Skip to content

DOC: ES01 fix for HDFS Methods #57604

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
wants to merge 2 commits into from
Closed

DOC: ES01 fix for HDFS Methods #57604

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f350ff6
ES01 fix for HDFS Methods
YashpalAhlawat Feb 24, 2024
dae653c
review comments implemented
YashpalAhlawat Feb 25, 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
4 changes: 0 additions & 4 deletions ci/code_checks.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,10 +521,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
pandas.DatetimeIndex.year\
pandas.DatetimeTZDtype.tz\
pandas.DatetimeTZDtype.unit\
pandas.HDFStore.get\
pandas.HDFStore.info\
pandas.HDFStore.keys\
pandas.HDFStore.put\
pandas.Index.T\
pandas.Index.all\
pandas.Index.any\
Expand Down
17 changes: 17 additions & 0 deletions pandas/io/pytables.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -640,6 +640,12 @@ def keys(self, include: str = "pandas") -> list[str]:
"""
Return a list of keys corresponding to objects stored in HDFStore.

The include parameter can be used to filter the returned
list based on the type of objects to include. If include
is set to "pandas" (default), only pandas objects will
be included in the list. If include is set to "native",
only native HDF5 Table objects will be included in the list.

Parameters
----------

Expand Down Expand Up @@ -776,6 +782,9 @@ def get(self, key: str):
"""
Retrieve pandas object stored in file.

This method within the context of a Pandas HDFStore allows
you to retrieve data that has been previously saved.

Parameters
----------
key : str
Expand Down Expand Up @@ -1107,6 +1116,10 @@ def put(
"""
Store object in HDFStore.

It also offers options to control various aspects of the
storage process, such as whether to write DataFrame index
as a column, whether to remove missing values, etc.

Parameters
----------
key : str
Expand Down Expand Up @@ -1647,6 +1660,10 @@ def info(self) -> str:
"""
Print detailed information on the store.

This method provide convenient ways to interact with data
stored in HDFStore files,allowing users to easily access
and inspect their content.

Returns
-------
str
Expand Down