Skip to content
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

Allow errors keyword for HDF IO Encoding Err Handling #20873

Merged
merged 8 commits into from
May 1, 2018
Merged

Allow errors keyword for HDF IO Encoding Err Handling #20873

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
f75ca6e
Added test case
WillAyd Apr 30, 2018
97f6a54
Round trippable read/write with errors
WillAyd Apr 30, 2018
9ae2ea0
Added index to test case
WillAyd Apr 30, 2018
cfe09d1
Mirrored encoding impl
WillAyd Apr 30, 2018
3973ef7
Updated whatsnew
WillAyd Apr 30, 2018
61a0c6b
LINT fixup
WillAyd Apr 30, 2018
0fe838a
Document errors
TomAugspurger May 1, 2018
9a13234
Merge remote-tracking branch 'upstream/master' into WillAyd-tbl-arg-pass
TomAugspurger May 1, 2018
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
1 change: 1 addition & 0 deletions doc/source/whatsnew/v0.23.0.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,7 @@ Other Enhancements
- Updated :meth:`DataFrame.to_gbq` and :meth:`pandas.read_gbq` signature and documentation to reflect changes from
the Pandas-GBQ library version 0.4.0. Adds intersphinx mapping to Pandas-GBQ
library. (:issue:`20564`)
- :func:`to_hdf` and :func:`read_hdf` now accept an ``errors`` keyword argument to control encoding error handling (:issue:`20835`)

.. _whatsnew_0230.api_breaking:

Expand Down
4 changes: 4 additions & 0 deletions pandas/core/generic.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1946,6 +1946,10 @@ def to_hdf(self, path_or_buf, key, **kwargs):
If applying compression use the fletcher32 checksum.
dropna : bool, default False
If true, ALL nan rows will not be written to store.
errors : str, default 'strict'
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TomAugspurger I know you are adding a few things for the RC so don't need to change anything here, but do we typically document things in the API like this? Wondering if we shouldn't make all of the documented features actual keyword arguments in the call signature rather than tucking them away in kwargs.

FWIW if we have errors here we'd probably want to add encoding as well

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The signature should be changed from kwargs to reflect the actual signature. I thought we had an issue for it, but didn't find one. Opened #20903

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I'll take a stab at that one later

Specifies how encoding and decoding errors are to be handled.
See the errors argument for :func:`open` for a full list
of options.

See Also
--------
Expand Down
Loading