From 2cd0aa16b5db9e0b22ac1cfdc3282ef76692d8e3 Mon Sep 17 00:00:00 2001 From: Teddy Sudol Date: Tue, 21 Aug 2018 21:51:04 -0700 Subject: [PATCH] Fix pkg_resources.pyi formatting (#2396) --- third_party/3/pkg_resources.pyi | 265 ++++++++++++-------------------- 1 file changed, 102 insertions(+), 163 deletions(-) diff --git a/third_party/3/pkg_resources.pyi b/third_party/3/pkg_resources.pyi index 6cd98fe6c..e7c3d1134 100644 --- a/third_party/3/pkg_resources.pyi +++ b/third_party/3/pkg_resources.pyi @@ -1,226 +1,187 @@ # Stubs for pkg_resources (Python 3.4) -from typing import ( - Any, Callable, Dict, IO, Iterable, Generator, Optional, Sequence, Tuple, - List, Union, - TypeVar, overload, -) +from typing import Any, Callable, Dict, IO, Iterable, Generator, Optional, Sequence, Tuple, List, Union, TypeVar, overload from abc import ABCMeta import importlib.abc import types import zipimport -_T = TypeVar('_T') +_T = TypeVar("_T") _NestedStr = Union[str, Iterable[Union[str, Iterable[Any]]]] _InstallerType = Callable[[Requirement], Optional[Distribution]] _EPDistType = Union[Distribution, Requirement, str] _MetadataType = Optional[IResourceProvider] _PkgReqType = Union[str, Requirement] -_DistFinderType = Callable[[str, _Importer, bool], - Generator[Distribution, None, None]] +_DistFinderType = Callable[[str, _Importer, bool], Generator[Distribution, None, None]] _NSHandlerType = Callable[[_Importer, str, str, types.ModuleType], str] def declare_namespace(name: str) -> None: ... def fixup_namespace_packages(path_item: str) -> None: ... - class WorkingSet: - entries = ... # type: List[str] + entries: List[str] def __init__(self, entries: Optional[Iterable[str]] = ...) -> None: ... def require(self, *requirements: _NestedStr) -> Sequence[Distribution]: ... def run_script(self, requires: str, script_name: str) -> None: ... - def iter_entry_points(self, group: str, name: Optional[str] = ...) \ - -> Generator[EntryPoint, None, None]: ... + def iter_entry_points(self, group: str, name: Optional[str] = ...) -> Generator[EntryPoint, None, None]: ... def add_entry(self, entry: str) -> None: ... def __contains__(self, dist: Distribution) -> bool: ... def __iter__(self) -> Generator[Distribution, None, None]: ... def find(self, req: Requirement) -> Optional[Distribution]: ... - def resolve(self, requirements: Sequence[Requirement], - env: Optional[Environment] = ..., - installer: Optional[_InstallerType] = ...) \ - -> List[Distribution]: ... - def add(self, dist: Distribution, entry: Optional[str] = ..., - insert: bool = ..., replace: bool = ...) -> None: ... + def resolve( + self, requirements: Sequence[Requirement], env: Optional[Environment] = ..., installer: Optional[_InstallerType] = ... + ) -> List[Distribution]: ... + def add(self, dist: Distribution, entry: Optional[str] = ..., insert: bool = ..., replace: bool = ...) -> None: ... def subscribe(self, callback: Callable[[Distribution], None]) -> None: ... - def find_plugins(self, plugin_env: Environment, - full_env: Optional[Environment] = ..., - fallback: bool = ...) \ - -> Tuple[List[Distribution], - Dict[Distribution, Exception]]: ... + def find_plugins( + self, plugin_env: Environment, full_env: Optional[Environment] = ..., fallback: bool = ... + ) -> Tuple[List[Distribution], Dict[Distribution, Exception]]: ... -working_set = ... # type: WorkingSet +working_set: WorkingSet -def require( - *requirements: Union[str, Sequence[str]] -) -> Sequence[Distribution]: ... +def require(*requirements: Union[str, Sequence[str]]) -> Sequence[Distribution]: ... def run_script(requires: str, script_name: str) -> None: ... -def iter_entry_points( - group: str, name: Optional[str] = ... -) -> Generator[EntryPoint, None, None]: ... -def add_activation_listener( - callback: Callable[[Distribution], None] -) -> None: ... - +def iter_entry_points(group: str, name: Optional[str] = ...) -> Generator[EntryPoint, None, None]: ... +def add_activation_listener(callback: Callable[[Distribution], None]) -> None: ... class Environment: - def __init__(self, search_path: Optional[Sequence[str]] = ..., - platform: Optional[str] = ..., - python: Optional[str] = ...) -> None: ... + def __init__( + self, search_path: Optional[Sequence[str]] = ..., platform: Optional[str] = ..., python: Optional[str] = ... + ) -> None: ... def __getitem__(self, project_name: str) -> List[Distribution]: ... def __iter__(self) -> Generator[str, None, None]: ... def add(self, dist: Distribution) -> None: ... def remove(self, dist: Distribution) -> None: ... def can_add(self, dist: Distribution) -> bool: ... - def __add__(self, - other: Union[Distribution, Environment]) -> Environment: ... - def __iadd__(self, - other: Union[Distribution, Environment]) -> Environment: ... + def __add__(self, other: Union[Distribution, Environment]) -> Environment: ... + def __iadd__(self, other: Union[Distribution, Environment]) -> Environment: ... @overload def best_match(self, req: Requirement, working_set: WorkingSet) -> Distribution: ... @overload - def best_match(self, req: Requirement, working_set: WorkingSet, - installer: Callable[[Requirement], _T] = ...) -> _T: ... + def best_match(self, req: Requirement, working_set: WorkingSet, installer: Callable[[Requirement], _T] = ...) -> _T: ... @overload def obtain(self, requirement: Requirement) -> None: ... @overload - def obtain(self, requirement: Requirement, - installer: Callable[[Requirement], _T] = ...) -> _T: ... + def obtain(self, requirement: Requirement, installer: Callable[[Requirement], _T] = ...) -> _T: ... def scan(self, search_path: Optional[Sequence[str]] = ...) -> None: ... - def parse_requirements(strs: Union[str, Iterable[str]]) -> Generator[Requirement, None, None]: ... class Requirement: - project_name = ... # type: str - key = ... # type: str - extras = ... # type: Tuple[str, ...] - specs = ... # type: List[Tuple[str, str]] + project_name: str + key: str + extras: Tuple[str, ...] + specs: List[Tuple[str, str]] @staticmethod def parse(s: Union[str, Iterable[str]]) -> Requirement: ... - def __contains__(self, - item: Union[Distribution, str, Tuple[str, ...]]) \ - -> bool: ... + def __contains__(self, item: Union[Distribution, str, Tuple[str, ...]]) -> bool: ... def __eq__(self, other_requirement: Any) -> bool: ... def load_entry_point(dist: _EPDistType, group: str, name: str) -> None: ... -def get_entry_info(dist: _EPDistType, group: str, - name: str) -> Optional[EntryPoint]: ... +def get_entry_info(dist: _EPDistType, group: str, name: str) -> Optional[EntryPoint]: ... @overload def get_entry_map(dist: _EPDistType) -> Dict[str, Dict[str, EntryPoint]]: ... @overload def get_entry_map(dist: _EPDistType, group: str) -> Dict[str, EntryPoint]: ... class EntryPoint: - name = ... # type: str - module_name = ... # type: str - attrs = ... # type: Tuple[str, ...] - extras = ... # type: Tuple[str, ...] - dist = ... # type: Optional[Distribution] - def __init__(self, name: str, module_name: str, - attrs: Tuple[str, ...] = ..., extras: Tuple[str, ...] = ..., - dist: Optional[Distribution] = ...) -> None: ... + name: str + module_name: str + attrs: Tuple[str, ...] + extras: Tuple[str, ...] + dist: Optional[Distribution] + def __init__( + self, + name: str, + module_name: str, + attrs: Tuple[str, ...] = ..., + extras: Tuple[str, ...] = ..., + dist: Optional[Distribution] = ..., + ) -> None: ... @classmethod def parse(cls, src: str, dist: Optional[Distribution] = ...) -> EntryPoint: ... @classmethod - def parse_group(cls, group: str, lines: Union[str, Sequence[str]], - dist: Optional[Distribution] = ...) -> Dict[str, EntryPoint]: ... + def parse_group( + cls, group: str, lines: Union[str, Sequence[str]], dist: Optional[Distribution] = ... + ) -> Dict[str, EntryPoint]: ... @classmethod - def parse_map(cls, data: Union[Dict[str, Union[str, Sequence[str]]], - str, Sequence[str]], - dist: Optional[Distribution] = ...) -> Dict[str, EntryPoint]: ... - def load(self, require: bool = ..., env: Optional[Environment] = ..., - installer: Optional[_InstallerType] = ...) -> Any: ... - def require(self, env: Optional[Environment] = ..., - installer: Optional[_InstallerType] = ...) -> None: ... + def parse_map( + cls, data: Union[Dict[str, Union[str, Sequence[str]]], str, Sequence[str]], dist: Optional[Distribution] = ... + ) -> Dict[str, EntryPoint]: ... + def load(self, require: bool = ..., env: Optional[Environment] = ..., installer: Optional[_InstallerType] = ...) -> Any: ... + def require(self, env: Optional[Environment] = ..., installer: Optional[_InstallerType] = ...) -> None: ... def resolve(self) -> Any: ... - -def find_distributions( - path_item: str, only: bool = ... -) -> Generator[Distribution, None, None]: ... +def find_distributions(path_item: str, only: bool = ...) -> Generator[Distribution, None, None]: ... def get_distribution(dist: Union[Requirement, str, Distribution]) -> Distribution: ... class Distribution(IResourceProvider, IMetadataProvider): - location = ... # type: str - project_name = ... # type: str - key = ... # type: str - extras = ... # type: List[str] - version = ... # type: str - parsed_version = ... # type: Tuple[str, ...] - py_version = ... # type: str - platform = ... # type: Optional[str] - precedence = ... # type: int - def __init__(self, location: Optional[str] = ..., - metadata: Optional[str] = ..., - project_name: Optional[str] = ..., - version: Optional[str] = ..., py_version: str = ..., - platform: Optional[str] = ..., - precedence: int = ...) -> None: ... + location: str + project_name: str + key: str + extras: List[str] + version: str + parsed_version: Tuple[str, ...] + py_version: str + platform: Optional[str] + precedence: int + def __init__( + self, + location: Optional[str] = ..., + metadata: Optional[str] = ..., + project_name: Optional[str] = ..., + version: Optional[str] = ..., + py_version: str = ..., + platform: Optional[str] = ..., + precedence: int = ..., + ) -> None: ... @classmethod - def from_location(cls, location: str, basename: str, - metadata: Optional[str] = ..., - **kw: Union[str, None, int]) -> Distribution: ... + def from_location( + cls, location: str, basename: str, metadata: Optional[str] = ..., **kw: Union[str, None, int] + ) -> Distribution: ... @classmethod - def from_filename(cls, filename: str, metadata: Optional[str] = ..., - **kw: Union[str, None, int]) -> Distribution: ... + def from_filename(cls, filename: str, metadata: Optional[str] = ..., **kw: Union[str, None, int]) -> Distribution: ... def activate(self, path: Optional[List[str]] = ...) -> None: ... def as_requirement(self) -> Requirement: ... def requires(self, extras: Tuple[str, ...] = ...) -> List[Requirement]: ... def clone(self, **kw: Union[str, int, None]) -> Requirement: ... def egg_name(self) -> str: ... def __cmp__(self, other: Any) -> bool: ... - def get_entry_info(self, group: str, - name: str) -> Optional[EntryPoint]: ... + def get_entry_info(self, group: str, name: str) -> Optional[EntryPoint]: ... @overload def get_entry_map(self) -> Dict[str, Dict[str, EntryPoint]]: ... @overload def get_entry_map(self, group: str) -> Dict[str, EntryPoint]: ... def load_entry_point(self, group: str, name: str) -> None: ... -EGG_DIST = ... # type: int -BINARY_DIST = ... # type: int -SOURCE_DIST = ... # type: int -CHECKOUT_DIST = ... # type: int -DEVELOP_DIST = ... # type: int +EGG_DIST: int +BINARY_DIST: int +SOURCE_DIST: int +CHECKOUT_DIST: int +DEVELOP_DIST: int - -def resource_exists(package_or_requirement: _PkgReqType, - resource_name: str) -> bool: ... -def resource_stream(package_or_requirement: _PkgReqType, - resource_name: str) -> IO[bytes]: ... -def resource_string(package_or_requirement: _PkgReqType, - resource_name: str) -> bytes: ... -def resource_isdir(package_or_requirement: _PkgReqType, - resource_name: str) -> bool: ... -def resource_listdir(package_or_requirement: _PkgReqType, - resource_name: str) -> List[str]: ... - -def resource_filename(package_or_requirement: _PkgReqType, - resource_name: str) -> str: ... +def resource_exists(package_or_requirement: _PkgReqType, resource_name: str) -> bool: ... +def resource_stream(package_or_requirement: _PkgReqType, resource_name: str) -> IO[bytes]: ... +def resource_string(package_or_requirement: _PkgReqType, resource_name: str) -> bytes: ... +def resource_isdir(package_or_requirement: _PkgReqType, resource_name: str) -> bool: ... +def resource_listdir(package_or_requirement: _PkgReqType, resource_name: str) -> List[str]: ... +def resource_filename(package_or_requirement: _PkgReqType, resource_name: str) -> str: ... def set_extraction_path(path: str) -> None: ... def cleanup_resources(force: bool = ...) -> List[str]: ... class IResourceManager: - def resource_exists(self, package_or_requirement: _PkgReqType, - resource_name: str) -> bool: ... - def resource_stream(self, package_or_requirement: _PkgReqType, - resource_name: str) -> IO[bytes]: ... - def resource_string(self, package_or_requirement: _PkgReqType, - resource_name: str) -> bytes: ... - def resource_isdir(self, package_or_requirement: _PkgReqType, - resource_name: str) -> bool: ... - def resource_listdir(self, package_or_requirement: _PkgReqType, - resource_name: str) -> List[str]: ... - def resource_filename(self, package_or_requirement: _PkgReqType, - resource_name: str) -> str: ... + def resource_exists(self, package_or_requirement: _PkgReqType, resource_name: str) -> bool: ... + def resource_stream(self, package_or_requirement: _PkgReqType, resource_name: str) -> IO[bytes]: ... + def resource_string(self, package_or_requirement: _PkgReqType, resource_name: str) -> bytes: ... + def resource_isdir(self, package_or_requirement: _PkgReqType, resource_name: str) -> bool: ... + def resource_listdir(self, package_or_requirement: _PkgReqType, resource_name: str) -> List[str]: ... + def resource_filename(self, package_or_requirement: _PkgReqType, resource_name: str) -> str: ... def set_extraction_path(self, path: str) -> None: ... def cleanup_resources(self, force: bool = ...) -> List[str]: ... - def get_cache_path(self, archive_name: str, - names: Tuple[str, ...] = ...) -> str: ... + def get_cache_path(self, archive_name: str, names: Tuple[str, ...] = ...) -> str: ... def extraction_error(self) -> None: ... def postprocess(self, tempname: str, filename: str) -> None: ... - @overload def get_provider(package_or_requirement: str) -> IResourceProvider: ... @overload @@ -234,37 +195,25 @@ class IMetadataProvider: def get_metadata_lines(self, name: str) -> Generator[List[str], None, None]: ... def run_script(self, script_name: str, namespace: Dict[str, Any]) -> None: ... - class ResolutionError(Exception): ... class DistributionNotFound(ResolutionError): ... class VersionConflict(ResolutionError): ... class UnknownExtra(ResolutionError): ... class ExtractionError(Exception): - manager = ... # type: IResourceManager - cache_path = ... # type: str - original_error = ... # type: Exception - + manager: IResourceManager + cache_path: str + original_error: Exception class _Importer(importlib.abc.MetaPathFinder, importlib.abc.InspectLoader, metaclass=ABCMeta): ... -def register_finder(importer_type: type, - distribution_finder: _DistFinderType) -> None: ... -def register_loader_type( - loader_type: type, - provider_factory: Callable[[types.ModuleType], IResourceProvider] -) -> None: ... -def register_namespace_handler(importer_type: type, - namespace_handler: _NSHandlerType) -> None: ... - +def register_finder(importer_type: type, distribution_finder: _DistFinderType) -> None: ... +def register_loader_type(loader_type: type, provider_factory: Callable[[types.ModuleType], IResourceProvider]) -> None: ... +def register_namespace_handler(importer_type: type, namespace_handler: _NSHandlerType) -> None: ... class IResourceProvider(IMetadataProvider): ... - - class NullProvider: ... - class EggProvider(NullProvider): ... - class DefaultProvider(EggProvider): ... class PathMetadata(DefaultProvider, IResourceProvider): @@ -277,33 +226,23 @@ class EggMetadata(ZipProvider, IResourceProvider): class EmptyProvider(NullProvider): ... -empty_provider = ... # type: EmptyProvider +empty_provider: EmptyProvider class FileMetadata(EmptyProvider, IResourceProvider): def __init__(self, path_to_pkg_info: str) -> None: ... - def parse_version(v: str) -> Tuple[str, ...]: ... def yield_lines(strs: _NestedStr) -> Generator[str, None, None]: ... -def split_sections( - strs: _NestedStr -) -> Generator[Tuple[Optional[str], str], None, None]: ... +def split_sections(strs: _NestedStr) -> Generator[Tuple[Optional[str], str], None, None]: ... def safe_name(name: str) -> str: ... def safe_version(version: str) -> str: ... def safe_extra(extra: str) -> str: ... def to_filename(name_or_version: str) -> str: ... - - def get_build_platform() -> str: ... def get_platform() -> str: ... def get_supported_platform() -> str: ... -def compatible_platforms(provided: Optional[str], - required: Optional[str]) -> bool: ... +def compatible_platforms(provided: Optional[str], required: Optional[str]) -> bool: ... def get_default_cache() -> str: ... - - def get_importer(path_item: str) -> _Importer: ... - - def ensure_directory(path: str) -> None: ... def normalize_path(filename: str) -> str: ...