lucianopaz / compress_pickle

Standard python pickle, thinly wrapped with standard compression libraries
MIT License
41 stars 10 forks source link

document the recognized extensions #31

Closed jerabaul29 closed 2 years ago

jerabaul29 commented 3 years ago

From the user manual https://lucianopaz.github.io/compress_pickle/html/ :

>>> fname2 = "gzip_compressed_data.gz"  # The compression is inferred from the extension
>>> dump(obj, fname2)

Can you document there which extensions are recognized? Which extensions can I use to automatically use lzma for example?

lucianopaz commented 3 years ago

You can find the list of registered extensions by calling:

from compress_pickle.compressers.registry import get_registered_extensions

get_registered_extensions()

I'll explicitly write that down in the documentation. The information is in the API docs but it's harder to find.