EntryPoint Class Reference

Public Member Functions
	__init__ (self, name, module_name, attrs=(), extras=(), dist=None)
	__str__ (self)
	__repr__ (self)
	load (self, require=True, *args, **kwargs)
	resolve (self)
	require (self, env=None, installer=None)
	parse (cls, src, dist=None)
	parse_group (cls, group, lines, dist=None)
	parse_map (cls, data, dist=None)

Data Fields
	name
	module_name
	attrs
	extras
	dist

Static Public Attributes
	pattern

Protected Member Functions
	_parse_extras (cls, extras_spec)

Detailed Description

Object representing an advertised importable object

Definition at line 2482 of file __init__.py.

Constructor & Destructor Documentation

__init__()

__init__	(		self,
			name,
			module_name,
			attrs = (),
			extras = (),
			dist = None
	)

Definition at line 2485 of file __init__.py.

    def __init__(self, name, module_name, attrs=(), extras=(), dist=None):
        if not MODULE(module_name):
            raise ValueError("Invalid module name", module_name)
        self.name = name
        self.module_name = module_name
        self.attrs = tuple(attrs)
        self.extras = tuple(extras)
        self.dist = dist
 

Referenced by Protocol.__init_subclass__().

Here is the caller graph for this function:

Member Function Documentation

__repr__()

__repr__

(

self

)

Definition at line 2502 of file __init__.py.

    def __repr__(self):
        return "EntryPoint.parse(%r)" % str(self)
 

__str__()

__str__

(

self

)

Definition at line 2494 of file __init__.py.

    def __str__(self):
        s = "%s = %s" % (self.name, self.module_name)
        if self.attrs:
            s += ':' + '.'.join(self.attrs)
        if self.extras:
            s += ' [%s]' % ','.join(self.extras)
        return s
 

_parse_extras()

_parse_extras (   cls,   extras_spec  )

protected

Definition at line 2573 of file __init__.py.

    def _parse_extras(cls, extras_spec):
        if not extras_spec:
            return ()
        req = Requirement.parse('x' + extras_spec)
        if req.specs:
            raise ValueError()
        return req.extras
 

load()

load	(		self,
			require = True,
		*	args,
		**	kwargs
	)

Require packages for this EntryPoint, then resolve it.

Definition at line 2505 of file __init__.py.

    def load(self, require=True, *args, **kwargs):
        """
        Require packages for this EntryPoint, then resolve it.
        """
        if not require or args or kwargs:
            warnings.warn(
                "Parameters to load are deprecated.  Call .resolve and "
                ".require separately.",
                PkgResourcesDeprecationWarning,
                stacklevel=2,
            )
        if require:
            self.require(*args, **kwargs)
        return self.resolve()
 

parse()

parse	(		cls,
			src,
			dist = None
	)

Parse a single entry point from string `src`

Entry point syntax follows the form::

    name = some.module:some.attr [extra1, extra2]

The entry name and module name are required, but the ``:attrs`` and
``[extras]`` parts are optional

Definition at line 2553 of file __init__.py.

    def parse(cls, src, dist=None):
        """Parse a single entry point from string `src`
 
        Entry point syntax follows the form::
 
            name = some.module:some.attr [extra1, extra2]
 
        The entry name and module name are required, but the ``:attrs`` and
        ``[extras]`` parts are optional
        """
        m = cls.pattern.match(src)
        if not m:
            msg = "EntryPoint must be in 'name=module:attrs [extras]' format"
            raise ValueError(msg, src)
        res = m.groupdict()
        extras = cls._parse_extras(res['extras'])
        attrs = res['attr'].split('.') if res['attr'] else ()
        return cls(res['name'], res['module'], attrs, extras, dist)
 

Referenced by Style.normalize().

Here is the caller graph for this function:

parse_group()

parse_group	(		cls,
			group,
			lines,
			dist = None
	)

Parse an entry point group

Definition at line 2582 of file __init__.py.

    def parse_group(cls, group, lines, dist=None):
        """Parse an entry point group"""
        if not MODULE(group):
            raise ValueError("Invalid group name", group)
        this = {}
        for line in yield_lines(lines):
            ep = cls.parse(line, dist)
            if ep.name in this:
                raise ValueError("Duplicate entry point", group, ep.name)
            this[ep.name] = ep
        return this
 

parse_map()

parse_map	(		cls,
			data,
			dist = None
	)

Parse a map of entry point groups

Definition at line 2595 of file __init__.py.

    def parse_map(cls, data, dist=None):
        """Parse a map of entry point groups"""
        if isinstance(data, dict):
            data = data.items()
        else:
            data = split_sections(data)
        maps = {}
        for group, lines in data:
            if group is None:
                if not lines:
                    continue
                raise ValueError("Entry points must be listed in groups")
            group = group.strip()
            if group in maps:
                raise ValueError("Duplicate group name", group)
            maps[group] = cls.parse_group(group, lines, dist)
        return maps
 
 

