Skip to content

DEPR: pandas.io #52994

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.

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

Open
rhshadrach opened this issue Apr 29, 2023 · 3 comments
Open

DEPR: pandas.io #52994

rhshadrach opened this issue Apr 29, 2023 · 3 comments
Labels
API Design Deprecate Functionality to remove in pandas Needs Discussion Requires discussion from core team before further action

Comments

@rhshadrach
Copy link
Member

Similar to #27522.

Currently we document pandas.io as:

In addition, public functions in pandas.io and pandas.tseries submodules are mentioned in the documentation.

Some submodules of pandas.io have a clear delineation of whats public vs private, e.g. pandas.io.excel where all submodules are prefixed with an underscore. Others, such as pandas.io.formats, are not.

One possible way to clean this up is to do add pandas.api.io and make various objects public by exposing them there.

Pinging people who helped introduce pandas.api.typing: cc @simonjayhawkins @Dr-Irv @mroeschke @jorisvandenbossche @topper-123 @bashtage

@rhshadrach rhshadrach added API Design Deprecate Functionality to remove in pandas Needs Discussion Requires discussion from core team before further action labels Apr 29, 2023
@Dr-Irv
Copy link
Contributor

Dr-Irv commented May 1, 2023

I think we are inconsistent on what we document from pandas.io between the user guide and reference guide. I support the idea of moving them all to a pandas.api.io package. But this should also be done by looking at the doc references and making sure that whatever is mentioned in the user guide has a corresponding reference manual page.

@rhshadrach
Copy link
Member Author

I think we are inconsistent on what we document from pandas.io between the user guide and reference guide.

Can you provide details here? The way I read the reference guide is "anything that appears in our documentation is public, otherwise it's private".

@Dr-Irv
Copy link
Contributor

Dr-Irv commented May 2, 2023

Can you provide details here? The way I read the reference guide is "anything that appears in our documentation is public, otherwise it's private".

Here is one example. There may be more. In https://pandas.pydata.org/pandas-docs/stable/user_guide/io.html#sql-queries, we say "The pandas.io.sql module provides a collection of query wrappers ...", but pandas.io.sql is not in the reference manual.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Design Deprecate Functionality to remove in pandas Needs Discussion Requires discussion from core team before further action
Projects
None yet
Development

No branches or pull requests

2 participants