setuptools.PackageFinder Class Reference

Inheritance diagram for setuptools.PackageFinder:

Public Member Functions
def	find

Static Public Member Functions
def	require_parents

Private Member Functions
def	_find_packages_iter

Static Private Member Functions
def	_all_dirs
def	_looks_like_package
def	_build_filter

Member Function Documentation

def setuptools.PackageFinder._all_dirs (   base_path )

staticprivate

Return all dirs in base_path, relative to base_path

def setuptools.PackageFinder._build_filter (   patterns )

staticprivate

Given a list of patterns, return a callable that will be true only if
the input matches one of the patterns.

def setuptools.PackageFinder._find_packages_iter (   cls,   base_path  )

private

def setuptools.PackageFinder._looks_like_package (   path )

staticprivate

def setuptools.PackageFinder.find	(		cls,
			where = '.',
			exclude = (),
			include = ('*',
	)

Return a list all Python packages found within directory 'where'

'where' 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 package names to exclude; '*' can be used
as a wildcard in the names, such that 'foo.*' will exclude all
subpackages of 'foo' (but not 'foo' itself).

'include' is a sequence of package names to include.  If it's
specified, only the named packages will be included.  If it's not
specified, all found packages will be included.  'include' can contain
shell style wildcard patterns just like 'exclude'.

The list of included packages is built up first and then any
explicitly excluded packages are removed from it.

def setuptools.PackageFinder.require_parents (   packages )

static

Exclude any apparent package that apparently doesn't include its
parent.

For example, exclude 'foo.bar' if 'foo' is not present.

---

The documentation for this class was generated from the following file:

• orbits/lib/python2.7/site-packages/setuptools/__init__.py