Mailman 3 July 2014 - code-quality

Custom pylint checkers for Python 2/3 compatibility
by Claudiu Popa Aug. 8, 2014

Aug. 8, 2014

Hello Brett. At a quick glance, the patch looks really good, even with the scarce documentation that we have. :-) Maybe you can turn this into a pull request for Pylint, so that we may have in the near future a mode that only checks Python 2/3 compatibility? That way would be easier for review, too. Thank you.

2 6

Contribution: Checking function, method, and constructor parameter documentation
by Daniel, Bruno July 31, 2014

July 31, 2014

Dear pylint developers, We use pylint extensively in our company -- thanks this great tool! -- and wrote some plugins ourselves to aid us in our daily work. One of these plugins is a Sphinx parameter documentation checker that helps us to identify missing parameter or parameter type documentation in functions, methods and class constructors (__init__ methods). The checker class also identifies naming inconsistencies between each function or method signature and the corresponding docstring. By convention, we use Sphinx syntax for the parameter documentation (see below for examples) and we document class constructor parameters in the class docstring. We want to offer this code to you as a optional standard pylint checker. Would such an addition to pylint be welcome? To illustrate, here are our unit tests which include several examples: -snip----- test_pylint_plugin.py ---------------------------------------------- """Unittest for our pylint plugin.""" from __future__ import division, print_function import unittest from astroid import test_utils from pylint.testutils import CheckerTestCase, Message, set_config from nbpy_devel.pylint_plugin import SphinxDocChecker, NbpyChecker class SpinxDocCheckerTest(CheckerTestCase): """Tests for pylint_plugin.SphinxDocChecker""" CHECKER_CLASS = SphinxDocChecker def test_missing_func_params_in_docstring(self): """Example of a function with missing parameter documentation in the docstring """ node = test_utils.extract_node(""" def function_foo(x, y): '''docstring ... missing parameter documentation''' pass """) with self.assertAddsMessages( Message( msg_id='W9003', node=node, args=('x, y',)), Message( msg_id='W9004', node=node, args=('x, y',))): self.checker.visit_function(node) def test_missing_method_params_in_docstring(self): """Example of a class method with missing parameter documentation in the docstring """ node = test_utils.extract_node(""" class Foo(object): def method_foo(self, x, y): '''docstring ... missing parameter documentation''' pass """) method_node = node.body[0] with self.assertAddsMessages( Message( msg_id='W9003', node=method_node, args=('x, y',)), Message( msg_id='W9004', node=method_node, args=('x, y',))): self.checker.visit(node) def test_existing_func_params_in_docstring(self): """Example of a function with correctly documented parameters and return values """ node = test_utils.extract_node(""" def function_foo(xarg, yarg): '''function foo ... :param xarg: bla xarg :type xarg: int :param yarg: bla yarg :type yarg: float :return: sum :rtype: float ''' return xarg + yarg """) with self.assertNoMessages(): self.checker.visit_function(node) def test_wrong_name_of_func_params_in_docstring(self): """Example of functions with inconsistent parameter names in the signature and in the documentation """ node = test_utils.extract_node(""" def function_foo(xarg, yarg): '''function foo ... :param xarg1: bla xarg :type xarg: int :param yarg: bla yarg :type yarg1: float ''' return xarg + yarg """) with self.assertAddsMessages( Message( msg_id='W9003', node=node, args=('xarg, xarg1',)), Message( msg_id='W9004', node=node, args=('yarg, yarg1',))): self.checker.visit_function(node) node = test_utils.extract_node(""" def function_foo(xarg, yarg): '''function foo ... :param yarg1: bla yarg :type yarg1: float For the other parameters, see bla. ''' return xarg + yarg """) with self.assertAddsMessages( Message( msg_id='W9003', node=node, args=('yarg1',)), Message( msg_id='W9004', node=node, args=('yarg1',))): self.checker.visit_function(node) def test_see_sentence_for_func_params_in_docstring(self): """Example for the usage of "For the other parameters, see" to avoid too many repetitions, e.g. in functions or methods adhering to a given interface """ node = test_utils.extract_node(""" def function_foo(xarg, yarg): '''function foo ... :param yarg: bla yarg :type yarg: float For the other parameters, see :func:`bla` ''' return xarg + yarg """) with self.assertNoMessages(): self.checker.visit_function(node) def test_constr_params_in_class(self): """Example of a class with missing constructor parameter documentation Everything is completely analogous to functions. """ node = test_utils.extract_node(""" class ClassFoo(object): '''docstring foo missing constructor parameter documentation''' def __init__(self, x, y): pass """) with self.assertAddsMessages( Message( msg_id='W9003', node=node, args=('x, y',)), Message( msg_id='W9004', node=node, args=('x, y',))): self.checker.visit_class(node) if __name__ == '__main__': unittest.main() ----------------------------------------------------------------------------- Kind regards Bruno Daniel ---- Dr. Bruno Daniel Research and Development bruno.daniel(a)blue-yonder.com www.blue-yonder.com

