diff options
author | Sylvain <syt@logilab.fr> | 2007-03-07 10:15:39 +0100 |
---|---|---|
committer | Sylvain <syt@logilab.fr> | 2007-03-07 10:15:39 +0100 |
commit | 10af1d7948e0d78eaf8d1e48a002af41f4819cf5 (patch) | |
tree | b6bea19494c69edae7be29128fc220e23e529937 | |
parent | 8bb5330d3376963138d5b47d376ccc21dab05cbe (diff) | |
download | pylint-10af1d7948e0d78eaf8d1e48a002af41f4819cf5.tar.gz |
regenerate doc
-rw-r--r-- | doc/features.txt | 336 | ||||
-rw-r--r-- | examples/pylintrc | 36 | ||||
-rw-r--r-- | man/pylint.1 | 128 |
3 files changed, 283 insertions, 217 deletions
diff --git a/doc/features.txt b/doc/features.txt index 28abb90..714a472 100644 --- a/doc/features.txt +++ b/doc/features.txt @@ -7,6 +7,11 @@ General options ~~~~~~~~~~~~~~~ :rcfile: Specify a configuration file. +:init-hook: + Python code to execute, usually for sys.path manipulation such as + pygtk.require(). +:rpython-mode: + enable the rpython checker which is disabled by default :errors-only: In debug mode, checkers without error messages are disabled and for others, only the ERROR messages are displayed, and no reports are done by default @@ -60,8 +65,8 @@ Messages control options Reports options ~~~~~~~~~~~~~~~ :output-format: - set the output format. Available formats are text, parseable, colorized and - html + set the output format. Available formats are text, parseable, colorized, msvs + (visual studio) and html Default: text :include-ids: Include message's id in output @@ -105,6 +110,8 @@ Main messages Used when an inline option disable a message or a messages category. :I0012: *Locally enabling %s* Used when an inline option enable a message or a messages category. +:I0013: *Ignoring entire file* + Used to inform that the file will not be checked :F0001: Used when an error occured preventing the analyzing of a module (unable to find it for instance). @@ -114,6 +121,8 @@ Main messages :F0003: *ignored builtin module %s* Used to indicate that the user asked to analyze a builtin module which has been skipped. +:F0004: *unexpected infered value %s* + Used to indicate that some value of an unexpected type has been infered. Main reports ~~~~~~~~~~~~ @@ -123,99 +132,13 @@ Main reports :R0004: Global evaluation -Typecheck checker ------------------ -try to find bugs in the code using type inference - -Options -~~~~~~~ -:ignore-mixin-members: - Tells wether missing members accessed in mixin class should be ignored. A - mixin class is detected if its name ends with "mixin" (case insensitive). - Default: yes -:zope: - When zope mode is activated, consider the acquired-members option to ignore - access to some undefined attributes. -:acquired-members: - List of members which are usually get through zope's acquisition mecanism and - so shouldn't trigger E0201 when accessed (need zope=yes to be considered). - Default: REQUEST,acl_users,aq_parent - -Messages -~~~~~~~~ -:E1101: *%s %r has no %r member* - Used when a class is accessed for an unexistant member. -:E1102: *%s is not callable* - Used when an object being called has been infered to a non callable object -:E1111: *Assigning to function call which doesn't return* - Used when an assigment is done on a function call but the infered function - doesn't return anything. -:W1111: *Assigning to function call which only returns None* - Used when an assigment is done on a function call but the infered function - returns nothing but None. - - -Variables checker ------------------ -checks for -* unused variables / imports -* undefined variables -* redefinition of variable from builtins or from an outer scope -* use of variable before assigment - -Options -~~~~~~~ -:init-import: - Tells wether we should check for unused import in __init__ files. -:dummy-variables-rgx: - A regular expression matching names used for dummy variables (i.e. not used). - Default: _|dummy -:additional-builtins: - List of additional names supposed to be defined in builtins. Remember that - you should avoid to define new builtins when possible. - -Messages -~~~~~~~~ -:E0601: *Using variable %r before assignment* - Used when a local variable is accessed before it's assignment. -:E0602: *Undefined variable %r* - Used when an undefined variable is accessed. -:E0611: *No name %r in module %r* - Used when a name cannot be found in a module. -:W0601: *Global variable %r undefined at the module level* - Used when a variable is defined through the "global" statement but the - variable is not defined in the module scope. -:W0602: *Using global for %r but no assigment is done* - Used when a variable is defined through the "global" statement but no - assigment to this variable is done. -:W0603: *Using the global statement* - Used when you use the "global" statement to update a global variable. PyLint - just try to discourage this usage. That doesn't mean you can not use it ! -:W0604: *Using the global statement at the module level* - Used when you use the "global" statement at the module level since it has no - effect -:W0611: *Unused import %s* - Used when an imported module or variable is not used. -:W0612: *Unused variable %r* - Used when a variable is defined but not used. -:W0613: *Unused argument %r* - Used when a function or method argument is not used. -:W0621: *Redefining name %r from outer scope (line %s)* - Used when a variable's name hide a name defined in the outer scope. -:W0622: *Redefining built-in %r* - Used when a variable or function override a built-in. -:W0631: *Using possibly undefined loop variable %r* - Used when an loop variable (i.e. defined by a for loop or a list comprehension - or a generator expression) is used outside the loop. - - Basic checker ------------- checks for : * doc strings * modules / classes / functions / methods / arguments / variables name * number of arguments, local variables, branchs, returns and statements in -functions, methods + functions, methods * required module attributes * dangerous default values as arguments * redefinition of function / method / class @@ -269,12 +192,22 @@ Options Messages ~~~~~~~~ +:E0100: *__init__ method is a generator* + Used when the special class method __init__ is turned into a generator by a + yield in its body. :E0101: *Explicit return in __init__* - Used when the special class method __ini__ has an explicit return value. + Used when the special class method __init__ has an explicit return value. :E0102: *%s already defined line %s* Used when a function / class / method is redefined. :E0103: *%r not properly in loop* Used when break or continue keywords are used outside a loop. +:E0104: *return outside function* + Used when a "return" statement is found outside a function or method. +:E0105: *yield outside function* + Used when a "yield" statement is found outside a function or method. +:E0106: *return with argument inside generator* + Used when a "return" statement with an argument is found outside in a + generator function or method (e.g. with some "yield" statements). :W0101: *Unreachable code* Used when there is some code behind a "return" or "raise" statement, which will never be accessed. @@ -286,10 +219,13 @@ Messages :W0105: *String statement has no effect* Used when a string is used as a statement (which of course has no effect). This is a particular case of W0104 with its own message so you can easily - disable it if you're using those strings as documentation, instead of comments. -:W0106: *Unnecessary semi-column* + disable it if you're using those strings as documentation, instead of + comments. +:W0106: *Unnecessary semicolon* Used when a statement is endend by a semi-colon (";"), which isn't necessary - (that's python, not C ;) + (that's python, not C ;). +:W0107: *Unnecessary pass statement* + Used when a "pass" statement that can be avoided is encountered.) :W0122: *Use of the exec statement* Used when you use the "exec" statement, to discourage its usage. That doesn't mean you can not use it ! @@ -299,7 +235,8 @@ Messages Python offers now some cleaner alternative like list comprehension. :W0142: *Used * or ** magic* Used when a function or method is called using `*args` or `**kwargs` to - dispatch arguments. This doesn't improve readility and should be used with care. + dispatch arguments. This doesn't improve readility and should be used with + care. :C0102: *Black listed name "%s"* Used when the name is listed in the black list (unauthorized names). :C0103: *Invalid name "%s" (should match %s)* @@ -310,7 +247,7 @@ Messages methods like __init__ doesn't necessary require a docstring. :C0112: *Empty docstring* Used when a module, function, class or method has an empty docstring (it would - be to easy ;). + be too easy ;). :C0121: *Missing required attribute "%s"* Used when an attribute required for modules is missing. @@ -319,6 +256,98 @@ Reports :R0101: Statistics by type +Typecheck checker +----------------- +try to find bugs in the code using type inference + +Options +~~~~~~~ +:ignore-mixin-members: + Tells wether missing members accessed in mixin class should be ignored. A + mixin class is detected if its name ends with "mixin" (case insensitive). + Default: yes +:zope: + When zope mode is activated, consider the acquired-members option to ignore + access to some undefined attributes. +:acquired-members: + List of members which are usually get through zope's acquisition mecanism and + so shouldn't trigger E0201 when accessed (need zope=yes to be considered). + Default: REQUEST,acl_users,aq_parent + +Messages +~~~~~~~~ +:E1101: *%s %r has no %r member* + Used when a variable is accessed for an unexistant member. +:E1102: *%s is not callable* + Used when an object being called has been infered to a non callable object +:E1103: *%s %r has no %r member (but some types could not be inferred)* + Used when a variable is accessed for an unexistant member, but astng was not + able to interpret all possible types of this variable. +:E1111: *Assigning to function call which doesn't return* + Used when an assigment is done on a function call but the infered function + doesn't return anything. +:W1111: *Assigning to function call which only returns None* + Used when an assigment is done on a function call but the infered function + returns nothing but None. + + +Variables checker +----------------- +checks for +* unused variables / imports +* undefined variables +* redefinition of variable from builtins or from an outer scope +* use of variable before assigment + +Options +~~~~~~~ +:init-import: + Tells wether we should check for unused import in __init__ files. +:dummy-variables-rgx: + A regular expression matching names used for dummy variables (i.e. not used). + Default: _|dummy +:additional-builtins: + List of additional names supposed to be defined in builtins. Remember that + you should avoid to define new builtins when possible. + +Messages +~~~~~~~~ +:E0601: *Using variable %r before assignment* + Used when a local variable is accessed before it's assignment. +:E0602: *Undefined variable %r* + Used when an undefined variable is accessed. +:E0611: *No name %r in module %r* + Used when a name cannot be found in a module. +:W0601: *Global variable %r undefined at the module level* + Used when a variable is defined through the "global" statement but the + variable is not defined in the module scope. +:W0602: *Using global for %r but no assigment is done* + Used when a variable is defined through the "global" statement but no + assigment to this variable is done. +:W0603: *Using the global statement* + Used when you use the "global" statement to update a global variable. PyLint + just try to discourage this usage. That doesn't mean you can not use it ! +:W0604: *Using the global statement at the module level* + Used when you use the "global" statement at the module level since it has no + effect +:W0611: *Unused import %s* + Used when an imported module or variable is not used. +:W0612: *Unused variable %r* + Used when a variable is defined but not used. +:W0613: *Unused argument %r* + Used when a function or method argument is not used. +:W0614: *Unused import %s from wildcard import* + Used when an imported module or variable is not used from a 'from X import *' + style import. +:W0621: *Redefining name %r from outer scope (line %s)* + Used when a variable's name hide a name defined in the outer scope. +:W0622: *Redefining built-in %r* + Used when a variable or function override a built-in. +:W0631: *Using possibly undefined loop variable %r* + Used when an loop variable (i.e. defined by a for loop or a list comprehension + or a generator expression) is used outside the loop. + + Classes checker --------------- checks for : @@ -399,33 +428,6 @@ Messages Used when a PyLint as failed to find interfaces implemented by a class -Newstyle checker ----------------- -checks for usage of new style capabilities on old style classes and -other new/old styles conflicts problems -* use of property, __slots__, super -* "super" usage -* raising a new style class as exception - -Messages -~~~~~~~~ -:E1001: *Use __slots__ on an old style class* - Used when an old style class use the __slots__ attribute. -:E1002: *Use super on an old style class* - Used when an old style class use the super builtin. -:E1003: *Bad first argument %r given to super class* - Used when another argument than the current class is given as first argument - of the super builtin. -:E1010: *Raising a new style class* - Used when a new style class is raised since it's not possible with python < 2.5. -:W1001: *Use of "property" on an old style class* - Used when PyLint detect the use of the builtin "property" on an old style - class while this is relying on new style classes features -:W1010: *Exception doesn't inherit from standard "Exception" class* - Used when a custom exception class is raised but doesn't inherit from the - builtin "Exception" class. - - Design checker -------------- checks for sign of poor/misdesign: @@ -470,8 +472,8 @@ Messages :R0902: *Too many instance attributes (%s/%s)* Used when class has too many instance attributes, try to reduce this to get a more simple (and so easier to use) class. -:R0903: *To few public methods (%s/%s)* - Used when class has to few public methods, so be sure it's really worth it. +:R0903: *Too few public methods (%s/%s)* + Used when class has too few public methods, so be sure it's really worth it. :R0904: *Too many public methods (%s/%s)* Used when class has too many public methods, try to reduce this to get a more simple (and so easier to use) class. @@ -479,7 +481,8 @@ Messages Used when a function or method has too many return statement, making it hard to follow. :R0912: *Too many branches (%s/%s)* - Used when a function or method has too many branches, making it hard to follow. + Used when a function or method has too many branches, making it hard to + follow. :R0913: *Too many arguments (%s/%s)* Used when a function or method takes too many arguments. :R0914: *Too many local variables (%s/%s)* @@ -544,6 +547,34 @@ Reports :R0402: Modules dependencies graph +Newstyle checker +---------------- +checks for usage of new style capabilities on old style classes and +other new/old styles conflicts problems +* use of property, __slots__, super +* "super" usage +* raising a new style class as exception + +Messages +~~~~~~~~ +:E1001: *Use __slots__ on an old style class* + Used when an old style class use the __slots__ attribute. +:E1002: *Use super on an old style class* + Used when an old style class use the super builtin. +:E1003: *Bad first argument %r given to super class* + Used when another argument than the current class is given as first argument + of the super builtin. +:E1010: *Raising a new style class* + Used when a new style class is raised since it's not possible with python < + 2.5. +:W1001: *Use of "property" on an old style class* + Used when PyLint detect the use of the builtin "property" on an old style + class while this is relying on new style classes features +:W1010: *Exception doesn't inherit from standard "Exception" class* + Used when a custom exception class is raised but doesn't inherit from the + builtin "Exception" class. + + Exceptions checker ------------------ checks for @@ -625,6 +656,32 @@ Messages the error if it occurs. +Miscellaneous checker +--------------------- +checks for: +* warning notes in the code like FIXME, XXX +* PEP 263: source code with non ascii character but no encoding declaration + +Options +~~~~~~~ +:notes: + List of note tags to take in consideration, separated by a comma. + Default: FIXME,XXX,TODO + +Messages +~~~~~~~~ +:E0501: *Non ascii characters found but no encoding specified (PEP 263)* + Used when some non ascii characters are detected but now encoding is + specified, as explicited in the PEP 263. +:E0502: *Wrong encoding specified (%s)* + Used when a known encoding is specified but the file doesn't seem to be + actually in this encoding. +:E0503: *Unknown encoding specified (%s)* + Used when an encoding is specified, but it's unknown to Python. +:W0511: + Used when a warning note as FIXME or XXX is detected. + + Metrics checker --------------- does not check anything but gives some raw metrics : @@ -661,36 +718,11 @@ Messages ~~~~~~~~ :R0801: *Similar lines in %s files* Indicates that a set of similar lines has been detected among multiple file. - This usually means that the code should be refactored to avoid this duplication. + This usually means that the code should be refactored to avoid this + duplication. Reports ~~~~~~~ :R0801: Duplication -Miscellaneous checker ---------------------- -checks for: -* warning notes in the code like FIXME, XXX -* PEP 263: source code with non ascii character but no encoding declaration - -Options -~~~~~~~ -:notes: - List of note tags to take in consideration, separated by a comma. - Default: FIXME,XXX,TODO - -Messages -~~~~~~~~ -:E0501: *Non ascii characters found but no encoding specified (PEP 263)* - Used when some non ascii characters are detected but now encoding is - specified, as explicited in the PEP 263. -:E0502: *Wrong encoding specified (%s)* - Used when a known encoding is specified but the file doesn't seem to be - actually in this encoding. -:E0503: *Unknown encoding specified (%s)* - Used when an encoding is specified, but it's unknown to Python. -:W0511: - Used when a warning note as FIXME or XXX is detected. - - diff --git a/examples/pylintrc b/examples/pylintrc index a088ee5..a0786ab 100644 --- a/examples/pylintrc +++ b/examples/pylintrc @@ -8,6 +8,13 @@ # [MASTER] +# Specify a configuration file. +#rcfile= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + # Profiled execution. profile=no @@ -26,14 +33,33 @@ cache-size=500 load-plugins= +[MESSAGES CONTROL] + +# Enable only checker(s) with the given id(s). This option conflict with the +# disable-checker option +#enable-checker= + +# Enable all checker(s) except those with the given id(s). This option conflict +# with the disable-checker option +#disable-checker= +# Enable all messages in the listed categories. +#enable-msg-cat= +# Disable all messages in the listed categories. +#disable-msg-cat= + +# Enable the message(s) with the given id(s). +#enable-msg= + +# Disable the message(s) with the given id(s). +#disable-msg= [REPORTS] -# set the output format. Available formats are text, parseable, colorized and -# html +# set the output format. Available formats are text, parseable, colorized, msvs +# (visual studio) and html output-format=text # Include message's id in output @@ -58,6 +84,12 @@ evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / stateme # evaluation report (R0004). comment=no +# Enable the report(s) with the given id(s). +#enable-report= + +# Disable the report(s) with the given id(s). +#disable-report= + # checks for : # * doc strings diff --git a/man/pylint.1 b/man/pylint.1 index c7459e6..64ced34 100644 --- a/man/pylint.1 +++ b/man/pylint.1 @@ -1,4 +1,4 @@ -.TH pylint 1 "2006-8-10" pylint +.TH pylint 1 "2007-3-6" pylint .SH NAME .B pylint \- python code static checker @@ -35,18 +35,22 @@ show this help message and exit .SH MASTER .IP "--rcfile=<file>" Specify a configuration file. +.IP "--init-hook=<code>" +Python code to execute, usually for sys.path manipulation such as pygtk.require(). +.IP "--rpython-mode" +enable the rpython checker which is disabled by default .IP "--errors-only, -e" In debug mode, checkers without error messages are disabled and for others, only the ERROR messages are displayed, and no reports are done by default .IP "--profile=<y_or_n>" -Profiled execution. +Profiled execution. [current: %default] .IP "--ignore=<file>" -Add <file or directory> to the black list. It should be a base name, not a path. You may set this option multiple times. +Add <file or directory> to the black list. It should be a base name, not a path. You may set this option multiple times. [current: %default] .IP "--persistent=<y_or_n>" -Pickle collected data for later comparisons. +Pickle collected data for later comparisons. [current: %default] .IP "--cache-size=<size>" -Set the cache size for astng objects. +Set the cache size for astng objects. [current: %default] .IP "--load-plugins=<modules>" -List of plugins (as comma separated values of python modules names) to load, usually to register additional checkers. +List of plugins (as comma separated values of python modules names) to load, usually to register additional checkers. [current: %default] .SH COMMANDS .IP "--help-msg=<msg-id>" @@ -73,18 +77,18 @@ Enable the message(s) with the given id(s). Disable the message(s) with the given id(s). .SH REPORTS -.IP "--output-format=<format>, -f<format>" -set the output format. Available formats are text, parseable, colorized and html -.IP "--include-ids=<y_or_n>, -i<y_or_n>" -Include message's id in output +.IP "--output-format=<format>, -f <format>" +set the output format. Available formats are text, parseable, colorized, msvs (visual studio) and html [current: %default] +.IP "--include-ids=<y_or_n>, -i <y_or_n>" +Include message's id in output [current: %default] .IP "--files-output=<y_or_n>" -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]". -.IP "--reports=<y_or_n>, -r<y_or_n>" -Tells wether to display a full report or only the messages +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]". [current: %default] +.IP "--reports=<y_or_n>, -r <y_or_n>" +Tells wether to display a full report or only the messages [current: %default] .IP "--evaluation=<python_expression>" -Python expression which should return a note less than 10 (10 is the highest note).You have access to the variables errors warning, statement which respectivly contain the number of errors / warnings messages and the total number of statements analyzed. This is used by the global evaluation report (R0004). +Python expression which should return a note less than 10 (10 is the highest note).You have access to the variables errors warning, statement which respectivly contain the number of errors / warnings messages and the total number of statements analyzed. This is used by the global evaluation report (R0004). [current: %default] .IP "--comment=<y_or_n>" -Add a comment according to your evaluation note. This is used by the global evaluation report (R0004). +Add a comment according to your evaluation note. This is used by the global evaluation report (R0004). [current: %default] .IP "--enable-report=<rpt ids>" Enable the report(s) with the given id(s). .IP "--disable-report=<rpt ids>" @@ -92,105 +96,105 @@ Disable the report(s) with the given id(s). .SH BASIC .IP "--required-attributes=<attributes>" -Required attributes for module, separated by a comma +Required attributes for module, separated by a comma [current: %default] .IP "--no-docstring-rgx=<regexp>" -Regular expression which should only match functions or classes name which do not require a docstring +Regular expression which should only match functions or classes name which do not require a docstring [current: %default] .IP "--module-rgx=<regexp>" -Regular expression which should only match correct module names +Regular expression which should only match correct module names [current: %default] .IP "--const-rgx=<regexp>" -Regular expression which should only match correct module level names +Regular expression which should only match correct module level names [current: %default] .IP "--class-rgx=<regexp>" -Regular expression which should only match correct class names +Regular expression which should only match correct class names [current: %default] .IP "--function-rgx=<regexp>" -Regular expression which should only match correct function names +Regular expression which should only match correct function names [current: %default] .IP "--method-rgx=<regexp>" -Regular expression which should only match correct method names +Regular expression which should only match correct method names [current: %default] .IP "--attr-rgx=<regexp>" -Regular expression which should only match correct instance attribute names +Regular expression which should only match correct instance attribute names [current: %default] .IP "--argument-rgx=<regexp>" -Regular expression which should only match correct argument names +Regular expression which should only match correct argument names [current: %default] .IP "--variable-rgx=<regexp>" -Regular expression which should only match correct variable names +Regular expression which should only match correct variable names [current: %default] .IP "--inlinevar-rgx=<regexp>" -Regular expression which should only match correct list comprehension / generator expression variable names +Regular expression which should only match correct list comprehension / generator expression variable names [current: %default] .IP "--good-names=<names>" -Good variable names which should always be accepted, separated by a comma +Good variable names which should always be accepted, separated by a comma [current: %default] .IP "--bad-names=<names>" -Bad variable names which should always be refused, separated by a comma +Bad variable names which should always be refused, separated by a comma [current: %default] .IP "--bad-functions=<builtin function names>" -List of builtins function names that should not be used, separated by a comma +List of builtins function names that should not be used, separated by a comma [current: %default] .SH CLASSES .IP "--ignore-iface-methods=<method names>" -List of interface methods to ignore, separated by a comma. This is used for instance to not check methods defines in Zope's Interface base class. +List of interface methods to ignore, separated by a comma. This is used for instance to not check methods defines in Zope's Interface base class. [current: %default] .IP "--defining-attr-methods=<method names>" -List of method names used to declare (i.e. assign) instance attributes. +List of method names used to declare (i.e. assign) instance attributes. [current: %default] .SH DESIGN .IP "--max-args=<int>" -Maximum number of arguments for function / method +Maximum number of arguments for function / method [current: %default] .IP "--max-locals=<int>" -Maximum number of locals for function / method body +Maximum number of locals for function / method body [current: %default] .IP "--max-returns=<int>" -Maximum number of return / yield for function / method body +Maximum number of return / yield for function / method body [current: %default] .IP "--max-branchs=<int>" -Maximum number of branch for function / method body +Maximum number of branch for function / method body [current: %default] .IP "--max-statements=<int>" -Maximum number of statements in function / method body +Maximum number of statements in function / method body [current: %default] .IP "--max-parents=<num>" -Maximum number of parents for a class (see R0901). +Maximum number of parents for a class (see R0901). [current: %default] .IP "--max-attributes=<num>" -Maximum number of attributes for a class (see R0902). +Maximum number of attributes for a class (see R0902). [current: %default] .IP "--min-public-methods=<num>" -Minimum number of public methods for a class (see R0903). +Minimum number of public methods for a class (see R0903). [current: %default] .IP "--max-public-methods=<num>" -Maximum number of public methods for a class (see R0904). +Maximum number of public methods for a class (see R0904). [current: %default] .SH FORMAT .IP "--max-line-length=<int>" -Maximum number of characters on a single line. +Maximum number of characters on a single line. [current: %default] .IP "--max-module-lines=<int>" -Maximum number of lines in a module +Maximum number of lines in a module [current: %default] .IP "--indent-string=<string>" -String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 tab). +String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 tab). [current: %default] .SH IMPORTS .IP "--deprecated-modules=<modules>" -Deprecated modules which should not be used, separated by a comma +Deprecated modules which should not be used, separated by a comma [current: %default] .IP "--import-graph=<file.dot>" -Create a graph of every (i.e. internal and external) dependencies in the given file (report R0402 must not be disabled) +Create a graph of every (i.e. internal and external) dependencies in the given file (report R0402 must not be disabled) [current: %default] .IP "--ext-import-graph=<file.dot>" -Create a graph of external dependencies in the given file (report R0402 must not be disabled) +Create a graph of external dependencies in the given file (report R0402 must not be disabled) [current: %default] .IP "--int-import-graph=<file.dot>" -Create a graph of internal dependencies in the given file (report R0402 must not be disabled) +Create a graph of internal dependencies in the given file (report R0402 must not be disabled) [current: %default] .SH MISCELLANEOUS .IP "--notes=<comma separated values>" -List of note tags to take in consideration, separated by a comma. +List of note tags to take in consideration, separated by a comma. [current: %default] .SH SIMILARITIES .IP "--min-similarity-lines=<int>" -Minimum lines number of a similarity. +Minimum lines number of a similarity. [current: %default] .IP "--ignore-comments=<y or n>" -Ignore comments when computing similarities. +Ignore comments when computing similarities. [current: %default] .IP "--ignore-docstrings=<y or n>" -Ignore docstrings when computing similarities. +Ignore docstrings when computing similarities. [current: %default] .SH TYPECHECK .IP "--ignore-mixin-members=<y_or_n>" -Tells wether missing members accessed in mixin class should be ignored. A mixin class is detected if its name ends with "mixin" (case insensitive). +Tells wether missing members accessed in mixin class should be ignored. A mixin class is detected if its name ends with "mixin" (case insensitive). [current: %default] .IP "--zope=<y_or_n>" -When zope mode is activated, consider the acquired-members option to ignore access to some undefined attributes. +When zope mode is activated, consider the acquired-members option to ignore access to some undefined attributes. [current: %default] .IP "--acquired-members=<members names>" -List of members which are usually get through zope's acquisition mecanism and so shouldn't trigger E0201 when accessed (need zope=yes to be considered). +List of members which are usually get through zope's acquisition mecanism and so shouldn't trigger E0201 when accessed (need zope=yes to be considered). [current: %default] .SH VARIABLES .IP "--init-import=<y_or_n>" -Tells wether we should check for unused import in __init__ files. +Tells wether we should check for unused import in __init__ files. [current: %default] .IP "--dummy-variables-rgx=<regexp>" -A regular expression matching names used for dummy variables (i.e. not used). +A regular expression matching names used for dummy variables (i.e. not used). [current: %default] .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. +List of additional names supposed to be defined in builtins. Remember that you should avoid to define new builtins when possible. [current: %default] .SH ENVIRONMENT VARIABLES @@ -198,13 +202,12 @@ The following environment variables are used : * PYLINTHOME path to the directory where data of persistent run will be stored. If not found, it defaults to ~/.pylint.d/ or .pylint.d (in the current working -directory) . The current PYLINTHOME is /home/adim/.pylint.d. +directory) . The current PYLINTHOME is /home/syt/.pylint.d. * PYLINTRC path to the configuration file. If not found, it will use the first existant file in ~/.pylintrc, /etc/pylintrc. The current PYLINTRC is None. - .SH OUTPUT Using the default text output, the message format is : @@ -213,16 +216,15 @@ There are 5 kind of message types : * (C) convention, for programming standard violation * (R) refactor, for bad code smell * (W) warning, for python specific problems - * (E) error, for much probably bugs in the code + * (E) error, for much probably bugs in the code * (F) fatal, if an error occured which prevented pylint from doing further processing. - .SH SEE ALSO /usr/share/doc/pythonX.Y-pylint/ .SH COPYRIGHT -Copyright (c) 2003-2006 Sylvain Thenault (thenault@gmail.com). -Copyright (c) 2003-2006 LOGILAB S.A. (Paris, FRANCE). +Copyright (c) 2003-2007 Sylvain Thenault (thenault@gmail.com). +Copyright (c) 2003-2007 LOGILAB S.A. (Paris, FRANCE). http://www.logilab.fr/ -- mailto:contact@logilab.fr This program is free software; you can redistribute it and/or modify |