I am currently using Pylint to check for bugs and formatting errors in my Python scripts. I used Brandon Corfman's nice Komodo Hacks: Integrating Pylint tutorial to set up Pylint and how to integrate it with the Komodo Edit IDE (see Easy setup of a Python 2.6 development environment on Windows about setting up Python).
Here is my updated Pylint
execution macro for Komodo Edit 5 which includes a verbose and an errors only reporting command.
Friday, February 09, 2007
Komodo Hacks: Integrating Pylint
UPDATE: Todd left a comment on how he didn't like Pylint's
verbosity. You can add a -e option to the command line to show errors
only instead of stylistic warnings.
UPDATE: I see this hack has already been covered by John
and Mateusz.
I'm
not enjoying today's hack as much as I'd like. Pylint is great, but
getting it installed and configured is much more painful than it should
be. For one thing, Logilab has configured a .egg file for Pylint so
that you can ostensibly use easy_install to get it on your system -- but
the .egg doesn't load any of the other dependencies that are needed.
Very frustrating. Consequently, we'll go about the install process
manually. I'm writing the steps below from a Windows perspective, but
I've tried to note where a Unix install is slightly different.
How
to get PyLint installed and configured for Komodo:
- Download Pylint
and the Pylint dependency modules from Logilab's site: logilab-common
and logilab-astng.
The download links are in the upper-left corner of the page.
- Extract
all the packages from step 1, preserving the folder structure. WinZip
is the best for this on a Windows system; if you have a Unix-based OS,
you can use gunzip -c
[MODULE].tar.gz | tar -xf - or similar.
- Open up a command
prompt, make sure your Python executable can be found in your PATH, and type python setup.py install inside
the extracted common, astng, and pylint directories in turn.
- Change
to your Python installation's scripts
directory.
- Type pylint
--generate-rcfile > standard.rc at the command prompt to
create a Pylint configuration file. (If you're using a Unix system,
you'll need to prefix the pylint
command with a ./ )
Now
you're ready to download Run Pylint macro here. Install
it into Komodo by using the Import Package option under the Toolbox
menu.
Additional configuration is needed to set up the macro for
your system:
- Right-click on the Pylint macro in the toolbox
and click Properties.
- Change the path to pylint in the Command text box
to match the location of your python installation's scripts directory. Also, if
you're using a Unix system, you'll probably need to remove the quotes
around the %F in the text box as well. (Can someone verify this for me?)
- Change
both the directory paths in the Environment Settings list to match the
location of your Python installation as well.
Usage notes:
- Double-clicking
on the Pylint macro in the toolbox will run pylint on the currently
viewed file and print a report in the Command Output tab. Each line in
the report can be double-clicked, and Komodo will jump to the matching
line in the file.
- The standard.rc file that was generated in
step 5 above can be edited to customize the types of errors/warnings
that Pylint will generate. The .rc file is commented thoroughly so you
should be able to figure out what's going on with a little study and
experimentation. As an alternative, pylint can also be customized with
command-line parameters; type pylint
(by itself) at a command prompt to see all the different possibilities.
- Add a -e to the Pylint run command to get just errors instead of the additional stylistic warnings.
- c:\python26\Scripts\pylint -e -f parseable "%F"
|
