Fixed #8280 -- Allowed management command discovery for eggs

Thanks jdetaeye for the report, bhuztez and jdetaeye for the
initial patches, Tim Graham and Berker Peksag for the reviews.
This commit is contained in:
Claude Paroz 2015-01-02 17:58:58 +01:00
parent d94fe42ae5
commit 6e1c9c6568
4 changed files with 22 additions and 7 deletions

View File

@ -3,6 +3,7 @@ from __future__ import unicode_literals
import collections import collections
from importlib import import_module from importlib import import_module
import os import os
import pkgutil
import sys import sys
import django import django
@ -24,11 +25,10 @@ def find_commands(management_dir):
Returns an empty list if no commands are defined. Returns an empty list if no commands are defined.
""" """
command_dir = os.path.join(management_dir, 'commands') command_dir = os.path.join(management_dir, 'commands')
try: # Workaround for a Python 3.2 bug with pkgutil.iter_modules
return [f[:-3] for f in os.listdir(command_dir) sys.path_importer_cache.pop(command_dir, None)
if not f.startswith('_') and f.endswith('.py')] return [name for _, name, is_pkg in pkgutil.iter_modules([command_dir])
except OSError: if not is_pkg and not name.startswith('_')]
return []
def load_command_class(app_name, name): def load_command_class(app_name, name):

View File

@ -371,6 +371,8 @@ Management Commands
* Database connections are now always closed after a management command called * Database connections are now always closed after a management command called
from the command line has finished doing its job. from the command line has finished doing its job.
* Commands from alternate package formats like eggs are now also discovered.
* :djadmin:`dumpdata` now has the option :djadminopt:`--output` which allows * :djadmin:`dumpdata` now has the option :djadminopt:`--output` which allows
specifying the file to which the serialized data is written. specifying the file to which the serialized data is written.

Binary file not shown.

View File

@ -1,13 +1,15 @@
import os import os
from django.apps import apps
from django.db import connection from django.db import connection
from django.core import management from django.core import management
from django.core.management import BaseCommand, CommandError from django.core.management import BaseCommand, CommandError, find_commands
from django.core.management.utils import find_command, popen_wrapper from django.core.management.utils import find_command, popen_wrapper
from django.test import SimpleTestCase, ignore_warnings from django.test import SimpleTestCase, ignore_warnings
from django.test.utils import captured_stderr, captured_stdout from django.test.utils import captured_stderr, captured_stdout, extend_sys_path
from django.utils import translation from django.utils import translation
from django.utils.deprecation import RemovedInDjango20Warning from django.utils.deprecation import RemovedInDjango20Warning
from django.utils._os import upath
from django.utils.six import StringIO from django.utils.six import StringIO
@ -72,6 +74,17 @@ class CommandTests(SimpleTestCase):
if current_path is not None: if current_path is not None:
os.environ['PATH'] = current_path os.environ['PATH'] = current_path
def test_discover_commands_in_eggs(self):
"""
Test that management commands can also be loaded from Python eggs.
"""
egg_dir = '%s/eggs' % os.path.dirname(upath(__file__))
egg_name = '%s/basic.egg' % egg_dir
with extend_sys_path(egg_name):
with self.settings(INSTALLED_APPS=['commandegg']):
cmds = find_commands(os.path.join(apps.get_app_config('commandegg').path, 'management'))
self.assertEqual(cmds, ['eggcommand'])
def test_call_command_option_parsing(self): def test_call_command_option_parsing(self):
""" """
When passing the long option name to call_command, the available option When passing the long option name to call_command, the available option