Mailman 3 November 2018 - Python-checkins

bpo-35300: Add usage note to the lru_cache() docs (GH-10707)
by Miss Islington (bot) 26 Nov '18

26 Nov '18

https://github.com/python/cpython/commit/f0e0f2008d160cdd7e5bc02ea61c43f8c7… commit: f0e0f2008d160cdd7e5bc02ea61c43f8c7b2b82f branch: master author: Raymond Hettinger <rhettinger(a)users.noreply.github.com> committer: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> date: 2018-11-25T16:24:52-08:00 summary: bpo-35300: Add usage note to the lru_cache() docs (GH-10707) https://bugs.python.org/issue35300 files: M Doc/library/functools.rst diff --git a/Doc/library/functools.rst b/Doc/library/functools.rst index 40abdc24883c..cd59e5bebfd5 100644 --- a/Doc/library/functools.rst +++ b/Doc/library/functools.rst @@ -118,6 +118,11 @@ The :mod:`functools` module defines the following functions: The cache's size limit assures that the cache does not grow without bound on long-running processes such as web servers. + In general, the LRU cache should only be used when you want to reuse + previously computed values. Accordingly, it doesn't make sense to cache + functions with side-effects, functions that need to create distinct mutable + objects on each call, or impure functions such as time() or random(). + Example of an LRU cache for static web content:: @lru_cache(maxsize=32)

1 0

bpo-35081: Add Include/internal/pycore_tupleobject.h (GH-10705)
by Victor Stinner 25 Nov '18

25 Nov '18

