Manpages

Manpage of PYCHECKER

PYCHECKER

Section: User Commands (1)
Updated: 12 June 2001
Index
Return to Main Contents
 

NAME

pychecker - program to check python scripts for common mistakes  

SYNOPSIS

pychecker [options] files...
 

DESCRIPTION

This manual page documents briefly the pychecker command. It was written for the Debian GNU/Linux distribution because the original program does not have a manual page.

pychecker is a program that finds common bugs in python source code. It finds problems that are typically caught by a compiler for less dynamic languages, like C and C++. Because of the dynamic nature of python, some warnings may be incorrect; however, spurious warnings should be fairly infrequent.

PyChecker works in a combination of ways. First, it imports each module. If there is an import error, the module cannot be processed. The import provides some basic information about the module. The code for each function, class, and method is checked for possible problems.

 

OPTIONS

This program follows the usual GNU command line syntax, with long options starting with two dashes (`-'). A summary of options is included below.
-h, --help
Show summary of options.
-s, --doc
turn off all warnings for no doc strings
-m, --moduledoc
no module doc strings [on]
-c, --classdoc
no class doc strings [on]
-f, --funcdoc
no function/method doc strings [off]
-i, --import unused imports [on]
-l, --local
unused local variables, except tuples [on]
-t, --tuple
all unused local variables, including tuples [off]
-v, --var
all unused module variables [off]
-p, --privatevar
unused private module variables [on]
-g, --allglobals
report each occurrence of global warnings [off]
-n, --namedargs
functions called with named arguments (like keywords) [on]
-a, --initattr
Attributes (members) must be defined in __init__() [off]
-I, --initsubclass
Subclass.__init__() not defined [off]
-A, --callattr
Calling data members as functions [off]
-b, --blacklist ignore warnings from the list of modules [['Tkinter', 'wxPython', 'gtk', 'GTK', 'GDK']]
-V, --varlist
ignore variables not used from the list [['Tkinter', 'wxPython', 'gtk', 'GTK', 'GDK']]
-L, --maxlines
maximum lines in a function [200]
-B, --maxbranches
maximum branches in a function [50]
-R, --maxreturns
maximum returns in a function [10]
-P, --printparse print internal checker parse structures [off]
-d, --debug
turn on debugging for checker [off]

 

SEE ALSO

python(1)
 

AUTHOR

This manual page was written by Arto Jantunen <viiru@debian.org>, for the Debian GNU/Linux system (but may be used by others).


 

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
SEE ALSO
AUTHOR

This document was created by man2html, using the manual pages.
Time: 00:12:28 GMT, April 25, 2024