summaryrefslogtreecommitdiff
path: root/docs/pkg_resources.txt
diff options
context:
space:
mode:
authorJason R. Coombs <jaraco@jaraco.com>2016-12-03 09:30:44 -0500
committerGitHub <noreply@github.com>2016-12-03 09:30:44 -0500
commitb29c4e27d09781879d3618de72b256373c68809d (patch)
tree6ff5b464aacc64669549731d2cdf45ca577f38cc /docs/pkg_resources.txt
parent03083d6f1596aaee9c7c46e58e57e8127b17dd2a (diff)
parent959e12ca13a0a006100c2fe5284f69ee0d5b6fbb (diff)
downloadpython-setuptools-git-b29c4e27d09781879d3618de72b256373c68809d.tar.gz
Merge pull request #859 from liaoishere/fix-entrypoint-doc
Make Entrypoint methods docs up to date.
Diffstat (limited to 'docs/pkg_resources.txt')
-rw-r--r--docs/pkg_resources.txt6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/pkg_resources.txt b/docs/pkg_resources.txt
index 7b979ec3..9a45b9e3 100644
--- a/docs/pkg_resources.txt
+++ b/docs/pkg_resources.txt
@@ -835,6 +835,8 @@ addition, the following methods are provided:
Load the entry point, returning the advertised Python object, or raise
``ImportError`` if it cannot be obtained. If `require` is a true value,
then ``require(env, installer)`` is called before attempting the import.
+ Parameters to load are deprecated. Call ``require`` and ``resolve``
+ separately.
``require(env=None, installer=None)``
Ensure that any "extras" needed by the entry point are available on
@@ -846,6 +848,10 @@ addition, the following methods are provided:
taking a ``Requirement`` instance and returning a matching importable
``Distribution`` instance or None.
+``resolve()``
+ Resolve the entry point from its module and attrs, returning the advertised
+ Python object.
+
``__str__()``
The string form of an ``EntryPoint`` is a string that could be passed to
``EntryPoint.parse()`` to produce an equivalent ``EntryPoint``.