To avoid passthrough parameters, use _for_archive to mutate a constructed ZipInfo.

jaraco · jaraco · commit 44e7b75ffe61 · 2024-12-29T13:06:52.000-05:00
diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst
@@ -85,13 +85,12 @@ The module defines the following items:
       continues to work as a property for backwards compatibility.
 
 
-   .. classmethod:: for_name(filename, archive, *, date_time=None)
+   .. method:: _for_archive(archive)
 
-      Construct an appropriate :class:`ZipInfo` from a *filename*,
-      a :class:`ZipFile` archive and an optional *date_time*.
+      Resolve the date_time, compression attributes, and external attributes
+      to suitable defaults as used by :meth:`ZipFile.writestr`.
 
-      If *date_time* is not specified, the current local time is used
-      instead, namely ``date_time = time.localtime(time.time())[:6]``.
+      Returns self for chaining.
 
       .. versionadded:: 3.14
 
diff --git a/Doc/whatsnew/3.14.rst b/Doc/whatsnew/3.14.rst
@@ -664,9 +664,9 @@ uuid
 zipinfo
 -------
 
-* Added :func:`ZipInfo.for_name <zipfile.ZipInfo.for_name>` for
-  constructing a :class:`~zipfile.ZipInfo` object from a filename
-  and an archive.
+* Added :func:`ZipInfo._for_archive <zipfile.ZipInfo._for_archive>`
+  to resolve suitable defaults for a :class:`~zipfile.ZipInfo` object
+  as used by :func:`ZipFile.writestr <zipfile.ZipFile.writestr>`.
 
   (Contributed by Bénédikt Tran in :gh:`123424`.)
 
diff --git a/Lib/test/test_zipfile/_path/test_path.py b/Lib/test/test_zipfile/_path/test_path.py
@@ -634,7 +634,7 @@ def test_backslash_not_separator(self):
         """
         data = io.BytesIO()
         zf = zipfile.ZipFile(data, "w")
-        zf.writestr(DirtyZipInfo.for_name("foo\\bar", zf), b"content")
+        zf.writestr(DirtyZipInfo("foo\\bar")._for_archive(zf), b"content")
         zf.filename = ''
         root = zipfile.Path(zf)
         (first,) = root.iterdir()
diff --git a/Lib/test/test_zipfile/test_core.py b/Lib/test/test_zipfile/test_core.py
@@ -2212,13 +2212,13 @@ def test_create_empty_zipinfo_repr(self):
         zi = zipfile.ZipInfo(filename="empty")
         self.assertEqual(repr(zi), "<ZipInfo filename='empty' file_size=0>")
 
-    def test_create_zipinfo_for_name(self):
+    def test_for_archive(self):
         base_filename = TESTFN2.rstrip('/')
 
         with zipfile.ZipFile(TESTFN, mode="w", compresslevel=1,
                              compression=zipfile.ZIP_STORED) as zf:
             # no trailing forward slash
-            zi = zipfile.ZipInfo.for_name(base_filename, zf)
+            zi = zipfile.ZipInfo(base_filename)._for_archive(zf)
             self.assertEqual(zi.compress_level, 1)
             self.assertEqual(zi.compress_type, zipfile.ZIP_STORED)
             # ?rw- --- ---
@@ -2230,7 +2230,7 @@ def test_create_zipinfo_for_name(self):
         with zipfile.ZipFile(TESTFN, mode="w", compresslevel=1,
                              compression=zipfile.ZIP_STORED) as zf:
             # with a trailing slash
-            zi = zipfile.ZipInfo.for_name(f'{base_filename}/', zf)
+            zi = zipfile.ZipInfo(f'{base_filename}/')._for_archive(zf)
             self.assertEqual(zi.compress_level, 1)
             self.assertEqual(zi.compress_type, zipfile.ZIP_STORED)
             # d rwx rwx r-x
diff --git a/Lib/zipfile/__init__.py b/Lib/zipfile/__init__.py
@@ -13,6 +13,7 @@
 import sys
 import threading
 import time
+from typing import Self
 
 try:
     import zlib # We may need its compression method
@@ -605,17 +606,15 @@ def from_file(cls, filename, arcname=None, *, strict_timestamps=True):
 
         return zinfo
 
-    @classmethod
-    def for_name(cls, filename, archive, *, date_time=None):
-        """Construct an appropriate ZipInfo from a filename and a ZipFile.
+    def _for_archive(self, archive: ZipFile) -> Self:
+        """Resolve suitable defaults from the archive.
 
-        The *filename* is expected to be the name of a file in the archive.
+        Resolve the date_time, compression attributes, and external attributes
+        to suitable defaults as used by :method:`ZipFile.writestr`.
 
-        If *date_time* is not specified, the current local time is used.
+        Return self.
         """
-        if date_time is None:
-            date_time = time.localtime(time.time())[:6]
-        self = cls(filename=filename, date_time=date_time)
+        self.date_time = time.localtime(time.time())[:6]
         self.compress_type = archive.compression
         self.compress_level = archive.compresslevel
         if self.filename.endswith('/'):  # pragma: no cover
@@ -1931,7 +1930,7 @@ def writestr(self, zinfo_or_arcname, data,
         if isinstance(zinfo_or_arcname, ZipInfo):
             zinfo = zinfo_or_arcname
         else:
-            zinfo = ZipInfo.for_name(zinfo_or_arcname, self)
+            zinfo = ZipInfo(zinfo_or_arcname)._for_archive(self)
 
         if not self.fp:
             raise ValueError(
diff --git a/Misc/NEWS.d/next/Library/2024-08-28-16-10-37.gh-issue-123424.u96_i6.rst b/Misc/NEWS.d/next/Library/2024-08-28-16-10-37.gh-issue-123424.u96_i6.rst
@@ -1,3 +1 @@
-Add :meth:`zipfile.ZipInfo.for_name` factory for constructing
-:class:`~zipfile.ZipInfo` objects from a filename and an archive. Patch by
-Bénédikt Tran.
+Add :meth:`zipfile.ZipInfo._for_archive` setting default properties on :class:`~zipfile.ZipInfo` objects. Patch by Bénédikt Tran and Jason R. Coombs.
