setuptools.discovery._Finder

class documentation

class _Finder: (source)

Known subclasses: setuptools.discovery.ModuleFinder, setuptools.discovery.PackageFinder

View In Hierarchy

Base class that exposes functionality for module/package finders

Class Method find Return a list of all Python items (packages or modules, depending on the finder implementation) found within directory 'where'.
Constant ALWAYS_EXCLUDE Undocumented
Constant DEFAULT_EXCLUDE Undocumented
Class Method _find_iter Undocumented
@classmethod
def find(cls, where: _Path = '.', exclude: Iterable[str] = (), include: Iterable[str] = ('*')) -> List[str]: (source)

Return a list of all Python items (packages or modules, depending on the finder implementation) found within directory 'where'. 'where' is the root directory which will be searched. It should be supplied as a "cross-platform" (i.e. URL-style) path; it will be converted to the appropriate local path syntax. 'exclude' is a sequence of names to exclude; '*' can be used as a wildcard in the names. When finding packages, 'foo.*' will exclude all subpackages of 'foo' (but not 'foo' itself). 'include' is a sequence of names to include. If it's specified, only the named items will be included. If it's not specified, all found items will be included. 'include' can contain shell style wildcard patterns just like 'exclude'.

ALWAYS_EXCLUDE: Tuple[str, ...] = (source)
overridden in setuptools.discovery.PackageFinder

Undocumented

Value
()
DEFAULT_EXCLUDE: Tuple[str, ...] = (source)
overridden in setuptools.discovery.FlatLayoutModuleFinder, setuptools.discovery.FlatLayoutPackageFinder

Undocumented

Value
()
@classmethod
def _find_iter(cls, where: _Path, exclude: _Filter, include: _Filter) -> StrIter: (source)
overridden in setuptools.discovery.ModuleFinder, setuptools.discovery.PackageFinder

Undocumented