Andre Delfino
dcc997cd28
[doc] Fix erroneous backslashes in signatures and names (GH-23658)
...
The issue being resolved is shown in the 3.10 docs (if you select docs for older versions you won't see a visual glitch).
The newer sphinx version that produces the 3.10 docs doesn't treat the backslash to escape things in some situations it previously did.
2020-12-16 17:37:28 -08:00
Serhiy Storchaka
138ccbb022
bpo-38738: Fix formatting of True and False. (GH-17083)
...
* "Return true/false" is replaced with "Return ``True``/``False``"
if the function actually returns a bool.
* Fixed formatting of some True and False literals (now in monospace).
* Replaced "True/False" with "true/false" if it can be not only bool.
* Replaced some 1/0 with True/False if it corresponds the code.
* "Returns <bool>" is replaced with "Return <bool>".
2019-11-12 16:57:03 +02:00
Berker Peksag
d4d48743ac
Tweak PEP 519 documentation in stdlib ( #163 )
...
* Drop duplicate work 'object' in lzma docs
* Fix typo in os docs: fpr -> for
2017-02-19 03:17:35 +03:00
Berker Peksag
5f59ddddcd
Issue #28229 : lzma module now supports pathlib
2016-10-04 20:41:20 +03:00
Berker Peksag
b334ee0063
Issue #28319 : Fix typo in lzma.rst
...
Reported by Vladimir Rutsky.
2016-10-01 01:19:04 +03:00
Terry Jan Reedy
fa089b9b0b
Issue #22558 : Add remaining doc links to source code for Python-coded modules.
...
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
Antoine Pitrou
2dbc6e6bce
Issue #23529 : Limit the size of decompressed data when reading from
...
GzipFile, BZ2File or LZMAFile. This defeats denial of service attacks
using compressed bombs (i.e. compressed payloads which decompress to a huge
size).
Patch by Martin Panter and Nikolaus Rath.
2015-04-11 00:31:01 +02:00
Antoine Pitrou
26795baaa8
Issue #15955 : Add an option to limit output size when decompressing LZMA data.
...
Patch by Nikolaus Rath and Martin Panter.
2015-01-17 16:22:18 +01:00
Nadeem Vawda
bd6932a576
Closes #18430 : Document that peek() may change the position of the underlying
...
file for the BZ2File, GzipFile and LZMAFile classes.
2013-12-08 19:50:05 +01:00
Nadeem Vawda
6976104a36
#18430 : Document that peek() may change the position of the underlying file for
...
the BZ2File, GzipFile and LZMAFile classes.
2013-12-08 19:47:22 +01:00
Serhiy Storchaka
0e90e99188
Issue #19795 : Improved markup of True/False constants.
2013-11-29 12:19:53 +02:00
Serhiy Storchaka
fbc1c26803
Issue #19795 : Improved markup of True/False constants.
2013-11-29 12:17:13 +02:00
Nadeem Vawda
42ca98217c
Issue #19201 : Add support for the 'x' mode to the lzma module.
...
Patch by Tim Heaney and Vajrasky Kok.
2013-10-19 00:06:19 +02:00
Serhiy Storchaka
f8def28ff0
Issue #17193 : Use binary prefixes (KiB, MiB, GiB) for memory units.
2013-02-16 17:29:56 +02:00
Nadeem Vawda
5011244be0
Prefer lzma.open() over lzma.LZMAFile() in lzma module documentation.
2012-09-23 18:20:23 +02:00
Nadeem Vawda
667a13bf2a
Fix indentation of examples in lzma module documentation.
2012-09-23 18:08:57 +02:00
Nadeem Vawda
a425c3d5a2
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.
2012-06-21 23:36:48 +02:00
Nadeem Vawda
e860404eb7
Add a function lzma.open(), to match gzip.open() and bz2.open().
2012-06-04 23:38:12 +02:00
Nadeem Vawda
6cbb20cdf6
Allow LZMAFile to accept modes with a "b" suffix.
2012-06-04 23:36:24 +02:00
Nadeem Vawda
33c34da574
Simplify usage of LZMAFile's fileobj support, like with BZ2File.
2012-06-04 23:34:07 +02:00
Nadeem Vawda
bc459bb484
Rename lzma.check_is_supported() to is_check_supported() to avoid grammatical confusion.
2012-05-06 23:01:51 +02:00
Nadeem Vawda
f55b329edc
Add lzma.{encode,decode}_filter_properties().
2012-05-06 23:01:27 +02:00
Nadeem Vawda
fb39063202
Make lzma docs consistent with other compression modules (cf. changeset 11bd2d32b4e8).
2012-02-05 15:07:43 +02:00
Nadeem Vawda
d85d0e7247
Document that some of LZMAFile.__init__()'s args are keyword-only.
2012-02-04 14:06:07 +02:00
Nadeem Vawda
dc9dd0d340
Add note on memory usage to LZMACompressor doc.
2012-01-02 02:24:20 +02:00
Nadeem Vawda
3ff069ebc6
Issue #6715 : Add module for compression using the LZMA algorithm.
2011-11-30 00:25:06 +02:00