Your IP : 216.73.216.196
B
;��Yh � @ s� d Z ddlZddlZddlZddlmZmZ ddlmZ ddl m
Z
ddl m Z m
Z
ddlmZmZ d d
� ZG d d � d e�Zed
d�ZG dd� de�Zedd�ZdS )z)Configuration file parsing and utilities.� N)�Set�
namedtuple)�compile)�RawConfigParser� )� __version__�log)�
ErrorRegistry� conventionsc s � fdd�}|S )z4Check that the configuration object was initialized.c s, | j d ks| jd kr td��� | f|�|�S )Nz$using an uninitialized configuration)�
_arguments�_options� RuntimeError)�self�args�kwargs)�method� �B/opt/alt/python37/lib/python3.7/site-packages/pydocstyle/config.py�
_decorator s z%check_initialized.<locals>._decoratorr )r r r )r r �check_initialized s r c @ s* e Zd ZdZdZdZdZdZdZe j
Z dZ dZ
d d
� Zd d � Zd
d� Zedd� �Zedd� �Zdd� Zdd� Zedd� �Zdd� Zdd � Zd9d d �Zed d!� �Ze d:d#d$��Z e d%d&� �Z e d'd(� �Z e d)d*� �Z e d+d,� �Z!ed-d.� �Z"e d/d0� �Z#e d1d2� �Z$e d3d4� �Z%e d5d6� �Z&e d7d8� �Z'd S );�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.
)�
convention�select�ignorez
add-selectz
add-ignore�matchz match-dirzignore-decorators)r r r z(?!test_).*\.pyz[^\.].*� )z setup.cfgztox.iniz .pydocstylez.pydocstyle.iniz
.pydocstylercz.pydocstylerc.iniz.pep257)Z
pydocstyle�pep257c C s, i | _ d| _d | _ | _| _| �� | _dS )z Create a configuration parser.N)�_cache�_override_by_clir r � _run_conf�_create_option_parser�_parser)r r r r �__init__W s z ConfigurationParser.__init__c C s | � g �\}}| �|�S )z;Return a `RunConfiguration` object set with default values.)� _parse_args�_create_run_config)r �options�_r r r � get_default_run_configuration` s z1ConfigurationParser.get_default_run_configurationc C sX | � � \| _| _| jpdg| _| �| j�s0t� �| �| j�| _| j| jdd�}|| _dS )z�Parse 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.
�.F)� use_defaultsN) r# r r �_validate_options�IllegalConfigurationr$ r �_create_check_configr )r �configr r r �parsee s zConfigurationParser.parsec C s | j S )z,Return the run configuration for the script.)r )r r r r �get_user_run_configurationx s z.ConfigurationParser.get_user_run_configurationc
# s dd� }dd� }x�| j D ]�}tj�|�r�x�t�|�D ]�\}}}| �tj�|��}||�\}� ||�} � fdd�|D �|dd�< x4|D ],}
||
�r�tj�||
�} | t|j �| fV q�W q4W q| �tj�|��}||�\}} ||�} ||�r|t|j �| fV qW 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 S s( t | jd �j}t | jd �j}||fS )z:Return the `match` and `match_dir` functions for `config`.�$)�rer � match_dir)r- Z
match_funcZmatch_dir_funcr r r � _get_matches� s z<ConfigurationParser.get_files_to_check.<locals>._get_matchesc S s | j rt| j �}nd}|S )z0Return the `ignore_decorators` as None or regex.N)�ignore_decoratorsr1 )r- r4 r r r �_get_ignore_decorators� s zFConfigurationParser.get_files_to_check.<locals>._get_ignore_decoratorsc s g | ]}� |�r|�qS r r )�.0�dir)r2 r r �
<listcomp>� s z:ConfigurationParser.get_files_to_check.<locals>.<listcomp>N)
r �os�path�isdir�walk� _get_config�abspath�join�list�
checked_codes)
r r3 r5 �name�root�dirs� filenamesr- r r4 �filename� full_pathr& r )r2 r �get_files_to_check} s&
z&ConfigurationParser.get_files_to_checkc
C s� | � |�}|| jkr | j| S | �|�}|dkr^tj�|�\}}|rP| �|�}q�| �| j�}nH| � |�\}}tj�|�\}}|r�|r�| �|�} | �
| |�}n
| �|�}|S )a� 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.
N) �
_get_node_dirr �_get_config_file_in_folderr9 r: �splitr= r, r �_read_configuration_file�_merge_configuration)
r �noder: Z config_fileZ
parent_dir�tailr- r% �inherit�
parent_configr r r �_get_config_by_discovery� s
z,ConfigurationParser._get_config_by_discoveryc C s* | j jdkr"t�d� | �|�}n�t�d| j j� tj�| j j�sTtd� | j j���d| j
krh| j
d S | � | j j�\}}|dkr�t� d� | �
| j�}n
| �
|�}i }x8tjD ].}t| j|�}t||�}|dk r�|n|||< q�W tf |�}| �|j| j� | j jdk �r|| 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 r- r �debugrR r9 r: �existsr+ �formatr rL �warningr, r �CheckConfiguration�_fields�getattrr �_set_add_optionsrA rI ) r rN r- r% r& Z final_config�attrZcli_valZconf_valr r r r= � s2
z ConfigurationParser._get_configc C s( t j�| �}t j�|�r |S t j�|�S )z?Return the absolute path of the directory of a filesystem node.)r9 r: r> r; �dirname)rN r: r r r rI s z!ConfigurationParser._get_node_dirc C sn t dd�}d}d}|�|��rB| �|��rB| jjdd� }x | jjD ]}|�|j� qDW tdd� |D ��}| �g �\}} | �|�}
x�|� |
�D ]�} | dkr�|�
|
| �}q�| � dd �| j kr�t
�d
�| �� q�| � d d�} || }
|
d kr�|�|
| �}n2|
d k�r|�|
| �}n|
d
k�s t�|�
|
| �}t|| |� q�W | �|�}|dk �rf| �|��sftd�|���||fS )z�Try 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).
)�#�;)Zinline_comment_prefixesNTc S s g | ]}|j |jp|jf�qS r )�dest�type�action)r6 �or r r r8 6 s z@ConfigurationParser._read_configuration_file.<locals>.<listcomp>rP r& �-zUnknown option '{}' ignored)�int�count�string)�
store_trueZ store_falsez in file: {})r �read�_get_section_namer! � option_listZ
option_groups�extend�dictr# r% Z
getboolean�replace�CONFIG_FILE_OPTIONSr rV rU Zgetint�get�AssertionError�setattr�_fix_set_optionsr* r+ )r r: �parserr% Zshould_inheritZ all_options�grouprj Z new_optionsr& � section_name�optZnormalized_optZopt_type�valuer r r rL $ s@
z,ConfigurationParser._read_configuration_filec C sf t �|j�}| �|�r | �|�}| �||� t|d�}x$dD ] }t||�pRt||�||< q<W tf |�S )z�Merge 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.
)rA )r r2 r4 ) �copy�deepcopyrA �_has_exclusive_option�_get_exclusive_error_codesrZ rl rY rW )r rQ Z
child_optionsZ error_codesr �keyr r r rM [ s
z(ConfigurationParser._merge_configurationNc C s | j �||�\}}| �|�|fS )z@Parse the options using `self._parser` and reformat the options.)r! �
parse_argsrr )r r �valuesr% Z argumentsr r r r# p s z ConfigurationParser._parse_argsc s" t � fdd�tjD ��}tf |�S )z2Create a `RunConfiguration` object from `options`.c s g | ]}|t � |�f�qS r )rY )r6 rv )r% r r r8 x s z:ConfigurationParser._create_run_config.<locals>.<listcomp>)rl �RunConfigurationrX )r% r~ r )r% r r$ u s z&ConfigurationParser._create_run_configTc C sr d}| � |�s|r | �|�}t|d�}x@dD ]8}t||�dkrV|rVt| d�|�� ��nt||�||< q,W tf |�S )z�Create 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.
N)rA )r r2 r4 zDEFAULT_{0}_RE)rz �_get_checked_errorsrl rY rU �upperrW )�clsr% r) rA r r| r r r r, | s
&z(ConfigurationParser._create_check_configc C s" x | j D ]}|�|�r|S qW dS )z$Parse options from relevant section.N)�POSSIBLE_SECTION_NAMESZ has_section)r� rs ru r r r ri � s
z%ConfigurationParser._get_section_namec C sX t j�|�rt j�|�}x:| jD ]0}t� }t j�||�}|�|�r | �|�r |S q W dS )zkLook for a configuration file in `path`.
If exists return its full path, otherwise None.
N) r9 r: �isfiler\ �PROJECT_CONFIG_FILESr r? rh ri )r� r: �fnr- rG r r r rJ � s z.ConfigurationParser._get_config_file_in_folderc C sh t t�� �}d}|jdk r0| �|j�}|| }n.|jdk rH| �|j�}n|jdk r^tt|j�}t �
|�S )z;Extract the error codes from the selected exclusive option.N) �setr �get_error_codesr �_expand_error_codesr r rY r
rx ry )r� r% �codesrA Zignoredr r r r{ � s
z.ConfigurationParser._get_exclusive_error_codesc C s$ || � |j�O }|| � |j�8 }dS )z@Set `checked_codes` by the `add_ignore` or `add_select` options.N)r� �
add_select�
add_ignore)r� rA r% r r r rZ � s z$ConfigurationParser._set_add_optionsc
s� t t�� �}t � }yLxF| D ]>� � �� � � s,q� fdd�|D �}|sNt�d� � |�|� qW W n* tk
r� } z t|��W dd}~X Y nX |S )z0Return an expanded set of error codes to ignore.c s h | ]}|� � �r|�qS r )�
startswith)r6 �code)�partr r � <setcomp>� s z:ConfigurationParser._expand_error_codes.<locals>.<setcomp>z9Error code passed is not a prefix of any known errors: %sN) r� r r� �stripr �warn�update� TypeErrorr+ )Z
code_partsr� Zexpanded_codesZ codes_to_add�er )r� r r� � s
z'ConfigurationParser._expand_error_codesc C s( | � |�}|dkr| j}| �||� |S )z6Extract the codes needed to be checked from `options`.N)r{ �DEFAULT_CONVENTIONrZ )r� r% rA r r r r� � s
z'ConfigurationParser._get_checked_errorsc C s| xDt �| jd�D ]2\}}t||�rt||�rt�d�||�� dS qW |jrx|jtkrxt�d�|jd� t�
� ��� dS dS )z�Validate 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: {}z, T) � itertools� permutations� BASE_ERROR_SELECTION_OPTIONSrY r �errorrU r r
r? �keys)r� r% Zopt1Zopt2r r r r* � s
z%ConfigurationParser._validate_optionsc s t � fdd�| jD ��S )z>Return `True` iff one or more exclusive options were selected.c s g | ]}t � |�d k �qS )N)rY )r6 rv )r% r r r8 � s z=ConfigurationParser._has_exclusive_option.<locals>.<listcomp>)�anyr� )r� r% r )r% r rz � s z)ConfigurationParser._has_exclusive_optionc s� d}d}� fdd�}x.|D ]&}t ||�}|dk rt||||�� qW x@|D ]8}t ||�}|dkrdd}t|t�sv||�}t|||� qJW |S )z9Alter the set options from None/strings to sets in place.)r r )r� r� c s � � t| �d��dh �S )z�Split `value_str` by the delimiter `,` and return a set.
Removes any occurrences of '' in the set.
Also expand error code prefixes, to avoid doing this for every
file.
�,r )r� r� rK )Z value_str)r� r r �_get_set s z6ConfigurationParser._fix_set_options.<locals>._get_setNr )rY rq �
isinstancer )r� r% Zoptional_set_optionsZmandatory_set_optionsr� rv rw r )r� r rr s
z$ConfigurationParser._fix_set_optionsc C sN ddl m}m} |tdd�}|j}|ddddd d
� |d d ddd
d
� |dddddd
� |dddddd
� |ddddd
� |ddddd� ||dd �}|j}|d d dd d� |d d dd!d� |d"d#dd$�d%�t��d� |d&d dd'd� |d(d dd)d� |�|� |d*d+dd,�| j �d� |d-d+dd.�| j
�d� |d/d0dd1�| j �d� |S )2z<Return an option parser to parse the command line arguments.r )� OptionParser� OptionGroupz+Usage: pydocstyle [options] [<file|dir>...])�versionZusagez-ez --explainrg Fz show explanation of each error)ra �default�helpz-sz--sourcezshow source for each errorz-dz--debugzprint debug informationz-vz --verbosezprint status informationz--countz&print total number of errors to stdoutz--configz<path>Nz2use given config file and disable config discovery)�metavarr� r� 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--selectz<codes>z�choose 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--ignorez�choose 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 --conventionz<name>zgchoose the basic list of checked errors by specifying an existing convention. Possible conventions: {}.z, 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--matchz <pattern>z�check only files that exactly match <pattern> regular expression; default is --match='{}' which matches files that don't start with 'test_' but end with '.py'z --match-dirz�search only dirs that exactly match <pattern> regular expression; default is --match-dir='{}', which matches all dirs that don't start with a dotz--ignore-decoratorsz <decorators>z�ignore any functions or methods that are decorated by a function with a name fitting the <decorators> regular expression; default is --ignore-decorators='{0}' which does not ignore any decorated functions.) Zoptparser� r� r Z
add_optionrU r? r
Zadd_option_group�DEFAULT_MATCH_RE�DEFAULT_MATCH_DIR_RE� DEFAULT_IGNORE_DECORATORS_RE)r� r� r� rs ZoptionZ check_groupZ add_checkr r r r " sX
z)ConfigurationParser._create_option_parser)NN)T)(�__name__�
__module__� __qualname__�__doc__rn r� r� r� r� r
r r� r� r� r" r' r. r r/ rH rR r= � staticmethodrI rL rM r# r$ � classmethodr, ri rJ r{ rZ r� r� r* rz rr r r r r r r sB $
3*D 7
!r rW )rA r r2 r4 c @ s e Zd ZdZdS )r+ z(An exception for illegal configurations.N)r� r� r� r� r r r r r+ ~ s r+ r )Zexplain�sourcerS �verbosere r- )r� rx r� r9 � collectionsr r r1 r Z configparserr Zutilsr r Z
violationsr r
r �objectr rW � Exceptionr+ r r r r r �<module> s& c