mirror of
https://github.com/RustPython/RustPython.git
synced 2026-10-28 18:59:04 +08:00
Updated the importlib + nturl2path + pathlib libraries + associated tests - v3.13.10 (#6609)
* Updated the nturl2path library * Updated pathlib library + test * Updated urllib test * Added expectedFailure to failing tests * Updated importlib library
This commit is contained in:
1 parent
1e706d911e
commit
a4df238b3d
25 files changed
+6750
-5115
No files matched your search
Vendored
+1
-3
@@ -54,8 +54,6 @@ _unpack_uint32 = _bootstrap_external._unpack_uint32
|
||||
# Fully bootstrapped at this point, import whatever you like, circular
|
||||
# dependencies and startup overhead minimisation permitting :)
|
||||
|
||||
import warnings
|
||||
|
||||
|
||||
# Public API #########################################################
|
||||
|
||||
@@ -105,7 +103,7 @@ def reload(module):
|
||||
try:
|
||||
name = module.__name__
|
||||
except AttributeError:
|
||||
raise TypeError("reload() argument must be a module")
|
||||
raise TypeError("reload() argument must be a module") from None
|
||||
|
||||
if sys.modules.get(name) is not module:
|
||||
raise ImportError(f"module {name} not in sys.modules", name=name)
|
||||
|
||||
Vendored
+11
-5
@@ -53,7 +53,7 @@ def _new_module(name):
|
||||
|
||||
# For a list that can have a weakref to it.
|
||||
class _List(list):
|
||||
pass
|
||||
__slots__ = ("__weakref__",)
|
||||
|
||||
|
||||
# Copied from weakref.py with some simplifications and modifications unique to
|
||||
@@ -527,7 +527,7 @@ def _load_module_shim(self, fullname):
|
||||
|
||||
"""
|
||||
msg = ("the load_module() method is deprecated and slated for removal in "
|
||||
"Python 3.12; use exec_module() instead")
|
||||
"Python 3.15; use exec_module() instead")
|
||||
_warnings.warn(msg, DeprecationWarning)
|
||||
spec = spec_from_loader(fullname, self)
|
||||
if fullname in sys.modules:
|
||||
@@ -825,10 +825,16 @@ def _module_repr_from_spec(spec):
|
||||
"""Return the repr to use for the module."""
|
||||
name = '?' if spec.name is None else spec.name
|
||||
if spec.origin is None:
|
||||
if spec.loader is None:
|
||||
loader = spec.loader
|
||||
if loader is None:
|
||||
return f'<module {name!r}>'
|
||||
elif (
|
||||
_bootstrap_external is not None
|
||||
and isinstance(loader, _bootstrap_external.NamespaceLoader)
|
||||
):
|
||||
return f'<module {name!r} (namespace) from {list(loader._path)}>'
|
||||
else:
|
||||
return f'<module {name!r} (namespace) from {list(spec.loader._path)}>'
|
||||
return f'<module {name!r} ({loader!r})>'
|
||||
else:
|
||||
if spec.has_location:
|
||||
return f'<module {name!r} from {spec.origin!r}>'
|
||||
@@ -1129,7 +1135,7 @@ class FrozenImporter:
|
||||
# part of the importer), instead of here (the finder part).
|
||||
# The loader is the usual place to get the data that will
|
||||
# be loaded into the module. (For example, see _LoaderBasics
|
||||
# in _bootstra_external.py.) Most importantly, this importer
|
||||
# in _bootstrap_external.py.) Most importantly, this importer
|
||||
# is simpler if we wait to get the data.
|
||||
# However, getting as much data in the finder as possible
|
||||
# to later load the module is okay, and sometimes important.
|
||||
|
||||
Vendored
+93
-8
@@ -52,7 +52,7 @@ _pathseps_with_colon = {f':{s}' for s in path_separators}
|
||||
|
||||
# Bootstrap-related code ######################################################
|
||||
_CASE_INSENSITIVE_PLATFORMS_STR_KEY = 'win',
|
||||
_CASE_INSENSITIVE_PLATFORMS_BYTES_KEY = 'cygwin', 'darwin'
|
||||
_CASE_INSENSITIVE_PLATFORMS_BYTES_KEY = 'cygwin', 'darwin', 'ios', 'tvos', 'watchos'
|
||||
_CASE_INSENSITIVE_PLATFORMS = (_CASE_INSENSITIVE_PLATFORMS_BYTES_KEY
|
||||
+ _CASE_INSENSITIVE_PLATFORMS_STR_KEY)
|
||||
|
||||
@@ -81,6 +81,11 @@ def _pack_uint32(x):
|
||||
return (int(x) & 0xFFFFFFFF).to_bytes(4, 'little')
|
||||
|
||||
|
||||
def _unpack_uint64(data):
|
||||
"""Convert 8 bytes in little-endian to an integer."""
|
||||
assert len(data) == 8
|
||||
return int.from_bytes(data, 'little')
|
||||
|
||||
def _unpack_uint32(data):
|
||||
"""Convert 4 bytes in little-endian to an integer."""
|
||||
assert len(data) == 4
|
||||
@@ -203,7 +208,7 @@ def _write_atomic(path, data, mode=0o666):
|
||||
try:
|
||||
# We first write data to a temporary file, and then use os.replace() to
|
||||
# perform an atomic rename.
|
||||
with _io.FileIO(fd, 'wb') as file:
|
||||
with _io.open(fd, 'wb') as file:
|
||||
file.write(data)
|
||||
_os.replace(path_tmp, path)
|
||||
except OSError:
|
||||
@@ -413,6 +418,7 @@ _code_type = type(_write_atomic.__code__)
|
||||
# Python 3.11a7 3492 (make POP_JUMP_IF_NONE/NOT_NONE/TRUE/FALSE relative)
|
||||
# Python 3.11a7 3493 (Make JUMP_IF_TRUE_OR_POP/JUMP_IF_FALSE_OR_POP relative)
|
||||
# Python 3.11a7 3494 (New location info table)
|
||||
# Python 3.11b4 3495 (Set line number of module's RESUME instr to 0 per PEP 626)
|
||||
# Python 3.12a1 3500 (Remove PRECALL opcode)
|
||||
# Python 3.12a1 3501 (YIELD_VALUE oparg == stack_depth)
|
||||
# Python 3.12a1 3502 (LOAD_FAST_CHECK, no NULL-check in LOAD_FAST)
|
||||
@@ -445,8 +451,30 @@ _code_type = type(_write_atomic.__code__)
|
||||
# Python 3.12b1 3529 (Inline list/dict/set comprehensions)
|
||||
# Python 3.12b1 3530 (Shrink the LOAD_SUPER_ATTR caches)
|
||||
# Python 3.12b1 3531 (Add PEP 695 changes)
|
||||
# Python 3.13a1 3550 (Plugin optimizer support)
|
||||
# Python 3.13a1 3551 (Compact superinstructions)
|
||||
# Python 3.13a1 3552 (Remove LOAD_FAST__LOAD_CONST and LOAD_CONST__LOAD_FAST)
|
||||
# Python 3.13a1 3553 (Add SET_FUNCTION_ATTRIBUTE)
|
||||
# Python 3.13a1 3554 (more efficient bytecodes for f-strings)
|
||||
# Python 3.13a1 3555 (generate specialized opcodes metadata from bytecodes.c)
|
||||
# Python 3.13a1 3556 (Convert LOAD_CLOSURE to a pseudo-op)
|
||||
# Python 3.13a1 3557 (Make the conversion to boolean in jumps explicit)
|
||||
# Python 3.13a1 3558 (Reorder the stack items for CALL)
|
||||
# Python 3.13a1 3559 (Generate opcode IDs from bytecodes.c)
|
||||
# Python 3.13a1 3560 (Add RESUME_CHECK instruction)
|
||||
# Python 3.13a1 3561 (Add cache entry to branch instructions)
|
||||
# Python 3.13a1 3562 (Assign opcode IDs for internal ops in separate range)
|
||||
# Python 3.13a1 3563 (Add CALL_KW and remove KW_NAMES)
|
||||
# Python 3.13a1 3564 (Removed oparg from YIELD_VALUE, changed oparg values of RESUME)
|
||||
# Python 3.13a1 3565 (Oparg of YIELD_VALUE indicates whether it is in a yield-from)
|
||||
# Python 3.13a1 3566 (Emit JUMP_NO_INTERRUPT instead of JUMP for non-loop no-lineno cases)
|
||||
# Python 3.13a1 3567 (Reimplement line number propagation by the compiler)
|
||||
# Python 3.13a1 3568 (Change semantics of END_FOR)
|
||||
# Python 3.13a5 3569 (Specialize CONTAINS_OP)
|
||||
# Python 3.13a6 3570 (Add __firstlineno__ class attribute)
|
||||
# Python 3.13b1 3571 (Fix miscompilation of private names in generic classes)
|
||||
|
||||
# Python 3.13 will start with 3550
|
||||
# Python 3.14 will start with 3600
|
||||
|
||||
# Please don't copy-paste the same pre-release tag for new entries above!!!
|
||||
# You should always use the *upcoming* tag. For example, if 3.12a6 came out
|
||||
@@ -461,7 +489,7 @@ _code_type = type(_write_atomic.__code__)
|
||||
# Whenever MAGIC_NUMBER is changed, the ranges in the magic_values array
|
||||
# in PC/launcher.c must also be updated.
|
||||
|
||||
MAGIC_NUMBER = (3531).to_bytes(2, 'little') + b'\r\n'
|
||||
MAGIC_NUMBER = (3571).to_bytes(2, 'little') + b'\r\n'
|
||||
|
||||
_RAW_MAGIC_NUMBER = int.from_bytes(MAGIC_NUMBER, 'little') # For import.c
|
||||
|
||||
@@ -535,7 +563,8 @@ def cache_from_source(path, debug_override=None, *, optimization=None):
|
||||
# Strip initial drive from a Windows path. We know we have an absolute
|
||||
# path here, so the second part of the check rules out a POSIX path that
|
||||
# happens to contain a colon at the second character.
|
||||
if head[1] == ':' and head[0] not in path_separators:
|
||||
# Slicing avoids issues with an empty (or short) `head`.
|
||||
if head[1:2] == ':' and head[0:1] not in path_separators:
|
||||
head = head[2:]
|
||||
|
||||
# Strip initial path separator from `head` to complete the conversion
|
||||
@@ -1437,7 +1466,7 @@ class PathFinder:
|
||||
@staticmethod
|
||||
def invalidate_caches():
|
||||
"""Call the invalidate_caches() method on all path entry finders
|
||||
stored in sys.path_importer_caches (where implemented)."""
|
||||
stored in sys.path_importer_cache (where implemented)."""
|
||||
for name, finder in list(sys.path_importer_cache.items()):
|
||||
# Drop entry if finder name is a relative path. The current
|
||||
# working directory may have changed.
|
||||
@@ -1449,6 +1478,9 @@ class PathFinder:
|
||||
# https://bugs.python.org/issue45703
|
||||
_NamespacePath._epoch += 1
|
||||
|
||||
from importlib.metadata import MetadataPathFinder
|
||||
MetadataPathFinder.invalidate_caches()
|
||||
|
||||
@staticmethod
|
||||
def _path_hooks(path):
|
||||
"""Search sys.path_hooks for a finder for 'path'."""
|
||||
@@ -1690,6 +1722,52 @@ class FileFinder:
|
||||
return f'FileFinder({self.path!r})'
|
||||
|
||||
|
||||
class AppleFrameworkLoader(ExtensionFileLoader):
|
||||
"""A loader for modules that have been packaged as frameworks for
|
||||
compatibility with Apple's iOS App Store policies.
|
||||
"""
|
||||
def create_module(self, spec):
|
||||
# If the ModuleSpec has been created by the FileFinder, it will have
|
||||
# been created with an origin pointing to the .fwork file. We need to
|
||||
# redirect this to the location in the Frameworks folder, using the
|
||||
# content of the .fwork file.
|
||||
if spec.origin.endswith(".fwork"):
|
||||
with _io.FileIO(spec.origin, 'r') as file:
|
||||
framework_binary = file.read().decode().strip()
|
||||
bundle_path = _path_split(sys.executable)[0]
|
||||
spec.origin = _path_join(bundle_path, framework_binary)
|
||||
|
||||
# If the loader is created based on the spec for a loaded module, the
|
||||
# path will be pointing at the Framework location. If this occurs,
|
||||
# get the original .fwork location to use as the module's __file__.
|
||||
if self.path.endswith(".fwork"):
|
||||
path = self.path
|
||||
else:
|
||||
with _io.FileIO(self.path + ".origin", 'r') as file:
|
||||
origin = file.read().decode().strip()
|
||||
bundle_path = _path_split(sys.executable)[0]
|
||||
path = _path_join(bundle_path, origin)
|
||||
|
||||
module = _bootstrap._call_with_frames_removed(_imp.create_dynamic, spec)
|
||||
|
||||
_bootstrap._verbose_message(
|
||||
"Apple framework extension module {!r} loaded from {!r} (path {!r})",
|
||||
spec.name,
|
||||
spec.origin,
|
||||
path,
|
||||
)
|
||||
|
||||
# Ensure that the __file__ points at the .fwork location
|
||||
try:
|
||||
module.__file__ = path
|
||||
except AttributeError:
|
||||
# Not important enough to report.
|
||||
# (The error is also ignored in _bootstrap._init_module_attrs or
|
||||
# import_run_extension in import.c)
|
||||
pass
|
||||
|
||||
return module
|
||||
|
||||
# Import setup ###############################################################
|
||||
|
||||
def _fix_up_module(ns, name, pathname, cpathname=None):
|
||||
@@ -1722,10 +1800,17 @@ def _get_supported_file_loaders():
|
||||
|
||||
Each item is a tuple (loader, suffixes).
|
||||
"""
|
||||
extensions = ExtensionFileLoader, _imp.extension_suffixes()
|
||||
extension_loaders = []
|
||||
if hasattr(_imp, 'create_dynamic'):
|
||||
if sys.platform in {"ios", "tvos", "watchos"}:
|
||||
extension_loaders = [(AppleFrameworkLoader, [
|
||||
suffix.replace(".so", ".fwork")
|
||||
for suffix in _imp.extension_suffixes()
|
||||
])]
|
||||
extension_loaders.append((ExtensionFileLoader, _imp.extension_suffixes()))
|
||||
source = SourceFileLoader, SOURCE_SUFFIXES
|
||||
bytecode = SourcelessFileLoader, BYTECODE_SUFFIXES
|
||||
return [extensions, source, bytecode]
|
||||
return extension_loaders + [source, bytecode]
|
||||
|
||||
|
||||
def _set_bootstrap_module(_bootstrap_module):
|
||||
|
||||
Vendored
+5
-1
@@ -180,7 +180,11 @@ class ExecutionLoader(InspectLoader):
|
||||
else:
|
||||
return self.source_to_code(source, path)
|
||||
|
||||
_register(ExecutionLoader, machinery.ExtensionFileLoader)
|
||||
_register(
|
||||
ExecutionLoader,
|
||||
machinery.ExtensionFileLoader,
|
||||
machinery.AppleFrameworkLoader,
|
||||
)
|
||||
|
||||
|
||||
class FileLoader(_bootstrap_external.FileLoader, ResourceLoader, ExecutionLoader):
|
||||
|
||||
Vendored
+1
@@ -12,6 +12,7 @@ from ._bootstrap_external import FileFinder
|
||||
from ._bootstrap_external import SourceFileLoader
|
||||
from ._bootstrap_external import SourcelessFileLoader
|
||||
from ._bootstrap_external import ExtensionFileLoader
|
||||
from ._bootstrap_external import AppleFrameworkLoader
|
||||
from ._bootstrap_external import NamespaceLoader
|
||||
|
||||
|
||||
|
||||
Vendored
+229
-101
@@ -1,9 +1,13 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import re
|
||||
import abc
|
||||
import csv
|
||||
import sys
|
||||
import json
|
||||
import email
|
||||
import types
|
||||
import inspect
|
||||
import pathlib
|
||||
import zipfile
|
||||
import operator
|
||||
@@ -12,11 +16,9 @@ import warnings
|
||||
import functools
|
||||
import itertools
|
||||
import posixpath
|
||||
import contextlib
|
||||
import collections
|
||||
import inspect
|
||||
|
||||
from . import _adapters, _meta
|
||||
from . import _meta
|
||||
from ._collections import FreezableDefaultDict, Pair
|
||||
from ._functools import method_cache, pass_none
|
||||
from ._itertools import always_iterable, unique_everseen
|
||||
@@ -26,8 +28,7 @@ from contextlib import suppress
|
||||
from importlib import import_module
|
||||
from importlib.abc import MetaPathFinder
|
||||
from itertools import starmap
|
||||
from typing import List, Mapping, Optional, cast
|
||||
|
||||
from typing import Any, Iterable, List, Mapping, Match, Optional, Set, cast
|
||||
|
||||
__all__ = [
|
||||
'Distribution',
|
||||
@@ -48,11 +49,11 @@ __all__ = [
|
||||
class PackageNotFoundError(ModuleNotFoundError):
|
||||
"""The package was not found."""
|
||||
|
||||
def __str__(self):
|
||||
def __str__(self) -> str:
|
||||
return f"No package metadata was found for {self.name}"
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
def name(self) -> str: # type: ignore[override]
|
||||
(name,) = self.args
|
||||
return name
|
||||
|
||||
@@ -118,38 +119,11 @@ class Sectioned:
|
||||
yield Pair(name, value)
|
||||
|
||||
@staticmethod
|
||||
def valid(line):
|
||||
def valid(line: str):
|
||||
return line and not line.startswith('#')
|
||||
|
||||
|
||||
class DeprecatedTuple:
|
||||
"""
|
||||
Provide subscript item access for backward compatibility.
|
||||
|
||||
>>> recwarn = getfixture('recwarn')
|
||||
>>> ep = EntryPoint(name='name', value='value', group='group')
|
||||
>>> ep[:]
|
||||
('name', 'value', 'group')
|
||||
>>> ep[0]
|
||||
'name'
|
||||
>>> len(recwarn)
|
||||
1
|
||||
"""
|
||||
|
||||
# Do not remove prior to 2023-05-01 or Python 3.13
|
||||
_warn = functools.partial(
|
||||
warnings.warn,
|
||||
"EntryPoint tuple interface is deprecated. Access members by name.",
|
||||
DeprecationWarning,
|
||||
stacklevel=2,
|
||||
)
|
||||
|
||||
def __getitem__(self, item):
|
||||
self._warn()
|
||||
return self._key()[item]
|
||||
|
||||
|
||||
class EntryPoint(DeprecatedTuple):
|
||||
class EntryPoint:
|
||||
"""An entry point as defined by Python packaging conventions.
|
||||
|
||||
See `the packaging docs on entry points
|
||||
@@ -191,34 +165,37 @@ class EntryPoint(DeprecatedTuple):
|
||||
value: str
|
||||
group: str
|
||||
|
||||
dist: Optional['Distribution'] = None
|
||||
dist: Optional[Distribution] = None
|
||||
|
||||
def __init__(self, name, value, group):
|
||||
def __init__(self, name: str, value: str, group: str) -> None:
|
||||
vars(self).update(name=name, value=value, group=group)
|
||||
|
||||
def load(self):
|
||||
def load(self) -> Any:
|
||||
"""Load the entry point from its definition. If only a module
|
||||
is indicated by the value, return that module. Otherwise,
|
||||
return the named object.
|
||||
"""
|
||||
match = self.pattern.match(self.value)
|
||||
match = cast(Match, self.pattern.match(self.value))
|
||||
module = import_module(match.group('module'))
|
||||
attrs = filter(None, (match.group('attr') or '').split('.'))
|
||||
return functools.reduce(getattr, attrs, module)
|
||||
|
||||
@property
|
||||
def module(self):
|
||||
def module(self) -> str:
|
||||
match = self.pattern.match(self.value)
|
||||
assert match is not None
|
||||
return match.group('module')
|
||||
|
||||
@property
|
||||
def attr(self):
|
||||
def attr(self) -> str:
|
||||
match = self.pattern.match(self.value)
|
||||
assert match is not None
|
||||
return match.group('attr')
|
||||
|
||||
@property
|
||||
def extras(self):
|
||||
def extras(self) -> List[str]:
|
||||
match = self.pattern.match(self.value)
|
||||
assert match is not None
|
||||
return re.findall(r'\w+', match.group('extras') or '')
|
||||
|
||||
def _for(self, dist):
|
||||
@@ -266,7 +243,7 @@ class EntryPoint(DeprecatedTuple):
|
||||
f'group={self.group!r})'
|
||||
)
|
||||
|
||||
def __hash__(self):
|
||||
def __hash__(self) -> int:
|
||||
return hash(self._key())
|
||||
|
||||
|
||||
@@ -277,7 +254,7 @@ class EntryPoints(tuple):
|
||||
|
||||
__slots__ = ()
|
||||
|
||||
def __getitem__(self, name): # -> EntryPoint:
|
||||
def __getitem__(self, name: str) -> EntryPoint: # type: ignore[override]
|
||||
"""
|
||||
Get the EntryPoint in self matching name.
|
||||
"""
|
||||
@@ -286,7 +263,14 @@ class EntryPoints(tuple):
|
||||
except StopIteration:
|
||||
raise KeyError(name)
|
||||
|
||||
def select(self, **params):
|
||||
def __repr__(self):
|
||||
"""
|
||||
Repr with classname and tuple constructor to
|
||||
signal that we deviate from regular tuple behavior.
|
||||
"""
|
||||
return '%s(%r)' % (self.__class__.__name__, tuple(self))
|
||||
|
||||
def select(self, **params) -> EntryPoints:
|
||||
"""
|
||||
Select entry points from self that match the
|
||||
given parameters (typically group and/or name).
|
||||
@@ -294,14 +278,14 @@ class EntryPoints(tuple):
|
||||
return EntryPoints(ep for ep in self if ep.matches(**params))
|
||||
|
||||
@property
|
||||
def names(self):
|
||||
def names(self) -> Set[str]:
|
||||
"""
|
||||
Return the set of all names of all entry points.
|
||||
"""
|
||||
return {ep.name for ep in self}
|
||||
|
||||
@property
|
||||
def groups(self):
|
||||
def groups(self) -> Set[str]:
|
||||
"""
|
||||
Return the set of all groups of all entry points.
|
||||
"""
|
||||
@@ -322,28 +306,31 @@ class EntryPoints(tuple):
|
||||
class PackagePath(pathlib.PurePosixPath):
|
||||
"""A reference to a path in a package"""
|
||||
|
||||
def read_text(self, encoding='utf-8'):
|
||||
with self.locate().open(encoding=encoding) as stream:
|
||||
return stream.read()
|
||||
hash: Optional[FileHash]
|
||||
size: int
|
||||
dist: Distribution
|
||||
|
||||
def read_binary(self):
|
||||
with self.locate().open('rb') as stream:
|
||||
return stream.read()
|
||||
def read_text(self, encoding: str = 'utf-8') -> str: # type: ignore[override]
|
||||
return self.locate().read_text(encoding=encoding)
|
||||
|
||||
def locate(self):
|
||||
def read_binary(self) -> bytes:
|
||||
return self.locate().read_bytes()
|
||||
|
||||
def locate(self) -> SimplePath:
|
||||
"""Return a path-like object for this path"""
|
||||
return self.dist.locate_file(self)
|
||||
|
||||
|
||||
class FileHash:
|
||||
def __init__(self, spec):
|
||||
def __init__(self, spec: str) -> None:
|
||||
self.mode, _, self.value = spec.partition('=')
|
||||
|
||||
def __repr__(self):
|
||||
def __repr__(self) -> str:
|
||||
return f'<FileHash mode: {self.mode} value: {self.value}>'
|
||||
|
||||
|
||||
class DeprecatedNonAbstract:
|
||||
# Required until Python 3.14
|
||||
def __new__(cls, *args, **kwargs):
|
||||
all_names = {
|
||||
name for subclass in inspect.getmro(cls) for name in vars(subclass)
|
||||
@@ -363,25 +350,48 @@ class DeprecatedNonAbstract:
|
||||
|
||||
|
||||
class Distribution(DeprecatedNonAbstract):
|
||||
"""A Python distribution package."""
|
||||
"""
|
||||
An abstract Python distribution package.
|
||||
|
||||
Custom providers may derive from this class and define
|
||||
the abstract methods to provide a concrete implementation
|
||||
for their environment. Some providers may opt to override
|
||||
the default implementation of some properties to bypass
|
||||
the file-reading mechanism.
|
||||
"""
|
||||
|
||||
@abc.abstractmethod
|
||||
def read_text(self, filename) -> Optional[str]:
|
||||
"""Attempt to load metadata file given by the name.
|
||||
|
||||
Python distribution metadata is organized by blobs of text
|
||||
typically represented as "files" in the metadata directory
|
||||
(e.g. package-1.0.dist-info). These files include things
|
||||
like:
|
||||
|
||||
- METADATA: The distribution metadata including fields
|
||||
like Name and Version and Description.
|
||||
- entry_points.txt: A series of entry points as defined in
|
||||
`the entry points spec <https://packaging.python.org/en/latest/specifications/entry-points/#file-format>`_.
|
||||
- RECORD: A record of files according to
|
||||
`this recording spec <https://packaging.python.org/en/latest/specifications/recording-installed-packages/#the-record-file>`_.
|
||||
|
||||
A package may provide any set of files, including those
|
||||
not listed here or none at all.
|
||||
|
||||
:param filename: The name of the file in the distribution info.
|
||||
:return: The text if found, otherwise None.
|
||||
"""
|
||||
|
||||
@abc.abstractmethod
|
||||
def locate_file(self, path):
|
||||
def locate_file(self, path: str | os.PathLike[str]) -> SimplePath:
|
||||
"""
|
||||
Given a path to a file in this distribution, return a path
|
||||
Given a path to a file in this distribution, return a SimplePath
|
||||
to it.
|
||||
"""
|
||||
|
||||
@classmethod
|
||||
def from_name(cls, name: str):
|
||||
def from_name(cls, name: str) -> Distribution:
|
||||
"""Return the Distribution for the given package name.
|
||||
|
||||
:param name: The name of the distribution package to search for.
|
||||
@@ -394,21 +404,23 @@ class Distribution(DeprecatedNonAbstract):
|
||||
if not name:
|
||||
raise ValueError("A distribution name is required.")
|
||||
try:
|
||||
return next(cls.discover(name=name))
|
||||
return next(iter(cls.discover(name=name)))
|
||||
except StopIteration:
|
||||
raise PackageNotFoundError(name)
|
||||
|
||||
@classmethod
|
||||
def discover(cls, **kwargs):
|
||||
def discover(
|
||||
cls, *, context: Optional[DistributionFinder.Context] = None, **kwargs
|
||||
) -> Iterable[Distribution]:
|
||||
"""Return an iterable of Distribution objects for all packages.
|
||||
|
||||
Pass a ``context`` or pass keyword arguments for constructing
|
||||
a context.
|
||||
|
||||
:context: A ``DistributionFinder.Context`` object.
|
||||
:return: Iterable of Distribution objects for all packages.
|
||||
:return: Iterable of Distribution objects for packages matching
|
||||
the context.
|
||||
"""
|
||||
context = kwargs.pop('context', None)
|
||||
if context and kwargs:
|
||||
raise ValueError("cannot accept context and kwargs")
|
||||
context = context or DistributionFinder.Context(**kwargs)
|
||||
@@ -417,8 +429,8 @@ class Distribution(DeprecatedNonAbstract):
|
||||
)
|
||||
|
||||
@staticmethod
|
||||
def at(path):
|
||||
"""Return a Distribution for the indicated metadata path
|
||||
def at(path: str | os.PathLike[str]) -> Distribution:
|
||||
"""Return a Distribution for the indicated metadata path.
|
||||
|
||||
:param path: a string or path-like object
|
||||
:return: a concrete Distribution instance for the path
|
||||
@@ -427,7 +439,7 @@ class Distribution(DeprecatedNonAbstract):
|
||||
|
||||
@staticmethod
|
||||
def _discover_resolvers():
|
||||
"""Search the meta_path for resolvers."""
|
||||
"""Search the meta_path for resolvers (MetadataPathFinders)."""
|
||||
declared = (
|
||||
getattr(finder, 'find_distributions', None) for finder in sys.meta_path
|
||||
)
|
||||
@@ -438,8 +450,15 @@ class Distribution(DeprecatedNonAbstract):
|
||||
"""Return the parsed metadata for this Distribution.
|
||||
|
||||
The returned object will have keys that name the various bits of
|
||||
metadata. See PEP 566 for details.
|
||||
metadata per the
|
||||
`Core metadata specifications <https://packaging.python.org/en/latest/specifications/core-metadata/#core-metadata>`_.
|
||||
|
||||
Custom providers may provide the METADATA file or override this
|
||||
property.
|
||||
"""
|
||||
# deferred for performance (python/cpython#109829)
|
||||
from . import _adapters
|
||||
|
||||
opt_text = (
|
||||
self.read_text('METADATA')
|
||||
or self.read_text('PKG-INFO')
|
||||
@@ -452,7 +471,7 @@ class Distribution(DeprecatedNonAbstract):
|
||||
return _adapters.Message(email.message_from_string(text))
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
def name(self) -> str:
|
||||
"""Return the 'Name' metadata for the distribution package."""
|
||||
return self.metadata['Name']
|
||||
|
||||
@@ -462,16 +481,22 @@ class Distribution(DeprecatedNonAbstract):
|
||||
return Prepared.normalize(self.name)
|
||||
|
||||
@property
|
||||
def version(self):
|
||||
def version(self) -> str:
|
||||
"""Return the 'Version' metadata for the distribution package."""
|
||||
return self.metadata['Version']
|
||||
|
||||
@property
|
||||
def entry_points(self):
|
||||
def entry_points(self) -> EntryPoints:
|
||||
"""
|
||||
Return EntryPoints for this distribution.
|
||||
|
||||
Custom providers may provide the ``entry_points.txt`` file
|
||||
or override this property.
|
||||
"""
|
||||
return EntryPoints._from_text_for(self.read_text('entry_points.txt'), self)
|
||||
|
||||
@property
|
||||
def files(self):
|
||||
def files(self) -> Optional[List[PackagePath]]:
|
||||
"""Files in this distribution.
|
||||
|
||||
:return: List of PackagePath for this distribution or None
|
||||
@@ -480,6 +505,10 @@ class Distribution(DeprecatedNonAbstract):
|
||||
(i.e. RECORD for dist-info, or installed-files.txt or
|
||||
SOURCES.txt for egg-info) is missing.
|
||||
Result may be empty if the metadata exists but is empty.
|
||||
|
||||
Custom providers are recommended to provide a "RECORD" file (in
|
||||
``read_text``) or override this property to allow for callers to be
|
||||
able to resolve filenames provided by the package.
|
||||
"""
|
||||
|
||||
def make_file(name, hash=None, size_str=None):
|
||||
@@ -491,6 +520,10 @@ class Distribution(DeprecatedNonAbstract):
|
||||
|
||||
@pass_none
|
||||
def make_files(lines):
|
||||
# Delay csv import, since Distribution.files is not as widely used
|
||||
# as other parts of importlib.metadata
|
||||
import csv
|
||||
|
||||
return starmap(make_file, csv.reader(lines))
|
||||
|
||||
@pass_none
|
||||
@@ -507,7 +540,7 @@ class Distribution(DeprecatedNonAbstract):
|
||||
|
||||
def _read_files_distinfo(self):
|
||||
"""
|
||||
Read the lines of RECORD
|
||||
Read the lines of RECORD.
|
||||
"""
|
||||
text = self.read_text('RECORD')
|
||||
return text and text.splitlines()
|
||||
@@ -534,7 +567,7 @@ class Distribution(DeprecatedNonAbstract):
|
||||
paths = (
|
||||
(subdir / name)
|
||||
.resolve()
|
||||
.relative_to(self.locate_file('').resolve())
|
||||
.relative_to(self.locate_file('').resolve(), walk_up=True)
|
||||
.as_posix()
|
||||
for name in text.splitlines()
|
||||
)
|
||||
@@ -556,7 +589,7 @@ class Distribution(DeprecatedNonAbstract):
|
||||
return text and map('"{}"'.format, text.splitlines())
|
||||
|
||||
@property
|
||||
def requires(self):
|
||||
def requires(self) -> Optional[List[str]]:
|
||||
"""Generated requirements specified for this Distribution"""
|
||||
reqs = self._read_dist_info_reqs() or self._read_egg_info_reqs()
|
||||
return reqs and list(reqs)
|
||||
@@ -607,10 +640,23 @@ class Distribution(DeprecatedNonAbstract):
|
||||
space = url_req_space(section.value)
|
||||
yield section.value + space + quoted_marker(section.name)
|
||||
|
||||
@property
|
||||
def origin(self):
|
||||
return self._load_json('direct_url.json')
|
||||
|
||||
def _load_json(self, filename):
|
||||
return pass_none(json.loads)(
|
||||
self.read_text(filename),
|
||||
object_hook=lambda data: types.SimpleNamespace(**data),
|
||||
)
|
||||
|
||||
|
||||
class DistributionFinder(MetaPathFinder):
|
||||
"""
|
||||
A MetaPathFinder capable of discovering installed distributions.
|
||||
|
||||
Custom providers should implement this interface in order to
|
||||
supply metadata.
|
||||
"""
|
||||
|
||||
class Context:
|
||||
@@ -623,6 +669,17 @@ class DistributionFinder(MetaPathFinder):
|
||||
Each DistributionFinder may expect any parameters
|
||||
and should attempt to honor the canonical
|
||||
parameters defined below when appropriate.
|
||||
|
||||
This mechanism gives a custom provider a means to
|
||||
solicit additional details from the caller beyond
|
||||
"name" and "path" when searching distributions.
|
||||
For example, imagine a provider that exposes suites
|
||||
of packages in either a "public" or "private" ``realm``.
|
||||
A caller may wish to query only for distributions in
|
||||
a particular realm and could call
|
||||
``distributions(realm="private")`` to signal to the
|
||||
custom provider to only include distributions from that
|
||||
realm.
|
||||
"""
|
||||
|
||||
name = None
|
||||
@@ -635,7 +692,7 @@ class DistributionFinder(MetaPathFinder):
|
||||
vars(self).update(kwargs)
|
||||
|
||||
@property
|
||||
def path(self):
|
||||
def path(self) -> List[str]:
|
||||
"""
|
||||
The sequence of directory path that a distribution finder
|
||||
should search.
|
||||
@@ -646,7 +703,7 @@ class DistributionFinder(MetaPathFinder):
|
||||
return vars(self).get('path', sys.path)
|
||||
|
||||
@abc.abstractmethod
|
||||
def find_distributions(self, context=Context()):
|
||||
def find_distributions(self, context=Context()) -> Iterable[Distribution]:
|
||||
"""
|
||||
Find distributions.
|
||||
|
||||
@@ -658,11 +715,18 @@ class DistributionFinder(MetaPathFinder):
|
||||
|
||||
class FastPath:
|
||||
"""
|
||||
Micro-optimized class for searching a path for
|
||||
children.
|
||||
Micro-optimized class for searching a root for children.
|
||||
|
||||
Root is a path on the file system that may contain metadata
|
||||
directories either as natural directories or within a zip file.
|
||||
|
||||
>>> FastPath('').children()
|
||||
['...']
|
||||
|
||||
FastPath objects are cached and recycled for any given root.
|
||||
|
||||
>>> FastPath('foobar') is FastPath('foobar')
|
||||
True
|
||||
"""
|
||||
|
||||
@functools.lru_cache() # type: ignore
|
||||
@@ -704,7 +768,19 @@ class FastPath:
|
||||
|
||||
|
||||
class Lookup:
|
||||
"""
|
||||
A micro-optimized class for searching a (fast) path for metadata.
|
||||
"""
|
||||
|
||||
def __init__(self, path: FastPath):
|
||||
"""
|
||||
Calculate all of the children representing metadata.
|
||||
|
||||
From the children in the path, calculate early all of the
|
||||
children that appear to represent metadata (infos) or legacy
|
||||
metadata (eggs).
|
||||
"""
|
||||
|
||||
base = os.path.basename(path.root).lower()
|
||||
base_is_egg = base.endswith(".egg")
|
||||
self.infos = FreezableDefaultDict(list)
|
||||
@@ -725,7 +801,10 @@ class Lookup:
|
||||
self.infos.freeze()
|
||||
self.eggs.freeze()
|
||||
|
||||
def search(self, prepared):
|
||||
def search(self, prepared: Prepared):
|
||||
"""
|
||||
Yield all infos and eggs matching the Prepared query.
|
||||
"""
|
||||
infos = (
|
||||
self.infos[prepared.normalized]
|
||||
if prepared
|
||||
@@ -741,13 +820,28 @@ class Lookup:
|
||||
|
||||
class Prepared:
|
||||
"""
|
||||
A prepared search for metadata on a possibly-named package.
|
||||
A prepared search query for metadata on a possibly-named package.
|
||||
|
||||
Pre-calculates the normalization to prevent repeated operations.
|
||||
|
||||
>>> none = Prepared(None)
|
||||
>>> none.normalized
|
||||
>>> none.legacy_normalized
|
||||
>>> bool(none)
|
||||
False
|
||||
>>> sample = Prepared('Sample__Pkg-name.foo')
|
||||
>>> sample.normalized
|
||||
'sample_pkg_name_foo'
|
||||
>>> sample.legacy_normalized
|
||||
'sample__pkg_name.foo'
|
||||
>>> bool(sample)
|
||||
True
|
||||
"""
|
||||
|
||||
normalized = None
|
||||
legacy_normalized = None
|
||||
|
||||
def __init__(self, name):
|
||||
def __init__(self, name: Optional[str]):
|
||||
self.name = name
|
||||
if name is None:
|
||||
return
|
||||
@@ -775,7 +869,9 @@ class Prepared:
|
||||
|
||||
class MetadataPathFinder(DistributionFinder):
|
||||
@classmethod
|
||||
def find_distributions(cls, context=DistributionFinder.Context()):
|
||||
def find_distributions(
|
||||
cls, context=DistributionFinder.Context()
|
||||
) -> Iterable[PathDistribution]:
|
||||
"""
|
||||
Find distributions.
|
||||
|
||||
@@ -795,19 +891,20 @@ class MetadataPathFinder(DistributionFinder):
|
||||
path.search(prepared) for path in map(FastPath, paths)
|
||||
)
|
||||
|
||||
def invalidate_caches(cls):
|
||||
@classmethod
|
||||
def invalidate_caches(cls) -> None:
|
||||
FastPath.__new__.cache_clear()
|
||||
|
||||
|
||||
class PathDistribution(Distribution):
|
||||
def __init__(self, path: SimplePath):
|
||||
def __init__(self, path: SimplePath) -> None:
|
||||
"""Construct a distribution.
|
||||
|
||||
:param path: SimplePath indicating the metadata directory.
|
||||
"""
|
||||
self._path = path
|
||||
|
||||
def read_text(self, filename):
|
||||
def read_text(self, filename: str | os.PathLike[str]) -> Optional[str]:
|
||||
with suppress(
|
||||
FileNotFoundError,
|
||||
IsADirectoryError,
|
||||
@@ -817,9 +914,11 @@ class PathDistribution(Distribution):
|
||||
):
|
||||
return self._path.joinpath(filename).read_text(encoding='utf-8')
|
||||
|
||||
return None
|
||||
|
||||
read_text.__doc__ = Distribution.read_text.__doc__
|
||||
|
||||
def locate_file(self, path):
|
||||
def locate_file(self, path: str | os.PathLike[str]) -> SimplePath:
|
||||
return self._path.parent / path
|
||||
|
||||
@property
|
||||
@@ -852,7 +951,7 @@ class PathDistribution(Distribution):
|
||||
return name
|
||||
|
||||
|
||||
def distribution(distribution_name):
|
||||
def distribution(distribution_name: str) -> Distribution:
|
||||
"""Get the ``Distribution`` instance for the named package.
|
||||
|
||||
:param distribution_name: The name of the distribution package as a string.
|
||||
@@ -861,7 +960,7 @@ def distribution(distribution_name):
|
||||
return Distribution.from_name(distribution_name)
|
||||
|
||||
|
||||
def distributions(**kwargs):
|
||||
def distributions(**kwargs) -> Iterable[Distribution]:
|
||||
"""Get all ``Distribution`` instances in the current environment.
|
||||
|
||||
:return: An iterable of ``Distribution`` instances.
|
||||
@@ -869,7 +968,7 @@ def distributions(**kwargs):
|
||||
return Distribution.discover(**kwargs)
|
||||
|
||||
|
||||
def metadata(distribution_name) -> _meta.PackageMetadata:
|
||||
def metadata(distribution_name: str) -> _meta.PackageMetadata:
|
||||
"""Get the metadata for the named package.
|
||||
|
||||
:param distribution_name: The name of the distribution package to query.
|
||||
@@ -878,7 +977,7 @@ def metadata(distribution_name) -> _meta.PackageMetadata:
|
||||
return Distribution.from_name(distribution_name).metadata
|
||||
|
||||
|
||||
def version(distribution_name):
|
||||
def version(distribution_name: str) -> str:
|
||||
"""Get the version string for the named package.
|
||||
|
||||
:param distribution_name: The name of the distribution package to query.
|
||||
@@ -912,7 +1011,7 @@ def entry_points(**params) -> EntryPoints:
|
||||
return EntryPoints(eps).select(**params)
|
||||
|
||||
|
||||
def files(distribution_name):
|
||||
def files(distribution_name: str) -> Optional[List[PackagePath]]:
|
||||
"""Return a list of files for the named package.
|
||||
|
||||
:param distribution_name: The name of the distribution package to query.
|
||||
@@ -921,11 +1020,11 @@ def files(distribution_name):
|
||||
return distribution(distribution_name).files
|
||||
|
||||
|
||||
def requires(distribution_name):
|
||||
def requires(distribution_name: str) -> Optional[List[str]]:
|
||||
"""
|
||||
Return a list of requirements for the named package.
|
||||
|
||||
:return: An iterator of requirements, suitable for
|
||||
:return: An iterable of requirements, suitable for
|
||||
packaging.requirement.Requirement.
|
||||
"""
|
||||
return distribution(distribution_name).requires
|
||||
@@ -952,13 +1051,42 @@ def _top_level_declared(dist):
|
||||
return (dist.read_text('top_level.txt') or '').split()
|
||||
|
||||
|
||||
def _topmost(name: PackagePath) -> Optional[str]:
|
||||
"""
|
||||
Return the top-most parent as long as there is a parent.
|
||||
"""
|
||||
top, *rest = name.parts
|
||||
return top if rest else None
|
||||
|
||||
|
||||
def _get_toplevel_name(name: PackagePath) -> str:
|
||||
"""
|
||||
Infer a possibly importable module name from a name presumed on
|
||||
sys.path.
|
||||
|
||||
>>> _get_toplevel_name(PackagePath('foo.py'))
|
||||
'foo'
|
||||
>>> _get_toplevel_name(PackagePath('foo'))
|
||||
'foo'
|
||||
>>> _get_toplevel_name(PackagePath('foo.pyc'))
|
||||
'foo'
|
||||
>>> _get_toplevel_name(PackagePath('foo/__init__.py'))
|
||||
'foo'
|
||||
>>> _get_toplevel_name(PackagePath('foo.pth'))
|
||||
'foo.pth'
|
||||
>>> _get_toplevel_name(PackagePath('foo.dist-info'))
|
||||
'foo.dist-info'
|
||||
"""
|
||||
return _topmost(name) or (
|
||||
# python/typeshed#10328
|
||||
inspect.getmodulename(name) # type: ignore
|
||||
or str(name)
|
||||
)
|
||||
|
||||
|
||||
def _top_level_inferred(dist):
|
||||
opt_names = {
|
||||
f.parts[0] if len(f.parts) > 1 else inspect.getmodulename(f)
|
||||
for f in always_iterable(dist.files)
|
||||
}
|
||||
opt_names = set(map(_get_toplevel_name, always_iterable(dist.files)))
|
||||
|
||||
@pass_none
|
||||
def importable_name(name):
|
||||
return '.' not in name
|
||||
|
||||
|
||||
Vendored
+1
-1
@@ -53,7 +53,7 @@ class Message(email.message.Message):
|
||||
def __getitem__(self, item):
|
||||
"""
|
||||
Warn users that a ``KeyError`` can be expected when a
|
||||
mising key is supplied. Ref python/importlib_metadata#371.
|
||||
missing key is supplied. Ref python/importlib_metadata#371.
|
||||
"""
|
||||
res = super().__getitem__(item)
|
||||
if res is None:
|
||||
|
||||
Vendored
+28
-24
@@ -1,3 +1,6 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
from typing import Protocol
|
||||
from typing import Any, Dict, Iterator, List, Optional, TypeVar, Union, overload
|
||||
|
||||
@@ -6,30 +9,27 @@ _T = TypeVar("_T")
|
||||
|
||||
|
||||
class PackageMetadata(Protocol):
|
||||
def __len__(self) -> int:
|
||||
... # pragma: no cover
|
||||
def __len__(self) -> int: ... # pragma: no cover
|
||||
|
||||
def __contains__(self, item: str) -> bool:
|
||||
... # pragma: no cover
|
||||
def __contains__(self, item: str) -> bool: ... # pragma: no cover
|
||||
|
||||
def __getitem__(self, key: str) -> str:
|
||||
... # pragma: no cover
|
||||
def __getitem__(self, key: str) -> str: ... # pragma: no cover
|
||||
|
||||
def __iter__(self) -> Iterator[str]:
|
||||
... # pragma: no cover
|
||||
def __iter__(self) -> Iterator[str]: ... # pragma: no cover
|
||||
|
||||
@overload
|
||||
def get(self, name: str, failobj: None = None) -> Optional[str]:
|
||||
... # pragma: no cover
|
||||
def get(
|
||||
self, name: str, failobj: None = None
|
||||
) -> Optional[str]: ... # pragma: no cover
|
||||
|
||||
@overload
|
||||
def get(self, name: str, failobj: _T) -> Union[str, _T]:
|
||||
... # pragma: no cover
|
||||
def get(self, name: str, failobj: _T) -> Union[str, _T]: ... # pragma: no cover
|
||||
|
||||
# overload per python/importlib_metadata#435
|
||||
@overload
|
||||
def get_all(self, name: str, failobj: None = None) -> Optional[List[Any]]:
|
||||
... # pragma: no cover
|
||||
def get_all(
|
||||
self, name: str, failobj: None = None
|
||||
) -> Optional[List[Any]]: ... # pragma: no cover
|
||||
|
||||
@overload
|
||||
def get_all(self, name: str, failobj: _T) -> Union[List[Any], _T]:
|
||||
@@ -44,20 +44,24 @@ class PackageMetadata(Protocol):
|
||||
"""
|
||||
|
||||
|
||||
class SimplePath(Protocol[_T]):
|
||||
class SimplePath(Protocol):
|
||||
"""
|
||||
A minimal subset of pathlib.Path required by PathDistribution.
|
||||
A minimal subset of pathlib.Path required by Distribution.
|
||||
"""
|
||||
|
||||
def joinpath(self) -> _T:
|
||||
... # pragma: no cover
|
||||
def joinpath(
|
||||
self, other: Union[str, os.PathLike[str]]
|
||||
) -> SimplePath: ... # pragma: no cover
|
||||
|
||||
def __truediv__(self, other: Union[str, _T]) -> _T:
|
||||
... # pragma: no cover
|
||||
def __truediv__(
|
||||
self, other: Union[str, os.PathLike[str]]
|
||||
) -> SimplePath: ... # pragma: no cover
|
||||
|
||||
@property
|
||||
def parent(self) -> _T:
|
||||
... # pragma: no cover
|
||||
def parent(self) -> SimplePath: ... # pragma: no cover
|
||||
|
||||
def read_text(self) -> str:
|
||||
... # pragma: no cover
|
||||
def read_text(self, encoding=None) -> str: ... # pragma: no cover
|
||||
|
||||
def read_bytes(self) -> bytes: ... # pragma: no cover
|
||||
|
||||
def exists(self) -> bool: ... # pragma: no cover
|
||||
Vendored
+21
@@ -0,0 +1,21 @@
|
||||
import sys
|
||||
|
||||
from . import Distribution
|
||||
|
||||
|
||||
def inspect(path):
|
||||
print("Inspecting", path)
|
||||
dists = list(Distribution.discover(path=[path]))
|
||||
if not dists:
|
||||
return
|
||||
print("Found", len(dists), "packages:", end=' ')
|
||||
print(', '.join(dist.name for dist in dists))
|
||||
|
||||
|
||||
def run():
|
||||
for path in sys.path:
|
||||
inspect(path)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
run()
|
||||
Vendored
+16
-9
@@ -1,20 +1,27 @@
|
||||
"""Read resources contained within a package."""
|
||||
"""
|
||||
Read resources contained within a package.
|
||||
|
||||
This codebase is shared between importlib.resources in the stdlib
|
||||
and importlib_resources in PyPI. See
|
||||
https://github.com/python/importlib_metadata/wiki/Development-Methodology
|
||||
for more detail.
|
||||
"""
|
||||
|
||||
from ._common import (
|
||||
as_file,
|
||||
files,
|
||||
Package,
|
||||
Anchor,
|
||||
)
|
||||
|
||||
from ._legacy import (
|
||||
from ._functional import (
|
||||
contents,
|
||||
open_binary,
|
||||
read_binary,
|
||||
open_text,
|
||||
read_text,
|
||||
is_resource,
|
||||
open_binary,
|
||||
open_text,
|
||||
path,
|
||||
Resource,
|
||||
read_binary,
|
||||
read_text,
|
||||
)
|
||||
|
||||
from .abc import ResourceReader
|
||||
@@ -22,11 +29,11 @@ from .abc import ResourceReader
|
||||
|
||||
__all__ = [
|
||||
'Package',
|
||||
'Resource',
|
||||
'Anchor',
|
||||
'ResourceReader',
|
||||
'as_file',
|
||||
'contents',
|
||||
'files',
|
||||
'contents',
|
||||
'is_resource',
|
||||
'open_binary',
|
||||
'open_text',
|
||||
|
||||
Vendored
+10
-6
@@ -12,8 +12,6 @@ import itertools
|
||||
from typing import Union, Optional, cast
|
||||
from .abc import ResourceReader, Traversable
|
||||
|
||||
from ._adapters import wrap_spec
|
||||
|
||||
Package = Union[types.ModuleType, str]
|
||||
Anchor = Package
|
||||
|
||||
@@ -27,6 +25,8 @@ def package_to_anchor(func):
|
||||
>>> files('a', 'b')
|
||||
Traceback (most recent call last):
|
||||
TypeError: files() takes from 0 to 1 positional arguments but 2 were given
|
||||
|
||||
Remove this compatibility in Python 3.14.
|
||||
"""
|
||||
undefined = object()
|
||||
|
||||
@@ -66,10 +66,10 @@ def get_resource_reader(package: types.ModuleType) -> Optional[ResourceReader]:
|
||||
# zipimport.zipimporter does not support weak references, resulting in a
|
||||
# TypeError. That seems terrible.
|
||||
spec = package.__spec__
|
||||
reader = getattr(spec.loader, 'get_resource_reader', None) # type: ignore
|
||||
reader = getattr(spec.loader, 'get_resource_reader', None) # type: ignore[union-attr]
|
||||
if reader is None:
|
||||
return None
|
||||
return reader(spec.name) # type: ignore
|
||||
return reader(spec.name) # type: ignore[union-attr]
|
||||
|
||||
|
||||
@functools.singledispatch
|
||||
@@ -93,12 +93,13 @@ def _infer_caller():
|
||||
"""
|
||||
|
||||
def is_this_file(frame_info):
|
||||
return frame_info.filename == __file__
|
||||
return frame_info.filename == stack[0].filename
|
||||
|
||||
def is_wrapper(frame_info):
|
||||
return frame_info.function == 'wrapper'
|
||||
|
||||
not_this_file = itertools.filterfalse(is_this_file, inspect.stack())
|
||||
stack = inspect.stack()
|
||||
not_this_file = itertools.filterfalse(is_this_file, stack)
|
||||
# also exclude 'wrapper' due to singledispatch in the call stack
|
||||
callers = itertools.filterfalse(is_wrapper, not_this_file)
|
||||
return next(callers).frame
|
||||
@@ -109,6 +110,9 @@ def from_package(package: types.ModuleType):
|
||||
Return a Traversable object for the given package.
|
||||
|
||||
"""
|
||||
# deferred for performance (python/cpython#109829)
|
||||
from ._adapters import wrap_spec
|
||||
|
||||
spec = wrap_spec(package)
|
||||
reader = spec.loader.get_resource_reader(spec.name)
|
||||
return reader.files()
|
||||
|
||||
+81
@@ -0,0 +1,81 @@
|
||||
"""Simplified function-based API for importlib.resources"""
|
||||
|
||||
import warnings
|
||||
|
||||
from ._common import files, as_file
|
||||
|
||||
|
||||
_MISSING = object()
|
||||
|
||||
|
||||
def open_binary(anchor, *path_names):
|
||||
"""Open for binary reading the *resource* within *package*."""
|
||||
return _get_resource(anchor, path_names).open('rb')
|
||||
|
||||
|
||||
def open_text(anchor, *path_names, encoding=_MISSING, errors='strict'):
|
||||
"""Open for text reading the *resource* within *package*."""
|
||||
encoding = _get_encoding_arg(path_names, encoding)
|
||||
resource = _get_resource(anchor, path_names)
|
||||
return resource.open('r', encoding=encoding, errors=errors)
|
||||
|
||||
|
||||
def read_binary(anchor, *path_names):
|
||||
"""Read and return contents of *resource* within *package* as bytes."""
|
||||
return _get_resource(anchor, path_names).read_bytes()
|
||||
|
||||
|
||||
def read_text(anchor, *path_names, encoding=_MISSING, errors='strict'):
|
||||
"""Read and return contents of *resource* within *package* as str."""
|
||||
encoding = _get_encoding_arg(path_names, encoding)
|
||||
resource = _get_resource(anchor, path_names)
|
||||
return resource.read_text(encoding=encoding, errors=errors)
|
||||
|
||||
|
||||
def path(anchor, *path_names):
|
||||
"""Return the path to the *resource* as an actual file system path."""
|
||||
return as_file(_get_resource(anchor, path_names))
|
||||
|
||||
|
||||
def is_resource(anchor, *path_names):
|
||||
"""Return ``True`` if there is a resource named *name* in the package,
|
||||
|
||||
Otherwise returns ``False``.
|
||||
"""
|
||||
return _get_resource(anchor, path_names).is_file()
|
||||
|
||||
|
||||
def contents(anchor, *path_names):
|
||||
"""Return an iterable over the named resources within the package.
|
||||
|
||||
The iterable returns :class:`str` resources (e.g. files).
|
||||
The iterable does not recurse into subdirectories.
|
||||
"""
|
||||
warnings.warn(
|
||||
"importlib.resources.contents is deprecated. "
|
||||
"Use files(anchor).iterdir() instead.",
|
||||
DeprecationWarning,
|
||||
stacklevel=1,
|
||||
)
|
||||
return (resource.name for resource in _get_resource(anchor, path_names).iterdir())
|
||||
|
||||
|
||||
def _get_encoding_arg(path_names, encoding):
|
||||
# For compatibility with versions where *encoding* was a positional
|
||||
# argument, it needs to be given explicitly when there are multiple
|
||||
# *path_names*.
|
||||
# This limitation can be removed in Python 3.15.
|
||||
if encoding is _MISSING:
|
||||
if len(path_names) > 1:
|
||||
raise TypeError(
|
||||
"'encoding' argument required with multiple path names",
|
||||
)
|
||||
else:
|
||||
return 'utf-8'
|
||||
return encoding
|
||||
|
||||
|
||||
def _get_resource(anchor, path_names):
|
||||
if anchor is None:
|
||||
raise TypeError("anchor must be module or string, got None")
|
||||
return files(anchor).joinpath(*path_names)
|
||||
Vendored
+63
-4
@@ -1,8 +1,14 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import collections
|
||||
import contextlib
|
||||
import itertools
|
||||
import pathlib
|
||||
import operator
|
||||
import re
|
||||
import warnings
|
||||
import zipfile
|
||||
from collections.abc import Iterator
|
||||
|
||||
from . import abc
|
||||
|
||||
@@ -31,8 +37,10 @@ class FileReader(abc.TraversableResources):
|
||||
|
||||
class ZipReader(abc.TraversableResources):
|
||||
def __init__(self, loader, module):
|
||||
_, _, name = module.rpartition('.')
|
||||
self.prefix = loader.prefix.replace('\\', '/') + name + '/'
|
||||
self.prefix = loader.prefix.replace('\\', '/')
|
||||
if loader.is_package(module):
|
||||
_, _, name = module.rpartition('.')
|
||||
self.prefix += name + '/'
|
||||
self.archive = loader.archive
|
||||
|
||||
def open_resource(self, resource):
|
||||
@@ -62,7 +70,7 @@ class MultiplexedPath(abc.Traversable):
|
||||
"""
|
||||
|
||||
def __init__(self, *paths):
|
||||
self._paths = list(map(pathlib.Path, remove_duplicates(paths)))
|
||||
self._paths = list(map(_ensure_traversable, remove_duplicates(paths)))
|
||||
if not self._paths:
|
||||
message = 'MultiplexedPath must contain at least one path'
|
||||
raise FileNotFoundError(message)
|
||||
@@ -130,7 +138,40 @@ class NamespaceReader(abc.TraversableResources):
|
||||
def __init__(self, namespace_path):
|
||||
if 'NamespacePath' not in str(namespace_path):
|
||||
raise ValueError('Invalid path')
|
||||
self.path = MultiplexedPath(*list(namespace_path))
|
||||
self.path = MultiplexedPath(*filter(bool, map(self._resolve, namespace_path)))
|
||||
|
||||
@classmethod
|
||||
def _resolve(cls, path_str) -> abc.Traversable | None:
|
||||
r"""
|
||||
Given an item from a namespace path, resolve it to a Traversable.
|
||||
|
||||
path_str might be a directory on the filesystem or a path to a
|
||||
zipfile plus the path within the zipfile, e.g. ``/foo/bar`` or
|
||||
``/foo/baz.zip/inner_dir`` or ``foo\baz.zip\inner_dir\sub``.
|
||||
|
||||
path_str might also be a sentinel used by editable packages to
|
||||
trigger other behaviors (see python/importlib_resources#311).
|
||||
In that case, return None.
|
||||
"""
|
||||
dirs = (cand for cand in cls._candidate_paths(path_str) if cand.is_dir())
|
||||
return next(dirs, None)
|
||||
|
||||
@classmethod
|
||||
def _candidate_paths(cls, path_str: str) -> Iterator[abc.Traversable]:
|
||||
yield pathlib.Path(path_str)
|
||||
yield from cls._resolve_zip_path(path_str)
|
||||
|
||||
@staticmethod
|
||||
def _resolve_zip_path(path_str: str):
|
||||
for match in reversed(list(re.finditer(r'[\\/]', path_str))):
|
||||
with contextlib.suppress(
|
||||
FileNotFoundError,
|
||||
IsADirectoryError,
|
||||
NotADirectoryError,
|
||||
PermissionError,
|
||||
):
|
||||
inner = path_str[match.end() :].replace('\\', '/') + '/'
|
||||
yield zipfile.Path(path_str[: match.start()], inner.lstrip('/'))
|
||||
|
||||
def resource_path(self, resource):
|
||||
"""
|
||||
@@ -142,3 +183,21 @@ class NamespaceReader(abc.TraversableResources):
|
||||
|
||||
def files(self):
|
||||
return self.path
|
||||
|
||||
|
||||
def _ensure_traversable(path):
|
||||
"""
|
||||
Convert deprecated string arguments to traversables (pathlib.Path).
|
||||
|
||||
Remove with Python 3.15.
|
||||
"""
|
||||
if not isinstance(path, str):
|
||||
return path
|
||||
|
||||
warnings.warn(
|
||||
"String arguments are deprecated. Pass a Traversable instead.",
|
||||
DeprecationWarning,
|
||||
stacklevel=3,
|
||||
)
|
||||
|
||||
return pathlib.Path(path)
|
||||
Vendored
+2
-2
@@ -77,7 +77,7 @@ class ResourceHandle(Traversable):
|
||||
|
||||
def __init__(self, parent: ResourceContainer, name: str):
|
||||
self.parent = parent
|
||||
self.name = name # type: ignore
|
||||
self.name = name # type: ignore[misc]
|
||||
|
||||
def is_file(self):
|
||||
return True
|
||||
@@ -88,7 +88,7 @@ class ResourceHandle(Traversable):
|
||||
def open(self, mode='r', *args, **kwargs):
|
||||
stream = self.parent.reader.open_binary(self.name)
|
||||
if 'b' not in mode:
|
||||
stream = io.TextIOWrapper(*args, **kwargs)
|
||||
stream = io.TextIOWrapper(stream, *args, **kwargs)
|
||||
return stream
|
||||
|
||||
def joinpath(self, name):
|
||||
|
||||
Vendored
+58
-32
@@ -135,7 +135,7 @@ class _incompatible_extension_module_restrictions:
|
||||
may not be imported in a subinterpreter. That implies modules
|
||||
that do not implement multi-phase init or that explicitly of out.
|
||||
|
||||
Likewise for modules import in a subinterpeter with its own GIL
|
||||
Likewise for modules import in a subinterpreter with its own GIL
|
||||
when the extension does not support a per-interpreter GIL. This
|
||||
implies the module does not have a Py_mod_multiple_interpreters slot
|
||||
set to Py_MOD_PER_INTERPRETER_GIL_SUPPORTED.
|
||||
@@ -145,7 +145,7 @@ class _incompatible_extension_module_restrictions:
|
||||
|
||||
You can get the same effect as this function by implementing the
|
||||
basic interface of multi-phase init (PEP 489) and lying about
|
||||
support for mulitple interpreters (or per-interpreter GIL).
|
||||
support for multiple interpreters (or per-interpreter GIL).
|
||||
"""
|
||||
|
||||
def __init__(self, *, disable_check):
|
||||
@@ -171,36 +171,57 @@ class _LazyModule(types.ModuleType):
|
||||
|
||||
def __getattribute__(self, attr):
|
||||
"""Trigger the load of the module and return the attribute."""
|
||||
# All module metadata must be garnered from __spec__ in order to avoid
|
||||
# using mutated values.
|
||||
# Stop triggering this method.
|
||||
self.__class__ = types.ModuleType
|
||||
# Get the original name to make sure no object substitution occurred
|
||||
# in sys.modules.
|
||||
original_name = self.__spec__.name
|
||||
# Figure out exactly what attributes were mutated between the creation
|
||||
# of the module and now.
|
||||
attrs_then = self.__spec__.loader_state['__dict__']
|
||||
attrs_now = self.__dict__
|
||||
attrs_updated = {}
|
||||
for key, value in attrs_now.items():
|
||||
# Code that set the attribute may have kept a reference to the
|
||||
# assigned object, making identity more important than equality.
|
||||
if key not in attrs_then:
|
||||
attrs_updated[key] = value
|
||||
elif id(attrs_now[key]) != id(attrs_then[key]):
|
||||
attrs_updated[key] = value
|
||||
self.__spec__.loader.exec_module(self)
|
||||
# If exec_module() was used directly there is no guarantee the module
|
||||
# object was put into sys.modules.
|
||||
if original_name in sys.modules:
|
||||
if id(self) != id(sys.modules[original_name]):
|
||||
raise ValueError(f"module object for {original_name!r} "
|
||||
"substituted in sys.modules during a lazy "
|
||||
"load")
|
||||
# Update after loading since that's what would happen in an eager
|
||||
# loading situation.
|
||||
self.__dict__.update(attrs_updated)
|
||||
__spec__ = object.__getattribute__(self, '__spec__')
|
||||
loader_state = __spec__.loader_state
|
||||
with loader_state['lock']:
|
||||
# Only the first thread to get the lock should trigger the load
|
||||
# and reset the module's class. The rest can now getattr().
|
||||
if object.__getattribute__(self, '__class__') is _LazyModule:
|
||||
__class__ = loader_state['__class__']
|
||||
|
||||
# Reentrant calls from the same thread must be allowed to proceed without
|
||||
# triggering the load again.
|
||||
# exec_module() and self-referential imports are the primary ways this can
|
||||
# happen, but in any case we must return something to avoid deadlock.
|
||||
if loader_state['is_loading']:
|
||||
return __class__.__getattribute__(self, attr)
|
||||
loader_state['is_loading'] = True
|
||||
|
||||
__dict__ = __class__.__getattribute__(self, '__dict__')
|
||||
|
||||
# All module metadata must be gathered from __spec__ in order to avoid
|
||||
# using mutated values.
|
||||
# Get the original name to make sure no object substitution occurred
|
||||
# in sys.modules.
|
||||
original_name = __spec__.name
|
||||
# Figure out exactly what attributes were mutated between the creation
|
||||
# of the module and now.
|
||||
attrs_then = loader_state['__dict__']
|
||||
attrs_now = __dict__
|
||||
attrs_updated = {}
|
||||
for key, value in attrs_now.items():
|
||||
# Code that set an attribute may have kept a reference to the
|
||||
# assigned object, making identity more important than equality.
|
||||
if key not in attrs_then:
|
||||
attrs_updated[key] = value
|
||||
elif id(attrs_now[key]) != id(attrs_then[key]):
|
||||
attrs_updated[key] = value
|
||||
__spec__.loader.exec_module(self)
|
||||
# If exec_module() was used directly there is no guarantee the module
|
||||
# object was put into sys.modules.
|
||||
if original_name in sys.modules:
|
||||
if id(self) != id(sys.modules[original_name]):
|
||||
raise ValueError(f"module object for {original_name!r} "
|
||||
"substituted in sys.modules during a lazy "
|
||||
"load")
|
||||
# Update after loading since that's what would happen in an eager
|
||||
# loading situation.
|
||||
__dict__.update(attrs_updated)
|
||||
# Finally, stop triggering this method, if the module did not
|
||||
# already update its own __class__.
|
||||
if isinstance(self, _LazyModule):
|
||||
object.__setattr__(self, '__class__', __class__)
|
||||
|
||||
return getattr(self, attr)
|
||||
|
||||
def __delattr__(self, attr):
|
||||
@@ -235,6 +256,9 @@ class LazyLoader(Loader):
|
||||
|
||||
def exec_module(self, module):
|
||||
"""Make the module load lazily."""
|
||||
# Threading is only needed for lazy loading, and importlib.util can
|
||||
# be pulled in at interpreter startup, so defer until needed.
|
||||
import threading
|
||||
module.__spec__.loader = self.loader
|
||||
module.__loader__ = self.loader
|
||||
# Don't need to worry about deep-copying as trying to set an attribute
|
||||
@@ -244,5 +268,7 @@ class LazyLoader(Loader):
|
||||
loader_state = {}
|
||||
loader_state['__dict__'] = module.__dict__.copy()
|
||||
loader_state['__class__'] = module.__class__
|
||||
loader_state['lock'] = threading.RLock()
|
||||
loader_state['is_loading'] = False
|
||||
module.__spec__.loader_state = loader_state
|
||||
module.__class__ = _LazyModule
|
||||
Vendored
+21
-33
@@ -15,32 +15,29 @@ def url2pathname(url):
|
||||
# become
|
||||
# C:\foo\bar\spam.foo
|
||||
import string, urllib.parse
|
||||
if url[:3] == '///':
|
||||
# URL has an empty authority section, so the path begins on the third
|
||||
# character.
|
||||
url = url[2:]
|
||||
elif url[:12] == '//localhost/':
|
||||
# Skip past 'localhost' authority.
|
||||
url = url[11:]
|
||||
if url[:3] == '///':
|
||||
# Skip past extra slash before UNC drive in URL path.
|
||||
url = url[1:]
|
||||
# Windows itself uses ":" even in URLs.
|
||||
url = url.replace(':', '|')
|
||||
if not '|' in url:
|
||||
# No drive specifier, just convert slashes
|
||||
if url[:4] == '////':
|
||||
# path is something like ////host/path/on/remote/host
|
||||
# convert this to \\host\path\on\remote\host
|
||||
# (notice halving of slashes at the start of the path)
|
||||
url = url[2:]
|
||||
components = url.split('/')
|
||||
# make sure not to convert quoted slashes :-)
|
||||
return urllib.parse.unquote('\\'.join(components))
|
||||
return urllib.parse.unquote(url.replace('/', '\\'))
|
||||
comp = url.split('|')
|
||||
if len(comp) != 2 or comp[0][-1] not in string.ascii_letters:
|
||||
error = 'Bad URL: ' + url
|
||||
raise OSError(error)
|
||||
drive = comp[0][-1].upper()
|
||||
components = comp[1].split('/')
|
||||
path = drive + ':'
|
||||
for comp in components:
|
||||
if comp:
|
||||
path = path + '\\' + urllib.parse.unquote(comp)
|
||||
# Issue #11474 - handing url such as |c/|
|
||||
if path.endswith(':') and url.endswith('/'):
|
||||
path += '\\'
|
||||
return path
|
||||
tail = urllib.parse.unquote(comp[1].replace('/', '\\'))
|
||||
return drive + ':' + tail
|
||||
|
||||
def pathname2url(p):
|
||||
"""OS-specific conversion from a file system path to a relative URL
|
||||
@@ -52,30 +49,21 @@ def pathname2url(p):
|
||||
import urllib.parse
|
||||
# First, clean up some special forms. We are going to sacrifice
|
||||
# the additional information anyway
|
||||
if p[:4] == '\\\\?\\':
|
||||
p = p.replace('\\', '/')
|
||||
if p[:4] == '//?/':
|
||||
p = p[4:]
|
||||
if p[:4].upper() == 'UNC\\':
|
||||
p = '\\' + p[4:]
|
||||
if p[:4].upper() == 'UNC/':
|
||||
p = '//' + p[4:]
|
||||
elif p[1:2] != ':':
|
||||
raise OSError('Bad path: ' + p)
|
||||
if not ':' in p:
|
||||
# No drive specifier, just convert slashes and quote the name
|
||||
if p[:2] == '\\\\':
|
||||
# path is something like \\host\path\on\remote\host
|
||||
# convert this to ////host/path/on/remote/host
|
||||
# (notice doubling of slashes at the start of the path)
|
||||
p = '\\\\' + p
|
||||
components = p.split('\\')
|
||||
return urllib.parse.quote('/'.join(components))
|
||||
# No DOS drive specified, just quote the pathname
|
||||
return urllib.parse.quote(p)
|
||||
comp = p.split(':', maxsplit=2)
|
||||
if len(comp) != 2 or len(comp[0]) > 1:
|
||||
error = 'Bad path: ' + p
|
||||
raise OSError(error)
|
||||
|
||||
drive = urllib.parse.quote(comp[0].upper())
|
||||
components = comp[1].split('\\')
|
||||
path = '///' + drive + ':'
|
||||
for comp in components:
|
||||
if comp:
|
||||
path = path + '/' + urllib.parse.quote(comp)
|
||||
return path
|
||||
tail = urllib.parse.quote(comp[1])
|
||||
return '///' + drive + ':' + tail
|
||||
Vendored
-1435
File diff suppressed because it is too large.
Load diff
Vendored
+12
@@ -0,0 +1,12 @@
|
||||
"""Object-oriented filesystem paths.
|
||||
|
||||
This module provides classes to represent abstract paths and concrete
|
||||
paths with operations that have semantics appropriate for different
|
||||
operating systems.
|
||||
"""
|
||||
|
||||
from ._abc import *
|
||||
from ._local import *
|
||||
|
||||
__all__ = (_abc.__all__ +
|
||||
_local.__all__)
|
||||
Vendored
+930
@@ -0,0 +1,930 @@
|
||||
"""
|
||||
Abstract base classes for rich path objects.
|
||||
|
||||
This module is published as a PyPI package called "pathlib-abc".
|
||||
|
||||
This module is also a *PRIVATE* part of the Python standard library, where
|
||||
it's developed alongside pathlib. If it finds success and maturity as a PyPI
|
||||
package, it could become a public part of the standard library.
|
||||
|
||||
Two base classes are defined here -- PurePathBase and PathBase -- that
|
||||
resemble pathlib's PurePath and Path respectively.
|
||||
"""
|
||||
|
||||
import functools
|
||||
from glob import _Globber, _no_recurse_symlinks
|
||||
from errno import ENOENT, ENOTDIR, EBADF, ELOOP, EINVAL
|
||||
from stat import S_ISDIR, S_ISLNK, S_ISREG, S_ISSOCK, S_ISBLK, S_ISCHR, S_ISFIFO
|
||||
|
||||
|
||||
__all__ = ["UnsupportedOperation"]
|
||||
|
||||
#
|
||||
# Internals
|
||||
#
|
||||
|
||||
_WINERROR_NOT_READY = 21 # drive exists but is not accessible
|
||||
_WINERROR_INVALID_NAME = 123 # fix for bpo-35306
|
||||
_WINERROR_CANT_RESOLVE_FILENAME = 1921 # broken symlink pointing to itself
|
||||
|
||||
# EBADF - guard against macOS `stat` throwing EBADF
|
||||
_IGNORED_ERRNOS = (ENOENT, ENOTDIR, EBADF, ELOOP)
|
||||
|
||||
_IGNORED_WINERRORS = (
|
||||
_WINERROR_NOT_READY,
|
||||
_WINERROR_INVALID_NAME,
|
||||
_WINERROR_CANT_RESOLVE_FILENAME)
|
||||
|
||||
def _ignore_error(exception):
|
||||
return (getattr(exception, 'errno', None) in _IGNORED_ERRNOS or
|
||||
getattr(exception, 'winerror', None) in _IGNORED_WINERRORS)
|
||||
|
||||
|
||||
@functools.cache
|
||||
def _is_case_sensitive(parser):
|
||||
return parser.normcase('Aa') == 'Aa'
|
||||
|
||||
|
||||
class UnsupportedOperation(NotImplementedError):
|
||||
"""An exception that is raised when an unsupported operation is called on
|
||||
a path object.
|
||||
"""
|
||||
pass
|
||||
|
||||
|
||||
class ParserBase:
|
||||
"""Base class for path parsers, which do low-level path manipulation.
|
||||
|
||||
Path parsers provide a subset of the os.path API, specifically those
|
||||
functions needed to provide PurePathBase functionality. Each PurePathBase
|
||||
subclass references its path parser via a 'parser' class attribute.
|
||||
|
||||
Every method in this base class raises an UnsupportedOperation exception.
|
||||
"""
|
||||
|
||||
@classmethod
|
||||
def _unsupported_msg(cls, attribute):
|
||||
return f"{cls.__name__}.{attribute} is unsupported"
|
||||
|
||||
@property
|
||||
def sep(self):
|
||||
"""The character used to separate path components."""
|
||||
raise UnsupportedOperation(self._unsupported_msg('sep'))
|
||||
|
||||
def join(self, path, *paths):
|
||||
"""Join path segments."""
|
||||
raise UnsupportedOperation(self._unsupported_msg('join()'))
|
||||
|
||||
def split(self, path):
|
||||
"""Split the path into a pair (head, tail), where *head* is everything
|
||||
before the final path separator, and *tail* is everything after.
|
||||
Either part may be empty.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('split()'))
|
||||
|
||||
def splitdrive(self, path):
|
||||
"""Split the path into a 2-item tuple (drive, tail), where *drive* is
|
||||
a device name or mount point, and *tail* is everything after the
|
||||
drive. Either part may be empty."""
|
||||
raise UnsupportedOperation(self._unsupported_msg('splitdrive()'))
|
||||
|
||||
def normcase(self, path):
|
||||
"""Normalize the case of the path."""
|
||||
raise UnsupportedOperation(self._unsupported_msg('normcase()'))
|
||||
|
||||
def isabs(self, path):
|
||||
"""Returns whether the path is absolute, i.e. unaffected by the
|
||||
current directory or drive."""
|
||||
raise UnsupportedOperation(self._unsupported_msg('isabs()'))
|
||||
|
||||
|
||||
class PurePathBase:
|
||||
"""Base class for pure path objects.
|
||||
|
||||
This class *does not* provide several magic methods that are defined in
|
||||
its subclass PurePath. They are: __fspath__, __bytes__, __reduce__,
|
||||
__hash__, __eq__, __lt__, __le__, __gt__, __ge__. Its initializer and path
|
||||
joining methods accept only strings, not os.PathLike objects more broadly.
|
||||
"""
|
||||
|
||||
__slots__ = (
|
||||
# The `_raw_path` slot store a joined string path. This is set in the
|
||||
# `__init__()` method.
|
||||
'_raw_path',
|
||||
|
||||
# The '_resolving' slot stores a boolean indicating whether the path
|
||||
# is being processed by `PathBase.resolve()`. This prevents duplicate
|
||||
# work from occurring when `resolve()` calls `stat()` or `readlink()`.
|
||||
'_resolving',
|
||||
)
|
||||
parser = ParserBase()
|
||||
_globber = _Globber
|
||||
|
||||
def __init__(self, path, *paths):
|
||||
self._raw_path = self.parser.join(path, *paths) if paths else path
|
||||
if not isinstance(self._raw_path, str):
|
||||
raise TypeError(
|
||||
f"path should be a str, not {type(self._raw_path).__name__!r}")
|
||||
self._resolving = False
|
||||
|
||||
def with_segments(self, *pathsegments):
|
||||
"""Construct a new path object from any number of path-like objects.
|
||||
Subclasses may override this method to customize how new path objects
|
||||
are created from methods like `iterdir()`.
|
||||
"""
|
||||
return type(self)(*pathsegments)
|
||||
|
||||
def __str__(self):
|
||||
"""Return the string representation of the path, suitable for
|
||||
passing to system calls."""
|
||||
return self._raw_path
|
||||
|
||||
def as_posix(self):
|
||||
"""Return the string representation of the path with forward (/)
|
||||
slashes."""
|
||||
return str(self).replace(self.parser.sep, '/')
|
||||
|
||||
@property
|
||||
def drive(self):
|
||||
"""The drive prefix (letter or UNC path), if any."""
|
||||
return self.parser.splitdrive(self.anchor)[0]
|
||||
|
||||
@property
|
||||
def root(self):
|
||||
"""The root of the path, if any."""
|
||||
return self.parser.splitdrive(self.anchor)[1]
|
||||
|
||||
@property
|
||||
def anchor(self):
|
||||
"""The concatenation of the drive and root, or ''."""
|
||||
return self._stack[0]
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""The final path component, if any."""
|
||||
return self.parser.split(self._raw_path)[1]
|
||||
|
||||
@property
|
||||
def suffix(self):
|
||||
"""
|
||||
The final component's last suffix, if any.
|
||||
|
||||
This includes the leading period. For example: '.txt'
|
||||
"""
|
||||
name = self.name
|
||||
i = name.rfind('.')
|
||||
if 0 < i < len(name) - 1:
|
||||
return name[i:]
|
||||
else:
|
||||
return ''
|
||||
|
||||
@property
|
||||
def suffixes(self):
|
||||
"""
|
||||
A list of the final component's suffixes, if any.
|
||||
|
||||
These include the leading periods. For example: ['.tar', '.gz']
|
||||
"""
|
||||
name = self.name
|
||||
if name.endswith('.'):
|
||||
return []
|
||||
name = name.lstrip('.')
|
||||
return ['.' + suffix for suffix in name.split('.')[1:]]
|
||||
|
||||
@property
|
||||
def stem(self):
|
||||
"""The final path component, minus its last suffix."""
|
||||
name = self.name
|
||||
i = name.rfind('.')
|
||||
if 0 < i < len(name) - 1:
|
||||
return name[:i]
|
||||
else:
|
||||
return name
|
||||
|
||||
def with_name(self, name):
|
||||
"""Return a new path with the file name changed."""
|
||||
split = self.parser.split
|
||||
if split(name)[0]:
|
||||
raise ValueError(f"Invalid name {name!r}")
|
||||
return self.with_segments(split(self._raw_path)[0], name)
|
||||
|
||||
def with_stem(self, stem):
|
||||
"""Return a new path with the stem changed."""
|
||||
suffix = self.suffix
|
||||
if not suffix:
|
||||
return self.with_name(stem)
|
||||
elif not stem:
|
||||
# If the suffix is non-empty, we can't make the stem empty.
|
||||
raise ValueError(f"{self!r} has a non-empty suffix")
|
||||
else:
|
||||
return self.with_name(stem + suffix)
|
||||
|
||||
def with_suffix(self, suffix):
|
||||
"""Return a new path with the file suffix changed. If the path
|
||||
has no suffix, add given suffix. If the given suffix is an empty
|
||||
string, remove the suffix from the path.
|
||||
"""
|
||||
stem = self.stem
|
||||
if not stem:
|
||||
# If the stem is empty, we can't make the suffix non-empty.
|
||||
raise ValueError(f"{self!r} has an empty name")
|
||||
elif suffix and not (suffix.startswith('.') and len(suffix) > 1):
|
||||
raise ValueError(f"Invalid suffix {suffix!r}")
|
||||
else:
|
||||
return self.with_name(stem + suffix)
|
||||
|
||||
def relative_to(self, other, *, walk_up=False):
|
||||
"""Return the relative path to another path identified by the passed
|
||||
arguments. If the operation is not possible (because this is not
|
||||
related to the other path), raise ValueError.
|
||||
|
||||
The *walk_up* parameter controls whether `..` may be used to resolve
|
||||
the path.
|
||||
"""
|
||||
if not isinstance(other, PurePathBase):
|
||||
other = self.with_segments(other)
|
||||
anchor0, parts0 = self._stack
|
||||
anchor1, parts1 = other._stack
|
||||
if anchor0 != anchor1:
|
||||
raise ValueError(f"{self._raw_path!r} and {other._raw_path!r} have different anchors")
|
||||
while parts0 and parts1 and parts0[-1] == parts1[-1]:
|
||||
parts0.pop()
|
||||
parts1.pop()
|
||||
for part in parts1:
|
||||
if not part or part == '.':
|
||||
pass
|
||||
elif not walk_up:
|
||||
raise ValueError(f"{self._raw_path!r} is not in the subpath of {other._raw_path!r}")
|
||||
elif part == '..':
|
||||
raise ValueError(f"'..' segment in {other._raw_path!r} cannot be walked")
|
||||
else:
|
||||
parts0.append('..')
|
||||
return self.with_segments('', *reversed(parts0))
|
||||
|
||||
def is_relative_to(self, other):
|
||||
"""Return True if the path is relative to another path or False.
|
||||
"""
|
||||
if not isinstance(other, PurePathBase):
|
||||
other = self.with_segments(other)
|
||||
anchor0, parts0 = self._stack
|
||||
anchor1, parts1 = other._stack
|
||||
if anchor0 != anchor1:
|
||||
return False
|
||||
while parts0 and parts1 and parts0[-1] == parts1[-1]:
|
||||
parts0.pop()
|
||||
parts1.pop()
|
||||
for part in parts1:
|
||||
if part and part != '.':
|
||||
return False
|
||||
return True
|
||||
|
||||
@property
|
||||
def parts(self):
|
||||
"""An object providing sequence-like access to the
|
||||
components in the filesystem path."""
|
||||
anchor, parts = self._stack
|
||||
if anchor:
|
||||
parts.append(anchor)
|
||||
return tuple(reversed(parts))
|
||||
|
||||
def joinpath(self, *pathsegments):
|
||||
"""Combine this path with one or several arguments, and return a
|
||||
new path representing either a subpath (if all arguments are relative
|
||||
paths) or a totally different path (if one of the arguments is
|
||||
anchored).
|
||||
"""
|
||||
return self.with_segments(self._raw_path, *pathsegments)
|
||||
|
||||
def __truediv__(self, key):
|
||||
try:
|
||||
return self.with_segments(self._raw_path, key)
|
||||
except TypeError:
|
||||
return NotImplemented
|
||||
|
||||
def __rtruediv__(self, key):
|
||||
try:
|
||||
return self.with_segments(key, self._raw_path)
|
||||
except TypeError:
|
||||
return NotImplemented
|
||||
|
||||
@property
|
||||
def _stack(self):
|
||||
"""
|
||||
Split the path into a 2-tuple (anchor, parts), where *anchor* is the
|
||||
uppermost parent of the path (equivalent to path.parents[-1]), and
|
||||
*parts* is a reversed list of parts following the anchor.
|
||||
"""
|
||||
split = self.parser.split
|
||||
path = self._raw_path
|
||||
parent, name = split(path)
|
||||
names = []
|
||||
while path != parent:
|
||||
names.append(name)
|
||||
path = parent
|
||||
parent, name = split(path)
|
||||
return path, names
|
||||
|
||||
@property
|
||||
def parent(self):
|
||||
"""The logical parent of the path."""
|
||||
path = self._raw_path
|
||||
parent = self.parser.split(path)[0]
|
||||
if path != parent:
|
||||
parent = self.with_segments(parent)
|
||||
parent._resolving = self._resolving
|
||||
return parent
|
||||
return self
|
||||
|
||||
@property
|
||||
def parents(self):
|
||||
"""A sequence of this path's logical parents."""
|
||||
split = self.parser.split
|
||||
path = self._raw_path
|
||||
parent = split(path)[0]
|
||||
parents = []
|
||||
while path != parent:
|
||||
parents.append(self.with_segments(parent))
|
||||
path = parent
|
||||
parent = split(path)[0]
|
||||
return tuple(parents)
|
||||
|
||||
def is_absolute(self):
|
||||
"""True if the path is absolute (has both a root and, if applicable,
|
||||
a drive)."""
|
||||
return self.parser.isabs(self._raw_path)
|
||||
|
||||
@property
|
||||
def _pattern_str(self):
|
||||
"""The path expressed as a string, for use in pattern-matching."""
|
||||
return str(self)
|
||||
|
||||
def match(self, path_pattern, *, case_sensitive=None):
|
||||
"""
|
||||
Return True if this path matches the given pattern. If the pattern is
|
||||
relative, matching is done from the right; otherwise, the entire path
|
||||
is matched. The recursive wildcard '**' is *not* supported by this
|
||||
method.
|
||||
"""
|
||||
if not isinstance(path_pattern, PurePathBase):
|
||||
path_pattern = self.with_segments(path_pattern)
|
||||
if case_sensitive is None:
|
||||
case_sensitive = _is_case_sensitive(self.parser)
|
||||
sep = path_pattern.parser.sep
|
||||
path_parts = self.parts[::-1]
|
||||
pattern_parts = path_pattern.parts[::-1]
|
||||
if not pattern_parts:
|
||||
raise ValueError("empty pattern")
|
||||
if len(path_parts) < len(pattern_parts):
|
||||
return False
|
||||
if len(path_parts) > len(pattern_parts) and path_pattern.anchor:
|
||||
return False
|
||||
globber = self._globber(sep, case_sensitive)
|
||||
for path_part, pattern_part in zip(path_parts, pattern_parts):
|
||||
match = globber.compile(pattern_part)
|
||||
if match(path_part) is None:
|
||||
return False
|
||||
return True
|
||||
|
||||
def full_match(self, pattern, *, case_sensitive=None):
|
||||
"""
|
||||
Return True if this path matches the given glob-style pattern. The
|
||||
pattern is matched against the entire path.
|
||||
"""
|
||||
if not isinstance(pattern, PurePathBase):
|
||||
pattern = self.with_segments(pattern)
|
||||
if case_sensitive is None:
|
||||
case_sensitive = _is_case_sensitive(self.parser)
|
||||
globber = self._globber(pattern.parser.sep, case_sensitive, recursive=True)
|
||||
match = globber.compile(pattern._pattern_str)
|
||||
return match(self._pattern_str) is not None
|
||||
|
||||
|
||||
|
||||
class PathBase(PurePathBase):
|
||||
"""Base class for concrete path objects.
|
||||
|
||||
This class provides dummy implementations for many methods that derived
|
||||
classes can override selectively; the default implementations raise
|
||||
UnsupportedOperation. The most basic methods, such as stat() and open(),
|
||||
directly raise UnsupportedOperation; these basic methods are called by
|
||||
other methods such as is_dir() and read_text().
|
||||
|
||||
The Path class derives this class to implement local filesystem paths.
|
||||
Users may derive their own classes to implement virtual filesystem paths,
|
||||
such as paths in archive files or on remote storage systems.
|
||||
"""
|
||||
__slots__ = ()
|
||||
|
||||
# Maximum number of symlinks to follow in resolve()
|
||||
_max_symlinks = 40
|
||||
|
||||
@classmethod
|
||||
def _unsupported_msg(cls, attribute):
|
||||
return f"{cls.__name__}.{attribute} is unsupported"
|
||||
|
||||
def stat(self, *, follow_symlinks=True):
|
||||
"""
|
||||
Return the result of the stat() system call on this path, like
|
||||
os.stat() does.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('stat()'))
|
||||
|
||||
def lstat(self):
|
||||
"""
|
||||
Like stat(), except if the path points to a symlink, the symlink's
|
||||
status information is returned, rather than its target's.
|
||||
"""
|
||||
return self.stat(follow_symlinks=False)
|
||||
|
||||
|
||||
# Convenience functions for querying the stat results
|
||||
|
||||
def exists(self, *, follow_symlinks=True):
|
||||
"""
|
||||
Whether this path exists.
|
||||
|
||||
This method normally follows symlinks; to check whether a symlink exists,
|
||||
add the argument follow_symlinks=False.
|
||||
"""
|
||||
try:
|
||||
self.stat(follow_symlinks=follow_symlinks)
|
||||
except OSError as e:
|
||||
if not _ignore_error(e):
|
||||
raise
|
||||
return False
|
||||
except ValueError:
|
||||
# Non-encodable path
|
||||
return False
|
||||
return True
|
||||
|
||||
def is_dir(self, *, follow_symlinks=True):
|
||||
"""
|
||||
Whether this path is a directory.
|
||||
"""
|
||||
try:
|
||||
return S_ISDIR(self.stat(follow_symlinks=follow_symlinks).st_mode)
|
||||
except OSError as e:
|
||||
if not _ignore_error(e):
|
||||
raise
|
||||
# Path doesn't exist or is a broken symlink
|
||||
# (see http://web.archive.org/web/20200623061726/https://bitbucket.org/pitrou/pathlib/issues/12/ )
|
||||
return False
|
||||
except ValueError:
|
||||
# Non-encodable path
|
||||
return False
|
||||
|
||||
def is_file(self, *, follow_symlinks=True):
|
||||
"""
|
||||
Whether this path is a regular file (also True for symlinks pointing
|
||||
to regular files).
|
||||
"""
|
||||
try:
|
||||
return S_ISREG(self.stat(follow_symlinks=follow_symlinks).st_mode)
|
||||
except OSError as e:
|
||||
if not _ignore_error(e):
|
||||
raise
|
||||
# Path doesn't exist or is a broken symlink
|
||||
# (see http://web.archive.org/web/20200623061726/https://bitbucket.org/pitrou/pathlib/issues/12/ )
|
||||
return False
|
||||
except ValueError:
|
||||
# Non-encodable path
|
||||
return False
|
||||
|
||||
def is_mount(self):
|
||||
"""
|
||||
Check if this path is a mount point
|
||||
"""
|
||||
# Need to exist and be a dir
|
||||
if not self.exists() or not self.is_dir():
|
||||
return False
|
||||
|
||||
try:
|
||||
parent_dev = self.parent.stat().st_dev
|
||||
except OSError:
|
||||
return False
|
||||
|
||||
dev = self.stat().st_dev
|
||||
if dev != parent_dev:
|
||||
return True
|
||||
ino = self.stat().st_ino
|
||||
parent_ino = self.parent.stat().st_ino
|
||||
return ino == parent_ino
|
||||
|
||||
def is_symlink(self):
|
||||
"""
|
||||
Whether this path is a symbolic link.
|
||||
"""
|
||||
try:
|
||||
return S_ISLNK(self.lstat().st_mode)
|
||||
except OSError as e:
|
||||
if not _ignore_error(e):
|
||||
raise
|
||||
# Path doesn't exist
|
||||
return False
|
||||
except ValueError:
|
||||
# Non-encodable path
|
||||
return False
|
||||
|
||||
def is_junction(self):
|
||||
"""
|
||||
Whether this path is a junction.
|
||||
"""
|
||||
# Junctions are a Windows-only feature, not present in POSIX nor the
|
||||
# majority of virtual filesystems. There is no cross-platform idiom
|
||||
# to check for junctions (using stat().st_mode).
|
||||
return False
|
||||
|
||||
def is_block_device(self):
|
||||
"""
|
||||
Whether this path is a block device.
|
||||
"""
|
||||
try:
|
||||
return S_ISBLK(self.stat().st_mode)
|
||||
except OSError as e:
|
||||
if not _ignore_error(e):
|
||||
raise
|
||||
# Path doesn't exist or is a broken symlink
|
||||
# (see http://web.archive.org/web/20200623061726/https://bitbucket.org/pitrou/pathlib/issues/12/ )
|
||||
return False
|
||||
except ValueError:
|
||||
# Non-encodable path
|
||||
return False
|
||||
|
||||
def is_char_device(self):
|
||||
"""
|
||||
Whether this path is a character device.
|
||||
"""
|
||||
try:
|
||||
return S_ISCHR(self.stat().st_mode)
|
||||
except OSError as e:
|
||||
if not _ignore_error(e):
|
||||
raise
|
||||
# Path doesn't exist or is a broken symlink
|
||||
# (see http://web.archive.org/web/20200623061726/https://bitbucket.org/pitrou/pathlib/issues/12/ )
|
||||
return False
|
||||
except ValueError:
|
||||
# Non-encodable path
|
||||
return False
|
||||
|
||||
def is_fifo(self):
|
||||
"""
|
||||
Whether this path is a FIFO.
|
||||
"""
|
||||
try:
|
||||
return S_ISFIFO(self.stat().st_mode)
|
||||
except OSError as e:
|
||||
if not _ignore_error(e):
|
||||
raise
|
||||
# Path doesn't exist or is a broken symlink
|
||||
# (see http://web.archive.org/web/20200623061726/https://bitbucket.org/pitrou/pathlib/issues/12/ )
|
||||
return False
|
||||
except ValueError:
|
||||
# Non-encodable path
|
||||
return False
|
||||
|
||||
def is_socket(self):
|
||||
"""
|
||||
Whether this path is a socket.
|
||||
"""
|
||||
try:
|
||||
return S_ISSOCK(self.stat().st_mode)
|
||||
except OSError as e:
|
||||
if not _ignore_error(e):
|
||||
raise
|
||||
# Path doesn't exist or is a broken symlink
|
||||
# (see http://web.archive.org/web/20200623061726/https://bitbucket.org/pitrou/pathlib/issues/12/ )
|
||||
return False
|
||||
except ValueError:
|
||||
# Non-encodable path
|
||||
return False
|
||||
|
||||
def samefile(self, other_path):
|
||||
"""Return whether other_path is the same or not as this file
|
||||
(as returned by os.path.samefile()).
|
||||
"""
|
||||
st = self.stat()
|
||||
try:
|
||||
other_st = other_path.stat()
|
||||
except AttributeError:
|
||||
other_st = self.with_segments(other_path).stat()
|
||||
return (st.st_ino == other_st.st_ino and
|
||||
st.st_dev == other_st.st_dev)
|
||||
|
||||
def open(self, mode='r', buffering=-1, encoding=None,
|
||||
errors=None, newline=None):
|
||||
"""
|
||||
Open the file pointed to by this path and return a file object, as
|
||||
the built-in open() function does.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('open()'))
|
||||
|
||||
def read_bytes(self):
|
||||
"""
|
||||
Open the file in bytes mode, read it, and close the file.
|
||||
"""
|
||||
with self.open(mode='rb') as f:
|
||||
return f.read()
|
||||
|
||||
def read_text(self, encoding=None, errors=None, newline=None):
|
||||
"""
|
||||
Open the file in text mode, read it, and close the file.
|
||||
"""
|
||||
with self.open(mode='r', encoding=encoding, errors=errors, newline=newline) as f:
|
||||
return f.read()
|
||||
|
||||
def write_bytes(self, data):
|
||||
"""
|
||||
Open the file in bytes mode, write to it, and close the file.
|
||||
"""
|
||||
# type-check for the buffer interface before truncating the file
|
||||
view = memoryview(data)
|
||||
with self.open(mode='wb') as f:
|
||||
return f.write(view)
|
||||
|
||||
def write_text(self, data, encoding=None, errors=None, newline=None):
|
||||
"""
|
||||
Open the file in text mode, write to it, and close the file.
|
||||
"""
|
||||
if not isinstance(data, str):
|
||||
raise TypeError('data must be str, not %s' %
|
||||
data.__class__.__name__)
|
||||
with self.open(mode='w', encoding=encoding, errors=errors, newline=newline) as f:
|
||||
return f.write(data)
|
||||
|
||||
def iterdir(self):
|
||||
"""Yield path objects of the directory contents.
|
||||
|
||||
The children are yielded in arbitrary order, and the
|
||||
special entries '.' and '..' are not included.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('iterdir()'))
|
||||
|
||||
def _glob_selector(self, parts, case_sensitive, recurse_symlinks):
|
||||
if case_sensitive is None:
|
||||
case_sensitive = _is_case_sensitive(self.parser)
|
||||
case_pedantic = False
|
||||
else:
|
||||
# The user has expressed a case sensitivity choice, but we don't
|
||||
# know the case sensitivity of the underlying filesystem, so we
|
||||
# must use scandir() for everything, including non-wildcard parts.
|
||||
case_pedantic = True
|
||||
recursive = True if recurse_symlinks else _no_recurse_symlinks
|
||||
globber = self._globber(self.parser.sep, case_sensitive, case_pedantic, recursive)
|
||||
return globber.selector(parts)
|
||||
|
||||
def glob(self, pattern, *, case_sensitive=None, recurse_symlinks=True):
|
||||
"""Iterate over this subtree and yield all existing files (of any
|
||||
kind, including directories) matching the given relative pattern.
|
||||
"""
|
||||
if not isinstance(pattern, PurePathBase):
|
||||
pattern = self.with_segments(pattern)
|
||||
anchor, parts = pattern._stack
|
||||
if anchor:
|
||||
raise NotImplementedError("Non-relative patterns are unsupported")
|
||||
select = self._glob_selector(parts, case_sensitive, recurse_symlinks)
|
||||
return select(self)
|
||||
|
||||
def rglob(self, pattern, *, case_sensitive=None, recurse_symlinks=True):
|
||||
"""Recursively yield all existing files (of any kind, including
|
||||
directories) matching the given relative pattern, anywhere in
|
||||
this subtree.
|
||||
"""
|
||||
if not isinstance(pattern, PurePathBase):
|
||||
pattern = self.with_segments(pattern)
|
||||
pattern = '**' / pattern
|
||||
return self.glob(pattern, case_sensitive=case_sensitive, recurse_symlinks=recurse_symlinks)
|
||||
|
||||
def walk(self, top_down=True, on_error=None, follow_symlinks=False):
|
||||
"""Walk the directory tree from this directory, similar to os.walk()."""
|
||||
paths = [self]
|
||||
while paths:
|
||||
path = paths.pop()
|
||||
if isinstance(path, tuple):
|
||||
yield path
|
||||
continue
|
||||
dirnames = []
|
||||
filenames = []
|
||||
if not top_down:
|
||||
paths.append((path, dirnames, filenames))
|
||||
try:
|
||||
for child in path.iterdir():
|
||||
try:
|
||||
if child.is_dir(follow_symlinks=follow_symlinks):
|
||||
if not top_down:
|
||||
paths.append(child)
|
||||
dirnames.append(child.name)
|
||||
else:
|
||||
filenames.append(child.name)
|
||||
except OSError:
|
||||
filenames.append(child.name)
|
||||
except OSError as error:
|
||||
if on_error is not None:
|
||||
on_error(error)
|
||||
if not top_down:
|
||||
while not isinstance(paths.pop(), tuple):
|
||||
pass
|
||||
continue
|
||||
if top_down:
|
||||
yield path, dirnames, filenames
|
||||
paths += [path.joinpath(d) for d in reversed(dirnames)]
|
||||
|
||||
def absolute(self):
|
||||
"""Return an absolute version of this path
|
||||
No normalization or symlink resolution is performed.
|
||||
|
||||
Use resolve() to resolve symlinks and remove '..' segments.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('absolute()'))
|
||||
|
||||
@classmethod
|
||||
def cwd(cls):
|
||||
"""Return a new path pointing to the current working directory."""
|
||||
# We call 'absolute()' rather than using 'os.getcwd()' directly to
|
||||
# enable users to replace the implementation of 'absolute()' in a
|
||||
# subclass and benefit from the new behaviour here. This works because
|
||||
# os.path.abspath('.') == os.getcwd().
|
||||
return cls('').absolute()
|
||||
|
||||
def expanduser(self):
|
||||
""" Return a new path with expanded ~ and ~user constructs
|
||||
(as returned by os.path.expanduser)
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('expanduser()'))
|
||||
|
||||
@classmethod
|
||||
def home(cls):
|
||||
"""Return a new path pointing to expanduser('~').
|
||||
"""
|
||||
return cls("~").expanduser()
|
||||
|
||||
def readlink(self):
|
||||
"""
|
||||
Return the path to which the symbolic link points.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('readlink()'))
|
||||
readlink._supported = False
|
||||
|
||||
def resolve(self, strict=False):
|
||||
"""
|
||||
Make the path absolute, resolving all symlinks on the way and also
|
||||
normalizing it.
|
||||
"""
|
||||
if self._resolving:
|
||||
return self
|
||||
path_root, parts = self._stack
|
||||
path = self.with_segments(path_root)
|
||||
try:
|
||||
path = path.absolute()
|
||||
except UnsupportedOperation:
|
||||
path_tail = []
|
||||
else:
|
||||
path_root, path_tail = path._stack
|
||||
path_tail.reverse()
|
||||
|
||||
# If the user has *not* overridden the `readlink()` method, then symlinks are unsupported
|
||||
# and (in non-strict mode) we can improve performance by not calling `stat()`.
|
||||
querying = strict or getattr(self.readlink, '_supported', True)
|
||||
link_count = 0
|
||||
while parts:
|
||||
part = parts.pop()
|
||||
if not part or part == '.':
|
||||
continue
|
||||
if part == '..':
|
||||
if not path_tail:
|
||||
if path_root:
|
||||
# Delete '..' segment immediately following root
|
||||
continue
|
||||
elif path_tail[-1] != '..':
|
||||
# Delete '..' segment and its predecessor
|
||||
path_tail.pop()
|
||||
continue
|
||||
path_tail.append(part)
|
||||
if querying and part != '..':
|
||||
path = self.with_segments(path_root + self.parser.sep.join(path_tail))
|
||||
path._resolving = True
|
||||
try:
|
||||
st = path.stat(follow_symlinks=False)
|
||||
if S_ISLNK(st.st_mode):
|
||||
# Like Linux and macOS, raise OSError(errno.ELOOP) if too many symlinks are
|
||||
# encountered during resolution.
|
||||
link_count += 1
|
||||
if link_count >= self._max_symlinks:
|
||||
raise OSError(ELOOP, "Too many symbolic links in path", self._raw_path)
|
||||
target_root, target_parts = path.readlink()._stack
|
||||
# If the symlink target is absolute (like '/etc/hosts'), set the current
|
||||
# path to its uppermost parent (like '/').
|
||||
if target_root:
|
||||
path_root = target_root
|
||||
path_tail.clear()
|
||||
else:
|
||||
path_tail.pop()
|
||||
# Add the symlink target's reversed tail parts (like ['hosts', 'etc']) to
|
||||
# the stack of unresolved path parts.
|
||||
parts.extend(target_parts)
|
||||
continue
|
||||
elif parts and not S_ISDIR(st.st_mode):
|
||||
raise NotADirectoryError(ENOTDIR, "Not a directory", self._raw_path)
|
||||
except OSError:
|
||||
if strict:
|
||||
raise
|
||||
else:
|
||||
querying = False
|
||||
return self.with_segments(path_root + self.parser.sep.join(path_tail))
|
||||
|
||||
def symlink_to(self, target, target_is_directory=False):
|
||||
"""
|
||||
Make this path a symlink pointing to the target path.
|
||||
Note the order of arguments (link, target) is the reverse of os.symlink.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('symlink_to()'))
|
||||
|
||||
def hardlink_to(self, target):
|
||||
"""
|
||||
Make this path a hard link pointing to the same file as *target*.
|
||||
|
||||
Note the order of arguments (self, target) is the reverse of os.link's.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('hardlink_to()'))
|
||||
|
||||
def touch(self, mode=0o666, exist_ok=True):
|
||||
"""
|
||||
Create this file with the given access mode, if it doesn't exist.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('touch()'))
|
||||
|
||||
def mkdir(self, mode=0o777, parents=False, exist_ok=False):
|
||||
"""
|
||||
Create a new directory at this given path.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('mkdir()'))
|
||||
|
||||
def rename(self, target):
|
||||
"""
|
||||
Rename this path to the target path.
|
||||
|
||||
The target path may be absolute or relative. Relative paths are
|
||||
interpreted relative to the current working directory, *not* the
|
||||
directory of the Path object.
|
||||
|
||||
Returns the new Path instance pointing to the target path.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('rename()'))
|
||||
|
||||
def replace(self, target):
|
||||
"""
|
||||
Rename this path to the target path, overwriting if that path exists.
|
||||
|
||||
The target path may be absolute or relative. Relative paths are
|
||||
interpreted relative to the current working directory, *not* the
|
||||
directory of the Path object.
|
||||
|
||||
Returns the new Path instance pointing to the target path.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('replace()'))
|
||||
|
||||
def chmod(self, mode, *, follow_symlinks=True):
|
||||
"""
|
||||
Change the permissions of the path, like os.chmod().
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('chmod()'))
|
||||
|
||||
def lchmod(self, mode):
|
||||
"""
|
||||
Like chmod(), except if the path points to a symlink, the symlink's
|
||||
permissions are changed, rather than its target's.
|
||||
"""
|
||||
self.chmod(mode, follow_symlinks=False)
|
||||
|
||||
def unlink(self, missing_ok=False):
|
||||
"""
|
||||
Remove this file or link.
|
||||
If the path is a directory, use rmdir() instead.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('unlink()'))
|
||||
|
||||
def rmdir(self):
|
||||
"""
|
||||
Remove this directory. The directory must be empty.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('rmdir()'))
|
||||
|
||||
def owner(self, *, follow_symlinks=True):
|
||||
"""
|
||||
Return the login name of the file owner.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('owner()'))
|
||||
|
||||
def group(self, *, follow_symlinks=True):
|
||||
"""
|
||||
Return the group name of the file gid.
|
||||
"""
|
||||
raise UnsupportedOperation(self._unsupported_msg('group()'))
|
||||
|
||||
@classmethod
|
||||
def from_uri(cls, uri):
|
||||
"""Return a new path from the given 'file' URI."""
|
||||
raise UnsupportedOperation(cls._unsupported_msg('from_uri()'))
|
||||
|
||||
def as_uri(self):
|
||||
"""Return the path as a URI."""
|
||||
raise UnsupportedOperation(self._unsupported_msg('as_uri()'))
|
||||
Vendored
+861
@@ -0,0 +1,861 @@
|
||||
import io
|
||||
import ntpath
|
||||
import operator
|
||||
import os
|
||||
import posixpath
|
||||
import sys
|
||||
import warnings
|
||||
from glob import _StringGlobber
|
||||
from itertools import chain
|
||||
from _collections_abc import Sequence
|
||||
|
||||
try:
|
||||
import pwd
|
||||
except ImportError:
|
||||
pwd = None
|
||||
try:
|
||||
import grp
|
||||
except ImportError:
|
||||
grp = None
|
||||
|
||||
from ._abc import UnsupportedOperation, PurePathBase, PathBase
|
||||
|
||||
|
||||
__all__ = [
|
||||
"PurePath", "PurePosixPath", "PureWindowsPath",
|
||||
"Path", "PosixPath", "WindowsPath",
|
||||
]
|
||||
|
||||
|
||||
class _PathParents(Sequence):
|
||||
"""This object provides sequence-like access to the logical ancestors
|
||||
of a path. Don't try to construct it yourself."""
|
||||
__slots__ = ('_path', '_drv', '_root', '_tail')
|
||||
|
||||
def __init__(self, path):
|
||||
self._path = path
|
||||
self._drv = path.drive
|
||||
self._root = path.root
|
||||
self._tail = path._tail
|
||||
|
||||
def __len__(self):
|
||||
return len(self._tail)
|
||||
|
||||
def __getitem__(self, idx):
|
||||
if isinstance(idx, slice):
|
||||
return tuple(self[i] for i in range(*idx.indices(len(self))))
|
||||
|
||||
if idx >= len(self) or idx < -len(self):
|
||||
raise IndexError(idx)
|
||||
if idx < 0:
|
||||
idx += len(self)
|
||||
return self._path._from_parsed_parts(self._drv, self._root,
|
||||
self._tail[:-idx - 1])
|
||||
|
||||
def __repr__(self):
|
||||
return "<{}.parents>".format(type(self._path).__name__)
|
||||
|
||||
|
||||
class PurePath(PurePathBase):
|
||||
"""Base class for manipulating paths without I/O.
|
||||
|
||||
PurePath represents a filesystem path and offers operations which
|
||||
don't imply any actual filesystem I/O. Depending on your system,
|
||||
instantiating a PurePath will return either a PurePosixPath or a
|
||||
PureWindowsPath object. You can also instantiate either of these classes
|
||||
directly, regardless of your system.
|
||||
"""
|
||||
|
||||
__slots__ = (
|
||||
# The `_raw_paths` slot stores unnormalized string paths. This is set
|
||||
# in the `__init__()` method.
|
||||
'_raw_paths',
|
||||
|
||||
# The `_drv`, `_root` and `_tail_cached` slots store parsed and
|
||||
# normalized parts of the path. They are set when any of the `drive`,
|
||||
# `root` or `_tail` properties are accessed for the first time. The
|
||||
# three-part division corresponds to the result of
|
||||
# `os.path.splitroot()`, except that the tail is further split on path
|
||||
# separators (i.e. it is a list of strings), and that the root and
|
||||
# tail are normalized.
|
||||
'_drv', '_root', '_tail_cached',
|
||||
|
||||
# The `_str` slot stores the string representation of the path,
|
||||
# computed from the drive, root and tail when `__str__()` is called
|
||||
# for the first time. It's used to implement `_str_normcase`
|
||||
'_str',
|
||||
|
||||
# The `_str_normcase_cached` slot stores the string path with
|
||||
# normalized case. It is set when the `_str_normcase` property is
|
||||
# accessed for the first time. It's used to implement `__eq__()`
|
||||
# `__hash__()`, and `_parts_normcase`
|
||||
'_str_normcase_cached',
|
||||
|
||||
# The `_parts_normcase_cached` slot stores the case-normalized
|
||||
# string path after splitting on path separators. It's set when the
|
||||
# `_parts_normcase` property is accessed for the first time. It's used
|
||||
# to implement comparison methods like `__lt__()`.
|
||||
'_parts_normcase_cached',
|
||||
|
||||
# The `_hash` slot stores the hash of the case-normalized string
|
||||
# path. It's set when `__hash__()` is called for the first time.
|
||||
'_hash',
|
||||
)
|
||||
parser = os.path
|
||||
_globber = _StringGlobber
|
||||
|
||||
def __new__(cls, *args, **kwargs):
|
||||
"""Construct a PurePath from one or several strings and or existing
|
||||
PurePath objects. The strings and path objects are combined so as
|
||||
to yield a canonicalized path, which is incorporated into the
|
||||
new PurePath object.
|
||||
"""
|
||||
if cls is PurePath:
|
||||
cls = PureWindowsPath if os.name == 'nt' else PurePosixPath
|
||||
return object.__new__(cls)
|
||||
|
||||
def __init__(self, *args):
|
||||
paths = []
|
||||
for arg in args:
|
||||
if isinstance(arg, PurePath):
|
||||
if arg.parser is not self.parser:
|
||||
# GH-103631: Convert separators for backwards compatibility.
|
||||
paths.append(arg.as_posix())
|
||||
else:
|
||||
paths.extend(arg._raw_paths)
|
||||
else:
|
||||
try:
|
||||
path = os.fspath(arg)
|
||||
except TypeError:
|
||||
path = arg
|
||||
if not isinstance(path, str):
|
||||
raise TypeError(
|
||||
"argument should be a str or an os.PathLike "
|
||||
"object where __fspath__ returns a str, "
|
||||
f"not {type(path).__name__!r}")
|
||||
paths.append(path)
|
||||
# Avoid calling super().__init__, as an optimisation
|
||||
self._raw_paths = paths
|
||||
|
||||
def joinpath(self, *pathsegments):
|
||||
"""Combine this path with one or several arguments, and return a
|
||||
new path representing either a subpath (if all arguments are relative
|
||||
paths) or a totally different path (if one of the arguments is
|
||||
anchored).
|
||||
"""
|
||||
return self.with_segments(self, *pathsegments)
|
||||
|
||||
def __truediv__(self, key):
|
||||
try:
|
||||
return self.with_segments(self, key)
|
||||
except TypeError:
|
||||
return NotImplemented
|
||||
|
||||
def __rtruediv__(self, key):
|
||||
try:
|
||||
return self.with_segments(key, self)
|
||||
except TypeError:
|
||||
return NotImplemented
|
||||
|
||||
def __reduce__(self):
|
||||
return self.__class__, tuple(self._raw_paths)
|
||||
|
||||
def __repr__(self):
|
||||
return "{}({!r})".format(self.__class__.__name__, self.as_posix())
|
||||
|
||||
def __fspath__(self):
|
||||
return str(self)
|
||||
|
||||
def __bytes__(self):
|
||||
"""Return the bytes representation of the path. This is only
|
||||
recommended to use under Unix."""
|
||||
return os.fsencode(self)
|
||||
|
||||
@property
|
||||
def _str_normcase(self):
|
||||
# String with normalized case, for hashing and equality checks
|
||||
try:
|
||||
return self._str_normcase_cached
|
||||
except AttributeError:
|
||||
if self.parser is posixpath:
|
||||
self._str_normcase_cached = str(self)
|
||||
else:
|
||||
self._str_normcase_cached = str(self).lower()
|
||||
return self._str_normcase_cached
|
||||
|
||||
def __hash__(self):
|
||||
try:
|
||||
return self._hash
|
||||
except AttributeError:
|
||||
self._hash = hash(self._str_normcase)
|
||||
return self._hash
|
||||
|
||||
def __eq__(self, other):
|
||||
if not isinstance(other, PurePath):
|
||||
return NotImplemented
|
||||
return self._str_normcase == other._str_normcase and self.parser is other.parser
|
||||
|
||||
@property
|
||||
def _parts_normcase(self):
|
||||
# Cached parts with normalized case, for comparisons.
|
||||
try:
|
||||
return self._parts_normcase_cached
|
||||
except AttributeError:
|
||||
self._parts_normcase_cached = self._str_normcase.split(self.parser.sep)
|
||||
return self._parts_normcase_cached
|
||||
|
||||
def __lt__(self, other):
|
||||
if not isinstance(other, PurePath) or self.parser is not other.parser:
|
||||
return NotImplemented
|
||||
return self._parts_normcase < other._parts_normcase
|
||||
|
||||
def __le__(self, other):
|
||||
if not isinstance(other, PurePath) or self.parser is not other.parser:
|
||||
return NotImplemented
|
||||
return self._parts_normcase <= other._parts_normcase
|
||||
|
||||
def __gt__(self, other):
|
||||
if not isinstance(other, PurePath) or self.parser is not other.parser:
|
||||
return NotImplemented
|
||||
return self._parts_normcase > other._parts_normcase
|
||||
|
||||
def __ge__(self, other):
|
||||
if not isinstance(other, PurePath) or self.parser is not other.parser:
|
||||
return NotImplemented
|
||||
return self._parts_normcase >= other._parts_normcase
|
||||
|
||||
def __str__(self):
|
||||
"""Return the string representation of the path, suitable for
|
||||
passing to system calls."""
|
||||
try:
|
||||
return self._str
|
||||
except AttributeError:
|
||||
self._str = self._format_parsed_parts(self.drive, self.root,
|
||||
self._tail) or '.'
|
||||
return self._str
|
||||
|
||||
@classmethod
|
||||
def _format_parsed_parts(cls, drv, root, tail):
|
||||
if drv or root:
|
||||
return drv + root + cls.parser.sep.join(tail)
|
||||
elif tail and cls.parser.splitdrive(tail[0])[0]:
|
||||
tail = ['.'] + tail
|
||||
return cls.parser.sep.join(tail)
|
||||
|
||||
def _from_parsed_parts(self, drv, root, tail):
|
||||
path = self._from_parsed_string(self._format_parsed_parts(drv, root, tail))
|
||||
path._drv = drv
|
||||
path._root = root
|
||||
path._tail_cached = tail
|
||||
return path
|
||||
|
||||
def _from_parsed_string(self, path_str):
|
||||
path = self.with_segments(path_str)
|
||||
path._str = path_str or '.'
|
||||
return path
|
||||
|
||||
@classmethod
|
||||
def _parse_path(cls, path):
|
||||
if not path:
|
||||
return '', '', []
|
||||
sep = cls.parser.sep
|
||||
altsep = cls.parser.altsep
|
||||
if altsep:
|
||||
path = path.replace(altsep, sep)
|
||||
drv, root, rel = cls.parser.splitroot(path)
|
||||
if not root and drv.startswith(sep) and not drv.endswith(sep):
|
||||
drv_parts = drv.split(sep)
|
||||
if len(drv_parts) == 4 and drv_parts[2] not in '?.':
|
||||
# e.g. //server/share
|
||||
root = sep
|
||||
elif len(drv_parts) == 6:
|
||||
# e.g. //?/unc/server/share
|
||||
root = sep
|
||||
parsed = [sys.intern(str(x)) for x in rel.split(sep) if x and x != '.']
|
||||
return drv, root, parsed
|
||||
|
||||
@property
|
||||
def _raw_path(self):
|
||||
"""The joined but unnormalized path."""
|
||||
paths = self._raw_paths
|
||||
if len(paths) == 0:
|
||||
path = ''
|
||||
elif len(paths) == 1:
|
||||
path = paths[0]
|
||||
else:
|
||||
path = self.parser.join(*paths)
|
||||
return path
|
||||
|
||||
@property
|
||||
def drive(self):
|
||||
"""The drive prefix (letter or UNC path), if any."""
|
||||
try:
|
||||
return self._drv
|
||||
except AttributeError:
|
||||
self._drv, self._root, self._tail_cached = self._parse_path(self._raw_path)
|
||||
return self._drv
|
||||
|
||||
@property
|
||||
def root(self):
|
||||
"""The root of the path, if any."""
|
||||
try:
|
||||
return self._root
|
||||
except AttributeError:
|
||||
self._drv, self._root, self._tail_cached = self._parse_path(self._raw_path)
|
||||
return self._root
|
||||
|
||||
@property
|
||||
def _tail(self):
|
||||
try:
|
||||
return self._tail_cached
|
||||
except AttributeError:
|
||||
self._drv, self._root, self._tail_cached = self._parse_path(self._raw_path)
|
||||
return self._tail_cached
|
||||
|
||||
@property
|
||||
def anchor(self):
|
||||
"""The concatenation of the drive and root, or ''."""
|
||||
return self.drive + self.root
|
||||
|
||||
@property
|
||||
def parts(self):
|
||||
"""An object providing sequence-like access to the
|
||||
components in the filesystem path."""
|
||||
if self.drive or self.root:
|
||||
return (self.drive + self.root,) + tuple(self._tail)
|
||||
else:
|
||||
return tuple(self._tail)
|
||||
|
||||
@property
|
||||
def parent(self):
|
||||
"""The logical parent of the path."""
|
||||
drv = self.drive
|
||||
root = self.root
|
||||
tail = self._tail
|
||||
if not tail:
|
||||
return self
|
||||
return self._from_parsed_parts(drv, root, tail[:-1])
|
||||
|
||||
@property
|
||||
def parents(self):
|
||||
"""A sequence of this path's logical parents."""
|
||||
# The value of this property should not be cached on the path object,
|
||||
# as doing so would introduce a reference cycle.
|
||||
return _PathParents(self)
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
"""The final path component, if any."""
|
||||
tail = self._tail
|
||||
if not tail:
|
||||
return ''
|
||||
return tail[-1]
|
||||
|
||||
def with_name(self, name):
|
||||
"""Return a new path with the file name changed."""
|
||||
p = self.parser
|
||||
if not name or p.sep in name or (p.altsep and p.altsep in name) or name == '.':
|
||||
raise ValueError(f"Invalid name {name!r}")
|
||||
tail = self._tail.copy()
|
||||
if not tail:
|
||||
raise ValueError(f"{self!r} has an empty name")
|
||||
tail[-1] = name
|
||||
return self._from_parsed_parts(self.drive, self.root, tail)
|
||||
|
||||
def relative_to(self, other, /, *_deprecated, walk_up=False):
|
||||
"""Return the relative path to another path identified by the passed
|
||||
arguments. If the operation is not possible (because this is not
|
||||
related to the other path), raise ValueError.
|
||||
|
||||
The *walk_up* parameter controls whether `..` may be used to resolve
|
||||
the path.
|
||||
"""
|
||||
if _deprecated:
|
||||
msg = ("support for supplying more than one positional argument "
|
||||
"to pathlib.PurePath.relative_to() is deprecated and "
|
||||
"scheduled for removal in Python 3.14")
|
||||
warnings.warn(msg, DeprecationWarning, stacklevel=2)
|
||||
other = self.with_segments(other, *_deprecated)
|
||||
elif not isinstance(other, PurePath):
|
||||
other = self.with_segments(other)
|
||||
for step, path in enumerate(chain([other], other.parents)):
|
||||
if path == self or path in self.parents:
|
||||
break
|
||||
elif not walk_up:
|
||||
raise ValueError(f"{str(self)!r} is not in the subpath of {str(other)!r}")
|
||||
elif path.name == '..':
|
||||
raise ValueError(f"'..' segment in {str(other)!r} cannot be walked")
|
||||
else:
|
||||
raise ValueError(f"{str(self)!r} and {str(other)!r} have different anchors")
|
||||
parts = ['..'] * step + self._tail[len(path._tail):]
|
||||
return self._from_parsed_parts('', '', parts)
|
||||
|
||||
def is_relative_to(self, other, /, *_deprecated):
|
||||
"""Return True if the path is relative to another path or False.
|
||||
"""
|
||||
if _deprecated:
|
||||
msg = ("support for supplying more than one argument to "
|
||||
"pathlib.PurePath.is_relative_to() is deprecated and "
|
||||
"scheduled for removal in Python 3.14")
|
||||
warnings.warn(msg, DeprecationWarning, stacklevel=2)
|
||||
other = self.with_segments(other, *_deprecated)
|
||||
elif not isinstance(other, PurePath):
|
||||
other = self.with_segments(other)
|
||||
return other == self or other in self.parents
|
||||
|
||||
def is_absolute(self):
|
||||
"""True if the path is absolute (has both a root and, if applicable,
|
||||
a drive)."""
|
||||
if self.parser is posixpath:
|
||||
# Optimization: work with raw paths on POSIX.
|
||||
for path in self._raw_paths:
|
||||
if path.startswith('/'):
|
||||
return True
|
||||
return False
|
||||
return self.parser.isabs(self)
|
||||
|
||||
def is_reserved(self):
|
||||
"""Return True if the path contains one of the special names reserved
|
||||
by the system, if any."""
|
||||
msg = ("pathlib.PurePath.is_reserved() is deprecated and scheduled "
|
||||
"for removal in Python 3.15. Use os.path.isreserved() to "
|
||||
"detect reserved paths on Windows.")
|
||||
warnings.warn(msg, DeprecationWarning, stacklevel=2)
|
||||
if self.parser is ntpath:
|
||||
return self.parser.isreserved(self)
|
||||
return False
|
||||
|
||||
def as_uri(self):
|
||||
"""Return the path as a URI."""
|
||||
if not self.is_absolute():
|
||||
raise ValueError("relative path can't be expressed as a file URI")
|
||||
|
||||
drive = self.drive
|
||||
if len(drive) == 2 and drive[1] == ':':
|
||||
# It's a path on a local drive => 'file:///c:/a/b'
|
||||
prefix = 'file:///' + drive
|
||||
path = self.as_posix()[2:]
|
||||
elif drive:
|
||||
# It's a path on a network drive => 'file://host/share/a/b'
|
||||
prefix = 'file:'
|
||||
path = self.as_posix()
|
||||
else:
|
||||
# It's a posix path => 'file:///etc/hosts'
|
||||
prefix = 'file://'
|
||||
path = str(self)
|
||||
from urllib.parse import quote_from_bytes
|
||||
return prefix + quote_from_bytes(os.fsencode(path))
|
||||
|
||||
@property
|
||||
def _pattern_str(self):
|
||||
"""The path expressed as a string, for use in pattern-matching."""
|
||||
# The string representation of an empty path is a single dot ('.'). Empty
|
||||
# paths shouldn't match wildcards, so we change it to the empty string.
|
||||
path_str = str(self)
|
||||
return '' if path_str == '.' else path_str
|
||||
|
||||
# Subclassing os.PathLike makes isinstance() checks slower,
|
||||
# which in turn makes Path construction slower. Register instead!
|
||||
os.PathLike.register(PurePath)
|
||||
|
||||
|
||||
class PurePosixPath(PurePath):
|
||||
"""PurePath subclass for non-Windows systems.
|
||||
|
||||
On a POSIX system, instantiating a PurePath should return this object.
|
||||
However, you can also instantiate it directly on any system.
|
||||
"""
|
||||
parser = posixpath
|
||||
__slots__ = ()
|
||||
|
||||
|
||||
class PureWindowsPath(PurePath):
|
||||
"""PurePath subclass for Windows systems.
|
||||
|
||||
On a Windows system, instantiating a PurePath should return this object.
|
||||
However, you can also instantiate it directly on any system.
|
||||
"""
|
||||
parser = ntpath
|
||||
__slots__ = ()
|
||||
|
||||
|
||||
class Path(PathBase, PurePath):
|
||||
"""PurePath subclass that can make system calls.
|
||||
|
||||
Path represents a filesystem path but unlike PurePath, also offers
|
||||
methods to do system calls on path objects. Depending on your system,
|
||||
instantiating a Path will return either a PosixPath or a WindowsPath
|
||||
object. You can also instantiate a PosixPath or WindowsPath directly,
|
||||
but cannot instantiate a WindowsPath on a POSIX system or vice versa.
|
||||
"""
|
||||
__slots__ = ()
|
||||
as_uri = PurePath.as_uri
|
||||
|
||||
@classmethod
|
||||
def _unsupported_msg(cls, attribute):
|
||||
return f"{cls.__name__}.{attribute} is unsupported on this system"
|
||||
|
||||
def __init__(self, *args, **kwargs):
|
||||
if kwargs:
|
||||
msg = ("support for supplying keyword arguments to pathlib.PurePath "
|
||||
"is deprecated and scheduled for removal in Python {remove}")
|
||||
warnings._deprecated("pathlib.PurePath(**kwargs)", msg, remove=(3, 14))
|
||||
super().__init__(*args)
|
||||
|
||||
def __new__(cls, *args, **kwargs):
|
||||
if cls is Path:
|
||||
cls = WindowsPath if os.name == 'nt' else PosixPath
|
||||
return object.__new__(cls)
|
||||
|
||||
def stat(self, *, follow_symlinks=True):
|
||||
"""
|
||||
Return the result of the stat() system call on this path, like
|
||||
os.stat() does.
|
||||
"""
|
||||
return os.stat(self, follow_symlinks=follow_symlinks)
|
||||
|
||||
def is_mount(self):
|
||||
"""
|
||||
Check if this path is a mount point
|
||||
"""
|
||||
return os.path.ismount(self)
|
||||
|
||||
def is_junction(self):
|
||||
"""
|
||||
Whether this path is a junction.
|
||||
"""
|
||||
return os.path.isjunction(self)
|
||||
|
||||
def open(self, mode='r', buffering=-1, encoding=None,
|
||||
errors=None, newline=None):
|
||||
"""
|
||||
Open the file pointed to by this path and return a file object, as
|
||||
the built-in open() function does.
|
||||
"""
|
||||
if "b" not in mode:
|
||||
encoding = io.text_encoding(encoding)
|
||||
return io.open(self, mode, buffering, encoding, errors, newline)
|
||||
|
||||
def read_text(self, encoding=None, errors=None, newline=None):
|
||||
"""
|
||||
Open the file in text mode, read it, and close the file.
|
||||
"""
|
||||
# Call io.text_encoding() here to ensure any warning is raised at an
|
||||
# appropriate stack level.
|
||||
encoding = io.text_encoding(encoding)
|
||||
return PathBase.read_text(self, encoding, errors, newline)
|
||||
|
||||
def write_text(self, data, encoding=None, errors=None, newline=None):
|
||||
"""
|
||||
Open the file in text mode, write to it, and close the file.
|
||||
"""
|
||||
# Call io.text_encoding() here to ensure any warning is raised at an
|
||||
# appropriate stack level.
|
||||
encoding = io.text_encoding(encoding)
|
||||
return PathBase.write_text(self, data, encoding, errors, newline)
|
||||
|
||||
_remove_leading_dot = operator.itemgetter(slice(2, None))
|
||||
_remove_trailing_slash = operator.itemgetter(slice(-1))
|
||||
|
||||
def _filter_trailing_slash(self, paths):
|
||||
sep = self.parser.sep
|
||||
anchor_len = len(self.anchor)
|
||||
for path_str in paths:
|
||||
if len(path_str) > anchor_len and path_str[-1] == sep:
|
||||
path_str = path_str[:-1]
|
||||
yield path_str
|
||||
|
||||
def iterdir(self):
|
||||
"""Yield path objects of the directory contents.
|
||||
|
||||
The children are yielded in arbitrary order, and the
|
||||
special entries '.' and '..' are not included.
|
||||
"""
|
||||
root_dir = str(self)
|
||||
with os.scandir(root_dir) as scandir_it:
|
||||
paths = [entry.path for entry in scandir_it]
|
||||
if root_dir == '.':
|
||||
paths = map(self._remove_leading_dot, paths)
|
||||
return map(self._from_parsed_string, paths)
|
||||
|
||||
def glob(self, pattern, *, case_sensitive=None, recurse_symlinks=False):
|
||||
"""Iterate over this subtree and yield all existing files (of any
|
||||
kind, including directories) matching the given relative pattern.
|
||||
"""
|
||||
sys.audit("pathlib.Path.glob", self, pattern)
|
||||
if not isinstance(pattern, PurePath):
|
||||
pattern = self.with_segments(pattern)
|
||||
if pattern.anchor:
|
||||
raise NotImplementedError("Non-relative patterns are unsupported")
|
||||
parts = pattern._tail.copy()
|
||||
if not parts:
|
||||
raise ValueError("Unacceptable pattern: {!r}".format(pattern))
|
||||
raw = pattern._raw_path
|
||||
if raw[-1] in (self.parser.sep, self.parser.altsep):
|
||||
# GH-65238: pathlib doesn't preserve trailing slash. Add it back.
|
||||
parts.append('')
|
||||
select = self._glob_selector(parts[::-1], case_sensitive, recurse_symlinks)
|
||||
root = str(self)
|
||||
paths = select(root)
|
||||
|
||||
# Normalize results
|
||||
if root == '.':
|
||||
paths = map(self._remove_leading_dot, paths)
|
||||
if parts[-1] == '':
|
||||
paths = map(self._remove_trailing_slash, paths)
|
||||
elif parts[-1] == '**':
|
||||
paths = self._filter_trailing_slash(paths)
|
||||
paths = map(self._from_parsed_string, paths)
|
||||
return paths
|
||||
|
||||
def rglob(self, pattern, *, case_sensitive=None, recurse_symlinks=False):
|
||||
"""Recursively yield all existing files (of any kind, including
|
||||
directories) matching the given relative pattern, anywhere in
|
||||
this subtree.
|
||||
"""
|
||||
sys.audit("pathlib.Path.rglob", self, pattern)
|
||||
if not isinstance(pattern, PurePath):
|
||||
pattern = self.with_segments(pattern)
|
||||
pattern = '**' / pattern
|
||||
return self.glob(pattern, case_sensitive=case_sensitive, recurse_symlinks=recurse_symlinks)
|
||||
|
||||
def walk(self, top_down=True, on_error=None, follow_symlinks=False):
|
||||
"""Walk the directory tree from this directory, similar to os.walk()."""
|
||||
sys.audit("pathlib.Path.walk", self, on_error, follow_symlinks)
|
||||
root_dir = str(self)
|
||||
if not follow_symlinks:
|
||||
follow_symlinks = os._walk_symlinks_as_files
|
||||
results = os.walk(root_dir, top_down, on_error, follow_symlinks)
|
||||
for path_str, dirnames, filenames in results:
|
||||
if root_dir == '.':
|
||||
path_str = path_str[2:]
|
||||
yield self._from_parsed_string(path_str), dirnames, filenames
|
||||
|
||||
def absolute(self):
|
||||
"""Return an absolute version of this path
|
||||
No normalization or symlink resolution is performed.
|
||||
|
||||
Use resolve() to resolve symlinks and remove '..' segments.
|
||||
"""
|
||||
if self.is_absolute():
|
||||
return self
|
||||
if self.root:
|
||||
drive = os.path.splitroot(os.getcwd())[0]
|
||||
return self._from_parsed_parts(drive, self.root, self._tail)
|
||||
if self.drive:
|
||||
# There is a CWD on each drive-letter drive.
|
||||
cwd = os.path.abspath(self.drive)
|
||||
else:
|
||||
cwd = os.getcwd()
|
||||
if not self._tail:
|
||||
# Fast path for "empty" paths, e.g. Path("."), Path("") or Path().
|
||||
# We pass only one argument to with_segments() to avoid the cost
|
||||
# of joining, and we exploit the fact that getcwd() returns a
|
||||
# fully-normalized string by storing it in _str. This is used to
|
||||
# implement Path.cwd().
|
||||
return self._from_parsed_string(cwd)
|
||||
drive, root, rel = os.path.splitroot(cwd)
|
||||
if not rel:
|
||||
return self._from_parsed_parts(drive, root, self._tail)
|
||||
tail = rel.split(self.parser.sep)
|
||||
tail.extend(self._tail)
|
||||
return self._from_parsed_parts(drive, root, tail)
|
||||
|
||||
def resolve(self, strict=False):
|
||||
"""
|
||||
Make the path absolute, resolving all symlinks on the way and also
|
||||
normalizing it.
|
||||
"""
|
||||
|
||||
return self.with_segments(os.path.realpath(self, strict=strict))
|
||||
|
||||
if pwd:
|
||||
def owner(self, *, follow_symlinks=True):
|
||||
"""
|
||||
Return the login name of the file owner.
|
||||
"""
|
||||
uid = self.stat(follow_symlinks=follow_symlinks).st_uid
|
||||
return pwd.getpwuid(uid).pw_name
|
||||
|
||||
if grp:
|
||||
def group(self, *, follow_symlinks=True):
|
||||
"""
|
||||
Return the group name of the file gid.
|
||||
"""
|
||||
gid = self.stat(follow_symlinks=follow_symlinks).st_gid
|
||||
return grp.getgrgid(gid).gr_name
|
||||
|
||||
if hasattr(os, "readlink"):
|
||||
def readlink(self):
|
||||
"""
|
||||
Return the path to which the symbolic link points.
|
||||
"""
|
||||
return self.with_segments(os.readlink(self))
|
||||
|
||||
def touch(self, mode=0o666, exist_ok=True):
|
||||
"""
|
||||
Create this file with the given access mode, if it doesn't exist.
|
||||
"""
|
||||
|
||||
if exist_ok:
|
||||
# First try to bump modification time
|
||||
# Implementation note: GNU touch uses the UTIME_NOW option of
|
||||
# the utimensat() / futimens() functions.
|
||||
try:
|
||||
os.utime(self, None)
|
||||
except OSError:
|
||||
# Avoid exception chaining
|
||||
pass
|
||||
else:
|
||||
return
|
||||
flags = os.O_CREAT | os.O_WRONLY
|
||||
if not exist_ok:
|
||||
flags |= os.O_EXCL
|
||||
fd = os.open(self, flags, mode)
|
||||
os.close(fd)
|
||||
|
||||
def mkdir(self, mode=0o777, parents=False, exist_ok=False):
|
||||
"""
|
||||
Create a new directory at this given path.
|
||||
"""
|
||||
try:
|
||||
os.mkdir(self, mode)
|
||||
except FileNotFoundError:
|
||||
if not parents or self.parent == self:
|
||||
raise
|
||||
self.parent.mkdir(parents=True, exist_ok=True)
|
||||
self.mkdir(mode, parents=False, exist_ok=exist_ok)
|
||||
except OSError:
|
||||
# Cannot rely on checking for EEXIST, since the operating system
|
||||
# could give priority to other errors like EACCES or EROFS
|
||||
if not exist_ok or not self.is_dir():
|
||||
raise
|
||||
|
||||
def chmod(self, mode, *, follow_symlinks=True):
|
||||
"""
|
||||
Change the permissions of the path, like os.chmod().
|
||||
"""
|
||||
os.chmod(self, mode, follow_symlinks=follow_symlinks)
|
||||
|
||||
def unlink(self, missing_ok=False):
|
||||
"""
|
||||
Remove this file or link.
|
||||
If the path is a directory, use rmdir() instead.
|
||||
"""
|
||||
try:
|
||||
os.unlink(self)
|
||||
except FileNotFoundError:
|
||||
if not missing_ok:
|
||||
raise
|
||||
|
||||
def rmdir(self):
|
||||
"""
|
||||
Remove this directory. The directory must be empty.
|
||||
"""
|
||||
os.rmdir(self)
|
||||
|
||||
def rename(self, target):
|
||||
"""
|
||||
Rename this path to the target path.
|
||||
|
||||
The target path may be absolute or relative. Relative paths are
|
||||
interpreted relative to the current working directory, *not* the
|
||||
directory of the Path object.
|
||||
|
||||
Returns the new Path instance pointing to the target path.
|
||||
"""
|
||||
os.rename(self, target)
|
||||
return self.with_segments(target)
|
||||
|
||||
def replace(self, target):
|
||||
"""
|
||||
Rename this path to the target path, overwriting if that path exists.
|
||||
|
||||
The target path may be absolute or relative. Relative paths are
|
||||
interpreted relative to the current working directory, *not* the
|
||||
directory of the Path object.
|
||||
|
||||
Returns the new Path instance pointing to the target path.
|
||||
"""
|
||||
os.replace(self, target)
|
||||
return self.with_segments(target)
|
||||
|
||||
if hasattr(os, "symlink"):
|
||||
def symlink_to(self, target, target_is_directory=False):
|
||||
"""
|
||||
Make this path a symlink pointing to the target path.
|
||||
Note the order of arguments (link, target) is the reverse of os.symlink.
|
||||
"""
|
||||
os.symlink(target, self, target_is_directory)
|
||||
|
||||
if hasattr(os, "link"):
|
||||
def hardlink_to(self, target):
|
||||
"""
|
||||
Make this path a hard link pointing to the same file as *target*.
|
||||
|
||||
Note the order of arguments (self, target) is the reverse of os.link's.
|
||||
"""
|
||||
os.link(target, self)
|
||||
|
||||
def expanduser(self):
|
||||
""" Return a new path with expanded ~ and ~user constructs
|
||||
(as returned by os.path.expanduser)
|
||||
"""
|
||||
if (not (self.drive or self.root) and
|
||||
self._tail and self._tail[0][:1] == '~'):
|
||||
homedir = os.path.expanduser(self._tail[0])
|
||||
if homedir[:1] == "~":
|
||||
raise RuntimeError("Could not determine home directory.")
|
||||
drv, root, tail = self._parse_path(homedir)
|
||||
return self._from_parsed_parts(drv, root, tail + self._tail[1:])
|
||||
|
||||
return self
|
||||
|
||||
@classmethod
|
||||
def from_uri(cls, uri):
|
||||
"""Return a new path from the given 'file' URI."""
|
||||
if not uri.startswith('file:'):
|
||||
raise ValueError(f"URI does not start with 'file:': {uri!r}")
|
||||
path = uri[5:]
|
||||
if path[:3] == '///':
|
||||
# Remove empty authority
|
||||
path = path[2:]
|
||||
elif path[:12] == '//localhost/':
|
||||
# Remove 'localhost' authority
|
||||
path = path[11:]
|
||||
if path[:3] == '///' or (path[:1] == '/' and path[2:3] in ':|'):
|
||||
# Remove slash before DOS device/UNC path
|
||||
path = path[1:]
|
||||
if path[1:2] == '|':
|
||||
# Replace bar with colon in DOS drive
|
||||
path = path[:1] + ':' + path[2:]
|
||||
from urllib.parse import unquote_to_bytes
|
||||
path = cls(os.fsdecode(unquote_to_bytes(path)))
|
||||
if not path.is_absolute():
|
||||
raise ValueError(f"URI is not absolute: {uri!r}")
|
||||
return path
|
||||
|
||||
|
||||
class PosixPath(Path, PurePosixPath):
|
||||
"""Path subclass for non-Windows systems.
|
||||
|
||||
On a POSIX system, instantiating a Path should return this object.
|
||||
"""
|
||||
__slots__ = ()
|
||||
|
||||
if os.name == 'nt':
|
||||
def __new__(cls, *args, **kwargs):
|
||||
raise UnsupportedOperation(
|
||||
f"cannot instantiate {cls.__name__!r} on your system")
|
||||
|
||||
class WindowsPath(Path, PureWindowsPath):
|
||||
"""Path subclass for Windows systems.
|
||||
|
||||
On a Windows system, instantiating a Path should return this object.
|
||||
"""
|
||||
__slots__ = ()
|
||||
|
||||
if os.name != 'nt':
|
||||
def __new__(cls, *args, **kwargs):
|
||||
raise UnsupportedOperation(
|
||||
f"cannot instantiate {cls.__name__!r} on your system")
|
||||
Vendored
-3328
File diff suppressed because it is too large.
Load diff
Vendored
+5
@@ -0,0 +1,5 @@
|
||||
import os
|
||||
from test.support import load_package_tests
|
||||
|
||||
def load_tests(*args):
|
||||
return load_package_tests(os.path.dirname(__file__), *args)
|
||||
+1660
File diff suppressed because it is too large.
Load diff
+2499
File diff suppressed because it is too large.
Load diff
Vendored
+142
-123
@@ -10,7 +10,9 @@ import unittest
|
||||
from unittest.mock import patch
|
||||
from test import support
|
||||
from test.support import os_helper
|
||||
from test.support import socket_helper
|
||||
from test.support import warnings_helper
|
||||
from test.support.testcase import ExtraAssertions
|
||||
import os
|
||||
try:
|
||||
import ssl
|
||||
@@ -18,12 +20,15 @@ except ImportError:
|
||||
ssl = None
|
||||
import sys
|
||||
import tempfile
|
||||
from nturl2path import url2pathname, pathname2url
|
||||
|
||||
from base64 import b64encode
|
||||
import collections
|
||||
|
||||
|
||||
if not socket_helper.has_gethostname:
|
||||
raise unittest.SkipTest("test requires gethostname()")
|
||||
|
||||
|
||||
def hexescape(char):
|
||||
"""Escape char as RFC 2396 specifies"""
|
||||
hex_repr = hex(ord(char))[2:].upper()
|
||||
@@ -135,7 +140,7 @@ class FakeFTPMixin(object):
|
||||
urllib.request.ftpwrapper = self._ftpwrapper_class
|
||||
|
||||
|
||||
class urlopen_FileTests(unittest.TestCase):
|
||||
class urlopen_FileTests(unittest.TestCase, ExtraAssertions):
|
||||
"""Test urlopen() opening a temporary file.
|
||||
|
||||
Try to test as much functionality as possible so as to cut down on reliance
|
||||
@@ -153,7 +158,7 @@ class urlopen_FileTests(unittest.TestCase):
|
||||
finally:
|
||||
f.close()
|
||||
self.pathname = os_helper.TESTFN
|
||||
self.quoted_pathname = urllib.parse.quote(self.pathname)
|
||||
self.quoted_pathname = urllib.parse.quote(os.fsencode(self.pathname))
|
||||
self.returned_obj = urlopen("file:%s" % self.quoted_pathname)
|
||||
|
||||
def tearDown(self):
|
||||
@@ -165,9 +170,7 @@ class urlopen_FileTests(unittest.TestCase):
|
||||
# Make sure object returned by urlopen() has the specified methods
|
||||
for attr in ("read", "readline", "readlines", "fileno",
|
||||
"close", "info", "geturl", "getcode", "__iter__"):
|
||||
self.assertTrue(hasattr(self.returned_obj, attr),
|
||||
"object returned by urlopen() lacks %s attribute" %
|
||||
attr)
|
||||
self.assertHasAttr(self.returned_obj, attr)
|
||||
|
||||
def test_read(self):
|
||||
self.assertEqual(self.text, self.returned_obj.read())
|
||||
@@ -232,17 +235,12 @@ class ProxyTests(unittest.TestCase):
|
||||
|
||||
def setUp(self):
|
||||
# Records changes to env vars
|
||||
self.env = os_helper.EnvironmentVarGuard()
|
||||
self.env = self.enterContext(os_helper.EnvironmentVarGuard())
|
||||
# Delete all proxy related env vars
|
||||
for k in list(os.environ):
|
||||
if 'proxy' in k.lower():
|
||||
self.env.unset(k)
|
||||
|
||||
def tearDown(self):
|
||||
# Restore all proxy related env vars
|
||||
self.env.__exit__()
|
||||
del self.env
|
||||
|
||||
def test_getproxies_environment_keep_no_proxies(self):
|
||||
self.env.set('NO_PROXY', 'localhost')
|
||||
proxies = urllib.request.getproxies_environment()
|
||||
@@ -477,7 +475,9 @@ Connection: close
|
||||
Content-Type: text/html; charset=iso-8859-1
|
||||
''', mock_close=True)
|
||||
try:
|
||||
self.assertRaises(OSError, urlopen, "http://python.org/")
|
||||
with self.assertRaises(urllib.error.HTTPError) as cm:
|
||||
urllib.request.urlopen("http://python.org/")
|
||||
cm.exception.close()
|
||||
finally:
|
||||
self.unfakehttp()
|
||||
|
||||
@@ -492,8 +492,9 @@ Content-Type: text/html; charset=iso-8859-1
|
||||
''', mock_close=True)
|
||||
try:
|
||||
msg = "Redirection to url 'file:"
|
||||
with self.assertRaisesRegex(urllib.error.HTTPError, msg):
|
||||
urlopen("http://python.org/")
|
||||
with self.assertRaisesRegex(urllib.error.HTTPError, msg) as cm:
|
||||
urllib.request.urlopen("http://python.org/")
|
||||
cm.exception.close()
|
||||
finally:
|
||||
self.unfakehttp()
|
||||
|
||||
@@ -506,8 +507,9 @@ Location: file://guidocomputer.athome.com:/python/license
|
||||
Connection: close
|
||||
''', mock_close=True)
|
||||
try:
|
||||
self.assertRaises(urllib.error.HTTPError, urlopen,
|
||||
"http://something")
|
||||
with self.assertRaises(urllib.error.HTTPError) as cm:
|
||||
urllib.request.urlopen("http://something")
|
||||
cm.exception.close()
|
||||
finally:
|
||||
self.unfakehttp()
|
||||
|
||||
@@ -597,17 +599,8 @@ Connection: close
|
||||
with warnings_helper.check_warnings(('',DeprecationWarning)):
|
||||
urllib.request.URLopener()
|
||||
|
||||
@unittest.skipUnless(ssl, "ssl module required")
|
||||
def test_cafile_and_context(self):
|
||||
context = ssl.create_default_context()
|
||||
with warnings_helper.check_warnings(('', DeprecationWarning)):
|
||||
with self.assertRaises(ValueError):
|
||||
urllib.request.urlopen(
|
||||
"https://localhost", cafile="/nonexistent/path", context=context
|
||||
)
|
||||
|
||||
|
||||
class urlopen_DataTests(unittest.TestCase):
|
||||
class urlopen_DataTests(unittest.TestCase, ExtraAssertions):
|
||||
"""Test urlopen() opening a data URL."""
|
||||
|
||||
def setUp(self):
|
||||
@@ -636,18 +629,17 @@ class urlopen_DataTests(unittest.TestCase):
|
||||
"QOjdAAAAAXNSR0IArs4c6QAAAA9JREFUCNdj%0AYGBg%2BP//PwAGAQL%2BCm8 "
|
||||
"vHgAAAABJRU5ErkJggg%3D%3D%0A%20")
|
||||
|
||||
self.text_url_resp = urllib.request.urlopen(self.text_url)
|
||||
self.text_url_base64_resp = urllib.request.urlopen(
|
||||
self.text_url_base64)
|
||||
self.image_url_resp = urllib.request.urlopen(self.image_url)
|
||||
self.text_url_resp = self.enterContext(
|
||||
urllib.request.urlopen(self.text_url))
|
||||
self.text_url_base64_resp = self.enterContext(
|
||||
urllib.request.urlopen(self.text_url_base64))
|
||||
self.image_url_resp = self.enterContext(urllib.request.urlopen(self.image_url))
|
||||
|
||||
def test_interface(self):
|
||||
# Make sure object returned by urlopen() has the specified methods
|
||||
for attr in ("read", "readline", "readlines",
|
||||
"close", "info", "geturl", "getcode", "__iter__"):
|
||||
self.assertTrue(hasattr(self.text_url_resp, attr),
|
||||
"object returned by urlopen() lacks %s attribute" %
|
||||
attr)
|
||||
self.assertHasAttr(self.text_url_resp, attr)
|
||||
|
||||
def test_info(self):
|
||||
self.assertIsInstance(self.text_url_resp.info(), email.message.Message)
|
||||
@@ -655,8 +647,10 @@ class urlopen_DataTests(unittest.TestCase):
|
||||
[('text/plain', ''), ('charset', 'ISO-8859-1')])
|
||||
self.assertEqual(self.image_url_resp.info()['content-length'],
|
||||
str(len(self.image)))
|
||||
self.assertEqual(urllib.request.urlopen("data:,").info().get_params(),
|
||||
r = urllib.request.urlopen("data:,")
|
||||
self.assertEqual(r.info().get_params(),
|
||||
[('text/plain', ''), ('charset', 'US-ASCII')])
|
||||
r.close()
|
||||
|
||||
def test_geturl(self):
|
||||
self.assertEqual(self.text_url_resp.geturl(), self.text_url)
|
||||
@@ -719,10 +713,6 @@ class urlretrieve_FileTests(unittest.TestCase):
|
||||
|
||||
def constructLocalFileUrl(self, filePath):
|
||||
filePath = os.path.abspath(filePath)
|
||||
try:
|
||||
filePath.encode("utf-8")
|
||||
except UnicodeEncodeError:
|
||||
raise unittest.SkipTest("filePath is not encodable to utf8")
|
||||
return "file://%s" % urllib.request.pathname2url(filePath)
|
||||
|
||||
def createNewTempFile(self, data=b""):
|
||||
@@ -1104,6 +1094,8 @@ class UnquotingTests(unittest.TestCase):
|
||||
self.assertEqual(result.count('%'), 1,
|
||||
"using unquote(): not all characters escaped: "
|
||||
"%s" % result)
|
||||
|
||||
def test_unquote_rejects_none_and_tuple(self):
|
||||
self.assertRaises((TypeError, AttributeError), urllib.parse.unquote, None)
|
||||
self.assertRaises((TypeError, AttributeError), urllib.parse.unquote, ())
|
||||
|
||||
@@ -1527,39 +1519,121 @@ class Pathname_Tests(unittest.TestCase):
|
||||
(expect, result))
|
||||
|
||||
@unittest.skipUnless(sys.platform == 'win32',
|
||||
'test specific to the nturl2path functions.')
|
||||
def test_prefixes(self):
|
||||
'test specific to Windows pathnames.')
|
||||
def test_pathname2url_win(self):
|
||||
# Test special prefixes are correctly handled in pathname2url()
|
||||
given = '\\\\?\\C:\\dir'
|
||||
expect = '///C:/dir'
|
||||
result = urllib.request.pathname2url(given)
|
||||
self.assertEqual(expect, result,
|
||||
"pathname2url() failed; %s != %s" %
|
||||
(expect, result))
|
||||
given = '\\\\?\\unc\\server\\share\\dir'
|
||||
expect = '/server/share/dir'
|
||||
result = urllib.request.pathname2url(given)
|
||||
self.assertEqual(expect, result,
|
||||
"pathname2url() failed; %s != %s" %
|
||||
(expect, result))
|
||||
fn = urllib.request.pathname2url
|
||||
self.assertEqual(fn('\\\\?\\C:\\dir'), '///C:/dir')
|
||||
self.assertEqual(fn('\\\\?\\unc\\server\\share\\dir'), '//server/share/dir')
|
||||
self.assertEqual(fn("C:"), '///C:')
|
||||
self.assertEqual(fn("C:\\"), '///C:/')
|
||||
self.assertEqual(fn('C:\\a\\b.c'), '///C:/a/b.c')
|
||||
self.assertEqual(fn('C:\\a\\b.c\\'), '///C:/a/b.c/')
|
||||
self.assertEqual(fn('C:\\a\\\\b.c'), '///C:/a//b.c')
|
||||
self.assertEqual(fn('C:\\a\\b%#c'), '///C:/a/b%25%23c')
|
||||
self.assertEqual(fn('C:\\a\\b\xe9'), '///C:/a/b%C3%A9')
|
||||
self.assertEqual(fn('C:\\foo\\bar\\spam.foo'), "///C:/foo/bar/spam.foo")
|
||||
# Long drive letter
|
||||
self.assertRaises(IOError, fn, "XX:\\")
|
||||
# No drive letter
|
||||
self.assertEqual(fn("\\folder\\test\\"), '/folder/test/')
|
||||
self.assertEqual(fn("\\\\folder\\test\\"), '//folder/test/')
|
||||
self.assertEqual(fn("\\\\\\folder\\test\\"), '///folder/test/')
|
||||
self.assertEqual(fn('\\\\some\\share\\'), '//some/share/')
|
||||
self.assertEqual(fn('\\\\some\\share\\a\\b.c'), '//some/share/a/b.c')
|
||||
self.assertEqual(fn('\\\\some\\share\\a\\b%#c\xe9'), '//some/share/a/b%25%23c%C3%A9')
|
||||
# Alternate path separator
|
||||
self.assertEqual(fn('C:/a/b.c'), '///C:/a/b.c')
|
||||
self.assertEqual(fn('//some/share/a/b.c'), '//some/share/a/b.c')
|
||||
self.assertEqual(fn('//?/C:/dir'), '///C:/dir')
|
||||
self.assertEqual(fn('//?/unc/server/share/dir'), '//server/share/dir')
|
||||
# Round-tripping
|
||||
urls = ['///C:',
|
||||
'/folder/test/',
|
||||
'///C:/foo/bar/spam.foo']
|
||||
for url in urls:
|
||||
self.assertEqual(fn(urllib.request.url2pathname(url)), url)
|
||||
|
||||
@unittest.skipIf(sys.platform == 'win32',
|
||||
'test specific to POSIX pathnames')
|
||||
@unittest.expectedFailure # AssertionError: '//a/b.c' != '////a/b.c'
|
||||
def test_pathname2url_posix(self):
|
||||
fn = urllib.request.pathname2url
|
||||
self.assertEqual(fn('/'), '/')
|
||||
self.assertEqual(fn('/a/b.c'), '/a/b.c')
|
||||
self.assertEqual(fn('//a/b.c'), '////a/b.c')
|
||||
self.assertEqual(fn('///a/b.c'), '/////a/b.c')
|
||||
self.assertEqual(fn('////a/b.c'), '//////a/b.c')
|
||||
self.assertEqual(fn('/a/b%#c'), '/a/b%25%23c')
|
||||
|
||||
@unittest.skipUnless(os_helper.FS_NONASCII, 'need os_helper.FS_NONASCII')
|
||||
def test_pathname2url_nonascii(self):
|
||||
encoding = sys.getfilesystemencoding()
|
||||
errors = sys.getfilesystemencodeerrors()
|
||||
url = urllib.parse.quote(os_helper.FS_NONASCII, encoding=encoding, errors=errors)
|
||||
self.assertEqual(urllib.request.pathname2url(os_helper.FS_NONASCII), url)
|
||||
|
||||
@unittest.skipUnless(sys.platform == 'win32',
|
||||
'test specific to the urllib.url2path function.')
|
||||
def test_ntpath(self):
|
||||
given = ('/C:/', '///C:/', '/C|//')
|
||||
expect = 'C:\\'
|
||||
for url in given:
|
||||
result = urllib.request.url2pathname(url)
|
||||
self.assertEqual(expect, result,
|
||||
'urllib.request..url2pathname() failed; %s != %s' %
|
||||
(expect, result))
|
||||
given = '///C|/path'
|
||||
expect = 'C:\\path'
|
||||
result = urllib.request.url2pathname(given)
|
||||
self.assertEqual(expect, result,
|
||||
'urllib.request.url2pathname() failed; %s != %s' %
|
||||
(expect, result))
|
||||
'test specific to Windows pathnames.')
|
||||
def test_url2pathname_win(self):
|
||||
fn = urllib.request.url2pathname
|
||||
self.assertEqual(fn('/C:/'), 'C:\\')
|
||||
self.assertEqual(fn("///C|"), 'C:')
|
||||
self.assertEqual(fn("///C:"), 'C:')
|
||||
self.assertEqual(fn('///C:/'), 'C:\\')
|
||||
self.assertEqual(fn('/C|//'), 'C:\\\\')
|
||||
self.assertEqual(fn('///C|/path'), 'C:\\path')
|
||||
# No DOS drive
|
||||
self.assertEqual(fn("///C/test/"), '\\C\\test\\')
|
||||
self.assertEqual(fn("////C/test/"), '\\\\C\\test\\')
|
||||
# DOS drive paths
|
||||
self.assertEqual(fn('C:/path/to/file'), 'C:\\path\\to\\file')
|
||||
self.assertEqual(fn('C:/path/to/file/'), 'C:\\path\\to\\file\\')
|
||||
self.assertEqual(fn('C:/path/to//file'), 'C:\\path\\to\\\\file')
|
||||
self.assertEqual(fn('C|/path/to/file'), 'C:\\path\\to\\file')
|
||||
self.assertEqual(fn('/C|/path/to/file'), 'C:\\path\\to\\file')
|
||||
self.assertEqual(fn('///C|/path/to/file'), 'C:\\path\\to\\file')
|
||||
self.assertEqual(fn("///C|/foo/bar/spam.foo"), 'C:\\foo\\bar\\spam.foo')
|
||||
# Non-ASCII drive letter
|
||||
self.assertRaises(IOError, fn, "///\u00e8|/")
|
||||
# UNC paths
|
||||
self.assertEqual(fn('//server/path/to/file'), '\\\\server\\path\\to\\file')
|
||||
self.assertEqual(fn('////server/path/to/file'), '\\\\server\\path\\to\\file')
|
||||
self.assertEqual(fn('/////server/path/to/file'), '\\\\server\\path\\to\\file')
|
||||
# Localhost paths
|
||||
self.assertEqual(fn('//localhost/C:/path/to/file'), 'C:\\path\\to\\file')
|
||||
self.assertEqual(fn('//localhost/C|/path/to/file'), 'C:\\path\\to\\file')
|
||||
self.assertEqual(fn('//localhost/path/to/file'), '\\path\\to\\file')
|
||||
self.assertEqual(fn('//localhost//server/path/to/file'), '\\\\server\\path\\to\\file')
|
||||
# Percent-encoded forward slashes are preserved for backwards compatibility
|
||||
self.assertEqual(fn('C:/foo%2fbar'), 'C:\\foo/bar')
|
||||
self.assertEqual(fn('//server/share/foo%2fbar'), '\\\\server\\share\\foo/bar')
|
||||
# Round-tripping
|
||||
paths = ['C:',
|
||||
r'\C\test\\',
|
||||
r'C:\foo\bar\spam.foo']
|
||||
for path in paths:
|
||||
self.assertEqual(fn(urllib.request.pathname2url(path)), path)
|
||||
|
||||
@unittest.skipIf(sys.platform == 'win32',
|
||||
'test specific to POSIX pathnames')
|
||||
@unittest.expectedFailure # AssertionError: '///foo/bar' != '/foo/bar'
|
||||
def test_url2pathname_posix(self):
|
||||
fn = urllib.request.url2pathname
|
||||
self.assertEqual(fn('/foo/bar'), '/foo/bar')
|
||||
self.assertEqual(fn('//foo/bar'), '//foo/bar')
|
||||
self.assertEqual(fn('///foo/bar'), '/foo/bar')
|
||||
self.assertEqual(fn('////foo/bar'), '//foo/bar')
|
||||
self.assertEqual(fn('//localhost/foo/bar'), '/foo/bar')
|
||||
|
||||
@unittest.skipUnless(os_helper.FS_NONASCII, 'need os_helper.FS_NONASCII')
|
||||
def test_url2pathname_nonascii(self):
|
||||
encoding = sys.getfilesystemencoding()
|
||||
errors = sys.getfilesystemencodeerrors()
|
||||
url = os_helper.FS_NONASCII
|
||||
self.assertEqual(urllib.request.url2pathname(url), os_helper.FS_NONASCII)
|
||||
url = urllib.parse.quote(url, encoding=encoding, errors=errors)
|
||||
self.assertEqual(urllib.request.url2pathname(url), os_helper.FS_NONASCII)
|
||||
|
||||
class Utility_Tests(unittest.TestCase):
|
||||
"""Testcase to test the various utility functions in the urllib."""
|
||||
@@ -1643,60 +1717,5 @@ class RequestTests(unittest.TestCase):
|
||||
self.assertEqual(request.get_method(), 'HEAD')
|
||||
|
||||
|
||||
class URL2PathNameTests(unittest.TestCase):
|
||||
|
||||
def test_converting_drive_letter(self):
|
||||
self.assertEqual(url2pathname("///C|"), 'C:')
|
||||
self.assertEqual(url2pathname("///C:"), 'C:')
|
||||
self.assertEqual(url2pathname("///C|/"), 'C:\\')
|
||||
|
||||
def test_converting_when_no_drive_letter(self):
|
||||
# cannot end a raw string in \
|
||||
self.assertEqual(url2pathname("///C/test/"), r'\\\C\test' '\\')
|
||||
self.assertEqual(url2pathname("////C/test/"), r'\\C\test' '\\')
|
||||
|
||||
def test_simple_compare(self):
|
||||
self.assertEqual(url2pathname("///C|/foo/bar/spam.foo"),
|
||||
r'C:\foo\bar\spam.foo')
|
||||
|
||||
def test_non_ascii_drive_letter(self):
|
||||
self.assertRaises(IOError, url2pathname, "///\u00e8|/")
|
||||
|
||||
def test_roundtrip_url2pathname(self):
|
||||
list_of_paths = ['C:',
|
||||
r'\\\C\test\\',
|
||||
r'C:\foo\bar\spam.foo'
|
||||
]
|
||||
for path in list_of_paths:
|
||||
self.assertEqual(url2pathname(pathname2url(path)), path)
|
||||
|
||||
class PathName2URLTests(unittest.TestCase):
|
||||
|
||||
def test_converting_drive_letter(self):
|
||||
self.assertEqual(pathname2url("C:"), '///C:')
|
||||
self.assertEqual(pathname2url("C:\\"), '///C:')
|
||||
|
||||
def test_converting_when_no_drive_letter(self):
|
||||
self.assertEqual(pathname2url(r"\\\folder\test" "\\"),
|
||||
'/////folder/test/')
|
||||
self.assertEqual(pathname2url(r"\\folder\test" "\\"),
|
||||
'////folder/test/')
|
||||
self.assertEqual(pathname2url(r"\folder\test" "\\"),
|
||||
'/folder/test/')
|
||||
|
||||
def test_simple_compare(self):
|
||||
self.assertEqual(pathname2url(r'C:\foo\bar\spam.foo'),
|
||||
"///C:/foo/bar/spam.foo" )
|
||||
|
||||
def test_long_drive_letter(self):
|
||||
self.assertRaises(IOError, pathname2url, "XX:\\")
|
||||
|
||||
def test_roundtrip_pathname2url(self):
|
||||
list_of_paths = ['///C:',
|
||||
'/////folder/test/',
|
||||
'///C:/foo/bar/spam.foo']
|
||||
for path in list_of_paths:
|
||||
self.assertEqual(pathname2url(url2pathname(path)), path)
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
Reference in new issue
Block a user