o _dHf @sHdZddlZddlZddlZddlmZddlmZddlmZddlm Z m Z m Z m Z m Z mZmZmZmZmZmZmZddlmZmZdd lmZdd lmZmZdd lmZdd l m!Z!m"Z"dd l#m$Z$ddl%m&Z&e rzddl'm(Z(ddl)m*Z*ee+ej,fZ-e dede ffZ. e de.fZ/ededdZ0 dAde-de1fddZ2ddde-ddfddZ3  dBddde-d ee-d!e4ded"f d#d$Z5d%e0d&e+fd'd(Z6d)ed"de1fd*d+Z7 dCd,dd-e/ded.fd/d0Z8d1e+d2e+d3e9fd4d5Z:Gd6d7d7e e0Z;Gd8d9d9e;d:Zd>e$Z>Gd?d@d@e$Z?dS)Da< 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)ZboundFfilepathreturncCs8ddlm}|}|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.distr Zfind_config_files_applyconfiguration_to_dict)r#Z find_othersignore_option_errorsr dist filenameshandlersr,:lib/python3.10/site-packages/setuptools/config/setupcfg.pyread_configuration8s r.r)r cCst||||S)z`Apply the configuration from a ``setup.cfg`` file into an existing distribution object. )r&Z_finalize_requires)r)r#r,r,r-apply_configurationRs r/r, other_filesr() ConfigHandler.c Csddlm}tj|}tj|std|dt}ttj |g||}z|j ||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%r2ospathabspathisfilergetcwdchdirdirnameZparse_config_filesparse_configurationcommand_optionsZ_finalize_license_files)r)r#r0r(r2Zcurrent_directoryr*r+r,r,r-r&[s       r& target_objkeycCs*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)r<r=Z getter_nameZ by_attributegetterr,r,r- _get_optionys  rAr+cCs<tt}|D]}|jD]}t|j|}|||j|<q q|S)zReturns configuration data gathered by given handlers as a dict. :param list[ConfigHandler] handlers: Handlers list, usually from parse_configuration() :rtype: dict )rdict set_optionsrAr<section_prefix)r+Z config_dictZhandleroptionvaluer,r,r-r's  r' distributionr;)ConfigMetadataHandlerConfigOptionsHandlercCst|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) rEnsurePackagesDiscoveredrIparse package_dirrHmetadatasrc_root_referenced_filesupdate)rGr;r(ensure_discoveredoptionsmetar,r,r-r:s4  r:label orig_valueparsedc 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).0ZmarkerrVr,r- sz8_warn_accidental_env_marker_misconfig..) len marker_envkeysrname_AmbiguousMarkeremitranymessage)rTrUrVZmarkersrXexmsgr,r\r-%_warn_accidental_env_marker_misconfigs    rhc@seZdZUdZeed< iZeeefed< dede de j fddZ e de fd d Zed d Zd dZe d*ddZe ddZe ddZe ddZdefddZdefddZe ddZe dd Ze d+d"d#Zd$d%Zd&d'Zd(d)Zd!S),r1z1Handles metadata supplied in configuration files.rDaliasesr<rRrQcCs4||_||_t|||_g|_||_t|_dSN) r(r<rB_section_optionssectionsrCrQsetrOselfr<rRr(rQr,r,r-__init__szConfigHandler.__init__ccs@|D]\}}||j\}}}|rq|d|fVqdS)N.)items partitionrDlstrip)clsrRZ full_namerFZpreseprar,r,r-rkszConfigHandler._section_optionscCstd|jj).Metadata item name to parser function mapping.z!%s must provide .parsers property)NotImplementedError __class____name__ror,r,r-parserss zConfigHandler.parsersc Cs|j}|j||}zt||}Wn tyt|w|r!dSz |j|dd|}Wntf|jy<YdSwt |j |}t|d||}|||j |dS)NcSs|Srjr,)xr,r,r-%z+ConfigHandler.__setitem__..zset_%s)r<rigetr?AttributeErrorKeyErrorr| Exceptionr(r>r __setattr__rCappend)roZ option_namerFr<Z current_valuerVZ simple_settersetterr,r,r- __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 rWcSsg|] }|r|qSr,strip)r[chunkr,r,r- Asz-ConfigHandler._parse_list..) isinstancelist splitlinessplit)rurF separatorr,r,r- _parse_list/s   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: )rrsrr)rurFrresultliner=rvvalr,r,r- _parse_dictCszConfigHandler._parse_dictcCs|}|dvS)zQRepresents value as boolean. :param value: :rtype: bool )1trueZyes)lowerrurFr,r,r- _parse_boolTszConfigHandler._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}||rtd|S)Nfile:zCOnly strings are accepted for the {0} field, files are not accepted)rZ ValueErrorformat)rFZexclude_directiver=r,r-parserjs z3ConfigHandler._exclude_files_parser..parserr,)rur=rr,rr-_exclude_files_parser^s  z#ConfigHandler._exclude_files_parserroot_dircCs\d}t|ts |S||s|S|t|d}dd|dD}|j|t||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)r[r4r,r,r-rz-ConfigHandler._parse_file..r) rr!rZr^rrOrPrZ read_files)rorFrZinclude_directivespecZ filepathsr,r,r- _parse_fileus    zConfigHandler._parse_filecCs:d}||s |S||d}||jjt|||S)zRepresents value as a module attribute. Examples: attr: package.attr attr: package.module.attr :param str value: :rtype: str zattr:)rZreplacerPrQrLrZ read_attr)rorFrLrZattr_directiveZ attr_descr,r,r- _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|Srjr,)rFrVmethod parse_methodsr,r-rKs z1ConfigHandler._get_parser_compound..parser,)rurrKr,rr-_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 )rr)rusection_options values_parserrFr=_rr,r,r-_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|Srjr,rvrr,r-r~sz6ConfigHandler._parse_section_to_dict..cSs|Srjr,rr,r,r-r~rr)rurrrr,rr-_parse_section_to_dicts z$ConfigHandler._parse_section_to_dictc CsL|D]\}\}}tt |||<Wdn1swYqdS)zQParses configuration file section. :param dict section_options: N)rr contextlibsuppressr)rorrarrFr,r,r- parse_sections   zConfigHandler.parse_sectioncCsh|jD],\}}d}|rd|}t|d|ddd}|dur-td|jd|d||qdS) zTParses configuration file items from one or more related sections. rz_%szparse_section%srq__Nz*Unsupported distribution option section: [])rlrrr?rrrD)roZ section_namerZmethod_postfixZsection_parser_methodr,r,r-rKs& 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_DeprecatedConfigrc)argskwargsfunckwrgr,r-config_handlers z@ConfigHandler._deprecated_config_handler..config_handlerr)rorrgrrr,rr-_deprecated_config_handlersz(ConfigHandler._deprecated_config_handler)rrj)rz __module__ __qualname____doc__r!__annotations__rir r"AllCommandOptionsrrJrp classmethodrkpropertyr|rrrrr_PathrrrrrrrKrr,r,r,r-r1sJ            r1c speZdZdZdddddZdZ dejfd d d ed e d e j de e def fdd ZeddZddZZS)rHrMurl description classifiers platforms)Z home_pageZsummaryZ classifierplatformFNr<rrRr(rQrLrcs"t||||||_||_dSrj)superrprLr)ror<rRr(rQrLrryr,r-rps  zConfigMetadataHandler.__init__cCsl|j}t|j|jd}|j}|j}||||j|ddd|||||d|j|dddd||||j|d S) rwrz[The requires parameter is deprecated, please use install_requires for runtime dependencies.)i )Zdue_datelicense license_filezDThe license_file parameter is deprecated, use license_files instead.) rkeywordsZprovidesZrequiresZ obsoletesrrrZ license_filesrZlong_descriptionversionZ project_urls) rrrrrrrr_parse_version)ro parse_listZ parse_file parse_dictZexclude_files_parserr,r,r-r|#s4 zConfigMetadataHandler.parserscCsh|||j}||kr(|}zt|W|Sty'td|d|wt|||j |jS)zSParses `version` option value. :param value: :rtype: str zVersion loaded from z does not comply with PEP 440: ) rrrrrrrrrrL)rorFrr,r,r-rGs  z$ConfigMetadataHandler._parse_version)rzrrrDriZ strict_moder3curdirrboolrrJr rBrrprr|r __classcell__r,r,rr-rHs6  #rHrcseZdZdZdddededejffdd Ze dd Z d d Z d e d e fddZ eddZddZddZddZddZddZddZddZd d!Zd"d#ZZS)$rIrRr<r r(rQcs$t|||||j|_i|_dSrj)rrprNrrLrnrr,r-rpds zConfigOptionsHandler.__init__cCs|j|ddS)N;)r)rrr,r,r-_parse_list_semicolonosz*ConfigOptionsHandler._parse_list_semicoloncCs|j||jdS)Nr)rr)rorFr,r,r-_parse_file_in_rootssz(ConfigOptionsHandler._parse_file_in_rootrTrFcCs*|||}t|||dd|DS)NcSsg|] }|ds|qS)#rY)r[rr,r,r-r|szAConfigOptionsHandler._parse_requirements_list..)rrrh)rorTrFrVr,r,r-_parse_requirements_listvs z-ConfigOptionsHandler._parse_requirements_listcCsT|j}|j}|j}|j}||||||||dt|jd|j|j|j|j |t |dS)rwzeThe namespace_packages parameter is deprecated, consider using implicit namespaces instead (PEP 420).install_requires)Zzip_safeZinclude_package_datarLZscriptsZeager_resourcesZdependency_linksZnamespace_packagesrZsetup_requiresZ tests_requireZpackages entry_pointsZ py_modulesZpython_requirescmdclass) rrr_parse_cmdclassrrrr_parse_packagesrr)rorZ parse_boolrZparse_cmdclassr,r,r-r|~s2zConfigOptionsHandler.parserscCs|jj}t||||jSrj)rQrLrrrr)rorFrLr,r,r-rsz$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__findrlrrPrrLrZ find_packages)rorFZfind_directivesZ trimmed_value find_kwargsr,r,r-rs   z$ConfigOptionsHandler._parse_packagescsR|||j}gdtfdd|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$g|]\}}|vr|r||fqSr,r,)r[krZ valid_keysr,r-rs$zEConfigOptionsHandler.parse_section_packages__find..rNr)rrrBrrr)rorZ section_datarrr,rr-rs  z1ConfigOptionsHandler.parse_section_packages__findcCs|||j}||d<dS)z`Parses `entry_points` configuration file section. :param dict section_options: rN)rrrorrVr,r,r-parse_section_entry_pointss z/ConfigOptionsHandler.parse_section_entry_pointscCs|||j}t|Srj)rrrZcanonic_package_data)ror package_datar,r,r-_parse_package_datas z(ConfigOptionsHandler._parse_package_datacC|||d<dS)z`Parses `package_data` configuration file section. :param dict section_options: rNrrorr,r,r-parse_section_package_dataz/ConfigOptionsHandler.parse_section_package_datacCr)zhParses `exclude_package_data` configuration file section. :param dict section_options: Zexclude_package_dataNrrr,r,r-"parse_section_exclude_package_datarz7ConfigOptionsHandler.parse_section_exclude_package_datacs |fdd}|d<dS)zbParses `extras_require` configuration file section. :param dict section_options: csd|d|S)Nzextras_require[r)r)rrr{r,r-r~rzCConfigOptionsHandler.parse_section_extras_require..Zextras_requireNrrr,r{r-parse_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,r-parse_section_data_filessz-ConfigOptionsHandler.parse_section_data_files)rzrrrDrrrrJrprrrr!rrr|rrrrrrrrrrr,r,rr-rIas4    rIc@s$eZdZdZdZdZeddZdS)rbzAmbiguous 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)rurZdocsr,r,r-res z_AmbiguousMarker.messageN)rzrrrrrrrer,r,r,r-rbs rbc@seZdZdZdS)rz!userguide/declarative_config.htmlN)rzrrrr,r,r,r-rsr)FF)r,F)F)@rrr>r3 collectionsrrrtypingrrrr r r r r rrrrerrorsrrZextern.packaging.markersrr_Zextern.packaging.requirementsrrZextern.packaging.specifiersrZextern.packaging.versionrrwarningsrrrZdistutils.distrr%r r!PathLikerZSingleCommandOptionsrr"rBr.r/rr&rAr'r:rrhr1rHrIrbrr,r,r,r-s|    8            . #[