依赖项说明符#
本文件描述了最初在 PEP 508 中指定的依赖项说明符格式。
依赖项的工作是让 pip 等工具 [1] 找到要安装的正确包。有时这很宽松 - 只指定一个名称，有时非常具体 - 引用要安装的特定文件。有时依赖项只与一个平台相关，或者只接受某些版本，因此该语言允许描述所有这些情况。
定义的语言是一种紧凑的基于行的格式，它已广泛用于 pip 需求文件中，尽管我们没有指定这些文件允许的命令行选项处理。有一个警告 - 版本说明符规范 中指定的 URL 引用形式实际上并未在 pip 中实现，但我们使用该格式，而不是 pip 当前的本机格式。
规范#
示例#
使用基于名称的查找显示语言的所有功能
requests [security,tests] >= 2.8.1, == 2.8.* ; python_version < "2.7"
基于 URL 的最小查找
pip @ https://github.com/pypa/pip/archive/1.3.1.zip#sha1=da9234ee9982d4bbb3c72346a6de940a148ea686
概念#
依赖项规范始终指定一个发行版名称。它可能包括扩展项，这些扩展项扩展了指定发行版的依赖项以启用可选功能。可以使用版本限制或提供要安装的特定工件的 URL 来控制已安装的版本。最后，可以使用环境标记使依赖项成为条件性的。
语法#
我们首先简要介绍语法，然后深入探讨每个部分的语义。
发行版规范是用 ASCII 文本编写的。我们使用 parsley [2] 语法来提供精确的语法。预计该规范将嵌入到提供诸如注释、通过续行提供多行支持或其他此类功能的框架的更大系统中。
包括注释以构建有用的解析树的完整语法包含在本文件的末尾。
可以根据 版本说明符规范 的规则指定版本。（注意：URI 在 std-66 中定义）
version_cmp = wsp* '<' | '<=' | '!=' | '==' | '>=' | '>' | '~=' | '==='
version = wsp* ( letterOrDigit | '-' | '_' | '.' | '*' | '+' | '!' )+
version_one = version_cmp version wsp*
version_many = version_one (',' version_one)* (',' wsp*)?
versionspec = ( '(' version_many ')' ) | version_many
urlspec = '@' wsp* <URI_reference>
环境标记允许在某些环境中使规范生效
marker_op = version_cmp | (wsp+ 'in' wsp+) | (wsp+ 'not' wsp+ 'in' wsp+)
python_str_c = (wsp | letter | digit | '(' | ')' | '.' | '{' | '}' |
'-' | '_' | '*' | '#' | ':' | ';' | ',' | '/' | '?' |
'[' | ']' | '!' | '~' | '`' | '@' | '$' | '%' | '^' |
'&' | '=' | '+' | '|' | '<' | '>' )
dquote = '"'
squote = '\\''
python_str = (squote (python_str_c | dquote)* squote |
dquote (python_str_c | squote)* dquote)
env_var = ('python_version' | 'python_full_version' |
'os_name' | 'sys_platform' | 'platform_release' |
'platform_system' | 'platform_version' |
'platform_machine' | 'platform_python_implementation' |
'implementation_name' | 'implementation_version' |
'extra' # ONLY when defined by a containing layer
)
marker_var = wsp* (env_var | python_str)
marker_expr = marker_var marker_op marker_var
| wsp* '(' marker wsp* ')'
marker_and = marker_expr wsp* 'and' marker_expr
| marker_expr
marker_or = marker_and wsp* 'or' marker_and
| marker_and
marker = marker_or
quoted_marker = ';' wsp* marker
可以使用 extras 字段指定发行版的可选组件
identifier_end = letterOrDigit | (('-' | '_' | '.' )* letterOrDigit)
identifier = letterOrDigit identifier_end*
name = identifier
extras_list = identifier (wsp* ',' wsp* identifier)*
extras = '[' wsp* extras_list? wsp* ']'
在 PEP 685 中定义了对扩展项名称的限制。
为我们提供基于名称的要求的规则
name_req = name wsp* extras? wsp* versionspec? wsp* quoted_marker?
以及直接引用规范的规则
url_req = name wsp* extras? wsp* urlspec (wsp+ quoted_marker?)?
导致可以指定依赖项的统一规则。
specification = wsp* ( url_req | name_req ) wsp*
空白#
非换行空白大多是可选的，没有语义含义。唯一的例外是检测 URL 要求的结尾。
名称#
Python 发行版名称目前在 PEP 345 中定义。名称充当发行版的首要标识符。它们存在于所有依赖项规范中，并且足以成为其自身的规范。但是，PyPI 对名称施加了严格的限制 - 它们必须匹配不区分大小写的正则表达式，否则将不被接受。因此，在本文件中，我们将标识符的可接受值限制为该正则表达式。名称的完全重新定义可能会在未来的元数据 PEP 中进行。正则表达式（使用 re.IGNORECASE 运行）为
^([A-Z0-9]|[A-Z0-9][A-Z0-9._-]*[A-Z0-9])$
附加组件#
附加组件是发行版的可选部分。发行版可以指定任意数量的附加组件，并且每个附加组件都会导致在依赖项规范中使用附加组件时声明发行版的其他依赖项。例如
requests[security,tests]
附加组件在它们定义的依赖项中与它们所附加的发行版的依赖项进行联合。上面的示例将导致安装 requests，以及 requests 自身的依赖项，以及在 requests 的“security”附加组件中列出的任何依赖项。
如果列出了多个附加组件，则所有依赖项都将联合在一起。
版本#
有关版本号和版本比较的更多详细信息，请参阅 版本说明符规范。版本规范限制了可以使用发行版的版本。它们仅适用于通过名称查找的发行版，而不是通过 URL 查找的发行版。版本比较也用于标记功能中。版本周围的可选括号是为了与 PEP 345 兼容，但不能生成，只能接受。
环境标记#
环境标记允许依赖项规范提供一条规则，描述何时应使用依赖项。例如，考虑一个需要 argparse 的软件包。在 Python 2.7 中，argparse 始终存在。在较旧的 Python 版本中，它必须作为依赖项进行安装。这可以这样表达
argparse;python_version<"2.7"
标记表达式求值为 True 或 False。当它求值为 False 时，应忽略依赖项规范。
标记语言的灵感来自 Python 本身，选择它是因为能够安全地对其进行评估，而无需运行可能成为安全漏洞的任意代码。标记最初在 PEP 345 中标准化。本文档修复了在 PEP 426 中描述的设计中观察到的一些问题。
标记表达式中的比较由比较运算符键入。不在 <version_cmp> 中的 <marker_op> 运算符执行的操作与它们在 Python 中对字符串执行的操作相同。当定义了 <version_cmp> 运算符时，它们使用 版本说明符规范 的版本比较规则（即当双方都有有效的版本说明符时）。如果此规范没有定义的行为并且运算符存在于 Python 中，则运算符将回退到 Python 行为。否则应引发错误。例如，以下内容将导致错误
"dog" ~= "fred"
python_version ~= "surprise"
用户提供的常量始终使用带有 ' 或 " 引号的字符串进行编码。请注意，未定义反斜杠转义，但现有实现支持它们。它们未包含在此规范中，因为它们增加了复杂性，并且目前没有可观察到的需要。同样，我们不定义非 ASCII 字符支持：我们引用的所有运行时变量都应仅限于 ASCII。
标记语法中的变量（如“os_name”）解析为在 Python 运行时中查找的值。除了“extra”之外，所有值目前在所有 Python 版本上都已定义 - 如果未定义值，则标记实现中存在错误。
未知变量必须引发错误，而不是导致评估为 True 或 False 的比较。
在给定的 Python 实现中无法计算其值的变量应评估为版本中的 0，以及所有其他变量中的空字符串。
“extra”变量是特殊的。它由轮子用于指示哪些规范适用于轮子 METADATA 文件中的给定额外内容，但由于 METADATA 文件基于 PEP 426 的草稿版本，因此目前没有对此的规范。无论如何，在没有进行此特殊处理的上下文中，“extra”变量应像所有其他未知变量一样导致错误。
标记 |
Python 等效项 |
示例值 |
|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
参见下面的定义 |
|
|
错误，除非由解释规范的上下文定义。 |
|
implementation_version 标记变量派生自 sys.implementation.version
def format_full_version(info):
version = '{0.major}.{0.minor}.{0.micro}'.format(info)
kind = info.releaselevel
if kind != 'final':
version += kind[0] + str(info.serial)
return version
if hasattr(sys, 'implementation'):
implementation_version = format_full_version(sys.implementation.version)
else:
implementation_version = "0"
完整语法#
完整的 Parsley 语法
wsp = ' ' | '\t'
version_cmp = wsp* <'<=' | '<' | '!=' | '==' | '>=' | '>' | '~=' | '==='>
version = wsp* <( letterOrDigit | '-' | '_' | '.' | '*' | '+' | '!' )+>
version_one = version_cmp:op version:v wsp* -> (op, v)
version_many = version_one:v1 (',' version_one)*:v2 (',' wsp*)? -> [v1] + v2
versionspec = ('(' version_many:v ')' ->v) | version_many
urlspec = '@' wsp* <URI_reference>
marker_op = version_cmp | (wsp* 'in') | (wsp* 'not' wsp+ 'in')
python_str_c = (wsp | letter | digit | '(' | ')' | '.' | '{' | '}' |
'-' | '_' | '*' | '#' | ':' | ';' | ',' | '/' | '?' |
'[' | ']' | '!' | '~' | '`' | '@' | '$' | '%' | '^' |
'&' | '=' | '+' | '|' | '<' | '>' )
dquote = '"'
squote = '\\''
python_str = (squote <(python_str_c | dquote)*>:s squote |
dquote <(python_str_c | squote)*>:s dquote) -> s
env_var = ('python_version' | 'python_full_version' |
'os_name' | 'sys_platform' | 'platform_release' |
'platform_system' | 'platform_version' |
'platform_machine' | 'platform_python_implementation' |
'implementation_name' | 'implementation_version' |
'extra' # ONLY when defined by a containing layer
):varname -> lookup(varname)
marker_var = wsp* (env_var | python_str)
marker_expr = marker_var:l marker_op:o marker_var:r -> (o, l, r)
| wsp* '(' marker:m wsp* ')' -> m
marker_and = marker_expr:l wsp* 'and' marker_expr:r -> ('and', l, r)
| marker_expr:m -> m
marker_or = marker_and:l wsp* 'or' marker_and:r -> ('or', l, r)
| marker_and:m -> m
marker = marker_or
quoted_marker = ';' wsp* marker
identifier_end = letterOrDigit | (('-' | '_' | '.' )* letterOrDigit)
identifier = < letterOrDigit identifier_end* >
name = identifier
extras_list = identifier:i (wsp* ',' wsp* identifier)*:ids -> [i] + ids
extras = '[' wsp* extras_list?:e wsp* ']' -> e
name_req = (name:n wsp* extras?:e wsp* versionspec?:v wsp* quoted_marker?:m
-> (n, e or [], v or [], m))
url_req = (name:n wsp* extras?:e wsp* urlspec:v (wsp+ | end) quoted_marker?:m
-> (n, e or [], v, m))
specification = wsp* ( url_req | name_req ):s wsp* -> s
# The result is a tuple - name, list-of-extras,
# list-of-version-constraints-or-a-url, marker-ast or None
URI_reference = <URI | relative_ref>
URI = scheme ':' hier_part ('?' query )? ( '#' fragment)?
hier_part = ('//' authority path_abempty) | path_absolute | path_rootless | path_empty
absolute_URI = scheme ':' hier_part ( '?' query )?
relative_ref = relative_part ( '?' query )? ( '#' fragment )?
relative_part = '//' authority path_abempty | path_absolute | path_noscheme | path_empty
scheme = letter ( letter | digit | '+' | '-' | '.')*
authority = ( userinfo '@' )? host ( ':' port )?
userinfo = ( unreserved | pct_encoded | sub_delims | ':')*
host = IP_literal | IPv4address | reg_name
port = digit*
IP_literal = '[' ( IPv6address | IPvFuture) ']'
IPvFuture = 'v' hexdig+ '.' ( unreserved | sub_delims | ':')+
IPv6address = (
( h16 ':'){6} ls32
| '::' ( h16 ':'){5} ls32
| ( h16 )? '::' ( h16 ':'){4} ls32
| ( ( h16 ':')? h16 )? '::' ( h16 ':'){3} ls32
| ( ( h16 ':'){0,2} h16 )? '::' ( h16 ':'){2} ls32
| ( ( h16 ':'){0,3} h16 )? '::' h16 ':' ls32
| ( ( h16 ':'){0,4} h16 )? '::' ls32
| ( ( h16 ':'){0,5} h16 )? '::' h16
| ( ( h16 ':'){0,6} h16 )? '::' )
h16 = hexdig{1,4}
ls32 = ( h16 ':' h16) | IPv4address
IPv4address = dec_octet '.' dec_octet '.' dec_octet '.' dec_octet
nz = ~'0' digit
dec_octet = (
digit # 0-9
| nz digit # 10-99
| '1' digit{2} # 100-199
| '2' ('0' | '1' | '2' | '3' | '4') digit # 200-249
| '25' ('0' | '1' | '2' | '3' | '4' | '5') )# %250-255
reg_name = ( unreserved | pct_encoded | sub_delims)*
path = (
path_abempty # begins with '/' or is empty
| path_absolute # begins with '/' but not '//'
| path_noscheme # begins with a non-colon segment
| path_rootless # begins with a segment
| path_empty ) # zero characters
path_abempty = ( '/' segment)*
path_absolute = '/' ( segment_nz ( '/' segment)* )?
path_noscheme = segment_nz_nc ( '/' segment)*
path_rootless = segment_nz ( '/' segment)*
path_empty = pchar{0}
segment = pchar*
segment_nz = pchar+
segment_nz_nc = ( unreserved | pct_encoded | sub_delims | '@')+
# non-zero-length segment without any colon ':'
pchar = unreserved | pct_encoded | sub_delims | ':' | '@'
query = ( pchar | '/' | '?')*
fragment = ( pchar | '/' | '?')*
pct_encoded = '%' hexdig
unreserved = letter | digit | '-' | '.' | '_' | '~'
reserved = gen_delims | sub_delims
gen_delims = ':' | '/' | '?' | '#' | '(' | ')?' | '@'
sub_delims = '!' | '$' | '&' | '\\'' | '(' | ')' | '*' | '+' | ',' | ';' | '='
hexdig = digit | 'a' | 'A' | 'b' | 'B' | 'c' | 'C' | 'd' | 'D' | 'e' | 'E' | 'f' | 'F'
测试程序 - 如果语法在字符串 grammar 中
import os
import sys
import platform
from parsley import makeGrammar
grammar = """
wsp ...
"""
tests = [
"A",
"A.B-C_D",
"aa",
"name",
"name<=1",
"name>=3",
"name>=3,",
"name>=3,<2",
"name@http://foo.com",
"name [fred,bar] @ http://foo.com ; python_version=='2.7'",
"name[quux, strange];python_version<'2.7' and platform_version=='2'",
"name; os_name=='a' or os_name=='b'",
# Should parse as (a and b) or c
"name; os_name=='a' and os_name=='b' or os_name=='c'",
# Overriding precedence -> a and (b or c)
"name; os_name=='a' and (os_name=='b' or os_name=='c')",
# should parse as a or (b and c)
"name; os_name=='a' or os_name=='b' and os_name=='c'",
# Overriding precedence -> (a or b) and c
"name; (os_name=='a' or os_name=='b') and os_name=='c'",
]
def format_full_version(info):
version = '{0.major}.{0.minor}.{0.micro}'.format(info)
kind = info.releaselevel
if kind != 'final':
version += kind[0] + str(info.serial)
return version
if hasattr(sys, 'implementation'):
implementation_version = format_full_version(sys.implementation.version)
implementation_name = sys.implementation.name
else:
implementation_version = '0'
implementation_name = ''
bindings = {
'implementation_name': implementation_name,
'implementation_version': implementation_version,
'os_name': os.name,
'platform_machine': platform.machine(),
'platform_python_implementation': platform.python_implementation(),
'platform_release': platform.release(),
'platform_system': platform.system(),
'platform_version': platform.version(),
'python_full_version': platform.python_version(),
'python_version': '.'.join(platform.python_version_tuple()[:2]),
'sys_platform': sys.platform,
}
compiled = makeGrammar(grammar, {'lookup': bindings.__getitem__})
for test in tests:
parsed = compiled(test).specification()
print("%s -> %s" % (test, parsed))