1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
|
# -*- coding: utf-8 -*-
from __future__ import with_statement
import os
import re
from django.conf import settings
from django.core.management.base import BaseCommand
from django_extensions.compat import get_template_setting
from django_extensions.management.utils import signalcommand
ANNOTATION_RE = re.compile("\{?#[\s]*?(TODO|FIXME|BUG|HACK|WARNING|NOTE|XXX)[\s:]?(.+)")
ANNOTATION_END_RE = re.compile("(.*)#\}(.*)")
class Command(BaseCommand):
help = 'Show all annotations like TODO, FIXME, BUG, HACK, WARNING, NOTE or XXX in your py and HTML files.'
args = 'tag'
label = 'annotation tag (TODO, FIXME, BUG, HACK, WARNING, NOTE, XXX)'
@signalcommand
def handle(self, *args, **options):
# don't add django internal code
apps = [app for app in filter(lambda app: not app.startswith('django.contrib'), settings.INSTALLED_APPS)]
template_dirs = get_template_setting('DIRS', [])
if template_dirs:
apps += template_dirs
for app_dir in apps:
app_dir = app_dir.replace(".", "/")
for top, dirs, files in os.walk(app_dir):
for fn in files:
if os.path.splitext(fn)[1] in ('.py', '.html'):
fpath = os.path.join(top, fn)
annotation_lines = []
with open(fpath, 'r') as fd:
i = 0
for line in fd.readlines():
i += 1
if ANNOTATION_RE.search(line):
tag, msg = ANNOTATION_RE.findall(line)[0]
if len(args) == 1:
search_for_tag = args[0].upper()
if not search_for_tag == tag:
break
if ANNOTATION_END_RE.search(msg.strip()):
msg = ANNOTATION_END_RE.findall(msg.strip())[0][0]
annotation_lines.append("[%3s] %-5s %s" % (i, tag, msg.strip()))
if annotation_lines:
print("%s:" % fpath)
for annotation in annotation_lines:
print(" * %s" % annotation)
print("")
|