https://github.com/python/cpython/commit/ec13b9322d95a651606219469fc7b7e9c9… commit: ec13b9322d95a651606219469fc7b7e9c977f248 branch: master author: Victor Stinner <vstinner(a)redhat.com> committer: GitHub <noreply(a)github.com> date: 2018-11-25T23:56:17+01:00 summary: bpo-35081: Add Include/internal/pycore_tupleobject.h (GH-10705) Move _PyTuple_ITEMS() to a new header file: Include/internal/pycore_tupleobject.h files: A Include/internal/pycore_tupleobject.h M Include/tupleobject.h M Makefile.pre.in M Modules/_functoolsmodule.c M Objects/call.c M Objects/codeobject.c M Objects/descrobject.c M Objects/funcobject.c M PCbuild/pythoncore.vcxproj M PCbuild/pythoncore.vcxproj.filters M Python/ceval.c M Python/getargs.c diff --git a/Include/internal/pycore_tupleobject.h b/Include/internal/pycore_tupleobject.h new file mode 100644 index 000000000000..fdd741467665 --- /dev/null +++ b/Include/internal/pycore_tupleobject.h @@ -0,0 +1,18 @@ +#ifndef Py_INTERNAL_TUPLEOBJECT_H +#define Py_INTERNAL_TUPLEOBJECT_H +#ifdef __cplusplus +extern "C" { +#endif + +#if !defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_BUILTIN) +# error "this header requires Py_BUILD_CORE or Py_BUILD_CORE_BUILTIN define" +#endif + +#include "tupleobject.h" + +#define _PyTuple_ITEMS(op) (_PyTuple_CAST(op)->ob_item) + +#ifdef __cplusplus +} +#endif +#endif /* !Py_INTERNAL_TUPLEOBJECT_H */ diff --git a/Include/tupleobject.h b/Include/tupleobject.h index a150d07d3e0a..eec2d98f2d95 100644 --- a/Include/tupleobject.h +++ b/Include/tupleobject.h @@ -61,10 +61,6 @@ PyAPI_FUNC(void) _PyTuple_MaybeUntrack(PyObject *); #define PyTuple_GET_ITEM(op, i) (_PyTuple_CAST(op)->ob_item[i]) #define PyTuple_GET_SIZE(op) (assert(PyTuple_Check(op)), Py_SIZE(op)) -#ifdef Py_BUILD_CORE -# define _PyTuple_ITEMS(op) (_PyTuple_CAST(op)->ob_item) -#endif - /* Macro, *only* to be used to fill in brand new tuples */ #define PyTuple_SET_ITEM(op, i, v) (_PyTuple_CAST(op)->ob_item[i] = v) #endif diff --git a/Makefile.pre.in b/Makefile.pre.in index d0e915a00ae0..2c92db23489e 100644 --- a/Makefile.pre.in +++ b/Makefile.pre.in @@ -1043,6 +1043,7 @@ PYTHON_HEADERS= \ $(srcdir)/Include/internal/pycore_pylifecycle.h \ $(srcdir)/Include/internal/pycore_pymem.h \ $(srcdir)/Include/internal/pycore_pystate.h \ + $(srcdir)/Include/internal/pycore_tupleobject.h \ $(srcdir)/Include/internal/pycore_warnings.h \ $(DTRACE_HEADERS) diff --git a/Modules/_functoolsmodule.c b/Modules/_functoolsmodule.c index 773102bb5900..8701f6c89d71 100644 --- a/Modules/_functoolsmodule.c +++ b/Modules/_functoolsmodule.c @@ -1,7 +1,7 @@ - #include "Python.h" #include "pycore_pymem.h" #include "pycore_pystate.h" +#include "pycore_tupleobject.h" #include "structmember.h" /* _functools module written and maintained diff --git a/Objects/call.c b/Objects/call.c index ce346c293486..ba2ddcb35b9b 100644 --- a/Objects/call.c +++ b/Objects/call.c @@ -1,6 +1,7 @@ #include "Python.h" #include "pycore_object.h" #include "pycore_pystate.h" +#include "pycore_tupleobject.h" #include "frameobject.h" diff --git a/Objects/codeobject.c b/Objects/codeobject.c index a2efa7ed03f5..09182d61c244 100644 --- a/Objects/codeobject.c +++ b/Objects/codeobject.c @@ -4,6 +4,7 @@ #include "code.h" #include "structmember.h" #include "pycore_pystate.h" +#include "pycore_tupleobject.h" /* Holder for co_extra information */ typedef struct { diff --git a/Objects/descrobject.c b/Objects/descrobject.c index dd3c5014aea7..23d4b1a29e6f 100644 --- a/Objects/descrobject.c +++ b/Objects/descrobject.c @@ -3,6 +3,7 @@ #include "Python.h" #include "pycore_object.h" #include "pycore_pystate.h" +#include "pycore_tupleobject.h" #include "structmember.h" /* Why is this not included in Python.h? */ /*[clinic input] diff --git a/Objects/funcobject.c b/Objects/funcobject.c index 982df5434d25..c77e4e9f4e89 100644 --- a/Objects/funcobject.c +++ b/Objects/funcobject.c @@ -5,6 +5,7 @@ #include "pycore_object.h" #include "pycore_pymem.h" #include "pycore_pystate.h" +#include "pycore_tupleobject.h" #include "code.h" #include "structmember.h" diff --git a/PCbuild/pythoncore.vcxproj b/PCbuild/pythoncore.vcxproj index 34cd3796888c..8aa4c0610f60 100644 --- a/PCbuild/pythoncore.vcxproj +++ b/PCbuild/pythoncore.vcxproj @@ -127,6 +127,7 @@ <ClInclude Include="..\Include\internal\pycore_pylifecycle.h" /> <ClInclude Include="..\Include\internal\pycore_pymem.h" /> <ClInclude Include="..\Include\internal\pycore_pystate.h" /> + <ClInclude Include="..\Include\internal\pycore_tupleobject.h" /> <ClInclude Include="..\Include\internal\pycore_warnings.h" /> <ClInclude Include="..\Include\intrcheck.h" /> <ClInclude Include="..\Include\iterobject.h" /> diff --git a/PCbuild/pythoncore.vcxproj.filters b/PCbuild/pythoncore.vcxproj.filters index ebe5e8a169fd..021a67efccbc 100644 --- a/PCbuild/pythoncore.vcxproj.filters +++ b/PCbuild/pythoncore.vcxproj.filters @@ -180,6 +180,9 @@ <ClInclude Include="..\Include\internal\pycore_pystate.h"> <Filter>Include</Filter> </ClInclude> + <ClInclude Include="..\Include\internal\pycore_tupleobject.h"> + <Filter>Include</Filter> + </ClInclude> <ClInclude Include="..\Include\internal\pycore_warnings.h"> <Filter>Include</Filter> </ClInclude> diff --git a/Python/ceval.c b/Python/ceval.c index 7b2465592a4b..a4273adee48d 100644 --- a/Python/ceval.c +++ b/Python/ceval.c @@ -12,6 +12,7 @@ #include "Python.h" #include "pycore_object.h" #include "pycore_pystate.h" +#include "pycore_tupleobject.h" #include "code.h" #include "dictobject.h" diff --git a/Python/getargs.c b/Python/getargs.c index 89df29e31527..ac8bac3bf50b 100644 --- a/Python/getargs.c +++ b/Python/getargs.c @@ -2,6 +2,7 @@ /* New getargs implementation */ #include "Python.h" +#include "pycore_tupleobject.h" #include <ctype.h> #include <float.h>

