summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdrien Di Mascio <Adrien.DiMascio@logilab.fr>2006-08-10 15:49:01 +0200
committerAdrien Di Mascio <Adrien.DiMascio@logilab.fr>2006-08-10 15:49:01 +0200
commitdb54b8957b38d503f904747fde003682849fd5df (patch)
tree80f5fcd7e94550b282425d5d0d2d3234552dcdea
parent863e53b90b2f0b0d02d7df86cbf381651094b431 (diff)
downloadpylint-db54b8957b38d503f904747fde003682849fd5df.tar.gz
prepared new version
-rw-r--r--COPYING340
-rw-r--r--ChangeLog2
-rw-r--r--__pkginfo__.py2
-rw-r--r--debian/changelog6
-rwxr-xr-x[-rw-r--r--]debian/rules0
-rw-r--r--examples/pylintrc165
-rw-r--r--man/pylint.1255
7 files changed, 471 insertions, 299 deletions
diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000..b7b5f53
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,340 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The licenses for most software are designed to take away your
+freedom to share and change it. By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.) You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+ To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+ We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+ Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+ Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ GNU GENERAL PUBLIC LICENSE
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License. The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language. (Hereinafter, translation is included without limitation in
+the term "modification".) Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+ 1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+ 2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+ a) You must cause the modified files to carry prominent notices
+ stating that you changed the files and the date of any change.
+
+ b) You must cause any work that you distribute or publish, that in
+ whole or in part contains or is derived from the Program or any
+ part thereof, to be licensed as a whole at no charge to all third
+ parties under the terms of this License.
+
+ c) If the modified program normally reads commands interactively
+ when run, you must cause it, when started running for such
+ interactive use in the most ordinary way, to print or display an
+ announcement including an appropriate copyright notice and a
+ notice that there is no warranty (or else, saying that you provide
+ a warranty) and that users may redistribute the program under
+ these conditions, and telling the user how to view a copy of this
+ License. (Exception: if the Program itself is interactive but
+ does not normally print such an announcement, your work based on
+ the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+ 3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+ a) Accompany it with the complete corresponding machine-readable
+ source code, which must be distributed under the terms of Sections
+ 1 and 2 above on a medium customarily used for software interchange; or,
+
+ b) Accompany it with a written offer, valid for at least three
+ years, to give any third party, for a charge no more than your
+ cost of physically performing source distribution, a complete
+ machine-readable copy of the corresponding source code, to be
+ distributed under the terms of Sections 1 and 2 above on a medium
+ customarily used for software interchange; or,
+
+ c) Accompany it with the information you received as to the offer
+ to distribute corresponding source code. (This alternative is
+ allowed only for noncommercial distribution and only if you
+ received the program in object code or executable form with such
+ an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+ 4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+ 5. You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+ 6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+ 7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all. For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+ 8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+ 9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation. If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+ 10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission. For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this. Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+ NO WARRANTY
+
+ 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+ 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+ `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+ <signature of Ty Coon>, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs. If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library. If this is what you want to do, use the GNU Library General
+Public License instead of this License.
diff --git a/ChangeLog b/ChangeLog
index 3b0e613..19d458b 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,7 +1,7 @@
ChangeLog for PyLint
====================
- --
+2006-08-10 -- 0.12.0
* usability changes:
- parseable, html and color options are now handled by a single
output-format option
diff --git a/__pkginfo__.py b/__pkginfo__.py
index 169e1bc..6d2be18 100644
--- a/__pkginfo__.py
+++ b/__pkginfo__.py
@@ -21,7 +21,7 @@ __revision__ = '$Id: __pkginfo__.py,v 1.50 2006-04-19 09:17:40 syt Exp $'
modname = 'pylint'
-numversion = (0, 11, 0)
+numversion = (0, 12, 0)
version = '.'.join([str(num) for num in numversion])
license = 'GPL'
diff --git a/debian/changelog b/debian/changelog
index ae0be82..18f186e 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,9 @@
+pylint (0.12.0-1) unstable; urgency=low
+
+ * new upstream release
+
+ -- Adrien.DiMascio <Adrien.DiMascio@logilab.fr> Thu, 10 Aug 2006 11:18:50 +0200
+
pylint (0.11.0-2) unstable; urgency=low
* Updated standards to 3.7.2
diff --git a/debian/rules b/debian/rules
index c845b7b..c845b7b 100644..100755
--- a/debian/rules
+++ b/debian/rules
diff --git a/examples/pylintrc b/examples/pylintrc
index fc07984..3fed0e5 100644
--- a/examples/pylintrc
+++ b/examples/pylintrc
@@ -6,11 +6,6 @@
# * handle message activation / deactivation at the module level
# * handle some basic but necessary stats'data (number of classes, methods...)
#
-# This checker also defines the following reports:
-# * R0001: Total errors / warnings
-# * R0002: % errors / warnings by module
-# * R0003: Messages
-# * R0004: Global evaluation
[MASTER]
# Profiled execution.
@@ -31,26 +26,27 @@ cache-size=500
load-plugins=
-[REPORTS]
-# Tells wether to display a full report or only the messages
-reports=yes
-# Use HTML as output format instead of text
-html=no
-# Use a parseable text output format, so your favorite text editor will be able
-# to jump to the line corresponding to a message.
-parseable=no
-# Colorizes text output using ansi escape codes
-color=no
+[REPORTS]
+
+# set the output format. Available formats are text, parseable, colorized and
+# html
+output-format=text
+
+# Include message's id in output
+include-ids=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]".
files-output=no
+# Tells wether to display a full report or only the messages
+reports=yes
+
# 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
@@ -62,9 +58,6 @@ evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / stateme
# evaluation report (R0004).
comment=no
-# Include message's id in output
-include-ids=no
-
# checks for :
# * doc strings
@@ -76,13 +69,8 @@ include-ids=no
# * redefinition of function / method / class
# * uses of the global statement
#
-# This checker also defines the following reports:
-# * R0101: Statistics by type
[BASIC]
-# Enable / disable this checker
-enable-basic=yes
-
# Required attributes for module, separated by a comma
required-attributes=__revision__
@@ -132,9 +120,6 @@ bad-functions=map,filter,apply,input
#
[TYPECHECK]
-# Enable / disable this checker
-enable-typecheck=yes
-
# Tells wether missing members accessed in mixin class should be ignored. A
# mixin class is detected if its name ends with "mixin" (case insensitive).
ignore-mixin-members=yes
@@ -144,7 +129,7 @@ ignore-mixin-members=yes
zope=no
# 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.
+# so shouldn't trigger E0201 when accessed (need zope=yes to be considered).
acquired-members=REQUEST,acl_users,aq_parent
@@ -156,9 +141,6 @@ acquired-members=REQUEST,acl_users,aq_parent
#
[VARIABLES]
-# Enable / disable this checker
-enable-variables=yes
-
# Tells wether we should check for unused import in __init__ files.
init-import=no
@@ -170,15 +152,30 @@ dummy-variables-rgx=_|dummy
additional-builtins=
+# checks for :
+# * methods without self as first argument
+# * overridden methods signature
+# * access only to existant members via self
+# * attributes not defined in the __init__ method
+# * supported interfaces implementation
+# * unreachable code
+#
+[CLASSES]
+
+# 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.
+ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
+
+# List of method names used to declare (i.e. assign) instance attributes.
+defining-attr-methods=__init__,__new__,setUp
+
+
# checks for sign of poor/misdesign:
# * number of methods, attributes, local variables...
# * size, complexity of functions, methods
#
[DESIGN]
-# Enable / disable this checker
-enable-design=yes
-
# Maximum number of arguments for function / method
max-args=5
@@ -207,41 +204,14 @@ min-public-methods=2
max-public-methods=20
-# checks for :
-# * methods without self as first argument
-# * overriden methods signature
-# * access only to existant members via self
-# * attributes not defined in the __init__ method
-# * supported interfaces implementation
-# * unreachable code
-#
-[CLASSES]
-
-# Enable / disable this checker
-enable-classes=yes
-
-# 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.
-ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by
-
-# List of method names used to declare (i.e. assign) instance attributes.
-defining-attr-methods=__init__,__new__,setUp
-
-
# checks for
# * external modules dependencies
# * relative / wildcard imports
# * cyclic imports
# * uses of deprecated modules
#
-# This checker also defines the following reports:
-# * R0401: External dependencies
-# * R0402: Modules dependencies graph
[IMPORTS]
-# Enable / disable this checker
-enable-imports=yes
-
# Deprecated modules which should not be used, separated by a comma
deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
@@ -258,49 +228,6 @@ ext-import-graph=
int-import-graph=
-# 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
-#
-[NEWSTYLE]
-
-# Enable / disable this checker
-enable-newstyle=yes
-
-
-# checks for
-# * excepts without exception filter
-# * string exceptions
-#
-[EXCEPTIONS]
-
-# Enable / disable this checker
-enable-exceptions=yes
-
-
-# checks for similarities and duplicated code. This computation may be
-# memory / CPU intensive, so you should disable it if you experiments some
-# problems.
-#
-# This checker also defines the following reports:
-# * R0801: Duplication
-[SIMILARITIES]
-
-# Enable / disable this checker
-enable-similarities=yes
-
-# Minimum lines number of a similarity.
-min-similarity-lines=4
-
-# Ignore comments when computing similarities.
-ignore-comments=yes
-
-# Ignore docstrings when computing similarities.
-ignore-docstrings=yes
-
-
# checks for :
# * unauthorized constructions
# * strict indentation
@@ -309,9 +236,6 @@ ignore-docstrings=yes
#
[FORMAT]
-# Enable / disable this checker
-enable-format=yes
-
# Maximum number of characters on a single line.
max-line-length=80
@@ -329,24 +253,21 @@ indent-string=' '
#
[MISCELLANEOUS]
-# Enable / disable this checker
-enable-miscellaneous=yes
-
-# List of note tags to take in consideration, separated by a comma. Default to
-# FIXME, XXX, TODO
+# List of note tags to take in consideration, separated by a comma.
notes=FIXME,XXX,TODO
-# does not check anything but gives some raw metrics :
-# * total number of lines
-# * total number of code lines
-# * total number of docstring lines
-# * total number of comments lines
-# * total number of empty lines
+# checks for similarities and duplicated code. This computation may be
+# memory / CPU intensive, so you should disable it if you experiments some
+# problems.
#
-# This checker also defines the following reports:
-# * R0701: Raw metrics
-[METRICS]
+[SIMILARITIES]
+
+# Minimum lines number of a similarity.
+min-similarity-lines=4
-# Enable / disable this checker
-enable-metrics=yes
+# Ignore comments when computing similarities.
+ignore-comments=yes
+
+# Ignore docstrings when computing similarities.
+ignore-docstrings=yes
diff --git a/man/pylint.1 b/man/pylint.1
index eefa920..7c519be 100644
--- a/man/pylint.1
+++ b/man/pylint.1
@@ -1,4 +1,4 @@
-.TH pylint 1 "2006-4-20" pylint
+.TH pylint 1 "2006-8-10" pylint
.SH NAME
.B pylint
\- python code static checker
@@ -33,20 +33,6 @@ show program's version number and exit
show this help message and exit
.SH MASTER
-lint Python modules using external checkers.
-
- This is the main checker controling the other ones and the reports
- generation. It is itself both a raw checker and an astng checker in order
- to:
- * handle message activation / deactivation at the module level
- * handle some basic but necessary stats'data (number of classes, methods...)
-
-This checker also defines the following reports:
- * R0001: Total errors / warnings
- * R0002: % errors / warnings by module
- * R0003: Messages
- * R0004: Global evaluation
-
.IP "--rcfile=<file>"
Specify a configuration file.
.IP "--disable-all"
@@ -73,7 +59,6 @@ Set the cache size for astng objects.
List of plugins (as comma separated values of python modules names) to load, usually to register additional checkers.
.SH REPORTS
-Options related to messages / statistics reporting
.IP "--reports=<y_or_n>, -r<y_or_n>"
Tells wether to display a full report or only the messages
.IP "--html=<y_or_n>"
@@ -103,46 +88,65 @@ Enable the report with the given id.
.IP "--disable-report=<rpt ids>"
Disable the report with the given id.
-.SH DESIGN
-checks for sign of poor/misdesign:
- * number of methods, attributes, local variables...
- * size, complexity of functions, methods
-
-.IP "--enable-design=<y_or_n>"
+.SH EXCEPTIONS
+.IP "--enable-exceptions=<y_or_n>"
Enable / disable this checker
-.IP "--max-args=<int>"
-Maximum number of arguments for function / method
-.IP "--max-locals=<int>"
-Maximum number of locals for function / method body
-.IP "--max-returns=<int>"
-Maximum number of return / yield for function / method body
-.IP "--max-branchs=<int>"
-Maximum number of branch for function / method body
-.IP "--max-statements=<int>"
-Maximum number of statements in function / method body
-.IP "--max-parents=<num>"
-Maximum number of parents for a class (see R0901).
-.IP "--max-attributes=<num>"
-Maximum number of attributes for a class (see R0902).
-.IP "--min-public-methods=<num>"
-Minimum number of public methods for a class (see R0903).
-.IP "--max-public-methods=<num>"
-Maximum number of public methods for a class (see R0904).
-.SH BASIC
-checks for :
- * doc strings
- * modules / classes / functions / methods / arguments / variables name
- * number of arguments, local variables, branchs, returns and statements in
-functions, methods
- * required module attributes
- * dangerous default values as arguments
- * redefinition of function / method / class
- * uses of the global statement
-
-This checker also defines the following reports:
- * R0101: Statistics by type
+.SH VARIABLES
+.IP "--enable-variables=<y_or_n>"
+Enable / disable this checker
+.IP "--init-import=<y_or_n>"
+Tells wether we should check for unused import in __init__ files.
+.IP "--dummy-variables-rgx=<regexp>"
+A regular expression matching names used for dummy variables (i.e. not used).
+.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.
+
+.SH CLASSES
+.IP "--enable-classes=<y_or_n>"
+Enable / disable this checker
+.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.
+.IP "--defining-attr-methods=<method names>"
+List of method names used to declare (i.e. assign) instance attributes.
+.SH IMPORTS
+.IP "--enable-imports=<y_or_n>"
+Enable / disable this checker
+.IP "--deprecated-modules=<modules>"
+Deprecated modules which should not be used, separated by a comma
+.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)
+.IP "--ext-import-graph=<file.dot>"
+Create a graph of external dependencies in the given file (report R0402 must not be disabled)
+.IP "--int-import-graph=<file.dot>"
+Create a graph of internal dependencies in the given file (report R0402 must not be disabled)
+
+.SH TYPECHECK
+.IP "--enable-typecheck=<y_or_n>"
+Enable / disable this checker
+.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).
+.IP "--zope=<y_or_n>"
+When zope mode is activated, consider the acquired-members option to ignore access to some undefined attributes.
+.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.
+
+.SH METRICS
+.IP "--enable-metrics=<y_or_n>"
+Enable / disable this checker
+
+.SH SIMILARITIES
+.IP "--enable-similarities=<y_or_n>"
+Enable / disable this checker
+.IP "--min-similarity-lines=<int>"
+Minimum lines number of a similarity.
+.IP "--ignore-comments=<y or n>"
+Ignore comments when computing similarities.
+.IP "--ignore-docstrings=<y or n>"
+Ignore docstrings when computing similarities.
+
+.SH BASIC
.IP "--enable-basic=<y_or_n>"
Enable / disable this checker
.IP "--required-attributes=<attributes>"
@@ -174,54 +178,33 @@ Bad variable names which should always be refused, separated by a comma
.IP "--bad-functions=<builtin function names>"
List of builtins function names that should not be used, separated by a comma
-.SH CLASSES
-checks for :
- * methods without self as first argument
- * overriden methods signature
- * access only to existant members via self
- * attributes not defined in the __init__ method
- * supported interfaces implementation
- * unreachable code
-
-.IP "--enable-classes=<y_or_n>"
-Enable / disable this checker
-.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.
-.IP "--defining-attr-methods=<method names>"
-List of method names used to declare (i.e. assign) instance attributes.
-
-.SH SIMILARITIES
-checks for similarities and duplicated code. This computation may be
- memory / CPU intensive, so you should disable it if you experiments some
- problems.
-
-This checker also defines the following reports:
- * R0801: Duplication
-
-.IP "--enable-similarities=<y_or_n>"
+.SH NEWSTYLE
+.IP "--enable-newstyle=<y_or_n>"
Enable / disable this checker
-.IP "--min-similarity-lines=<int>"
-Minimum lines number of a similarity.
-.IP "--ignore-comments=<y or n>"
-Ignore comments when computing similarities.
-.IP "--ignore-docstrings=<y or n>"
-Ignore docstrings when computing similarities.
-.SH EXCEPTIONS
-checks for
- * excepts without exception filter
- * string exceptions
-
-.IP "--enable-exceptions=<y_or_n>"
+.SH DESIGN
+.IP "--enable-design=<y_or_n>"
Enable / disable this checker
+.IP "--max-args=<int>"
+Maximum number of arguments for function / method
+.IP "--max-locals=<int>"
+Maximum number of locals for function / method body
+.IP "--max-returns=<int>"
+Maximum number of return / yield for function / method body
+.IP "--max-branchs=<int>"
+Maximum number of branch for function / method body
+.IP "--max-statements=<int>"
+Maximum number of statements in function / method body
+.IP "--max-parents=<num>"
+Maximum number of parents for a class (see R0901).
+.IP "--max-attributes=<num>"
+Maximum number of attributes for a class (see R0902).
+.IP "--min-public-methods=<num>"
+Minimum number of public methods for a class (see R0903).
+.IP "--max-public-methods=<num>"
+Maximum number of public methods for a class (see R0904).
.SH FORMAT
-checks for :
- * unauthorized constructions
- * strict indentation
- * line length
- * use of <> instead of !=
-
.IP "--enable-format=<y_or_n>"
Enable / disable this checker
.IP "--max-line-length=<int>"
@@ -231,97 +214,19 @@ Maximum number of lines in a module
.IP "--indent-string=<string>"
String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 tab).
-.SH IMPORTS
-checks for
- * external modules dependencies
- * relative / wildcard imports
- * cyclic imports
- * uses of deprecated modules
-
-This checker also defines the following reports:
- * R0401: External dependencies
- * R0402: Modules dependencies graph
-
-.IP "--enable-imports=<y_or_n>"
-Enable / disable this checker
-.IP "--deprecated-modules=<modules>"
-Deprecated modules which should not be used, separated by a comma
-.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)
-.IP "--ext-import-graph=<file.dot>"
-Create a graph of external dependencies in the given file (report R0402 must not be disabled)
-.IP "--int-import-graph=<file.dot>"
-Create a graph of internal dependencies in the given file (report R0402 must not be disabled)
-
.SH MISCELLANEOUS
-checks for:
- * warning notes in the code like FIXME, XXX
- * PEP 263: source code with non ascii character but no encoding declaration
-
.IP "--enable-miscellaneous=<y_or_n>"
Enable / disable this checker
.IP "--notes=<comma separated values>"
List of note tags to take in consideration, separated by a comma. Default to FIXME, XXX, TODO
-.SH NEWSTYLE
-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
-
-.IP "--enable-newstyle=<y_or_n>"
-Enable / disable this checker
-
-.SH METRICS
-does not check anything but gives some raw metrics :
- * total number of lines
- * total number of code lines
- * total number of docstring lines
- * total number of comments lines
- * total number of empty lines
-
-This checker also defines the following reports:
- * R0701: Raw metrics
-
-.IP "--enable-metrics=<y_or_n>"
-Enable / disable this checker
-
-.SH TYPECHECK
-try to find bugs in the code using type inference
-
-.IP "--enable-typecheck=<y_or_n>"
-Enable / disable this checker
-.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).
-.IP "--zope=<y_or_n>"
-When zope mode is activated, consider the acquired-members option to ignore access to some undefined attributes.
-.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.
-
-.SH VARIABLES
-checks for
- * unused variables / imports
- * undefined variables
- * redefinition of variable from builtins or from an outer scope
- * use of variable before assigment
-
-.IP "--enable-variables=<y_or_n>"
-Enable / disable this checker
-.IP "--init-import=<y_or_n>"
-Tells wether we should check for unused import in __init__ files.
-.IP "--dummy-variables-rgx=<regexp>"
-A regular expression matching names used for dummy variables (i.e. not used).
-.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.
-
.SH ENVIRONMENT VARIABLES
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/syt/.pylint.d.
+directory) . The current PYLINTHOME is /home/adim/.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