diff options
author | Sylvain Th?nault <sylvain.thenault@logilab.fr> | 2014-04-18 15:30:12 +0200 |
---|---|---|
committer | Sylvain Th?nault <sylvain.thenault@logilab.fr> | 2014-04-18 15:30:12 +0200 |
commit | 8ae7a22ad67a416068068850c95f0f98e35e6072 (patch) | |
tree | 167d767d504065ba05747139bb42aa21bd0d959c | |
parent | 3b86291897c0a610a332201fc5f117caf080993b (diff) | |
download | pylint-8ae7a22ad67a416068068850c95f0f98e35e6072.tar.gz |
regenerate doc/example/man
-rw-r--r-- | examples/pylintrc | 133 | ||||
-rw-r--r-- | man/pylint.1 | 6 |
2 files changed, 104 insertions, 35 deletions
diff --git a/examples/pylintrc b/examples/pylintrc index d560f9e..047b473 100644 --- a/examples/pylintrc +++ b/examples/pylintrc @@ -12,7 +12,7 @@ profile=no # Add files or directories to the blacklist. They should be base names, not # paths. -ignore=CVS +ignore=.hg,test # Pickle collected data for later comparisons. persistent=yes @@ -21,6 +21,12 @@ persistent=yes # usually to register additional checkers. load-plugins= +# DEPRECATED +include-ids=no + +# DEPRECATED +symbols=no + [MESSAGES CONTROL] @@ -48,12 +54,6 @@ load-plugins= # mypackage.mymodule.MyReporterClass. output-format=text -# Include message's id in output -include-ids=no - -# Include symbolic ids of messages in output -symbols=no - # Put messages in a separate file for each module / package specified on the # command line instead of printing them on stdout. Reports (if any) will be # written in a file name "pylint_global.[txt|html]". @@ -73,12 +73,33 @@ evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / stateme # evaluation report (RP0004). comment=no +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details +#msg-template= + + +[LOGGING] + +# Logging modules to check that the string format arguments are in logging +# function parameter format +logging-modules=logging + [FORMAT] # Maximum number of characters on a single line. max-line-length=80 +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )?<?https?://\S+>?$ + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + +# List of optional constructs for which whitespace checking is disabled +no-space-check=trailing-comma,dict-separator + # Maximum number of lines in a module max-module-lines=1000 @@ -86,8 +107,6 @@ max-module-lines=1000 # tab). indent-string=' ' -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )?<?https?://\S+>?$ [BASIC] @@ -97,44 +116,87 @@ required-attributes= # List of builtins function names that should not be used, separated by a comma bad-functions=map,filter,apply,input -# Regular expression which should only match correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ +# Good variable names which should always be accepted, separated by a comma +good-names=i,j,k,ex,Run,_ -# Regular expression which should only match correct module level names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ +# Bad variable names which should always be refused, separated by a comma +bad-names=foo,bar,baz,toto,tutu,tata -# Regular expression which should only match correct class names -class-rgx=[A-Z_][a-zA-Z0-9]+$ +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= -# Regular expression which should only match correct function names +# Include a hint for the correct naming format with invalid-name +include-naming-hint=no + +# Regular expression matching correct function names function-rgx=[a-z_][a-z0-9_]{2,30}$ -# Regular expression which should only match correct method names -method-rgx=[a-z_][a-z0-9_]{2,30}$ +# Naming hint for function names +function-name-hint=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression matching correct variable names +variable-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Naming hint for variable names +variable-name-hint=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression matching correct constant names +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ -# Regular expression which should only match correct instance attribute names +# Naming hint for constant names +const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Regular expression matching correct attribute names attr-rgx=[a-z_][a-z0-9_]{2,30}$ -# Regular expression which should only match correct argument names +# Naming hint for attribute names +attr-name-hint=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression matching correct argument names argument-rgx=[a-z_][a-z0-9_]{2,30}$ -# Regular expression which should only match correct variable names -variable-rgx=[a-z_][a-z0-9_]{2,30}$ +# Naming hint for argument names +argument-name-hint=[a-z_][a-z0-9_]{2,30}$ -# Regular expression which should only match correct list comprehension / -# generator expression variable names +# Regular expression matching correct class attribute names +class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Naming hint for class attribute names +class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ + +# Regular expression matching correct inline iteration names inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ -# Good variable names which should always be accepted, separated by a comma -good-names=i,j,k,ex,Run,_ +# Naming hint for inline iteration names +inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata +# Regular expression matching correct class names +class-rgx=[A-Z_][a-zA-Z0-9]+$ + +# Naming hint for class names +class-name-hint=[A-Z_][a-zA-Z0-9]+$ + +# Regular expression matching correct module names +module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ -# Regular expression which should only match functions or classes name which do -# not require a docstring +# Naming hint for module names +module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ + +# Regular expression matching correct method names +method-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Naming hint for method names +method-name-hint=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression which should only match function or class names that do +# not require a docstring. no-docstring-rgx=__.*__ +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + [SIMILARITIES] @@ -163,6 +225,11 @@ notes=FIXME,XXX,TODO # mixin class is detected if its name ends with "mixin" (case insensitive). ignore-mixin-members=yes +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus extisting member attributes cannot be deduced by static analysis +ignored-modules= + # List of classes names for which member attributes should not be checked # (useful for classes with attributes dynamically set). ignored-classes=SQLObject @@ -182,8 +249,8 @@ generated-members=REQUEST,acl_users,aq_parent # Tells whether we should check for unused import in __init__ files. init-import=no -# A regular expression matching the beginning of the name of dummy variables -# (i.e. not used). +# A regular expression matching the name of dummy variables (i.e. expectedly +# not used). dummy-variables-rgx=_|dummy # List of additional names supposed to be defined in builtins. Remember that @@ -225,7 +292,7 @@ max-locals=15 max-returns=6 # Maximum number of branch for function / method body -max-branchs=12 +max-branches=12 # Maximum number of statements in function / method body max-statements=50 diff --git a/man/pylint.1 b/man/pylint.1 index f80c61c..480ac18 100644 --- a/man/pylint.1 +++ b/man/pylint.1 @@ -1,4 +1,4 @@ -.TH pylint 1 "2014-4-11" pylint +.TH pylint 1 "2014-4-18" pylint .SH NAME .B pylint \- python code static checker @@ -210,6 +210,8 @@ List of note tags to take in consideration, separated by a comma. [current: FIXM .SH TYPECHECK .IP "--ignore-mixin-members=<y_or_n>" Tells whether missing members accessed in mixin class should be ignored. A mixin class is detected if its name ends with "mixin" (case insensitive). [current: yes] +.IP "--ignored-modules=<module names>" +List of module names for which member attributes should not be checked (useful for modules/projects where namespaces are manipulated during runtime and thus extisting member attributes cannot be deduced by static analysis [current: none] .IP "--ignored-classes=<members names>" List of classes names for which member attributes should not be checked (useful for classes with attributes dynamically set). [current: SQLObject] .IP "--zope=<y_or_n>" @@ -221,7 +223,7 @@ List of members which are set dynamically and missed by pylint inference system, .IP "--init-import=<y_or_n>" Tells whether we should check for unused import in __init__ files. [current: no] .IP "--dummy-variables-rgx=<regexp>" -A regular expression matching the beginning of the name of dummy variables (i.e. not used). [current: _|dummy] +A regular expression matching the name of dummy variables (i.e. expectedly not used). [current: _|dummy] .IP "--additional-builtins=<comma separated list>" List of additional names supposed to be defined in builtins. Remember that you should avoid to define new builtins when possible. [current: none] |