8000 Call post_command when the command raises an unhandled exception by jrobichaud · Pull Request #1837 · django-extensions/django-extensions · GitHub
[go: up one dir, main page]
Skip to content

Call post_command when the command raises an unhandled exception #1837

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 5, 2025
Merged

Call post_command when the command raises an unhandled exception #1837

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7eca5ca
Call post_command when the command raises an unhandled exception
jrobichaud Sep 15, 2023
6a71d47
Merge branch 'main' into signalcommand_exception
trbs Apr 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions django_extensions/management/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,13 @@ def signalcommand(func):

def inner(self, *args, **kwargs):
pre_command.send(self.__class__, args=args, kwargs=kwargs)
ret = func(self, *args, **kwargs)
post_command.send(self.__class__, args=args, kwargs=kwargs, outcome=ret)
try:
ret = func(self, *args, **kwargs)
except Exception as e:
post_command.send(self.__class__, args=args, kwargs=kwargs, outcome=e)
raise
else:
post_command.send(self.__class__, args=args, kwargs=kwargs, outcome=ret)
return ret
return inner

Expand Down
35 changes: 34 additions & 1 deletion tests/test_management_command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@
import logging
import importlib

from django.core.management import call_command, find_commands, load_command_class
from django.core.management import call_command, find_commands, load_command_class, BaseCommand
from django.test import TestCase
from io import StringIO

from django_extensions.management.modelviz import use_model, generate_graph_data
from django_extensions.management.commands.merge_model_instances import get_model_to_deduplicate, get_field_names, keep_first_or_last_instance
from django_extensions.management.utils import signalcommand
from . import force_color_support
from .testapp.models import Person, Name, Note, Personality, Club, Membership, Permission
from .testapp.jobs.hourly.test_hourly_job import HOURLY_JOB_MOCK
Expand Down Expand Up @@ -104,6 +105,38 @@ def post(sender, **kwargs):
self.assertIn('kwargs', CommandSignalTests.post)
self.assertIn('outcome', CommandSignalTests.post)

def test_exception(self):
from django_extensions.management.signals import post_command, pre_command

exception = Exception()

class TestCommand(BaseCommand):
@signalcommand
def handle(self, *args, **options):
raise exception

def pre(sender, **kwargs):
CommandSignalTests.pre = dict(**kwargs)

def post(sender, **kwargs):
CommandSignalTests.post = dict(**kwargs)

pre_command.connect(pre, TestCommand)
post_command.connect(post, TestCommand)

out = StringIO()

with self.assertRaises(Exception) as e_info:
call_command(TestCommand(), stdout=out)
self.assertEqual(exception, e_info.exception)
self.assertIn('args', CommandSignalTests.pre)
self.assertIn('kwargs', CommandSignalTests.pre)

self.assertIn('args', CommandSignalTests.post)
self.assertIn('kwargs', CommandSignalTests.post)
self.assertIn('outcome', CommandSignalTests.post)
self.assertEqual(e_info.exception, CommandSignalTests.post["outcome"])


class CommandClassTests(TestCase):
def setUp(self):
Expand Down
0