Skip to content

remove compressor kwarg from create_array #2818

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
d-v-b opened this issue Feb 12, 2025 · 2 comments
Open

remove compressor kwarg from create_array #2818

d-v-b opened this issue Feb 12, 2025 · 2 comments

Comments

@d-v-b
Copy link
Contributor

d-v-b commented Feb 12, 2025

In #2709 we ended up with a new keyword argument (compressor) in Group.create_array, unfortunately this creates confusion given that Group.create_array already takes a compressors kwarg, and create_array (the function Group.create_array ultimately invokes) only takes compressors.

New functions like create_array should be kept clear of confusing / redundant keyword arguments, and we should also ensure that Group.<func> has nearly the same signature as <func>, so for both these reasons I think we should hastily remove the compressor kwarg from Group.create_array, and ensure that the issue solved by #2709 can be solved via the compressors kwarg.

cc @martindurant

@martindurant
Copy link
Member

Happy to hear opinions. Probably this was used in the current release of kerchunk.

@d-v-b
Copy link
Contributor Author

d-v-b commented Feb 12, 2025

I think we could keep the change smooth via a deprecation + warning, and then make the breaking change in a few releases?

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants