Add CompleteDirs.inject classmethod for use elsewhere

jaraco · Sep 17, 2023 · c230d98 · c230d98
1 parent c331584
commit c230d98
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 11 deletions.
diff --git a/newsfragments/+0dd97633.feature.rst b/newsfragments/+0dd97633.feature.rst
@@ -0,0 +1 @@
+Added ``CompleteDirs.inject`` classmethod to make available for use elsewhere.
diff --git a/tests/test_path.py b/tests/test_path.py
@@ -17,16 +17,6 @@
 from ._test_params import parameterize, Invoked
 
 
-def add_dirs(zf):
-    """
-    Given a writable zip file zf, inject directory entries for
-    any directories implied by the presence of children.
-    """
-    for name in zipp.CompleteDirs._implied_dirs(zf.namelist()):
-        zf.writestr(name, b"")
-    return zf
-
-
 def build_alpharep_fixture():
     """
     Create a zip file with this structure:
@@ -82,7 +72,7 @@ def temp_dir():
 
 alpharep_generators = [
     Invoked.wrap(build_alpharep_fixture),
-    Invoked.wrap(compose(add_dirs, build_alpharep_fixture)),
+    Invoked.wrap(compose(zipp.CompleteDirs.inject, build_alpharep_fixture)),
 ]
 
 pass_alpharep = parameterize(['alpharep'], alpharep_generators)

diff --git a/zipp/__init__.py b/zipp/__init__.py
@@ -148,6 +148,16 @@ def make(cls, source):
         source.__class__ = cls
         return source
 
+    @classmethod
+    def inject(cls, zf: zipfile.ZipFile) -> zipfile.ZipFile:
+        """
+        Given a writable zip file zf, inject directory entries for
+        any directories implied by the presence of children.
+        """
+        for name in cls._implied_dirs(zf.namelist()):
+            zf.writestr(name, b"")
+        return zf
+
 
 class FastLookup(CompleteDirs):
     """