From 0fa022c367daf37a33837dbe43b1474f69c62df1 Mon Sep 17 00:00:00 2001 From: Stefano Rivera Date: Sun, 26 Dec 2010 21:57:44 +0200 Subject: [PATCH] Run pylint on Python source code. --- debian/changelog | 3 +- debian/control | 1 + ubuntutools/test/pylint.conf | 236 ++++++++++++++++++++++++++++++++ ubuntutools/test/test_pylint.py | 40 ++++++ 4 files changed, 279 insertions(+), 1 deletion(-) create mode 100644 ubuntutools/test/pylint.conf create mode 100644 ubuntutools/test/test_pylint.py diff --git a/debian/changelog b/debian/changelog index dce2376..1f26a8f 100644 --- a/debian/changelog +++ b/debian/changelog @@ -21,6 +21,7 @@ ubuntu-dev-tools (0.109) UNRELEASED; urgency=low - 404main, merge-changelog, pull-debian-debdiff, pull-debian-source, pull-revu-source: + Return 0 after showing help. + - Run pylint on Python source code. * ubuntutools/common.py: Remove https_proxy unsetting code, working around LP: #94130. * edit-patch: Don't let cat error through if debian/source/format doesn't @@ -50,7 +51,7 @@ ubuntu-dev-tools (0.109) UNRELEASED; urgency=low * add "add-patch" that provides the non-interactive version of edit-patch - -- Stefano Rivera Sun, 26 Dec 2010 20:14:54 +0200 + -- Stefano Rivera Sun, 26 Dec 2010 21:56:07 +0200 ubuntu-dev-tools (0.108) experimental; urgency=low diff --git a/debian/control b/debian/control index fa05060..5e873ed 100644 --- a/debian/control +++ b/debian/control @@ -12,6 +12,7 @@ Build-Depends: dctrl-tools, libapt-pkg-perl, libwww-perl, lsb-release, + pylint, python-all (>= 2.6.5-13~), python-apt (>= 0.7.93~), python-debian (>= 0.1.15), diff --git a/ubuntutools/test/pylint.conf b/ubuntutools/test/pylint.conf new file mode 100644 index 0000000..2bc088e --- /dev/null +++ b/ubuntutools/test/pylint.conf @@ -0,0 +1,236 @@ +[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 + +# Add to the black list. It should be a base name, not a +# path. You may set this option multiple times. +ignore=CVS + +# Pickle collected data for later comparisons. +persistent=no + +# List of plugins (as comma separated values of python modules names) to load, +# usually to register additional checkers. +load-plugins= + + +[MESSAGES CONTROL] + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time. +enable=E9900,E1102,E1103,E1124,E1122,E1123,E9906,E1120,E9905,E9902,E9903,E0602,E9901,E0202,E0203,E0221,E0222,E1101,E0001,E0100,E0710,E0711,E1003,E1002,E1001,E0103,E1111,E0601,E0101,E0102,E0105,E0104,E0107,E1121,E0503,E0106,E0501,E0502,E0211,E0213,E0611,E9904,E0012,E0011,E0702,E0701 + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifier separated by comma (,) or put this option +# multiple time. +#disable= + + +[REPORTS] + +# Set the output format. Available formats are text, parseable, colorized, msvs +# (visual studio) and html +output-format=text + +# Include message's id in output +include-ids=yes + +# 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 whether to display a full report or only the messages +reports=no + +# 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 +# respectively contain the number of errors / warnings messages and the total +# number of statements analyzed. This is used by the global evaluation report +# (R0004). +evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) + +# Add a comment according to your evaluation note. This is used by the global +# evaluation report (R0004). +comment=no + + +[SIMILARITIES] + +# 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 + + +[TYPECHECK] + +# Tells whether 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 + +# List of classes names for which member attributes should not be checked +# (useful for classes with attributes dynamically set). +ignored-classes=Launchpad,BaseWrapper,PersonTeam,Distribution,Consumer + +# When zope mode is activated, add a predefined set of Zope acquired attributes +# to generated-members. +zope=no + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E0201 when accessed. +generated-members=REQUEST,acl_users,aq_parent + + +[FORMAT] + +# Maximum number of characters on a single line. +max-line-length=80 + +# Maximum number of lines in a module +max-module-lines=1000 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME,XXX,TODO + + +[BASIC] + +# Required attributes for module, separated by a comma +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]+))$ + +# Regular expression which should only match correct module level names +const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ + +# Regular expression which should only match correct class names +class-rgx=[A-Z_][a-zA-Z0-9]+$ + +# Regular expression which should only match 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}$ + +# Regular expression which should only match correct instance attribute names +attr-rgx=[a-z_][a-z0-9_]{2,30}$ + +# Regular expression which should only match 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}$ + +# Regular expression which should only match correct list comprehension / +# generator expression variable 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,_ + +# 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 functions or classes name which do +# not require a docstring +no-docstring-rgx=__.*__ + + +[VARIABLES] + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# A regular expression matching names used for dummy variables (i.e. not used). +dummy-variables-rgx=_|dummy + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid to define new builtins when possible. +additional-builtins= + + +[DESIGN] + +# Maximum number of arguments for function / method +max-args=5 + +# Argument names that match this expression will be ignored. Default to name +# with leading underscore +ignored-argument-names=_.* + +# Maximum number of locals for function / method body +max-locals=15 + +# Maximum number of return / yield for function / method body +max-returns=6 + +# Maximum number of branch for function / method body +max-branchs=12 + +# Maximum number of statements in function / method body +max-statements=50 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of attributes for a class (see R0902). +max-attributes=7 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + + +[IMPORTS] + +# Deprecated modules which should not be used, separated by a comma +deprecated-modules=regsub,string,TERMIOS,Bastion,rexec + +# Create a graph of every (i.e. internal and external) dependencies in the +# given file (report RP0402 must not be disabled) +import-graph= + +# Create a graph of external dependencies in the given file (report RP0402 must +# not be disabled) +ext-import-graph= + +# Create a graph of internal dependencies in the given file (report RP0402 must +# not be disabled) +int-import-graph= + + +[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 diff --git a/ubuntutools/test/test_pylint.py b/ubuntutools/test/test_pylint.py new file mode 100644 index 0000000..02ff50d --- /dev/null +++ b/ubuntutools/test/test_pylint.py @@ -0,0 +1,40 @@ +# test_pylint.py - Run pylint in errors-only mode. +# +# Copyright (C) 2010, Stefano Rivera +# +# Permission to use, copy, modify, and/or distribute this software for any +# purpose with or without fee is hereby granted, provided that the above +# copyright notice and this permission notice appear in all copies. +# +# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH +# REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +# AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +# INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM +# LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +# OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +# PERFORMANCE OF THIS SOFTWARE. + +import os +import subprocess + +import setup +from ubuntutools.test import unittest + +class PylintTestCase(unittest.TestCase): + def test_pylint(self): + "Test: Run pylint on Python source code" + files = ['ubuntutools'] + for script in setup.scripts: + f = open(script, 'r') + if 'python' in f.readline(): + files.append(script) + f.close() + p = subprocess.Popen(['pylint', '--rcfile=ubuntutools/test/pylint.conf', + '-E', '--'] + files, + stdout=subprocess.PIPE, stderr=subprocess.PIPE, + close_fds=True) + + out, err = p.communicate() + self.assertEqual(p.wait(), 0, + "pylint returned non-zero.\n" + "Output:\n" + out + err)