From 0346563939396fb89dec8df31f82eaefaaeb8616 Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Tue, 25 Jun 2013 09:37:54 +0800 Subject: Fixed #20653 -- Renamed checksetup management command. This is to allow future compatibility with work that is ongoing in the 2013 GSoC. --- django/core/checks/__init__.py | 0 django/core/checks/compatibility/__init__.py | 0 django/core/checks/compatibility/base.py | 39 ++++++++++++++++++++++++ django/core/checks/compatibility/django_1_6_0.py | 37 ++++++++++++++++++++++ django/core/compat_checks/__init__.py | 0 django/core/compat_checks/base.py | 39 ------------------------ django/core/compat_checks/django_1_6_0.py | 37 ---------------------- django/core/management/commands/check.py | 14 +++++++++ django/core/management/commands/checksetup.py | 14 --------- 9 files changed, 90 insertions(+), 90 deletions(-) create mode 100644 django/core/checks/__init__.py create mode 100644 django/core/checks/compatibility/__init__.py create mode 100644 django/core/checks/compatibility/base.py create mode 100644 django/core/checks/compatibility/django_1_6_0.py delete mode 100644 django/core/compat_checks/__init__.py delete mode 100644 django/core/compat_checks/base.py delete mode 100644 django/core/compat_checks/django_1_6_0.py create mode 100644 django/core/management/commands/check.py delete mode 100644 django/core/management/commands/checksetup.py (limited to 'django/core') diff --git a/django/core/checks/__init__.py b/django/core/checks/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/django/core/checks/compatibility/__init__.py b/django/core/checks/compatibility/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/django/core/checks/compatibility/base.py b/django/core/checks/compatibility/base.py new file mode 100644 index 0000000000..7fe52d2af9 --- /dev/null +++ b/django/core/checks/compatibility/base.py @@ -0,0 +1,39 @@ +from __future__ import unicode_literals +import warnings + +from django.core.checks.compatibility import django_1_6_0 + + +COMPAT_CHECKS = [ + # Add new modules at the top, so we keep things in descending order. + # After two-three minor releases, old versions should get dropped. + django_1_6_0, +] + + +def check_compatibility(): + """ + Runs through compatibility checks to warn the user with an existing install + about changes in an up-to-date Django. + + Modules should be located in ``django.core.compat_checks`` (typically one + per release of Django) & must have a ``run_checks`` function that runs + all the checks. + + Returns a list of informational messages about incompatibilities. + """ + messages = [] + + for check_module in COMPAT_CHECKS: + check = getattr(check_module, 'run_checks', None) + + if check is None: + warnings.warn( + "The '%s' module lacks a " % check_module.__name__ + + "'run_checks' method, which is needed to verify compatibility." + ) + continue + + messages.extend(check()) + + return messages diff --git a/django/core/checks/compatibility/django_1_6_0.py b/django/core/checks/compatibility/django_1_6_0.py new file mode 100644 index 0000000000..1998c5ba77 --- /dev/null +++ b/django/core/checks/compatibility/django_1_6_0.py @@ -0,0 +1,37 @@ +from __future__ import unicode_literals + + +def check_test_runner(): + """ + Checks if the user has *not* overridden the ``TEST_RUNNER`` setting & + warns them about the default behavior changes. + + If the user has overridden that setting, we presume they know what they're + doing & avoid generating a message. + """ + from django.conf import settings + new_default = 'django.test.runner.DiscoverRunner' + test_runner_setting = getattr(settings, 'TEST_RUNNER', new_default) + + if test_runner_setting == new_default: + message = [ + "You have not explicitly set 'TEST_RUNNER'. In Django 1.6,", + "there is a new test runner ('%s')" % new_default, + "by default. You should ensure your tests are still all", + "running & behaving as expected. See", + "https://docs.djangoproject.com/en/dev/releases/1.6/#discovery-of-tests-in-any-test-module", + "for more information.", + ] + return ' '.join(message) + + +def run_checks(): + """ + Required by the ``check`` management command, this returns a list of + messages from all the relevant check functions for this version of Django. + """ + checks = [ + check_test_runner() + ] + # Filter out the ``None`` or empty strings. + return [output for output in checks if output] diff --git a/django/core/compat_checks/__init__.py b/django/core/compat_checks/__init__.py deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/django/core/compat_checks/base.py b/django/core/compat_checks/base.py deleted file mode 100644 index e54b50f287..0000000000 --- a/django/core/compat_checks/base.py +++ /dev/null @@ -1,39 +0,0 @@ -from __future__ import unicode_literals -import warnings - -from django.core.compat_checks import django_1_6_0 - - -COMPAT_CHECKS = [ - # Add new modules at the top, so we keep things in descending order. - # After two-three minor releases, old versions should get dropped. - django_1_6_0, -] - - -def check_compatibility(): - """ - Runs through compatibility checks to warn the user with an existing install - about changes in an up-to-date Django. - - Modules should be located in ``django.core.compat_checks`` (typically one - per release of Django) & must have a ``run_checks`` function that runs - all the checks. - - Returns a list of informational messages about incompatibilities. - """ - messages = [] - - for check_module in COMPAT_CHECKS: - check = getattr(check_module, 'run_checks', None) - - if check is None: - warnings.warn( - "The '%s' module lacks a " % check_module.__name__ + - "'run_checks' method, which is needed to verify compatibility." - ) - continue - - messages.extend(check()) - - return messages diff --git a/django/core/compat_checks/django_1_6_0.py b/django/core/compat_checks/django_1_6_0.py deleted file mode 100644 index bb0dabedac..0000000000 --- a/django/core/compat_checks/django_1_6_0.py +++ /dev/null @@ -1,37 +0,0 @@ -from __future__ import unicode_literals - - -def check_test_runner(): - """ - Checks if the user has *not* overridden the ``TEST_RUNNER`` setting & - warns them about the default behavior changes. - - If the user has overridden that setting, we presume they know what they're - doing & avoid generating a message. - """ - from django.conf import settings - new_default = 'django.test.runner.DiscoverRunner' - test_runner_setting = getattr(settings, 'TEST_RUNNER', new_default) - - if test_runner_setting == new_default: - message = [ - "You have not explicitly set 'TEST_RUNNER'. In Django 1.6,", - "there is a new test runner ('%s')" % new_default, - "by default. You should ensure your tests are still all", - "running & behaving as expected. See", - "https://docs.djangoproject.com/en/dev/releases/1.6/#discovery-of-tests-in-any-test-module", - "for more information.", - ] - return ' '.join(message) - - -def run_checks(): - """ - Required by the ``checksetup`` management command, this returns a list of - messages from all the relevant check functions for this version of Django. - """ - checks = [ - check_test_runner() - ] - # Filter out the ``None`` or empty strings. - return [output for output in checks if output] diff --git a/django/core/management/commands/check.py b/django/core/management/commands/check.py new file mode 100644 index 0000000000..05f48c82bc --- /dev/null +++ b/django/core/management/commands/check.py @@ -0,0 +1,14 @@ +from __future__ import unicode_literals +import warnings + +from django.core.checks.compatibility.base import check_compatibility +from django.core.management.base import NoArgsCommand + + +class Command(NoArgsCommand): + help = "Checks your configuration's compatibility with this version " + \ + "of Django." + + def handle_noargs(self, **options): + for message in check_compatibility(): + warnings.warn(message) diff --git a/django/core/management/commands/checksetup.py b/django/core/management/commands/checksetup.py deleted file mode 100644 index d37e826757..0000000000 --- a/django/core/management/commands/checksetup.py +++ /dev/null @@ -1,14 +0,0 @@ -from __future__ import unicode_literals -import warnings - -from django.core.compat_checks.base import check_compatibility -from django.core.management.base import NoArgsCommand - - -class Command(NoArgsCommand): - help = "Checks your configuration's compatibility with this version " + \ - "of Django." - - def handle_noargs(self, **options): - for message in check_compatibility(): - warnings.warn(message) -- cgit v1.3