B 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)partial)wraps) TYPE_CHECKINGCallableAnyDictGenericIterableListOptionalSetTupleTypeVarUnion) FileError OptionError)default_environment)InvalidRequirement Requirement) SpecifierSet)InvalidVersionVersion)SetuptoolsDeprecationWarning)expand)DistributionMetadata) DistributionstrTarget)rr)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 r)r)setuptools.distrfind_config_files_applyconfiguration_to_dict)r"Z find_othersignore_option_errorsrdist filenameshandlersr,g/work/yifan.wang/ringdown/master-ringdown-env/lib/python3.7/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 r/r,) ConfigHandler.)r)r" other_filesr(r#c Csddlm}tj|}tj|s4td|dt}ttj |||f}z*|j ||dt ||j |d}| Wdt|X|S)zHRead configuration from ``filepath`` and applies to the ``dist`` object.r) _DistributionzConfiguration file z does not exist.)r*)r(N)r$r2ospathabspathisfilergetcwdchdirdirnameparse_config_filesparse_configurationcommand_optionsZ_finalize_license_files)r)r"r1r(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. get_) functoolsrgetattr)r=r>Z getter_nameZ by_attributegetterr,r,r- _get_optionys  rC)r+r#cCsDtt}x6|D].}x(|jD]}t|j|}|||j|<qWqW|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_optionsrCr=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|jWdQRX||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) rEnsurePackagesDiscoveredrKparse package_dirrJmetadatasrc_root_referenced_filesupdate)rLr<r(ensure_discoveredoptionsmetar,r,r-r;s( r;)label orig_valueparsedc sd|kstdkrdSt}y,td}|j|krLtj|ddWnTtk r}z6tfdd|Drtj |dd}t||Wdd}~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).0marker)rYr,r- sz8_warn_accidental_env_marker_misconfig..) len marker_envkeysrname_AmbiguousMarkeremitranymessage)rWrXrYmarkersr\exmsgr,)rYr-%_warn_accidental_env_marker_misconfigs   rlc@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)+r0z1Handles metadata supplied in configuration files.rFaliases)r=rUrTcCs4||_||_t|||_g|_||_t|_dS)N) r(r=rD_section_optionssectionsrErTsetrR)selfr=rUr(rTr,r,r-__init__szConfigHandler.__init__)rUccsBx<|D]0\}}||j\}}}|r*q |d|fVq WdS)N.)items partitionrFlstrip)clsrUZ full_namerIpreseprdr,r,r-rns zConfigHandler._section_optionscCstd|jjdS)z.Metadata item name to parser function mapping.z!%s must provide .parsers propertyN)NotImplementedError __class____name__)rqr,r,r-parsersszConfigHandler.parsersc Cs|j}|j||}yt||}Wntk r>t|YnX|rHdSy|j|dd|}Wntf|jk r~dSXt |j |}t|d||}|||j |dS)NcSs|S)Nr,)xr,r,r-%z+ConfigHandler.__setitem__..zset_%s)r=rmgetrAAttributeErrorKeyErrorr} Exceptionr(r@r __setattr__rEappend)rqZ option_namerIr= current_valuerYZ 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 rZcSsg|]}|r|qSr,)strip)r^chunkr,r,r- Asz-ConfigHandler._parse_list..) isinstancelist splitlinessplit)rwrI separatorr,r,r- _parse_list/s   zConfigHandler._parse_listcCsVd}i}xH||D]:}||\}}}||kr>td||||<qW|S)zPRepresents value as a dict. :param value: :rtype: dict =z&Unable to parse option value to dict: )rrurr)rwrIrresultliner>ryvalr,r,r- _parse_dictCszConfigHandler._parse_dictcCs|}|dkS)zQRepresents value as boolean. :param value: :rtype: bool )1trueyes)lower)rwrIr,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)Nzfile:zCOnly strings are accepted for the {0} field, files are not accepted)r] ValueErrorformat)rIZexclude_directive)r>r,r-parserjs  z3ConfigHandler._exclude_files_parser..parserr,)rwr>rr,)r>r-_exclude_files_parser^s z#ConfigHandler._exclude_files_parser)root_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 zfile:NcSsg|] }|qSr,)r)r^r4r,r,r-rsz-ConfigHandler._parse_file..r) rrr]rarrRrSrZ read_files)rqrIrZinclude_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]replacerSrTrOrZ read_attr)rqrIrOrZattr_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|}xD] }||}q W|S)Nr,)rIrYmethod) parse_methodsr,r-rNs  z1ConfigHandler._get_parser_compound..parser,)rwrrNr,)rr-_get_parser_compounds z"ConfigHandler._get_parser_compoundcCs0i}x&|D]\}\}}|||||<qW|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_parserrIr>_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|S)Nr,)rv)rr,r-rrz6ConfigHandler._parse_section_to_dict..cSs|S)Nr,)rrr,r,r-rr)r)rwrrrr,)rr-_parse_section_to_dicts z$ConfigHandler._parse_section_to_dictc Cs<x6|D]*\}\}}tt|||<WdQRXq WdS)zQParses configuration file section. :param dict section_options: N)rt contextlibsuppressr)rqrrdrrIr,r,r- parse_sections zConfigHandler.parse_sectioncCslxf|jD]X\}}d}|r$d|}t|d|ddd}|dkr\td|jd|d||q WdS) zTParses configuration file items from one or more related sections. rz_%szparse_section%srs__Nz*Unsupported distribution option section: [])rortrArrrF)rq section_namerZmethod_postfixZsection_parser_methodr,r,r-rNszConfigHandler.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_DeprecatedConfigrf)argskwargs)funckwrkr,r-config_handlers z@ConfigHandler._deprecated_config_handler..config_handler)r)rqrrkrrr,)rrrkr-_deprecated_config_handlersz(ConfigHandler._deprecated_config_handler)r)N)r| __module__ __qualname____doc__r__annotations__rmrr AllCommandOptionsrrMrr classmethodrnpropertyr}rrrrr_PathrrrrrrrNrr,r,r,r-r0s0           r0csdeZdZdZdddddZdZdejfd ee e j e e ed fd d Zed dZddZZS)rJrPurl description classifiers platforms)Z home_pagesummary classifierplatformFNr)r=rUr(rTrOrcs"t||||||_||_dS)N)superrrrOr)rqr=rUr(rTrOr)r{r,r-rrs zConfigMetadataHandler.__init__cCsl|j}t|j|jd}|j}|j}||||j|ddd|||||d|j|dddd||||j|d S) z.Metadata item name to parser function mapping.)rz[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)rq parse_list parse_file parse_dictZexclude_files_parserr,r,r-r}#s. zConfigMetadataHandler.parserscCsp|||j}||krX|}y 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: ) rrrrrrrrrrO)rqrIrr,r,r-rGs z$ConfigMetadataHandler._parse_version)r|rrrFrmZ strict_moder3curdirrboolrrMr rDrrrrr}r __classcell__r,r,)r{r-rJs ( $rJrcseZdZdZdeeejdfdd Ze ddZ dd Z e e d d d Z ed dZddZddZddZddZddZddZddZddZdd ZZS)!rKrUr)r=rUr(rTcs$t|||||j|_i|_dS)N)rrrrQrrO)rqr=rUr(rT)r{r,r-rrdszConfigOptionsHandler.__init__cCs|j|ddS)N;)r)r)rwrIr,r,r-_parse_list_semicolonosz*ConfigOptionsHandler._parse_list_semicoloncCs|j||jdS)N)r)rr)rqrIr,r,r-_parse_file_in_rootssz(ConfigOptionsHandler._parse_file_in_root)rWrIcCs*|||}t|||dd|DS)NcSsg|]}|ds|qS)#)r])r^rr,r,r-r|szAConfigOptionsHandler._parse_requirements_list..)rrrl)rqrWrIrYr,r,r-_parse_requirements_listvs z-ConfigOptionsHandler._parse_requirements_listcCsT|j}|j}|j}|j}||||||||dt|jd|j|j|j|j |t |dS)z.Metadata item name to parser function mapping.zeThe namespace_packages parameter is deprecated, consider using implicit namespaces instead (PEP 420).install_requires)Zzip_safeZinclude_package_datarOscriptsZeager_resourcesZdependency_linksnamespace_packagesrZsetup_requiresZ tests_requirepackages entry_points py_modulesZpython_requirescmdclass) rrr_parse_cmdclassrrrr_parse_packagesrr)rqrZ parse_boolrZparse_cmdclassr,r,r-r}~s,zConfigOptionsHandler.parserscCs|jj}t||||jS)N)rTrOrrrr)rqrIrOr,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__findrorrSrrOrZ find_packages)rqrIZfind_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^kr) valid_keysr,r-rszEConfigOptionsHandler.parse_section_packages__find..Nr)rrrDrtr)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)rr)rqrrYr,r,r-parse_section_entry_pointssz/ConfigOptionsHandler.parse_section_entry_pointscCs|||j}t|S)N)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: rN)r)rqrr,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_dataN)r)rqrr,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)rr)rqr,r-rrzCConfigOptionsHandler.parse_section_extras_require..Zextras_requireN)r)rqrrYr,)rqr-parse_section_extras_requiresz1ConfigOptionsHandler.parse_section_extras_requirecCs$|||j}t||j|d<dS)z^Parses `data_files` configuration file section. :param dict section_options: data_filesN)rrrZcanonic_data_filesr)rqrrYr,r,r-parse_section_data_filessz-ConfigOptionsHandler.parse_section_data_files)r|rrrFrrrrMrrrrrrrrr}rrrrrrrrrrr,r,)r{r-rKas$  ! rKc@s$eZdZdZdZdZeddZdS)rezAmbiguous 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)rwrdocsr,r,r-rhs z_AmbiguousMarker.messageN)r|rrrrrrrhr,r,r,r-resrec@seZdZdZdS)rz!userguide/declarative_config.htmlN)r|rrrr,r,r,r-rsr)FF)r,F)F)@rrr@r3 collectionsrrrtypingrrrrr r r r r rrrerrorsrrZextern.packaging.markersrrbZextern.packaging.requirementsrrZextern.packaging.specifiersrZextern.packaging.versionrrwarningsrrrdistutils.distrr$rrPathLikerZSingleCommandOptionsrr rDr.r/rr&rCr'r;rrlr0rJrKrerr,r,r,r- sP   8         * #[