Skip to content

[SPARK-56367][SS][PYTHON][DOCS] Fix latestOffset docstring and tutorial to use correct field name and signature #55227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jiteshsoni wants to merge 1 commit into
base: master
Choose a base branch
from
+2 −2
Draft

[SPARK-56367][SS][PYTHON][DOCS] Fix latestOffset docstring and tutorial to use correct field name and signature #55227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion python/docs/source/tutorial/sql/python_data_source.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ This is a dummy streaming data reader that generates 2 rows in every microbatch.
"""
return {"offset": 0}

def latestOffset(self) -> dict:
def latestOffset(self, start: dict, limit) -> dict:
Copy link
Copy Markdown
Contributor

@gaogaotiantian gaogaotiantian Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably should add the type of limit too here.

Copy link
Copy Markdown
Contributor Author

@jiteshsoni jiteshsoni Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad, this was not ready for review yet.

Give me a couple of days, and I will test this and bring this PR out of draft status.

"""
Return the current latest offset that the next microbatch will read to.
"""
Expand Down
2 changes: 1 addition & 1 deletion python/pyspark/sql/datasource.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -756,7 +756,7 @@ def latestOffset(self, start: dict, limit: ReadLimit) -> dict:
... if isinstance(limit, ReadAllAvailable):
... return {"index": start["index"] + 10}
... else: # e.g., limit is ReadMaxRows(5)
... return {"index": start["index"] + min(10, limit.maxRows)}
... return {"index": start["index"] + min(10, limit.max_rows)}
"""
# NOTE: Previous Spark versions didn't have start offset and read limit parameters for this
# method. While Spark will ensure the backward compatibility for existing data sources, the
Expand Down