summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorLiao Penghui <liaoishere@gmail.com>2016-11-25 12:41:53 +0800
committerLiao Penghui <liaoishere@gmail.com>2016-11-25 12:44:29 +0800
commit959e12ca13a0a006100c2fe5284f69ee0d5b6fbb (patch)
treeb89443e43469300d724b8d9abc8dcf170cea5bf3 /docs
parente8d53c0b830744a3cec9c0080293c39dfbf5ac72 (diff)
downloadpython-setuptools-git-959e12ca13a0a006100c2fe5284f69ee0d5b6fbb.tar.gz
Make Entrypoint methods docs up to date.
Entrypoint.load() is deprecated and it's recommend to use `require` and `resolve` separately.
Diffstat (limited to 'docs')
-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``.