U dHf@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)ZboundF)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 find_config_files_applyconfiguration_to_dict)r#Z find_othersignore_option_errorsr dist filenameshandlersr-B/tmp/pip-install-xwugzb3_/setuptools/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 |||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%r3ospathabspathisfilergetcwdchdirdirnameparse_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. get_) functoolsrgetattr)r>r?Z getter_nameZ by_attributegetterr-r-r. _get_optionys  rD)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_optionsrDr>section_prefix)r,Z config_dicthandleroptionvaluer-r-r.r(s   r()ConfigMetadataHandlerConfigOptionsHandler) 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 ) rEnsurePackagesDiscoveredrLparse package_dirrKmetadatasrc_root_referenced_filesupdate)rMr=r)ensure_discoveredoptionsmetar-r-r.r<s0 r<)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)fieldreqc3s|]}d|VqdS)rN startswith).0markerrZr-r. sz8_warn_accidental_env_marker_misconfig..) len marker_envkeysrname_AmbiguousMarkeremitranymessage)rXrYrZmarkersr]exmsgr-rbr.%_warn_accidental_env_marker_misconfigs   roc@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.rGaliases)r>rVrUcCs4||_||_t|||_g|_||_t|_dSN) r)r>rE_section_optionssectionsrFrUsetrSselfr>rVr)rUr-r-r.__init__szConfigHandler.__init__)rVccs>|D]0\}}||j\}}}|r(q|d|fVqdS)N.)items partitionrGlstrip)clsrVZ full_namerJpreseprgr-r-r.rrs zConfigHandler._section_optionscCstd|jjdS).Metadata item name to parser function mapping.z!%s must provide .parsers propertyN)NotImplementedError __class____name__rvr-r-r.parserss zConfigHandler.parsersc Cs|j}|j||}zt||}Wntk r>t|YnX|rHdSz|j|dd|}Wntf|jk rYdSXt |j |}t|d||}|||j |dS)NcSs|Srqr-)xr-r-r.%z+ConfigHandler.__setitem__..zset_%s)r>rpgetrBAttributeErrorKeyErrorr Exceptionr)rAr __setattr__rFappend)rvZ option_namerJr>Z current_valuerZZ 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 r[cSsg|]}|r|qSr-strip)r`chunkr-r-r. Asz-ConfigHandler._parse_list..) isinstancelist splitlinessplit)r|rJ separatorr-r-r. _parse_list/s   zConfigHandler._parse_listcCsRd}i}||D]:}||\}}}||kr.parserr-)r|r?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.rsz-ConfigHandler._parse_file..r) rr!r_rdrrSrTrZ read_files)rvrJrZinclude_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:)r_replacerTrUrPrZ read_attr)rvrJrPrZattr_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|Srqr-)rJrZmethod parse_methodsr-r.rOs z1ConfigHandler._get_parser_compound..parser-)r|rrOr-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 )ry)r|section_options values_parserrJr?_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|Srqr-rvrr-r.rrz6ConfigHandler._parse_section_to_dict..cSs|Srqr-rr-r-r.rrr)r|rrrr-rr._parse_section_to_dicts z$ConfigHandler._parse_section_to_dictc Cs8|D]*\}\}}tt|||<W5QRXqdS)zQParses configuration file section. :param dict section_options: N)ry contextlibsuppressr)rvrrgrrJr-r-r. parse_sections zConfigHandler.parse_sectioncCsh|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%srx__Nz*Unsupported distribution option section: [])rsryrBrrrG)rv section_namerZmethod_postfixZsection_parser_methodr-r-r.rOszConfigHandler.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_DeprecatedConfigri)argskwargsfunckwrnr-r.config_handlers z@ConfigHandler._deprecated_config_handler..config_handlerr)rvrrnrrr-rr._deprecated_config_handlersz(ConfigHandler._deprecated_config_handler)r)N)r __module__ __qualname____doc__r!__annotations__rpr r"AllCommandOptionsrrNrw classmethodrrpropertyrrrrrr_PathrrrrrrrOrr-r-r-r.r1s>            r1csdeZdZdZdddddZdZdejfd ee e j e e ed fd d Zed dZddZZS)rKrQurl description classifiers platforms)Z home_pagesummary classifierplatformFNr)r>rVr)rUrPrcs"t||||||_||_dSrq)superrwrPr)rvr>rVr)rUrPrrr-r.rws zConfigMetadataHandler.__init__cCsl|j}t|j|jd}|j}|j}||||j|ddd|||||d|j|dddd||||j|d S) rrz[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.) rkeywordsprovidesrequires obsoletesrrrZ license_filesrlong_descriptionversionZ project_urls) rrrrrrrr_parse_version)rv parse_listZ parse_file parse_dictZexclude_files_parserr-r-r.r#s4 zConfigMetadataHandler.parserscCsp|||j}||krX|}z t|Wn(tk rRtd|d|YnX|St|||j |jS)zSParses `version` option value. :param value: :rtype: str zVersion loaded from z does not comply with PEP 440: ) rrrrrrrrrrP)rvrJrr-r-r.rGs  z$ConfigMetadataHandler._parse_version)rrrrGrpZ strict_moder4curdirrboolrrNr rErrwrrr __classcell__r-r-rr.rKs(   #rKrcseZdZdZdeeejdfdd Ze ddZ dd Z e e d d d Z ed dZddZddZddZddZddZddZddZddZdd ZZS)!rLrVr )r>rVr)rUcs$t|||||j|_i|_dSrq)rrwrRrrPrurr-r.rwdszConfigOptionsHandler.__init__cCs|j|ddS)N;)r)rrr-r-r._parse_list_semicolonosz*ConfigOptionsHandler._parse_list_semicoloncCs|j||jdS)Nr)rr)rvrJr-r-r._parse_file_in_rootssz(ConfigOptionsHandler._parse_file_in_root)rXrJcCs*|||}t|||dd|DS)NcSsg|]}|ds|qS)#r^)r`rr-r-r.r|s zAConfigOptionsHandler._parse_requirements_list..)rrro)rvrXrJrZr-r-r._parse_requirements_listvs z-ConfigOptionsHandler._parse_requirements_listcCsT|j}|j}|j}|j}||||||||dt|jd|j|j|j|j |t |dS)rzeThe namespace_packages parameter is deprecated, consider using implicit namespaces instead (PEP 420).install_requires)Zzip_safeZinclude_package_datarPscriptsZeager_resourcesZdependency_linksZnamespace_packagesrZsetup_requiresZ tests_requirepackages entry_points py_modulesZpython_requirescmdclass) rrr_parse_cmdclassrrrr_parse_packagesrr)rvrZ parse_boolrZparse_cmdclassr-r-r.r~s4zConfigOptionsHandler.parserscCs|jj}t||||jSrq)rUrPrrrr)rvrJrPr-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) namespacesrZfill_package_dir) rrparse_section_packages__findrsrrTrrPrZ find_packages)rvrJZfind_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: whereincludeexcludecs$g|]\}}|kr|r||fqSr-r-)r`krZ valid_keysr-r.rszEConfigOptionsHandler.parse_section_packages__find..Nr)rrrEryr)rvrZ section_datarrr-rr.rs   z1ConfigOptionsHandler.parse_section_packages__findcCs|||j}||d<dS)z`Parses `entry_points` configuration file section. :param dict section_options: rN)rrrvrrZr-r-r.parse_section_entry_pointssz/ConfigOptionsHandler.parse_section_entry_pointscCs|||j}t|Srq)rrrZcanonic_package_data)rvr package_datar-r-r._parse_package_datasz(ConfigOptionsHandler._parse_package_datacCs|||d<dS)z`Parses `package_data` configuration file section. :param dict section_options: rNr rvrr-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_dataNr r r-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)rrrr-r.rrzCConfigOptionsHandler.parse_section_extras_require..Zextras_requireNrrr-rr.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: data_filesN)rrrZcanonic_data_filesrrr-r-r.parse_section_data_filessz-ConfigOptionsHandler.parse_section_data_files)rrrrGrrrrNrwrrrr!rrrrrrrr r r rrrr-r-rr.rLas*    rLc@s$eZdZdZdZdZeddZdS)rhzAmbiguous 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)r|rZdocsr-r-r.rks z_AmbiguousMarker.messageN)rrrrrrrrkr-r-r-r.rhs rhc@seZdZdZdS)rz!userguide/declarative_config.htmlN)rrrrr-r-r-r.rsr)FF)r-F)F)@rrrAr4 collectionsrrrtypingrrrr r r r r rrrrerrorsrrZextern.packaging.markersrreZextern.packaging.requirementsrrZextern.packaging.specifiersrZextern.packaging.versionrrwarningsrrrdistutils.distrr%r r!PathLikerZSingleCommandOptionsrr"rEr/r0rr'rDr(r<rror1rKrLrhrr-r-r-r.sl    8            . #[