1 0

bpo-35081: Add _PyTuple_CAST() (GH-10704)
by Victor Stinner 25 Nov '18

25 Nov '18

https://github.com/python/cpython/commit/8ac6539d85b481fc6b5e9145446b07e591… commit: 8ac6539d85b481fc6b5e9145446b07e591b2caba branch: master author: Victor Stinner <vstinner(a)redhat.com> committer: GitHub <noreply(a)github.com> date: 2018-11-25T23:30:32+01:00 summary: bpo-35081: Add _PyTuple_CAST() (GH-10704) files: M Include/tupleobject.h diff --git a/Include/tupleobject.h b/Include/tupleobject.h index 257e05aeae8f..a150d07d3e0a 100644 --- a/Include/tupleobject.h +++ b/Include/tupleobject.h @@ -55,15 +55,18 @@ PyAPI_FUNC(void) _PyTuple_MaybeUntrack(PyObject *); /* Macro, trading safety for speed */ #ifndef Py_LIMITED_API -#define PyTuple_GET_ITEM(op, i) (((PyTupleObject *)(op))->ob_item[i]) -#define PyTuple_GET_SIZE(op) (assert(PyTuple_Check(op)),Py_SIZE(op)) +/* Cast argument to PyTupleObject* type. */ +#define _PyTuple_CAST(op) ((PyTupleObject *)(op)) + +#define PyTuple_GET_ITEM(op, i) (_PyTuple_CAST(op)->ob_item[i]) +#define PyTuple_GET_SIZE(op) (assert(PyTuple_Check(op)), Py_SIZE(op)) #ifdef Py_BUILD_CORE -# define _PyTuple_ITEMS(op) ((((PyTupleObject *)(op))->ob_item)) +# define _PyTuple_ITEMS(op) (_PyTuple_CAST(op)->ob_item) #endif /* Macro, *only* to be used to fill in brand new tuples */ -#define PyTuple_SET_ITEM(op, i, v) (((PyTupleObject *)(op))->ob_item[i] = v) +#define PyTuple_SET_ITEM(op, i, v) (_PyTuple_CAST(op)->ob_item[i] = v) #endif PyAPI_FUNC(int) PyTuple_ClearFreeList(void);

1 0

closes bpo-35309: cpath should be capath (GH-10701)
by Benjamin Peterson 25 Nov '18

25 Nov '18

https://github.com/python/cpython/commit/6a528ccb4c09933c434be1011b2f5e1481… commit: 6a528ccb4c09933c434be1011b2f5e148170d3a1 branch: 3.7 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: Benjamin Peterson <benjamin(a)python.org> date: 2018-11-25T14:51:02-06:00 summary: closes bpo-35309: cpath should be capath (GH-10701) (cherry picked from commit 158695817d736df8b18682866033c87e46252309) Co-authored-by: Boštjan Mejak <bostjan.xperia(a)gmail.com> files: M Lib/urllib/request.py diff --git a/Lib/urllib/request.py b/Lib/urllib/request.py index 5b962f7dc20b..d38f725d8e9f 100644 --- a/Lib/urllib/request.py +++ b/Lib/urllib/request.py @@ -198,7 +198,7 @@ def urlopen(url, data=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT, global _opener if cafile or capath or cadefault: import warnings - warnings.warn("cafile, cpath and cadefault are deprecated, use a " + warnings.warn("cafile, capath and cadefault are deprecated, use a " "custom context instead.", DeprecationWarning, 2) if context is not None: raise ValueError(

1 0

closes bpo-35309: cpath should be capath (GH-10702)
by Benjamin Peterson 25 Nov '18

25 Nov '18

https://github.com/python/cpython/commit/8c1592e53a8981451f59050198da34a584… commit: 8c1592e53a8981451f59050198da34a584160b4e branch: 3.6 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: Benjamin Peterson <benjamin(a)python.org> date: 2018-11-25T14:50:46-06:00 summary: closes bpo-35309: cpath should be capath (GH-10702) (cherry picked from commit 158695817d736df8b18682866033c87e46252309) Co-authored-by: Boštjan Mejak <bostjan.xperia(a)gmail.com> files: M Lib/urllib/request.py diff --git a/Lib/urllib/request.py b/Lib/urllib/request.py index 96921440edea..d28f2f8369c7 100644 --- a/Lib/urllib/request.py +++ b/Lib/urllib/request.py @@ -199,7 +199,7 @@ def urlopen(url, data=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT, global _opener if cafile or capath or cadefault: import warnings - warnings.warn("cafile, cpath and cadefault are deprecated, use a " + warnings.warn("cafile, capath and cadefault are deprecated, use a " "custom context instead.", DeprecationWarning, 2) if context is not None: raise ValueError(

1 0

closes bpo-35309: cpath should be capath (GH-10699)
by Benjamin Peterson 25 Nov '18

25 Nov '18

https://github.com/python/cpython/commit/158695817d736df8b18682866033c87e46… commit: 158695817d736df8b18682866033c87e46252309 branch: master author: Boštjan Mejak <bostjan.xperia(a)gmail.com> committer: Benjamin Peterson <benjamin(a)python.org> date: 2018-11-25T12:32:50-06:00 summary: closes bpo-35309: cpath should be capath (GH-10699) files: M Lib/urllib/request.py diff --git a/Lib/urllib/request.py b/Lib/urllib/request.py index 9d50b688a3a5..9a3d399f0189 100644 --- a/Lib/urllib/request.py +++ b/Lib/urllib/request.py @@ -198,7 +198,7 @@ def urlopen(url, data=None, timeout=socket._GLOBAL_DEFAULT_TIMEOUT, global _opener if cafile or capath or cadefault: import warnings - warnings.warn("cafile, cpath and cadefault are deprecated, use a " + warnings.warn("cafile, capath and cadefault are deprecated, use a " "custom context instead.", DeprecationWarning, 2) if context is not None: raise ValueError(

1 0

bpo-32035: Fix words about strings and bytes in zipfile documentation. (GH-10592)
by Miss Islington (bot) 25 Nov '18

25 Nov '18

https://github.com/python/cpython/commit/af009fbcdb00fffced653792eb7af6b72f… commit: af009fbcdb00fffced653792eb7af6b72f2521e3 branch: 3.6 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: GitHub <noreply(a)github.com> date: 2018-11-25T01:30:45-08:00 summary: bpo-32035: Fix words about strings and bytes in zipfile documentation. (GH-10592) (cherry picked from commit 4bb186d7e253ad4def875305e06690181e923dfd) Co-authored-by: Serhiy Storchaka <storchaka(a)gmail.com> files: M Doc/library/zipfile.rst M Lib/zipfile.py diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst index b7563f662ddb..b65b61d8dad8 100644 --- a/Doc/library/zipfile.rst +++ b/Doc/library/zipfile.rst @@ -360,13 +360,6 @@ ZipFile Objects the new entry. The archive must be open with mode ``'w'``, ``'x'`` or ``'a'``. - .. note:: - - There is no official file name encoding for ZIP files. If you have unicode file - names, you must convert them to byte strings in your desired encoding before - passing them to :meth:`write`. WinZip interprets all file names as encoded in - CP437, also known as DOS Latin. - .. note:: Archive names should be relative to the archive root, that is, they should not @@ -385,7 +378,9 @@ ZipFile Objects .. method:: ZipFile.writestr(zinfo_or_arcname, data[, compress_type]) - Write the string *data* to the archive; *zinfo_or_arcname* is either the file + Write a file into the archive. The contents is *data*, which may be either + a :class:`str` or a :class:`bytes` instance; if it is a :class:`str`, + it is encoded as UTF-8 first. *zinfo_or_arcname* is either the file name it will be given in the archive, or a :class:`ZipInfo` instance. If it's an instance, at least the filename, date, and time must be given. If it's a name, the date and time is set to the current date and time. @@ -425,11 +420,11 @@ The following data attributes are also available: .. attribute:: ZipFile.comment - The comment text associated with the ZIP file. If assigning a comment to a + The comment associated with the ZIP file as a :class:`bytes` object. + If assigning a comment to a :class:`ZipFile` instance created with mode ``'w'``, ``'x'`` or ``'a'``, - this should be a - string no longer than 65535 bytes. Comments longer than this will be - truncated in the written archive when :meth:`close` is called. + it should be no longer than 65535 bytes. Comments longer than this will be + truncated. .. _pyzipfile-objects: @@ -583,13 +578,14 @@ Instances have the following methods and attributes: .. attribute:: ZipInfo.comment - Comment for the individual archive member. + Comment for the individual archive member as a :class:`bytes` object. .. attribute:: ZipInfo.extra Expansion field data. The `PKZIP Application Note`_ contains - some comments on the internal structure of the data contained in this string. + some comments on the internal structure of the data contained in this + :class:`bytes` object. .. attribute:: ZipInfo.create_system diff --git a/Lib/zipfile.py b/Lib/zipfile.py index 5bb35870a689..edde0c5fd4a5 100644 --- a/Lib/zipfile.py +++ b/Lib/zipfile.py @@ -405,7 +405,7 @@ def __repr__(self): return ''.join(result) def FileHeader(self, zip64=None): - """Return the per-file header as a string.""" + """Return the per-file header as a bytes object.""" dt = self.date_time dosdate = (dt[0] - 1980) << 9 | dt[1] << 5 | dt[2] dostime = dt[3] << 11 | dt[4] << 5 | (dt[5] // 2) @@ -1333,7 +1333,7 @@ def comment(self, comment): self._didModify = True def read(self, name, pwd=None): - """Return file bytes (as a string) for name.""" + """Return file bytes for name.""" with self.open(name, "r", pwd) as fp: return fp.read()

1 0

bpo-32035: Fix words about strings and bytes in zipfile documentation. (GH-10592)
by Miss Islington (bot) 25 Nov '18

25 Nov '18

