a ydHf@s$dZddlZddlZddlZddlmZddlmZddlmZddlm 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 rddl'm(Z(ddl)m*Z*ee+ej,fZ-e dede ffZ.e de.fZ/ededdZ0d;e-e1dddZ2de-ddddZ3dGd9d:d:e$Z?dS)>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)boundF)filepathreturncCs8ddlm}|}|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-9lib/python3.9/site-packages/setuptools/config/setupcfg.pyread_configuration8s  r/r )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 r0r-) ConfigHandler.)r*r$ other_filesr)r%c Csddlm}tj|}tj|s4td|dt}ttj |g||}z4|j ||dt ||j |d}| Wt|n t|0|S)zHRead configuration from ``filepath`` and applies to the ``dist`` object.r) _DistributionzConfiguration file z does not exist.)r+)r))r&r3ospathabspathisfilergetcwdchdirdirnameZparse_config_filesparse_configurationcommand_optionsZ_finalize_license_files)r*r$r2r)r3Zcurrent_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  rB)r,r%cCs<tt}|D]*}|jD]}t|j|}|||j|<qq |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_optionsrBr=section_prefix)r,Z config_dictZhandlerZoptionvaluer-r-r.r(s   r()ConfigMetadataHandlerConfigOptionsHandler) distributionr<r%cCst|f}t||||}||js0|j|_t|j||||j|j}||j |j|jWdn1sv0Y||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) rEnsurePackagesDiscoveredrHparse package_dirrGmetadatasrc_root_referenced_filesupdate)rIr<r)ensure_discoveredoptionsmetar-r-r.r;s. "r;)label orig_valueparsedc sd|vstdkrdSt}z,td}|j|vrLtj|ddWnVty}z>tfdd|Drtj |dd}t||WYd}~n d}~00dS)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. z8_warn_accidental_env_marker_misconfig..) len marker_envkeysrname_AmbiguousMarkeremitranymessage)rTrUrVZmarkersrXexmsgr-r\r.%_warn_accidental_env_marker_misconfigs   ric@seZdZUdZeed<iZeeefed<ee e j dddZ e e ddd Zed d Zd d Ze d)ddZe ddZe ddZe ddZedddZedddZe ddZe ddZe d*d!d"Zd#d$Zd%d&Zd'd(Zd S)+r1z1Handles metadata supplied in configuration files.rEaliases)r=rRrQcCs4||_||_t|||_g|_||_t|_dSN) r)r=rC_section_optionssectionsrDrQsetrOselfr=rRr)rQr-r-r.__init__szConfigHandler.__init__)rRccs>|D]0\}}||j\}}}|r(q|d|fVqdS)N.)items partitionrElstrip)clsrRZ full_namerFZpreseprbr-r-r.rls zConfigHandler._section_optionscCstd|jjdS).Metadata item name to parser function mapping.z!%s must provide .parsers propertyN)NotImplementedError __class____name__rpr-r-r.parserss zConfigHandler.parsersc Cs|j}|j||}zt||}Wnty<t|Yn0|rFdSz|j|dd|}Wntf|jy|YdS0t |j |}t|d||}|||j |dS)NcSs|Srkr-)xr-r-r.%r^z+ConfigHandler.__setitem__..zset_%s)r=rjgetr@AttributeErrorKeyErrorr} Exceptionr)r?r __setattr__rDappend)rpZ 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. Ar^z-ConfigHandler._parse_list..) isinstancelist splitlinessplit)rvrF separatorr-r-r. _parse_list/s   zConfigHandler._parse_listcCsRd}i}||D]:}||\}}}||krrwvalr-r-r. _parse_dictCszConfigHandler._parse_dictcCs|}|dvS)zQRepresents value as boolean. :param value: :rtype: bool )1trueZyes)lowerrvrFr-r-r. _parse_boolTszConfigHandler._parse_boolcsfdd}|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-)rvr>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[r5r-r-r.rr^z-ConfigHandler._parse_file..r) rr!rZr_rrOrPrZ read_files)rprFrZinclude_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)rprFrLrZattr_directiveZ attr_descr-r-r. _parse_attrs   zConfigHandler._parse_attrcsfdd}|S)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|Srkr-)rFrVmethod parse_methodsr-r.rKs z1ConfigHandler._get_parser_compound..parser-)rvrrKr-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 )rs)rvsection_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|Srkr-rvrr-r.rr^z6ConfigHandler._parse_section_to_dict..cSs|Srkr-rr-r-r.rr^r)rvrrrr-rr._parse_section_to_dicts z$ConfigHandler._parse_section_to_dictc CsL|D]>\}\}}tt|||<Wdq1s<0YqdS)zQParses configuration file section. :param dict section_options: N)rs contextlibsuppressr)rprrbrrFr-r-r. parse_sections zConfigHandler.parse_sectioncCsh|jD]X\}}d}|r"d|}t|d|ddd}|durZtd|jd|d||q dS) zTParses configuration file items from one or more related sections. rz_%szparse_section%srr__Nz*Unsupported distribution option section: [])rmrsr@rrrE)rpZ 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_DeprecatedConfigrd)argskwargsfunckwrhr-r.config_handlers z@ConfigHandler._deprecated_config_handler..config_handlerr)rprrhrrr-rr._deprecated_config_handlersz(ConfigHandler._deprecated_config_handler)r)N)r{ __module__ __qualname____doc__r!__annotations__rjr r"AllCommandOptionsrrJrq classmethodrlpropertyr}rrrrr_PathrrrrrrrKrr-r-r-r.r1s>            r1csdeZdZdZdddddZdZdejfd ee e j e e ed fd d Zed dZddZZS)rGrMZurl description classifiers platforms)Z home_pageZsummaryZ classifierplatformFNr)r=rRr)rQrLrcs"t||||||_||_dSrk)superrqrLr)rpr=rRr)rQrLrrzr-r.rqs zConfigMetadataHandler.__init__cCsl|j}t|j|jd}|j}|j}||||j|ddd|||||d|j|dddd||||j|d S) rxrz[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)rp parse_listZ parse_file parse_dictZexclude_files_parserr-r-r.r}#s4 zConfigMetadataHandler.parserscCsn|||j}||krV|}z t|Wn&tyPtd|d|Yn0|St|||j |jS)zSParses `version` option value. :param value: :rtype: str zVersion loaded from z does not comply with PEP 440: ) rrrrrrrrrrL)rprFrr-r-r.rGs   z$ConfigMetadataHandler._parse_version)r{rrrErjZ strict_moder4curdirrboolrrJr rCrrqrr}r __classcell__r-r-rr.rGs(   #rGrcseZdZdZdeeejdfdd Ze ddZ dd Z e e d d d Z ed dZddZddZddZddZddZddZddZddZdd ZZS)!rHrRr )r=rRr)rQcs$t|||||j|_i|_dSrk)rrqrNrrLrorr-r.rqdszConfigOptionsHandler.__init__cCs|j|ddS)N;)r)rrr-r-r._parse_list_semicolonosz*ConfigOptionsHandler._parse_list_semicoloncCs|j||jdS)Nr)rr)rprFr-r-r._parse_file_in_rootssz(ConfigOptionsHandler._parse_file_in_root)rTrFcCs*|||}t|||dd|DS)NcSsg|]}|ds|qS)#rY)r[rr-r-r.r|r^zAConfigOptionsHandler._parse_requirements_list..)rrri)rprTrFrVr-r-r._parse_requirements_listvs z-ConfigOptionsHandler._parse_requirements_listcCsT|j}|j}|j}|j}||||||||dt|jd|j|j|j|j |t |dS)rxzeThe 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)rprZ parse_boolrZparse_cmdclassr-r-r.r}~s2zConfigOptionsHandler.parserscCs|jj}t||||jSrk)rQrLrrrr)rprFrLr-r-r.rsz$ConfigOptionsHandler._parse_cmdclasscCsbddg}|}||vr"||S||jdi}|j||dk|j|jdtj fi|S)zTParses `packages` option value. :param value: :rtype: list zfind:zfind_namespace:z packages.findr)Z namespacesrZfill_package_dir) rrparse_section_packages__findrmrrPrrLrZ find_packages)rprFZfind_directivesZ trimmed_value find_kwargsr-r-r.rs   z$ConfigOptionsHandler._parse_packagescsR|||j}gdtfdd|D}|d}|durN|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.rr^zEConfigOptionsHandler.parse_section_packages__find..rNr)rrrCrsr)rprZ section_datarrr-rr.rs  z1ConfigOptionsHandler.parse_section_packages__findcCs|||j}||d<dS)z`Parses `entry_points` configuration file section. :param dict section_options: rN)rrrprrVr-r-r.parse_section_entry_pointssz/ConfigOptionsHandler.parse_section_entry_pointscCs|||j}t|Srk)rrrZcanonic_package_data)rpr package_datar-r-r._parse_package_datasz(ConfigOptionsHandler._parse_package_datacCs|||d<dS)z`Parses `package_data` configuration file section. :param dict section_options: rNrrprr-r-r.parse_section_package_datasz/ConfigOptionsHandler.parse_section_package_datacCs|||d<dS)zhParses `exclude_package_data` configuration file section. :param dict section_options: Zexclude_package_dataNrrr-r-r."parse_section_exclude_package_datasz7ConfigOptionsHandler.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.rr^zCConfigOptionsHandler.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)r{rrrErrrrJrqrrrr!rrr}rrrrrrrrrrr-r-rr.rHas*    rHc@s$eZdZdZdZdZeddZdS)rczAmbiguous 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_DOCSZ_format_SUMMARY_DETAILS)rvrZdocsr-r-r.rfs z_AmbiguousMarker.messageN)r{rrrrrrrfr-r-r-r.rcs rcc@seZdZdZdS)rz!userguide/declarative_config.htmlN)r{rrrr-r-r-r.rsr)FF)r-F)F)@rrr?r4 collectionsrrrtypingrrrr r r r r rrrrerrorsrrZextern.packaging.markersrr`Zextern.packaging.requirementsrrZextern.packaging.specifiersrZextern.packaging.versionrrwarningsrrrZdistutils.distrr&r r!PathLikerZSingleCommandOptionsrr"rCr/r0rr'rBr(r;rrir1rGrHrcrr-r-r-r.sj    8            . #[