Broken examples in order_request and subscription_request docstrings, async SDK guide and CLI tips
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Read the docstrings for planet.order_request.build_request, planet.order_request.delivery, and planet.subscription_request.build_request, plus the “Create an order request” section in docs/python/async-sdk-guide.md and “Large Dataset Visualization” in docs/cli/cli-tips-tricks.md. Reproduce the reported syntax and command errors, then correct the examples so they compile, pass tools by keyword, and use the documented CLI command. Done when all five examples work as described; the issue author reports having a patch and offers to open a PR.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Expected behavior
Each documented example runs when copied (placeholder keys aside). The order_request.build_request example produces an order that contains its tools.
Actual behavior (describe the problem)
Five examples fail. They fail in the source on main (a6c66cb, the 3.7.0 tag) and in the 3.7.0 wheel. The published docs (planet-sdk-for-python.readthedocs.io/en/latest/, pages python/sdk-reference, python/async-sdk-guide and cli/cli-tips-tricks) show the same text.
planet.order_request.build_requestdocstring:SyntaxError: unmatched ')'at'analytic', 'REOrthoTile')]). With that fixed, the last linebuild_request('test_order', products, tools)passestoolsas the third positional argument, which issubscription_id. No error is raised. The result has notoolskey andsubscription_idholds the tool list. The example also usesprojection='WSG84'; thereproject_tooldocstring asks forEPSG:n.planet.order_request.deliverydocstring:SyntaxError: invalid syntax. Perhaps you forgot a comma?atarchive_filename='{{order_id}}.zip'. There is no comma beforecloud_config.planet.subscription_request.build_requestdocstring:NameError: name 'sentinel_hub' is not defined. The import line lists onlybuild_request, catalog_source, amazon_s3.docs/python/async-sdk-guide.md, "Create an order request":IndentationError. The function body is indented 4 spaces up to theoregon_aoidict and 3 spaces after it. Once that is fixed:SyntaxError, missing comma afteritem_type='PSScene'. The JSON block below it is invalid too:"name":"oregon_order”,ends in a curly quote, and the key is"Item_ids"where the code usesitem_ids.docs/cli/cli-tips-tricks.md, "Large Dataset Visualization":planet data collect skysat-large.geojsonsgivesError: No such command 'collect'.The command isplanet collect, as the sentence above the block says.
Related Issues
None of these is reported. Nearby:
- #869 (closed) fixed other broken CLI examples.
- #938 (closed) updated older docstring examples.
- #874 (open) tracks retired item types in examples. The
build_requestexample here usesREOrthoTile. - #373 (open) "Establish testing for documentation".
- #311 (open) "Bring docs_test and examples up to date"; covers the
docs_testnox session.
Workaround
- Remove the stray
])at the end of theproduct(...)line, passtools=tools, and useprojection='EPSG:4326'. - Add a comma after
'{{order_id}}.zip'. - Also import
sentinel_hub. - Re-indent the body to 4 spaces, add the comma after
item_type='PSScene', replace the curly quote, and use the keyitem_ids. - Use
planet collect.
I have a patch for all five (docstrings and docs only; unit tests, flake8 and yapf pass) and can open a PR if you want one.
Minimum, Complete, Viable Code Sample
No API key is needed. product() fetches the public bundle spec once.
# check_examples.py
import inspect, re, textwrap
from planet import order_request, subscription_request
def fenced(fn):
block = re.search(r"```python\n(.*?)```", inspect.getdoc(fn), re.S).group(1)
lines = textwrap.dedent(block).splitlines()
return "\n".join(l[4:] if l.startswith((">>> ", "... ")) else
("" if l in (">>>", "...") else l) for l in lines)
for fn in (order_request.build_request, order_request.delivery):
try:
compile(fenced(fn), fn.__name__, "exec")
print(fn.__name__, "compiles")
except SyntaxError as e:
print(f"order_request.{fn.__name__}: SyntaxError: {e.msg}: {e.text.strip()!r}")
# subscription_request.build_request uses an "Example::" block
code = textwrap.dedent(inspect.getdoc(subscription_request.build_request).split("Example::\n", 1)[1])
try:
exec(code, {"ACCESS_KEY_ID": "id", "SECRET_ACCESS_KEY": "secret"})
except Exception as e:
print(f"subscription_request.build_request: {type(e).__name__}: {e}")
# order_request.build_request example with only the bracket typo fixed
products = [order_request.product(["20170614_113217_3163208_RapidEye-5"], "analytic", "REOrthoTile")]
tools = [order_request.toar_tool(scale_factor=10000)]
req = order_request.build_request("test_order", products, tools) # call as written in the docstring
print(sorted(req), "tools" in req, req["subscription_id"])
> python check_examples.py
order_request.build_request: SyntaxError: unmatched ')': "'analytic', 'REOrthoTile')])"
order_request.delivery: SyntaxError: invalid syntax. Perhaps you forgot a comma?: "archive_filename='{{order_id}}.zip'"
subscription_request.build_request: NameError: name 'sentinel_hub' is not defined
['name', 'products', 'subscription_id'] False [{'toar': {'scale_factor': 10000}}]
For 4, copy the python block under "Create an order request" in docs/python/async-sdk-guide.md into guide.py and add import planet as the first line (without that line the same error is reported at line 13):
> python -m py_compile guide.py
Sorry: IndentationError: unindent does not match any outer indentation level (guide.py, line 14)
With the body re-indented to 4 spaces:
> python -m py_compile guide.py
File "guide.py", line 21
item_type='PSScene'
^^^^^
SyntaxError: invalid syntax. Perhaps you forgot a comma?
For 5:
> echo '{"type":"Feature","properties":{},"geometry":{"type":"Point","coordinates":[1,2]}}' > skysat-large.geojsons
> planet data collect skysat-large.geojsons
Usage: planet data [OPTIONS] COMMAND [ARGS]...
Try 'planet data --help' for help.
Error: No such command 'collect'.
> planet collect skysat-large.geojsons
{"type": "FeatureCollection", "features": [ ... ]}
Environment Information
- Operation System Information: macOS-27.0.1-arm64-arm-64bit
- Python version: 3.12.15 (main, Oct 9 2026, 15:10:57) [Clang 22.1.3 ]
- Planet package version: planet, version 3.7.0 (PyPI wheel, and main at a6c66cb, which is the 3.7.0 tag)
Installation Method
- pip wheel (
uv pip install planet) and from source (pip install -e .)
Found and reproduced with an AI coding assistant, then checked by me.
- Lenguaje dominante
- Python
- Estrellas
- 300
- Forks
- 99
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de planetlabs/planet-client-python
-
CLI: invalid --geom/--geometry value prints a traceback and exits 1 instead of a usage errorAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
planetlabs/planet-client-python#1230 ·
-
better-testing
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
planetlabs/planet-client-python#1110 ·
-
FeaturesClient list_items does not support filteringPosiblemente ocupada @steps-re la tomó hace 103 días. Abiertoproposal
Dificultad 3/5 1-2 días Aptitud para principiantes 65/100
planetlabs/planet-client-python#1221 ·
-
FeaturesClient does not implement Update FeaturePosiblemente ocupada @tbarsballe la tomó hace 132 días. Abiertoproposal
Dificultad 3/5 1-2 días Aptitud para principiantes 57/100
planetlabs/planet-client-python#1214 ·
-
bug
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
planetlabs/planet-client-python#1197 · 1 comentario · 1 reacción ·
Todos los issues de planetlabs/planet-client-python
Issues similares
-
documentation
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
ianktoo/project-monitor#14 ·
-
A wrong descriptor checksum is refused with the right one, also for an xprv or WIF descriptorAbiertosecurity
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
btclib-org/btclib-wallet#478 ·
Los mantenedores suelen responder en 1 día
-
security
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
btclib-org/btclib#2727 ·
Los mantenedores suelen responder en 1 día
-
good first issue lead variant:container
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
radialmonster/orf-cleanroom#10 ·
Los mantenedores suelen responder en 1 día
-
gdsa opencode: keep-alive cleanup trap fails with 'keepalive_pid: unbound variable'Posiblemente ocupada @darribas la tomó hoy. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100