a
hK @ s d gZ ddlZddlZddlZddlZddlZddlZddlZddl Zddl
Zddl Zddl m
Z
ddlmZ ddlmZ ddlmZ ddlZddlmZ ddlmZ dd lmZmZ dd
l m Z dd l m Z dd l m Z dd
l m!Z! ddl"m#Z# ddl$Z$ddl$m%Z% ddl&m'Z' ddl(m)Z) ddl*Z*e+d e+d dd Z,dd Z-dd Z.dd Z/d d Z0e1e2fZ3d d Z4d!d" Z5d#d$ Z6d%d& Z7d'd( Z8d)d* Z9d+d, Z:d-d. Z;d/d0 Zd5d6 Z?e'ej@jAZBG d7d d eBZAG d8d9 d9e#ZCd._read_fieldc s | d }|g krd S |S N)Zget_all)r. valuesr0 r r
_read_listO s z!read_pkg_file.._read_listzmetadata-versionr. versionZsummaryauthorNz author-emailz home-pagelicensez download-url descriptionkeywords,platformZ
classifierr r' r& r( z license-file)r r
r r. r6 r9 r7 r# author_emailr$ urlr8 r* Zlong_descriptionsplitr: Z platformsr) r' r& r(
license_files)r+ filer2 r5 r r0 r
read_pkg_fileE s<
rB c C s" d| v r t d | dd} | S )N
z1newlines not allowed and will break in the future )r r replace)valr r r single_line| s
rG c
s | } fdd}|dt| |d| |d| |dt| |d| |tdk r|d | |d
| n.d }|D ]$\}}t
| |}|d ur||| q|d
| | j r|d| j | j
D ]}|dd| qt| } |d| d| }
|
r(|d|
|tdkrR| D ]} |d| q>n| d| | d| | d| | d| | d| t| dr|d| j | jr|d| j | j r| j D ]} |d | q| d | j p
g d S ) z5Write the PKG-INFO format data to a file object.
c s d| |f d S )Nz%s: %s
)write)keyr/ rA r r write_field s z#write_pkg_file..write_fieldzMetadata-VersionNameVersionZSummaryz Home-pager Author Author-email))rN r7 )rO r= )Z
Maintainerr# )zMaintainer-emailr$ NZLicensez Download-URLz Project-URLz%s, %sZ Descriptionr; ZKeywordsZPlatformZ
ClassifierZRequiresZProvidesZ Obsoletesr zRequires-PythonzDescription-Content-TypezProvides-Extraz License-File) r- strZget_nameZ get_versionrG Zget_descriptionZget_urlr
Z get_contactZget_contact_emailr Z get_licenser* r% itemsr Zget_long_descriptionjoinZ get_keywordsZ
get_platformsZ _write_listZget_classifiersZ get_requiresZ get_providesZ
get_obsoleteshasattrr r! r" r@ )
r+ rA r6 rK Zoptional_fieldsZfieldattrZattr_valZ project_urlZ long_descr: r< extrar rJ r write_pkg_file sX
rV c C sX zt jd| }W n> ttttfyR } z td||f |W Y d }~n
d }~0 0 d S )Nzx=z4%r must be importable 'module:attrs' string (got %r))
pkg_resources
EntryPointparse TypeError
ValueErrorAttributeErrorAssertionErrorr )distrT r/ eper r r check_importable s ra c C sH zW n> t tttfyB } z td||f |W Y d}~n
d}~0 0 dS )z"Verify that value is a string listz%%r must be a list of strings (got %r)N)rZ r[ r\ r] r r^ rT r/ r` r r r assert_string_list s
rc c C sd |}t | || |D ]J}| |s2tdd| |d\}}}|r||vrtjd|| qdS )z(Verify that namespace packages are validz1Distribution contains no modules or packages for znamespace package %r.z^WARNING: %r is declared as a package namespace, but %r is not: please correct this in setup.pyN)rc has_contents_forr
rpartition distutilslogr )r^ rT r/ Z ns_packagesZnspparentsepchildr r r check_nsp s
rl c
C sR zt tt| W n4 tttfyL } ztd|W Y d}~n
d}~0 0 dS )z+Verify that extras_require mapping is validz'extras_require' must be a dictionary whose values are strings or lists of strings containing valid project/version requirement specifiers.N) list itertoolsstarmap _check_extrarQ rZ r[ r\ r rb r r r check_extras s rq c C s< | d\}}}|r*t|r*td| tt| d S )N:z Invalid environment marker: ) partitionrW Zinvalid_markerr rm parse_requirements)rU Zreqsr. rj markerr r r rp s rp c C s& t ||kr"d}t|j||ddS )z)Verify that value is True, False, 0, or 1z0{attr!r} must be a boolean value (got {value!r}))rT r/ N)boolr format)r^ rT r/ tmplr r r assert_bool s ry c
C sn z(t t| t|ttfr&tdW n@ ttfyh } z$d}t|j ||d|W Y d}~n
d}~0 0 dS )z9Verify that install_requires is a valid requirements listz Unordered types are not allowedzm{attr!r} must be a string or list of strings containing valid project/version requirement specifiers; {error}rT errorN)
rm rW rt
isinstancedictsetrZ r[ r rw r^ rT r/ r{ rx r r r check_requirements s r c
C sV zt j| W n@ t jjyP } z$d}t|j||d|W Y d}~n
d}~0 0 dS )z.Verify that value is a valid version specifierzF{attr!r} must be a string containing valid version specifiers; {error}rz N)r Z
specifiersZ SpecifierSetZInvalidSpecifierr rw r r r r check_specifier' s r c
C sD zt j| W n. ty> } zt||W Y d}~n
d}~0 0 dS )z)Verify that entry_points map is parseableN)rW rX Z parse_mapr[ r rb r r r check_entry_points5 s r c C s t |tstdd S )Nztest_suite must be a string)r| rP r )r^ rT r/ r r r check_test_suite= s
r c C sZ t |tstd|| D ]4\}}t |tsBtd||t| d|| q dS )z@Verify that value is a dictionary of package names to glob listszT{!r} must be a dictionary mapping package names to lists of string wildcard patternsz,keys of {!r} dict must be strings (got {!r})zvalues of {!r} dictN)r| r} r rw rQ rP rc )r^ rT r/ kvr r r check_package_dataB s
r c C s( |D ] }t d|stjd| qd S )Nz \w+(\.\w+)*z[WARNING: %r not a valid package name; please use only .-separated package names in setup.py)rematchrg rh r )r^ rT r/ Zpkgnamer r r check_packagesQ s r c @ sV e Zd ZdZdeejdd dd dZdZdd Z dLd d
Z
e d d Z e d
d Z
dd Zdd Ze dd Zdd Zdd Zdd Ze dd ZdMd d ZdNd d ZdOd"d#Zd$d% Zd&d' Zd(d) Zd*d+ Zd,d- Z d.d/ Z d0d1 Z d2d3 Z d4d5 Z d6d7 Z!d8d9 Z"d:d; Z#dd? Z%d@dA Z&dBdC Z'dDdE Z(dFdG Z)dHdI Z*dJdK Z+dS )Pr aG Distribution with support for 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.
'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.
Nc C s d S r3 r r r r r zDistribution.c C s d S r3 r r r r r r r )r! r% r" license_filer@ c C sl |rd|vsd|vrd S t t|d }t jj|}|d urh|dsht t|d |_ || _
d S )Nr. r6 zPKG-INFO) rW Z safe_namerP lower working_setZby_keygetZ has_metadataZ safe_version_version
_patched_dist)r+ attrsrI r^ r r r patch_missing_pkg_info s z#Distribution.patch_missing_pkg_infoc s t d}|si _|pi }g _|dd _ | |dg _|dg _t dD ]}t
|j d q`t
fdd| D j D ]J\}} jj|fD ]}||v r|| } qq|r| nd }t j|| q jj j_ d S )N package_datasrc_rootdependency_linkssetup_requiresdistutils.setup_keywordsc s i | ]\}}| j vr||qS r ) _DISTUTILS_UNSUPPORTED_METADATA.0r r r+ r r
s
z)Distribution.__init__..)rS r Z
dist_filespopr r r r rW iter_entry_pointsvars
setdefaultr.
_Distribution__init__rQ r metadata__dict__setattr_normalize_version_validate_versionr6 _finalize_requires)r+ r Zhave_package_datar_ optiondefaultsourcer/ r r r r s2
zDistribution.__init__c C sT t | tjs| d u r| S ttj| }| |krPd}t|j f i t
|S | S )Nz)Normalizing '{version}' to '{normalized}') r|
setuptoolssicrP r r6 rM r r rw locals)r6 Z
normalizedrx r r r r s z Distribution._normalize_versionc C sd t | tjrt| } | d ur`ztj| W n2 tjjtfy^ t
d| t | Y S 0 | S )NzThe 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| numbersNumberrP r r6 rM ZInvalidVersionrZ r r r r )r6 r r r r s z Distribution._validate_versionc C sf t | ddr| j| j_t | ddrR| j D ]$}|dd }|r,| jj| q,| | dS )z
Set `metadata.python_requires` and fix environment markers
in `install_requires` and `extras_require`.
r Nextras_requirerr r )
r r r r keysr? r" add _convert_extras_requirements"_move_install_requirements_markers)r+ rU r r r r s
z Distribution._finalize_requiresc C sh t | ddpi }tt| _| D ]@\}}| j| t|D ]"}| |}| j|| | q>q"dS )z
Convert requirements in `extras_require` of the form
`"extra": ["barbazquux; {marker}"]` to
`"extra:{marker}": ["barbazquux"]`.
r N) r r rm _tmp_extras_requirerQ rW rt _suffix_forappend)r+ Z
spec_ext_reqssectionr rsuffixr r r r 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.
rr )ru rP reqr r r r s zDistribution._suffix_forc s dd }t ddpd}tt|}t||}t||}ttt| _ |D ] } j
dt|j | qPt
fdd j
D _dS ) zv
Move requirements in `install_requires` that are using environment
markers `extras_require`.
c S s | j S r3 ru r r r r
is_simple_req s zFDistribution._move_install_requirements_markers..is_simple_reqinstall_requiresNr rr c 3 s, | ]$\}}|d d t j|D fV qdS )c S s g | ] }t |qS r )rP )r r r r r
* r zMDistribution._move_install_requirements_markers...N)map
_clean_reqr r r r ) s zBDistribution._move_install_requirements_markers..)r rm rW rt filterrn filterfalser rP r r ru r r} rQ 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.
Nr )r+ r r r r r . s zDistribution._clean_reqc C s` | j j}|r|ng }| j j}|r2||vr2|| |du rF|du rFd}tt| || j _dS )z.r )r r r r r G s z Distribution._expand_patternsc C s ddl m} tjtjkr g ng d}t|}|du r<| }trJ| d | }t |_
|D ]}t j |dd6}tr| dj
f i t || W d n1 s0 Y | D ]X}||}| |} |D ]:}
|
d ks|
|v rq|||
} |
d
d }
|| f| |
< qq| qZd | jvr.dS | jd D ]\}
\} } | j|
}
|
rft| } n|
d
v rxt| } zt| |
p|
| W n0 ty } zt ||W Y d}~n
d}~0 0 q.z1error in %s: command '%s' has no such option '%s')Zget_command_namer r r rQ Zboolean_optionsr\ r r| rP r r rS r
r[ ) r+ Z command_objZ option_dictZ command_namer r r/ Z bool_optsneg_optZ is_stringr` r r r _set_command_options sF
z!Distribution._set_command_optionsFc C s0 | j |d t| | j|d | | dS )zYParses configuration files from various levels
and loads configuration.
)r )ignore_option_errorsN)r r r r r )r+ r r r r r parse_config_files s z Distribution.parse_config_filesc C s8 t jjt || jdd}|D ]}t jj|dd q |S )z Resolve pre-setup requirementsT) installerZreplace_conflicting)rE )rW r resolvert fetch_build_eggr )r+ r' Zresolved_distsr^ r r r fetch_build_eggs s z Distribution.fetch_build_eggsc C s> d}dd }t dd t|}t||dD ] }|| q,dS )z
Allow plugins to apply arbitrary operations to the
distribution. Each hook may optionally define a 'order'
to influence the order of execution. Smaller numbers
go first and the default is 0.
z(setuptools.finalize_distribution_optionsc S s t | ddS )Norderr )r )hookr r r by_order s z/Distribution.finalize_options..by_orderc S s | S r3 )load)r` r r r r r z/Distribution.finalize_options..)rI N)r rW r sorted)r+ groupr epsr_ r r r finalize_options s
z Distribution.finalize_optionsc C sJ t dD ]:}t| |jd }|d ur
|j| jd | | |j| q
d S )Nr r )rW r r r. requirer r )r+ r_ r/ r r r _finalize_setup_keywords s
z%Distribution._finalize_setup_keywordsc C s* t | dd r dd | jD | _ng | _d S )Nconvert_2to3_doctestsc S s g | ]}t j|qS r )r r abspathr pr r r r s z8Distribution._finalize_2to3_doctests..)r r r r r r _finalize_2to3_doctests s
z$Distribution._finalize_2to3_doctestsc C s t jt jd}t j|st | t| t j|d}t|d.}| d | d | d W d n1 s|0 Y |S )Nz.eggsz
README.txtwzcThis 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.
)
r r rR curdirexistsmkdirr Z hide_filer rH )r+ Z
egg_cache_dirZreadme_txt_filenamefr r r get_egg_cache_dir s
(z Distribution.get_egg_cache_dirc C s ddl m} || |S )z Fetch an egg needed for buildingr )r )Zsetuptools.installerr )r+ r r r r r r s z Distribution.fetch_build_eggc C s\ || j v r| j | S td|}|D ]*}|j| jd | | j |< }| S t| |S )z(Pluggable version of get_command_class()distutils.commandsr N)cmdclassrW r r r r r get_command_class)r+ commandr r_ r r r r r s
z Distribution.get_command_classc C s: t dD ]$}|j| jvr
| }|| j|j< q
t| S Nr )rW r r. r r r print_commandsr+ r_ r r r r r s
zDistribution.print_commandsc C s: t dD ]$}|j| jvr
| }|| j|j< q
t| S r )rW r r. r r r get_command_listr r r r r # s
z Distribution.get_command_listc K s@ | D ]2\}}t| d| d}|r.|| q| || qdS )a Add items to distribution that are named in keyword arguments
For example, 'dist.include(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)rQ r
_include_misc)r+ r r r includer r r r + s
zDistribution.includec sf d | j r& fdd| j D | _ | jrD fdd| jD | _| jrb fdd| jD | _dS )z9Remove packages, modules, and extensions in named packagerd c s" g | ]}| kr| s|qS r
startswithr packagepfxr r r F s z0Distribution.exclude_package..c s" g | ]}| kr| s|qS r r r r r r r L s c s& g | ] }|j kr|j s|qS r )r. r r r r r r R s N)packages
py_modules ext_modules)r+ r r r r exclude_packageA s z Distribution.exclude_packagec C s2 |d }| D ] }||ks&||r dS qdS )z.r| sequencer r r\ r )r+ r. r/ oldr` r r) r
_exclude_misc` s$
zDistribution._exclude_miscc
s t |tstd||f zt| | W n2 tyZ } ztd| |W Y d}~n
d}~0 0 du rrt| || n:t tst|d n" fdd|D }t| | | dS )zAHandle 'include()' for list/tuple attrs without a special handlerz %s: setting must be a list (%r)r% Nr& c s g | ]}| vr|qS r r r' r, r r r r z.Distribution._include_misc..r* )r+ r. r/ r` newr r. r r s s(
zDistribution._include_miscc K s@ | D ]2\}}t| d| d}|r.|| q| || qdS )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)rQ r r- )r+ r r r excluder r r r0 s
zDistribution.excludec C s, t |tstd|f tt| j| d S )Nz.packages: setting must be a list or tuple (%r))r| r+ r rm r r# )r+ r r r r _exclude_packages s
z Distribution._exclude_packagesc
C s | j j| _| j j| _|d }| d}||v rf|| \}}||= dd l}||d|d d< |d }q&t| ||}| |} t | dd rd|f| |d< |d urg S |S )Nr aliasesTr Zcommand_consumes_arguments command lineargs)
__class__Zglobal_optionsr r shlexr? r _parse_command_optsr r )
r+ r r4 r r2 r r r6 nargsZ cmd_classr r r r7 s"
z Distribution._parse_command_optsc C s i }| j D ]\}}| D ]\}\}}|dkr4q |dd}|dkr| |}| j }|t|di | D ] \} }
|
|krv| }d} qqvtdn |dkrd}|| |i |< q q|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.
r3 r r r r Nz Shouldn't be able to get herer )
r rQ rE Zget_command_objr copyupdater r] r ) r+ dcmdZoptsr r rF Zcmdobjr negposr r r get_cmdline_options s(
z Distribution.get_cmdline_optionsc c sv | j pdD ]
}|V q
| jp dD ]
}|V q | jp4dD ]:}t|trN|\}}n|j}|drj|dd }|V q6dS )z@Yield all packages, modules, and extension names in distributionr moduleNi)r r! r" r| tupler. r )r+ pkgr@ extr. Z buildinfor r r r$ s
z$Distribution.iter_distribution_namesc
C s ddl }| jrt| |S t|jtjs4t| |S |jj dv rPt| |S |jj}|jj
}|j dkrndppd}|jj }t|j
d||||_z(t| |W t|j
|||||_S t|j
|||||_0 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 N)r utf8win32rC r )r Z
help_commandsr handle_display_optionsr| stdoutr
TextIOWrapperr r errorsr< line_bufferingdetach)r+ Z option_orderr r rI newlinerJ r r r rF s2 z#Distribution.handle_display_options)N)N)N)NF),r
__module__ __qualname____doc__r} r Z
OrderedSetr 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# re r- r r0 r1 r7 r? r$ rF r r r r r ] s\ 4
"
B
/
(c @ s e Zd ZdZdS )r zrClass for warning about deprecations in dist in
setuptools. Not ignored by default, unlike DeprecationWarning.N)r rM rN rO r r r r r s r c c sd t }|j}|du r8t|j| D ]}|| |V q"n(| D ]"}||}||vr<|| |V q sr 7
I G