From 59523de6e89a8b98104d55c5db8d106cf422fff7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dea=20Mar=C3=ADa=20L=C3=A9on?= Date: Thu, 20 Jul 2023 18:19:51 +0200 Subject: [PATCH 1/3] Examples pandas.test, read_feather... --- ci/code_checks.sh | 7 ------- pandas/io/feather_format.py | 4 ++++ pandas/io/orc.py | 4 ++++ pandas/io/sas/sasreader.py | 4 ++++ pandas/io/spss.py | 4 ++++ pandas/io/sql.py | 7 +++++++ pandas/util/_tester.py | 5 +++++ 7 files changed, 28 insertions(+), 7 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 5fc8f02a3fa8d..1fea0691707b2 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -73,14 +73,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then pandas.errors.PyperclipWindowsException \ pandas.errors.UnsortedIndexError \ pandas.errors.UnsupportedFunctionCall \ - pandas.test \ pandas.NaT \ - pandas.read_feather \ - pandas.DataFrame.to_feather \ - pandas.read_orc \ - pandas.read_sas \ - pandas.read_spss \ - pandas.read_sql_query \ pandas.io.stata.StataReader.data_label \ pandas.io.stata.StataReader.value_labels \ pandas.io.stata.StataReader.variable_labels \ diff --git a/pandas/io/feather_format.py b/pandas/io/feather_format.py index 045eb7201631c..ee479ec8b8ba7 100644 --- a/pandas/io/feather_format.py +++ b/pandas/io/feather_format.py @@ -103,6 +103,10 @@ def read_feather( Returns ------- type of object stored in file + + Examples + -------- + >>> df = pd.read_feather("path/to/file.feather") # doctest: +SKIP """ import_optional_dependency("pyarrow") from pyarrow import feather diff --git a/pandas/io/orc.py b/pandas/io/orc.py index edba03d2d46a8..3d3d3eafcca29 100644 --- a/pandas/io/orc.py +++ b/pandas/io/orc.py @@ -95,6 +95,10 @@ def read_orc( a ``pyarrow.fs`` filesystem will be attempted to read the file. You can also pass a pyarrow or fsspec filesystem object into the filesystem keyword to override this behavior. + + Examples + -------- + >>> result = pd.read_orc("example_pa.orc") # doctest: +SKIP """ # we require a newer version of pyarrow than we support for parquet diff --git a/pandas/io/sas/sasreader.py b/pandas/io/sas/sasreader.py index 4b31c4b3828ce..50fa78abe6cb2 100644 --- a/pandas/io/sas/sasreader.py +++ b/pandas/io/sas/sasreader.py @@ -126,6 +126,10 @@ def read_sas( ------- DataFrame if iterator=False and chunksize=None, else SAS7BDATReader or XportReader + + Examples + -------- + >>> df = pd.read_sas("sas_data.sas7bdat") """ if format is None: buffer_error_msg = ( diff --git a/pandas/io/spss.py b/pandas/io/spss.py index a50bff6cf49b5..58487c6cd721b 100644 --- a/pandas/io/spss.py +++ b/pandas/io/spss.py @@ -50,6 +50,10 @@ def read_spss( Returns ------- DataFrame + + Examples + -------- + >>> df = pd.read_spss("spss_data.sav") # doctest: +SKIP """ pyreadstat = import_optional_dependency("pyreadstat") check_dtype_backend(dtype_backend) diff --git a/pandas/io/sql.py b/pandas/io/sql.py index 309d33d5ae75b..1a1d34a25c363 100644 --- a/pandas/io/sql.py +++ b/pandas/io/sql.py @@ -468,6 +468,13 @@ def read_sql_query( ----- Any datetime values with time zone information parsed via the `parse_dates` parameter will be converted to UTC. + + Examples + -------- + >>> from sqlalchemy import create_engine # doctest: +SKIP + >>> engine = create_engine("sqlite:///database.db") # doctest: +SKIP + >>> with engine.connect() as conn, conn.begin(): # doctest: +SKIP + ... data = pd.read_sql_table("data", conn) # doctest: +SKIP """ check_dtype_backend(dtype_backend) diff --git a/pandas/util/_tester.py b/pandas/util/_tester.py index 6a2a8189ad896..7cfddef7ddff8 100644 --- a/pandas/util/_tester.py +++ b/pandas/util/_tester.py @@ -25,6 +25,11 @@ def test(extra_args: list[str] | None = None, run_doctests: bool = False) -> Non Whether to only run the Python and Cython doctests. If you would like to run both doctests/regular tests, just append "--doctest-modules"/"--doctest-cython" to extra_args. + + Examples + -------- + >>> pd.test() # doctest: +SKIP + running: pytest... """ pytest = import_optional_dependency("pytest") import_optional_dependency("hypothesis") From 16b6a6178a9cd6ed4e362f75e8f41e6068687324 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dea=20Mar=C3=ADa=20L=C3=A9on?= Date: Thu, 20 Jul 2023 19:16:09 +0200 Subject: [PATCH 2/3] add skip doctest --- pandas/io/sas/sasreader.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pandas/io/sas/sasreader.py b/pandas/io/sas/sasreader.py index 50fa78abe6cb2..7fdfd214c452c 100644 --- a/pandas/io/sas/sasreader.py +++ b/pandas/io/sas/sasreader.py @@ -129,7 +129,7 @@ def read_sas( Examples -------- - >>> df = pd.read_sas("sas_data.sas7bdat") + >>> df = pd.read_sas("sas_data.sas7bdat") # doctest: +SKIP """ if format is None: buffer_error_msg = ( From 7071e54b37ee8abba7ba7b01abccf41c014c440a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dea=20Mar=C3=ADa=20L=C3=A9on?= Date: Thu, 20 Jul 2023 20:41:50 +0200 Subject: [PATCH 3/3] Correct code_checks.sh --- ci/code_checks.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 702e7d28a36d8..c57f8f9c5482d 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -74,6 +74,7 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then pandas.errors.UnsortedIndexError \ pandas.errors.UnsupportedFunctionCall \ pandas.NaT \ + pandas.DataFrame.to_feather \ pandas.io.stata.StataReader.data_label \ pandas.io.stata.StataReader.value_labels \ pandas.io.stata.StataReader.variable_labels \