Skip to content

ENH: set __module__ on read_* functions in readers.py #60265

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

Merged
merged 3 commits into from
Nov 11, 2024
Merged

ENH: set __module__ on read_* functions in readers.py #60265

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
51ec4d0
decorate read_* functions in readers.py with set_module('pandas')
chanshing Nov 9, 2024
55a06ba
add asserts to test read function module string is set to 'pandas'
chanshing Nov 9, 2024
4eae6e3
Merge branch 'main' into decorate-readers-set-module
simonjayhawkins Nov 11, 2024
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
8 changes: 7 additions & 1 deletion pandas/io/parsers/readers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@
AbstractMethodError,
ParserWarning,
)
from pandas.util._decorators import Appender
from pandas.util._decorators import (
Appender,
set_module,
)
from pandas.util._exceptions import find_stack_level
from pandas.util._validators import check_dtype_backend

Expand Down Expand Up @@ -771,6 +774,7 @@ def read_csv(
% "filepath_or_buffer",
)
)
@set_module("pandas")
def read_csv(
filepath_or_buffer: FilePath | ReadCsvBuffer[bytes] | ReadCsvBuffer[str],
*,
Expand Down Expand Up @@ -906,6 +910,7 @@ def read_table(
% "filepath_or_buffer",
)
)
@set_module("pandas")
def read_table(
filepath_or_buffer: FilePath | ReadCsvBuffer[bytes] | ReadCsvBuffer[str],
*,
Expand Down Expand Up @@ -1023,6 +1028,7 @@ def read_fwf(
) -> DataFrame: ...


@set_module("pandas")
def read_fwf(
filepath_or_buffer: FilePath | ReadCsvBuffer[bytes] | ReadCsvBuffer[str],
*,
Expand Down
3 changes: 3 additions & 0 deletions pandas/tests/api/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,3 +416,6 @@ def test_set_module():
assert pd.Period.__module__ == "pandas"
assert pd.Timestamp.__module__ == "pandas"
assert pd.Timedelta.__module__ == "pandas"
assert pd.read_csv.__module__ == "pandas"
assert pd.read_table.__module__ == "pandas"
assert pd.read_fwf.__module__ == "pandas"