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
Andrey Doroschenko
ec42789e6e
bpo-39693: mention KeyError in tarfile extractfile documentation (GH-18639)
...
Co-authored-by: Andrey Darascheka <andrei.daraschenka@leverx.com>
2020-10-20 10:05:01 -04:00
Victor Stinner
d3ded08048
bpo-40204: Add :noindex: in the documentation (GH-21859)
...
Add :noindex: to duplicated documentation to fix "duplicate object
description" errors.
For example, fix this Sphinx 3 issue:
Doc/library/configparser.rst:1146: WARNING: duplicate object
description of configparser.ConfigParser.optionxform, other instance
in library/configparser, use :noindex: for one of them
2020-08-13 21:41:54 +02:00
Harsha Laxman
7a280197f4
Fix spacing in docs for tarfile (GH-20629)
...
Before
```
content.txt is 42 bytes in size and isa regular file.
folder is 420 bytes in size and isa directory.
magic is 4200 bytes in size and issomething else.
```
After:
```
content.txt is 42 bytes in size and is a regular file.
folder is 420 bytes in size and is a directory.
magic is 4200 bytes in size and is something else.
```
Automerge-Triggered-By: @orsenthil
2020-06-04 12:58:10 -07:00
William Woodruff
dd754caf14
bpo-29435: Allow is_tarfile to take a filelike obj (GH-18090)
...
`is_tarfile()` now supports `name` being a file or file-like object.
2020-01-22 18:24:16 -08:00
Pascal Chambon
c5a7e0ce19
bpo-37408: Precise that Tarfile "format" argument only concerns writing. (GH-14389)
2019-09-28 08:04:44 -07:00
CAM Gerlach
89a894403c
bpo-30661: Improve docs for tarfile pax change and effect on shutil (GH-12635)
...
The shutil archive creation helpers use the default tarfile format,
so that API is also switching to use `pax` by default.
2019-04-07 14:47:49 +10:00
CAM Gerlach
e680c3db80
bpo-36268: Change default tar format to pax from GNU. (GH-12355)
2019-03-21 16:44:51 +02:00
Bernhard M. Wiedemann
84521047e4
bpo-30693: zip+tarfile: sort directory listing ( #2263 )
...
tarfile and zipfile now sort directory listing to generate tar and zip archives
in a more reproducible way.
See also https://reproducible-builds.org/docs/stable-inputs/ on that topic.
2018-01-31 11:17:10 +01:00
Serhiy Storchaka
c45cd167d4
bpo-28230: Document the pathlib support in tarfile and add tests. ( #512 )
2017-03-08 10:32:44 +02:00
Serhiy Storchaka
4f76fb16b7
Issue #29210 : Removed support of deprecated argument "exclude" in
...
tarfile.TarFile.add().
2017-01-13 13:25:24 +02:00
Martin Panter
efbf20f3a3
Issue #28678 : Fix references to numeric_owner parameter
2016-11-13 23:25:06 +00:00
Serhiy Storchaka
72b34439bc
Fixed hyperlinks for tarfile CLI options.
2016-11-02 21:04:45 +02:00
Martin Panter
1050d2d0c7
Issue #26462 : Doc: reduce literal_block warnings, fix syntax highlighting.
...
Patch by Julien Palard.
2016-07-26 11:18:21 +02:00
Berker Peksag
9748478086
Issue #27306 : Fix typo in tarfile documentation
...
Patch by Gareth Rees.
2016-06-14 00:48:35 +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
Serhiy Storchaka
6dff0205b7
Issue #26736 : Used HTTPS for external links in the documentation if possible.
2016-05-07 10:49:07 +03:00
Serhiy Storchaka
6a7b3a77b4
Issue #26778 : Fixed "a/an/and" typos in code comment and documentation.
2016-04-17 08:32:47 +03:00
Martin Panter
7f7c605f29
Issue #25496 : Document compresslevel defaults to 9, by Hamza T Khan
2016-04-13 03:24:06 +00:00
Martin Panter
f817a48d17
Issues #22468 , #21996 , #22208 : Clarify gettarinfo() and TarInfo usage
...
* The Windows-specific binary notice was probably a Python 2 thing
* Make it more obvious gettarinfo() is based on stat(), and that non-ordinary
files may need special care
* The file name must be text; suggest dummy arcname as a workaround
* Indicate TarInfo may be used directly, not just via gettarinfo()
2016-02-19 23:34:56 +00:00
Martin Panter
c04fb56e36
Issue #26304 : Change "allows to <verb>" to "allows <verb>ing" or similar
...
The original form is incorrect grammar and feels awkward, even though the
meaning is clear.
2016-02-10 05:44:01 +00:00
Berker Peksag
662738980a
Mark TarInfo.frombuf() and TarInfo.fromtarfile() as classmethods.
2015-04-19 04:38:01 +03:00
Berker Peksag
37de910b52
Mark TarInfo.frombuf() and TarInfo.fromtarfile() as classmethods.
2015-04-19 04:37:35 +03:00
Berker Peksag
0002d3ccf6
Issue #15566 : Document encoding and errors parameters of TarInfo.frombuf().
...
Patch by Andy Holst.
2015-04-19 04:32:52 +03:00
Berker Peksag
e4dde50c78
Issue #15566 : Document encoding and errors parameters of TarInfo.frombuf().
...
Patch by Andy Holst.
2015-04-19 04:32:23 +03:00
Eric V. Smith
7a80389ce5
Issue 23193: Add numeric_owner to tarfile.TarFile.extract() and tarfile.TarFile.extractall().
2015-04-15 10:27:58 -04:00
Berker Peksag
0fe6325acf
Issue #21717 : tarfile.open() now supports 'x' (exclusive creation) mode.
2015-02-13 21:02:12 +02:00
Nick Coghlan
582acb75e9
Merge issue 19548 changes from 3.4
2015-01-07 00:37:01 +10:00
Nick Coghlan
b9fdb7a452
Issue 19548: update codecs module documentation
...
- clarified the distinction between text encodings and other codecs
- clarified relationship with builtin open and the io module
- consolidated documentation of error handlers into one section
- clarified type constraints of some behaviours
- added tests for some of the new statements in the docs
2015-01-07 00:22:00 +10:00
R David Murray
84bf989cc2
Merge: #14056 : Small improvements to the tarfile documentation.
2014-10-03 20:19:09 -04:00
R David Murray
bf92bceaaa
#14056 : Small improvements to the tarfile documentation.
...
Patch by Éric Araujo with help from Lars Gustäbel.
2014-10-03 20:18:48 -04:00
Serhiy Storchaka
dd6507eb86
Issue #22369 : Change "context manager protocol" to "context management protocol".
2014-09-10 23:45:42 +03:00
Serhiy Storchaka
148679982f
Issue #22369 : Change "context manager protocol" to "context management protocol".
2014-09-10 23:43:41 +03:00
Serhiy Storchaka
a7eb746278
Issue #21549 : Added the "members" parameter to TarFile.list().
2014-08-21 10:01:16 +03:00
Benjamin Peterson
9b2731bfdd
document the compress_level argument to tarfile.open ( closes #21404 )
...
Patch by Katherine Busch.
2014-06-07 12:45:37 -07:00
Raymond Hettinger
7096e26983
Issue 21479: Fix markup for the TarFile.open() classmethod.
2014-05-23 03:46:52 +01:00
Raymond Hettinger
f7f64f94b1
Issue 21198: Minor tarfile documentation bug.
2014-05-23 00:03:45 +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
Serhiy Storchaka
d27b455bbc
Issue #13477 : Added command line interface to the tarfile module.
...
Original patch by Berker Peksag.
2013-11-24 01:53:29 +02:00
Serhiy Storchaka
f8def28ff0
Issue #17193 : Use binary prefixes (KiB, MiB, GiB) for memory units.
2013-02-16 17:29:56 +02:00
Lars Gustäbel
7a919e9930
Issue #13815 : TarFile.extractfile() now returns io.BufferedReader objects.
...
The ExFileObject class was removed, some of its code went into _FileInFile.
2012-05-05 18:15:03 +02:00
Éric Araujo
cd0d951a70
Merge edits from 3.2 ( #13716 , #1040439 , #2945 , #13770 , #6715 )
2012-02-05 13:49:59 +01:00
Éric Araujo
f2fbb9cf42
Improve interlinking of archiving/compression modules docs.
...
- Remove duplicated list of links to the other modules from each
module’s doc (people can already go up to library/archiving and
there they can see the list).
- Link to shutil high-level operations.
Reviewed by Nadeem Vawda in #6715 .
2012-01-16 16:55:55 +01:00
Lars Gustäbel
521dfb02dd
Add missing versionchanged information.
2011-12-12 10:22:56 +01:00
Lars Gustäbel
0a9dd2f11d
Issue #5689 : Add support for lzma compression to the tarfile module.
2011-12-10 20:38:14 +01:00
Lars Gustäbel
c67c0b0db1
Merge with 3.2: Fix doc typo.
2011-12-10 12:48:03 +01:00
Lars Gustäbel
0c6cbbd632
Fix doc typo.
2011-12-10 12:45:45 +01:00
Antoine Pitrou
62ab10a05a
Replace mentions of IOError
2011-10-12 20:10:51 +02:00
Raymond Hettinger
a199368b23
More source links.
2011-01-27 01:20:32 +00:00