# -*- coding: utf-8 -*- 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( r"\{?#[\s]*?(TODO|FIXME|BUG|HACK|WARNING|NOTE|XXX)[\s:]?(.+)" ) ANNOTATION_END_RE = re.compile(r"(.*)#\}(.*)") class Command(BaseCommand): help = "Show all annotations like TODO, FIXME, BUG, HACK, WARNING, NOTE or XXX " "in your py and HTML files." label = "annotation tag (TODO, FIXME, BUG, HACK, WARNING, NOTE, XXX)" def add_arguments(self, parser): super().add_arguments(parser) parser.add_argument( "--tag", dest="tag", help="Search for specific tags only", action="append" ) @signalcommand def handle(self, *args, **options): # don't add django internal code apps = [ app.replace(".", "/") for app in filter( lambda app: not app.startswith("django.contrib"), settings.INSTALLED_APPS, ) ] template_dirs = get_template_setting("DIRS", []) base_dir = getattr(settings, "BASE_DIR") if template_dirs: apps += template_dirs for app_dir in apps: if base_dir: app_dir = os.path.join(base_dir, app_dir) 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 options["tag"]: if tag not in map( str.upper, map(str, options["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: self.stdout.write("%s:" % fpath) for annotation in annotation_lines: self.stdout.write(" * %s" % annotation) self.stdout.write("")