Skip to content

ARROW-16018: [Doc][Python] Run doctests on Python docstring examples (CI job) #13216

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

Closed
AlenkaF wants to merge 14 commits into from
Closed

ARROW-16018: [Doc][Python] Run doctests on Python docstring examples (CI job) #13216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
d1e2514
Initial commit for doctest CI job
AlenkaF May 23, 2022
b8aea0e
Correct PYTEST_ARGS
AlenkaF May 23, 2022
7da4eca
Try to fix importing cache manifest error
AlenkaF May 23, 2022
85ffc38
Fix CI ValueError
AlenkaF May 24, 2022
5bc5abe
Remove extra build for doctest and instead add extra step to the sphi…
AlenkaF May 24, 2022
cce055f
Update docker-compose.yml
AlenkaF May 25, 2022
2269348
Remove --doctest-cython to be added in the last PR for doctest
AlenkaF May 25, 2022
f666c54
Doctest check corrections
AlenkaF May 25, 2022
8209396
Initial commit for doctest CI job
AlenkaF May 23, 2022
6d39b5e
Correct PYTEST_ARGS
AlenkaF May 23, 2022
f416f46
Try to fix importing cache manifest error
AlenkaF May 23, 2022
1cdbf91
Fix CI ValueError
AlenkaF May 24, 2022
1df5c39
Remove extra build for doctest and instead add extra step to the sphi…
AlenkaF May 24, 2022
028d51d
Remove whitespace
AlenkaF May 26, 2022
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: 2 additions & 0 deletions ci/conda_env_sphinx.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,5 @@ pydata-sphinx-theme
sphinx-design
sphinx>=4.2
sphinx-copybutton
# Requirement for doctest-cython
pytest-cython
4 changes: 3 additions & 1 deletion docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1055,12 +1055,14 @@ services:
LANG: "C.UTF-8"
BUILD_DOCS_CPP: "ON"
BUILD_DOCS_PYTHON: "ON"
PYTEST_ARGS: "--doctest-modules"
volumes: *conda-volumes
command:
["/arrow/ci/scripts/cpp_build.sh /arrow /build &&
/arrow/ci/scripts/python_build.sh /arrow /build &&
pip install -e /arrow/dev/archery[numpydoc] &&
archery numpydoc --allow-rule PR01,PR10"]
archery numpydoc --allow-rule PR01,PR10 &&
/arrow/ci/scripts/python_test.sh /arrow"]

conda-python-dask:
# Possible $DASK parameters:
Expand Down
7 changes: 4 additions & 3 deletions python/pyarrow/fs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,12 +224,13 @@ def copy_files(source, destination,
--------
Copy an S3 bucket's files to a local directory:

>>> copy_files("s3://your-bucket-name", "local-directory")
>>> copy_files("s3://your-bucket-name",
... "local-directory") # doctest: +SKIP

Using a FileSystem object:

>>> copy_files("your-bucket-name", "local-directory",
... source_filesystem=S3FileSystem(...))
... source_filesystem=S3FileSystem(...)) # doctest: +SKIP

"""
source_fs, source_path = _resolve_filesystem_and_path(
Expand Down Expand Up @@ -263,7 +264,7 @@ class FSSpecHandler(FileSystemHandler):

Examples
--------
>>> PyFileSystem(FSSpecHandler(fsspec_fs))
>>> PyFileSystem(FSSpecHandler(fsspec_fs)) # doctest: +SKIP
"""

def __init__(self, fs):
Expand Down
4 changes: 2 additions & 2 deletions python/pyarrow/parquet/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1926,7 +1926,7 @@ def read_pandas(self, **kwargs):
Select pandas metadata:

>>> dataset.read_pandas(columns=["n_legs"]).schema.pandas_metadata
{'index_columns': [{'kind': 'range', ... 'pandas_version': '1.4.1'}
{'index_columns': [{'kind': 'range', 'name': None, 'start': 0, ...}
"""
return self.read(use_pandas_metadata=True, **kwargs)

Expand Down Expand Up @@ -2486,7 +2486,7 @@ def read_pandas(self, **kwargs):
n_legs: [[2,2,4,4,5,100]]

>>> dataset.read_pandas(columns=["n_legs"]).schema.pandas_metadata
{'index_columns': [{'kind': 'range', ... 'pandas_version': '1.4.1'}
{'index_columns': [{'kind': 'range', 'name': None, 'start': 0, ...}
"""
return self.read(use_pandas_metadata=True, **kwargs)

Expand Down