3 6

[ANN] Pylint 1.3 / Astroid 1.2 released.
by Claudiu Popa July 28, 2014

July 28, 2014

Hello! I'm happy to announce that Pylint 1.3 and Astroid 1.2 were released at the end of the last week. There has been a lot of enhancements and bug fixes since the latest release, so you're strongly encouraged to upgrade. More information about the changes in this release can be found here: http://www.logilab.org/blogentry/259107. Enjoy!

1 0

Custom pylint checkers for Python 2/3 compatibility
by Brett Cannon July 25, 2014

July 25, 2014

The Python 2/3 checkers I emailed this list about back in June I think are now at a beta stage and can be viewed at https://github.com/brettcannon/caniusepython3/blob/pylint/caniusepython3/py… along with tests at https://github.com/brettcannon/caniusepython3/blob/pylint/caniusepython3/te… and a demo "bad" file and pylintrc file at https://github.com/brettcannon/caniusepython3/blob/pylint/bad.py and https://github.com/brettcannon/caniusepython3/blob/pylint/pylintrc, respectively. If anyone has any feedback on the way I implemented the checkers I would appreciate it since the public documentation on writing your own checkers is a bit thin to say the least =) .

1 0

Static Analysis Dinner on Friday @ EuroPython
by Torsten Marek July 24, 2014

July 24, 2014

Hi all, we thought it'd be nice to go and have a dinner together with people interested in static analysis. My suggestion is to go to Pri Maria ( http://www.primaria.de/). Let's meet tomorrow at 6:30pm, at the bcc entrance. Getting to the restaurant will take about 30min. If you want to come, please drop me a line until tomorrow about noon so that I can reserve a table. Cheers, // Torsten

1 0

Europython 14
by Sylvain Thénault July 21, 2014

July 21, 2014

Hi there, a quick email to let you know that Torsten, Claudiu and I, the main pylint developpers, will met together during EP14 in Berlin in the next few weeks. It may be a good opportunity to talk with other people developping other tools for python or interested by code quality in general. So, let me know! cheers -- Sylvain Thénault, LOGILAB, Paris (01.45.32.03.12) - Toulouse (05.62.17.16.42) Formations Python, Debian, Méth. Agiles: http://www.logilab.fr/formations Développement logiciel sur mesure: http://www.logilab.fr/services CubicWeb, the semantic web framework: http://www.cubicweb.org

5 5

Namespaced packages and relative imports
by François Vanderkelen July 17, 2014

July 17, 2014

