Last active
November 1, 2024 11:13
-
-
Save voldmar/1264102 to your computer and use it in GitHub Desktop.
Show all signals receivers in Django project (fixed for Django 4 by @MahrezBH)
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# coding:utf-8 | |
import gc | |
import inspect | |
import weakref | |
from django.core.management.base import BaseCommand, CommandError | |
from django.dispatch import Signal | |
REF_TYPES = (weakref.ReferenceType,) | |
PROJECT_NAME = "TO-BE-COMPLETED" | |
FORMATS = { | |
'vim': '{path}:{line}:{name}', | |
'human': '{name} in line {line} of {path}', | |
} | |
class Command(BaseCommand): | |
help = 'Show all signals receivers from the project' | |
def add_arguments(self, parser): | |
parser.add_argument( | |
'--format', | |
dest='line_format', | |
default='human', | |
choices=FORMATS.keys(), | |
help='Line format (available choices: {0})'.format(', '.join(FORMATS)), | |
) | |
parser.add_argument( | |
'--scope', | |
dest='scope', | |
default='all', | |
choices=['all', 'project'], | |
help='Specify "all" to show all signals or "project" to show only project-specific signals', | |
) | |
def handle(self, *args, **options): | |
line_format = options['line_format'] | |
scope = options['scope'] | |
msg = FORMATS.get(line_format) | |
if not msg: | |
raise CommandError('Format must be one of {0}'.format( | |
', '.join(FORMATS.keys()))) | |
seen_receivers = set() | |
for signal in [obj for obj in gc.get_objects() if isinstance(obj, Signal)]: | |
for _, receiver in signal.receivers: | |
if isinstance(receiver, REF_TYPES): | |
receiver = receiver() | |
if receiver and receiver not in seen_receivers: | |
source_file = inspect.getsourcefile(receiver) | |
# Filter signals based on scope | |
if scope == 'all' or (source_file and PROJECT_NAME in source_file): | |
seen_receivers.add(receiver) | |
self.stdout.write( | |
msg.format( | |
name=receiver.__name__, | |
line=inspect.getsourcelines(receiver)[1], | |
path=source_file, | |
) | |
) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
@MahrezBH Thanks mate, appreciate it!