1jЂ j d Z ddlZddlZddlZddlZddlZddlmZ ddlm Z ddl
m Z m Z m
Z
ddlmZ ddlmZ dd lmZ dd
lmZ dd lmZmZ ej d k rddlZn ddlZn
# e $ r dZY nw xY wd
Z G d d Z G d d Z edd Z G d de! Z" edd Z#dS )z)Configuration file parsing and utilities. N)
namedtuple)Set)
NoOptionErrorNoSectionErrorRawConfigParser)reduce)compile ) __version__)log)
ErrorRegistry conventions) c fd}|S )z4Check that the configuration object was initialized.c V | j | j t d | g|R i |S )Nz$using an uninitialized configuration)
_arguments_options RuntimeError)selfargskwargsmethods c/builddir/build/BUILD/cloudlinux-venv-1.0.11/venv/lib/python3.11/site-packages/pydocstyle/config.py
_decoratorz%check_initialized.._decorator sA ? "dm&; EFF Fvd,T,,,V,,, )r r s ` r check_initializedr s$ - - - - -
r c L e Zd ZdZd Zd
dZddZd Zd Zdd d
Z d Z
d Z dS )
TomlParsera ConfigParser 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.
c i | _ dS )zCreate a toml parser.N)_configr s r __init__zTomlParser.__init__. s
r Nc t |t t t j f r|g}g }|D ]} t |d 5 }t s"t j d| ddd =| j
t
j | ddd n # 1 swxY w Y n# t $ r Y w xY wt |t j rt j
| }| | |S )a Read 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.
rbzTThe %s configuration file was ignored, because the `tomli` package is not installed.N)
isinstancestrbytesosPathLikeopentomllibr warningr" updateloadOSErrorfspathappend)r filenamesencodingread_okfilenamefps r readzTomlParser.read2 sp i#ubk!: ; ; $" I! % %H
(D)) :R" ! L $
!: : : : : : : L'' R(8(8999: : : : : : : : : : : : : : :
(BK00
/ 9X.. NN8 $ $ $ $sA B0 B$ B0,,B$ B0$B( (B0+B( ,B00
B=<B=Fc t t j | d | j d }n# t
$ r d }Y nw xY wt
|t r|S |rd S t | )N.tool) r operatorgetitemsplitr" KeyErrorr' dictr )r section
allow_nonecurrents r _get_sectionzTomlParser._get_sectionS s
c"" V$ GG
GGG gt $ $ *N
*4 )) )s 9< A
A c 4 | |d duS )zCIndicate whether the named section is present in the configuration.T)rC N)rE )r rB s r has_sectionzTomlParser.has_sectiond s T ::$FFr c n | | }t | S )z9Return a list of option names for the given section name.)rE listkeys)r rB rD s r optionszTomlParser.optionsh s+ ##G,,GLLNN###r _convc R | | }| } || }n # t $ r t || w xY wt |t
rt
d| d| d |(t || st
d| d| d| |S )z(Get an option value for a given section.z Expected r; z to be an option, not a section.Nz The type of z should be )rE lowerr@ r r' rA TypeError)r rB optionrM dvalues r getzTomlParser.getm s g & & 1fIEE 1 1 1 00 0 1 eT " " NGNNfNNN
Zu%=%= CwCCCCECC
s 4 Ac < | ||t S )z/Get a boolean option value for a given section.rL )rT boolr rB rQ s r
getbooleanzTomlParser.getboolean s xxtx444r c < | ||t S )z0Get an integer option value for a given section.rL )rT intrW s r getintzTomlParser.getint s xxsx333r N)F) __name__
__module__ __qualname____doc__r$ r9 rE rG rK rT rX r[ r r r r r & s B* * * *"G G G$ $ $
-1 .5 5 54 4 4 4 4r r c e Zd ZdZdZdZdZdZdZdZ e
j Z dZ
d Zd
Zd Zd Zd
Zed Zed Zd Zd Zed Zd Zd Zd$dZ ed Z e d%d Z e d Z e d Z!e d Z"e d Z#ed Z$e d Z%e d Z&e d! Z'e d" Z(e d# Z)dS )&ConfigurationParsera Responsible 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-decoratorszignore-self-only-init)re rd rc z(?!test_).*\.pyz[^\.].* z2property,cached_property,functools.cached_propertyF)z setup.cfgztox.iniz .pydocstylez.pydocstyle.iniz
.pydocstylercz.pydocstylerc.inizpyproject.tomlz.pep257)
pydocstylepep257c ~ i | _ d| _ dx| _ x| _ | _ | | _ dS )z Create a configuration parser.N)_cache_override_by_clir r _run_conf_create_option_parser_parserr# s r r$ z ConfigurationParser.__init__ s= $ ;??
?$.1133 r c \ | g \ }}| | S )z;Return a `RunConfiguration` object set with default values.) _parse_args_create_run_config)r rK _s r get_default_run_configurationz1ConfigurationParser.get_default_run_configuration s- %%b))
&&w///r c : | \ | _ | _ | j pdg| _ | | j st | | j | _ | | j d }|| _ 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.
r; F) use_defaultsN) rq r r _validate_optionsIllegalConfigurationrr rm _create_check_configrl )r configs r parsezConfigurationParser.parse s *.)9)9););&
t /2cU%%dm44 )&(( ( 00 ??**4=u*MM & r c | j S )z,Return the run configuration for the script.)rm r# s r get_user_run_configurationz.ConfigurationParser.get_user_run_configuration s ~ r c # K d }d }d }| j D ]}t j | rt j | D ]\ }}}| t j | } || \ } || }
|| } fd|D |dd< t t j j | D ]M} | | r@t j || }
|
t |j |
| |j fV Nݐ| t j | } || \ } } || }
|| } | t j | r |t |j |
| |j fV dS )a Generate 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.
c z t | j dz j }t | j dz j }||fS )z:Return the `match` and `match_dir` functions for `config`.$)rerf match_dir)conf
match_funcmatch_dir_funcs r _get_matchesz._get_matches s; DJ ,--3J 4 5 5 ;N ~- -r c < | j rt | j ndS )z0Return the `ignore_decorators` as None or regex.N)ignore_decoratorsr r s r _get_ignore_decoratorszFConfigurationParser.get_files_to_check.._get_ignore_decorators s$ /3.DN4)***$
r c b | j r't | j d ndS )z0Return the `property_decorators` as None or set.,N)property_decoratorssetr? r s r _get_property_decoratorszHConfigurationParser.get_files_to_check.._get_property_decorators s5 +D,22377888
r c * g | ]} |
|S r r ).0rR r s r
z:ConfigurationParser.get_files_to_check..( s& ? ? ?Q))A,, ?q ? ? ?r N)
r r* pathisdirwalk _get_configabspathmapbasenamejoinrI
checked_codesignore_self_only_init)r r r r namerootdirsr4 rz rf r r r7 full_pathrs r s @r get_files_to_checkz&ConfigurationParser.get_files_to_check s+ . . . O ! ! Dw}}T""
-/WT]] )D$ ! - -bgood.C.C D DF'3|F';';$E9(>(>v(F(F%*B*B6*J*J' @ ? ? ?$ ? ? ?DG$'(8)$D$D 5?? (* T8(D(DI ) $V%9 : : 1 3 & < # ( ))"'//$*?*?@@'<//q$:$:6$B$B!&>&>v&F&F#5))$//00 V 122)+ 4 7! ! r c 2 | | }|| j v r
| j | S | | }|Ut j | \ }}|r| | }n| | j }n| | \ }}t j | \ }}|r.|r,| | } |
| | }n| | }|S )aw Get 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.
)
_get_node_dirrk _get_config_file_in_folderr* r r? r ry r _read_configuration_file_merge_configuration)
r noder config_file
parent_dirtailrz rK inherit
parent_configs
r _get_config_by_discoveryz,ConfigurationParser._get_config_by_discoveryD s !!$'' 4; ;t$ $55d;; !w}}T 2 2 J
B ))*55 224=AA $ < <[ I I GW !w}}T 2 2 J
<
< $ 0 0 < <
22='JJ 227;;
r c | j j *t j d | | }nt j d| j j t
j | j j s,t d | j j d| j
v r
| j
d S | | j j \ }}|/t j d |
| j }n|
| }i }t j D ]0}t# | j | }t# || }||n|||< 1t di |}| |j | j | j j || j
d< n || j
| | < |S )a Get 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.r )rm rz r debugr r* r existsrx formatrk r r. ry r CheckConfiguration_fieldsgetattrrl _set_add_optionsr r ) r r rz rK rs final_configattrcli_valconf_vals r r z ConfigurationParser._get_confign s : > ( I> ? ? ?22488FF I,dn.C D D D7>>$."788
*228& 9N2O2O
t{""{4(( 66t~7LMMJGQ G 224=AA 227;; &. N ND d 3T::G vt,,H,3,?XL #33l33 f 2DMBBB > , &DK 4:DK**400 1
r c t j | }t j | r|n t j | S )z?Return the absolute path of the directory of a filesystem node.)r* r r r dirname)r r s r r z!ConfigurationParser._get_node_dir sB wt$$w}}T**Ett0E0EEr c | d rt }nt d }d}d}| | r| | ry| j j dd }| j j D ] }| |j d |D }| g \ }} | | }
|
|
D ]} | dk r| |
| } | dd | j
vrt j d
| d U| d d } || }
|
d v r| |
| }n9|
d
k r| |
| }n |
dv sJ | |
| }t% || | | | }|'| | st+ d| ||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#;inline_comment_prefixesNTc 6 i | ]}|j |j p|j S r )desttypeaction)r os r
z@ConfigurationParser._read_configuration_file.. s% KKK!1616#5QXKKKr r rs -zUnknown option 'z ' ignored)rZ countstring)
store_true store_falsez in file: )endswithr r r9 _get_section_namero option_list
option_groupsextendrq rK rX replaceCONFIG_FILE_OPTIONSr r. r[ rT setattr_fix_set_optionsrw rx )r r parserrK should_inherit all_optionsgroupr new_optionsrs section_nameoptnormalized_optopt_typerS s r r z,ConfigurationParser._read_configuration_file sO == ! ! I \\FF$ZHHHF ;;t ! 9!7!7!?!? ! 9 ,21115K 3
6
6""5#45555KK{KKKK " - -b 1 1NK 11&99L ~~l33
<
<)##%+%6%6|S%I%IN ;;sC((0HHHK A3 A A ABBB !$S#!6!6&~6 /// "MM, < >>&&r c D t j |j }| | r| | }| || t
| }dD ])}t || }||nt || ||< *t di |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.
r rf r r r r Nr ) copydeepcopyr _has_exclusive_option_get_exclusive_error_codesr rA r r )r r
child_options error_codesr key child_values r r z(ConfigurationParser._merge_configuration s mM$?@@ % %m 4 4 I 99-HHK k=999K000
C "-55K * ]C00
3KK
"++F+++r Nc l | j || \ }}| | |fS )z@Parse the options using `self._parser` and reformat the options.)ro
parse_argsr )r r valuesrK argumentss r rq z ConfigurationParser._parse_args s7 !\ 4 4T6 B B$$W--y88r c L fdt j D }t di |S )z2Create a `RunConfiguration` object from `options`.c 2 i | ]}|t | S r r r r rK s r r z:ConfigurationParser._create_run_config.. s2
+.C#&&
r r )RunConfigurationr )rK r s ` r rr z&ConfigurationParser._create_run_config sD
2B2J
))&)))r Tc J d}| | s|r| | }t | }dddddd}| D ]=\ }}t || |rt | d | nt || ||< >t d
i |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.
Nr MATCH_RE MATCH_DIR_REIGNORE_DECORATORS_REPROPERTY_DECORATORSIGNORE_SELF_ONLY_INITr DEFAULT_r )r _get_checked_errorsrA itemsr r )clsrK rv r r defaultsr defaults r ry z(ConfigurationParser._create_check_config s
$ $W - - = = 3 3G < sD 6 $ $L!!,//
$####
$ tr c t j | r t j | }| j D ]}| d rt
}nt d }t j || }| | r|
| r|c S dS )zkLook for a configuration file in `path`.
If exists return its full path, otherwise None.
r r r N) r* r isfiler PROJECT_CONFIG_FILESr r r r r9 r )r r fnrz r s r r z.ConfigurationParser._get_config_file_in_folderG s 7>>$ )7??4((D* ! !B{{7##
M# (LLL T2..I{{9%%
!#*?*?*G*G
! ! !r c B t t j }d}|j | |j }||z
}nC|j | |j }n!|j t t |j }t j
| S )z;Extract the error codes from the selected exclusive option.N) r r
get_error_codesre _expand_error_codesrd rc r r r r )r rK codesr ignoreds r r z.ConfigurationParser._get_exclusive_error_codesZ s M13344
> %--gn==G !GOMM
^
' 3 3GN C CMM
+ #K1C D DM }]+++r c z || |j z }|| |j z }dS )z@Set `checked_codes` by the `add_ignore` or `add_select` options.N)r
add_select
add_ignore)r r rK s r r z$ConfigurationParser._set_add_optionsk s> 001CDDD
001CDDD
r c X t t j }t } | D ]S sfd|D }|st j d | | Tn"# t $ r}t | |d}~ww xY w|S )z0Return an expanded set of error codes to ignore.c > h | ]}| |S r )
startswith)r codeparts r z:ConfigurationParser._expand_error_codes.. s: !dood.C.C r z9Error code passed is not a prefix of any known errors: %sN) r r
r stripr r. r/ rP rx )
code_partsr expanded_codes codes_to_adder s @r r z'ConfigurationParser._expand_error_codesq s M13344 1"
4
4 zz|| %* $ K+
%%l3333!
4" 1 1 1&q))q 0 1 s AB
B'B""B'c n | | }|| j }| || |S )z6Extract the codes needed to be checked from `options`.)r DEFAULT_CONVENTIONr )r rK r s r r z'ConfigurationParser._get_checked_errors sA 66w??
2M ]G444 r c t j | j d D ]P\ }}t || r;t || r+t j d || dS Q|j ra|j t vrSt j d |j d t j
dS dS )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 permutations BASE_ERROR_SELECTION_OPTIONSr r errorr rc r r rJ )r rK opt1opt2s r rw z%ConfigurationParser._validate_options s $0 ,a
JD$ w%%
''4*@*@
**0&t*<*< uu '"4K"G"G ICJJ& +2B2D2D(E(E
5tr c D t fd| j D S )z>Return `True` iff one or more exclusive options were selected.c 4 g | ]}t | d uS r\ r r s r r z=ConfigurationParser._has_exclusive_option.. s8
%%T1
r )anyr )r rK s `r r z)ConfigurationParser._has_exclusive_option s@
;
r c d}d} fd}|D ].}t || }|t || || /|D ]G}t || }|d}t |t s || }t ||| H|S )z9Alter the set options from None/strings to sets in place.)re rd )r
r c t | t r| d } d | D dhz
S )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.
r c 6 h | ]}| S r )r )r xs r r zIConfigurationParser._fix_set_options.._get_set.. s ...q...r rg )r' r( r? r ) value_strr s r _get_setz6ConfigurationParser._fix_set_options.._get_set sX )S))
1 %OOC 0 0 **..I..."5
r Nrg )r r r' r )r rK optional_set_optionsmandatory_set_optionsr, r rS s ` r r z$ConfigurationParser._fix_set_options s 4 < ( 7 7CGS))E hhuoo666( ) )CGS))E} eS))
( GS% ( ( ( (r c
ddl m}m} |t d }|j } |ddddd
|d d ddd
|ddddd
|ddddd
|dddd
|dddd | ||dd ||d d }|j } |d d dd! |d"d dd# |d$d%dd& d' t |d(d dd) |d*d dd+ |d,ddd-. | | |d/d0dd1 | j |d2d0dd3 | j
|d4d5dd6 | j |d7d8dd9 | j |S ):z...])versionusagez-ez --explainr Fz show explanation of each error)r r helpz-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)metavarr r4 NotezWhen 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 Optionsa Only 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: {}.r z --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--ignore-self-only-initz5ignore __init__ methods which only have a self param.)r r r4 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.z--property-decoratorszzconsider any method decorated with one of these decorators as a property, and consequently allow a docstring which is not in imperative mood; default is --property-decorators='{}')
optparser0 r1 r
add_optionadd_option_groupr r r DEFAULT_MATCH_REDEFAULT_MATCH_DIR_RE DEFAULT_IGNORE_DECORATORS_REDEFAULT_PROPERTY_DECORATORS)r r0 r1 r rQ check_group add_checks r rn z)ConfigurationParser._create_option_parser s 76666666 ?
" 1
-
*
+
9
E
K4
"k !
=
* ,
,
@@F +&&A A
% H
,,, fS)**
fS-..
!"B CI&4C C
#+0 1731 1
r )NN)T)*r] r^ r_ r` r r r: r; r< r= r ri r DEFAULT_IGNORE_SELF_ONLY_INITr r r$ rt r{ r r} r r r staticmethodr r r rq rr classmethodry r r r r r r rw r r rn r r r rb rb s # #J
$F )%#% < %+$)!
64 4 40 0 0
' ' '& B B BL( ( (TE E EN F F \F
7' 7' 7'r , , ,>9 9 9 9
* * \* , , , [,: [ ! ! [!$ , , [, E E [E
\ 8 [ [4
[
" " ["H v v [v v vr rb r )r rf r r r r c e Zd ZdZdS )rx z(An exception for illegal configurations.N)r] r^ r_ r` r r r rx rx s 22Dr rx r )explainsourcer verboser rz )$r` r r r= r* sys collectionsr collections.abcr configparserr r r functoolsr r r _versionr utilsr
violationsr
r version_infor- tomli ImportErrorr r rb r Exceptionrx r r r r rS s / /
" " " " " " G G G G G G G G G G ! ! ! ! ! ! 2 2 2 2 2 2 2 2w NNNN d4 d4 d4 d4 d4 d4 d4 d4NM M M M M M M M b Z
9 :@ s A# #A-,A-