oGW d Z ddlZddlZddlZddlZddlZddlZddlZddlm Z ddlm
Z
ddlm Z ddlm Z ddlm
Z
ddlmZ dd lmZ dd
lmZ dd lmZ dd lmZ dd
lmZ ddlmZ ddlmZ dZ ej e Z G d dej Z G d dej Z G d dej Z!de e e" de e e" dee"df fdZ#de e e" d ee"df d e e" de e e" dee"df f
d Z$ G d d Z% G d! d" Z& G d# d$ Z'dS )%z0Implementation of the StyleGuide used by Flake8. N)Dict) Generator)List)Optional)Sequence)Set)Tuple)Union)defaults)
statistics)utils)base) Violation)
StyleGuidec e Zd ZdZdZdZdS )Selectedz($
$
$
#5>(#
#
#
'> O $ <(
&> O $ <(
r codec | | j r t j S | | j r t j S t j S )a Determine if the code has been selected by the user.
:param code: The code for the check that has been run.
:returns:
Selected.Implicitly if the selected list is empty,
Selected.Explicitly if the selected list is not empty and a match
was found,
Ignored.Implicitly if the selected list is not empty but no match
was found.
)
startswithr7 r r r= r r rA rC s r was_selectedzDecisionEngine.was_selectedk sL ??43 4 4 && &
__T]
+
+ && &% %r c | | j r t j S | | j r t j S t j S )a Determine if the code has been ignored by the user.
:param code:
The code for the check that has been run.
:returns:
Selected.Implicitly if the ignored list is empty,
Ignored.Explicitly if the ignored list is not empty and a match was
found,
Selected.Implicitly if the ignored list is not empty but no match
was found.
)rE r: r r r@ r r rF s r was_ignoredzDecisionEngine.was_ignored} sL ??42 3 3 '% %
__T\
*
* '% %& &r c | }| }t d|| t |t
r!t |t
r t j S t |t r!t |t r t j S |t
j u r|t j ur t j S |t
j ur|t j u r t j S |t j u r|t
j u r t j S |t
j u r|t j u s |t
j u r|t j u rxt fd| j D }t fd| j D }t | t | k r t j S t j S t d d| d| )z-Decide if code should be ignored or selected.z#The user configured %r to be %r, %rc 3 F K | ]} | |V d S NrE .0srC s r z/DecisionEngine.make_decision.. s4 IIdooa6H6HI!IIIIIIr c 3 F K | ]} | |V d S rL rM rN s r rQ z/DecisionEngine.make_decision.. s4 HHT__Q5G5GH!HHHHHHr z unreachable )rG rI LOGdebug
isinstancer r r r r nextr= r@ lenAssertionError)rA rC r= r@ r5 r8 s ` r
make_decisionz DecisionEngine.make_decision s $$T**""4(( 1
h ) ) Mj(.K.K M$ $
'
*
* Mz'7/K/K M# # + + +w 111$ $ H / / /7---# #
+
+
+8;N0N0N# # + + +7;M0M0M + + +7;M0M0M IIIIT]IIIIIFHHHHT\HHHHHF6{{S[[(( (( '' !K!K!Kx!K!K'!K!KLL Lr c | j | }|;| | }|| j |< t d|| |S )a Return the decision for a specific code.
This method caches the decisions for codes to avoid retracing the same
logic over and over again. We only care about the select and ignore
rules as specified by the user in their configuration files and
command-line flags.
This method does not look at whether the specific line is being
ignored in the file itself.
:param code: The code for the check that has been run.
Nz"%s" will be "%s")r4 getrZ rT rU )rA rC decisions r decision_forzDecisionEngine.decision_for sX :>>$'' ))$//H 'DJt II)4 : : :r )r r r r argparse NamespacerB strr
r r rG rI r rZ r^ r r r r1 r1 J s
2
t
4& &x/@)A & & & &$' 'h.?(@ ' ' ' '&(M# (M( (M (M (M (MT r r1 c e Zd ZdZ ddej dej dee ddfdZ
dej de d fd Z d
e
dd fd Zej d
e
de d fd
Z dde
d
e
dedede
dee
defdZdee
ee f ddfdZdS )StyleGuideManagerz.Manage multiple style guides for a single run.Nr2 formatterdeciderr# c || _ || _ t j | _ |pt | | _ g | _ t ||| j | | _ t t j | j g|
| | _ t j d | j | _ dS )SInitialize our StyleGuide.
.. todo:: Add parameter documentation.
)re N)maxsize)r2 rd r
Statisticsstatsr1 re style_guidesr default_style_guidelist itertoolschainpopulate_style_guides_with functools lru_cache_style_guide_forstyle_guide_for)rA r2 rd re s r rB zStyleGuideManager.__init__ s " *,,
9."9"9 .0#- Y
G$
$
$
! O)*//88
Ay 24 @ @ @ !
r r NNc # K t j |j }|D ]#\ }}| j || V $dS )zGenerate style guides from the per-file-ignores option.
:param options:
The original options parsed from the CLI and config file.
:returns:
A copy of the default style guide with overridden values.
)filenameextend_ignore_withN)r
parse_files_to_codes_mappingper_file_ignoresrl copy)rA r2 per_filerw
violationss r rp z,StyleGuideManager.populate_style_guides_with sm 5g6NOO$, Hj*//!j 0
r rw r c J t fd| j D d S )z3Find the StyleGuide for the filename in particular.c 3 F K | ]}| |V d S rL )
applies_to)rO grw s r rQ z5StyleGuideManager._style_guide_for.. s4 D D1Q\\(-C-C DQ D D D D D Dr c . t | j pd S )N )rX rw )r s r z4StyleGuideManager._style_guide_for.. s #aj .B// r )key)maxrk rA rw s `r rs z"StyleGuideManager._style_guide_for s: D D D D) D D D//
r c # K | | }| | 5 |V ddd dS # 1 swxY w Y dS z9Record the fact that we're processing the file's results.N)rt processing_file)rA rw guides r r z!StyleGuideManager.processing_file s
$$X..
"
"8
,
, KKK s ?AArC line_number
column_numbertext
physical_linec ` | | }| |||||| S ) Handle an error reported by a check.
:param code:
The error code found, e.g., E123.
:param filename:
The file in which the error was found.
:param line_number:
The line number (where counting starts at 1) at which the error
occurs.
:param column_number:
The column number (where counting starts at 1) at which the error
occurs.
:param text:
The text of the error message.
:param physical_line:
The actual physical line causing the error.
:returns:
1 if the error was reported. 0 if it was ignored. This is to allow
for counting of the number of errors found that were not ignored.
)rt handle_error)rA rC rw r r r r r s r r z StyleGuideManager.handle_error s< : $$X..!! (K m
r diffinfoc D | j D ]}| | dS )a5 Update the StyleGuides to filter out information not in the diff.
This provides information to the underlying StyleGuides so that only
the errors in the line number ranges are reported.
:param diffinfo:
Dictionary mapping filenames to sets of line number ranges.
N)rk add_diff_ranges)rA r r s r r z!StyleGuideManager.add_diff_ranges1 s7 & , ,E ! !( + + + + , ,r rL )r r r r r_ r` base_formatter
BaseFormatterr r1 rB r rp ra rs
contextlibcontextmanagerr intr r r r r r r rc rc s 88 -1
#
"/
.)
: ) + ,
+ , (,
}
D
,S#c(](;
,
,
,
,
,
,
,r rc c j e Zd ZdZ ddej dej dej de
e de
e f
dZ
d e fd
Z dde
e d e
ee d d fd Zej de d ed
fd Zde d efdZde d efdZ dde de dedede de
e d efdZdee e e f d dfdZ dS )r z#Manage a Flake8 user's style guide.Nr2 rd rj rw re c || _ || _ || _ |pt | | _ || _ | j r t
j | j | _ i | _ dS )rg N) r2 rd rj r1 re rw r
normalize_path _parsed_diff)rA r2 rd rj rw re s r rB zStyleGuide.__init__A sa "
9."9"9
= @ ! 0 ? ?DM13r r# c d| j dS )z5Make it easier to debug which StyleGuide we're using.z
rw )rA s r __repr__zStyleGuide.__repr__V s 0t}0000r rx c |p| j }t j | j }|j pg |_ |j |pg t
|| j | j | S )z8Create a copy of this style guide with different values.r ) rw r{ deepcopyr2 r9 r" r rd rj )rA rw rx r2 s r r{ zStyleGuide.copyZ sr ,t}- -- ' 5 ; $$%7%=2>>> T^TZ(
r ru c # z K | j | | V | j | dS r )rd beginningfinishedr s r r zStyleGuide.processing_fileh sC
***
)))))r c ` | j dS t j || j g| dt S )a Check if this StyleGuide applies to the file.
:param filename:
The name of the file with violations that we're potentially
applying this StyleGuide to.
:returns:
True if this applies, False otherwise
NTz! does %(whether)smatch "%(path)s")patterns log_messagelogger)rw r
matches_filenamerT r s r r zStyleGuide.applies_toq sD = 4% m_ DDD
r rC c 6 | j | S )a Determine if the error code should be reported or ignored.
This method only cares about the select and ignore rules as specified
by the user in their configuration files and command-line flags.
This method does not look at whether the specific line is being
ignored in the file itself.
:param code:
The code for the check that has been run.
)re r^ rF s r should_report_errorz StyleGuide.should_report_error s |((...r r r r r c z | j j }|sd}t ||||dz || }| |j t
j u } | | du }
| | j } | r:|
r8| r6| j
| | j
| dS dS )r r F)r2 disable_noqar r rC r r is_inline_ignoredis_inr rd handlerj record) rA rC rw r r r r r errorerror_is_selectedis_not_inline_ignoredis_included_in_diffs r r zStyleGuide.handle_error s : |0 M A
$ $UZ 0 0H4E E !& 7 7 E E N #kk$*; < < !6 ;N N ! !% ( ( ( J e $ $ $1qr r c || _ dS )a( Update the StyleGuide to filter out information not in the diff.
This provides information to the StyleGuide so that only the errors
in the line number ranges are reported.
:param diffinfo:
Dictionary mapping filenames to sets of line number ranges.
N)r )rA r s r r zStyleGuide.add_diff_ranges s %r )NNrL ) r r r r r_ r` r r r ri r ra r1 rB r r r{ r r r r boolr r r r r r r r r r r r r > s -- #',0
4 4#4 "/4 $ 4
3- 4 .)
4 4 4 4*1# 1 1 1 1 #'6:
3-
%Xc] 3
** + ,* * * *
3
4
$ / / / / / /* (,3 33 3 3
3
3 }3
3 3 3 3j %S#c(](; % % % % % % %r r )(r r_ r r{ enumrq rn loggingtypingr r r r r r r r
flake8r r r
flake8.formattingr r flake8.violationr __all__ getLoggerr rT Enumr r r ra r+ r/ r1 rc r r r r r s* 6 6 4 4 4 4 4 4 & & & & & &
g!!' ' ' ' 'ty ' ' '& & & & &di & & & ty , T#Y ,
T#Y , 38_ , , , , , T#Y , 38_ , 3i ,
T#Y , 38_
, , , , B B B B B B B BJl, l, l, l, l, l, l, l,^Q% Q% Q% Q% Q% Q% Q% Q% Q% Q%r