mirror of
https://github.com/davidhalter/typeshed.git
synced 2025-12-08 04:54:47 +08:00
Improve importlib.metadata (#7326)
This commit is contained in:
Alex Waygood
@@ -9,108 +9,136 @@ from os import PathLike
|
||||
from pathlib import Path
|
||||
from typing import Any, ClassVar, Iterable, NamedTuple, Pattern, overload
|
||||
|
||||
if sys.version_info >= (3, 10):
|
||||
__all__ = [
|
||||
"Distribution",
|
||||
"DistributionFinder",
|
||||
"PackageMetadata",
|
||||
"PackageNotFoundError",
|
||||
"distribution",
|
||||
"distributions",
|
||||
"entry_points",
|
||||
"files",
|
||||
"metadata",
|
||||
"packages_distributions",
|
||||
"requires",
|
||||
"version",
|
||||
]
|
||||
else:
|
||||
__all__ = [
|
||||
"Distribution",
|
||||
"DistributionFinder",
|
||||
"PackageNotFoundError",
|
||||
"distribution",
|
||||
"distributions",
|
||||
"entry_points",
|
||||
"files",
|
||||
"metadata",
|
||||
"requires",
|
||||
"version",
|
||||
]
|
||||
|
||||
if sys.version_info >= (3, 10):
|
||||
from importlib.metadata._meta import PackageMetadata as PackageMetadata
|
||||
def packages_distributions() -> Mapping[str, list[str]]: ...
|
||||
|
||||
if sys.version_info >= (3, 8):
|
||||
class PackageNotFoundError(ModuleNotFoundError): ...
|
||||
class PackageNotFoundError(ModuleNotFoundError): ...
|
||||
|
||||
class _EntryPointBase(NamedTuple):
|
||||
name: str
|
||||
value: str
|
||||
group: str
|
||||
class _EntryPointBase(NamedTuple):
|
||||
name: str
|
||||
value: str
|
||||
group: str
|
||||
|
||||
class EntryPoint(_EntryPointBase):
|
||||
pattern: ClassVar[Pattern[str]]
|
||||
def load(self) -> Any: ... # Callable[[], Any] or an importable module
|
||||
class EntryPoint(_EntryPointBase):
|
||||
pattern: ClassVar[Pattern[str]]
|
||||
def load(self) -> Any: ... # Callable[[], Any] or an importable module
|
||||
@property
|
||||
def extras(self) -> list[str]: ...
|
||||
if sys.version_info >= (3, 9):
|
||||
@property
|
||||
def extras(self) -> list[str]: ...
|
||||
if sys.version_info >= (3, 9):
|
||||
@property
|
||||
def module(self) -> str: ...
|
||||
@property
|
||||
def attr(self) -> str: ...
|
||||
if sys.version_info >= (3, 10):
|
||||
dist: ClassVar[Distribution | None]
|
||||
def matches(self, **params: Any) -> bool: ... # undocumented
|
||||
|
||||
class PackagePath(pathlib.PurePosixPath):
|
||||
def read_text(self, encoding: str = ...) -> str: ...
|
||||
def read_binary(self) -> bytes: ...
|
||||
def locate(self) -> PathLike[str]: ...
|
||||
# The following attributes are not defined on PackagePath, but are dynamically added by Distribution.files:
|
||||
hash: FileHash | None
|
||||
size: int | None
|
||||
dist: Distribution
|
||||
|
||||
class FileHash:
|
||||
mode: str
|
||||
value: str
|
||||
def __init__(self, spec: str) -> None: ...
|
||||
|
||||
class Distribution:
|
||||
@abc.abstractmethod
|
||||
def read_text(self, filename: str) -> str | None: ...
|
||||
@abc.abstractmethod
|
||||
def locate_file(self, path: StrPath) -> PathLike[str]: ...
|
||||
@classmethod
|
||||
def from_name(cls, name: str) -> Distribution: ...
|
||||
@overload
|
||||
@classmethod
|
||||
def discover(cls, *, context: DistributionFinder.Context) -> Iterable[Distribution]: ...
|
||||
@overload
|
||||
@classmethod
|
||||
def discover(
|
||||
cls, *, context: None = ..., name: str | None = ..., path: list[str] = ..., **kwargs: Any
|
||||
) -> Iterable[Distribution]: ...
|
||||
@staticmethod
|
||||
def at(path: StrPath) -> PathDistribution: ...
|
||||
def module(self) -> str: ...
|
||||
@property
|
||||
def metadata(self) -> Message: ...
|
||||
@property
|
||||
def version(self) -> str: ...
|
||||
@property
|
||||
def entry_points(self) -> list[EntryPoint]: ...
|
||||
@property
|
||||
def files(self) -> list[PackagePath] | None: ...
|
||||
@property
|
||||
def requires(self) -> list[str] | None: ...
|
||||
if sys.version_info >= (3, 10):
|
||||
@property
|
||||
def name(self) -> str: ...
|
||||
def attr(self) -> str: ...
|
||||
if sys.version_info >= (3, 10):
|
||||
dist: ClassVar[Distribution | None]
|
||||
def matches(self, **params: Any) -> bool: ... # undocumented
|
||||
|
||||
class DistributionFinder(MetaPathFinder):
|
||||
class Context:
|
||||
name: str | None
|
||||
def __init__(self, *, name: str | None = ..., path: list[str] = ..., **kwargs: Any) -> None: ...
|
||||
@property
|
||||
def path(self) -> list[str]: ...
|
||||
class PackagePath(pathlib.PurePosixPath):
|
||||
def read_text(self, encoding: str = ...) -> str: ...
|
||||
def read_binary(self) -> bytes: ...
|
||||
def locate(self) -> PathLike[str]: ...
|
||||
# The following attributes are not defined on PackagePath, but are dynamically added by Distribution.files:
|
||||
hash: FileHash | None
|
||||
size: int | None
|
||||
dist: Distribution
|
||||
|
||||
@abc.abstractmethod
|
||||
def find_distributions(self, context: DistributionFinder.Context = ...) -> Iterable[Distribution]: ...
|
||||
class FileHash:
|
||||
mode: str
|
||||
value: str
|
||||
def __init__(self, spec: str) -> None: ...
|
||||
|
||||
class MetadataPathFinder(DistributionFinder):
|
||||
@classmethod
|
||||
def find_distributions(cls, context: DistributionFinder.Context = ...) -> Iterable[PathDistribution]: ...
|
||||
if sys.version_info >= (3, 10):
|
||||
# Yes, this is an instance method that has argumend named "cls"
|
||||
def invalidate_caches(cls) -> None: ... # type: ignore
|
||||
|
||||
class PathDistribution(Distribution):
|
||||
def __init__(self, path: Path) -> None: ...
|
||||
def read_text(self, filename: StrPath) -> str: ...
|
||||
def locate_file(self, path: StrPath) -> PathLike[str]: ...
|
||||
|
||||
def distribution(distribution_name: str) -> Distribution: ...
|
||||
class Distribution:
|
||||
@abc.abstractmethod
|
||||
def read_text(self, filename: str) -> str | None: ...
|
||||
@abc.abstractmethod
|
||||
def locate_file(self, path: StrPath) -> PathLike[str]: ...
|
||||
@classmethod
|
||||
def from_name(cls, name: str) -> Distribution: ...
|
||||
@overload
|
||||
def distributions(*, context: DistributionFinder.Context) -> Iterable[Distribution]: ...
|
||||
@classmethod
|
||||
def discover(cls, *, context: DistributionFinder.Context) -> Iterable[Distribution]: ...
|
||||
@overload
|
||||
def distributions(
|
||||
*, context: None = ..., name: str | None = ..., path: list[str] = ..., **kwargs: Any
|
||||
@classmethod
|
||||
def discover(
|
||||
cls, *, context: None = ..., name: str | None = ..., path: list[str] = ..., **kwargs: Any
|
||||
) -> Iterable[Distribution]: ...
|
||||
def metadata(distribution_name: str) -> Message: ...
|
||||
def version(distribution_name: str) -> str: ...
|
||||
def entry_points() -> dict[str, tuple[EntryPoint, ...]]: ...
|
||||
def files(distribution_name: str) -> list[PackagePath] | None: ...
|
||||
def requires(distribution_name: str) -> list[str] | None: ...
|
||||
@staticmethod
|
||||
def at(path: StrPath) -> PathDistribution: ...
|
||||
@property
|
||||
def metadata(self) -> Message: ...
|
||||
@property
|
||||
def version(self) -> str: ...
|
||||
@property
|
||||
def entry_points(self) -> list[EntryPoint]: ...
|
||||
@property
|
||||
def files(self) -> list[PackagePath] | None: ...
|
||||
@property
|
||||
def requires(self) -> list[str] | None: ...
|
||||
if sys.version_info >= (3, 10):
|
||||
@property
|
||||
def name(self) -> str: ...
|
||||
|
||||
class DistributionFinder(MetaPathFinder):
|
||||
class Context:
|
||||
name: str | None
|
||||
def __init__(self, *, name: str | None = ..., path: list[str] = ..., **kwargs: Any) -> None: ...
|
||||
@property
|
||||
def path(self) -> list[str]: ...
|
||||
|
||||
@abc.abstractmethod
|
||||
def find_distributions(self, context: DistributionFinder.Context = ...) -> Iterable[Distribution]: ...
|
||||
|
||||
class MetadataPathFinder(DistributionFinder):
|
||||
@classmethod
|
||||
def find_distributions(cls, context: DistributionFinder.Context = ...) -> Iterable[PathDistribution]: ...
|
||||
if sys.version_info >= (3, 10):
|
||||
# Yes, this is an instance method that has argumend named "cls"
|
||||
def invalidate_caches(cls) -> None: ... # type: ignore
|
||||
|
||||
class PathDistribution(Distribution):
|
||||
def __init__(self, path: Path) -> None: ...
|
||||
def read_text(self, filename: StrPath) -> str: ...
|
||||
def locate_file(self, path: StrPath) -> PathLike[str]: ...
|
||||
|
||||
def distribution(distribution_name: str) -> Distribution: ...
|
||||
@overload
|
||||
def distributions(*, context: DistributionFinder.Context) -> Iterable[Distribution]: ...
|
||||
@overload
|
||||
def distributions(
|
||||
*, context: None = ..., name: str | None = ..., path: list[str] = ..., **kwargs: Any
|
||||
) -> Iterable[Distribution]: ...
|
||||
def metadata(distribution_name: str) -> Message: ...
|
||||
def version(distribution_name: str) -> str: ...
|
||||
def entry_points() -> dict[str, tuple[EntryPoint, ...]]: ...
|
||||
def files(distribution_name: str) -> list[PackagePath] | None: ...
|
||||
def requires(distribution_name: str) -> list[str] | None: ...
|
||||
|
||||
Reference in New Issue
Block a user