U fc@sdZddlmZddlZddlZddlZddlmZddlmZddlm Z ddl m Z m Z m Z mZmZmZmZmZmZmZdd lmZdd lmZmZdd lmZdd lmZmZdd l m!Z!ddl"m#Z#m$Z$ddl%m&Z&ddl'm(Z(e rddl)m*Z*ddl+m,Z,edede ffZ-ede-fZ.ededdZ/dCdddddZ0ddddd d!Z1dDddd#d$d%d&d'd(Z2ddd)d*d+Z3d%dd,d-d.Z4dEdd/d0d1d2d3Z5ddd4d5d6d7Z6Gd8d9d9ee/Z7Gd:d;d;e7d<Z8Gd=d>d>e7dZ9Gd?d@d@e&Z:GdAdBdBe&Z;dS)Fa< 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)partialwraps) TYPE_CHECKINGCallableAnyDictGenericIterableIteratorTupleTypeVarUnion)StrPath) FileError OptionError)default_environment)InvalidRequirement Requirement) SpecifierSet)InvalidVersionVersion)SetuptoolsDeprecationWarning)expand)DistributionMetadata DistributionstrTarget)r r)ZboundFrdict)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.8/site-packages/setuptools/config/setupcfg.pyread_configuration9s  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_configurationSs r0r-zIterable[StrPath]boolztuple[ConfigHandler, ...])r*r$ other_filesr)r%c Csddlm}tj|}tj|s4td|dt}ttj |||f}z*|j ||dt ||j |d}| W5t|X|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_optionzs  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 )rr# set_optionsrBr=section_prefix)r,Z config_dictZhandlerZoptionvaluer-r-r.r(s   r(AllCommandOptionsz2tuple[ConfigMetadataHandler, ConfigOptionsHandler]) distributionr<r%c Cstt|\}t||||}||js0|j|_t|j||||j|j}||j |j|jW5QRX||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 ) rZEnsurePackagesDiscoveredConfigOptionsHandlerparse package_dirConfigMetadataHandlermetadatasrc_root_referenced_filesupdate)rGr<r)ensure_discoveredoptionsmetar-r-r.r;s0 r;list)label orig_valueparsedc sd|kstdkrdSt}z,td}|j|krLtj|ddWnTtk r}z6tfdd|Drtj |dd}t||W5d}~XYnXdS)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@seZdZUdZded<iZded<dddd d d Zedd d ddZe ddZ ddZ ed2ddZ eddZ eddZeddZdddd Zddd!d"Zed#d$Zed%d&Zed3d(d)Zd*d+Zd,d-d.d/Zd0d1Zd'S)4 ConfigHandlerz1Handles metadata supplied in configuration files.r!rDzdict[str, str]aliasesr"rFexpand.EnsurePackagesDiscovered)r=rQrPcCs4||_||_t|||_g|_||_t|_dSN) r)r=r#_section_optionssectionsrCrPsetrNselfr=rQr)rPr-r-r.__init__szConfigHandler.__init__z*Iterator[tuple[str, SingleCommandOptions]])rQr%ccs>|D]0\}}||j\}}}|r(q|d|fVqdS)N.)items partitionrDlstrip)clsrQZ full_namerEZpreseprar-r-r.rms zConfigHandler._section_optionscCstd|jjdS).Metadata item name to parser function mapping.z!%s must provide .parsers propertyN)NotImplementedError __class____name__rqr-r-r.parserss zConfigHandler.parsersc Cs|j}|j||}zt||}Wn,tk rN}zt||W5d}~XYnX|rXdSz|j|dd|}Wntf|jk rYdSXt |j |}t|d||}|||j |dS)NcSs|Srlr-)xr-r-r.(z+ConfigHandler.__setitem__..zset_%s)r=rjgetr@AttributeErrorKeyErrorr~ Exceptionr)r?r __setattr__rCappend) rqZ option_namerEr=Z current_valueerVZ simple_settersetterr-r-r. __setitem__s zConfigHandler.__setitem__,cCs8t|tr|Sd|kr |}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. Dsz-ConfigHandler._parse_list..) isinstancerS splitlinessplit)rwrE separatorr-r-r. _parse_list2s   zConfigHandler._parse_listcCsRd}i}||D]:}||\}}}||krrxvalr-r-r. _parse_dictFszConfigHandler._parse_dictcCs|}|dkS)zQRepresents value as boolean. :param value: :rtype: bool )1trueZyes)lowerrwrEr-r-r. _parse_boolWszConfigHandler._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)rEZexclude_directiver>r-r.parserms z3ConfigHandler._exclude_files_parser..parserr-)rwr>rr-rr._exclude_files_parseras z#ConfigHandler._exclude_files_parserrroot_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.rsz-ConfigHandler._parse_file..r) rr!rZr^rrNrOrZ read_files)rqrErZinclude_directivespecZ filepathsr-r-r. _parse_filexs    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:)rZreplacerOrPrJrZ read_attr)rqrErJrZattr_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|Srlr-)rErVmethod parse_methodsr-r.rIs z1ConfigHandler._get_parser_compound..parser-)rwrrIr-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 )rt)rwsection_options values_parserrEr>_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|Srlr-rvrr-r.rrz6ConfigHandler._parse_section_to_dict..cSs|Srlr-rr-r-r.rrr)rwrrrr-rr._parse_section_to_dicts z$ConfigHandler._parse_section_to_dictc Cs8|D]*\}\}}tt|||<W5QRXqdS)zQParses configuration file section. :param dict section_options: N)rt contextlibsuppressr)rqrrarrEr-r-r. parse_sections zConfigHandler.parse_sectionNone)r%cCsh|jD]X\}}d}|r"d|}t|d|ddd}|dkrZtd|jd|d||q dS) zTParses configuration file items from one or more related sections. rz_%szparse_section%srs__Nz*Unsupported distribution option section: [])rnrtr@rrrD)rqZ section_namerZmethod_postfixZsection_parser_methodr-r-r.rIszConfigHandler.parsec stfdd}|S)zthis function will wrap around parameters that are deprecated :param msg: deprecation message :param func: function to be wrapped around cs&ddtjdf||S)N stacklevelrz Deprecated config in `setup.cfg`) setdefault_DeprecatedConfigrc)argskwargsfunckwrgr-r.config_handlers z@ConfigHandler._deprecated_config_handler..config_handlerr)rqrrgrrr-rr._deprecated_config_handlersz(ConfigHandler._deprecated_config_handler)r)N)r| __module__ __qualname____doc____annotations__rjrr classmethodrmpropertyr~rrrrrrrrrrrrIrr-r-r-r.ris8            rics^eZdZdZdddddZdZdejfd d d d d ddfdd Ze ddZ ddZ Z S)rKrLZurl description classifiers platforms)Z home_pageZsummaryZ classifierplatformFNrrFr1rkz dict | Noner)r=rQr)rPrJrcs"t||||||_||_dSrl)superrrrJr)rqr=rQr)rPrJrr{r-r.rrs zConfigMetadataHandler.__init__c CsL|j}t|j|jd}|j}|j}||||||||d||||j|d S)ryrlicense) rkeywordsZprovidesZ obsoletesrrZ license_filesrZlong_descriptionversionZ project_urls)rrrrrrr_parse_version)rq parse_listZ parse_file parse_dictZexclude_files_parserr-r-r.r~&s  zConfigMetadataHandler.parsersc Cs|||j}||krh|}z t|Wn8tk rb}ztd|d||W5d}~XYnX|St|||j |jS)zSParses `version` option value. :param value: :rtype: str zVersion loaded from z does not comply with PEP 440: N) rrrrrrrrrrJ)rqrErrr-r-r.r<s z$ConfigMetadataHandler._parse_version) r|rrrDrjZ strict_moder4curdirrrrr~r __classcell__r-r-rr.rK s   rKrcseZdZdZdddddfdd Zed d Zd d Zd d dddZe ddZ ddZ ddZ ddZ ddZddZddZdd Zd!d"Zd#d$ZZS)%rHrQr rFr1rk)r=rQr)rPcs$t|||||j|_i|_dSrl)rrrrMrrJrprr-r.rrYszConfigOptionsHandler.__init__cCs|j|ddS)N;)r)rrr-r-r._parse_list_semicolondsz*ConfigOptionsHandler._parse_list_semicoloncCs|j||jdS)Nr)rr)rqrEr-r-r._parse_file_in_roothsz(ConfigOptionsHandler._parse_file_in_rootr!)rTrEcCs*|||}t|||dd|DS)NcSsg|]}|ds|qS)#rY)r[rr-r-r.rqs zAConfigOptionsHandler._parse_requirements_list..)rrrh)rqrTrErVr-r-r._parse_requirements_listks z-ConfigOptionsHandler._parse_requirements_listcCsP|j}|j}|j}|j}||||||||dt|jd|j|j|j |t |dS)ryzeThe namespace_packages parameter is deprecated, consider using implicit namespaces instead (PEP 420).install_requires)Zzip_safeZinclude_package_datarJZscriptsZeager_resourcesZdependency_linksZnamespace_packagesrZsetup_requiresZpackages entry_pointsZ py_modulesZpython_requirescmdclass) rrr_parse_cmdclassrrrr_parse_packagesrr)rqrZ parse_boolrZparse_cmdclassr-r-r.r~ss2zConfigOptionsHandler.parserscCs|jj}t||||jSrl)rPrJrrrr)rqrErJr-r-r.rsz$ConfigOptionsHandler._parse_cmdclasscCs^ddg}|}||kr"||S||jdi}|j||dk|j|jdtj f|S)zTParses `packages` option value. :param value: :rtype: list zfind:zfind_namespace:z packages.findr)Z namespacesrZfill_package_dir) rrparse_section_packages__findrnrrOrrJrZ find_packages)rqrEZfind_directivesZ trimmed_value find_kwargsr-r-r.rs   z$ConfigOptionsHandler._parse_packagescsT|||j}dddgtfdd|D}|d}|dk rP|d|d<|S)zParses `packages.find` configuration file section. To be used in conjunction with _parse_packages(). :param dict section_options: whereZincludeZexcludecs$g|]\}}|kr|r||fqSr-r-)r[krZ valid_keysr-r.rszEConfigOptionsHandler.parse_section_packages__find..Nr)rrr#rtr)rqrZ section_datarrr-rr.rs    z1ConfigOptionsHandler.parse_section_packages__findcCs|||j}||d<dS)z`Parses `entry_points` configuration file section. :param dict section_options: rN)rrrqrrVr-r-r.parse_section_entry_pointssz/ConfigOptionsHandler.parse_section_entry_pointscCs|||j}t|Srl)rrrZcanonic_package_data)rqr package_datar-r-r._parse_package_datasz(ConfigOptionsHandler._parse_package_datacCs|||d<dS)z`Parses `package_data` configuration file section. :param dict section_options: rNrrqrr-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.rrzCConfigOptionsHandler.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|rrrDrrrrrrrr~rrrrrrrrrrr-r-rr.rHVs"    rHc@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_DOCSZ_format_SUMMARY_DETAILS)rwrZdocsr-r-r.res z_AmbiguousMarker.messageN)r|rrrrrrrer-r-r-r.rbs rbc@seZdZdZdS)rz!userguide/declarative_config.htmlN)r|rrrr-r-r-r.rsr)FF)r-F)F)sT    0          . %M