propagation of `encoding`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
What is your issue?
We frequently get bug reports related to encoding that can usually be fixed by clearing it or by overriding it using the encoding parameter of the to_* methods, e.g.
- #4224
- #4380
- #4655
- #5427
- #5490
- fsspec/kerchunk#130
There are also a few discussions with more background:
- https://github.com/pydata/xarray/pull/5065#issuecomment-806154872
- https://github.com/pydata/xarray/issues/1614
- #5082
- #5336
We discussed this in the meeting yesterday and as far as I can remember agreed that the current default behavior is not ideal and decided to investigate #5336: a keep_encoding option, similar to keep_attrs, that would be True (propagate encoding) by default but will be changed to False (drop encoding on any operation) in the future.
cc @rabernat, @shoyer
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading issue #5336 and the linked discussions and related reports to understand the proposed keep_encoding behavior and its compatibility implications. Identify the affected operations and tests, then define the scope and acceptance criteria for propagating encoding by default before implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- data
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100