1jGh U d Z ddlmZ ddlZddlZddlZddlmZ ddlm Z ddl
m Z m Z ddlm
Z
mZ ddlmZmZmZmZmZmZmZ dd lmZ dd
lmZm Z dd l m Z m Z d d
l m!Z! d dl"m#Z# d dl$m%Z%m&Z& d dl'm(Z( ddl m)Z) erddl*m+Z+ ddl,m-Z- ddl.m/Z/ e0e1e2e1ef f Z3de4d< e0e1e3f Z5de4d< eddd Z6 dFdGd$Z7dHd&Z8 dIdJd+Z9dKd0Z:dLd3Z; dMdNd6Z G d> d?e>d Z? G d@ dAe>d Z@ G dB dCe( ZA G dD dEe( ZBdS )Pa<
Load setuptools configuration from ``setup.cfg`` files.
**API will be made private in the future**
To read project metadata, consider using
``build.util.project_wheel_metadata`` (https://pypi.org/project/build/).
For simple scenarios, you can also try parsing the file directly
with the help of ``configparser``.
) annotationsN)abstractmethod) defaultdict)IterableIterator)partialwraps)
TYPE_CHECKINGAnyCallableClassVarGenericTypeVarcast)default_environment)InvalidRequirement Requirement)InvalidVersionVersion )_static)StrPath) FileError OptionError) SetuptoolsDeprecationWarning )expand) TypeAlias Distribution)DistributionMetadatar SingleCommandOptionsAllCommandOptionsTargetr r! Ffilepathr find_othersboolignore_option_errorsreturndictc ddl m} | }|r| ng }t || || }t | S )a, Read given configuration file and returns options from it as a dict.
:param str|unicode filepath: Path to configuration file
to get options from.
:param bool find_others: Whether to search for other configuration files
which could be on in various places.
:param bool ignore_option_errors: Whether to silently ignore
options, values of which could not be resolved (e.g. due to exceptions
in directives such as file:, attr:, etc.).
If False exceptions are propagated as expected.
:rtype: dict
r r )setuptools.distr find_config_files_applyconfiguration_to_dict)r% r& r( r dist filenameshandlerss Q/opt/cloudlinux/venv/lib64/python3.11/site-packages/setuptools/config/setupcfg.pyread_configurationr4 3 s^ $ -,,,,, <>>D,7?&&(((RIdHi1EFFH * ** r0 c N t | | | | S )z`Apply the configuration from a ``setup.cfg`` file into an existing
distribution object.
)r. _finalize_requires)r0 r% s r3 apply_configurationr8 M s+ 4 Kr5 other_filesIterable[StrPath]2tuple[ConfigMetadataHandler, ConfigOptionsHandler]c f ddl m} t j | }t j | st
d| d t j }t j t j | g ||} |
| t t t | t | | j | }| t j | n# t j | w xY w|S )zHRead configuration from ``filepath`` and applies to the ``dist`` object.r )
_DistributionzConfiguration file z does not exist.)r1 )r( )r, r> ospathabspathisfiler getcwdchdirdirnameparse_config_filesr liststrparse_configurationcommand_options_finalize_license_files)r0 r% r: r( r> current_directoryr1 r2 s r3 r. r. V s" .-----wx((H
7>>( # # JHhHHHIII HRW__X
&
&'''(+(x(I$((d3i9S9S(TTT& $&=Q
$$&&&
"####"#### Os
#A D D.
target_obj#Distribution | DistributionMetadatakeyrH c x d| }t j t | | }t | || } | S )z
Given a target object and option key, get that option from
the target object, either through a get_{key} method or
from an attribute directly.
get_) functoolsr getattr)rM rO getter_name by_attributegetters r3 _get_optionrW u s? ,,K $Wj#>>L
Zl
;
;F 688Or5 r2 KIterable[ConfigHandler[Distribution] | ConfigHandler[DistributionMetadata]]c t t }| D ]1}|j D ]'}t |j | }|||j |< (2|S )zReturns configuration data gathered by given handlers as a dict.
:param Iterable[ConfigHandler] handlers: Handlers list,
usually from parse_configuration()
:rtype: dict
)r r* set_optionsrW rM section_prefix)r2 config_dicthandleroptionvalues r3 r/ r/ sk $D))K @ @ ) @ @F 2F;;E:?K. / 7 7 @ r5 distributionrJ c t j | 5 }t | ||| }| | j s |j | _ t | j |||| j | j }| | j |j |j ddd n # 1 swxY w Y ||fS )a Performs additional parsing of configuration options
for a distribution.
Returns a list of used option handlers.
:param Distribution distribution:
:param dict command_options:
:param bool ignore_option_errors: Whether to silently ignore
options, values of which could not be resolved (e.g. due to exceptions
in directives such as file:, attr:, etc.).
If False exceptions are propagated as expected.
:rtype: list
N)
r EnsurePackagesDiscoveredConfigOptionsHandlerparse package_dirConfigMetadataHandlermetadatasrc_root_referenced_filesupdate)r` rJ r( ensure_discoveredoptionsmetas r3 rI rI s $
( 6 6
:K&
' ;'.':L $$ ! $ !
&-- %t'=
+
2 =s BB77B;>B;label
orig_valueparsedrG c d|v st dk rdS t } t d }|j |v r$t
| d dS dS # t $ rX}t fd|D r2t
| d }t | |Y d}~dS d}~ww xY w)am Because users sometimes misinterpret this configuration:
[options.extras_require]
foo = bar;python_version<"4"
It looks like one requirement with an environment marker
but because there is no newline, it's parsed as two requirements
with a semicolon as separator.
Therefore, if:
* input string does not contain a newline AND
* parsed result contains two requirements AND
* parsing of the two parts from the result (";")
leads in a valid Requirement with a valid marker
a UserWarning is shown to inform the user about the possible problem.
r Nr )fieldreqc 3 N K | ] }d | V dS )r N
startswith).0markerrp s r3 z8_warn_accidental_env_marker_misconfig.. s5 BBvay##F++BBBBBBr5 )
len
marker_envkeysr name_AmbiguousMarkeremitr anymessage)rn ro rp markersrt exmsgs ` r3 %_warn_accidental_env_marker_misconfigr s " zS[[A - -ll !!G2&)$$ 8w ! !6!9 ! = = = = = 2 2 2 BBBB'BBB B B 2"**F1I*FFC$S))r 1 2 2 2 2 2 22s A B
C"
A
C C"c D e Zd ZU dZded< i Zded< d%dZed&d Ze e
d'd Z d(dZ ed)d Z
ed Zed Zed Zd*dZd+d Zed Zed Zed,d! Zd(d"Zd(d#Zd$ Zd S )-
ConfigHandlerz1Handles metadata supplied in configuration files.rH r[ zClassVar[dict[str, str]]aliasesrM r$ rl r# rk expand.EnsurePackagesDiscoveredr) Nonec || _ || _ t | | | _ g | _ || _ t t | _ d S N)
r( rM r* _section_optionssectionsrZ rk setrH ri )selfrM rl r( rk s r3 __init__zConfigHandler.__init__ sZ %9!", T 2 27 ; ;<<
&(!2 !$S r5 *Iterator[tuple[str, SingleCommandOptions]]c # K | D ]?\ }}| | j \ }}}|r&| d |fV @d S )N.)items partitionr[ lstrip)clsrl full_namer_ pre_sepr~ s r3 r z ConfigHandler._section_options su !(
* * Iu ' 1 1#2D E EOCt
++c""E) ) ) ) ) * *r5 dict[str, Callable]c : t | j j d ).Metadata item name to parser function mapping.z must provide .parsers property)NotImplementedError __class____name__)r s r3 parserszConfigHandler.parsers s' "~& G G G
r5 c | j }| j || } t || }n"# t $ r}t | |d }~ww xY w|rd S | j |d | }n# t f| j z $ r Y d S w xY wt j
|j | }t |d| | } || | j
| d S )Nc | S r r9 )xs r3 z+ConfigHandler.__setitem__..( s Q r5 set_)rM r getrS AttributeErrorKeyErrorr Exceptionr( rR r __setattr__rZ append) r option_namer_ rM
current_valueerp
simple_settersetters r3 __setitem__zConfigHandler.__setitem__ s' _
l&&{K@@ / #J < z-ConfigHandler._parse_list..D s- BBB%EKKMMB
BBBr5 )
isinstancerG
splitlinessplit)r r_ separators r3 _parse_listzConfigHandler._parse_list2 s\ eT " " L 5==$$&&EEKK **EBB5BBBBr5 c d}i }| | D ]\}| | \ }}}||k rt d| | || < ]|S )zPRepresents value as a dict.
:param value:
:rtype: dict
=z&Unable to parse option value to dict: )r r r r )r r_ r resultlinerO sepvals r3 _parse_dictzConfigHandler._parse_dictF s OOE** . .D NN9 5 5MCci !"R5"R"RSSS"%))++F399;;
r5 c 2 | }|dv S )zQRepresents value as boolean.
:param value:
:rtype: bool
)1trueyes)lowerr r_ s r3 _parse_boolzConfigHandler._parse_boolW s
,,,r5 c fd}|S )zReturns a parser function to make sure field inputs
are not files.
Parses a value after getting the key so error messages are
more informative.
:param key:
:rtype: callable
c d}| | rt d d t j | S )Nfile:z"Only strings are accepted for the z field, files are not accepted)rw
ValueErrorr Str)r_ exclude_directiverO s r3 parserz3ConfigHandler._exclude_files_parser..parserm sZ ' 122
- - - - ;u%% %r5 r9 )r rO r s ` r3 _exclude_files_parserz#ConfigHandler._exclude_files_parsera s# & & & & &
r5 root_dirStrPath | Nonec t d}t |t s|S | | st j | S |t | d }d | d D }| j | t j t j
|| S )aO Represents value as a string, allowing including text
from nearest files using `file:` directive.
Directive is sandboxed and won't reach anything outside
directory with setup.py.
Examples:
file: README.rst, CHANGELOG.md, src/file.txt
:param str value:
:rtype: str
r Nc 6 g | ]}| S r9 r )rx r@ s r3 r z-ConfigHandler._parse_file.. s >>>dTZZ\\>>>r5 r ) r rH rw r r r{ r ri rj r
read_files)r r_ r include_directivespec filepathss r3 _parse_filezConfigHandler._parse_filex s $%%% L 122 &;u%% %S*++--.>>djjoo>>> %%i000{6,YAABBBr5 r c d}| | st j | S | |d }| | j j t j ||| S )zRepresents value as a module attribute.
Examples:
attr: package.attr
attr: package.module.attr
:param str value:
:rtype: str
zattr: ) rw r r replacerj rk re r read_attr)r r_ re r attr_directive attr_descs r3 _parse_attrzConfigHandler._parse_attr ss ! // &;u%% %MM."55 41=>>> ;AAAr5 c fd}|S )zReturns parser function to represents value as a list.
Parses a value applying given methods one after another.
:param parse_methods:
:rtype: callable
c , | }D ]
} || }|S r r9 )r_ rp method
parse_methodss r3 rd z1ConfigHandler._get_parser_compound..parse s+ F'
(
( Mr5 r9 )r r rd s ` r3 _get_parser_compoundz"ConfigHandler._get_parser_compound s# r5 c b i }| D ]\ }\ }} ||| ||< |S )a Parses section options into a dictionary.
Applies a given parser to each option in a section.
:param dict section_options:
:param callable values_parser: function with 2 args corresponding to key, value
:rtype: dict
)r )r section_options
values_parserr_ rO _r s r3 _parse_section_to_dict_with_keyz-ConfigHandler._parse_section_to_dict_with_key sH , 2 2 4 4 1 1MC!S& sC00E#JJ r5 Nc D rfdnd }| || S )a Parses section options into a dictionary.
Optionally applies a given parser to each value.
:param dict section_options:
:param callable values_parser: function with 1 arg corresponding to option value
:rtype: dict
c | S r r9 )r vr s r3 r z6ConfigHandler._parse_section_to_dict.. s }}Q / / r5 c |S r r9 )r r s r3 r z6ConfigHandler._parse_section_to_dict.. s UV r5 )r )r r r r s ` r3 _parse_section_to_dictz$ConfigHandler._parse_section_to_dict s7 5BW/////22?FKKKr5 c | D ]>\ }\ }}t j t 5 || |< ddd n # 1 swxY w Y ?dS )zQParses configuration file section.
:param dict section_options:
N)r
contextlibsuppressr )r r r~ r r_ s r3
parse_sectionzConfigHandler.parse_section s
!0 5 5 7 7 # # D*1e$X..
#
# "T
#
#
#
#
#
#
#
#
#
#
#
#
#
#
# # #s AA A c | j D ]^\ }}d}|rd| }t | d| dd d }|t d| j d| d || _dS ) zTParses configuration file items from one
or more related sections.
r r r r __Nz*Unsupported distribution option section: [])r r rS r r r[ )r section_namer method_postfixsection_parser_methods r3 rd zConfigHandler.parse s
.2]-@-@-B-B 3 3 )L/ N
4!3\!3!35<00088dCC 6 6 ! %,!> +> >.:> > >
" !/ 2 2 2 2% 3 3r5 c D t fd }|S )zthis function will wrap around parameters that are deprecated
:param msg: deprecation message
:param func: function to be wrapped around
c f dd t j dfi | i |S )N
stacklevelr z Deprecated config in `setup.cfg`)
setdefault_DeprecatedConfigr )argskwargsfunckwr s r3 config_handlerz@ConfigHandler._deprecated_config_handler..config_handler sH MM, * * * "#Es Q Qb Q Q Q4((( (r5 )r )r r r r r s ``` r3 _deprecated_config_handlerz(ConfigHandler._deprecated_config_handler sB
t ) ) ) ) ) )
)
r5 )rM r$ rl r# rk r r) r )rl r# r) r r) r r) r )r )r r )r r r )r
__module__ __qualname____doc____annotations__r r classmethodr propertyr r r r r r r r r r r r r rd r
r9 r5 r3 r r s ;;
)+G**** " * * * [*
^ X
- - - -4 C C C [C& [ - - [- [,C C C C6B B B B( [& [
L
L
L [
L# # # #3 3 3 32
r5 r c f e Zd ZdZdddddZdZ dej fd fd
Ze d d Z
d Z xZ S ) rf rg url description classifiers platforms) home_pagesummary
classifierplatformFNrM r! rl r# r( r' rk r re dict | Noner r r) r c l t |||| || _ || _ d S r )superr re r )r rM rl r( rk re r r s r3 r z ConfigMetadataHandler.__init__ s8 W.BDUVVV&
r5 r c | | j t j }| | j t j }t
| j | j }| j }i dt j
dt j
dt j
dt j
d|d|d|d |d
| || d |d d |d
|d|dt j
d| j dt j
d|S )r r author author_email
maintainermaintainer_emailr keywordsprovides obsoletesr license
license_filesr long_description long_description_content_typeversionr project_urls) r r r Listr Dictr r r r r _parse_version)r parse_list_staticparse_dict_static
parse_fileexclude_files_parsers r3 r z ConfigMetadataHandler.parsers' s^ ! 5 5d6F U U 5 5d6F U U T -
FFF
# 9
gk
GK
'+
*
)
)
*
444ZARSS
++I66
.
:
,W[
t*
7;!
"
-#
r5 c H | || j }||k rO| } t | n(# t $ r}t d| d| |d}~ww xY w|S t
j | || j | j S )zSParses `version` option value.
:param value:
:rtype: str
zVersion loaded from z does not comply with PEP 440: N)
r r r r r r r r, r re )r r_ r, r s r3 r0 z$ConfigMetadataHandler._parse_versionC s ""5$-88 e mmooG
!
!65 6 6,36 6
N~d . .ud6F
V VWWWs A
A,A''A,)rM r! rl r# r( r' rk r re r r r r) r r )
r r
r r[ r strict_moder? curdirr r r r0
__classcell__r s @r3 rf rf
s N # G K $(#%9 ! ! ! ! ! ! !
X
6X X X X X X Xr5 rf c e Zd ZdZd fd Zed Zd
Zd dZe d d Z
d Z d Z d Z
d dZd Zd dZd dZd dZd d Z xZS )!rc rl rM r r# r( r' rk r r) r c v t |||| |j | _ i | _ d S r )r r rh r re )r rM rl r( rk r s r3 r z ConfigOptionsHandler.__init__` s= W.BDUVVV"+
+-r5 c 0 | |d S )N;)r )r r s r3 _parse_list_semicolonz*ConfigOptionsHandler._parse_list_semicolonk s u444r5 c : | || j S )Nr )r r )r r_ s r3 _parse_file_in_rootz(ConfigOptionsHandler._parse_file_in_rooto s
>>>r5 rn rH r_ c | | | }t ||| t j d |D S )Nc 3 D K | ]}| d |V dS )#Nrv )rx r s r3 rz z@ConfigOptionsHandler._parse_requirements_list..x s3 PPT4??3;O;OPDPPPPPPr5 )r> r@ r r r. )r rn r_ rp s r3 _parse_requirements_listz-ConfigOptionsHandler._parse_requirements_listr sV ++D,D,DU,K,KLL-eUFCCC |PPVPPPPPPr5 r c | j }| j }| j }||| j |||| |d t | j d | j | j | j |t j |dS )r zeThe namespace_packages parameter is deprecated, consider using implicit namespaces instead (PEP 420).install_requires)zip_safeinclude_package_datare scriptseager_resourcesdependency_linksnamespace_packagesrF setup_requirespackages entry_points
py_modulespython_requirescmdclass) r r _parse_cmdclassr r
r rD r> _parse_packagesr@ r SpecifierSet)r
parse_list
parse_boolparse_cmdclasss r3 r z ConfigOptionsHandler.parsers{ s %
%
- #$. +! ) *"&"A"AH# # !(-/A! ! # 8 , 4$ & 3&+
r5 c v | j j }t j | | || j S r )rk re r rR r r )r r_ re s r3 rS z$ConfigOptionsHandler._parse_cmdclass s1 ,8 t / / 6 6 T]SSSr5 c : ddg}| }||vr| | S | | j di }| ||d k | j | j t j di |S )zTParses `packages` option value.
:param value:
:rtype: list
zfind:zfind_namespace:z
packages.findr )
namespacesr fill_package_dirr9 )
r r parse_section_packages__findr r rj r re r
find_packages)r r_ find_directives
trimmed_value find_kwargss r3 rT z$ConfigOptionsHandler._parse_packages s #$56
/ /##E** * 77 M or 2 2
% );;] ! -
#22k222r5 c | || j }g dfd| D }| d }| |d |d< |S )zParses `packages.find` configuration file section.
To be used in conjunction with _parse_packages().
:param dict section_options:
)whereincludeexcludec ( i | ]\ }}|v | ||S r9 r9 )rx kr
valid_keyss r3
zEConfigOptionsHandler.parse_section_packages__find.. s) VVV1ZTUq!r5 rc Nr )r r r r )r r section_datara rc rh s @r3 r] z1ConfigOptionsHandler.parse_section_packages__find sx 22?DDTUU 444
VVVV (:(:(<(<VVV (( #(8K r5 c F | || j }|| d< dS )z`Parses `entry_points` configuration file section.
:param dict section_options:
rO N)r r r r rp s r3 parse_section_entry_pointsz/ConfigOptionsHandler.parse_section_entry_points s,
,,_d>NOO %^ r5 c ` | || j }t j | S r )r r r canonic_package_data)r r package_datas r3 _parse_package_dataz(ConfigOptionsHandler._parse_package_data s+ 22?DDTUU *<888r5 c 6 | | | d< dS )z`Parses `package_data` configuration file section.
:param dict section_options:
rp Nrq r r s r3 parse_section_package_dataz/ConfigOptionsHandler.parse_section_package_data s"
$ 7 7 H H^ r5 c 6 | | | d< dS )zhParses `exclude_package_data` configuration file section.
:param dict section_options:
exclude_package_dataNrs rt s r3 "parse_section_exclude_package_dataz7ConfigOptionsHandler.parse_section_exclude_package_data s#
(,'?'?'P'P
#$$$r5 c h | fd }t j | d< dS )zbParses `extras_require` configuration file section.
:param dict section_options:
c 8 d| d| S )Nzextras_require[r )rD )rg r r s r3 r zCConfigOptionsHandler.parse_section_extras_require.. s# 667M7M7M7MqQQ r5 extras_requireN)r r r/ rl s ` r3 parse_section_extras_requirez1ConfigOptionsHandler.parse_section_extras_require sF
55 Q Q Q Q
") f!5!5
r5 c v | || j }t j || j | d< dS )z^Parses `data_files` configuration file section.
:param dict section_options:
data_filesN)r r r canonic_data_filesr rl s r3 parse_section_data_filesz-ConfigOptionsHandler.parse_section_data_files s;
,,_d>NOO # 6vt} M M\r5 )
rM r rl r# r( r' rk r r) r )rn rH r_ rH r r )r r
r r[ r r r> r@ rD r r rS rT r] rm rq ru rx r| r r8 r9 s @r3 rc rc ] sW N . . . . . . 5 5 [5? ? ?Q Q Q Q
X
<T T T3 3 32 $& & & &9 9 9I I I IQ Q Q Q
6
6
6
6N N N N N N N Nr5 rc c 0 e Zd ZdZdZdZed ZdS )r z Ambiguous requirement marker.z
One of the parsed requirements in `{field}` looks like a valid environment marker:
{req!r}
Please make sure that the configuration file is correct.
You can use dangling lines to avoid this problem.
z'userguide/declarative_config.html#opt-2c \ d| j }| | j | j || S )Nz%https://setuptools.pypa.io/en/latest/)see_url format_args) _SEE_DOCS_format_SUMMARY_DETAILS)r r docss r3 r z_AmbiguousMarker.message s0 Fs}FF{{3< tQS{TTTr5 N)r r
r r r r r r r9 r5 r3 r r sG .HH :I U U [U U Ur5 r c e Zd ZdZdS )r z!userguide/declarative_config.htmlN)r r
r r r9 r5 r3 r r
s 3IIIr5 r )FF)r% r r& r' r( r' r) r* )r0 r r% r r) r )r9 F)
r0 r r% r r: r; r( r' r) r< )rM rN rO rH )r2 rX r) r* )F)r` r rJ r# r( r' r) r< )rn rH ro rH rp rG )Cr
__future__r r rR r? abcr collectionsr collections.abcr r r r typingr
r r r
r r r packaging.markersr r| packaging.requirementsr r packaging.versionr r r r _pathr errorsr r warningsr r typing_extensionsr r, r distutils.distr! r* rH tupler" r r# r$ r4 r8 r. rW r/ rI r r rf rc r r r9 r5 r3 r s # " " " " " # # # # # # . . . . . . . . $ $ $ $ $ $ $ $ Q Q Q Q Q Q Q Q Q Q Q Q Q Q Q Q Q Q ? ? ? ? ? ? B B B B B B B B 5 5 5 5 5 5 5 5 + + + + + + + + 3 3 3 3 3 3 4++++++,,,,,,333333"&sE#s(O';"< < < < <
$C)=$= > > > > > >+A B B PU+ + + + +4 &(!& > 2 "'+ + + + +\ 2 2 2 2@b b b b b GFO b b b J PX PX PX PX PXM*@ A PX PX PXfYN YN YN YN YN= 8 YN YN YNxU U U U U3 U U U(4 4 4 4 44 4 4 4 4 4r5