fix: show results in the nine silent top-level examples - #1730
Open
ump45nose wants to merge 1 commit into
Open
Conversation
Nine examples (`export.py`, `import.py`, `python-udaf.py`, `python-udf.py`, `query-pyarrow-data.py`, `sql-to-pandas.py`, `sql-using-python-udaf.py`, `sql-using-python-udf.py`, `substrait.py`) ended in bare asserts and printed nothing, so a reader running them sees no output and cannot tell a working script from a silent one (apache#1728). Each now shows its final result with `df.show()` or a terminal `print`, keeping the asserts.
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
1 participant
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.
Which issue does this PR close?
Part of #1728.
Rationale for this change
Issue #1728 documents two example-side problems. The self-contained
csv-read-options.pyfix is already covered by #1729; this PR addresses the other half: nine top-level examples (export.py,import.py,python-udaf.py,python-udf.py,query-pyarrow-data.py,sql-to-pandas.py,sql-using-python-udaf.py,sql-using-python-udf.py,substrait.py) end in bareasserts and print nothing, so running them gives a reader no output and a silent script is indistinguishable from a broken one.What changes are included in this PR?
df.show()orprint(...)showing its final result; the existing asserts are kept unchanged.Are there any user-facing changes?
No API changes. The examples are documentation; after this change they visibly print their results when run.
Testing: ran all nine scripts with the released
datafusion54.0.0 wheel on Python 3.12 (macOS ARM).sql-to-pandas.pywas additionally verified end-to-end with the NYC taxi parquet documented inexamples/README.md(generatedchart.pngremoved afterwards).ruff check/ruff format(v0.15.1 as pinned in.pre-commit-config.yaml) andcodespellpass on the changed files.Prepared with AI assistance (agent contribution).