Python SDK docs: snake_case names and generated API reference link - #91
Merged
Merged
Conversation
…ated API reference The Python package now exposes every action and its arguments in snake_case only (wait_for_selector, backend_node_id, max_depth, ...), with Session.call as the escape hatch that takes the browser's own names. Drop the camelCase aliases and the keyword-case warning, rename the arguments in every table, and link the pdoc reference now published at lightpanda.io/lightpanda-python. Also drop the 0.4.0 caveats: the next wheel exposes wait_until, max_bytes, strip and limit as keywords and returns an inline screenshot as bytes.
cdebled
approved these changes
Sep 2, 2026
This was referenced Sep 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follows lightpanda-io/lightpanda-python#3, which drops the camelCase aliases from the Python package and converts the action arguments to snake_case (
wait_for_selector,backend_node_id,max_depth, ...), and publishes the pdoc reference to GitHub Pages at https://lightpanda.io/docs/python/ (see #92 for the workflow that publishes it).callis documented as the escape hatch that takes the browser's own names. The method column loses its camelCase aliases and every Arguments column is renamed. Result keys such asbackendNodeIdintree/links/node_detailsoutput stay camelCase, since that is what the browser returns.wait_until,max_bytes,stripandlimitas keywords and returns an inline screenshot asbytes.This describes the next Python release, so it should be merged alongside it rather than before.