a `y@sdZddlZddlZddlZddlZddlmZddlmZddl m Z m Z m Z ddl mZddlmZdd lmZmZdd lmZmZz ddlZWneydZYn0d d ZGd ddZGdddZeddZGdddeZeddZdS)z)Configuration file parsing and utilities.N) namedtuple)Set) NoOptionErrorNoSectionErrorRawConfigParser)reduce)compile) __version__log) ErrorRegistry conventionscsfdd}|S)z4Check that the configuration object was initialized.cs2|jdus|jdurtd|g|Ri|S)Nz$using an uninitialized configuration) _arguments_options RuntimeError)selfargskwargsmethod0lib/python3.9/site-packages/pydocstyle/config.py _decoratorsz%check_initialized.._decoratorr)rrrrrcheck_initializeds rc@sZeZdZdZddZdddZddd Zd d Zd d ZddddZ ddZ ddZ dS) TomlParseraConfigParser that partially mimics RawConfigParser but for toml files. See RawConfigParser for more info. Also, please note that not all RawConfigParser functionality is implemented, but only the subset that is currently used by pydocstyle. cCs i|_dS)zCreate a toml parser.N)_configrrrr__init__)szTomlParser.__init__Nc Cst|tttjfr|g}g}|D]}zbt||dB}tsTtd|WdWq |j t |Wdn1sz0YWnt yYq Yn0t|tjrt |}||q |S)aRead and parse a filename or an iterable of filenames. Files that cannot be opened are silently ignored; this is designed so that you can specify an iterable of potential configuration file locations (e.g. current directory, user's home directory, systemwide directory), and all existing configuration files in the iterable will be read. A single filename may also be given. Return list of successfully read files. )encodingzSThe %s configuration file was ignored, because the `toml` package is not installed.N) isinstancestrbytesosPathLikeopentomlr warningrupdateloadOSErrorfspathappend)r filenamesrZread_okfilenamefprrrread-s& 4     zTomlParser.readFcCsXzttj|d|jd}Wnty4d}Yn0t|trD|S|rLdSt|dS)N.Ztool) roperatorgetitemsplitrKeyErrorrdictr)rsection allow_nonecurrentrrr _get_sectionNs   zTomlParser._get_sectioncCs|j|ddduS)zCIndicate whether the named section is present in the configuration.T)r7N)r9)rr6rrr has_section_szTomlParser.has_sectioncCs||}t|S)z9Return a list of option names for the given section name.)r9listkeys)rr6r8rrroptionscs zTomlParser.options_convcCs||}|}z ||}Wnty:t||Yn0t|tr\td|d|d|durt||std|d|d||S)z(Get an option value for a given section.z Expected r0z to be an option, not a section.Nz The type of z should be )r9lowerr4rrr5 TypeError)rr6optionr?dvaluerrrgeths    zTomlParser.getcCs|j||tdS)z/Get a boolean option value for a given section.r>)rEboolrr6rBrrr getbooleanszTomlParser.getbooleancCs|j||tdS)z0Get an integer option value for a given section.r>)rEintrGrrrgetintszTomlParser.getint)N)F) __name__ __module__ __qualname____doc__rr/r9r:r=rErHrJrrrrr!s ! rc@s*eZdZdZdZdZdZdZdZe j Z dZ dZ d d Zd d Zd dZeddZeddZddZddZeddZddZddZd9ddZed d!Zed:d#d$Zed%d&Zed'd(Zed)d*Z ed+d,Z!ed-d.Z"ed/d0Z#ed1d2Z$ed3d4Z%ed5d6Z&ed7d8Z'dS);ConfigurationParseraResponsible for parsing configuration from files and CLI. There are 2 types of configurations: Run configurations and Check configurations. Run Configurations: ------------------ Responsible for deciding things that are related to the user interface and configuration discovery, e.g. verbosity, debug options, etc. All run configurations default to `False` or `None` and are decided only by CLI. Check Configurations: -------------------- Configurations that are related to which files and errors will be checked. These are configurable in 2 ways: using the CLI, and using configuration files. Configuration files are nested within the file system, meaning that the closer a configuration file is to a checked file, the more relevant it will be. For instance, imagine this directory structure: A +-- tox.ini: sets `select=D100` +-- B +-- foo.py +-- tox.ini: sets `add-ignore=D100` Then `foo.py` will not be checked for `D100`. The configuration build algorithm is described in `self._get_config`. Note: If any of `BASE_ERROR_SELECTION_OPTIONS` was selected in the CLI, all configuration files will be ignored and each file will be checked for the error codes supplied in the CLI. ) conventionselectignorez add-selectz add-ignorematchz match-dirzignore-decorators)rRrQrPz(?!test_).*\.pyz[^\.].*)z setup.cfgztox.iniz .pydocstylez.pydocstyle.iniz .pydocstylercz.pydocstylerc.inizpyproject.tomlz.pep257)Z pydocstylepep257cCs,i|_d|_d|_|_|_||_dS)zCreate a configuration parser.N)_cache_override_by_clirr _run_conf_create_option_parser_parserrrrrrszConfigurationParser.__init__cCs|g\}}||S)z;Return a `RunConfiguration` object set with default values.) _parse_args_create_run_config)rr=_rrrget_default_run_configurationsz1ConfigurationParser.get_default_run_configurationcCsX|\|_|_|jpdg|_||js0t||j|_|j|jdd}||_dS)zParse the configuration. If one of `BASE_ERROR_SELECTION_OPTIONS` was selected, overrides all error codes to check and disregards any error code related configurations from the configuration files. r0F) use_defaultsN) r[rr_validate_optionsIllegalConfigurationr\rX_create_check_configrW)rconfigrrrparses zConfigurationParser.parsecCs|jS)z,Return the run configuration for the script.)rXrrrrget_user_run_configurationsz.ConfigurationParser.get_user_run_configurationc #sdd}dd}|jD]}tj|rt|D]|\}}}|tj|}||\}||} fdd|D|dd<|D],} || r~tj|| } | t|j | fVq~q0q|tj|}||\}} ||} ||r|t|j | fVqdS)aGenerate files and error codes to check on each one. Walk dir trees under `self._arguments` and yield file names that `match` under each directory that `match_dir`. The method locates the configuration for each file name and yields a tuple of (filename, [error_codes]). With every discovery of a new configuration file `IllegalConfiguration` might be raised. cSs(t|jdj}t|jdj}||fS)z:Return the `match` and `match_dir` functions for `config`.$)rerS match_dir)confZ match_funcZmatch_dir_funcrrr _get_matchessz._get_matchescSs|jrt|jSdS)z0Return the `ignore_decorators` as None or regex.N)ignore_decoratorsrg)rirrr_get_ignore_decoratorsszFConfigurationParser.get_files_to_check.._get_ignore_decoratorscsg|]}|r|qSrr).0rCrhrr z:ConfigurationParser.get_files_to_check..N) rr"pathisdirwalk _get_configabspathjoinr; checked_codes) rrjrlnamerootdirsr,rcrSrkr- full_pathr]rrnrget_files_to_checks*     z&ConfigurationParser.get_files_to_checkc Cs||}||jvr|j|S||}|dur^tj|\}}|rP||}q||j}nH| |\}}tj|\}}|r|r||} | | |}n ||}|S)awGet a configuration for checking `node` by config discovery. Config discovery happens when no explicit config file is specified. The file system is searched for config files starting from the directory containing the file being checked, and up until the root directory of the project. See `_get_config` for further details. N) _get_node_dirrV_get_config_file_in_folderr"rqr3rtrbr_read_configuration_file_merge_configuration) rnoderqZ config_fileZ parent_dirtailrcr=inherit parent_configrrr_get_config_by_discovery(s       z,ConfigurationParser._get_config_by_discoveryc Cs*|jjdur"td||}ntd|jjtj|jjsTtd |jjd|j vrh|j dS| |jj\}}|durt d| |j}n | |}i}tjD].}t|j|}t||}|dur|n|||<qtfi|}||j|j|jjdur||j d<n||j ||<|S)aGet and cache the run configuration for `node`. If no configuration exists (not local and not for the parent node), returns and caches a default configuration. The algorithm: ------------- * If the current directory's configuration exists in `self._cache` - return it. * If a configuration file does not exist in this directory: * If the directory is not a root directory: * Cache its configuration as this directory's and return it. * Else: * Cache a default configuration and return it. * Else: * Read the configuration file. * If a parent directory exists AND the configuration file allows inheritance: * Read the parent configuration by calling this function with the parent directory as `node`. * Merge the parent configuration with the current one and cache it. * If the user has specified one of `BASE_ERROR_SELECTION_OPTIONS` in the CLI - return the CLI configuration with the configuration match clauses * Set the `--add-select` and `--add-ignore` CLI configurations. Nz&No config file specified, discovering.zUsing config file %rz=Configuration file {!r} specified via --config was not found.zVConfiguration file does not contain a pydocstyle section. Using default configuration.)rXrcr debugrr"rqexistsraformatrVrr&rbrCheckConfiguration_fieldsgetattrrW_set_add_optionsrwr}) rrrcr=r]Z final_configattrZcli_valZconf_valrrrrtRs<          zConfigurationParser._get_configcCs(tj|}tj|r|Stj|S)z?Return the absolute path of the directory of a filesystem node.)r"rqrurrdirname)rrqrrrr}s z!ConfigurationParser._get_node_dircCsx|drt}n tdd}d}d}||rL||rL|jjdd}|jjD]}||jqTdd|D}| g\}} ||} | | D]} | dkr| | | }q| d d |j vrtd | d q| d d } || } | d vr|| | }n2| dkr|| | }n| dvs(J| | | }t|| |q||}|durp||sptd|||fS)zTry to read and parse `path` as a configuration file. If the configurations were illegal (checked with `self._validate_options`), raises `IllegalConfiguration`. Returns (options, should_inherit). .toml#;Zinline_comment_prefixesNTcSsi|]}|j|jp|jqSr)desttypeaction)rmorrr rpz@ConfigurationParser._read_configuration_file..rr]-zUnknown option 'z ' ignored)rIcountstring) store_true store_falsez in file: )endswithrrr/_get_section_namerZ option_listZ option_groupsextendr[r=rHreplaceCONFIG_FILE_OPTIONSr r&rJrEsetattr_fix_set_optionsr`ra)rrqparserr=Zshould_inheritZ all_optionsgrouprZ new_optionsr] section_nameoptZnormalized_optZopt_typerDrrrrsB            z,ConfigurationParser._read_configuration_filecCsft|j}||r ||}|||t|d}dD]}t||pPt||||<q:tfi|S)zMerge parent config into the child options. The migration process requires an `options` object for the child in order to distinguish between mutually exclusive codes, add-select and add-ignore error codes. rwrSrhrk) copydeepcopyrw_has_exclusive_option_get_exclusive_error_codesrr5rr)rrZ child_optionsZ error_codesrkeyrrrrs       z(ConfigurationParser._merge_configurationNcCs |j||\}}|||fS)z@Parse the options using `self._parser` and reformat the options.)rZ parse_argsr)rrvaluesr=Z argumentsrrrr[szConfigurationParser._parse_argscs"fddtjD}tfi|S)z2Create a `RunConfiguration` object from `options`.csi|]}|t|qSrrrmrr=rrrsz:ConfigurationParser._create_run_config..)RunConfigurationr)r=rrrrr\s z&ConfigurationParser._create_run_configTcCstd}||s|r||}t|d}dD]:}t||durV|rVt|d|dnt||||<q*tfi|S)zCreate a `CheckConfiguration` object from `options`. If `use_defaults`, any of the match options that are `None` will be replaced with their default value and the default convention will be set for the checked codes. NrrZDEFAULT_Z_RE)r_get_checked_errorsr5rupperr)clsr=r_rwrrrrrrbs    z(ConfigurationParser._create_check_configcCs"|jD]}||r|SqdS)z$Parse options from relevant section.N)POSSIBLE_SECTION_NAMESr:)rrrrrrrs   z%ConfigurationParser._get_section_namecCsntj|rtj|}|jD]J}|dr4t}n tdd}tj||}| |r| |r|SqdS)zkLook for a configuration file in `path`. If exists return its full path, otherwise None. rrrN) r"rqisfilerPROJECT_CONFIG_FILESrrrrvr/r)rrqfnrcr{rrrr~s     z.ConfigurationParser._get_config_file_in_foldercCshtt}d}|jdur0||j}||}n.|jdurH||j}n|jdur^tt|j}t |S)z;Extract the error codes from the selected exclusive option.N) setr get_error_codesrR_expand_error_codesrQrPrr rr)rr=codesrwZignoredrrrr.s       z.ConfigurationParser._get_exclusive_error_codescCs$|||jO}|||j8}dS)z@Set `checked_codes` by the `add_ignore` or `add_select` options.N)r add_select add_ignore)rrwr=rrrr?sz$ConfigurationParser._set_add_optionsc stt}t}zH|D]>s*qfdd|D}|sLtd||qWn.ty}zt||WYd}~n d}~00|S)z0Return an expanded set of error codes to ignore.csh|]}|r|qSr) startswith)rmcodepartrr Ssz:ConfigurationParser._expand_error_codes..z9Error code passed is not a prefix of any known errors: %sN) rr rstripr r&r'rAra)Z code_partsrZexpanded_codesZ codes_to_adderrrrEs&   z'ConfigurationParser._expand_error_codescCs(||}|dur|j}||||S)z6Extract the codes needed to be checked from `options`.N)rDEFAULT_CONVENTIONr)rr=rwrrrrbs   z'ConfigurationParser._get_checked_errorsc Cszt|jdD]4\}}t||rt||rtd||dSq|jrv|jtvrvtd|jd t dSdS)zValidate the mutually exclusive options. Return `True` iff only zero or one of `BASE_ERROR_SELECTION_OPTIONS` was selected. z8Cannot pass both {} and {}. They are mutually exclusive.Fz1Illegal convention '{}'. Possible conventions: {}, T) itertools permutationsBASE_ERROR_SELECTION_OPTIONSrr errorrrPr rvr<)rr=Zopt1Zopt2rrrr`ms$ z%ConfigurationParser._validate_optionscstfdd|jDS)z>Return `True` iff one or more exclusive options were selected.csg|]}t|duqS)Nrrrrrrosz=ConfigurationParser._has_exclusive_option..)anyr)rr=rrrrs  z)ConfigurationParser._has_exclusive_optioncsd}d}fdd}|D]&}t||}|durt||||q|D]8}t||}|dur^d}t|tsp||}t|||qD|S)z9Alter the set options from None/strings to sets in place.)rRrQ)rrcs.t|tr|d}dd|DdhS)zSplit `value_str` by the delimiter `,` and return a set. Removes empty values ('') and strips whitespace. Also expands error code prefixes, to avoid doing this for every file. ,cSsh|] }|qSr)r)rmxrrrrrpzIConfigurationParser._fix_set_options.._get_set..rT)rr r3r)Z value_strrrr_get_sets   z6ConfigurationParser._fix_set_options.._get_setNrT)rrrr)rr=Zoptional_set_optionsZmandatory_set_optionsrrrDrrrrs    z$ConfigurationParser._fix_set_optionsc Cs`ddlm}m}|tdd}|j}|ddddd d |d d ddd d |dddddd |dddddd |ddddd |ddddd|||dd||dd}|j}|dd dd!d|d"d dd#d|d$d%dd&d'td|d(d dd)d|d*d dd+d|||d,d-dd.|j d|d/d-dd0|j d|d1d2dd3|j d|S)4z...])versionusagez-ez --explainrFzshow explanation of each error)rdefaulthelpz-sz--sourcezshow source for each errorz-dz--debugzprint debug informationz-vz --verbosezprint status informationz--countz&print total number of errors to stdoutz--configzNz2use given config file and disable config discovery)metavarrrZNotezWhen using --match, --match-dir or --ignore-decorators consider whether you should use a single quote (') or a double quote ("), depending on your OS, Shell, etc.zError Check OptionsaOnly one of --select, --ignore or --convention can be specified. If none is specified, defaults to `--convention=pep257`. These three options select the "basic list" of error codes to check. If you wish to change that list (for example, if you selected a known convention but wish to ignore a specific error from it or add a new one) you can use `--add-[ignore/select]` in order to do so.z--selectzzchoose the basic list of checked errors by specifying which errors to check for (with a list of comma-separated error codes or prefixes). for example: --select=D101,D2z--ignorezchoose the basic list of checked errors by specifying which errors to ignore out of all of the available error codes (with a list of comma-separated error codes or prefixes). for example: --ignore=D101,D2z --conventionzzgchoose the basic list of checked errors by specifying an existing convention. Possible conventions: {}.rz --add-selectzpadd extra error codes to check to the basic list of errors previously set by --select, --ignore or --convention.z --add-ignorezsignore extra error codes by removing them from the basic list previously set by --select, --ignore or --convention.z--matchz zcheck only files that exactly match regular expression; default is --match='{}' which matches files that don't start with 'test_' but end with '.py'z --match-dirzsearch only dirs that exactly match regular expression; default is --match-dir='{}', which matches all dirs that don't start with a dotz--ignore-decoratorsz zignore any functions or methods that are decorated by a function with a name fitting the regular expression; default is --ignore-decorators='{}' which does not ignore any decorated functions.) Zoptparserrr Z add_optionZadd_option_grouprrvr DEFAULT_MATCH_REDEFAULT_MATCH_DIR_REDEFAULT_IGNORE_DECORATORS_RE)rrrrrBZ check_groupZ add_checkrrrrYs        z)ConfigurationParser._create_option_parser)NN)T)(rKrLrMrNrrrrrr rUrrrrr^rdrrer|rrt staticmethodr}rrr[r\ classmethodrbrr~rrrrr`rrrYrrrrrOs^%     4*G 9            $rOr)rwrSrhrkc@seZdZdZdS)raz(An exception for illegal configurations.N)rKrLrMrNrrrrraesrar)Zexplainsourcerverboserrc) rNrrr1r" collectionsrcollections.abcrZ configparserrrr functoolsrrgrZutilsr r Z violationsr r r% ImportErrorrrrOr Exceptionrarrrrrs@        g\