Hi experts ! I am struggling with Pylint with an issue that might be a problem coming from my code. Since I am relatively new to python (~1year) I would like to have your input on the matter. I am trying to split a big python project I am doing for my company into several packages, allowing me to update each part without impacting the others. Doing that, we decided to go with Jenkins to improve our code quality which lead me to implement pylint for code violations checks. Currently my build process is the following : - Create a new virtualenv with Python version 2.7.6 - Install all dependencies needed by my package - Download the last version of the package from the master branch in our internal gitlab - Run nosetests with coverage reports - Run pylint and export the result to have some violations reports in Jenkins. At first I had a lot of pylint errors since I wasn't installing all dependencies, resulting in something like 200 import errors ... Now it is reduced to some 60 errors but when I look a the build output log, I can see that pylint is actually crashing in the middle of the process. ************* Module company.project.core.security.app company/project/core/security/app.py:1: [C0111(missing-docstring), ] Missing module docstring load_entry_point('pylint==1.2.1', 'console_scripts', 'pylint')() File "/var/lib/jenkins/.pyenv/versions/2.7.6/lib/python2.7/site-packages/pylint/__init__.py", line 21, in run_pylint Run(sys.argv[1:]) File "/var/lib/jenkins/.pyenv/versions/2.7.6/lib/python2.7/site-packages/pylint/lint.py", line 1051, in __init__ linter.check(args) File "/var/lib/jenkins/.pyenv/versions/2.7.6/lib/python2.7/site-packages/pylint/lint.py", line 626, in check self.check_astroid_module(astroid, walker, rawcheckers, tokencheckers) File "/var/lib/jenkins/.pyenv/versions/2.7.6/lib/python2.7/site-packages/pylint/lint.py", line 712, in check_astroid_module walker.walk(astroid) File "/var/lib/jenkins/.pyenv/versions/2.7.6/lib/python2.7/site-packages/pylint/utils.py", line 715, in walk self.walk(child) File "/var/lib/jenkins/.pyenv/versions/2.7.6/lib/python2.7/site-packages/pylint/utils.py", line 712, in walk cb(astroid) File "/var/lib/jenkins/.pyenv/versions/2.7.6/lib/python2.7/site-packages/pylint/checkers/imports.py", line 269, in visit_from self._add_imported_module(node, '%s.%s' % (importedmodnode.name, name)) File "/var/lib/jenkins/.pyenv/versions/2.7.6/lib/python2.7/site-packages/pylint/checkers/imports.py", line 302, in _add_imported_module importedmodname = get_module_part(importedmodname) File "/var/lib/jenkins/.pyenv/versions/2.7.6/lib/python2.7/site-packages/logilab/common/modutils.py", line 352, in get_module_part path=path, context_file=context_file) File "/var/lib/jenkins/.pyenv/versions/2.7.6/lib/python2.7/site-packages/logilab/common/modutils.py", line 297, in file_from_modpath return _file_from_modpath(modpath, path, context) File "/var/lib/jenkins/.pyenv/versions/2.7.6/lib/python2.7/site-packages/logilab/common/modutils.py", line 556, in _file_from_modpath mtype, mp_filename = _module_file(modpath, path) File "/var/lib/jenkins/.pyenv/versions/2.7.6/lib/python2.7/site-packages/logilab/common/modutils.py", line 636, in _module_file return _search_zip(modpath, pic)[:2] File "/var/lib/jenkins/.pyenv/versions/2.7.6/lib/python2.7/site-packages/logilab/common/modutils.py", line 577, in _search_zip raise ImportError('No module named %s' % '.'.join(modpath)) ImportError: No module named project This is how my package is constructed : company/ -- __init__.py -- project/ -- __init__.py -- core/ -- __init__.py -- app.py -- security/ -- __init__.py -- app.py In company.project.core.security.app I am trying to import company.project.core.app which contains some BaseClass for my project using: from ..app import BaseApplication This is working fine with python, although pylint is crying out loud on this specific line. I tried to replace the relative import by core.app which worked fine with pylint but my code is not working anymore. I tried also to use the full path (company.project.core.app) but I have the exact same import error. Be aware that both company and project are just namespace packages. Also I am forced to use the path to run pylint because it looks like my top-level folder is not a package (even if it contains a __init__ file). pylint company.project.core No module named project.core (fatal) pylint company/project/core is working. When I try to run pylint directly from the top-level package, I have the exact same result as from the path. A workaround I can try is to install the package before running pylint on it but I reckon since my cwd is supposed to be added to the path I can't see how it would help (although I have other company packages installed). What do you think I should do ? Is my design a poorly chosen one and I don't have any solution ? Thanks, François

2 7

Unable to import error from pylint
by Martín Ferrari July 14, 2014

July 14, 2014

Hi! This is probably a FAQ, but I cannot find it anywhere in the docs. I get a F0401 (Unable to import) when importing a flask external module, which involves a trick on __init__ on the parent package to locate the actual module, which has a different name (flask.ext.httpauth is in fact flask_httpauth, with no package name). I understand that pylint avoids executing code on imports, so that explains this message. The question would be: is there a way to fix this situation without ignoring everything that uses that module? Adding an 'import flask.ext.httpauth' in the init-hook does not seem to solve it. Thanks! -- MartÃn Ferrari (Tincho)

2 1

flake8 offers an extra option: –max-complexity, which will emit a warning if the McCabe complexity of a function is higher than the value. By default it’s deactivated
by Liang, Feng July 11, 2014

July 11, 2014

Hello, I like to keep this feature turned off, but somehow it’s on and I don’t know when, where or how I turned it on. I don’t have any config file at all. Can you shed some light here how to turn it off? Thank you, Feng

2 1

Minor ignore config issue
by Roger Binns July 8, 2014

July 8, 2014

-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 In my config file I had this: ignore = E226, E225 The E225 bit didn't work. I worked out that the space after the comma was causing the problem. Can I recommend that strip is run on each part after splitting on the comma? Roger -----BEGIN PGP SIGNATURE----- Version: GnuPG v1 iEYEARECAAYFAlO8VcAACgkQmOOfHg372QSmRQCeJF8u9qC9FcDioDDIJbwR6xMn KC8AniRQ2K4O09UavNqB5JkZCKzBGXcy =x7hJ -----END PGP SIGNATURE-----

1 0