require()

require	(		self,
			env = None,
			installer = None
	)

Definition at line 2530 of file __init__.py.

    def require(self, env=None, installer=None):
        if self.extras and not self.dist:
            raise UnknownExtra("Can't require() without a distribution", self)
 
        # Get the requirements for this entry point with all its extras and
        # then resolve them. We have to pass `extras` along when resolving so
        # that the working set knows what extras we want. Otherwise, for
        # dist-info distributions, the working set will assume that the
        # requirements for that extra are purely optional and skip over them.
        reqs = self.dist.requires(self.extras)
        items = working_set.resolve(reqs, env, installer, extras=self.extras)
        list(map(working_set.add, items))
 

resolve()

resolve

(

self

)

Resolve the entry point from its module and attrs.

Definition at line 2520 of file __init__.py.

    def resolve(self):
        """
        Resolve the entry point from its module and attrs.
        """
        module = __import__(self.module_name, fromlist=['__name__'], level=0)
        try:
            return functools.reduce(getattr, self.attrs, module)
        except AttributeError as exc:
            raise ImportError(str(exc)) from exc
 

Referenced by BaseConfigurator.configure_custom(), Configurator.configure_custom(), and BaseConfigurator.ext_convert().

Here is the caller graph for this function:

Field Documentation

attrs

attrs

Definition at line 2490 of file __init__.py.

dist

dist

Definition at line 2492 of file __init__.py.

Referenced by AlreadyInstalledCandidate.__repr__(), NoneMetadataError.__str__(), AlreadyInstalledCandidate.__str__(), AlreadyInstalledCandidate.is_editable(), _InstallRequirementBackedCandidate.iter_dependencies(), AlreadyInstalledCandidate.iter_dependencies(), _InstallRequirementBackedCandidate.project_name(), AlreadyInstalledCandidate.project_name(), _InstallRequirementBackedCandidate.version(), and AlreadyInstalledCandidate.version().

extras

extras

Definition at line 2491 of file __init__.py.

Referenced by ExtrasCandidate.__eq__(), ExtrasCandidate.__hash__(), ExtrasCandidate.__repr__(), ExtrasCandidate.__str__(), Requirement.__str__(), Distribution._get_requirements(), Metadata._to_legacy(), ExtrasCandidate.format_for_error(), Metadata.get_requirements(), ExtrasCandidate.iter_dependencies(), and ExtrasCandidate.name().

module_name

module_name

Definition at line 2489 of file __init__.py.

name

name

Definition at line 2488 of file __init__.py.

Referenced by AlreadyInstalledCandidate.__eq__(), Distribution.__eq__(), ExportEntry.__eq__(), _LazyDescr.__get__(), Distribution.__hash__(), ElementState.__init__(), Requirement.__init__(), LinkHash.__post_init__(), InstallationCandidate.__repr__(), Distribution.__repr__(), Metadata.__repr__(), ExportEntry.__repr__(), Encoding.__repr__(), Color.__rich_repr__(), Layout.__rich_repr__(), InstallationCandidate.__str__(), InstalledDistribution.__str__(), EggInfoDistribution.__str__(), Requirement.__str__(), ParserElement.__str__(), Tag.__str__(), _SixMetaPathImporter._add_module(), Matcher._check_compatible(), InstallRequirement._get_archive_name(), Wheel._get_extensions(), _SixMetaPathImporter._get_module(), ConfigOptionParser._get_ordered_configuration_items(), Distribution._get_requirements(), _Cache.add(), InstallRequirement.archive(), LinkHash.as_dict(), LinkHash.as_hashes(), Wheel.build(), _Cache.clear(), Wheel.filename(), Layout.get(), InstallRequirement.get_dist(), InstalledDistribution.get_distinfo_file(), RequirementCommand.get_requirements(), Wheel.get_wheel_metadata(), InstallRequirement.install(), Wheel.install(), SpecifierRequirement.is_satisfied_by(), LinuxDistribution.linux_distribution(), Wheel.metadata(), Distribution.name_and_version(), InstallRequirement.prepare_metadata(), Distribution.provides(), Metadata.provides(), VcsSupport.register(), VersionControl.run_command(), InstallRequirement.uninstall(), Wheel.update(), and Wheel.verify().

pattern

pattern

static

Initial value:

=  re.compile(
        r'\s*'
        r'(?P<name>.+?)\s*'
        r'=\s*'
        r'(?P<module>[\w.]+)\s*'
        r'(:\s*(?P<attr>[\w.]+))?\s*'
        r'(?P<extras>\[.*\])?\s*$'
    )

Definition at line 2543 of file __init__.py.

Referenced by Regex._generateDefaultName(), and Regex.re().

---

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

• /home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_vendor/pkg_resources/__init__.py