3
KRe' @ s d gZ ddlZddlZddlZddlZddlZddlZddlZddl Zddl
Z
ddl m Z ddl
mZmZmZ ddlmZ ddlmZ ddlmZmZmZ ddlmZ dd lm Z dd
l m Z dd l m Z dd l!m"Z" ddl#Z#d
dl$m%Z% e&d e&d dd Z'dd Z(dd Z)e*e+fZ,dd Z-dd Z.dd Z/d d Z0d d Z1d!d" Z2d#d$ Z3d%d& Z4d'd( Z5d)d* Z6d+d, Z7d-d. Z8e ej9j:Z;G d/d d e%e;Z:G d0d1 d1Zd? Z#d@dA Z$dBdC Z%dDdE Z&dS )Hr a Distribution with support for features, tests, and package data
This is an enhanced version of 'distutils.dist.Distribution' that
effectively adds the following new optional keyword arguments to 'setup()':
'install_requires' -- a string or sequence of strings specifying project
versions that the distribution requires when installed, in the format
used by 'pkg_resources.require()'. They will be installed
automatically when the package is installed. If you wish to use
packages that are not available in PyPI, or want to give your users an
alternate download location, you can add a 'find_links' option to the
'[easy_install]' section of your project's 'setup.cfg' file, and then
setuptools will scan the listed web pages for links that satisfy the
requirements.
'extras_require' -- a dictionary mapping names of optional "extras" to the
additional requirement(s) that using those extras incurs. For example,
this::
extras_require = dict(reST = ["docutils>=0.3", "reSTedit"])
indicates that the distribution can optionally provide an extra
capability called "reST", but it can only be used if docutils and
reSTedit are installed. If the user installs your package using
EasyInstall and requests one of your extras, the corresponding
additional requirements will be installed if needed.
'features' **deprecated** -- a dictionary mapping option names to
'setuptools.Feature'
objects. Features are a portion of the distribution that can be
included or excluded based on user options, inter-feature dependencies,
and availability on the current system. Excluded features are omitted
from all setup commands, including source and binary distributions, so
you can create multiple distributions from the same source tree.
Feature names should be valid Python identifiers, except that they may
contain the '-' (minus) sign. Features can be included or excluded
via the command line options '--with-X' and '--without-X', where 'X' is
the name of the feature. Whether a feature is included by default, and
whether you are allowed to control this from the command line, is
determined by the Feature object. See the 'Feature' class for more
information.
'test_suite' -- the name of a test suite to run for the 'test' command.
If the user runs 'python setup.py test', the package will be installed,
and the named test suite will be run. The format is the same as
would be used on a 'unittest.py' command line. That is, it is the
dotted name of an object to import and call to generate a test suite.
'package_data' -- a dictionary mapping package names to lists of filenames
or globs to use to find data files contained in the named packages.
If the dictionary has filenames or globs listed under '""' (the empty
string), those names will be searched for in every package, in addition
to any names for the specific package. Data files found using these
names/globs will be installed along with the package, in the same
location as the package. Note that globs are allowed to reference
the contents of non-package subdirectories, as long as you use '/' as
a path separator. (Globs are automatically converted to
platform-specific paths at runtime.)
In addition to these new keywords, this class also has several new methods
for manipulating the distribution's contents. For example, the 'include()'
and 'exclude()' methods can be thought of as in-place add and subtract
commands that add or remove packages, modules, extensions, and so on from
the distribution. They are used by the feature subsystem to configure the
distribution for the included and excluded features.
Nc C sp | sd|ksd|krd S t jt|d j }t jjj|}|d k rl|jd rlt jt|d |_ || _
d S )Nro r> zPKG-INFO) rK safe_namer lower working_setby_keyget has_metadata safe_version_version
_patched_dist)r< attrskeyrS r r r patch_missing_pkg_info/ s z#Distribution.patch_missing_pkg_infoc C s t | d}|si | _|pi }d|ks,d|kr4tj g | _i | _g | _|jdd | _| j | |j
di | _ |jdg | _ |jdg | _
x$tjdD ]}t| j|jd qW tj| | t| jd| j | j_ |j
d | j_t| jjtjrt | jj| j_| jjd k ryHt jj | jj}t |}| jj|krPt j d
| jj|f || j_W n0 t jj!t"fk
r t j d | jj Y nX | j# d S ) N package_datafeaturesrequire_featuressrc_rootr( dependency_linkssetup_requireszdistutils.setup_keywordsr2 zNormalizing '%s' to '%s'zThe version specified (%r) is an invalid version, this may not work as expected with newer versions of setuptools, pip, and PyPI. Please see PEP 440 for more details.)$r' r Featurewarn_deprecatedr r
dist_filespopr r r r( r r rK iter_entry_pointsvars
setdefaultro
_Distribution__init__getattrmetadatar2 rv r> numbersNumberr r Versionr r InvalidVersionrP _finalize_requires)r< r Zhave_package_datarV verZnormalized_versionr r r r < sL
zDistribution.__init__c C s* t | ddr| j| j_| j | j dS )z
Set `metadata.python_requires` and fix environment markers
in `install_requires` and `extras_require`.
r N)r r r _convert_extras_requirements"_move_install_requirements_markers)r< r r r r p s
z Distribution._finalize_requiresc C sp t | ddpi }tt| _xP|j D ]D\}}| j| x0tj|D ]"}| j|}| j|| j| qBW q$W dS )z
Convert requirements in `extras_require` of the form
`"extra": ["barbazquux; {marker}"]` to
`"extra:{marker}": ["barbazquux"]`.
extras_requireN) r r rd _tmp_extras_requirer1 rK rl _suffix_forappend)r< Z
spec_ext_reqssectionr rsuffixr r r r z s
z)Distribution._convert_extras_requirementsc C s | j rdt| j S dS )ze
For a requirement, return the 'extras_require' suffix for
that requirement.
ri rX )rp r )reqr r r r s zDistribution._suffix_forc s dd }t ddpf }ttj|}t||}t||}ttt| _x&|D ] } j dt|j
j | qPW t fdd j j
D _dS )zv
Move requirements in `install_requires` that are using environment
markers `extras_require`.
c S s | j S )N)rp )r r r r
is_simple_req s zFDistribution._move_install_requirements_markers..is_simple_reqinstall_requiresNri c 3 s, | ]$\}}|d d t j|D fV qdS )c S s g | ] }t |qS r )r ).0r r r r
s zMDistribution._move_install_requirements_markers...N)r
_clean_req)r r r )r< r r s zBDistribution._move_install_requirements_markers..)r rd rK rl r
r r r r r rp r rw r1 r )r< r Zspec_inst_reqsZ inst_reqsZ simple_reqsZ complex_reqsr r )r< r r s
z/Distribution._move_install_requirements_markersc C s
d|_ |S )zP
Given a Requirement, remove environment markers and return it.
N)rp )r< r r r r r s zDistribution._clean_reqFc C s* t j| |d t| | j|d | j dS )zYParses configuration files from various levels
and loads configuration.
) filenames)ignore_option_errorsN)r parse_config_filesr command_optionsr )r< r r r r r r s z Distribution.parse_config_filesc C s t j| }| jr| j |S )z3Process features after parsing command line options)r parse_command_liner _finalize_features)r< resultr r r r s
z Distribution.parse_command_linec C s d|j dd S )z;Convert feature name to corresponding option attribute nameZwith_-_)replace)r< ro r r r _feature_attrname s z Distribution._feature_attrnamec C s< t jjt j|| jdd}x |D ]}t jj|dd q W |S )z Resolve pre-setup requirementsT) installerreplace_conflicting)r )rK r resolverl fetch_build_eggadd)r< r# Zresolved_distsrS r r r fetch_build_eggs s
z Distribution.fetch_build_eggsc C s t j| | jr| j xHtjdD ]:}t| |jd }|d k r$|j| j d |j
| |j| q$W t| dd rdd | j D | _ ng | _ d S )Nzdistutils.setup_keywords)r convert_2to3_doctestsc S s g | ]}t jj|qS r )rF rG abspath)r pr r r r s z1Distribution.finalize_options..) r finalize_optionsr _set_global_opts_from_featuresrK r r ro requirer loadr )r< rV rU r r r r s
z Distribution.finalize_optionsc C sv t jjt jd}t jj|srt j| tj| t jj|d}t|d$}|j d |j d |j d W d Q R X |S )Nz.eggsz
README.txtrC zcThis directory contains eggs that were downloaded by setuptools to build, test, and run plug-ins.
zAThis directory caches those eggs to prevent repeated downloads.
z/However, it is safe to delete this directory.
)
rF rG r4 curdirexistsmkdirr Z hide_filerE r) )r< Z
egg_cache_dirZreadme_txt_filenamefr r r get_egg_cache_dir s
z Distribution.get_egg_cache_dirc
C s ddl m} | jddgi}|jd}|j |jdd | jdj D | jr| jdd }d|krx|d d | }d
|f|d< | j }||d g|d d
dd
d
d d d
d }|j |j|S )z Fetch an egg needed for buildingr ) easy_install script_argsr c s s" | ]\}}|dkr||fV qdS )
find_links site_dirs index_urloptimize allow_hostsN)r r r r r r r )r r r r r r r s z/Distribution.fetch_build_egg..Nr r setupxTF)
args install_dirZexclude_scriptsZ always_copyZbuild_directoryeditableupgradeZ
multi_versionZ no_reportuser)
Z setuptools.command.easy_installr __class__get_option_dictclearupdater1 r r ensure_finalized)r< r r rS optslinksr cmdr r r r s(
z Distribution.fetch_build_eggc C s g }| j j }x| jj D ]\}}| j|d |j| |jr|j}d}d}|j s^|| }}d| dd| | fd| dd| | ff}|j | d| |d| < qW || j
| _
| _ | | _ | _ dS )z;Add --with-X/--without-X options based on optional featuresNz
(default)rX zwith-zinclude zwithout-zexclude )
negative_optcopyr r1 _set_featurevalidateoptional descriptioninclude_by_defaultextendglobal_optionsZfeature_optionsZfeature_negopt) r< Zgonoro featuredescrZincdefZexcdefnewr r r r s"
z+Distribution._set_global_opts_from_featuresc C s xJ| j j D ]<\}}| j|}|s2|dkr |j r |j| | j|d q W x6| j j D ](\}}| j|sX|j| | j|d qXW dS )z9Add/remove features and resolve dependencies between themNr r )r r1 feature_is_includedr
include_inr exclude_from)r< ro r Zenabledr r r r - s
z Distribution._finalize_featuresc C s` || j kr| j | S tjd|}x:|D ]&}|j| jd |j | j |< }|S W tj| |S dS )z(Pluggable version of get_command_class()zdistutils.commands)r N)cmdclassrK r r r r r get_command_class)r< commandZepsrV r r r r r > s
z Distribution.get_command_classc C s> x2t jdD ]$}|j| jkr |j }|| j|j< q W tj| S )Nzdistutils.commands)rK r ro r r r print_commands)r< rV r r r r r K s
zDistribution.print_commandsc C s> x2t jdD ]$}|j| jkr |j }|| j|j< q W tj| S )Nzdistutils.commands)rK r ro r r r get_command_list)r< rV r r r r r S s
z Distribution.get_command_listc C s t | | j|| dS )z Set feature's inclusion statusN)setattrr )r< ro statusr r r r [ s zDistribution._set_featurec C s t | | j|S )zAReturn 1 if feature is included, 0 if excluded, 'None' if unknown)r r )r< ro r r r r _ s z Distribution.feature_is_includedc C sF | j |dkr&| j| j}t|d | j| j| | j|d dS )z)Request inclusion of feature named 'name'r z2 is required, but was excluded or is not availabler N)r r r r r r )r< ro r r r r include_featurec s
z Distribution.include_featurec K sD x>|j D ]2\}}t| d| d}|r0|| q
| j|| q
W dS )a Add items to distribution that are named in keyword arguments
For example, 'dist.exclude(py_modules=["x"])' would add 'x' to
the distribution's 'py_modules' attribute, if it was not already
there.
Currently, this method only supports inclusion for attributes that are
lists or tuples. If you need to add support for adding to other
attributes in this or a subclass, you can add an '_include_X' method,
where 'X' is the name of the attribute. The method will be called with
the value passed to 'include()'. So, 'dist.include(foo={"bar":"baz"})'
will try to call 'dist._include_foo({"bar":"baz"})', which can then
handle whatever special inclusion logic is needed.
Z _include_N)r1 r
_include_misc)r< r r r includer r r r n s
zDistribution.includec sf d | j r& fdd| j D | _ | jrD fdd| jD | _| jrb fdd| jD | _dS )z9Remove packages, modules, and extensions in named packagerZ c s$ g | ] }| kr|j r|qS r )
startswith)r r )packagepfxr r r s z0Distribution.exclude_package..c s$ g | ] }| kr|j r|qS r )r )r r )r
r r r r s c s( g | ] }|j kr|j j r|qS r )ro r )r r )r
r r r r s N)packages
py_modules ext_modules)r< r
r )r
r r exclude_package s z Distribution.exclude_packagec C s4 |d }x&| j D ]}||ks(|j|rdS qW dS )z.)rv sequencer r rR r )r< ro rU oldr )rU r
_exclude_misc s
zDistribution._exclude_miscc
s t |tstd||f yt| | W n tk
rH td| Y nX dkr`t| || n:t tsxt|d n" fdd|D }t| | | dS )zAHandle 'include()' for list/tuple attrs without a special handlerz %s: setting must be a list (%r)z %s: No such distribution settingNz4: this setting cannot be changed via include/excludec s g | ]}| kr|qS r r )r r )r r r r s z.Distribution._include_misc..)rv r r r rR r )r< ro rU r r )r r r
s
zDistribution._include_miscc K sD x>|j D ]2\}}t| d| d}|r0|| q
| j|| q
W dS )a Remove items from distribution that are named in keyword arguments
For example, 'dist.exclude(py_modules=["x"])' would remove 'x' from
the distribution's 'py_modules' attribute. Excluding packages uses
the 'exclude_package()' method, so all of the package's contained
packages, modules, and extensions are also excluded.
Currently, this method only supports exclusion from attributes that are
lists or tuples. If you need to add support for excluding from other
attributes in this or a subclass, you can add an '_exclude_X' method,
where 'X' is the name of the attribute. The method will be called with
the value passed to 'exclude()'. So, 'dist.exclude(foo={"bar":"baz"})'
will try to call 'dist._exclude_foo({"bar":"baz"})', which can then
handle whatever special exclusion logic is needed.
Z _exclude_N)r1 r r )r< r r r excluder r r r s
zDistribution.excludec C s, t |tstd|f tt| j| d S )Nz.packages: setting must be a list or tuple (%r))rv r r rd r r )r< r r r r _exclude_packages s
z Distribution._exclude_packagesc
C s | j j| _| j j| _|d }| jd}xB||krh|| \}}||= dd l}|j|d|d d< |d }q(W tj| ||}| j|} t | dd rd|f| j|d< |d k rg S |S )Nr aliasesTr Zcommand_consumes_argumentsz command liner )
r r r r shlexsplitr _parse_command_optsr r )
r< parserr r r srcaliasr nargs cmd_classr r r r s"
z Distribution._parse_command_optsc C s i }x| j j D ]\}}x|j D ]\}\}}|dkr8q"|jdd}|dkr| j|}| jj }|jt|di x<|j D ]\} }
|
|kr|| }d}P q|W tdn |dkrd}||j |i |< q"W qW |S ) ah Return a '{cmd: {opt:val}}' map of all command-line options
Option names are all long, but do not include the leading '--', and
contain dashes rather than underscores. If the option doesn't take
an argument (e.g. '--quiet'), the 'val' is 'None'.
Note that options provided by config files are intentionally excluded.
z command liner r r r Nz Shouldn't be able to get herer )
r r1 r get_command_objr r r r rO r ) r< dr r optr valZcmdobjneg_optnegposr r r get_cmdline_options s(
z Distribution.get_cmdline_optionsc c s x| j p
f D ]
}|V q W x| jp$f D ]
}|V q&W xH| jp>f D ]:}t|trX|\}}n|j}|jdrt|dd }|V q@W dS )z@Yield all packages, modules, and extension names in distributionmoduleN i)r r r rv tuplero endswith)r< pkgr+ extro Z buildinfor r r r - s
z$Distribution.iter_distribution_namesc C s ddl }tjs| jr tj| |S ddl}t|j|j sBtj| |S |jj
j dkr^tj| |S |jj
}|jj }|j
dkr|dp~d}|jj}|j |jj d||||_z tj| |S |j |jj |||||_X dS )zIf there were any non-global "display-only" options
(--help-commands or the metadata display options) on the command
line, display the requested info and return true; else return
false.
r Nutf-8utf8win32
)r1 r2 )sysr PY2
help_commandsr handle_display_optionsiorv stdout
TextIOWrapperrD r errorsplatformline_bufferingdetach)r< option_orderr5 r9 rD r< newliner> r r r r8 ? s$ z#Distribution.handle_display_options)N)NF)'__name__
__module__ __qualname____doc__r r r r r staticmethodr r r r r r r r r r r r r r r r r r r r r[ r r
r r r r* r r8 r r r r r sF B
4
(c @ sP e Zd ZdZedd Zdddf f fddZdd Zd
d Zd d
Z dd Z
dS )r a
**deprecated** -- The `Feature` facility was never completely implemented
or supported, `has reported issues
`_ and will be removed in
a future version.
A subset of the distribution that can be excluded if unneeded/wanted
Features are created using these keyword arguments:
'description' -- a short, human readable description of the feature, to
be used in error messages, and option help messages.
'standard' -- if true, the feature is included by default if it is
available on the current system. Otherwise, the feature is only
included if requested via a command line '--with-X' option, or if
another included feature requires it. The default setting is 'False'.
'available' -- if true, the feature is available for installation on the
current system. The default setting is 'True'.
'optional' -- if true, the feature's inclusion can be controlled from the
command line, using the '--with-X' or '--without-X' options. If
false, the feature's inclusion status is determined automatically,
based on 'availabile', 'standard', and whether any other feature
requires it. The default setting is 'True'.
'require_features' -- a string or sequence of strings naming features
that should also be included if this feature is included. Defaults to
empty list. May also contain 'Require' objects that should be
added/removed from the distribution.
'remove' -- a string or list of strings naming packages to be removed
from the distribution if this feature is *not* included. If the
feature *is* included, this argument is ignored. This argument exists
to support removing features that "crosscut" a distribution, such as
defining a 'tests' feature that removes all the 'tests' subpackages
provided by other features. The default for this argument is an empty
list. (Note: the named package(s) or modules must exist in the base
distribution when the 'setup()' function is initially called.)
other keywords -- any other keyword arguments are saved, and passed to
the distribution's 'include()' and 'exclude()' methods when the
feature is included or excluded, respectively. So, for example, you
could pass 'packages=["a","b"]' to cause packages 'a' and 'b' to be
added or removed from the distribution as appropriate.
A feature must include at least one 'requires', 'remove', or other
keyword argument. Otherwise, it can't affect the distribution in any way.
Note also that you can subclass 'Feature' to create your own specialized
feature types that modify the distribution in other ways when included or
excluded. See the docstrings for the various methods here for more detail.
Aside from the methods, the only feature attributes that distributions look
at are 'description' and 'optional'.
c C s d} t j| tdd d S )NzrFeatures are deprecated and will be removed in a future version. See https://github.com/pypa/setuptools/issues/65. )
stacklevel)r r r )msgr r r r s zFeature.warn_deprecatedFTc K s | j || _|| _|| _|| _t|ttfr4|f}dd |D | _dd |D }|r^||d< t|trn|f}|| _ || _
| r| r| rt dd S )Nc S s g | ]}t |tr|qS r )rv r )r r r r r r s z$Feature.__init__..c S s g | ]}t |ts|qS r )rv r )r r r r r r s r zgFeature %s: must define 'require_features', 'remove', or at least one of 'packages', 'py_modules', etc.) r r standard availabler rv r r
r removerN r ) r< r rJ rK r r rL rN Zerr r r r s$
zFeature.__init__c C s | j o
| jS )z+Should this feature be included by default?)rK rJ )r< r r r r s zFeature.include_by_defaultc C s@ | j st| jd |jf | j x| jD ]}|j| q*W dS )a Ensure feature and its requirements are included in distribution
You may override this in a subclass to perform additional operations on
the distribution. Note that this method may be called more than once
per feature, and so should be idempotent.
z3 is required, but is not available on this platformN)rK r r r rN r r )r< rS r r r r r s zFeature.include_inc C s2 |j f | j | jr.x| jD ]}|j| q W dS )a2 Ensure feature is excluded from distribution
You may override this in a subclass to perform additional operations on
the distribution. This method will be called at most once per
feature, and only after all included features have been asked to
include themselves.
N)r rN rL r )r< rS r r r r r s zFeature.exclude_fromc C s2 x,| j D ]"}|j|std| j||f qW dS )a Verify that feature makes sense in context of distribution
This method is called by the distribution just before it parses its
command line. It checks to ensure that the 'remove' attribute, if any,
contains only valid package/module names that are present in the base
distribution when 'setup()' is called. You may override it in a
subclass to perform any other required validation of the feature
against a target distribution.
zg%s wants to be able to remove %s, but the distribution doesn't contain any packages or modules under %sN)rL r[ r r )r< rS r r r r r s
zFeature.validateN) rB rC rD rE rF r r r r r r r r r r r c s 7 r )=__all__r rF r r Z
distutils.logr] distutils.core
distutils.cmddistutils.distre collectionsr distutils.errorsr r r distutils.utilr Zsetuptools.externr Zsetuptools.extern.six.movesr r
r Zpkg_resources.externr Zsetuptools.dependsr
setuptoolsr Zsetuptools.monkeyr Zsetuptools.configr rK Z
py36compatr
__import__r rB rJ r- rd r rW rY rc rh rg rt ry r} r r r r corer r r r r r r s\ 1
~