https://github.com/python/cpython/commit/89a3087d40feed3ca78033319389437bb4… commit: 89a3087d40feed3ca78033319389437bb4b5bcd7 branch: 3.7 author: Miss Islington (bot) <31488909+miss-islington(a)users.noreply.github.com> committer: GitHub <noreply(a)github.com> date: 2018-11-25T01:30:37-08:00 summary: bpo-32035: Fix words about strings and bytes in zipfile documentation. (GH-10592) (cherry picked from commit 4bb186d7e253ad4def875305e06690181e923dfd) Co-authored-by: Serhiy Storchaka <storchaka(a)gmail.com> files: M Doc/library/zipfile.rst M Lib/zipfile.py diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst index 7804e92e5374..e1f8b9a4a32a 100644 --- a/Doc/library/zipfile.rst +++ b/Doc/library/zipfile.rst @@ -378,13 +378,6 @@ ZipFile Objects given. The archive must be open with mode ``'w'``, ``'x'`` or ``'a'``. - .. note:: - - There is no official file name encoding for ZIP files. If you have unicode file - names, you must convert them to byte strings in your desired encoding before - passing them to :meth:`write`. WinZip interprets all file names as encoded in - CP437, also known as DOS Latin. - .. note:: Archive names should be relative to the archive root, that is, they should not @@ -404,7 +397,9 @@ ZipFile Objects .. method:: ZipFile.writestr(zinfo_or_arcname, data, compress_type=None, \ compresslevel=None) - Write the string *data* to the archive; *zinfo_or_arcname* is either the file + Write a file into the archive. The contents is *data*, which may be either + a :class:`str` or a :class:`bytes` instance; if it is a :class:`str`, + it is encoded as UTF-8 first. *zinfo_or_arcname* is either the file name it will be given in the archive, or a :class:`ZipInfo` instance. If it's an instance, at least the filename, date, and time must be given. If it's a name, the date and time is set to the current date and time. @@ -445,11 +440,11 @@ The following data attributes are also available: .. attribute:: ZipFile.comment - The comment text associated with the ZIP file. If assigning a comment to a + The comment associated with the ZIP file as a :class:`bytes` object. + If assigning a comment to a :class:`ZipFile` instance created with mode ``'w'``, ``'x'`` or ``'a'``, - this should be a - string no longer than 65535 bytes. Comments longer than this will be - truncated in the written archive when :meth:`close` is called. + it should be no longer than 65535 bytes. Comments longer than this will be + truncated. .. _pyzipfile-objects: @@ -606,13 +601,14 @@ Instances have the following methods and attributes: .. attribute:: ZipInfo.comment - Comment for the individual archive member. + Comment for the individual archive member as a :class:`bytes` object. .. attribute:: ZipInfo.extra Expansion field data. The `PKZIP Application Note`_ contains - some comments on the internal structure of the data contained in this string. + some comments on the internal structure of the data contained in this + :class:`bytes` object. .. attribute:: ZipInfo.create_system diff --git a/Lib/zipfile.py b/Lib/zipfile.py index a43878575db8..d2d3b693282d 100644 --- a/Lib/zipfile.py +++ b/Lib/zipfile.py @@ -402,7 +402,7 @@ def __repr__(self): return ''.join(result) def FileHeader(self, zip64=None): - """Return the per-file header as a string.""" + """Return the per-file header as a bytes object.""" dt = self.date_time dosdate = (dt[0] - 1980) << 9 | dt[1] << 5 | dt[2] dostime = dt[3] << 11 | dt[4] << 5 | (dt[5] // 2) @@ -1424,7 +1424,7 @@ def comment(self, comment): self._didModify = True def read(self, name, pwd=None): - """Return file bytes (as a string) for name.""" + """Return file bytes for name.""" with self.open(name, "r", pwd) as fp: return fp.read()

1 0

Daily reference leaks (4243df51fe43): sum=-2
by solipsis＠pitrou.net 25 Nov '18

25 Nov '18

results for 4243df51fe43 on branch "default" -------------------------------------------- test_collections leaked [-7, 1, 0] memory blocks, sum=-6 test_functools leaked [0, 3, 1] memory blocks, sum=4 test_multiprocessing_forkserver leaked [-2, 2, 0] memory blocks, sum=0 test_multiprocessing_spawn leaked [0, -2, 2] memory blocks, sum=0 Command line was: ['./python', '-m', 'test.regrtest', '-uall', '-R', '3:3:/home/psf-users/antoine/refleaks/reflog9N0uMw', '--timeout', '7200']

1 0

bpo-32035: Fix words about strings and bytes in zipfile documentation. (GH-10592)
by Serhiy Storchaka 25 Nov '18

25 Nov '18

https://github.com/python/cpython/commit/4bb186d7e253ad4def875305e06690181e… commit: 4bb186d7e253ad4def875305e06690181e923dfd branch: master author: Serhiy Storchaka <storchaka(a)gmail.com> committer: GitHub <noreply(a)github.com> date: 2018-11-25T09:51:14+02:00 summary: bpo-32035: Fix words about strings and bytes in zipfile documentation. (GH-10592) files: M Doc/library/zipfile.rst M Lib/zipfile.py diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst index 8d8612afa39b..1437730087a7 100644 --- a/Doc/library/zipfile.rst +++ b/Doc/library/zipfile.rst @@ -387,13 +387,6 @@ ZipFile Objects given. The archive must be open with mode ``'w'``, ``'x'`` or ``'a'``. - .. note:: - - There is no official file name encoding for ZIP files. If you have unicode file - names, you must convert them to byte strings in your desired encoding before - passing them to :meth:`write`. WinZip interprets all file names as encoded in - CP437, also known as DOS Latin. - .. note:: Archive names should be relative to the archive root, that is, they should not @@ -413,7 +406,9 @@ ZipFile Objects .. method:: ZipFile.writestr(zinfo_or_arcname, data, compress_type=None, \ compresslevel=None) - Write the string *data* to the archive; *zinfo_or_arcname* is either the file + Write a file into the archive. The contents is *data*, which may be either + a :class:`str` or a :class:`bytes` instance; if it is a :class:`str`, + it is encoded as UTF-8 first. *zinfo_or_arcname* is either the file name it will be given in the archive, or a :class:`ZipInfo` instance. If it's an instance, at least the filename, date, and time must be given. If it's a name, the date and time is set to the current date and time. @@ -454,11 +449,11 @@ The following data attributes are also available: .. attribute:: ZipFile.comment - The comment text associated with the ZIP file. If assigning a comment to a + The comment associated with the ZIP file as a :class:`bytes` object. + If assigning a comment to a :class:`ZipFile` instance created with mode ``'w'``, ``'x'`` or ``'a'``, - this should be a - string no longer than 65535 bytes. Comments longer than this will be - truncated in the written archive when :meth:`close` is called. + it should be no longer than 65535 bytes. Comments longer than this will be + truncated. .. _pyzipfile-objects: @@ -625,13 +620,14 @@ Instances have the following methods and attributes: .. attribute:: ZipInfo.comment - Comment for the individual archive member. + Comment for the individual archive member as a :class:`bytes` object. .. attribute:: ZipInfo.extra Expansion field data. The `PKZIP Application Note`_ contains - some comments on the internal structure of the data contained in this string. + some comments on the internal structure of the data contained in this + :class:`bytes` object. .. attribute:: ZipInfo.create_system diff --git a/Lib/zipfile.py b/Lib/zipfile.py index 4a6b40ee441c..dc16f6d464fd 100644 --- a/Lib/zipfile.py +++ b/Lib/zipfile.py @@ -402,7 +402,7 @@ def __repr__(self): return ''.join(result) def FileHeader(self, zip64=None): - """Return the per-file header as a string.""" + """Return the per-file header as a bytes object.""" dt = self.date_time dosdate = (dt[0] - 1980) << 9 | dt[1] << 5 | dt[2] dostime = dt[3] << 11 | dt[4] << 5 | (dt[5] // 2) @@ -1429,7 +1429,7 @@ def comment(self, comment): self._didModify = True def read(self, name, pwd=None): - """Return file bytes (as a string) for name.""" + """Return file bytes for name.""" with self.open(name, "r", pwd) as fp: return fp.read()

1 0