_ic d Z ddlZddlZddlZddlmZ ddlmZ ddlmZ ddlm Z m
Z
m Z m Z m
Z
mZmZmZmZmZmZmZ ddlmZmZ dd lmZ dd
lm Z m Z dd l m Z dd l m!Z!m"Z" dd
l#m$Z$ ddl%m&Z& e r ddl'm(Z( ddl)m*Z* ee+ejX f Z-e dede f f Z. e de.f Z/ eded Z0 d8de-de1fdZ2ddde-ddfdZ3 d9ddde-d ee- d e4ded f
d Z5d e0d!e+fd"Z6d#ed de1fd$Z7 d:d%dd&e/ded' fd(Z8d)e+d*e+d+e9fd,Z: G d- d.e
e0 Z; G d/ d0e;d1 Z< G d2 d3e;d Z= G d4 d5e$ Z> G d6 d7e$ Z?y);a<
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``.
N) defaultdict)partialwraps)
TYPE_CHECKINGCallableAnyDictGenericIterableListOptionalSetTupleTypeVarUnion ) FileError OptionError)default_environment)InvalidRequirement Requirement) SpecifierSet)InvalidVersionVersion) SetuptoolsDeprecationWarning )expand)DistributionMetadata DistributionstrTarget)r! r )boundfilepathreturnc v ddl m} | }|r|j 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% find_othersignore_option_errorsr! dist filenameshandlerss /builddir/build/BUILDROOT/alt-python312-setuptools-69.0.2-3.el8.x86_64/opt/alt/python312/lib/python3.12/site-packages/setuptools/config/setupcfg.pyread_configurationr2 8 s< $ - >D,7&&(RIdHi1EFH ** r. r! c > t | | | j | S )z`Apply the configuration from a ``setup.cfg`` file into an existing
distribution object.
)r* _finalize_requires)r. r% s r1 apply_configurationr6 R s 4 Kr3 other_filesr- )
ConfigHandler.c ddl m} t j j | }t j j | st
d| d t j }t j t j j | g ||} |j | | t | | j | }| j t j | |S # t j | w xY w)zHRead configuration from ``filepath`` and applies to the ``dist`` object.r )
_DistributionzConfiguration file z does not exist.)r/ )r- )r( r: ospathabspathisfiler getcwdchdirdirnameparse_config_filesparse_configurationcommand_options_finalize_license_files)r. r% r7 r- r: current_directoryr/ r0 s r1 r* r* [ s .wwx(H
77>>( #-hZ7GHII HHRWW__X
&'(+(x(I$(((C& $&&=Q
$$&
"# O "#s !;C3 3D
target_objkeyc j 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)rG rH getter_name by_attributegetters r1 _get_optionrP y s8 ,K $$Wj#>L
Zl
;F 8Or3 r0 c t t }| D ]; }|j D ]* }t |j | }|||j
|< , = |S )zReturns configuration data gathered by given handlers as a dict.
:param list[ConfigHandler] handlers: Handlers list,
usually from parse_configuration()
:rtype: dict
)r dict set_optionsrP rG section_prefix)r0 config_dicthandleroptionvalues r1 r+ r+ sW $D)K ))F 2 2F;E:?K.. / 7 *
r3 distributionrD )ConfigMetadataHandlerConfigOptionsHandlerc t j | 5 }t | ||| }|j | j s|j | _ t | j |||| j | j }|j | j j |j |j ddd ||fS # 1 sw Y fS xY w)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 EnsurePackagesDiscoveredr[ parse package_dirrZ metadatasrc_root_referenced_filesupdate)rY rD r- ensure_discoveredoptionsmetas r1 rC rC s $
( ( 6:K&
'''.':':L $$ ! ! $ $ ! !
&&-- % %t'='=
+
72 =3
72 =s B*C Clabel
orig_valueparsedc l d|v st dk7 ryt j } t d }|j |v rt
j
| d yy# t $ rD}t fd|D r&t
j | d }t | |Y d}~yd}~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 F K | ] }d j | yw)r N)
startswith).0markerri s r1 z8_warn_accidental_env_marker_misconfig.. s! B'vay##F+'s !)
len
marker_envkeysr name_AmbiguousMarkeremitr anymessage)rg rh ri markersrm exmsgs ` r1 %_warn_accidental_env_marker_misconfigr~ s " zS[A -l !G2&)$ 88w ! !6!9 ! = 2 B'B B"**F1I*FC$S)r 1 C2s 6A& & B3/:B..B3c * e Zd ZU dZeed< i Zeeef ed< dede de
j fdZ e
de fd Zed Zd
Ze
dd Ze
d Ze
d
Ze
d ZdefdZdefdZe
d Ze
d Ze
dd Zd Z d Z d Z y)r8 z1Handles metadata supplied in configuration files.rT aliasesrG re rd c || _ || _ t | j | | _ g | _ || _ t | _ y N) r- rG rR _section_optionssectionsrS rd setrb )selfrG re r- rd s r1 __init__zConfigHandler.__init__ sI %9!$ T 2 27 ;<
&(!2 +.5 r3 c # K |j D ]< \ }}|j | j \ }}}|r(|j d |f > y w)N.)items partitionrT lstrip)clsre full_namerX preseprv s r1 r z ConfigHandler._section_options sQ '
Iu & 0 01C1C DNCd++c"E) ) !0s AAc F t d| j j z ).Metadata item name to parser function mapping.z!%s must provide .parsers property)NotImplementedError __class____name__)r s r1 parserszConfigHandler.parsers s# " /$..2I2I I
r3 c | j }| j j || } t || }|ry | j j |d | }t j |j | }t |d|z | } || | j j | y # t $ r t | w xY w# t f| j z $ r Y y w xY w)Nc | S r )xs r1 z+ConfigHandler.__setitem__..% s Qr3 zset_%s)rG r getrL AttributeErrorKeyErrorr Exceptionr- rK r __setattr__rS append)r option_namerX rG
current_valueri
simple_settersetters r1 __setitem__zConfigHandler.__setitem__ s __
ll&&{K@ ( #J .parserj s: ' 12 --3VC[ Lr3 r )r rH r s ` r1 _exclude_files_parserz#ConfigHandler._exclude_files_parser^ s
r3 root_dirc 0 d}t |t s|S |j | s|S |t | d }|j d D cg c] }|j }}| j j | t j || S c c}w )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 N,)
r r" ro rs r r rb rc r
read_files)r rX r include_directivespecr< filepathss r1 _parse_filezConfigHandler._parse_fileu s $%%L 12LS*+-..2jjo>odTZZ\o > %%i0 H55 ?s Bc d}|j | s|S |j |d }|j | 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: )ro replacerc rd r_ r read_attr)r rX r_ r attr_directive attr_descs r1 _parse_attrzConfigHandler._parse_attr s] ! /LMM."5 411==> ;AAr3 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 r )rX ri method
parse_methodss r1 r^ z1ConfigHandler._get_parser_compound..parse s" F' ( Mr3 r )r r r^ s ` r1 _get_parser_compoundz"ConfigHandler._get_parser_compound s r3 c X i }|j 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_parserrX rH _r s r1 _parse_section_to_dict_with_keyz-ConfigHandler._parse_section_to_dict_with_key s9 , 2 2 4MC!S&sC0E#J 5 r3 Nc < rfdnd }| j || 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 r )r vr s r1 r z6ConfigHandler._parse_section_to_dict.. s
}Q /r3 c |S r r )r r s r1 r z6ConfigHandler._parse_section_to_dict.. s UVr3 r )r r r r s ` r1 _parse_section_to_dictz$ConfigHandler._parse_section_to_dict s# 5B/22?FKKr3 c |j D ]/ \ }\ }}t j t 5 || |< ddd 1 y# 1 sw Y
"/ 2% .Cr3 c 6 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 j dd t j dfi | i |S )N
stacklevelr z Deprecated config in `setup.cfg`)
setdefault_DeprecatedConfigrx )argskwargsfunckwr} s r1 config_handlerz@ConfigHandler._deprecated_config_handler..config_handler s7 MM, * " "#Es Qb Q(( (r3 r )r r r} r r s ``` r1 _deprecated_config_handlerz(ConfigHandler._deprecated_config_handler s#
t )
)
r3 )r r ) r
__module__ __qualname____doc__r" __annotations__r r
r# AllCommandOptionsr r] r classmethodr propertyr r r r r r _Pathr r r r r r r^ r r r3 r1 r8 r8 s> ;
!GT#s(^ #
":: " *'8 * *
-4 C C& - - ,65 64B B( &
L
L#32
r3 r8 c
e Zd ZdZdddddZdZ dej fd d
d ed e d
e
j de e
def fd
Zed Zd Z xZS )rZ r` url description classifiers platforms) home_pagesummary
classifierplatformFNrG r re r- rd r_ r c F t | |||| || _ || _ y r )superr r_ r )r rG re r- rd r_ r r s r1 r z ConfigMetadataHandler.__init__ s) W.BDUV&
r3 c | j }t | j | j }| j }| j
}||||| j
|| |d |||| j |d S )r r license) r keywordsprovides obsoletesr r
license_filesr long_descriptionversion project_urls)r r r r r r r _parse_version)r
parse_list
parse_file
parse_dictexclude_files_parsers r1 r z ConfigMetadataHandler.parsers# s %%
T - -
F
%%
# 9 9 $""# 44ZL+I6 '% *** &
r3 c 0 | j || j }||k7 r |j } t | |S t
j | j || j | j S # t $ r t d| d| w xY w)zSParses `version` option value.
:param value:
:rtype: str
zVersion loaded from z does not comply with PEP 440: )
r r r r r r r r r r_ )r rX r s r1 r z$ConfigMetadataHandler._parse_version9 s ""5$--8 e mmoG
N~~d . .ud6F6F
VWW "
!*5' 2,,396
s A: :B)r r r rT r strict_moder; curdirr boolr r] r rR r r r r r
__classcell__r s @r1 rZ rZ s N # G K '+ )) !* ! # ! # !
":: ! d^
! !
*Xr3 rZ r c e Zd ZdZdddededej f fd Ze d Z
d Z d e d
e fd Z
ed Zd
Zd Zd Zd Zd Zd Zd Zd Zd Z xZS )r[ re rG r! r- rd c Z t | |||| |j | _ i | _ y r )r r ra r r_ )r rG re r- rd r s r1 r z ConfigOptionsHandler.__init__V s/ W.BDUV"++
+-r3 c ( | j |d S )N;)r )r r s r1 _parse_list_semicolonz*ConfigOptionsHandler._parse_list_semicolona s u44r3 c < | j || j S )Nr
)r r )r rX s r1 _parse_file_in_rootz(ConfigOptionsHandler._parse_file_in_roote s
>>r3 rg rX c | j | j | }t ||| |D cg c] }|j d r| c}S c c}w )N#)r% r' r~ ro )r rg rX ri r s r1 _parse_requirements_listz-ConfigOptionsHandler._parse_requirements_listh sN ++D,D,DU,KL-eUFC "(Dts/CDDDs A Ac & | j }| j }| j }| j }||||||| j |d t | j d | j | j | j | j |t |dS )r zeThe namespace_packages parameter is deprecated, consider using implicit namespaces instead (PEP 420).install_requires)zip_safeinclude_package_datar_ scriptseager_resourcesdependency_linksnamespace_packagesr, setup_requires
tests_requirepackages entry_points
py_modulespython_requirescmdclass) r r r _parse_cmdclassr r r* r% _parse_packagesr' r )r r
parse_boolr parse_cmdclasss r1 r z ConfigOptionsHandler.parsersp s %%
%%
%%
-- #$.%! ) *"&"A"AH# !(--/A! # 8 8 ! 7 7 ,, 4 4$ +&-
r3 c | j j }t j | j | || j
S r )rd r_ r r9 r r )r rX r_ s r1 r: z$ConfigOptionsHandler._parse_cmdclass s5 ,,88 t / / 6 T]]SSr3 c 0 ddg}|j }||vr| j | S | j | j j di }|j ||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_dirr )
r r parse_section_packages__findr r rc r r_ r
find_packages)r rX find_directives
trimmed_value find_kwargss r1 r; z$ConfigOptionsHandler._parse_packages s #$56
/##E* * 77 MM or 2
% );;]] ! - -
##2k22r3 c | j || j }g d}t |j D cg c] \ }}||v s |s||f c}} }|j d }||d |d< |S c c}}w )zParses `packages.find` configuration file section.
To be used in conjunction with _parse_packages().
:param dict section_options:
)whereincludeexcluderH r )r r rR r r )r r section_data
valid_keyskr rF rH s r1 rB z1ConfigOptionsHandler.parse_section_packages__find s 22?DDTDTU 4
, 2 2 4 N 41ZAaV 4 N
( #(8K
Os A4
A4
A4
c F | j || j }|| d< y)z`Parses `entry_points` configuration file section.
:param dict section_options:
r6 N)r r r r ri s r1 parse_section_entry_pointsz/ConfigOptionsHandler.parse_section_entry_points s&
,,_d>N>NO %^ r3 c d | j || j }t j | S r )r r r canonic_package_data)r r package_datas r1 _parse_package_dataz(ConfigOptionsHandler._parse_package_data s+ 22?DDTDTU **<88r3 c , | j | | d< y)z`Parses `package_data` configuration file section.
:param dict section_options:
rS NrT r r s r1 parse_section_package_dataz/ConfigOptionsHandler.parse_section_package_data s
$ 7 7 H^ r3 c , | j | | d< y)zhParses `exclude_package_data` configuration file section.
:param dict section_options:
exclude_package_dataNrV rW s r1 "parse_section_exclude_package_dataz7ConfigOptionsHandler.parse_section_exclude_package_data s
(,'?'?'P
#$r3 c : j | fd }| d< y)zbParses `extras_require` configuration file section.
:param dict section_options:
c 0 j d| d| S )Nzextras_require[r )r* )rM r r s r1 r zCConfigOptionsHandler.parse_section_extras_require.. s 66 17MqQr3 extras_requireNr rO s ` r1 parse_section_extras_requirez1ConfigOptionsHandler.parse_section_extras_require s(
55 Q
"(
r3 c | j || j }t j || j | d< y)z^Parses `data_files` configuration file section.
:param dict section_options:
data_filesN)r r r canonic_data_filesr rO s r1 parse_section_data_filesz-ConfigOptionsHandler.parse_section_data_files s7
,,_d>N>NO # 6 6vt}} M\r3 )r r r rT r r r r] r r r% r' r" r* r r r: r; rB rP rT rX r[ r_ rc r r s @r1 r[ r[ S s N ." . # . # .
":: . 5 5?Ec E# E
@T32*&9IQ
(Nr3 r[ c ( e Zd ZdZdZdZed Zy)rw 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 r d| j }| j | j | j || S )Nz%https://setuptools.pypa.io/en/latest/)see_url format_args) _SEE_DOCS_format_SUMMARY_DETAILS)r r docss r1 rz z_AmbiguousMarker.message s2 6s}}oF{{3<< tQS{TTr3 N)r r r rj rk rh r rz r r3 r1 rw rw s+ .HH :I U Ur3 rw c e Zd ZdZy)r z!userguide/declarative_config.htmlN)r r r rh r r3 r1 r r s 3Ir3 r )FF)r F)F)@r r rK r; collectionsr r r typingr r r r
r r r
r r r r r errorsr r extern.packaging.markersr rt extern.packaging.requirementsr r extern.packaging.specifiersr extern.packaging.versionr r warningsr r r distutils.distr r( r! r" PathLiker SingleCommandOptionsr r# rR r2 r6 r r* rP r+ rC r r~ r8 rZ r[ rw r r r3 r1 ry s #
, H K 6 > 3 3,
c2;; E5#4 45
445 'M!N O >C++ +4n . $&!&
%
< F E*>$? D * + +&+ :; +\ 2 2# 2t 2@^ GFO ^ B JXM*@ A JXZ\N= 8 \N~U3 U(44 4r3