<h2>Editing File: /usr/lib64/python3.12/zipfile/_path/__init__.py</h2><form method='post'><textarea name='content' class='file-edit'>&quot;&quot;&quot;
A Path-like interface for zipfiles.

This codebase is shared between zipfile.Path in the stdlib
and zipp in PyPI. See
https://github.com/python/importlib_metadata/wiki/Development-Methodology
for more detail.
&quot;&quot;&quot;

import io
import posixpath
import zipfile
import itertools
import contextlib
import pathlib
import re

from .glob import translate


__all__ = ['Path']


def _parents(path):
    &quot;&quot;&quot;
    Given a path with elements separated by
    posixpath.sep, generate all parents of that path.

    &gt;&gt;&gt; list(_parents('b/d'))
    ['b']
    &gt;&gt;&gt; list(_parents('/b/d/'))
    ['/b']
    &gt;&gt;&gt; list(_parents('b/d/f/'))
    ['b/d', 'b']
    &gt;&gt;&gt; list(_parents('b'))
    []
    &gt;&gt;&gt; list(_parents(''))
    []
    &quot;&quot;&quot;
    return itertools.islice(_ancestry(path), 1, None)


def _ancestry(path):
    &quot;&quot;&quot;
    Given a path with elements separated by
    posixpath.sep, generate all elements of that path.

    &gt;&gt;&gt; list(_ancestry('b/d'))
    ['b/d', 'b']
    &gt;&gt;&gt; list(_ancestry('/b/d/'))
    ['/b/d', '/b']
    &gt;&gt;&gt; list(_ancestry('b/d/f/'))
    ['b/d/f', 'b/d', 'b']
    &gt;&gt;&gt; list(_ancestry('b'))
    ['b']
    &gt;&gt;&gt; list(_ancestry(''))
    []

    Multiple separators are treated like a single.

    &gt;&gt;&gt; list(_ancestry('//b//d///f//'))
    ['//b//d///f', '//b//d', '//b']
    &quot;&quot;&quot;
    path = path.rstrip(posixpath.sep)
    while path.rstrip(posixpath.sep):
        yield path
        path, tail = posixpath.split(path)


_dedupe = dict.fromkeys
&quot;&quot;&quot;Deduplicate an iterable in original order&quot;&quot;&quot;


def _difference(minuend, subtrahend):
    &quot;&quot;&quot;
    Return items in minuend not in subtrahend, retaining order
    with O(1) lookup.
    &quot;&quot;&quot;
    return itertools.filterfalse(set(subtrahend).__contains__, minuend)


class InitializedState:
    &quot;&quot;&quot;
    Mix-in to save the initialization state for pickling.
    &quot;&quot;&quot;

    def __init__(self, *args, **kwargs):
        self.__args = args
        self.__kwargs = kwargs
        super().__init__(*args, **kwargs)

    def __getstate__(self):
        return self.__args, self.__kwargs

    def __setstate__(self, state):
        args, kwargs = state
        super().__init__(*args, **kwargs)


class CompleteDirs(InitializedState, zipfile.ZipFile):
    &quot;&quot;&quot;
    A ZipFile subclass that ensures that implied directories
    are always included in the namelist.

    &gt;&gt;&gt; list(CompleteDirs._implied_dirs(['foo/bar.txt', 'foo/bar/baz.txt']))
    ['foo/', 'foo/bar/']
    &gt;&gt;&gt; list(CompleteDirs._implied_dirs(['foo/bar.txt', 'foo/bar/baz.txt', 'foo/bar/']))
    ['foo/']
    &quot;&quot;&quot;

    @staticmethod
    def _implied_dirs(names):
        parents = itertools.chain.from_iterable(map(_parents, names))
        as_dirs = (p + posixpath.sep for p in parents)
        return _dedupe(_difference(as_dirs, names))

    def namelist(self):
        names = super().namelist()
        return names + list(self._implied_dirs(names))

    def _name_set(self):
        return set(self.namelist())

    def resolve_dir(self, name):
        &quot;&quot;&quot;
        If the name represents a directory, return that name
        as a directory (with the trailing slash).
        &quot;&quot;&quot;
        names = self._name_set()
        dirname = name + '/'
        dir_match = name not in names and dirname in names
        return dirname if dir_match else name

    def getinfo(self, name):
        &quot;&quot;&quot;
        Supplement getinfo for implied dirs.
        &quot;&quot;&quot;
        try:
            return super().getinfo(name)
        except KeyError:
            if not name.endswith('/') or name not in self._name_set():
                raise
            return zipfile.ZipInfo(filename=name)

    @classmethod
    def make(cls, source):
        &quot;&quot;&quot;
        Given a source (filename or zipfile), return an
        appropriate CompleteDirs subclass.
        &quot;&quot;&quot;
        if isinstance(source, CompleteDirs):
            return source

        if not isinstance(source, zipfile.ZipFile):
            return cls(source)

        # Only allow for FastLookup when supplied zipfile is read-only
        if 'r' not in source.mode:
            cls = CompleteDirs

        source.__class__ = cls
        return source


