findnocoding.py

#!/usr/bin/env python

"""List all those Python files that require a coding directive

Usage: nocoding.py dir1 [dir2...]
"""

__author__="Oleg Broytmann, Georg Brandl"

importsys, os, re, getopt

# our pysource module finds Python source files
try:
importpysource
exceptImportError:
# emulate the module with a simple os.walk
classpysource:
has_python_ext=looks_like_python=can_be_compiled=None
defwalk_python_files(self, paths, *args, **kwargs):
forpathinpaths:
ifos.path.isfile(path):
yieldpath.endswith(".py")
elifos.path.isdir(path):
forroot, dirs, filesinos.walk(path):
forfilenameinfiles:
iffilename.endswith(".py"):
yieldos.path.join(root, filename)
pysource=pysource()


print>>sys.stderr, ("The pysource module is not available; "
"no sophisticated Python source file search will be done.")


decl_re=re.compile(r'^[ \t\f]*#.*?coding[:=][ \t]*([-\w.]+)')
blank_re=re.compile(r'^[ \t\f]*(?:[#\r\n]|$)')

defget_declaration(line):
match=decl_re.match(line)
ifmatch:
returnmatch.group(1)
returnb''

defhas_correct_encoding(text, codec):
try:
unicode(text, codec)
exceptUnicodeDecodeError:
returnFalse
else:
returnTrue

defneeds_declaration(fullpath):
try:
infile=open(fullpath, 'rU')
exceptIOError: # Oops, the file was removed - ignore it
returnNone

line1=infile.readline()
line2=infile.readline()

if (get_declaration(line1) or
blank_re.match(line1) andget_declaration(line2)):
# the file does have an encoding declaration, so trust it
infile.close()
returnFalse

# check the whole file for non-ASCII characters
rest=infile.read()
infile.close()

ifhas_correct_encoding(line1+line2+rest, "ascii"):
returnFalse

returnTrue


usage="""Usage: %s [-cd] paths...
 -c: recognize Python source files trying to compile them
 -d: debug output"""%sys.argv[0]

try:
opts, args=getopt.getopt(sys.argv[1:], 'cd')
exceptgetopt.error, msg:
print>>sys.stderr, msg
print>>sys.stderr, usage
sys.exit(1)

is_python=pysource.looks_like_python
debug=False

foro, ainopts:
ifo=='-c':
is_python=pysource.can_be_compiled
elifo=='-d':
debug=True

ifnotargs:
print>>sys.stderr, usage
sys.exit(1)

forfullpathinpysource.walk_python_files(args, is_python):
ifdebug:
print"Testing for coding: %s"%fullpath
result=needs_declaration(fullpath)
ifresult:
printfullpath