diff options
| author | Nadeem Vawda <nadeem.vawda@gmail.com> | 2012-06-21 21:36:48 (GMT) |
|---|---|---|
| committer | Nadeem Vawda <nadeem.vawda@gmail.com> | 2012-06-21 21:36:48 (GMT) |
| commit | a425c3d5a264c556d31bdd88097c79246b533ea3 (patch) | |
| tree | 2ee651277af2bb8d61ad824001aa2bbcbba54585 /Doc/library/lzma.rst | |
| parent | 01317d2ed5b06310ab9cefa7eed5912819ea89c9 (diff) | |
| download | cpython-a425c3d5a264c556d31bdd88097c79246b533ea3.zip cpython-a425c3d5a264c556d31bdd88097c79246b533ea3.tar.gz cpython-a425c3d5a264c556d31bdd88097c79246b533ea3.tar.bz2 | |
Make lzma.{encode,decode}_filter_properties private.
These functions were originally added to support LZMA compression in the zipfile
module, and are not of interest for the majority of users.
They can be made public in 3.4 if there is user interest, but in the meanwhile,
I've opted to present a smaller, simpler API for the module's initial release.
Diffstat (limited to 'Doc/library/lzma.rst')
| -rw-r--r-- | Doc/library/lzma.rst | 26 |
1 files changed, 0 insertions, 26 deletions
diff --git a/Doc/library/lzma.rst b/Doc/library/lzma.rst index 3174dd3..402fae2 100644 --- a/Doc/library/lzma.rst +++ b/Doc/library/lzma.rst @@ -268,32 +268,6 @@ Miscellaneous feature set. -.. function:: encode_filter_properties(filter) - - Return a :class:`bytes` object encoding the options (properties) of the - filter specified by *filter* (a dictionary). - - *filter* is interpreted as a filter specifier, as described in - :ref:`filter-chain-specs`. - - The returned data does not include the filter ID itself, only the options. - - This function is primarily of interest to users implementing custom file - formats. - - -.. function:: decode_filter_properties(filter_id, encoded_props) - - Return a dictionary describing a filter with ID *filter_id*, and options - (properties) decoded from the :class:`bytes` object *encoded_props*. - - The returned dictionary is a filter specifier, as described in - :ref:`filter-chain-specs`. - - This function is primarily of interest to users implementing custom file - formats. - - .. _filter-chain-specs: Specifying custom filter chains |