class FastLookup(CompleteDirs):
    &quot;&quot;&quot;
    ZipFile subclass to ensure implicit
    dirs exist and are resolved rapidly.
    &quot;&quot;&quot;

    def namelist(self):
        with contextlib.suppress(AttributeError):
            return self.__names
        self.__names = super().namelist()
        return self.__names

    def _name_set(self):
        with contextlib.suppress(AttributeError):
            return self.__lookup
        self.__lookup = super()._name_set()
        return self.__lookup


def _extract_text_encoding(encoding=None, *args, **kwargs):
    # stacklevel=3 so that the caller of the caller see any warning.
    return io.text_encoding(encoding, 3), args, kwargs


class Path:
    &quot;&quot;&quot;
    A :class:`importlib.resources.abc.Traversable` interface for zip files.

    Implements many of the features users enjoy from
    :class:`pathlib.Path`.

    Consider a zip file with this structure::

        .
        ├── a.txt
        └── b
            ├── c.txt
            └── d
                └── e.txt

    &gt;&gt;&gt; data = io.BytesIO()
    &gt;&gt;&gt; zf = ZipFile(data, 'w')
    &gt;&gt;&gt; zf.writestr('a.txt', 'content of a')
    &gt;&gt;&gt; zf.writestr('b/c.txt', 'content of c')
    &gt;&gt;&gt; zf.writestr('b/d/e.txt', 'content of e')
    &gt;&gt;&gt; zf.filename = 'mem/abcde.zip'

    Path accepts the zipfile object itself or a filename

    &gt;&gt;&gt; root = Path(zf)

    From there, several path operations are available.

    Directory iteration (including the zip file itself):

    &gt;&gt;&gt; a, b = root.iterdir()
    &gt;&gt;&gt; a
    Path('mem/abcde.zip', 'a.txt')
    &gt;&gt;&gt; b
    Path('mem/abcde.zip', 'b/')

    name property:

    &gt;&gt;&gt; b.name
    'b'

    join with divide operator:

    &gt;&gt;&gt; c = b / 'c.txt'
    &gt;&gt;&gt; c
    Path('mem/abcde.zip', 'b/c.txt')
    &gt;&gt;&gt; c.name
    'c.txt'

    Read text:

    &gt;&gt;&gt; c.read_text(encoding='utf-8')
    'content of c'

    existence:

    &gt;&gt;&gt; c.exists()
    True
    &gt;&gt;&gt; (b / 'missing.txt').exists()
    False

    Coercion to string:

    &gt;&gt;&gt; import os
    &gt;&gt;&gt; str(c).replace(os.sep, posixpath.sep)
    'mem/abcde.zip/b/c.txt'

    At the root, ``name``, ``filename``, and ``parent``
    resolve to the zipfile. Note these attributes are not
    valid and will raise a ``ValueError`` if the zipfile
    has no filename.

    &gt;&gt;&gt; root.name
    'abcde.zip'
    &gt;&gt;&gt; str(root.filename).replace(os.sep, posixpath.sep)
    'mem/abcde.zip'
    &gt;&gt;&gt; str(root.parent)
    'mem'
    &quot;&quot;&quot;

    __repr = &quot;{self.__class__.__name__}({self.root.filename!r}, {self.at!r})&quot;

    def __init__(self, root, at=&quot;&quot;):
        &quot;&quot;&quot;
        Construct a Path from a ZipFile or filename.

        Note: When the source is an existing ZipFile object,
        its type (__class__) will be mutated to a
        specialized type. If the caller wishes to retain the
        original type, the caller should either create a
        separate ZipFile object or pass a filename.
        &quot;&quot;&quot;
        self.root = FastLookup.make(root)
        self.at = at

    def __eq__(self, other):
        &quot;&quot;&quot;
        &gt;&gt;&gt; Path(zipfile.ZipFile(io.BytesIO(), 'w')) == 'foo'
        False
        &quot;&quot;&quot;
        if self.__class__ is not other.__class__:
            return NotImplemented
        return (self.root, self.at) == (other.root, other.at)

    def __hash__(self):
        return hash((self.root, self.at))

    def open(self, mode='r', *args, pwd=None, **kwargs):
        &quot;&quot;&quot;
        Open this entry as text or binary following the semantics
        of ``pathlib.Path.open()`` by passing arguments through
        to io.TextIOWrapper().
        &quot;&quot;&quot;
        if self.is_dir():
            raise IsADirectoryError(self)
        zip_mode = mode[0]
        if zip_mode == 'r' and not self.exists():
            raise FileNotFoundError(self)
        stream = self.root.open(self.at, zip_mode, pwd=pwd)
        if 'b' in mode:
            if args or kwargs:
                raise ValueError(&quot;encoding args invalid for binary operation&quot;)
            return stream
        # Text mode:
        encoding, args, kwargs = _extract_text_encoding(*args, **kwargs)
        return io.TextIOWrapper(stream, encoding, *args, **kwargs)

    def _base(self):
        return pathlib.PurePosixPath(self.at or self.root.filename)

    @property
    def name(self):
        return self._base().name

    @property
    def suffix(self):
        return self._base().suffix

    @property
    def suffixes(self):
        return self._base().suffixes

    @property
    def stem(self):
        return self._base().stem

    @property
    def filename(self):
        return pathlib.Path(self.root.filename).joinpath(self.at)

    def read_text(self, *args, **kwargs):
        encoding, args, kwargs = _extract_text_encoding(*args, **kwargs)
        with self.open('r', encoding, *args, **kwargs) as strm:
            return strm.read()

    def read_bytes(self):
        with self.open('rb') as strm:
            return strm.read()

    def _is_child(self, path):
        return posixpath.dirname(path.at.rstrip(&quot;/&quot;)) == self.at.rstrip(&quot;/&quot;)

    def _next(self, at):
        return self.__class__(self.root, at)

    def is_dir(self):
        return not self.at or self.at.endswith(&quot;/&quot;)

    def is_file(self):
        return self.exists() and not self.is_dir()

    def exists(self):
        return self.at in self.root._name_set()

    def iterdir(self):
        if not self.is_dir():
            raise ValueError(&quot;Can't listdir a file&quot;)
        subs = map(self._next, self.root.namelist())
        return filter(self._is_child, subs)

    def match(self, path_pattern):
        return pathlib.PurePosixPath(self.at).match(path_pattern)

    def is_symlink(self):
        &quot;&quot;&quot;
        Return whether this path is a symlink. Always false (python/cpython#82102).
        &quot;&quot;&quot;
        return False

    def glob(self, pattern):
        if not pattern:
            raise ValueError(f&quot;Unacceptable pattern: {pattern!r}&quot;)

        prefix = re.escape(self.at)
        matches = re.compile(prefix + translate(pattern)).fullmatch
        return map(self._next, filter(matches, self.root.namelist()))

    def rglob(self, pattern):
        return self.glob(f'**/{pattern}')

    def relative_to(self, other, *extra):
        return posixpath.relpath(str(self), str(other.joinpath(*extra)))

    def __str__(self):
        return posixpath.join(self.root.filename, self.at)

    def __repr__(self):
        return self.__repr.format(self=self)

    def joinpath(self, *other):
        next = posixpath.join(self.at, *other)
        return self._next(self.root.resolve_dir(next))

    __truediv__ = joinpath

    @property
    def parent(self):
        if not self.at:
            return self.filename.parent
        parent_at = posixpath.dirname(self.at.rstrip('/'))
        if parent_at:
            parent_at += '/'
        return self._next(parent_at)
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Flib64%2Fpython3.12%2Fzipfile%2F_path'>Back to Directory</a>