o 5hg@sUdZddlmZddlZddlZddlZddlmZddlm Z m Z ddlm Z m Z ddl mZmZmZmZmZmZmZddlmZdd lmZmZdd lmZmZd d lmZd d l m!Z!d dl"m#Z#m$Z$d dl%m&Z&ddlm'Z'erddl(m)Z)ddl*m+Z+ddl,m-Z-e.e/e0e/effZ1de2d< e.e/e1fZ3de2d< edddZ4 dLdMd#d$Z5dNd&d'Z6 ( dOdPd,d-Z7dQd2d3Z8dRd6d7Z9 dSdTd:d;Z:dUd@dAZ;GdBdCdCee4ZGdHdIdIe&Z?GdJdKdKe&Z@dS)Va< 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) defaultdict)IterableIterator)partialwraps) TYPE_CHECKINGAnyCallableClassVarGenericTypeVarcast)default_environment)InvalidRequirement Requirement)InvalidVersionVersion)_static)StrPath) FileError OptionError)SetuptoolsDeprecationWarning)expand) TypeAlias Distribution)DistributionMetadatarSingleCommandOptionsAllCommandOptionsTargetrrFfilepathr find_othersboolignore_option_errorsreturndictcCs8ddlm}|}|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 rr)setuptools.distrZfind_config_files_applyconfiguration_to_dict)r#r$r&rdist filenameshandlersr/:lib/python3.10/site-packages/setuptools/config/setupcfg.pyread_configuration2s r1r,cCst||||S)z`Apply the configuration from a ``setup.cfg`` file into an existing distribution object. )r*Z_finalize_requires)r,r#r/r/r0apply_configurationLs r2r/ other_filesIterable[StrPath]2tuple[ConfigMetadataHandler, ConfigOptionsHandler]c Csddlm}tj|}tj|std|dt}ttj |g||}z |j |t t t |dt||j|d}|Wt||St|w)zHRead configuration from ``filepath`` and applies to the ``dist`` object.r) _DistributionzConfiguration file z does not exist.)r-)r&)r)r6ospathabspathisfilergetcwdchdirdirnameZparse_config_filesrliststrparse_configurationcommand_optionsZ_finalize_license_files)r,r#r3r&r6Zcurrent_directoryr-r.r/r/r0r*Us       r* target_obj#Distribution | DistributionMetadatakeyr?cCs*d|}tt||}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. Zget_) functoolsrgetattr)rBrDZ getter_nameZ by_attributegetterr/r/r0 _get_optionts  rHr.KIterable[ConfigHandler[Distribution] | ConfigHandler[DistributionMetadata]]cCs<tt}|D]}|jD]}t|j|}|||j|<q q|S)zReturns configuration data gathered by given handlers as a dict. :param Iterable[ConfigHandler] handlers: Handlers list, usually from parse_configuration() :rtype: dict )rr( set_optionsrHrBsection_prefix)r.Z config_dictZhandleroptionvaluer/r/r0r+s   r+ distributionrAcCst|6}t||||}||js|j|_t|j||||j|j}||j |j|jWd||fS1s>wY||fS)aPerforms 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) rZEnsurePackagesDiscoveredConfigOptionsHandlerparse package_dirConfigMetadataHandlermetadatasrc_root_referenced_filesupdate)rNrAr&ensure_discoveredoptionsmetar/r/r0r@s4  r@label orig_valueparsedr>c sd|vs tdkr dSt}ztd}|j|vr)tj|ddWdSWdStyW}z tfdd|DrLtj |dd}t||WYd}~dSd}~ww)amBecause 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.  rNr)Zfieldreqc3s|] }d|VqdS)rN startswith).0Zmarkerr\r/r0 z8_warn_accidental_env_marker_misconfig..) len marker_envkeysrname_AmbiguousMarkeremitranymessage)rZr[r\Zmarkersr^exmsgr/rbr0%_warn_accidental_env_marker_misconfigs    roc@seZdZUdZded< iZded< d4ddZed5ddZe ddZ d6ddZ ed7ddZ eddZ eddZeddZd8d"d#Zd9d%d&Zed'd(Zed)d*Zed:d,d-Zd6d.d/Zd6d0d1Zd2d3Zd+S); ConfigHandlerz1Handles metadata supplied in configuration files.r?rKzClassVar[dict[str, str]]aliasesrBr"rXr!rWexpand.EnsurePackagesDiscoveredr'NonecCs8||_||_t|||_g|_||_tt|_ dSN) r&rBr(_section_optionssectionsrJrWsetr?rUselfrBrXr&rWr/r/r0__init__s zConfigHandler.__init__*Iterator[tuple[str, SingleCommandOptions]]ccs@|D]\}}||j\}}}|rq|d|fVqdS)N.)items partitionrKlstrip)clsrXZ full_namerMZpreZ_seprhr/r/r0ruszConfigHandler._section_optionscCst|jjd).Metadata item name to parser function mapping.z must provide .parsers property)NotImplementedError __class____name__ryr/r/r0parserss zConfigHandler.parsersc Cs|j}|j||}zt||}Wnty"}zt||d}~ww|r'dSz |j|dd|}Wntf|jyBYdSwt |j |}t|d||}|||j |dS)NcSs|Srtr/)xr/r/r0&z+ConfigHandler.__setitem__..Zset_)rBrqgetrFAttributeErrorKeyErrorr Exceptionr&rEr __setattr__rJappend) ryZ option_namerMrBZ current_valueer\Z simple_settersetterr/r/r0 __setitem__s& zConfigHandler.__setitem__,cCs8t|tr|Sd|vr|}n||}dd|DS)zRepresents value as a list. Value is split either by separator (defaults to comma) or by lines. :param value: :param separator: List items separator character. :rtype: list r]cSsg|] }|r|qSr/strip)rachunkr/r/r0 Bsz-ConfigHandler._parse_list..) isinstancer> splitlinessplit)rrM separatorr/r/r0 _parse_list0s   zConfigHandler._parse_listcCsRd}i}||D]}||\}}}||krtd||||<q |S)zPRepresents value as a dict. :param value: :rtype: dict =z&Unable to parse option value to dict: )rr~rr)rrMrresultlinerDsepvalr/r/r0 _parse_dictDszConfigHandler._parse_dictcCs|}|dvS)zQRepresents value as boolean. :param value: :rtype: bool )1trueZyes)lowerrrMr/r/r0 _parse_boolUszConfigHandler._parse_boolcfdd}|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 cs(d}||rtddt|S)Nfile:z"Only strings are accepted for the z field, files are not accepted)r` ValueErrorrStr)rMZexclude_directiverDr/r0parserks    z3ConfigHandler._exclude_files_parser..parserr/)rrDrr/rr0_exclude_files_parser_s  z#ConfigHandler._exclude_files_parserroot_dirStrPath | NonecCshd}t|ts |S||st|S|t|d}dd|dD}|j|tt ||S)aORepresents 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 rNcSsg|]}|qSr/r)rar8r/r/r0rz-ConfigHandler._parse_file..r) rr?r`rrrerrUrVrZ read_files)ryrMrZinclude_directivespecZ filepathsr/r/r0 _parse_filevs    zConfigHandler._parse_filercCs@d}||s t|S||d}||jjt|||S)zRepresents value as a module attribute. Examples: attr: package.attr attr: package.module.attr :param str value: :rtype: str zattr:) r`rrreplacerVrWrQrZ read_attr)ryrMrQrZattr_directiveZ attr_descr/r/r0 _parse_attrs    zConfigHandler._parse_attrcr)zReturns parser function to represents value as a list. Parses a value applying given methods one after another. :param parse_methods: :rtype: callable cs|}D]}||}q|Srtr/)rMr\method parse_methodsr/r0rPs z1ConfigHandler._get_parser_compound..parser/)rrrPr/rr0_get_parser_compounds z"ConfigHandler._get_parser_compoundcCs,i}|D] \}\}}|||||<q|S)aParses 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})rsection_options values_parserrMrD_rr/r/r0_parse_section_to_dict_with_keys z-ConfigHandler._parse_section_to_dict_with_keyNcs$rfddndd}|||S)aParses 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 cs|Srtr/rvrr/r0rsz6ConfigHandler._parse_section_to_dict..cSs|Srtr/rr/r/r0rr)r)rrrrr/rr0_parse_section_to_dicts z$ConfigHandler._parse_section_to_dictc CsL|D]\}\}}tt |||<Wdn1swYqdS)zQParses configuration file section. :param dict section_options: N)r} contextlibsuppressr)ryrrhrrMr/r/r0 parse_sections   zConfigHandler.parse_sectioncCsl|jD].\}}d}|rd|}t|d|ddd}|dur/td|jd|d||qdS) zTParses configuration file items from one or more related sections. rrrr|__Nz*Unsupported distribution option section: [])rvr}rFrrrK)ryZ section_namerZmethod_postfixZsection_parser_methodr/r/r0rPs&  zConfigHandler.parsec stfdd}|S)zthis function will wrap around parameters that are deprecated :param msg: deprecation message :param func: function to be wrapped around cs.ddtjdfi|i|S)N stacklevelrz Deprecated config in `setup.cfg`) setdefault_DeprecatedConfigrj)argskwargsfunckwrnr/r0config_handlers z@ConfigHandler._deprecated_config_handler..config_handler)r)ryrrnrrr/rr0_deprecated_config_handlersz(ConfigHandler._deprecated_config_handler)rBr"rXr!rWrrr'rs)rXr!r'r{r'rs)r)rr)rrrt)r __module__ __qualname____doc____annotations__rqrz classmethodrupropertyrrrrrrrrrrrrrPrr/r/r/r0rps>                rpcsReZdZdZdddddZdZ dejfdfdd Ze ddZ ddZ Z S)rRrSurl description classifiers platforms)Z home_pageZsummaryZ classifierplatformFNrBrrXr!r&r%rWrrrQ dict | Nonerrr'rscs"t||||||_||_dSrt)superrzrQr)ryrBrXr&rWrQrrr/r0rzs  zConfigMetadataHandler.__init__cCs||jtj}||jtj}t|j|jd}|j }idtj dtj dtj dtj d|d|d|d |d |||d |d d |d |d|dtj d|j dtj d|S)rrZauthorZ author_emailZ maintainerZmaintainer_emailrkeywordsZprovidesZ obsoletesrlicenseZ license_filesrZlong_descriptionZlong_description_content_typeversionrZ project_urls) rrrListrDictrrrrr_parse_version)ryZparse_list_staticZparse_dict_staticZ parse_fileZexclude_files_parserr/r/r0r%sN     zConfigMetadataHandler.parsersc Cst|||j}||kr.|}zt|W|Sty-}z td|d||d}~wwt|||j |jS)zSParses `version` option value. :param value: :rtype: str zVersion loaded from z does not comply with PEP 440: N) rrrrrrrrrrQ)ryrMrrr/r/r0rAs" z$ConfigMetadataHandler._parse_version)rBrrXr!r&r%rWrrrQrrrr'rs) rrrrKrqZ strict_moder7curdirrzrrr __classcell__r/r/rr0rRs  rRcseZdZdZd*fd d Zed dZddZd+ddZe ddZ ddZ ddZ ddZ d,ddZd d!Zd,d"d#Zd,d$d%Zd,d&d'Zd,d(d)ZZS)-rOrXrBrr!r&r%rWrrr'rscs$t|||||j|_i|_dSrt)rrzrTrrQrxrr/r0rz^s zConfigOptionsHandler.__init__cCs|j|ddS)N;)r)rrr/r/r0_parse_list_semicolonisz*ConfigOptionsHandler._parse_list_semicoloncCs|j||jdS)Nr)rr)ryrMr/r/r0_parse_file_in_rootmsz(ConfigOptionsHandler._parse_file_in_rootrZr?rMcCs0|||}t|||tdd|DS)Ncss|] }|ds|VqdS)#Nr_)rarr/r/r0rcvrdz@ConfigOptionsHandler._parse_requirements_list..)rrrorr)ryrZrMr\r/r/r0_parse_requirements_listps z-ConfigOptionsHandler._parse_requirements_listcCsN|j}|j}|j}|||j|||||dt|jd|j|j|j |t j |dS)rzeThe namespace_packages parameter is deprecated, consider using implicit namespaces instead (PEP 420).install_requires)Zzip_safeZinclude_package_datarQZscriptsZeager_resourcesZdependency_linksZnamespace_packagesrZsetup_requiresZpackages entry_pointsZ py_modulesZpython_requirescmdclass) rr_parse_cmdclassrrrrr_parse_packagesrrZ SpecifierSet)ryZ parse_listZ parse_boolZparse_cmdclassr/r/r0rys.zConfigOptionsHandler.parserscCs|jj}t||||jSrt)rWrQrrrr)ryrMrQr/r/r0rsz$ConfigOptionsHandler._parse_cmdclasscCsbddg}|}||vr||S||jdi}|j||dk|j|jdtj di|S)zTParses `packages` option value. :param value: :rtype: list zfind:zfind_namespace:z packages.findr)Z namespacesrZfill_package_dirNr/) rrparse_section_packages__findrvrrVrrQrZ find_packages)ryrMZfind_directivesZ trimmed_value find_kwargsr/r/r0rs   z$ConfigOptionsHandler._parse_packagescsN|||j}gdfdd|D}|d}|dur%|d|d<|S)zParses `packages.find` configuration file section. To be used in conjunction with _parse_packages(). :param dict section_options: )whereZincludeZexcludecs"i|] \}}|vr|r||qSr/r/)rakrZ valid_keysr/r0 s"zEConfigOptionsHandler.parse_section_packages__find..rNr)rrr}r)ryrZ section_datarrr/rr0rs  z1ConfigOptionsHandler.parse_section_packages__findcCs|||j}||d<dS)z`Parses `entry_points` configuration file section. :param dict section_options: rN)rrryrr\r/r/r0parse_section_entry_pointss z/ConfigOptionsHandler.parse_section_entry_pointscCs|||j}t|Srt)rrrZcanonic_package_data)ryr package_datar/r/r0_parse_package_datas z(ConfigOptionsHandler._parse_package_datacC|||d<dS)z`Parses `package_data` configuration file section. :param dict section_options: rNrryrr/r/r0parse_section_package_dataz/ConfigOptionsHandler.parse_section_package_datacCr)zhParses `exclude_package_data` configuration file section. :param dict section_options: Zexclude_package_dataNrrr/r/r0"parse_section_exclude_package_datarz7ConfigOptionsHandler.parse_section_exclude_package_datacs&|fdd}t|d<dS)zbParses `extras_require` configuration file section. :param dict section_options: csd|d|S)Nzextras_require[r)r)rrrr/r0rrzCConfigOptionsHandler.parse_section_extras_require..Zextras_requireN)rrrrr/rr0parse_section_extras_requires  z1ConfigOptionsHandler.parse_section_extras_requirecCs$|||j}t||j|d<dS)z^Parses `data_files` configuration file section. :param dict section_options: Z data_filesN)rrrZcanonic_data_filesrrr/r/r0parse_section_data_filessz-ConfigOptionsHandler.parse_section_data_files) rBrrXr!r&r%rWrrr'rs)rZr?rMr?r)rrrrKrzrrrrrrrrrrrrrrrrr/r/rr0rO[s$        rOc@s$eZdZdZdZdZeddZdS)rizAmbiguous 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-2cKs"d|j}|j|j|j||dS)Nz%https://setuptools.pypa.io/en/latest/)Zsee_urlZ format_args) _SEE_DOCS_format_SUMMARY_DETAILS)rrZdocsr/r/r0rls z_AmbiguousMarker.messageN)rrrrr rrrlr/r/r/r0ris ric@seZdZdZdS)rz!userguide/declarative_config.htmlN)rrrrr/r/r/r0r sr)FF)r#rr$r%r&r%r'r()r,rr#rr'r)r/F) r,rr#rr3r4r&r%r'r5)rBrCrDr?)r.rIr'r()F)rNrrAr!r&r%r'r5)rZr?r[r?r\r>)ArZ __future__rrrEr7 collectionsrZcollections.abcrrrrtypingrr r r r r rZpackaging.markersrrfZpackaging.requirementsrrZpackaging.versionrrrr_pathrerrorsrrwarningsrrZtyping_extensionsrr)rZdistutils.distrr(r?tupler rr!r"r1r2r*rHr+r@rorprRrOrirr/r/r/r0sZ  $              . &S