Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
S
setuptools
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Jérome Perrin
setuptools
Commits
79d48e6b
Commit
79d48e6b
authored
Mar 18, 2016
by
Jason R. Coombs
Browse files
Options
Browse Files
Download
Plain Diff
Merged in stevenk_/setuptools (pull request #184)
Update documentation for ``Requirement``.
parents
dc04903d
db587f4f
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
13 additions
and
14 deletions
+13
-14
docs/pkg_resources.txt
docs/pkg_resources.txt
+13
-14
No files found.
docs/pkg_resources.txt
View file @
79d48e6b
...
@@ -590,20 +590,7 @@ Requirements Parsing
...
@@ -590,20 +590,7 @@ Requirements Parsing
parse multiple specifiers from a string or iterable of strings, use
parse multiple specifiers from a string or iterable of strings, use
``parse_requirements()`` instead.)
``parse_requirements()`` instead.)
The syntax of a requirement specifier can be defined in EBNF as follows::
The syntax of a requirement specifier is defined in full in PEP 508.
requirement ::= project_name extras? versionspec?
versionspec ::= comparison version (',' comparison version)*
comparison ::= '<' | '<=' | '!=' | '==' | '>=' | '>' | '~=' | '==='
extras ::= '[' extralist? ']'
extralist ::= identifier (',' identifier)*
project_name ::= identifier
identifier ::= [-A-Za-z0-9_]+
version ::= [-A-Za-z0-9_.]+
Tokens can be separated by whitespace, and a requirement can be continued
over multiple lines using a backslash (``\\``). Line-end comments (using
``#``) are also allowed.
Some examples of valid requirement specifiers::
Some examples of valid requirement specifiers::
...
@@ -611,6 +598,7 @@ Requirements Parsing
...
@@ -611,6 +598,7 @@ Requirements Parsing
Fizzy [foo, bar]
Fizzy [foo, bar]
PickyThing<1.6,>1.9,!=1.9.6,<2.0a0,==2.4c1
PickyThing<1.6,>1.9,!=1.9.6,<2.0a0,==2.4c1
SomethingWhoseVersionIDontCareAbout
SomethingWhoseVersionIDontCareAbout
SomethingWithMarker[foo]>1.0;python_version<"2.7"
The project name is the only required portion of a requirement string, and
The project name is the only required portion of a requirement string, and
if it's the only thing supplied, the requirement will accept any version
if it's the only thing supplied, the requirement will accept any version
...
@@ -631,6 +619,11 @@ Requirements Parsing
...
@@ -631,6 +619,11 @@ Requirements Parsing
``pkg_resources.require('Report-O-Rama[PDF]')`` to add the necessary
``pkg_resources.require('Report-O-Rama[PDF]')`` to add the necessary
distributions to sys.path at runtime.
distributions to sys.path at runtime.
The "markers" in a requirement are used to specify when a requirement
should be installed -- the requirement will be installed if the marker
evaluates as true in the current environment. For example, specifying
``argparse;python_version<"2.7"`` will not install in an Python 2.7 or 3.3
environment, but will in a Python 2.6 environment.
``Requirement`` Methods and Attributes
``Requirement`` Methods and Attributes
--------------------------------------
--------------------------------------
...
@@ -680,6 +673,12 @@ Requirements Parsing
...
@@ -680,6 +673,12 @@ Requirements Parsing
order. The `op` in each tuple is a comparison operator, represented as
order. The `op` in each tuple is a comparison operator, represented as
a string. The `version` is the (unparsed) version number.
a string. The `version` is the (unparsed) version number.
``marker``
An instance of ``packaging.markers.Marker`` that allows evaluation
against the current environment. May be None if no marker specified.
``url``
The location to download the requirement from if specified.
Entry Points
Entry Points
============
============
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment