From 1a9f13df59e83eb6e0c20f96d878826519eca62a Mon Sep 17 00:00:00 2001 From: Anubhav Joshi Date: Thu, 19 Dec 2013 03:01:48 +0530 Subject: [PATCH 001/208] Fixed #21478 -- Corrected docs for when Field.db_type() is called. --- docs/howto/custom-model-fields.txt | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/howto/custom-model-fields.txt b/docs/howto/custom-model-fields.txt index 6054a83f10..b7bcefad53 100644 --- a/docs/howto/custom-model-fields.txt +++ b/docs/howto/custom-model-fields.txt @@ -458,11 +458,14 @@ For example:: else: return 'timestamp' -The :meth:`.db_type` method is only called by Django when the framework +The :meth:`.db_type` method is called by Django when the framework constructs the ``CREATE TABLE`` statements for your application -- that is, -when you first create your tables. It's not called at any other time, so it can -afford to execute slightly complex code, such as the -``connection.settings_dict`` check in the above example. +when you first create your tables. It is also called when constructing a +``WHERE`` clause that includes the model field -- that is, when you retrieve data +using QuerySet methods like ``get()``, ``filter()``, and ``exclude()`` and have +the model field as an argument. It's not called at any other time, so it can afford to +execute slightly complex code, such as the ``connection.settings_dict`` check in +the above example. Some database column types accept parameters, such as ``CHAR(25)``, where the parameter ``25`` represents the maximum column length. In cases like these, From 7f2485b4d180956aa556a88ed1d9754eeeeea054 Mon Sep 17 00:00:00 2001 From: Alexey Voronov Date: Sun, 22 Dec 2013 00:03:17 +0200 Subject: [PATCH 002/208] Fixed #21643 -- repeated execution of qs with F() + timedelta Thanks Tim Graham for review. --- django/db/models/sql/expressions.py | 1 + tests/expressions_regress/tests.py | 7 +++++++ 2 files changed, 8 insertions(+) diff --git a/django/db/models/sql/expressions.py b/django/db/models/sql/expressions.py index bd661b5adf..9f29e2ace5 100644 --- a/django/db/models/sql/expressions.py +++ b/django/db/models/sql/expressions.py @@ -111,6 +111,7 @@ class SQLEvaluator(object): def evaluate_date_modifier_node(self, node, qn, connection): timedelta = node.children.pop() sql, params = self.evaluate_node(node, qn, connection) + node.children.append(timedelta) if (timedelta.days == timedelta.seconds == timedelta.microseconds == 0): return sql, params diff --git a/tests/expressions_regress/tests.py b/tests/expressions_regress/tests.py index e603c410ac..7533e4ee39 100644 --- a/tests/expressions_regress/tests.py +++ b/tests/expressions_regress/tests.py @@ -274,6 +274,13 @@ class FTimeDeltaTests(TestCase): self.days_long.append(e4.completed - e4.assigned) self.expnames = [e.name for e in Experiment.objects.all()] + def test_multiple_query_compilation(self): + # Ticket #21643 + queryset = Experiment.objects.filter(end__lt=F('start') + datetime.timedelta(hours=1)) + q1 = str(queryset.query) + q2 = str(queryset.query) + self.assertEqual(q1, q2) + def test_delta_add(self): for i in range(len(self.deltas)): delta = self.deltas[i] From 73c9e65b75cd956410ae71f39fb2f6a9b7b45b42 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 18 Dec 2013 10:34:20 +0100 Subject: [PATCH 003/208] Added a context manager to hold the import lock. --- django/core/apps/cache.py | 8 ++------ django/utils/module_loading.py | 13 +++++++++++++ 2 files changed, 15 insertions(+), 6 deletions(-) diff --git a/django/core/apps/cache.py b/django/core/apps/cache.py index b076fc1968..d07c3bbe34 100644 --- a/django/core/apps/cache.py +++ b/django/core/apps/cache.py @@ -1,7 +1,6 @@ "Utilities for loading models and the modules that contain them." from collections import OrderedDict -import imp from importlib import import_module import os import sys @@ -9,7 +8,7 @@ import warnings from django.conf import settings from django.core.exceptions import ImproperlyConfigured -from django.utils.module_loading import module_has_submodule +from django.utils.module_loading import import_lock, module_has_submodule from django.utils._os import upath from django.utils import six @@ -74,8 +73,7 @@ class AppCache(object): # without holding the importer lock and another thread then tries to # import something which also launches the app loading. For details of # this situation see #18251. - imp.acquire_lock() - try: + with import_lock(): if self.loaded: return for app_name in settings.INSTALLED_APPS: @@ -86,8 +84,6 @@ class AppCache(object): for app_name in self.postponed: self.load_app(app_name) self.loaded = True - finally: - imp.release_lock() def load_app(self, app_name, can_postpone=False): """ diff --git a/django/utils/module_loading.py b/django/utils/module_loading.py index 8868a2d3ab..0c6bad2a7b 100644 --- a/django/utils/module_loading.py +++ b/django/utils/module_loading.py @@ -1,5 +1,6 @@ from __future__ import absolute_import # Avoid importing `importlib` from this package. +from contextlib import contextmanager import copy import imp from importlib import import_module @@ -35,6 +36,18 @@ def import_by_path(dotted_path, error_prefix=''): return attr +@contextmanager +def import_lock(): + """ + Context manager that aquires the import lock. + """ + imp.acquire_lock() + try: + yield + finally: + imp.release_lock() + + def autodiscover_modules(*args, **kwargs): """ Auto-discover INSTALLED_APPS modules and fail silently when From 742ed9878e7edbb7a11667c489c719c4d9ab82de Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 18 Dec 2013 11:19:56 +0100 Subject: [PATCH 004/208] Refactored registration of models. Got rid of AppConfig._stub. As a side effect, app_cache.app_configs now only contains entries for applications that are in INSTALLED_APPS, which is a good thing and will allow dramatic simplifications (which I will perform in the next commit). That required adjusting all methods that iterate on app_configs without checking the "installed" flag, hence the large changes in get_model[s]. Introduced AppCache.all_models to store models: - while the app cache is being populated and a suitable app config object to register models isn't available yet; - for applications that aren't in INSTALLED_APPS since they don't have an app config any longer. Replaced get_model(seed_cache=False) by registered_model() which can be kept simple and safe to call at any time, and removed the seed_cache argument to get_model[s]. There's no replacement for that private API. Allowed non-master app caches to go through populate() as it is now safe to do so. They were introduced in 1.7 so backwards compatibility isn't a concern as long as the migrations framework keeps working. --- django/core/apps/base.py | 4 -- django/core/apps/cache.py | 80 ++++++++++++++------------ django/db/models/base.py | 6 +- django/db/models/fields/related.py | 3 +- tests/app_loading/tests.py | 15 ++--- tests/invalid_models/tests.py | 1 + tests/managers_regress/tests.py | 3 + tests/migrations/test_commands.py | 1 + tests/proxy_model_inheritance/tests.py | 2 + tests/proxy_models/tests.py | 1 + tests/tablespaces/tests.py | 1 + 11 files changed, 64 insertions(+), 53 deletions(-) diff --git a/django/core/apps/base.py b/django/core/apps/base.py index 860777bb03..5991029c09 100644 --- a/django/core/apps/base.py +++ b/django/core/apps/base.py @@ -39,9 +39,5 @@ class AppConfig(object): # This is a unicode object on Python 2 and a str on Python 3. self.path = upath(app_module.__path__[0]) if app_module is not None else None - @classmethod - def _stub(cls, label): - return cls(label, None, None) - def __repr__(self): return '' % self.label diff --git a/django/core/apps/cache.py b/django/core/apps/cache.py index d07c3bbe34..deffc84586 100644 --- a/django/core/apps/cache.py +++ b/django/core/apps/cache.py @@ -1,6 +1,6 @@ "Utilities for loading models and the modules that contain them." -from collections import OrderedDict +from collections import defaultdict, OrderedDict from importlib import import_module import os import sys @@ -10,7 +10,6 @@ from django.conf import settings from django.core.exceptions import ImproperlyConfigured from django.utils.module_loading import import_lock, module_has_submodule from django.utils._os import upath -from django.utils import six from .base import AppConfig @@ -39,6 +38,11 @@ class AppCache(object): # get_model[s]. self.master = master + # Mapping of app labels => model names => model classes. Used to + # register models before the app cache is populated and also for + # applications that aren't installed. + self.all_models = defaultdict(OrderedDict) + # Mapping of labels to AppConfig instances for installed apps. self.app_configs = OrderedDict() @@ -118,10 +122,7 @@ class AppCache(object): app_config = AppConfig( name=app_name, app_module=app_module, models_module=models_module) - # If a stub config existed for this app, preserve models registry. - old_app_config = self.app_configs.get(app_config.label) - if old_app_config is not None: - app_config.models = old_app_config.models + app_config.models = self.all_models[app_config.label] self.app_configs[app_config.label] = app_config return models_module @@ -145,6 +146,8 @@ class AppCache(object): If only_with_models_module in True (non-default), only applications containing a models module are considered. """ + if not only_installed: + raise ValueError("only_installed=False isn't supported any more.") self.populate() for app_config in self.app_configs.values(): if only_installed and not app_config.installed: @@ -170,6 +173,8 @@ class AppCache(object): If only_with_models_module in True (non-default), only applications containing a models module are considered. """ + if not only_installed: + raise ValueError("only_installed=False isn't supported any more.") self.populate() app_config = self.app_configs.get(app_label) if app_config is None: @@ -223,20 +228,22 @@ class AppCache(object): self.populate() if app_mod: app_label = app_mod.__name__.split('.')[-2] - try: - app_config = self.app_configs[app_label] - except KeyError: - app_list = [] - else: - app_list = [app_config] if app_config.installed else [] - else: - app_list = six.itervalues(self.app_configs) if only_installed: - app_list = (app for app in app_list if app.installed) + try: + model_dicts = [self.app_configs[app_label].models] + except KeyError: + model_dicts = [] + else: + model_dicts = [self.all_models[app_label]] + else: + if only_installed: + model_dicts = [app_config.models for app_config in self.app_configs.values()] + else: + model_dicts = self.all_models.values() model_list = [] - for app in app_list: + for model_dict in model_dicts: model_list.extend( - model for model in app.models.values() + model for model in model_dict.values() if ((not model._deferred or include_deferred) and (not model._meta.auto_created or include_auto_created) and (not model._meta.swapped or include_swapped)) @@ -249,8 +256,7 @@ class AppCache(object): ] return model_list - def get_model(self, app_label, model_name, - seed_cache=True, only_installed=True): + def get_model(self, app_label, model_name, only_installed=True): """ Returns the model matching the given app_label and case-insensitive model_name. @@ -262,43 +268,45 @@ class AppCache(object): """ if not self.master: only_installed = False - if seed_cache: - self.populate() + self.populate() if only_installed: app_config = self.app_configs.get(app_label) - if app_config is not None and not app_config.installed: + if app_config is None or not app_config.installed: return None if (self.available_apps is not None and app_config.name not in self.available_apps): raise UnavailableApp("App with label %s isn't available." % app_label) - try: - return self.app_configs[app_label].models[model_name.lower()] - except KeyError: - return None + return self.all_models[app_label].get(model_name.lower()) def register_model(self, app_label, model): - try: - app_config = self.app_configs[app_label] - except KeyError: - app_config = AppConfig._stub(app_label) - self.app_configs[app_label] = app_config - # Add the model to the app_config's models dictionary. + # Since this method is called when models are imported, it cannot + # perform imports because of the risk of import loops. It mustn't + # call get_app_config(). model_name = model._meta.model_name - model_dict = app_config.models - if model_name in model_dict: + models = self.all_models[app_label] + if model_name in models: # The same model may be imported via different paths (e.g. # appname.models and project.appname.models). We use the source # filename as a means to detect identity. fname1 = os.path.abspath(upath(sys.modules[model.__module__].__file__)) - fname2 = os.path.abspath(upath(sys.modules[model_dict[model_name].__module__].__file__)) + fname2 = os.path.abspath(upath(sys.modules[models[model_name].__module__].__file__)) # Since the filename extension could be .py the first time and # .pyc or .pyo the second time, ignore the extension when # comparing. if os.path.splitext(fname1)[0] == os.path.splitext(fname2)[0]: return - model_dict[model_name] = model + models[model_name] = model self._get_models_cache.clear() + def registered_model(self, app_label, model_name): + """ + Test if a model is registered and return the model class or None. + + It's safe to call this method at import time, even while the app cache + is being populated. + """ + return self.all_models[app_label].get(model_name.lower()) + def set_available_apps(self, available): available = set(available) installed = set(settings.INSTALLED_APPS) diff --git a/django/db/models/base.py b/django/db/models/base.py index 56973d4e38..a694350b97 100644 --- a/django/db/models/base.py +++ b/django/db/models/base.py @@ -151,8 +151,7 @@ class ModelBase(type): new_class._base_manager = new_class._base_manager._copy_to_model(new_class) # Bail out early if we have already created this class. - m = new_class._meta.app_cache.get_model(new_class._meta.app_label, name, - seed_cache=False, only_installed=False) + m = new_class._meta.app_cache.registered_model(new_class._meta.app_label, name) if m is not None: return m @@ -279,8 +278,7 @@ class ModelBase(type): # the first time this model tries to register with the framework. There # should only be one class for each model, so we always return the # registered version. - return new_class._meta.app_cache.get_model(new_class._meta.app_label, name, - seed_cache=False, only_installed=False) + return new_class._meta.app_cache.registered_model(new_class._meta.app_label, name) def copy_managers(cls, base_managers): # This is in-place sorting of an Options attribute, but that's fine. diff --git a/django/db/models/fields/related.py b/django/db/models/fields/related.py index 3eb6799a5f..1b141af099 100644 --- a/django/db/models/fields/related.py +++ b/django/db/models/fields/related.py @@ -68,8 +68,7 @@ def add_lazy_relation(cls, field, relation, operation): # string right away. If get_model returns None, it means that the related # model isn't loaded yet, so we need to pend the relation until the class # is prepared. - model = cls._meta.app_cache.get_model(app_label, model_name, - seed_cache=False, only_installed=False) + model = cls._meta.app_cache.registered_model(app_label, model_name) if model: operation(field, model, cls) else: diff --git a/tests/app_loading/tests.py b/tests/app_loading/tests.py index b32f510a24..e282306ec0 100644 --- a/tests/app_loading/tests.py +++ b/tests/app_loading/tests.py @@ -22,6 +22,7 @@ class EggLoadingTest(TestCase): def tearDown(self): app_cache.app_configs['app_loading'].models = self._old_models + app_cache.all_models['app_loading'] = self._old_models app_cache._get_models_cache = {} sys.path = self.old_path @@ -80,9 +81,9 @@ class EggLoadingTest(TestCase): app_cache.master = True with override_settings(INSTALLED_APPS=('notexists',)): with self.assertRaises(ImportError): - app_cache.get_model('notexists', 'nomodel', seed_cache=True) + app_cache.get_model('notexists', 'nomodel') with self.assertRaises(ImportError): - app_cache.get_model('notexists', 'nomodel', seed_cache=True) + app_cache.get_model('notexists', 'nomodel') class GetModelsTest(TestCase): @@ -101,17 +102,17 @@ class GetModelsTest(TestCase): self.not_installed_module.NotInstalledModel) def test_get_models_only_returns_installed_models(self): - self.assertFalse( - "NotInstalledModel" in + self.assertNotIn( + "NotInstalledModel", [m.__name__ for m in app_cache.get_models()]) def test_get_models_with_app_label_only_returns_installed_models(self): self.assertEqual(app_cache.get_models(self.not_installed_module), []) def test_get_models_with_not_installed(self): - self.assertTrue( - "NotInstalledModel" in [ - m.__name__ for m in app_cache.get_models(only_installed=False)]) + self.assertIn( + "NotInstalledModel", + [m.__name__ for m in app_cache.get_models(only_installed=False)]) class NotInstalledModelsTest(TestCase): diff --git a/tests/invalid_models/tests.py b/tests/invalid_models/tests.py index 712484c611..10d8fa47a7 100644 --- a/tests/invalid_models/tests.py +++ b/tests/invalid_models/tests.py @@ -24,6 +24,7 @@ class InvalidModelTestCase(unittest.TestCase): def tearDown(self): app_cache.app_configs['invalid_models'].models = self._old_models + app_cache.all_models['invalid_models'] = self._old_models app_cache._get_models_cache = {} sys.stdout = self.old_stdout diff --git a/tests/managers_regress/tests.py b/tests/managers_regress/tests.py index f2897862ec..b9c8244612 100644 --- a/tests/managers_regress/tests.py +++ b/tests/managers_regress/tests.py @@ -128,6 +128,7 @@ class ManagersRegressionTests(TestCase): finally: app_cache.app_configs['managers_regress'].models = _old_models + app_cache.all_models['managers_regress'] = _old_models app_cache._get_models_cache = {} @override_settings(TEST_SWAPPABLE_MODEL='managers_regress.Parent') @@ -155,6 +156,7 @@ class ManagersRegressionTests(TestCase): finally: app_cache.app_configs['managers_regress'].models = _old_models + app_cache.all_models['managers_regress'] = _old_models app_cache._get_models_cache = {} @override_settings(TEST_SWAPPABLE_MODEL='managers_regress.Parent') @@ -182,6 +184,7 @@ class ManagersRegressionTests(TestCase): finally: app_cache.app_configs['managers_regress'].models = _old_models + app_cache.all_models['managers_regress'] = _old_models app_cache._get_models_cache = {} def test_regress_3871(self): diff --git a/tests/migrations/test_commands.py b/tests/migrations/test_commands.py index 59cd56e78b..13514cac91 100644 --- a/tests/migrations/test_commands.py +++ b/tests/migrations/test_commands.py @@ -135,6 +135,7 @@ class MakeMigrationsTests(MigrationTestBase): def tearDown(self): app_cache.app_configs['migrations'].models = self._old_models + app_cache.all_models['migrations'] = self._old_models app_cache._get_models_cache = {} os.chdir(self.test_dir) diff --git a/tests/proxy_model_inheritance/tests.py b/tests/proxy_model_inheritance/tests.py index 861ab4af17..601fdc5b42 100644 --- a/tests/proxy_model_inheritance/tests.py +++ b/tests/proxy_model_inheritance/tests.py @@ -34,6 +34,8 @@ class ProxyModelInheritanceTests(TransactionTestCase): sys.path = self.old_sys_path del app_cache.app_configs['app1'] del app_cache.app_configs['app2'] + del app_cache.all_models['app1'] + del app_cache.all_models['app2'] def test_table_exists(self): try: diff --git a/tests/proxy_models/tests.py b/tests/proxy_models/tests.py index 3389f3597f..0995a778c0 100644 --- a/tests/proxy_models/tests.py +++ b/tests/proxy_models/tests.py @@ -175,6 +175,7 @@ class ProxyModelTests(TestCase): proxy = True finally: app_cache.app_configs['proxy_models'].models = _old_models + app_cache.all_models['proxy_models'] = _old_models app_cache._get_models_cache = {} def test_myperson_manager(self): diff --git a/tests/tablespaces/tests.py b/tests/tablespaces/tests.py index 4a62ad5a45..fa90704c45 100644 --- a/tests/tablespaces/tests.py +++ b/tests/tablespaces/tests.py @@ -36,6 +36,7 @@ class TablespacesTests(TestCase): model._meta.managed = False app_cache.app_configs['tablespaces'].models = self._old_models + app_cache.all_models['tablespaces'] = self._old_models app_cache._get_models_cache = {} def assertNumContains(self, haystack, needle, count): From 972babc3b45971a69a6b2a49fc498d92db674cae Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 18 Dec 2013 13:10:23 +0100 Subject: [PATCH 005/208] Removed the only_installed argument of get_app_config[s]. It wasn't used anywhere and couldn't be implemented any more since non-installed apps no longer have a configuration. --- django/core/apps/cache.py | 20 +++----------------- tests/admin_scripts/tests.py | 16 ++++++++-------- 2 files changed, 11 insertions(+), 25 deletions(-) diff --git a/django/core/apps/cache.py b/django/core/apps/cache.py index deffc84586..69f2f2c974 100644 --- a/django/core/apps/cache.py +++ b/django/core/apps/cache.py @@ -136,29 +136,22 @@ class AppCache(object): """ return self.loaded - def get_app_configs(self, only_installed=True, only_with_models_module=False): + def get_app_configs(self, only_with_models_module=False): """ Return an iterable of application configurations. - If only_installed is True (default), only applications explicitly - listed in INSTALLED_APPS are considered. - If only_with_models_module in True (non-default), only applications containing a models module are considered. """ - if not only_installed: - raise ValueError("only_installed=False isn't supported any more.") self.populate() for app_config in self.app_configs.values(): - if only_installed and not app_config.installed: - continue if only_with_models_module and app_config.models_module is None: continue if self.available_apps is not None and app_config.name not in self.available_apps: continue yield app_config - def get_app_config(self, app_label, only_installed=True, only_with_models_module=False): + def get_app_config(self, app_label, only_with_models_module=False): """ Returns the application configuration for the given app_label. @@ -167,20 +160,13 @@ class AppCache(object): Raises UnavailableApp when set_available_apps() disables the application with this app_label. - If only_installed is True (default), only applications explicitly - listed in INSTALLED_APPS are considered. - If only_with_models_module in True (non-default), only applications containing a models module are considered. """ - if not only_installed: - raise ValueError("only_installed=False isn't supported any more.") self.populate() app_config = self.app_configs.get(app_label) if app_config is None: - raise LookupError("No app with label %r." % app_label) - if only_installed and not app_config.installed: - raise LookupError("App with label %r isn't in INSTALLED_APPS." % app_label) + raise LookupError("No installed app with label %r." % app_label) if only_with_models_module and app_config.models_module is None: raise LookupError("App with label %r doesn't have a models module." % app_label) if self.available_apps is not None and app_config.name not in self.available_apps: diff --git a/tests/admin_scripts/tests.py b/tests/admin_scripts/tests.py index 8f693bfd34..db0b8d6030 100644 --- a/tests/admin_scripts/tests.py +++ b/tests/admin_scripts/tests.py @@ -379,14 +379,14 @@ class DjangoAdminMinimalSettings(AdminScriptTestCase): args = ['sqlall', '--settings=test_project.settings', 'admin_scripts'] out, err = self.run_django_admin(args) self.assertNoOutput(out) - self.assertOutput(err, "No app with label 'admin_scripts'.") + self.assertOutput(err, "No installed app with label 'admin_scripts'.") def test_builtin_with_environment(self): "minimal: django-admin builtin commands fail if settings are provided in the environment" args = ['sqlall', 'admin_scripts'] out, err = self.run_django_admin(args, 'test_project.settings') self.assertNoOutput(out) - self.assertOutput(err, "No app with label 'admin_scripts'.") + self.assertOutput(err, "No installed app with label 'admin_scripts'.") def test_builtin_with_bad_settings(self): "minimal: django-admin builtin commands fail if settings file (from argument) doesn't exist" @@ -815,21 +815,21 @@ class ManageMinimalSettings(AdminScriptTestCase): args = ['sqlall', 'admin_scripts'] out, err = self.run_manage(args) self.assertNoOutput(out) - self.assertOutput(err, "No app with label 'admin_scripts'.") + self.assertOutput(err, "No installed app with label 'admin_scripts'.") def test_builtin_with_settings(self): "minimal: manage.py builtin commands fail if settings are provided as argument" args = ['sqlall', '--settings=test_project.settings', 'admin_scripts'] out, err = self.run_manage(args) self.assertNoOutput(out) - self.assertOutput(err, "No app with label 'admin_scripts'.") + self.assertOutput(err, "No installed app with label 'admin_scripts'.") def test_builtin_with_environment(self): "minimal: manage.py builtin commands fail if settings are provided in the environment" args = ['sqlall', 'admin_scripts'] out, err = self.run_manage(args, 'test_project.settings') self.assertNoOutput(out) - self.assertOutput(err, "No app with label 'admin_scripts'.") + self.assertOutput(err, "No installed app with label 'admin_scripts'.") def test_builtin_with_bad_settings(self): "minimal: manage.py builtin commands fail if settings file (from argument) doesn't exist" @@ -964,7 +964,7 @@ class ManageMultipleSettings(AdminScriptTestCase): args = ['sqlall', 'admin_scripts'] out, err = self.run_manage(args) self.assertNoOutput(out) - self.assertOutput(err, "No app with label 'admin_scripts'.") + self.assertOutput(err, "No installed app with label 'admin_scripts'.") def test_builtin_with_settings(self): "multiple: manage.py builtin commands succeed if settings are provided as argument" @@ -1442,13 +1442,13 @@ class CommandTypes(AdminScriptTestCase): "User AppCommands can execute when a single app name is provided" args = ['app_command', 'NOT_AN_APP'] out, err = self.run_manage(args) - self.assertOutput(err, "No app with label 'NOT_AN_APP'.") + self.assertOutput(err, "No installed app with label 'NOT_AN_APP'.") def test_app_command_some_invalid_appnames(self): "User AppCommands can execute when some of the provided app names are invalid" args = ['app_command', 'auth', 'NOT_AN_APP'] out, err = self.run_manage(args) - self.assertOutput(err, "No app with label 'NOT_AN_APP'.") + self.assertOutput(err, "No installed app with label 'NOT_AN_APP'.") def test_label_command(self): "User LabelCommands can execute when a label is provided" From 9b3389b7268e48c16ed79256e516af787ad652df Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 18 Dec 2013 13:16:33 +0100 Subject: [PATCH 006/208] Removed the app_config.installed flag. Since applications that aren't installed no longer have an application configuration, it is now always True in practice. Provided an abstraction to temporarily add or remove applications as several tests messed with app_config.installed to achieve this effect. For now this API is _-prefixed because it looks dangerous. --- django/contrib/contenttypes/tests.py | 23 ++++--- django/contrib/gis/tests/geoapp/test_feeds.py | 6 +- .../contrib/gis/tests/geoapp/test_sitemaps.py | 6 +- django/contrib/sitemaps/tests/base.py | 4 -- django/contrib/sitemaps/tests/test_http.py | 15 +++-- django/contrib/sites/tests.py | 14 ++--- django/core/apps/base.py | 6 +- django/core/apps/cache.py | 63 ++++++++++++++++++- django/db/models/options.py | 4 +- tests/admin_docs/tests.py | 18 ++---- 10 files changed, 99 insertions(+), 60 deletions(-) diff --git a/django/contrib/contenttypes/tests.py b/django/contrib/contenttypes/tests.py index 756430f393..b194755b80 100644 --- a/django/contrib/contenttypes/tests.py +++ b/django/contrib/contenttypes/tests.py @@ -1,9 +1,10 @@ from __future__ import unicode_literals -from django.db import models from django.contrib.contenttypes.models import ContentType from django.contrib.contenttypes.views import shortcut -from django.contrib.sites.models import Site, get_current_site +from django.contrib.sites.models import get_current_site +from django.core.apps import app_cache +from django.db import models from django.http import HttpRequest, Http404 from django.test import TestCase from django.test.utils import override_settings @@ -54,11 +55,9 @@ class FooWithBrokenAbsoluteUrl(FooWithoutUrl): class ContentTypesTests(TestCase): def setUp(self): - self._old_installed = Site._meta.app_config.installed ContentType.objects.clear_cache() def tearDown(self): - Site._meta.app_config.installed = self._old_installed ContentType.objects.clear_cache() def test_lookup_cache(self): @@ -223,15 +222,15 @@ class ContentTypesTests(TestCase): user_ct = ContentType.objects.get_for_model(FooWithUrl) obj = FooWithUrl.objects.create(name="john") - Site._meta.app_config.installed = True - response = shortcut(request, user_ct.id, obj.id) - self.assertEqual("http://%s/users/john/" % get_current_site(request).domain, - response._headers.get("location")[1]) + with app_cache._with_app('django.contrib.sites'): + response = shortcut(request, user_ct.id, obj.id) + self.assertEqual("http://%s/users/john/" % get_current_site(request).domain, + response._headers.get("location")[1]) - Site._meta.app_config.installed = False - response = shortcut(request, user_ct.id, obj.id) - self.assertEqual("http://Example.com/users/john/", - response._headers.get("location")[1]) + with app_cache._without_app('django.contrib.sites'): + response = shortcut(request, user_ct.id, obj.id) + self.assertEqual("http://Example.com/users/john/", + response._headers.get("location")[1]) def test_shortcut_view_without_get_absolute_url(self): """ diff --git a/django/contrib/gis/tests/geoapp/test_feeds.py b/django/contrib/gis/tests/geoapp/test_feeds.py index 0817e65cb4..6f0d901a62 100644 --- a/django/contrib/gis/tests/geoapp/test_feeds.py +++ b/django/contrib/gis/tests/geoapp/test_feeds.py @@ -7,6 +7,7 @@ from django.conf import settings from django.contrib.sites.models import Site from django.contrib.gis.geos import HAS_GEOS from django.contrib.gis.tests.utils import HAS_SPATIAL_DB +from django.core.apps import app_cache from django.test import TestCase if HAS_GEOS: @@ -20,11 +21,10 @@ class GeoFeedTest(TestCase): def setUp(self): Site(id=settings.SITE_ID, domain="example.com", name="example.com").save() - self._old_installed = Site._meta.app_config.installed - Site._meta.app_config.installed = True + self._with_sites = app_cache._begin_with_app('django.contrib.sites') def tearDown(self): - Site._meta.app_config.installed = self._old_installed + app_cache._end_with_app(self._with_sites) def assertChildNodes(self, elem, expected): "Taken from syndication/tests.py." diff --git a/django/contrib/gis/tests/geoapp/test_sitemaps.py b/django/contrib/gis/tests/geoapp/test_sitemaps.py index ee9974ceaa..035d97af34 100644 --- a/django/contrib/gis/tests/geoapp/test_sitemaps.py +++ b/django/contrib/gis/tests/geoapp/test_sitemaps.py @@ -10,6 +10,7 @@ from django.conf import settings from django.contrib.gis.geos import HAS_GEOS from django.contrib.gis.tests.utils import HAS_SPATIAL_DB from django.contrib.sites.models import Site +from django.core.apps import app_cache from django.test import TestCase from django.test.utils import IgnoreDeprecationWarningsMixin from django.utils._os import upath @@ -26,11 +27,10 @@ class GeoSitemapTest(IgnoreDeprecationWarningsMixin, TestCase): def setUp(self): super(GeoSitemapTest, self).setUp() Site(id=settings.SITE_ID, domain="example.com", name="example.com").save() - self._old_installed = Site._meta.app_config.installed - Site._meta.app_config.installed = True + self._with_sites = app_cache._begin_with_app('django.contrib.sites') def tearDown(self): - Site._meta.app_config.installed = self._old_installed + app_cache._end_with_app(self._with_sites) super(GeoSitemapTest, self).tearDown() def assertChildNodes(self, elem, expected): diff --git a/django/contrib/sitemaps/tests/base.py b/django/contrib/sitemaps/tests/base.py index 98abb3dca4..ecddcc737b 100644 --- a/django/contrib/sitemaps/tests/base.py +++ b/django/contrib/sitemaps/tests/base.py @@ -25,10 +25,6 @@ class SitemapTestsBase(TestCase): def setUp(self): self.base_url = '%s://%s' % (self.protocol, self.domain) - self._old_installed = Site._meta.app_config.installed cache.clear() # Create an object for sitemap content. TestModel.objects.create(name='Test Object') - - def tearDown(self): - Site._meta.app_config.installed = self._old_installed diff --git a/django/contrib/sitemaps/tests/test_http.py b/django/contrib/sitemaps/tests/test_http.py index 61be8c842a..ed61c9950b 100644 --- a/django/contrib/sitemaps/tests/test_http.py +++ b/django/contrib/sitemaps/tests/test_http.py @@ -7,6 +7,7 @@ from unittest import skipUnless from django.conf import settings from django.contrib.sitemaps import Sitemap, GenericSitemap from django.contrib.sites.models import Site +from django.core.apps import app_cache from django.core.exceptions import ImproperlyConfigured from django.test.utils import override_settings from django.utils.formats import localize @@ -108,15 +109,14 @@ class HTTPSitemapTests(SitemapTestsBase): def test_requestsite_sitemap(self): # Make sure hitting the flatpages sitemap without the sites framework # installed doesn't raise an exception. - # Reset by SitemapTestsBase.tearDown(). - Site._meta.app_config.installed = False - response = self.client.get('/simple/sitemap.xml') - expected_content = """ + with app_cache._without_app('django.contrib.sites'): + response = self.client.get('/simple/sitemap.xml') + expected_content = """ http://testserver/location/%snever0.5 """ % date.today() - self.assertXMLEqual(response.content.decode('utf-8'), expected_content) + self.assertXMLEqual(response.content.decode('utf-8'), expected_content) @skipUnless("django.contrib.sites" in settings.INSTALLED_APPS, "django.contrib.sites app not installed.") @@ -134,9 +134,8 @@ class HTTPSitemapTests(SitemapTestsBase): Sitemap.get_urls if Site objects exists, but the sites framework is not actually installed. """ - # Reset by SitemapTestsBase.tearDown(). - Site._meta.app_config.installed = False - self.assertRaises(ImproperlyConfigured, Sitemap().get_urls) + with app_cache._without_app('django.contrib.sites'): + self.assertRaises(ImproperlyConfigured, Sitemap().get_urls) def test_sitemap_item(self): """ diff --git a/django/contrib/sites/tests.py b/django/contrib/sites/tests.py index 2be28a1429..8d76fd0d02 100644 --- a/django/contrib/sites/tests.py +++ b/django/contrib/sites/tests.py @@ -2,6 +2,7 @@ from __future__ import unicode_literals from django.conf import settings from django.contrib.sites.models import Site, RequestSite, get_current_site +from django.core.apps import app_cache from django.core.exceptions import ObjectDoesNotExist, ValidationError from django.http import HttpRequest from django.test import TestCase @@ -12,11 +13,10 @@ class SitesFrameworkTests(TestCase): def setUp(self): Site(id=settings.SITE_ID, domain="example.com", name="example.com").save() - self._old_installed = Site._meta.app_config.installed - Site._meta.app_config.installed = True + self._with_sites = app_cache._begin_with_app('django.contrib.sites') def tearDown(self): - Site._meta.app_config.installed = self._old_installed + app_cache._end_with_app(self._with_sites) def test_save_another(self): # Regression for #17415 @@ -67,10 +67,10 @@ class SitesFrameworkTests(TestCase): self.assertRaises(ObjectDoesNotExist, get_current_site, request) # A RequestSite is returned if the sites framework is not installed - Site._meta.app_config.installed = False - site = get_current_site(request) - self.assertTrue(isinstance(site, RequestSite)) - self.assertEqual(site.name, "example.com") + with app_cache._without_app('django.contrib.sites'): + site = get_current_site(request) + self.assertTrue(isinstance(site, RequestSite)) + self.assertEqual(site.name, "example.com") def test_domain_name_with_whitespaces(self): # Regression for #17320 diff --git a/django/core/apps/base.py b/django/core/apps/base.py index 5991029c09..332a066bcb 100644 --- a/django/core/apps/base.py +++ b/django/core/apps/base.py @@ -30,14 +30,10 @@ class AppConfig(object): # Populated by calls to AppCache.register_model(). self.models = OrderedDict() - # Whether the app is in INSTALLED_APPS or was automatically created - # when one of its models was imported. - self.installed = app_module is not None - # Filesystem path to the application directory eg. # u'/usr/lib/python2.7/dist-packages/django/contrib/admin'. # This is a unicode object on Python 2 and a str on Python 3. - self.path = upath(app_module.__path__[0]) if app_module is not None else None + self.path = upath(app_module.__path__[0]) def __repr__(self): return '' % self.label diff --git a/django/core/apps/cache.py b/django/core/apps/cache.py index 69f2f2c974..fb7bb6172e 100644 --- a/django/core/apps/cache.py +++ b/django/core/apps/cache.py @@ -1,6 +1,7 @@ "Utilities for loading models and the modules that contain them." from collections import defaultdict, OrderedDict +from contextlib import contextmanager from importlib import import_module import os import sys @@ -120,8 +121,7 @@ class AppCache(object): finally: self.nesting_level -= 1 - app_config = AppConfig( - name=app_name, app_module=app_module, models_module=models_module) + app_config = AppConfig(app_name, app_module, models_module) app_config.models = self.all_models[app_config.label] self.app_configs[app_config.label] = app_config @@ -257,7 +257,7 @@ class AppCache(object): self.populate() if only_installed: app_config = self.app_configs.get(app_label) - if app_config is None or not app_config.installed: + if app_config is None: return None if (self.available_apps is not None and app_config.name not in self.available_apps): @@ -304,6 +304,63 @@ class AppCache(object): def unset_available_apps(self): self.available_apps = None + ### DANGEROUS METHODS ### (only used to preserve existing tests) + + def _begin_with_app(self, app_name): + # Returns an opaque value that can be passed to _end_with_app(). + app_module = import_module(app_name) + models_module = import_module('%s.models' % app_name) + app_config = AppConfig(app_name, app_module, models_module) + if app_config.label in self.app_configs: + return None + else: + app_config.models = self.all_models[app_config.label] + self.app_configs[app_config.label] = app_config + return app_config + + def _end_with_app(self, app_config): + if app_config is not None: + del self.app_configs[app_config.label] + + @contextmanager + def _with_app(self, app_name): + app_config = self._begin_with_app(app_name) + try: + yield + finally: + self._end_with_app(app_config) + + def _begin_without_app(self, app_name): + # Returns an opaque value that can be passed to _end_without_app(). + return self.app_configs.pop(app_name.rpartition(".")[2], None) + + def _end_without_app(self, app_config): + if app_config is not None: + self.app_configs[app_config.label] = app_config + + @contextmanager + def _without_app(self, app_name): + app_config = self._begin_without_app(app_name) + try: + yield + finally: + self._end_without_app(app_config) + + def _begin_empty(self): + app_configs, self.app_configs = self.app_configs, OrderedDict() + return app_configs + + def _end_empty(self, app_configs): + self.app_configs = app_configs + + @contextmanager + def _empty(self): + app_configs = self._begin_empty() + try: + yield + finally: + self._end_empty(app_configs) + ### DEPRECATED METHODS GO BELOW THIS LINE ### def get_app(self, app_label): diff --git a/django/db/models/options.py b/django/db/models/options.py index cd68d5eae9..f7be089539 100644 --- a/django/db/models/options.py +++ b/django/db/models/options.py @@ -94,11 +94,11 @@ class Options(object): @property def app_config(self): # Don't go through get_app_config to avoid triggering populate(). - return self.app_cache.app_configs[self.app_label] + return self.app_cache.app_configs.get(self.app_label) @property def installed(self): - return self.app_config.installed + return self.app_config is not None def contribute_to_class(self, cls, name): from django.db import connection diff --git a/tests/admin_docs/tests.py b/tests/admin_docs/tests.py index 047bf920a2..66c125490f 100644 --- a/tests/admin_docs/tests.py +++ b/tests/admin_docs/tests.py @@ -4,6 +4,7 @@ from django.conf import settings from django.contrib.sites.models import Site from django.contrib.admindocs import utils from django.contrib.auth.models import User +from django.core.apps import app_cache from django.core.urlresolvers import reverse from django.test import TestCase from django.test.utils import override_settings @@ -13,27 +14,18 @@ class MiscTests(TestCase): urls = 'admin_docs.urls' def setUp(self): - self._old_installed = Site._meta.app_config.installed User.objects.create_superuser('super', None, 'secret') self.client.login(username='super', password='secret') - def tearDown(self): - Site._meta.app_config.installed = self._old_installed - - @override_settings( - SITE_ID=None, - INSTALLED_APPS=[app for app in settings.INSTALLED_APPS - if app != 'django.contrib.sites'], - ) def test_no_sites_framework(self): """ Without the sites framework, should not access SITE_ID or Site objects. Deleting settings is fine here as UserSettingsHolder is used. """ - Site._meta.app_config.installed = False - Site.objects.all().delete() - del settings.SITE_ID - self.client.get('/admindocs/views/') # should not raise + with self.settings(SITE_ID=None), app_cache._without_app('django.contrib.sites'): + Site.objects.all().delete() + del settings.SITE_ID + self.client.get('/admindocs/views/') # should not raise @override_settings(PASSWORD_HASHERS=('django.contrib.auth.hashers.SHA1PasswordHasher',)) From 2b56d6910269ace19e3007d2b4a3445f7886314f Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 18 Dec 2013 11:28:21 +0100 Subject: [PATCH 007/208] Implemented two-stage app-cache population. First stage imports app modules. It doesn't catch import errors. This matches the previous behavior and keeps the code simple. Second stage import models modules. It catches import errors and retries them after walking through the entire list once. This matches the previous behavior and seems useful. populate_models() is intended to be equivalent to populate(). It isn't wired yet. That is coming in the next commit. --- django/core/apps/base.py | 38 ++++++++++----- django/core/apps/cache.py | 95 ++++++++++++++++++++++++++++++++++---- tests/test_runner/tests.py | 16 +++---- 3 files changed, 117 insertions(+), 32 deletions(-) diff --git a/django/core/apps/base.py b/django/core/apps/base.py index 332a066bcb..83c073a12a 100644 --- a/django/core/apps/base.py +++ b/django/core/apps/base.py @@ -1,39 +1,53 @@ -from collections import OrderedDict +from importlib import import_module +from django.utils.module_loading import module_has_submodule from django.utils._os import upath +MODELS_MODULE_NAME = 'models' + + class AppConfig(object): """ Class representing a Django application and its configuration. """ - def __init__(self, name, app_module, models_module): + def __init__(self, app_name): # Full Python path to the application eg. 'django.contrib.admin'. # This is the value that appears in INSTALLED_APPS. - self.name = name + self.name = app_name # Last component of the Python path to the application eg. 'admin'. # This value must be unique across a Django project. - self.label = name.rpartition(".")[2] + self.label = app_name.rpartition(".")[2] # Root module eg. . - self.app_module = app_module + self.app_module = import_module(app_name) # Module containing models eg. . None if the application - # doesn't have a models module. - self.models_module = models_module + # from 'django/contrib/admin/models.pyc'>. Set by import_models(). + # None if the application doesn't have a models module. + self.models_module = None - # Mapping of lower case model names to model classes. - # Populated by calls to AppCache.register_model(). - self.models = OrderedDict() + # Mapping of lower case model names to model classes. Initally set to + # None to prevent accidental access before import_models() runs. + self.models = None # Filesystem path to the application directory eg. # u'/usr/lib/python2.7/dist-packages/django/contrib/admin'. # This is a unicode object on Python 2 and a str on Python 3. - self.path = upath(app_module.__path__[0]) + self.path = upath(self.app_module.__path__[0]) def __repr__(self): return '' % self.label + + def import_models(self, all_models): + # Dictionary of models for this app, stored in the 'all_models' + # attribute of the AppCache this AppConfig is attached to. Injected as + # a parameter because it may get populated before this method has run. + self.models = all_models + + if module_has_submodule(self.app_module, MODELS_MODULE_NAME): + models_module_name = '%s.%s' % (self.name, MODELS_MODULE_NAME) + self.models_module = import_module(models_module_name) diff --git a/django/core/apps/cache.py b/django/core/apps/cache.py index fb7bb6172e..cf2489185e 100644 --- a/django/core/apps/cache.py +++ b/django/core/apps/cache.py @@ -12,10 +12,7 @@ from django.core.exceptions import ImproperlyConfigured from django.utils.module_loading import import_lock, module_has_submodule from django.utils._os import upath -from .base import AppConfig - - -MODELS_MODULE_NAME = 'models' +from .base import AppConfig, MODELS_MODULE_NAME class UnavailableApp(Exception): @@ -54,6 +51,10 @@ class AppCache(object): # Used by TransactionTestCase.available_apps for performance reasons. self.available_apps = None + # Internal flags used when populating the cache. + self._apps_loaded = False + self._models_loaded = False + # -- Everything below here is only used when populating the cache -- self.loaded = False self.handled = set() @@ -61,6 +62,82 @@ class AppCache(object): self.nesting_level = 0 self._get_models_cache = {} + def populate_apps(self): + """ + Populate app-related information. + + This method imports each application module. + + It is thread safe and idempotent, but not reentrant. + """ + if self._apps_loaded: + return + # Since populate_apps() may be a side effect of imports, and since + # it will itself import modules, an ABBA deadlock between threads + # would be possible if we didn't take the import lock. See #18251. + with import_lock(): + if self._apps_loaded: + return + + # app_config should be pristine, otherwise the code below won't + # guarantee that the order matches the order in INSTALLED_APPS. + if self.app_configs: + raise RuntimeError("populate_apps() isn't reentrant") + + # Application modules aren't expected to import anything, and + # especially not other application modules, even indirectly. + # Therefore we simply import them sequentially. + for app_name in settings.INSTALLED_APPS: + app_config = AppConfig(app_name) + self.app_configs[app_config.label] = app_config + + self._apps_loaded = True + + def populate_models(self): + """ + Populate model-related information. + + This method imports each models module. + + It is thread safe, idempotent and reentrant. + """ + if self._models_loaded: + return + # Since populate_models() may be a side effect of imports, and since + # it will itself import modules, an ABBA deadlock between threads + # would be possible if we didn't take the import lock. See #18251. + with import_lock(): + if self._models_loaded: + return + + self.populate_apps() + + # Models modules are likely to import other models modules, for + # example to reference related objects. As a consequence: + # - we deal with import loops by postponing affected modules. + # - we provide reentrancy by making import_models() idempotent. + + outermost = not hasattr(self, '_postponed') + if outermost: + self._postponed = [] + + for app_config in self.app_configs.values(): + + try: + all_models = self.all_models[app_config.label] + app_config.import_models(all_models) + except ImportError: + self._postponed.append(app_config) + + if outermost: + for app_config in self._postponed: + all_models = self.all_models[app_config.label] + app_config.import_models(all_models) + + del self._postponed + + self._models_loaded = True + def populate(self): """ Fill in all the cache information. This method is threadsafe, in the @@ -121,8 +198,8 @@ class AppCache(object): finally: self.nesting_level -= 1 - app_config = AppConfig(app_name, app_module, models_module) - app_config.models = self.all_models[app_config.label] + app_config = AppConfig(app_name) + app_config.import_models(self.all_models[app_config.label]) self.app_configs[app_config.label] = app_config return models_module @@ -308,13 +385,11 @@ class AppCache(object): def _begin_with_app(self, app_name): # Returns an opaque value that can be passed to _end_with_app(). - app_module = import_module(app_name) - models_module = import_module('%s.models' % app_name) - app_config = AppConfig(app_name, app_module, models_module) + app_config = AppConfig(app_name) if app_config.label in self.app_configs: return None else: - app_config.models = self.all_models[app_config.label] + app_config.import_models(self.all_models[app_config.label]) self.app_configs[app_config.label] = app_config return app_config diff --git a/tests/test_runner/tests.py b/tests/test_runner/tests.py index 04fa3b8784..a6dbeb0ae4 100644 --- a/tests/test_runner/tests.py +++ b/tests/test_runner/tests.py @@ -3,7 +3,6 @@ Tests for django test runner """ from __future__ import unicode_literals -from importlib import import_module from optparse import make_option import types import unittest @@ -227,10 +226,8 @@ class ModulesTestsPackages(IgnoreAllDeprecationWarningsMixin, unittest.TestCase) "Check that the get_tests helper function can find tests in a directory" from django.core.apps.base import AppConfig from django.test.simple import get_tests - app_config = AppConfig( - 'test_runner.valid_app', - import_module('test_runner.valid_app'), - import_module('test_runner.valid_app.models')) + app_config = AppConfig('test_runner.valid_app') + app_config.import_models({}) tests = get_tests(app_config) self.assertIsInstance(tests, types.ModuleType) @@ -238,11 +235,10 @@ class ModulesTestsPackages(IgnoreAllDeprecationWarningsMixin, unittest.TestCase) "Test for #12658 - Tests with ImportError's shouldn't fail silently" from django.core.apps.base import AppConfig from django.test.simple import get_tests - app_config = AppConfig( - 'test_runner_invalid_app', - import_module('test_runner_invalid_app'), - import_module('test_runner_invalid_app.models')) - self.assertRaises(ImportError, get_tests, app_config) + app_config = AppConfig('test_runner_invalid_app') + app_config.import_models({}) + with self.assertRaises(ImportError): + get_tests(app_config) class Sqlite3InMemoryTestDbs(TestCase): From 86804ab063cb9666b69638372abfe4174a2472b2 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 18 Dec 2013 14:49:29 +0100 Subject: [PATCH 008/208] Terminated AppCache._populate() with extreme prejudice. It was called _populate() before I renamed it to populate(). Since it has been superseded by populate_models() there's no reason to keep it. Removed the can_postpone argument of load_app() as it was only used by populate(). It's a private API and there's no replacement. Simplified load_app() accordingly. Then new version behaves exactly like the old one even though it's much shorter. --- django/contrib/admin/validation.py | 2 +- django/core/apps/cache.py | 89 +++++------------------------- django/core/serializers/base.py | 2 +- django/core/serializers/python.py | 2 +- django/db/models/base.py | 2 +- django/db/models/loading.py | 2 +- django/db/models/options.py | 2 +- tests/app_loading/tests.py | 5 +- tests/runtests.py | 2 +- 9 files changed, 24 insertions(+), 84 deletions(-) diff --git a/django/contrib/admin/validation.py b/django/contrib/admin/validation.py index a15967e024..ee945f73e5 100644 --- a/django/contrib/admin/validation.py +++ b/django/contrib/admin/validation.py @@ -18,7 +18,7 @@ class BaseValidator(object): def __init__(self): # Before we can introspect models, they need the app cache to be fully # loaded so that inter-relations are set up correctly. - app_cache.populate() + app_cache.populate_models() def validate(self, cls, model): for m in dir(self): diff --git a/django/core/apps/cache.py b/django/core/apps/cache.py index cf2489185e..e9a4215440 100644 --- a/django/core/apps/cache.py +++ b/django/core/apps/cache.py @@ -2,17 +2,16 @@ from collections import defaultdict, OrderedDict from contextlib import contextmanager -from importlib import import_module import os import sys import warnings from django.conf import settings from django.core.exceptions import ImproperlyConfigured -from django.utils.module_loading import import_lock, module_has_submodule +from django.utils.module_loading import import_lock from django.utils._os import upath -from .base import AppConfig, MODELS_MODULE_NAME +from .base import AppConfig class UnavailableApp(Exception): @@ -51,15 +50,11 @@ class AppCache(object): # Used by TransactionTestCase.available_apps for performance reasons. self.available_apps = None - # Internal flags used when populating the cache. - self._apps_loaded = False - self._models_loaded = False + # Internal flags used when populating the master cache. + self._apps_loaded = not self.master + self._models_loaded = not self.master - # -- Everything below here is only used when populating the cache -- - self.loaded = False - self.handled = set() - self.postponed = [] - self.nesting_level = 0 + # Cache for get_models. self._get_models_cache = {} def populate_apps(self): @@ -138,71 +133,15 @@ class AppCache(object): self._models_loaded = True - def populate(self): - """ - Fill in all the cache information. This method is threadsafe, in the - sense that every caller will see the same state upon return, and if the - cache is already initialised, it does no work. - """ - if self.loaded: - return - if not self.master: - self.loaded = True - return - # Note that we want to use the import lock here - the app loading is - # in many cases initiated implicitly by importing, and thus it is - # possible to end up in deadlock when one thread initiates loading - # without holding the importer lock and another thread then tries to - # import something which also launches the app loading. For details of - # this situation see #18251. - with import_lock(): - if self.loaded: - return - for app_name in settings.INSTALLED_APPS: - if app_name in self.handled: - continue - self.load_app(app_name, can_postpone=True) - if not self.nesting_level: - for app_name in self.postponed: - self.load_app(app_name) - self.loaded = True - - def load_app(self, app_name, can_postpone=False): + def load_app(self, app_name): """ Loads the app with the provided fully qualified name, and returns the model module. """ - app_module = import_module(app_name) - self.handled.add(app_name) - self.nesting_level += 1 - try: - models_module = import_module('%s.%s' % (app_name, MODELS_MODULE_NAME)) - except ImportError: - # If the app doesn't have a models module, we can just swallow the - # ImportError and return no models for this app. - if not module_has_submodule(app_module, MODELS_MODULE_NAME): - models_module = None - # But if the app does have a models module, we need to figure out - # whether to suppress or propagate the error. If can_postpone is - # True then it may be that the package is still being imported by - # Python and the models module isn't available yet. So we add the - # app to the postponed list and we'll try it again after all the - # recursion has finished (in populate). If can_postpone is False - # then it's time to raise the ImportError. - else: - if can_postpone: - self.postponed.append(app_name) - return - else: - raise - finally: - self.nesting_level -= 1 - app_config = AppConfig(app_name) app_config.import_models(self.all_models[app_config.label]) self.app_configs[app_config.label] = app_config - - return models_module + return app_config.models_module def app_cache_ready(self): """ @@ -211,7 +150,7 @@ class AppCache(object): Useful for code that wants to cache the results of get_models() for themselves once it is safe to do so. """ - return self.loaded + return self._models_loaded # implies self._apps_loaded. def get_app_configs(self, only_with_models_module=False): """ @@ -220,7 +159,7 @@ class AppCache(object): If only_with_models_module in True (non-default), only applications containing a models module are considered. """ - self.populate() + self.populate_models() for app_config in self.app_configs.values(): if only_with_models_module and app_config.models_module is None: continue @@ -240,7 +179,7 @@ class AppCache(object): If only_with_models_module in True (non-default), only applications containing a models module are considered. """ - self.populate() + self.populate_models() app_config = self.app_configs.get(app_label) if app_config is None: raise LookupError("No installed app with label %r." % app_label) @@ -288,7 +227,7 @@ class AppCache(object): return model_list except KeyError: pass - self.populate() + self.populate_models() if app_mod: app_label = app_mod.__name__.split('.')[-2] if only_installed: @@ -331,7 +270,7 @@ class AppCache(object): """ if not self.master: only_installed = False - self.populate() + self.populate_models() if only_installed: app_config = self.app_configs.get(app_label) if app_config is None: @@ -496,7 +435,7 @@ class AppCache(object): "[a.path for a in get_app_configs()] supersedes get_app_paths().", PendingDeprecationWarning, stacklevel=2) - self.populate() + self.populate_models() app_paths = [] for app in self.get_apps(): diff --git a/django/core/serializers/base.py b/django/core/serializers/base.py index db4b79a020..b0bc8138ab 100644 --- a/django/core/serializers/base.py +++ b/django/core/serializers/base.py @@ -139,7 +139,7 @@ class Deserializer(six.Iterator): self.stream = stream_or_string # Make sure the app cache is loaded before deserialization starts # (otherwise subclass calls to get_model() and friends might fail...) - app_cache.populate() + app_cache.populate_models() def __iter__(self): return self diff --git a/django/core/serializers/python.py b/django/core/serializers/python.py index 13d6f01a4e..1e4c37e2ae 100644 --- a/django/core/serializers/python.py +++ b/django/core/serializers/python.py @@ -88,7 +88,7 @@ def Deserializer(object_list, **options): db = options.pop('using', DEFAULT_DB_ALIAS) ignore = options.pop('ignorenonexistent', False) - app_cache.populate() + app_cache.populate_models() for d in object_list: # Look up the model and starting build a dict of data for it. diff --git a/django/db/models/base.py b/django/db/models/base.py index a694350b97..d1e7323d17 100644 --- a/django/db/models/base.py +++ b/django/db/models/base.py @@ -6,7 +6,7 @@ from functools import update_wrapper from django.utils.six.moves import zip from django.core.apps import app_cache -from django.core.apps.cache import MODELS_MODULE_NAME +from django.core.apps.base import MODELS_MODULE_NAME import django.db.models.manager # NOQA: Imported to register signal handler. from django.conf import settings from django.core.exceptions import (ObjectDoesNotExist, diff --git a/django/db/models/loading.py b/django/db/models/loading.py index 5745dbed4d..00fae36769 100644 --- a/django/db/models/loading.py +++ b/django/db/models/loading.py @@ -30,6 +30,6 @@ def get_app_errors(): try: return app_cache.app_errors except AttributeError: - app_cache.populate() + app_cache.populate_models() app_cache.app_errors = {} return app_cache.app_errors diff --git a/django/db/models/options.py b/django/db/models/options.py index f7be089539..fec9aa4fc4 100644 --- a/django/db/models/options.py +++ b/django/db/models/options.py @@ -93,7 +93,7 @@ class Options(object): @property def app_config(self): - # Don't go through get_app_config to avoid triggering populate(). + # Don't go through get_app_config to avoid triggering imports. return self.app_cache.app_configs.get(self.app_label) @property diff --git a/tests/app_loading/tests.py b/tests/app_loading/tests.py index e282306ec0..45f6cd6c31 100644 --- a/tests/app_loading/tests.py +++ b/tests/app_loading/tests.py @@ -77,8 +77,9 @@ class EggLoadingTest(TestCase): error. Refs #17667. """ app_cache = AppCache() - # Pretend we're the master app cache to test populate(). - app_cache.master = True + # Pretend we're the master app cache to test the population process. + app_cache._apps_loaded = False + app_cache._models_loaded = False with override_settings(INSTALLED_APPS=('notexists',)): with self.assertRaises(ImportError): app_cache.get_model('notexists', 'nomodel') diff --git a/tests/runtests.py b/tests/runtests.py index badbd6fbec..77cf005267 100755 --- a/tests/runtests.py +++ b/tests/runtests.py @@ -128,7 +128,7 @@ def setup(verbosity, test_labels): # Load all the ALWAYS_INSTALLED_APPS. with warnings.catch_warnings(): warnings.filterwarnings('ignore', 'django.contrib.comments is deprecated and will be removed before Django 1.8.', DeprecationWarning) - app_cache.populate() + app_cache.populate_models() # Load all the test model apps. test_modules = get_test_modules() From 439b364e1e81371bd87488beed35ce051be8aaaa Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 18 Dec 2013 16:49:42 +0100 Subject: [PATCH 009/208] Added an _-prefix to pending lookups because it's transient. --- django/core/apps/cache.py | 6 +++--- django/db/models/fields/related.py | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/django/core/apps/cache.py b/django/core/apps/cache.py index e9a4215440..74488325a8 100644 --- a/django/core/apps/cache.py +++ b/django/core/apps/cache.py @@ -43,9 +43,6 @@ class AppCache(object): # Mapping of labels to AppConfig instances for installed apps. self.app_configs = OrderedDict() - # Pending lookups for lazy relations - self.pending_lookups = {} - # Set of app names. Allows restricting the set of installed apps. # Used by TransactionTestCase.available_apps for performance reasons. self.available_apps = None @@ -54,6 +51,9 @@ class AppCache(object): self._apps_loaded = not self.master self._models_loaded = not self.master + # Pending lookups for lazy relations. + self._pending_lookups = {} + # Cache for get_models. self._get_models_cache = {} diff --git a/django/db/models/fields/related.py b/django/db/models/fields/related.py index 1b141af099..cf35504afe 100644 --- a/django/db/models/fields/related.py +++ b/django/db/models/fields/related.py @@ -74,7 +74,7 @@ def add_lazy_relation(cls, field, relation, operation): else: key = (app_label, model_name) value = (cls, field, operation) - cls._meta.app_cache.pending_lookups.setdefault(key, []).append(value) + cls._meta.app_cache._pending_lookups.setdefault(key, []).append(value) def do_pending_lookups(sender, **kwargs): @@ -82,7 +82,7 @@ def do_pending_lookups(sender, **kwargs): Handle any pending relations to the sending model. Sent from class_prepared. """ key = (sender._meta.app_label, sender.__name__) - for cls, field, operation in sender._meta.app_cache.pending_lookups.pop(key, []): + for cls, field, operation in sender._meta.app_cache._pending_lookups.pop(key, []): operation(field, sender, cls) signals.class_prepared.connect(do_pending_lookups) From f25fa9d8590c7759c1ec7ffecf1d67be81237674 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 18 Dec 2013 17:56:11 +0100 Subject: [PATCH 010/208] Deprecated load_app(). Adjusted several tests that used it to add apps to the app cache and then attempted to remove them by manipulating attributes directly. Also renamed invalid_models to invalid_models_tests to avoid clashing application labels between the outer and the inner invalid_models applications. --- django/core/apps/cache.py | 25 +++++++------ tests/admin_scripts/tests.py | 2 +- tests/app_loading/tests.py | 35 +++++++++---------- .../__init__.py | 0 .../invalid_models/__init__.py | 0 .../invalid_models/models.py | 0 .../tests.py | 15 ++------ tests/migrations/test_writer.py | 10 +++--- tests/proxy_model_inheritance/tests.py | 21 ++++------- tests/runtests.py | 3 +- 10 files changed, 47 insertions(+), 64 deletions(-) rename tests/{invalid_models => invalid_models_tests}/__init__.py (100%) rename tests/{invalid_models => invalid_models_tests}/invalid_models/__init__.py (100%) rename tests/{invalid_models => invalid_models_tests}/invalid_models/models.py (100%) rename tests/{invalid_models => invalid_models_tests}/tests.py (72%) diff --git a/django/core/apps/cache.py b/django/core/apps/cache.py index 74488325a8..65f51801ec 100644 --- a/django/core/apps/cache.py +++ b/django/core/apps/cache.py @@ -133,16 +133,6 @@ class AppCache(object): self._models_loaded = True - def load_app(self, app_name): - """ - Loads the app with the provided fully qualified name, and returns the - model module. - """ - app_config = AppConfig(app_name) - app_config.import_models(self.all_models[app_config.label]) - self.app_configs[app_config.label] = app_config - return app_config.models_module - def app_cache_ready(self): """ Returns true if the model cache is fully populated. @@ -377,6 +367,19 @@ class AppCache(object): ### DEPRECATED METHODS GO BELOW THIS LINE ### + def load_app(self, app_name): + """ + Loads the app with the provided fully qualified name, and returns the + model module. + """ + warnings.warn( + "load_app(app_name) is deprecated.", + PendingDeprecationWarning, stacklevel=2) + app_config = AppConfig(app_name) + app_config.import_models(self.all_models[app_config.label]) + self.app_configs[app_config.label] = app_config + return app_config.models_module + def get_app(self, app_label): """ Returns the module containing the models for the given app_label. @@ -447,7 +450,7 @@ class AppCache(object): Register a set of models as belonging to an app. """ warnings.warn( - "register_models(app_label, models) is deprecated.", + "register_models(app_label, *models) is deprecated.", PendingDeprecationWarning, stacklevel=2) for model in models: self.register_model(app_label, model) diff --git a/tests/admin_scripts/tests.py b/tests/admin_scripts/tests.py index db0b8d6030..3f9a336c16 100644 --- a/tests/admin_scripts/tests.py +++ b/tests/admin_scripts/tests.py @@ -1094,7 +1094,7 @@ class ManageValidate(AdminScriptTestCase): self.assertOutput(err, 'ImportError') def test_complex_app(self): - "manage.py validate does not raise an ImportError validating a complex app with nested calls to load_app" + "manage.py validate does not raise an ImportError validating a complex app" self.write_settings('settings.py', apps=['admin_scripts.complex_app', 'admin_scripts.simple_app'], sdict={'DEBUG': True}) diff --git a/tests/app_loading/tests.py b/tests/app_loading/tests.py index 45f6cd6c31..bb71ad84a2 100644 --- a/tests/app_loading/tests.py +++ b/tests/app_loading/tests.py @@ -8,6 +8,7 @@ from django.core.apps import app_cache from django.core.apps.cache import AppCache from django.test.utils import override_settings from django.utils._os import upath +from django.utils import six class EggLoadingTest(TestCase): @@ -31,45 +32,41 @@ class EggLoadingTest(TestCase): """Models module can be loaded from an app in an egg""" egg_name = '%s/modelapp.egg' % self.egg_dir sys.path.append(egg_name) - models = app_cache.load_app('app_with_models') - self.assertFalse(models is None) + with app_cache._with_app('app_with_models'): + models_module = app_cache.get_app_config('app_with_models').models_module + self.assertIsNotNone(models_module) def test_egg2(self): """Loading an app from an egg that has no models returns no models (and no error)""" egg_name = '%s/nomodelapp.egg' % self.egg_dir sys.path.append(egg_name) - models = app_cache.load_app('app_no_models') - self.assertTrue(models is None) + with app_cache._with_app('app_no_models'): + models_module = app_cache.get_app_config('app_no_models').models_module + self.assertIsNone(models_module) def test_egg3(self): """Models module can be loaded from an app located under an egg's top-level package""" egg_name = '%s/omelet.egg' % self.egg_dir sys.path.append(egg_name) - models = app_cache.load_app('omelet.app_with_models') - self.assertFalse(models is None) + with app_cache._with_app('omelet.app_with_models'): + models_module = app_cache.get_app_config('app_with_models').models_module + self.assertIsNotNone(models_module) def test_egg4(self): """Loading an app with no models from under the top-level egg package generates no error""" egg_name = '%s/omelet.egg' % self.egg_dir sys.path.append(egg_name) - models = app_cache.load_app('omelet.app_no_models') - self.assertTrue(models is None) + with app_cache._with_app('omelet.app_no_models'): + models_module = app_cache.get_app_config('app_no_models').models_module + self.assertIsNone(models_module) def test_egg5(self): """Loading an app from an egg that has an import error in its models module raises that error""" egg_name = '%s/brokenapp.egg' % self.egg_dir sys.path.append(egg_name) - self.assertRaises(ImportError, app_cache.load_app, 'broken_app') - raised = None - try: - app_cache.load_app('broken_app') - except ImportError as e: - raised = e - - # Make sure the message is indicating the actual - # problem in the broken app. - self.assertTrue(raised is not None) - self.assertTrue("modelz" in raised.args[0]) + with six.assertRaisesRegex(self, ImportError, 'modelz'): + with app_cache._with_app('broken_app'): + app_cache.get_app_config('omelet.app_no_models').models_module def test_missing_app(self): """ diff --git a/tests/invalid_models/__init__.py b/tests/invalid_models_tests/__init__.py similarity index 100% rename from tests/invalid_models/__init__.py rename to tests/invalid_models_tests/__init__.py diff --git a/tests/invalid_models/invalid_models/__init__.py b/tests/invalid_models_tests/invalid_models/__init__.py similarity index 100% rename from tests/invalid_models/invalid_models/__init__.py rename to tests/invalid_models_tests/invalid_models/__init__.py diff --git a/tests/invalid_models/invalid_models/models.py b/tests/invalid_models_tests/invalid_models/models.py similarity index 100% rename from tests/invalid_models/invalid_models/models.py rename to tests/invalid_models_tests/invalid_models/models.py diff --git a/tests/invalid_models/tests.py b/tests/invalid_models_tests/tests.py similarity index 72% rename from tests/invalid_models/tests.py rename to tests/invalid_models_tests/tests.py index 10d8fa47a7..4e0cef546b 100644 --- a/tests/invalid_models/tests.py +++ b/tests/invalid_models_tests/tests.py @@ -18,14 +18,7 @@ class InvalidModelTestCase(unittest.TestCase): self.stdout = StringIO() sys.stdout = self.stdout - # The models need to be removed after the test in order to prevent bad - # interactions with the flush operation in other tests. - self._old_models = app_cache.app_configs['invalid_models'].models.copy() - def tearDown(self): - app_cache.app_configs['invalid_models'].models = self._old_models - app_cache.all_models['invalid_models'] = self._old_models - app_cache._get_models_cache = {} sys.stdout = self.old_stdout # Technically, this isn't an override -- TEST_SWAPPED_MODEL must be @@ -38,12 +31,10 @@ class InvalidModelTestCase(unittest.TestCase): TEST_SWAPPED_MODEL_BAD_MODEL='not_an_app.Target', ) def test_invalid_models(self): - try: - module = app_cache.load_app("invalid_models.invalid_models") - except Exception: - self.fail('Unable to load invalid model module') + with app_cache._with_app("invalid_models_tests.invalid_models"): + module = app_cache.get_app_config("invalid_models").models_module + get_validation_errors(self.stdout, module) - get_validation_errors(self.stdout, module) self.stdout.seek(0) error_log = self.stdout.read() actual = error_log.split('\n') diff --git a/tests/migrations/test_writer.py b/tests/migrations/test_writer.py index 76fe5b5a9e..f921f9f03c 100644 --- a/tests/migrations/test_writer.py +++ b/tests/migrations/test_writer.py @@ -124,8 +124,8 @@ class WriterTests(TestCase): with override_settings(INSTALLED_APPS=test_apps): for app in test_apps: - app_cache.load_app(app) - migration = migrations.Migration('0001_initial', app.split('.')[-1]) - expected_path = os.path.join(base_dir, *(app.split('.') + ['migrations', '0001_initial.py'])) - writer = MigrationWriter(migration) - self.assertEqual(writer.path, expected_path) + with app_cache._with_app(app): + migration = migrations.Migration('0001_initial', app.split('.')[-1]) + expected_path = os.path.join(base_dir, *(app.split('.') + ['migrations', '0001_initial.py'])) + writer = MigrationWriter(migration) + self.assertEqual(writer.path, expected_path) diff --git a/tests/proxy_model_inheritance/tests.py b/tests/proxy_model_inheritance/tests.py index 601fdc5b42..01a2ddfef6 100644 --- a/tests/proxy_model_inheritance/tests.py +++ b/tests/proxy_model_inheritance/tests.py @@ -3,7 +3,6 @@ from __future__ import unicode_literals import os import sys -from django.conf import settings from django.core.apps import app_cache from django.core.management import call_command from django.test import TestCase, TransactionTestCase @@ -21,28 +20,21 @@ class ProxyModelInheritanceTests(TransactionTestCase): for the proxied model (as described in #12286). This test creates two dummy apps and calls migrate, then verifies that the table has been created. """ - - available_apps = [] + available_apps = ['app1', 'app2'] def setUp(self): self.old_sys_path = sys.path[:] sys.path.append(os.path.dirname(os.path.abspath(upath(__file__)))) - for app in settings.INSTALLED_APPS: - app_cache.load_app(app) + self._with_app1 = app_cache._begin_with_app('app1') + self._with_app2 = app_cache._begin_with_app('app2') def tearDown(self): + app_cache._end_with_app(self._with_app1) + app_cache._end_with_app(self._with_app2) sys.path = self.old_sys_path - del app_cache.app_configs['app1'] - del app_cache.app_configs['app2'] - del app_cache.all_models['app1'] - del app_cache.all_models['app2'] def test_table_exists(self): - try: - app_cache.set_available_apps(settings.INSTALLED_APPS) - call_command('migrate', verbosity=0) - finally: - app_cache.unset_available_apps() + call_command('migrate', verbosity=0) from .app1.models import ProxyModel from .app2.models import NiceModel self.assertEqual(NiceModel.objects.all().count(), 0) @@ -56,7 +48,6 @@ class MultiTableInheritanceProxyTest(TestCase): Deleting an instance of a model proxying a multi-table inherited subclass should cascade delete down the whole inheritance chain (see #18083). - """ instance = ConcreteModelSubclassProxy.objects.create() instance.delete() diff --git a/tests/runtests.py b/tests/runtests.py index 77cf005267..64d363a095 100755 --- a/tests/runtests.py +++ b/tests/runtests.py @@ -164,7 +164,8 @@ def setup(verbosity, test_labels): if module_found_in_labels: if verbosity >= 2: print("Importing application %s" % module_name) - app_cache.load_app(module_label) + # HACK. + app_cache._begin_with_app(module_label) if module_label not in settings.INSTALLED_APPS: settings.INSTALLED_APPS.append(module_label) From 4582993302262dec06a39028cc878247542c2334 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 19 Dec 2013 10:26:18 +0100 Subject: [PATCH 011/208] Populated models only when necessary in get_app_config[s]. Took this opportunity to change get_app[s] to only consider applications containing a model module as that seems slightly more backwards compatible. Since callers that care about models pass only_with_models_module=True, this has very few consequences. Only AppCommand needed a change. --- django/core/apps/cache.py | 34 ++++++++++++++++++++++------------ django/core/management/base.py | 5 +++++ 2 files changed, 27 insertions(+), 12 deletions(-) diff --git a/django/core/apps/cache.py b/django/core/apps/cache.py index 65f51801ec..0eddbed935 100644 --- a/django/core/apps/cache.py +++ b/django/core/apps/cache.py @@ -144,12 +144,16 @@ class AppCache(object): def get_app_configs(self, only_with_models_module=False): """ - Return an iterable of application configurations. + Imports applications and returns an iterable of app configs. - If only_with_models_module in True (non-default), only applications - containing a models module are considered. + If only_with_models_module in True (non-default), imports models and + considers only applications containing a models module. """ - self.populate_models() + if only_with_models_module: + self.populate_models() + else: + self.populate_apps() + for app_config in self.app_configs.values(): if only_with_models_module and app_config.models_module is None: continue @@ -159,17 +163,21 @@ class AppCache(object): def get_app_config(self, app_label, only_with_models_module=False): """ - Returns the application configuration for the given app_label. + Imports applications and returns an app config for the given label. - Raises LookupError if no application exists with this app_label. + Raises LookupError if no application exists with this label. Raises UnavailableApp when set_available_apps() disables the - application with this app_label. + application with this label. - If only_with_models_module in True (non-default), only applications - containing a models module are considered. + If only_with_models_module in True (non-default), imports models and + considers only applications containing a models module. """ - self.populate_models() + if only_with_models_module: + self.populate_models() + else: + self.populate_apps() + app_config = self.app_configs.get(app_label) if app_config is None: raise LookupError("No installed app with label %r." % app_label) @@ -391,7 +399,8 @@ class AppCache(object): "get_app_config(app_label).models_module supersedes get_app(app_label).", PendingDeprecationWarning, stacklevel=2) try: - return self.get_app_config(app_label).models_module + return self.get_app_config( + app_label, only_with_models_module=True).models_module except LookupError as exc: # Change the exception type for backwards compatibility. raise ImproperlyConfigured(*exc.args) @@ -403,7 +412,8 @@ class AppCache(object): warnings.warn( "[a.models_module for a in get_app_configs()] supersedes get_apps().", PendingDeprecationWarning, stacklevel=2) - return [app_config.models_module for app_config in self.get_app_configs()] + app_configs = self.get_app_configs(only_with_models_module=True) + return [app_config.models_module for app_config in app_configs] def _get_app_package(self, app): return '.'.join(app.__name__.split('.')[:-1]) diff --git a/django/core/management/base.py b/django/core/management/base.py index aeb27e1f0b..b9404ec1aa 100644 --- a/django/core/management/base.py +++ b/django/core/management/base.py @@ -344,6 +344,11 @@ class AppCommand(BaseCommand): from django.core.apps import app_cache if not app_labels: raise CommandError('Enter at least one appname.') + # Populate models and don't use only_with_models_module=True when + # calling get_app_config() to tell apart missing apps from apps + # without a model module -- which can't be supported with the legacy + # API since it passes the models module to handle_app(). + app_cache.populate_models() try: app_configs = [app_cache.get_app_config(app_label) for app_label in app_labels] except (LookupError, ImportError) as e: From d4733b6df07b1f8a869eed8eac86869d1d14472c Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 19 Dec 2013 20:32:00 +0100 Subject: [PATCH 012/208] Not all Python modules have a __path__. --- django/core/apps/base.py | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/django/core/apps/base.py b/django/core/apps/base.py index 83c073a12a..2503d9e3ff 100644 --- a/django/core/apps/base.py +++ b/django/core/apps/base.py @@ -35,9 +35,13 @@ class AppConfig(object): self.models = None # Filesystem path to the application directory eg. - # u'/usr/lib/python2.7/dist-packages/django/contrib/admin'. - # This is a unicode object on Python 2 and a str on Python 3. - self.path = upath(self.app_module.__path__[0]) + # u'/usr/lib/python2.7/dist-packages/django/contrib/admin'. May be + # None if the application isn't a bona fide package eg. if it's an + # egg. Otherwise it's a unicode on Python 2 and a str on Python 3. + try: + self.path = upath(self.app_module.__path__[0]) + except AttributeError: + self.path = None def __repr__(self): return '' % self.label From 65cd74be8e99d06c7861edc5050e34d6444e4d56 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 19 Dec 2013 15:57:23 +0100 Subject: [PATCH 013/208] Stopped iterating on INSTALLED_APPS. Used the app cache's get_app_configs() method instead. --- django/contrib/staticfiles/finders.py | 6 +++-- django/core/management/__init__.py | 20 +++++++++++----- django/core/management/commands/flush.py | 5 ++-- django/core/management/commands/migrate.py | 7 +++--- django/template/base.py | 8 +++++-- django/template/loaders/app_directories.py | 11 +++------ django/template/loaders/eggs.py | 7 +++--- django/utils/autoreload.py | 9 +++----- django/utils/module_loading.py | 9 ++++---- django/utils/translation/trans_real.py | 8 +++---- django/views/i18n.py | 6 ++++- tests/bash_completion/tests.py | 8 ++++--- tests/i18n/tests.py | 26 +++++++++++++++++---- tests/staticfiles_tests/test_liveserver.py | 3 +++ tests/template_tests/test_loaders.py | 27 +++++++++++----------- tests/template_tests/tests.py | 13 +++++++---- tests/utils_tests/test_module_loading.py | 9 ++++++-- tests/view_tests/tests/test_i18n.py | 16 ++++++------- 18 files changed, 116 insertions(+), 82 deletions(-) diff --git a/django/contrib/staticfiles/finders.py b/django/contrib/staticfiles/finders.py index cf5eb4f85b..cadc8bffa7 100644 --- a/django/contrib/staticfiles/finders.py +++ b/django/contrib/staticfiles/finders.py @@ -2,6 +2,7 @@ from collections import OrderedDict import os from django.conf import settings +from django.core.apps import app_cache from django.core.exceptions import ImproperlyConfigured from django.core.files.storage import default_storage, Storage, FileSystemStorage from django.utils.functional import empty, LazyObject @@ -116,10 +117,11 @@ class AppDirectoriesFinder(BaseFinder): def __init__(self, apps=None, *args, **kwargs): # The list of apps that are handled self.apps = [] - # Mapping of app module paths to storage instances + # Mapping of app names to storage instances self.storages = OrderedDict() if apps is None: - apps = settings.INSTALLED_APPS + app_configs = app_cache.get_app_configs() + apps = [app_config.name for app_config in app_configs] for app in apps: app_storage = self.storage_class(app) if os.path.isdir(app_storage.location): diff --git a/django/core/management/__init__.py b/django/core/management/__init__.py index 0b47e179db..a7d074e149 100644 --- a/django/core/management/__init__.py +++ b/django/core/management/__init__.py @@ -5,6 +5,7 @@ from optparse import OptionParser, NO_DEFAULT import os import sys +from django.conf import settings from django.core.exceptions import ImproperlyConfigured from django.core.management.base import BaseCommand, CommandError, handle_default_options from django.core.management.color import color_style @@ -106,13 +107,19 @@ def get_commands(): _commands = dict((name, 'django.core') for name in find_commands(__path__[0])) # Find the installed apps - from django.conf import settings try: - apps = settings.INSTALLED_APPS + settings.INSTALLED_APPS except ImproperlyConfigured: - # Still useful for commands that do not require functional settings, - # like startproject or help + # Still useful for commands that do not require functional + # settings, like startproject or help. apps = [] + else: + # Populate the app cache outside of the try/except block to avoid + # catching ImproperlyConfigured errors that aren't caused by the + # absence of a settings module. + from django.core.apps import app_cache + app_configs = app_cache.get_app_configs() + apps = [app_config.name for app_config in app_configs] # Find and load the management module for each installed app. for app_name in apps: @@ -339,9 +346,10 @@ class ManagementUtility(object): elif cwords[0] in ('dumpdata', 'sql', 'sqlall', 'sqlclear', 'sqlcustom', 'sqlindexes', 'sqlsequencereset', 'test'): try: - from django.conf import settings + from django.core.apps import app_cache + app_configs = app_cache.get_app_configs() # Get the last part of the dotted path as the app name. - options += [(a.split('.')[-1], 0) for a in settings.INSTALLED_APPS] + options += [(app_config.label, 0) for app_config in app_configs] except ImportError: # Fail silently if DJANGO_SETTINGS_MODULE isn't set. The # user will find out once they execute the command. diff --git a/django/core/management/commands/flush.py b/django/core/management/commands/flush.py index 562147e403..f13e948ae5 100644 --- a/django/core/management/commands/flush.py +++ b/django/core/management/commands/flush.py @@ -2,7 +2,6 @@ import sys from importlib import import_module from optparse import make_option -from django.conf import settings from django.core.apps import app_cache from django.db import connections, router, transaction, DEFAULT_DB_ALIAS from django.core.management import call_command @@ -42,9 +41,9 @@ class Command(NoArgsCommand): # Import the 'management' module within each installed app, to register # dispatcher events. - for app_name in settings.INSTALLED_APPS: + for app_config in app_cache.get_app_configs(): try: - import_module('.management', app_name) + import_module('.management', app_config.name) except ImportError: pass diff --git a/django/core/management/commands/migrate.py b/django/core/management/commands/migrate.py index b607e8ee43..c99f26aa0c 100644 --- a/django/core/management/commands/migrate.py +++ b/django/core/management/commands/migrate.py @@ -6,7 +6,6 @@ from importlib import import_module import itertools import traceback -from django.conf import settings from django.core.apps import app_cache from django.core.management import call_command from django.core.management.base import BaseCommand, CommandError @@ -47,9 +46,9 @@ class Command(BaseCommand): # Import the 'management' module within each installed app, to register # dispatcher events. - for app_name in settings.INSTALLED_APPS: - if module_has_submodule(import_module(app_name), "management"): - import_module('.management', app_name) + for app_config in app_cache.get_app_configs(): + if module_has_submodule(app_config.app_module, "management"): + import_module('.management', app_config.name) # Get the database we're operating from db = options.get('database') diff --git a/django/template/base.py b/django/template/base.py index c314637c42..7098ea60f8 100644 --- a/django/template/base.py +++ b/django/template/base.py @@ -6,6 +6,7 @@ from importlib import import_module from inspect import getargspec, getcallargs from django.conf import settings +from django.core.apps import app_cache from django.template.context import (BaseContext, Context, RequestContext, # NOQA: imported for backwards compatibility ContextPopException) from django.utils.itercompat import is_iterable @@ -1302,9 +1303,12 @@ def get_templatetags_modules(): # Populate list once per process. Mutate the local list first, and # then assign it to the global name to ensure there are no cases where # two threads try to populate it simultaneously. - for app_module in ['django'] + list(settings.INSTALLED_APPS): + + templatetags_modules_candidates = ['django.templatetags'] + templatetags_modules_candidates += ['%s.templatetags' % app_config.name + for app_config in app_cache.get_app_configs()] + for templatetag_module in templatetags_modules_candidates: try: - templatetag_module = '%s.templatetags' % app_module import_module(templatetag_module) _templatetags_modules.append(templatetag_module) except ImportError: diff --git a/django/template/loaders/app_directories.py b/django/template/loaders/app_directories.py index 4f8ddfccac..90baa34c7a 100644 --- a/django/template/loaders/app_directories.py +++ b/django/template/loaders/app_directories.py @@ -3,12 +3,11 @@ Wrapper for loading templates from "templates" directories in INSTALLED_APPS packages. """ -from importlib import import_module import os import sys from django.conf import settings -from django.core.exceptions import ImproperlyConfigured +from django.core.apps import app_cache from django.template.base import TemplateDoesNotExist from django.template.loader import BaseLoader from django.utils._os import safe_join @@ -18,12 +17,8 @@ from django.utils import six if six.PY2: fs_encoding = sys.getfilesystemencoding() or sys.getdefaultencoding() app_template_dirs = [] -for app in settings.INSTALLED_APPS: - try: - mod = import_module(app) - except ImportError as e: - raise ImproperlyConfigured('ImportError %s: %s' % (app, e.args[0])) - template_dir = os.path.join(os.path.dirname(mod.__file__), 'templates') +for app_config in app_cache.get_app_configs(): + template_dir = os.path.join(app_config.path, 'templates') if os.path.isdir(template_dir): if six.PY2: template_dir = template_dir.decode(fs_encoding) diff --git a/django/template/loaders/eggs.py b/django/template/loaders/eggs.py index 04e4f73b7b..e9b46b15de 100644 --- a/django/template/loaders/eggs.py +++ b/django/template/loaders/eggs.py @@ -7,6 +7,7 @@ except ImportError: resource_string = None from django.conf import settings +from django.core.apps import app_cache from django.template.base import TemplateDoesNotExist from django.template.loader import BaseLoader from django.utils import six @@ -23,12 +24,12 @@ class Loader(BaseLoader): """ if resource_string is not None: pkg_name = 'templates/' + template_name - for app in settings.INSTALLED_APPS: + for app_config in app_cache.get_app_configs(): try: - resource = resource_string(app, pkg_name) + resource = resource_string(app_config.name, pkg_name) except Exception: continue if six.PY2: resource = resource.decode(settings.FILE_CHARSET) - return (resource, 'egg:%s:%s' % (app, pkg_name)) + return (resource, 'egg:%s:%s' % (app_config.name, pkg_name)) raise TemplateDoesNotExist(template_name) diff --git a/django/utils/autoreload.py b/django/utils/autoreload.py index 1913317822..05ffb12f74 100644 --- a/django/utils/autoreload.py +++ b/django/utils/autoreload.py @@ -37,9 +37,8 @@ import time import traceback from django.conf import settings +from django.core.apps import app_cache from django.core.signals import request_finished -from django.utils._os import upath -from importlib import import_module try: from django.utils.six.moves import _thread as thread except ImportError: @@ -91,10 +90,8 @@ def gen_filenames(): basedirs = [os.path.join(os.path.dirname(os.path.dirname(__file__)), 'conf', 'locale'), 'locale'] - for appname in reversed(settings.INSTALLED_APPS): - app = import_module(appname) - basedirs.append(os.path.join(os.path.dirname(upath(app.__file__)), - 'locale')) + for app_config in reversed(list(app_cache.get_app_configs())): + basedirs.append(os.path.join(app_config.path, 'locale')) basedirs.extend(settings.LOCALE_PATHS) basedirs = [os.path.abspath(basedir) for basedir in basedirs if os.path.isdir(basedir)] diff --git a/django/utils/module_loading.py b/django/utils/module_loading.py index 0c6bad2a7b..8d95fc00a3 100644 --- a/django/utils/module_loading.py +++ b/django/utils/module_loading.py @@ -58,18 +58,17 @@ def autodiscover_modules(*args, **kwargs): registry. This register_to object must have a _registry instance variable to access it. """ - from django.conf import settings + from django.core.apps import app_cache register_to = kwargs.get('register_to') - for app in settings.INSTALLED_APPS: - mod = import_module(app) + for app_config in app_cache.get_app_configs(): # Attempt to import the app's module. try: if register_to: before_import_registry = copy.copy(register_to._registry) for module_to_search in args: - import_module('%s.%s' % (app, module_to_search)) + import_module('%s.%s' % (app_config.name, module_to_search)) except: # Reset the model registry to the state before the last import as # this import will have to reoccur on the next request and this @@ -81,7 +80,7 @@ def autodiscover_modules(*args, **kwargs): # Decide whether to bubble up this error. If the app just # doesn't have an admin module, we can ignore the error # attempting to import it, otherwise we want it to bubble up. - if module_has_submodule(mod, module_to_search): + if module_has_submodule(app_config.app_module, module_to_search): raise diff --git a/django/utils/translation/trans_real.py b/django/utils/translation/trans_real.py index e547800b92..3ed6371966 100644 --- a/django/utils/translation/trans_real.py +++ b/django/utils/translation/trans_real.py @@ -7,10 +7,10 @@ import os import re import sys import gettext as gettext_module -from importlib import import_module from threading import local import warnings +from django.core.apps import app_cache from django.dispatch import receiver from django.test.signals import setting_changed from django.utils.encoding import force_str, force_text @@ -179,10 +179,8 @@ def translation(language): res.merge(t) return res - for appname in reversed(settings.INSTALLED_APPS): - app = import_module(appname) - apppath = os.path.join(os.path.dirname(upath(app.__file__)), 'locale') - + for app_config in reversed(list(app_cache.get_app_configs())): + apppath = os.path.join(app_config.path, 'locale') if os.path.isdir(apppath): res = _merge(apppath) diff --git a/django/views/i18n.py b/django/views/i18n.py index 751905efaf..2f0c89a037 100644 --- a/django/views/i18n.py +++ b/django/views/i18n.py @@ -5,6 +5,7 @@ import gettext as gettext_module from django import http from django.conf import settings +from django.core.apps import app_cache from django.template import Context, Template from django.utils.translation import check_for_language, to_locale, get_language from django.utils.encoding import smart_text @@ -187,7 +188,10 @@ def render_javascript_catalog(catalog=None, plural=None): def get_javascript_catalog(locale, domain, packages): default_locale = to_locale(settings.LANGUAGE_CODE) - packages = [p for p in packages if p == 'django.conf' or p in settings.INSTALLED_APPS] + app_configs = app_cache.get_app_configs() + allowable_packages = set(app_config.name for app_config in app_configs) + allowable_packages.add('django.conf') + packages = [p for p in packages if p in allowable_packages] t = {} paths = [] en_selected = locale.startswith('en') diff --git a/tests/bash_completion/tests.py b/tests/bash_completion/tests.py index 6ff709809d..85fb58904c 100644 --- a/tests/bash_completion/tests.py +++ b/tests/bash_completion/tests.py @@ -5,7 +5,7 @@ import os import sys import unittest -from django.conf import settings +from django.core.apps import app_cache from django.core.management import ManagementUtility from django.utils.six import StringIO @@ -84,5 +84,7 @@ class BashCompletionTests(unittest.TestCase): "Application names will be autocompleted for an AppCommand" self._user_input('django-admin.py sqlall a') output = self._run_autocomplete() - app_labels = [name.split('.')[-1] for name in settings.INSTALLED_APPS] - self.assertEqual(output, sorted(label for label in app_labels if label.startswith('a'))) + a_labels = sorted(app_config.label + for app_config in app_cache.get_app_configs() + if app_config.label.startswith('a')) + self.assertEqual(output, a_labels) diff --git a/tests/i18n/tests.py b/tests/i18n/tests.py index 77b7d18455..339317c541 100644 --- a/tests/i18n/tests.py +++ b/tests/i18n/tests.py @@ -9,6 +9,7 @@ import pickle from threading import local from django.conf import settings +from django.core.apps import app_cache from django.template import Template, Context from django.template.base import TemplateSyntaxError from django.test import TestCase, RequestFactory @@ -1035,11 +1036,29 @@ class ResolutionOrderI18NTests(TransRealMixin, TestCase): "translation of '%s'; the actual result is '%s'." % (msgstr, msgid, result))) -@override_settings(INSTALLED_APPS=['i18n.resolution'] + list(settings.INSTALLED_APPS)) class AppResolutionOrderI18NTests(ResolutionOrderI18NTests): def test_app_translation(self): - self.assertUgettext('Date/time', 'APP') + # This test relies on an implementation detail, namely the fact that + # _with_app adds the app at the list. Adjust the test if this changes. + + # Original translation. + self.assertUgettext('Date/time', 'Datum/Zeit') + + # Different translation. + with app_cache._with_app('i18n.resolution'): + self.flush_caches() + activate('de') + + # Doesn't work because it's added later in the list. + self.assertUgettext('Date/time', 'Datum/Zeit') + + with app_cache._without_app('admin'): + self.flush_caches() + activate('de') + + # Unless the original is removed from the list. + self.assertUgettext('Date/time', 'Datum/Zeit (APP)') @override_settings(LOCALE_PATHS=extended_locale_paths) @@ -1049,8 +1068,7 @@ class LocalePathsResolutionOrderI18NTests(ResolutionOrderI18NTests): self.assertUgettext('Time', 'LOCALE_PATHS') def test_locale_paths_override_app_translation(self): - extended_apps = list(settings.INSTALLED_APPS) + ['i18n.resolution'] - with self.settings(INSTALLED_APPS=extended_apps): + with app_cache._with_app('i18n.resolution'): self.assertUgettext('Time', 'LOCALE_PATHS') diff --git a/tests/staticfiles_tests/test_liveserver.py b/tests/staticfiles_tests/test_liveserver.py index 71f4bb89a1..6fa64240cc 100644 --- a/tests/staticfiles_tests/test_liveserver.py +++ b/tests/staticfiles_tests/test_liveserver.py @@ -86,6 +86,9 @@ class StaticLiveServerChecks(LiveServerBase): class StaticLiveServerView(LiveServerBase): + # The test is going to access a static file stored in this application. + available_apps = ['staticfiles_tests.apps.test'] + def urlopen(self, url): return urlopen(self.live_server_url + url) diff --git a/tests/template_tests/test_loaders.py b/tests/template_tests/test_loaders.py index 6e74477e83..551bd7fb72 100644 --- a/tests/template_tests/test_loaders.py +++ b/tests/template_tests/test_loaders.py @@ -20,6 +20,7 @@ except ImportError: pkg_resources = None +from django.core.apps import app_cache from django.template import TemplateDoesNotExist, Context from django.template.loaders.eggs import Loader as EggLoader from django.template import loader @@ -49,7 +50,6 @@ def create_egg(name, resources): @unittest.skipUnless(pkg_resources, 'setuptools is not installed') -@override_settings(INSTALLED_APPS=[]) class EggLoaderTest(TestCase): def setUp(self): # Defined here b/c at module scope we may not have pkg_resources @@ -78,29 +78,28 @@ class EggLoaderTest(TestCase): os.path.normcase('templates/x.txt'): StringIO("x"), }) - @override_settings(INSTALLED_APPS=['egg_empty']) def test_empty(self): "Loading any template on an empty egg should fail" - egg_loader = EggLoader() - self.assertRaises(TemplateDoesNotExist, egg_loader.load_template_source, "not-existing.html") + with app_cache._with_app('egg_empty'): + egg_loader = EggLoader() + self.assertRaises(TemplateDoesNotExist, egg_loader.load_template_source, "not-existing.html") - @override_settings(INSTALLED_APPS=['egg_1']) def test_non_existing(self): "Template loading fails if the template is not in the egg" - egg_loader = EggLoader() - self.assertRaises(TemplateDoesNotExist, egg_loader.load_template_source, "not-existing.html") + with app_cache._with_app('egg_1'): + egg_loader = EggLoader() + self.assertRaises(TemplateDoesNotExist, egg_loader.load_template_source, "not-existing.html") - @override_settings(INSTALLED_APPS=['egg_1']) def test_existing(self): "A template can be loaded from an egg" - egg_loader = EggLoader() - contents, template_name = egg_loader.load_template_source("y.html") - self.assertEqual(contents, "y") - self.assertEqual(template_name, "egg:egg_1:templates/y.html") + with app_cache._with_app('egg_1'): + egg_loader = EggLoader() + contents, template_name = egg_loader.load_template_source("y.html") + self.assertEqual(contents, "y") + self.assertEqual(template_name, "egg:egg_1:templates/y.html") - @override_settings(INSTALLED_APPS=[]) def test_not_installed(self): - "Loading an existent template from an egg not included in INSTALLED_APPS should fail" + "Loading an existent template from an egg not included in any app should fail" egg_loader = EggLoader() self.assertRaises(TemplateDoesNotExist, egg_loader.load_template_source, "y.html") diff --git a/tests/template_tests/tests.py b/tests/template_tests/tests.py index 651d46d4f1..61a46a81f9 100644 --- a/tests/template_tests/tests.py +++ b/tests/template_tests/tests.py @@ -16,6 +16,7 @@ import unittest import warnings from django import template +from django.core.apps import app_cache from django.core import urlresolvers from django.template import (base as template_base, loader, Context, RequestContext, Template, TemplateSyntaxError) @@ -1873,24 +1874,26 @@ class TemplateTagLoading(TestCase): self.assertTrue('ImportError' in e.args[0]) self.assertTrue('Xtemplate' in e.args[0]) - @override_settings(INSTALLED_APPS=('tagsegg',)) def test_load_error_egg(self): ttext = "{% load broken_egg %}" egg_name = '%s/tagsegg.egg' % self.egg_dir sys.path.append(egg_name) - self.assertRaises(template.TemplateSyntaxError, template.Template, ttext) + with self.assertRaises(template.TemplateSyntaxError): + with app_cache._with_app('tagsegg'): + template.Template(ttext) try: - template.Template(ttext) + with app_cache._with_app('tagsegg'): + template.Template(ttext) except template.TemplateSyntaxError as e: self.assertTrue('ImportError' in e.args[0]) self.assertTrue('Xtemplate' in e.args[0]) - @override_settings(INSTALLED_APPS=('tagsegg',)) def test_load_working_egg(self): ttext = "{% load working_egg %}" egg_name = '%s/tagsegg.egg' % self.egg_dir sys.path.append(egg_name) - template.Template(ttext) + with app_cache._with_app('tagsegg'): + template.Template(ttext) class RequestContextTests(unittest.TestCase): diff --git a/tests/utils_tests/test_module_loading.py b/tests/utils_tests/test_module_loading.py index 5a7eadcedf..0c8dfe1e12 100644 --- a/tests/utils_tests/test_module_loading.py +++ b/tests/utils_tests/test_module_loading.py @@ -5,9 +5,9 @@ import sys import unittest from zipimport import zipimporter +from django.core.apps import app_cache from django.core.exceptions import ImproperlyConfigured from django.test import SimpleTestCase -from django.test.utils import override_settings from django.utils import six from django.utils.module_loading import autodiscover_modules, import_by_path, module_has_submodule from django.utils._os import upath @@ -135,9 +135,14 @@ class ModuleImportTestCase(unittest.TestCase): 'Should have more than the calling frame in the traceback.') -@override_settings(INSTALLED_APPS=('utils_tests.test_module',)) class AutodiscoverModulesTestCase(SimpleTestCase): + def setUp(self): + self._with_test_module = app_cache._begin_with_app('utils_tests.test_module') + + def tearDown(self): + app_cache._end_with_app(self._with_test_module) + def test_autodiscover_modules_found(self): autodiscover_modules('good_module') diff --git a/tests/view_tests/tests/test_i18n.py b/tests/view_tests/tests/test_i18n.py index 42f82251f5..19bbde286c 100644 --- a/tests/view_tests/tests/test_i18n.py +++ b/tests/view_tests/tests/test_i18n.py @@ -5,6 +5,7 @@ from os import path import unittest from django.conf import settings +from django.core.apps import app_cache from django.core.urlresolvers import reverse from django.test import LiveServerTestCase, TestCase from django.test.utils import override_settings @@ -115,9 +116,8 @@ class JsI18NTests(TestCase): available. The Javascript i18n view must return a NON empty language catalog with the proper English translations. See #13726 for more details. """ - extended_apps = list(settings.INSTALLED_APPS) + ['view_tests.app0'] - with self.settings(LANGUAGE_CODE='fr', INSTALLED_APPS=extended_apps): - with override('en-us'): + with app_cache._with_app('view_tests.app0'): + with self.settings(LANGUAGE_CODE='fr'), override('en-us'): response = self.client.get('/views/jsi18n_english_translation/') self.assertContains(response, javascript_quote('this app0 string is to be translated')) @@ -144,9 +144,8 @@ class JsI18NTestsMultiPackage(TestCase): translations of multiple Python packages is requested. See #13388, #3594 and #13514 for more details. """ - extended_apps = list(settings.INSTALLED_APPS) + ['view_tests.app1', 'view_tests.app2'] - with self.settings(LANGUAGE_CODE='en-us', INSTALLED_APPS=extended_apps): - with override('fr'): + with app_cache._with_app('view_tests.app1'), app_cache._with_app('view_tests.app2'): + with self.settings(LANGUAGE_CODE='en-us'), override('fr'): response = self.client.get('/views/jsi18n_multi_packages1/') self.assertContains(response, javascript_quote('il faut traduire cette chaîne de caractères de app1')) @@ -155,9 +154,8 @@ class JsI18NTestsMultiPackage(TestCase): Similar to above but with neither default or requested language being English. """ - extended_apps = list(settings.INSTALLED_APPS) + ['view_tests.app3', 'view_tests.app4'] - with self.settings(LANGUAGE_CODE='fr', INSTALLED_APPS=extended_apps): - with override('es-ar'): + with app_cache._with_app('view_tests.app3'), app_cache._with_app('view_tests.app4'): + with self.settings(LANGUAGE_CODE='fr'), override('es-ar'): response = self.client.get('/views/jsi18n_multi_packages2/') self.assertContains(response, javascript_quote('este texto de app3 debe ser traducido')) From 70c9654d454fe7a2206319a20e0b4158a6de639d Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 19 Dec 2013 21:36:02 +0100 Subject: [PATCH 014/208] Renamed registered_model to has_model. This avoids possible confusion with register_model. Thanks Marc Tamlyn for the suggestion. --- django/core/apps/cache.py | 6 +++--- django/db/models/base.py | 4 ++-- django/db/models/fields/related.py | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/django/core/apps/cache.py b/django/core/apps/cache.py index 0eddbed935..41196e5f05 100644 --- a/django/core/apps/cache.py +++ b/django/core/apps/cache.py @@ -298,12 +298,12 @@ class AppCache(object): models[model_name] = model self._get_models_cache.clear() - def registered_model(self, app_label, model_name): + def has_model(self, app_label, model_name): """ - Test if a model is registered and return the model class or None. + Returns the model class if one is registered and None otherwise. It's safe to call this method at import time, even while the app cache - is being populated. + is being populated. It returns None for models that aren't loaded yet. """ return self.all_models[app_label].get(model_name.lower()) diff --git a/django/db/models/base.py b/django/db/models/base.py index d1e7323d17..5599d81b4b 100644 --- a/django/db/models/base.py +++ b/django/db/models/base.py @@ -151,7 +151,7 @@ class ModelBase(type): new_class._base_manager = new_class._base_manager._copy_to_model(new_class) # Bail out early if we have already created this class. - m = new_class._meta.app_cache.registered_model(new_class._meta.app_label, name) + m = new_class._meta.app_cache.has_model(new_class._meta.app_label, name) if m is not None: return m @@ -278,7 +278,7 @@ class ModelBase(type): # the first time this model tries to register with the framework. There # should only be one class for each model, so we always return the # registered version. - return new_class._meta.app_cache.registered_model(new_class._meta.app_label, name) + return new_class._meta.app_cache.has_model(new_class._meta.app_label, name) def copy_managers(cls, base_managers): # This is in-place sorting of an Options attribute, but that's fine. diff --git a/django/db/models/fields/related.py b/django/db/models/fields/related.py index cf35504afe..0218c8c693 100644 --- a/django/db/models/fields/related.py +++ b/django/db/models/fields/related.py @@ -68,7 +68,7 @@ def add_lazy_relation(cls, field, relation, operation): # string right away. If get_model returns None, it means that the related # model isn't loaded yet, so we need to pend the relation until the class # is prepared. - model = cls._meta.app_cache.registered_model(app_label, model_name) + model = cls._meta.app_cache.has_model(app_label, model_name) if model: operation(field, model, cls) else: From 9cdf1f6d547b6dffcee26f0a525429452551bb4a Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 19 Dec 2013 21:57:09 +0100 Subject: [PATCH 015/208] Stop testing for inclusion in INSTALLED_APPS. Removed some exception masking in the comments app that was harmful and couldn't be preserved easily. --- .../admin/templatetags/admin_static.py | 4 +- django/contrib/comments/__init__.py | 19 +++---- django/contrib/messages/tests/base.py | 53 +++++++++---------- django/contrib/redirects/middleware.py | 3 +- django/contrib/redirects/tests.py | 9 ++-- .../contrib/sitemaps/tests/test_flatpages.py | 3 +- django/contrib/sitemaps/tests/test_http.py | 2 +- django/core/apps/cache.py | 12 +++++ django/test/client.py | 5 +- tests/comment_tests/tests/test_app_api.py | 21 +++----- 10 files changed, 66 insertions(+), 65 deletions(-) diff --git a/django/contrib/admin/templatetags/admin_static.py b/django/contrib/admin/templatetags/admin_static.py index 5ea3ba5838..75b077057e 100644 --- a/django/contrib/admin/templatetags/admin_static.py +++ b/django/contrib/admin/templatetags/admin_static.py @@ -1,9 +1,9 @@ -from django.conf import settings +from django.core.apps import app_cache from django.template import Library register = Library() -if 'django.contrib.staticfiles' in settings.INSTALLED_APPS: +if app_cache.has_app('django.contrib.staticfiles'): from django.contrib.staticfiles.templatetags.staticfiles import static else: from django.templatetags.static import static diff --git a/django/contrib/comments/__init__.py b/django/contrib/comments/__init__.py index 56ed32bafe..8d4b922966 100644 --- a/django/contrib/comments/__init__.py +++ b/django/contrib/comments/__init__.py @@ -2,6 +2,7 @@ from importlib import import_module import warnings from django.conf import settings from django.core import urlresolvers +from django.core.apps import app_cache from django.core.exceptions import ImproperlyConfigured from django.contrib.comments.models import Comment from django.contrib.comments.forms import CommentForm @@ -14,20 +15,12 @@ def get_comment_app(): """ Get the comment app (i.e. "django.contrib.comments") as defined in the settings """ - # Make sure the app's in INSTALLED_APPS - comments_app = get_comment_app_name() - if comments_app not in settings.INSTALLED_APPS: - raise ImproperlyConfigured("The COMMENTS_APP (%r) "\ - "must be in INSTALLED_APPS" % settings.COMMENTS_APP) - - # Try to import the package try: - package = import_module(comments_app) - except ImportError as e: - raise ImproperlyConfigured("The COMMENTS_APP setting refers to "\ - "a non-existing package. (%s)" % e) - - return package + app_config = app_cache.get_app_config(get_comment_app_name().rpartition(".")[2]) + except LookupError: + raise ImproperlyConfigured("The COMMENTS_APP (%r) " + "must be in INSTALLED_APPS" % settings.COMMENTS_APP) + return app_config.app_module def get_comment_app_name(): """ diff --git a/django/contrib/messages/tests/base.py b/django/contrib/messages/tests/base.py index f3e676fac5..8d7906ba52 100644 --- a/django/contrib/messages/tests/base.py +++ b/django/contrib/messages/tests/base.py @@ -1,4 +1,4 @@ -from unittest import skipIf +from unittest import skipUnless from django import http from django.conf import settings, global_settings @@ -7,14 +7,15 @@ from django.contrib.messages.api import MessageFailure from django.contrib.messages.constants import DEFAULT_LEVELS from django.contrib.messages.storage import default_storage, base from django.contrib.messages.storage.base import Message +from django.core.apps import app_cache from django.core.urlresolvers import reverse from django.test.utils import override_settings from django.utils.translation import ugettext_lazy def skipUnlessAuthIsInstalled(func): - return skipIf( - 'django.contrib.auth' not in settings.INSTALLED_APPS, + return skipUnless( + app_cache.has_app('django.contrib.auth'), "django.contrib.auth isn't installed")(func) @@ -219,8 +220,6 @@ class BaseTests(object): self.assertContains(response, msg) @override_settings( - INSTALLED_APPS=filter( - lambda app: app != 'django.contrib.messages', settings.INSTALLED_APPS), MIDDLEWARE_CLASSES=filter( lambda m: 'MessageMiddleware' not in m, settings.MIDDLEWARE_CLASSES), TEMPLATE_CONTEXT_PROCESSORS=filter( @@ -233,19 +232,18 @@ class BaseTests(object): Tests that, when the middleware is disabled, an exception is raised when one attempts to store a message. """ - data = { - 'messages': ['Test message %d' % x for x in range(5)], - } - reverse('django.contrib.messages.tests.urls.show') - for level in ('debug', 'info', 'success', 'warning', 'error'): - add_url = reverse('django.contrib.messages.tests.urls.add', - args=(level,)) - self.assertRaises(MessageFailure, self.client.post, add_url, - data, follow=True) + with app_cache._without_app('django.contrib.messages'): + data = { + 'messages': ['Test message %d' % x for x in range(5)], + } + reverse('django.contrib.messages.tests.urls.show') + for level in ('debug', 'info', 'success', 'warning', 'error'): + add_url = reverse('django.contrib.messages.tests.urls.add', + args=(level,)) + self.assertRaises(MessageFailure, self.client.post, add_url, + data, follow=True) @override_settings( - INSTALLED_APPS=filter( - lambda app: app != 'django.contrib.messages', settings.INSTALLED_APPS), MIDDLEWARE_CLASSES=filter( lambda m: 'MessageMiddleware' not in m, settings.MIDDLEWARE_CLASSES), TEMPLATE_CONTEXT_PROCESSORS=filter( @@ -258,17 +256,18 @@ class BaseTests(object): Tests that, when the middleware is disabled, an exception is not raised if 'fail_silently' = True """ - data = { - 'messages': ['Test message %d' % x for x in range(5)], - 'fail_silently': True, - } - show_url = reverse('django.contrib.messages.tests.urls.show') - for level in ('debug', 'info', 'success', 'warning', 'error'): - add_url = reverse('django.contrib.messages.tests.urls.add', - args=(level,)) - response = self.client.post(add_url, data, follow=True) - self.assertRedirects(response, show_url) - self.assertFalse('messages' in response.context) + with app_cache._without_app('django.contrib.messages'): + data = { + 'messages': ['Test message %d' % x for x in range(5)], + 'fail_silently': True, + } + show_url = reverse('django.contrib.messages.tests.urls.show') + for level in ('debug', 'info', 'success', 'warning', 'error'): + add_url = reverse('django.contrib.messages.tests.urls.add', + args=(level,)) + response = self.client.post(add_url, data, follow=True) + self.assertRedirects(response, show_url) + self.assertFalse('messages' in response.context) def stored_messages_count(self, storage, response): """ diff --git a/django/contrib/redirects/middleware.py b/django/contrib/redirects/middleware.py index 9053c64a9a..e8aa06ebb1 100644 --- a/django/contrib/redirects/middleware.py +++ b/django/contrib/redirects/middleware.py @@ -3,6 +3,7 @@ from __future__ import unicode_literals from django.conf import settings from django.contrib.redirects.models import Redirect from django.contrib.sites.models import get_current_site +from django.core.apps import app_cache from django.core.exceptions import ImproperlyConfigured from django import http @@ -14,7 +15,7 @@ class RedirectFallbackMiddleware(object): response_redirect_class = http.HttpResponsePermanentRedirect def __init__(self): - if 'django.contrib.sites' not in settings.INSTALLED_APPS: + if not app_cache.has_app('django.contrib.sites'): raise ImproperlyConfigured( "You cannot use RedirectFallbackMiddleware when " "django.contrib.sites is not installed." diff --git a/django/contrib/redirects/tests.py b/django/contrib/redirects/tests.py index 84638d6ab6..8566a34c68 100644 --- a/django/contrib/redirects/tests.py +++ b/django/contrib/redirects/tests.py @@ -1,6 +1,7 @@ from django import http from django.conf import settings from django.contrib.sites.models import Site +from django.core.apps import app_cache from django.core.exceptions import ImproperlyConfigured from django.test import TestCase from django.test.utils import override_settings @@ -56,12 +57,10 @@ class RedirectTests(TestCase): response = self.client.get('/initial') self.assertEqual(response.status_code, 410) - @override_settings( - INSTALLED_APPS=[app for app in settings.INSTALLED_APPS - if app != 'django.contrib.sites']) def test_sites_not_installed(self): - with self.assertRaises(ImproperlyConfigured): - RedirectFallbackMiddleware() + with app_cache._without_app('django.contrib.sites'): + with self.assertRaises(ImproperlyConfigured): + RedirectFallbackMiddleware() class OverriddenRedirectFallbackMiddleware(RedirectFallbackMiddleware): diff --git a/django/contrib/sitemaps/tests/test_flatpages.py b/django/contrib/sitemaps/tests/test_flatpages.py index 75ebb10f96..33ba168a45 100644 --- a/django/contrib/sitemaps/tests/test_flatpages.py +++ b/django/contrib/sitemaps/tests/test_flatpages.py @@ -3,13 +3,14 @@ from __future__ import unicode_literals from unittest import skipUnless from django.conf import settings +from django.core.apps import app_cache from .base import SitemapTestsBase class FlatpagesSitemapTests(SitemapTestsBase): - @skipUnless("django.contrib.flatpages" in settings.INSTALLED_APPS, + @skipUnless(app_cache.has_app('django.contrib.flatpages'), "django.contrib.flatpages app not installed.") def test_flatpage_sitemap(self): "Basic FlatPage sitemap test" diff --git a/django/contrib/sitemaps/tests/test_http.py b/django/contrib/sitemaps/tests/test_http.py index ed61c9950b..94d9adea49 100644 --- a/django/contrib/sitemaps/tests/test_http.py +++ b/django/contrib/sitemaps/tests/test_http.py @@ -118,7 +118,7 @@ class HTTPSitemapTests(SitemapTestsBase): """ % date.today() self.assertXMLEqual(response.content.decode('utf-8'), expected_content) - @skipUnless("django.contrib.sites" in settings.INSTALLED_APPS, + @skipUnless(app_cache.has_app('django.contrib.sites'), "django.contrib.sites app not installed.") def test_sitemap_get_urls_no_site_1(self): """ diff --git a/django/core/apps/cache.py b/django/core/apps/cache.py index 41196e5f05..697cf9e516 100644 --- a/django/core/apps/cache.py +++ b/django/core/apps/cache.py @@ -298,6 +298,18 @@ class AppCache(object): models[model_name] = model self._get_models_cache.clear() + def has_app(self, app_name): + """ + Returns the application config if one is registered and None otherwise. + + It's safe to call this method at import time, even while the app cache + is being populated. It returns None for apps that aren't loaded yet. + """ + app_config = self.app_configs.get(app_name.rpartition(".")[2]) + if app_config is not None and app_config.name != app_name: + app_config = None + return app_config + def has_model(self, app_label, model_name): """ Returns the model class if one is registered and None otherwise. diff --git a/django/test/client.py b/django/test/client.py index 8c9a17564c..cccc3ecc42 100644 --- a/django/test/client.py +++ b/django/test/client.py @@ -10,6 +10,7 @@ from io import BytesIO from django.conf import settings from django.contrib.auth import authenticate, login, logout, get_user_model +from django.core.apps import app_cache from django.core.handlers.base import BaseHandler from django.core.handlers.wsgi import WSGIRequest from django.core.signals import (request_started, request_finished, @@ -389,7 +390,7 @@ class Client(RequestFactory): """ Obtains the current session variables. """ - if 'django.contrib.sessions' in settings.INSTALLED_APPS: + if app_cache.has_app('django.contrib.sessions'): engine = import_module(settings.SESSION_ENGINE) cookie = self.cookies.get(settings.SESSION_COOKIE_NAME, None) if cookie: @@ -550,7 +551,7 @@ class Client(RequestFactory): """ user = authenticate(**credentials) if (user and user.is_active and - 'django.contrib.sessions' in settings.INSTALLED_APPS): + app_cache.has_app('django.contrib.sessions')): engine = import_module(settings.SESSION_ENGINE) # Create a fake request that goes through request middleware diff --git a/tests/comment_tests/tests/test_app_api.py b/tests/comment_tests/tests/test_app_api.py index 384802d1b2..645daf123d 100644 --- a/tests/comment_tests/tests/test_app_api.py +++ b/tests/comment_tests/tests/test_app_api.py @@ -2,6 +2,7 @@ from django.conf import settings from django.contrib import comments from django.contrib.comments.models import Comment from django.contrib.comments.forms import CommentForm +from django.core.apps import app_cache from django.core.exceptions import ImproperlyConfigured from django.test.utils import override_settings from django.utils import six @@ -15,14 +16,6 @@ class CommentAppAPITests(CommentTestCase): def testGetCommentApp(self): self.assertEqual(comments.get_comment_app(), comments) - @override_settings( - COMMENTS_APP='missing_app', - INSTALLED_APPS=list(settings.INSTALLED_APPS) + ['missing_app'], - ) - def testGetMissingCommentApp(self): - with six.assertRaisesRegex(self, ImproperlyConfigured, 'missing_app'): - comments.get_comment_app() - def testGetForm(self): self.assertEqual(comments.get_form(), CommentForm) @@ -42,14 +35,16 @@ class CommentAppAPITests(CommentTestCase): self.assertEqual(comments.get_approve_url(c), "/approve/12345/") -@override_settings( - COMMENTS_APP='comment_tests.custom_comments', - INSTALLED_APPS=list(settings.INSTALLED_APPS) + [ - 'comment_tests.custom_comments'], -) +@override_settings(COMMENTS_APP='comment_tests.custom_comments') class CustomCommentTest(CommentTestCase): urls = 'comment_tests.urls' + def setUp(self): + self._with_custom_comments = app_cache._begin_with_app('comment_tests.custom_comments') + + def tearDown(self): + app_cache._end_with_app(self._with_custom_comments) + def testGetCommentApp(self): from comment_tests import custom_comments self.assertEqual(comments.get_comment_app(), custom_comments) From 2239081ff16aab1eaafea003433f7139bf13e097 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 19 Dec 2013 22:33:46 +0100 Subject: [PATCH 016/208] Expurged INSTALLED_APPS from code and tests. Except the app cache code and a few specific tests, of course. --- django/contrib/admin/sites.py | 16 +++++++--------- tests/migrations/test_writer.py | 15 +++++++-------- tests/proxy_model_inheritance/tests.py | 18 ++++++++---------- tests/staticfiles_tests/tests.py | 6 +++--- tests/utils_tests/test_autoreload.py | 13 ++++++++----- 5 files changed, 33 insertions(+), 35 deletions(-) diff --git a/django/contrib/admin/sites.py b/django/contrib/admin/sites.py index 7b633bef89..a4caa863eb 100644 --- a/django/contrib/admin/sites.py +++ b/django/contrib/admin/sites.py @@ -6,6 +6,7 @@ from django.contrib.auth import logout as auth_logout, REDIRECT_FIELD_NAME from django.contrib.contenttypes import views as contenttype_views from django.views.decorators.csrf import csrf_protect from django.db.models.base import ModelBase +from django.core.apps import app_cache from django.core.exceptions import ImproperlyConfigured, PermissionDenied from django.core.urlresolvers import reverse, NoReverseMatch from django.template.response import TemplateResponse @@ -156,20 +157,17 @@ class AdminSite(object): """ Check that all things needed to run the admin have been correctly installed. - The default implementation checks that LogEntry, ContentType and the - auth context processor are installed. + The default implementation checks that admin and contenttypes apps are + installed, as well as the auth context processor. """ - from django.contrib.admin.models import LogEntry - from django.contrib.contenttypes.models import ContentType - - if not LogEntry._meta.installed: + app_cache.populate_apps() + if not app_cache.has_app('django.contrib.admin'): raise ImproperlyConfigured("Put 'django.contrib.admin' in your " "INSTALLED_APPS setting in order to use the admin application.") - if not ContentType._meta.installed: + if not app_cache.has_app('django.contrib.contenttypes'): raise ImproperlyConfigured("Put 'django.contrib.contenttypes' in " "your INSTALLED_APPS setting in order to use the admin application.") - if not ('django.contrib.auth.context_processors.auth' in settings.TEMPLATE_CONTEXT_PROCESSORS or - 'django.core.context_processors.auth' in settings.TEMPLATE_CONTEXT_PROCESSORS): + if 'django.contrib.auth.context_processors.auth' not in settings.TEMPLATE_CONTEXT_PROCESSORS: raise ImproperlyConfigured("Put 'django.contrib.auth.context_processors.auth' " "in your TEMPLATE_CONTEXT_PROCESSORS setting in order to use the admin application.") diff --git a/tests/migrations/test_writer.py b/tests/migrations/test_writer.py index f921f9f03c..3f46703207 100644 --- a/tests/migrations/test_writer.py +++ b/tests/migrations/test_writer.py @@ -9,7 +9,7 @@ from django.core.apps import app_cache from django.core.validators import RegexValidator, EmailValidator from django.db import models, migrations from django.db.migrations.writer import MigrationWriter -from django.test import TestCase, override_settings +from django.test import TestCase from django.utils import six from django.utils.deconstruct import deconstructible from django.utils.translation import ugettext_lazy as _ @@ -122,10 +122,9 @@ class WriterTests(TestCase): base_dir = os.path.dirname(os.path.dirname(__file__)) - with override_settings(INSTALLED_APPS=test_apps): - for app in test_apps: - with app_cache._with_app(app): - migration = migrations.Migration('0001_initial', app.split('.')[-1]) - expected_path = os.path.join(base_dir, *(app.split('.') + ['migrations', '0001_initial.py'])) - writer = MigrationWriter(migration) - self.assertEqual(writer.path, expected_path) + for app in test_apps: + with app_cache._with_app(app): + migration = migrations.Migration('0001_initial', app.split('.')[-1]) + expected_path = os.path.join(base_dir, *(app.split('.') + ['migrations', '0001_initial.py'])) + writer = MigrationWriter(migration) + self.assertEqual(writer.path, expected_path) diff --git a/tests/proxy_model_inheritance/tests.py b/tests/proxy_model_inheritance/tests.py index 01a2ddfef6..91fcbbcc09 100644 --- a/tests/proxy_model_inheritance/tests.py +++ b/tests/proxy_model_inheritance/tests.py @@ -13,7 +13,8 @@ from .models import (ConcreteModel, ConcreteModelSubclass, ConcreteModelSubclassProxy) -@override_settings(INSTALLED_APPS=('app1', 'app2')) +# Required for available_apps. +@override_settings(INSTALLED_APPS=['app1', 'app2']) class ProxyModelInheritanceTests(TransactionTestCase): """ Proxy model inheritance across apps can result in migrate not creating the table @@ -25,20 +26,17 @@ class ProxyModelInheritanceTests(TransactionTestCase): def setUp(self): self.old_sys_path = sys.path[:] sys.path.append(os.path.dirname(os.path.abspath(upath(__file__)))) - self._with_app1 = app_cache._begin_with_app('app1') - self._with_app2 = app_cache._begin_with_app('app2') def tearDown(self): - app_cache._end_with_app(self._with_app1) - app_cache._end_with_app(self._with_app2) sys.path = self.old_sys_path def test_table_exists(self): - call_command('migrate', verbosity=0) - from .app1.models import ProxyModel - from .app2.models import NiceModel - self.assertEqual(NiceModel.objects.all().count(), 0) - self.assertEqual(ProxyModel.objects.all().count(), 0) + with app_cache._with_app('app1'), app_cache._with_app('app2'): + call_command('migrate', verbosity=0) + from .app1.models import ProxyModel + from .app2.models import NiceModel + self.assertEqual(NiceModel.objects.all().count(), 0) + self.assertEqual(ProxyModel.objects.all().count(), 0) class MultiTableInheritanceProxyTest(TestCase): diff --git a/tests/staticfiles_tests/tests.py b/tests/staticfiles_tests/tests.py index f5d871587c..3ad8249e76 100644 --- a/tests/staticfiles_tests/tests.py +++ b/tests/staticfiles_tests/tests.py @@ -298,7 +298,7 @@ class TestCollectionDryRun(CollectionTestCase, TestNoFilesCreated): class TestCollectionFilesOverride(CollectionTestCase): """ Test overriding duplicated files by ``collectstatic`` management command. - Check for proper handling of apps order in INSTALLED_APPS even if file modification + Check for proper handling of apps order in installed apps even if file modification dates are in different order: 'staticfiles_tests.apps.test', @@ -314,7 +314,7 @@ class TestCollectionFilesOverride(CollectionTestCase): # prepare duplicate of file2.txt from no_label app # this file will have modification time older than no_label/static/file2.txt # anyway it should be taken to STATIC_ROOT because 'test' app is before - # 'no_label' app in INSTALLED_APPS + # 'no_label' app in installed apps self.testfile_path = os.path.join(TEST_ROOT, 'apps', 'test', 'static', 'file2.txt') with open(self.testfile_path, 'w+') as f: f.write('duplicate of file2.txt') @@ -340,7 +340,7 @@ class TestCollectionFilesOverride(CollectionTestCase): self.assertFileContains('file2.txt', 'duplicate of file2.txt') # and now change modification time of no_label/static/file2.txt - # test app is first in INSTALLED_APPS so file2.txt should remain unmodified + # test app is first in installed apps so file2.txt should remain unmodified mtime = os.path.getmtime(self.testfile_path) atime = os.path.getatime(self.testfile_path) os.utime(self.orig_path, (mtime + 1, atime + 1)) diff --git a/tests/utils_tests/test_autoreload.py b/tests/utils_tests/test_autoreload.py index d6e22ad8ee..47c70fae92 100644 --- a/tests/utils_tests/test_autoreload.py +++ b/tests/utils_tests/test_autoreload.py @@ -2,6 +2,7 @@ import os from django import conf from django.contrib import admin +from django.core.apps import app_cache from django.test import TestCase, override_settings from django.utils.autoreload import gen_filenames @@ -27,7 +28,6 @@ class TestFilenameGenerator(TestCase): self.assertIn(os.path.join(LOCALE_PATH, 'nl', 'LC_MESSAGES', 'django.mo'), filenames) - @override_settings(INSTALLED_APPS=()) def test_project_root_locale(self): """ Test that gen_filenames also yields from the current directory (project @@ -36,19 +36,22 @@ class TestFilenameGenerator(TestCase): old_cwd = os.getcwd() os.chdir(os.path.dirname(__file__)) try: - filenames = list(gen_filenames()) + # Remove the current app from the app cache to guarantee that the + # files will be found thanks to the current working directory. + with app_cache._empty(): + filenames = list(gen_filenames()) self.assertIn( os.path.join(LOCALE_PATH, 'nl', 'LC_MESSAGES', 'django.mo'), filenames) finally: os.chdir(old_cwd) - @override_settings(INSTALLED_APPS=('django.contrib.admin',)) def test_app_locales(self): """ - Test that gen_filenames also yields from INSTALLED_APPS locales. + Test that gen_filenames also yields from locale dirs in installed apps. """ - filenames = list(gen_filenames()) + with app_cache._empty(), app_cache._with_app('django.contrib.admin'): + filenames = list(gen_filenames()) self.assertIn(os.path.join(os.path.dirname(admin.__file__), 'locale', 'nl', 'LC_MESSAGES', 'django.mo'), filenames) From 16aae35ca8508dff2e0b94da67b8c880fe98e9d1 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Fri, 20 Dec 2013 10:39:12 +0100 Subject: [PATCH 017/208] Improved set_available_apps() in several ways. - Tested consistency the current app_configs instead of INSTALLED_APPS. - Considered applications added with _with_app as available. - Added docstrings. --- django/core/apps/cache.py | 19 ++++++++++++++++++- tests/proxy_model_inheritance/tests.py | 5 +---- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/django/core/apps/cache.py b/django/core/apps/cache.py index 697cf9e516..92b9f8d8d4 100644 --- a/django/core/apps/cache.py +++ b/django/core/apps/cache.py @@ -320,14 +320,27 @@ class AppCache(object): return self.all_models[app_label].get(model_name.lower()) def set_available_apps(self, available): + """ + Restricts the set of installed apps used by get_app_config[s]. + + available must be an iterable of application names. + + Primarily used for performance optimization in TransactionTestCase. + """ + if self.available_apps is not None: + raise RuntimeError("set_available_apps() may be called only once " + "in a row; make sure it's paired with unset_available_apps()") available = set(available) - installed = set(settings.INSTALLED_APPS) + installed = set(app_config.name for app_config in self.get_app_configs()) if not available.issubset(installed): raise ValueError("Available apps isn't a subset of installed " "apps, extra apps: %s" % ", ".join(available - installed)) self.available_apps = available def unset_available_apps(self): + """ + Cancels a previous call to set_available_apps(). + """ self.available_apps = None ### DANGEROUS METHODS ### (only used to preserve existing tests) @@ -340,11 +353,15 @@ class AppCache(object): else: app_config.import_models(self.all_models[app_config.label]) self.app_configs[app_config.label] = app_config + if self.available_apps is not None: + self.available_apps.add(app_config.name) return app_config def _end_with_app(self, app_config): if app_config is not None: del self.app_configs[app_config.label] + if self.available_apps is not None: + self.available_apps.discard(app_config.name) @contextmanager def _with_app(self, app_name): diff --git a/tests/proxy_model_inheritance/tests.py b/tests/proxy_model_inheritance/tests.py index 91fcbbcc09..5f33ec2fee 100644 --- a/tests/proxy_model_inheritance/tests.py +++ b/tests/proxy_model_inheritance/tests.py @@ -6,22 +6,19 @@ import sys from django.core.apps import app_cache from django.core.management import call_command from django.test import TestCase, TransactionTestCase -from django.test.utils import override_settings from django.utils._os import upath from .models import (ConcreteModel, ConcreteModelSubclass, ConcreteModelSubclassProxy) -# Required for available_apps. -@override_settings(INSTALLED_APPS=['app1', 'app2']) class ProxyModelInheritanceTests(TransactionTestCase): """ Proxy model inheritance across apps can result in migrate not creating the table for the proxied model (as described in #12286). This test creates two dummy apps and calls migrate, then verifies that the table has been created. """ - available_apps = ['app1', 'app2'] + available_apps = [] def setUp(self): self.old_sys_path = sys.path[:] From 517c24bcfabcc704a6b3b3f1eb39b05a3cf41954 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Fri, 20 Dec 2013 10:44:32 +0100 Subject: [PATCH 018/208] Complained on override_settings(INSTALLED_APPS=...). Currently such overrides aren't reflected in the app cache. It would be possible to handle them. But that doesn't look like a very good API. It makes it complicated to express "add this app" and "remove this app", which are the most common operations on INSTALLED_APPS. --- django/test/signals.py | 2 +- tests/app_loading/tests.py | 13 ++++++++----- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/django/test/signals.py b/django/test/signals.py index 8086d50b32..0d6b7bedf1 100644 --- a/django/test/signals.py +++ b/django/test/signals.py @@ -17,7 +17,7 @@ setting_changed = Signal(providing_args=["setting", "value", "enter"]) # except for cases where the receiver is related to a contrib app. # Settings that may not work well when using 'override_settings' (#19031) -COMPLEX_OVERRIDE_SETTINGS = set(['DATABASES']) +COMPLEX_OVERRIDE_SETTINGS = set(['DATABASES', 'INSTALLED_APPS']) @receiver(setting_changed) diff --git a/tests/app_loading/tests.py b/tests/app_loading/tests.py index bb71ad84a2..dcd0fa34c0 100644 --- a/tests/app_loading/tests.py +++ b/tests/app_loading/tests.py @@ -3,6 +3,7 @@ from __future__ import unicode_literals import os import sys from unittest import TestCase +import warnings from django.core.apps import app_cache from django.core.apps.cache import AppCache @@ -77,11 +78,13 @@ class EggLoadingTest(TestCase): # Pretend we're the master app cache to test the population process. app_cache._apps_loaded = False app_cache._models_loaded = False - with override_settings(INSTALLED_APPS=('notexists',)): - with self.assertRaises(ImportError): - app_cache.get_model('notexists', 'nomodel') - with self.assertRaises(ImportError): - app_cache.get_model('notexists', 'nomodel') + with warnings.catch_warnings(): + warnings.filterwarnings("ignore", "Overriding setting INSTALLED_APPS") + with override_settings(INSTALLED_APPS=['notexists']): + with self.assertRaises(ImportError): + app_cache.get_model('notexists', 'nomodel') + with self.assertRaises(ImportError): + app_cache.get_model('notexists', 'nomodel') class GetModelsTest(TestCase): From 99bd39ef6e1017f75c71fc276f43a941fe6081ea Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Fri, 20 Dec 2013 14:03:14 +0100 Subject: [PATCH 019/208] Added the ability to supply custom app configs. --- django/core/apps/base.py | 79 ++++++++++++++++++++++++++++++-------- django/core/apps/cache.py | 6 +-- tests/test_runner/tests.py | 4 +- 3 files changed, 69 insertions(+), 20 deletions(-) diff --git a/django/core/apps/base.py b/django/core/apps/base.py index 2503d9e3ff..706ed54ef6 100644 --- a/django/core/apps/base.py +++ b/django/core/apps/base.py @@ -1,6 +1,7 @@ from importlib import import_module -from django.utils.module_loading import module_has_submodule +from django.core.exceptions import ImproperlyConfigured +from django.utils.module_loading import import_by_path, module_has_submodule from django.utils._os import upath @@ -14,16 +15,33 @@ class AppConfig(object): def __init__(self, app_name): # Full Python path to the application eg. 'django.contrib.admin'. - # This is the value that appears in INSTALLED_APPS. self.name = app_name + # Root module for the application eg. . + self.app_module = import_module(app_name) + + # The following attributes could be defined at the class level in a + # subclass, hence the test-and-set pattern. + # Last component of the Python path to the application eg. 'admin'. # This value must be unique across a Django project. - self.label = app_name.rpartition(".")[2] + if not hasattr(self, 'label'): + self.label = app_name.rpartition(".")[2] - # Root module eg. . - self.app_module = import_module(app_name) + # Human-readable name for the application eg. "Admin". + if not hasattr(self, 'verbose_name'): + self.verbose_name = self.label.title() + + # Filesystem path to the application directory eg. + # u'/usr/lib/python2.7/dist-packages/django/contrib/admin'. May be + # None if the application isn't a bona fide package eg. if it's an + # egg. Otherwise it's a unicode on Python 2 and a str on Python 3. + if not hasattr(self, 'path'): + try: + self.path = upath(self.app_module.__path__[0]) + except AttributeError: + self.path = None # Module containing models eg. . Set by import_models(). @@ -34,18 +52,49 @@ class AppConfig(object): # None to prevent accidental access before import_models() runs. self.models = None - # Filesystem path to the application directory eg. - # u'/usr/lib/python2.7/dist-packages/django/contrib/admin'. May be - # None if the application isn't a bona fide package eg. if it's an - # egg. Otherwise it's a unicode on Python 2 and a str on Python 3. - try: - self.path = upath(self.app_module.__path__[0]) - except AttributeError: - self.path = None - def __repr__(self): return '' % self.label + @classmethod + def create(cls, entry): + """ + Factory that creates an app config from an entry in INSTALLED_APPS. + """ + try: + # If import_module succeeds, entry is a path to an app module. + # Otherwise, entry is a path to an app config class or an error. + import_module(entry) + + except ImportError: + # Raise the original exception when entry cannot be a path to an + # app config class. Since module names are allowable here, the + # standard exception message from import_by_path is unsuitable. + if '.' not in entry: + raise + + cls = import_by_path(entry) + + # Check for obvious errors. (This check prevents duck typing, but + # it could be removed if it became a problem in practice.) + if not issubclass(cls, AppConfig): + raise ImproperlyConfigured( + "%r isn't a subclass of AppConfig." % entry) + + # Obtain app name here rather than in AppClass.__init__ to keep + # all error checking for entries in INSTALLED_APPS in one place. + try: + app_name = cls.name + except AttributeError: + raise ImproperlyConfigured( + "%r must supply a name attribute." % entry) + + # Entry is a path to an app config class. + return cls(app_name) + + else: + # Entry is a path to an app module. + return cls(entry) + def import_models(self, all_models): # Dictionary of models for this app, stored in the 'all_models' # attribute of the AppCache this AppConfig is attached to. Injected as diff --git a/django/core/apps/cache.py b/django/core/apps/cache.py index 92b9f8d8d4..056aa9a60b 100644 --- a/django/core/apps/cache.py +++ b/django/core/apps/cache.py @@ -83,7 +83,7 @@ class AppCache(object): # especially not other application modules, even indirectly. # Therefore we simply import them sequentially. for app_name in settings.INSTALLED_APPS: - app_config = AppConfig(app_name) + app_config = AppConfig.create(app_name) self.app_configs[app_config.label] = app_config self._apps_loaded = True @@ -347,7 +347,7 @@ class AppCache(object): def _begin_with_app(self, app_name): # Returns an opaque value that can be passed to _end_with_app(). - app_config = AppConfig(app_name) + app_config = AppConfig.create(app_name) if app_config.label in self.app_configs: return None else: @@ -412,7 +412,7 @@ class AppCache(object): warnings.warn( "load_app(app_name) is deprecated.", PendingDeprecationWarning, stacklevel=2) - app_config = AppConfig(app_name) + app_config = AppConfig.create(app_name) app_config.import_models(self.all_models[app_config.label]) self.app_configs[app_config.label] = app_config return app_config.models_module diff --git a/tests/test_runner/tests.py b/tests/test_runner/tests.py index a6dbeb0ae4..3c365b0225 100644 --- a/tests/test_runner/tests.py +++ b/tests/test_runner/tests.py @@ -226,7 +226,7 @@ class ModulesTestsPackages(IgnoreAllDeprecationWarningsMixin, unittest.TestCase) "Check that the get_tests helper function can find tests in a directory" from django.core.apps.base import AppConfig from django.test.simple import get_tests - app_config = AppConfig('test_runner.valid_app') + app_config = AppConfig.create('test_runner.valid_app') app_config.import_models({}) tests = get_tests(app_config) self.assertIsInstance(tests, types.ModuleType) @@ -235,7 +235,7 @@ class ModulesTestsPackages(IgnoreAllDeprecationWarningsMixin, unittest.TestCase) "Test for #12658 - Tests with ImportError's shouldn't fail silently" from django.core.apps.base import AppConfig from django.test.simple import get_tests - app_config = AppConfig('test_runner_invalid_app') + app_config = AppConfig.create('test_runner_invalid_app') app_config.import_models({}) with self.assertRaises(ImportError): get_tests(app_config) From 2fef9e5375b0267734392080858d9fced15ee2f9 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 22 Dec 2013 11:35:17 +0100 Subject: [PATCH 020/208] Moved apps back in the toplevel django namespace. Reverted 4a56a93cc458e9ab4dcab95d9f5067d4975dd1a2. --- django/{core => }/apps/__init__.py | 0 django/{core => }/apps/base.py | 0 django/{core => }/apps/cache.py | 0 django/contrib/admin/sites.py | 2 +- django/contrib/admin/templatetags/admin_static.py | 2 +- django/contrib/admin/validation.py | 2 +- django/contrib/admindocs/views.py | 2 +- django/contrib/auth/__init__.py | 2 +- django/contrib/auth/management/__init__.py | 2 +- django/contrib/auth/tests/test_management.py | 2 +- django/contrib/comments/__init__.py | 2 +- django/contrib/comments/views/comments.py | 2 +- django/contrib/contenttypes/management.py | 2 +- django/contrib/contenttypes/models.py | 2 +- django/contrib/contenttypes/tests.py | 2 +- django/contrib/gis/sitemaps/kml.py | 2 +- django/contrib/gis/sitemaps/views.py | 2 +- django/contrib/gis/tests/geoapp/test_feeds.py | 2 +- django/contrib/gis/tests/geoapp/test_sitemaps.py | 2 +- django/contrib/messages/tests/base.py | 2 +- django/contrib/redirects/middleware.py | 2 +- django/contrib/redirects/tests.py | 2 +- django/contrib/sitemaps/tests/test_flatpages.py | 2 +- django/contrib/sitemaps/tests/test_http.py | 2 +- django/contrib/sites/tests.py | 2 +- django/contrib/staticfiles/finders.py | 2 +- django/core/checks/compatibility/django_1_6_0.py | 2 +- django/core/management/__init__.py | 4 ++-- django/core/management/base.py | 2 +- django/core/management/commands/dumpdata.py | 4 ++-- django/core/management/commands/flush.py | 2 +- django/core/management/commands/loaddata.py | 2 +- django/core/management/commands/makemigrations.py | 2 +- django/core/management/commands/migrate.py | 2 +- django/core/management/commands/shell.py | 2 +- django/core/management/commands/sqlsequencereset.py | 2 +- django/core/management/sql.py | 2 +- django/core/management/validation.py | 2 +- django/core/serializers/base.py | 2 +- django/core/serializers/python.py | 2 +- django/core/serializers/xml_serializer.py | 2 +- django/db/backends/__init__.py | 6 +++--- django/db/backends/sqlite3/schema.py | 2 +- django/db/migrations/loader.py | 2 +- django/db/migrations/questioner.py | 2 +- django/db/migrations/recorder.py | 2 +- django/db/migrations/state.py | 2 +- django/db/migrations/writer.py | 2 +- django/db/models/base.py | 4 ++-- django/db/models/fields/__init__.py | 2 +- django/db/models/loading.py | 2 +- django/db/models/options.py | 2 +- django/db/models/signals.py | 2 +- django/db/utils.py | 2 +- django/template/base.py | 2 +- django/template/loaders/app_directories.py | 2 +- django/template/loaders/eggs.py | 2 +- django/test/client.py | 2 +- django/test/simple.py | 2 +- django/test/testcases.py | 2 +- django/utils/autoreload.py | 2 +- django/utils/module_loading.py | 2 +- django/utils/translation/trans_real.py | 2 +- django/views/i18n.py | 2 +- tests/admin_docs/tests.py | 2 +- tests/app_cache/models.py | 2 +- tests/app_cache/tests.py | 4 ++-- tests/app_loading/tests.py | 4 ++-- tests/bash_completion/tests.py | 2 +- tests/commands_sql/tests.py | 2 +- tests/comment_tests/tests/test_app_api.py | 2 +- tests/contenttypes_tests/tests.py | 2 +- tests/defer_regress/tests.py | 2 +- tests/i18n/tests.py | 2 +- tests/invalid_models_tests/tests.py | 2 +- tests/managers_regress/tests.py | 2 +- tests/migrations/models.py | 2 +- tests/migrations/test_commands.py | 2 +- tests/migrations/test_state.py | 2 +- tests/migrations/test_writer.py | 2 +- tests/no_models/tests.py | 2 +- tests/proxy_model_inheritance/tests.py | 2 +- tests/proxy_models/tests.py | 2 +- tests/runtests.py | 4 ++-- tests/schema/models.py | 2 +- tests/swappable_models/tests.py | 2 +- tests/tablespaces/tests.py | 2 +- tests/template_tests/test_loaders.py | 2 +- tests/template_tests/tests.py | 2 +- tests/test_runner/tests.py | 4 ++-- tests/test_suite_override/tests.py | 2 +- tests/utils_tests/test_autoreload.py | 2 +- tests/utils_tests/test_module_loading.py | 2 +- tests/validation/test_unique.py | 2 +- tests/view_tests/tests/test_i18n.py | 2 +- 95 files changed, 101 insertions(+), 101 deletions(-) rename django/{core => }/apps/__init__.py (100%) rename django/{core => }/apps/base.py (100%) rename django/{core => }/apps/cache.py (100%) diff --git a/django/core/apps/__init__.py b/django/apps/__init__.py similarity index 100% rename from django/core/apps/__init__.py rename to django/apps/__init__.py diff --git a/django/core/apps/base.py b/django/apps/base.py similarity index 100% rename from django/core/apps/base.py rename to django/apps/base.py diff --git a/django/core/apps/cache.py b/django/apps/cache.py similarity index 100% rename from django/core/apps/cache.py rename to django/apps/cache.py diff --git a/django/contrib/admin/sites.py b/django/contrib/admin/sites.py index a4caa863eb..d72666a257 100644 --- a/django/contrib/admin/sites.py +++ b/django/contrib/admin/sites.py @@ -6,7 +6,7 @@ from django.contrib.auth import logout as auth_logout, REDIRECT_FIELD_NAME from django.contrib.contenttypes import views as contenttype_views from django.views.decorators.csrf import csrf_protect from django.db.models.base import ModelBase -from django.core.apps import app_cache +from django.apps import app_cache from django.core.exceptions import ImproperlyConfigured, PermissionDenied from django.core.urlresolvers import reverse, NoReverseMatch from django.template.response import TemplateResponse diff --git a/django/contrib/admin/templatetags/admin_static.py b/django/contrib/admin/templatetags/admin_static.py index 75b077057e..7c7a5e5654 100644 --- a/django/contrib/admin/templatetags/admin_static.py +++ b/django/contrib/admin/templatetags/admin_static.py @@ -1,4 +1,4 @@ -from django.core.apps import app_cache +from django.apps import app_cache from django.template import Library register = Library() diff --git a/django/contrib/admin/validation.py b/django/contrib/admin/validation.py index ee945f73e5..18e3ad48f8 100644 --- a/django/contrib/admin/validation.py +++ b/django/contrib/admin/validation.py @@ -1,4 +1,4 @@ -from django.core.apps import app_cache +from django.apps import app_cache from django.core.exceptions import ImproperlyConfigured from django.db import models from django.db.models.fields import FieldDoesNotExist diff --git a/django/contrib/admindocs/views.py b/django/contrib/admindocs/views.py index 9e6dd85595..973c81ddaf 100644 --- a/django/contrib/admindocs/views.py +++ b/django/contrib/admindocs/views.py @@ -5,10 +5,10 @@ import re import warnings from django import template +from django.apps import app_cache from django.conf import settings from django.contrib import admin from django.contrib.admin.views.decorators import staff_member_required -from django.core.apps import app_cache from django.db import models from django.core.exceptions import ViewDoesNotExist from django.http import Http404 diff --git a/django/contrib/auth/__init__.py b/django/contrib/auth/__init__.py index d5fc14dd2a..3c5a40c184 100644 --- a/django/contrib/auth/__init__.py +++ b/django/contrib/auth/__init__.py @@ -123,7 +123,7 @@ def get_user_model(): """ Returns the User model that is active in this project. """ - from django.core.apps import app_cache + from django.apps import app_cache try: app_label, model_name = settings.AUTH_USER_MODEL.split('.') diff --git a/django/contrib/auth/management/__init__.py b/django/contrib/auth/management/__init__.py index ec963becc4..5f24bf069e 100644 --- a/django/contrib/auth/management/__init__.py +++ b/django/contrib/auth/management/__init__.py @@ -6,9 +6,9 @@ from __future__ import unicode_literals import getpass import unicodedata +from django.apps import app_cache, UnavailableApp from django.contrib.auth import (models as auth_app, get_permission_codename, get_user_model) -from django.core.apps import app_cache, UnavailableApp from django.core import exceptions from django.core.management.base import CommandError from django.db import DEFAULT_DB_ALIAS, router diff --git a/django/contrib/auth/tests/test_management.py b/django/contrib/auth/tests/test_management.py index d9de5a2ad0..c005e74442 100644 --- a/django/contrib/auth/tests/test_management.py +++ b/django/contrib/auth/tests/test_management.py @@ -1,6 +1,7 @@ from __future__ import unicode_literals from datetime import date +from django.apps import app_cache from django.contrib.auth import models, management from django.contrib.auth.management import create_permissions from django.contrib.auth.management.commands import changepassword @@ -8,7 +9,6 @@ from django.contrib.auth.models import User from django.contrib.auth.tests.custom_user import CustomUser from django.contrib.auth.tests.utils import skipIfCustomUser from django.contrib.contenttypes.models import ContentType -from django.core.apps import app_cache from django.core import exceptions from django.core.management import call_command from django.core.management.base import CommandError diff --git a/django/contrib/comments/__init__.py b/django/contrib/comments/__init__.py index 8d4b922966..f265875c36 100644 --- a/django/contrib/comments/__init__.py +++ b/django/contrib/comments/__init__.py @@ -1,8 +1,8 @@ from importlib import import_module import warnings +from django.apps import app_cache from django.conf import settings from django.core import urlresolvers -from django.core.apps import app_cache from django.core.exceptions import ImproperlyConfigured from django.contrib.comments.models import Comment from django.contrib.comments.forms import CommentForm diff --git a/django/contrib/comments/views/comments.py b/django/contrib/comments/views/comments.py index 294c7c8e42..5d7c543adb 100644 --- a/django/contrib/comments/views/comments.py +++ b/django/contrib/comments/views/comments.py @@ -1,9 +1,9 @@ from django import http +from django.apps import app_cache from django.conf import settings from django.contrib import comments from django.contrib.comments import signals from django.contrib.comments.views.utils import next_redirect, confirmation_view -from django.core.apps import app_cache from django.core.exceptions import ObjectDoesNotExist, ValidationError from django.db import models from django.shortcuts import render_to_response diff --git a/django/contrib/contenttypes/management.py b/django/contrib/contenttypes/management.py index 7ff08b70f8..35a8a7fdc8 100644 --- a/django/contrib/contenttypes/management.py +++ b/django/contrib/contenttypes/management.py @@ -1,5 +1,5 @@ +from django.apps import app_cache, UnavailableApp from django.contrib.contenttypes.models import ContentType -from django.core.apps import app_cache, UnavailableApp from django.db import DEFAULT_DB_ALIAS, router from django.db.models import signals from django.utils.encoding import smart_text diff --git a/django/contrib/contenttypes/models.py b/django/contrib/contenttypes/models.py index 98eae0219c..90dea5b811 100644 --- a/django/contrib/contenttypes/models.py +++ b/django/contrib/contenttypes/models.py @@ -1,4 +1,4 @@ -from django.core.apps import app_cache +from django.apps import app_cache from django.db import models from django.utils.translation import ugettext_lazy as _ from django.utils.encoding import smart_text, force_text diff --git a/django/contrib/contenttypes/tests.py b/django/contrib/contenttypes/tests.py index b194755b80..302cdbb5cf 100644 --- a/django/contrib/contenttypes/tests.py +++ b/django/contrib/contenttypes/tests.py @@ -1,9 +1,9 @@ from __future__ import unicode_literals +from django.apps import app_cache from django.contrib.contenttypes.models import ContentType from django.contrib.contenttypes.views import shortcut from django.contrib.sites.models import get_current_site -from django.core.apps import app_cache from django.db import models from django.http import HttpRequest, Http404 from django.test import TestCase diff --git a/django/contrib/gis/sitemaps/kml.py b/django/contrib/gis/sitemaps/kml.py index aa9ae69f5d..1e4fc82550 100644 --- a/django/contrib/gis/sitemaps/kml.py +++ b/django/contrib/gis/sitemaps/kml.py @@ -1,4 +1,4 @@ -from django.core.apps import app_cache +from django.apps import app_cache from django.core import urlresolvers from django.contrib.sitemaps import Sitemap from django.contrib.gis.db.models.fields import GeometryField diff --git a/django/contrib/gis/sitemaps/views.py b/django/contrib/gis/sitemaps/views.py index e55a371672..e68523981e 100644 --- a/django/contrib/gis/sitemaps/views.py +++ b/django/contrib/gis/sitemaps/views.py @@ -2,7 +2,7 @@ from __future__ import unicode_literals import warnings -from django.core.apps import app_cache +from django.apps import app_cache from django.http import HttpResponse, Http404 from django.template import loader from django.contrib.sites.models import get_current_site diff --git a/django/contrib/gis/tests/geoapp/test_feeds.py b/django/contrib/gis/tests/geoapp/test_feeds.py index 6f0d901a62..638944db63 100644 --- a/django/contrib/gis/tests/geoapp/test_feeds.py +++ b/django/contrib/gis/tests/geoapp/test_feeds.py @@ -3,11 +3,11 @@ from __future__ import unicode_literals from unittest import skipUnless from xml.dom import minidom +from django.apps import app_cache from django.conf import settings from django.contrib.sites.models import Site from django.contrib.gis.geos import HAS_GEOS from django.contrib.gis.tests.utils import HAS_SPATIAL_DB -from django.core.apps import app_cache from django.test import TestCase if HAS_GEOS: diff --git a/django/contrib/gis/tests/geoapp/test_sitemaps.py b/django/contrib/gis/tests/geoapp/test_sitemaps.py index 035d97af34..909a543bb6 100644 --- a/django/contrib/gis/tests/geoapp/test_sitemaps.py +++ b/django/contrib/gis/tests/geoapp/test_sitemaps.py @@ -6,11 +6,11 @@ from xml.dom import minidom import os import zipfile +from django.apps import app_cache from django.conf import settings from django.contrib.gis.geos import HAS_GEOS from django.contrib.gis.tests.utils import HAS_SPATIAL_DB from django.contrib.sites.models import Site -from django.core.apps import app_cache from django.test import TestCase from django.test.utils import IgnoreDeprecationWarningsMixin from django.utils._os import upath diff --git a/django/contrib/messages/tests/base.py b/django/contrib/messages/tests/base.py index 8d7906ba52..e03d229be3 100644 --- a/django/contrib/messages/tests/base.py +++ b/django/contrib/messages/tests/base.py @@ -1,13 +1,13 @@ from unittest import skipUnless from django import http +from django.apps import app_cache from django.conf import settings, global_settings from django.contrib.messages import constants, utils, get_level, set_level from django.contrib.messages.api import MessageFailure from django.contrib.messages.constants import DEFAULT_LEVELS from django.contrib.messages.storage import default_storage, base from django.contrib.messages.storage.base import Message -from django.core.apps import app_cache from django.core.urlresolvers import reverse from django.test.utils import override_settings from django.utils.translation import ugettext_lazy diff --git a/django/contrib/redirects/middleware.py b/django/contrib/redirects/middleware.py index e8aa06ebb1..c5b672659e 100644 --- a/django/contrib/redirects/middleware.py +++ b/django/contrib/redirects/middleware.py @@ -1,9 +1,9 @@ from __future__ import unicode_literals +from django.apps import app_cache from django.conf import settings from django.contrib.redirects.models import Redirect from django.contrib.sites.models import get_current_site -from django.core.apps import app_cache from django.core.exceptions import ImproperlyConfigured from django import http diff --git a/django/contrib/redirects/tests.py b/django/contrib/redirects/tests.py index 8566a34c68..0784a6a6f3 100644 --- a/django/contrib/redirects/tests.py +++ b/django/contrib/redirects/tests.py @@ -1,7 +1,7 @@ from django import http +from django.apps import app_cache from django.conf import settings from django.contrib.sites.models import Site -from django.core.apps import app_cache from django.core.exceptions import ImproperlyConfigured from django.test import TestCase from django.test.utils import override_settings diff --git a/django/contrib/sitemaps/tests/test_flatpages.py b/django/contrib/sitemaps/tests/test_flatpages.py index 33ba168a45..90172e558f 100644 --- a/django/contrib/sitemaps/tests/test_flatpages.py +++ b/django/contrib/sitemaps/tests/test_flatpages.py @@ -2,8 +2,8 @@ from __future__ import unicode_literals from unittest import skipUnless +from django.apps import app_cache from django.conf import settings -from django.core.apps import app_cache from .base import SitemapTestsBase diff --git a/django/contrib/sitemaps/tests/test_http.py b/django/contrib/sitemaps/tests/test_http.py index 94d9adea49..fca644538b 100644 --- a/django/contrib/sitemaps/tests/test_http.py +++ b/django/contrib/sitemaps/tests/test_http.py @@ -4,10 +4,10 @@ import os from datetime import date from unittest import skipUnless +from django.apps import app_cache from django.conf import settings from django.contrib.sitemaps import Sitemap, GenericSitemap from django.contrib.sites.models import Site -from django.core.apps import app_cache from django.core.exceptions import ImproperlyConfigured from django.test.utils import override_settings from django.utils.formats import localize diff --git a/django/contrib/sites/tests.py b/django/contrib/sites/tests.py index 8d76fd0d02..79bcae9aa6 100644 --- a/django/contrib/sites/tests.py +++ b/django/contrib/sites/tests.py @@ -1,8 +1,8 @@ from __future__ import unicode_literals +from django.apps import app_cache from django.conf import settings from django.contrib.sites.models import Site, RequestSite, get_current_site -from django.core.apps import app_cache from django.core.exceptions import ObjectDoesNotExist, ValidationError from django.http import HttpRequest from django.test import TestCase diff --git a/django/contrib/staticfiles/finders.py b/django/contrib/staticfiles/finders.py index cadc8bffa7..de907ef8ef 100644 --- a/django/contrib/staticfiles/finders.py +++ b/django/contrib/staticfiles/finders.py @@ -1,8 +1,8 @@ from collections import OrderedDict import os +from django.apps import app_cache from django.conf import settings -from django.core.apps import app_cache from django.core.exceptions import ImproperlyConfigured from django.core.files.storage import default_storage, Storage, FileSystemStorage from django.utils.functional import empty, LazyObject diff --git a/django/core/checks/compatibility/django_1_6_0.py b/django/core/checks/compatibility/django_1_6_0.py index fef8bc3a51..a42249de60 100644 --- a/django/core/checks/compatibility/django_1_6_0.py +++ b/django/core/checks/compatibility/django_1_6_0.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals -from django.core.apps import app_cache +from django.apps import app_cache from django.db import models diff --git a/django/core/management/__init__.py b/django/core/management/__init__.py index a7d074e149..bc81b8f9d2 100644 --- a/django/core/management/__init__.py +++ b/django/core/management/__init__.py @@ -117,7 +117,7 @@ def get_commands(): # Populate the app cache outside of the try/except block to avoid # catching ImproperlyConfigured errors that aren't caused by the # absence of a settings module. - from django.core.apps import app_cache + from django.apps import app_cache app_configs = app_cache.get_app_configs() apps = [app_config.name for app_config in app_configs] @@ -346,7 +346,7 @@ class ManagementUtility(object): elif cwords[0] in ('dumpdata', 'sql', 'sqlall', 'sqlclear', 'sqlcustom', 'sqlindexes', 'sqlsequencereset', 'test'): try: - from django.core.apps import app_cache + from django.apps import app_cache app_configs = app_cache.get_app_configs() # Get the last part of the dotted path as the app name. options += [(app_config.label, 0) for app_config in app_configs] diff --git a/django/core/management/base.py b/django/core/management/base.py index b9404ec1aa..101a486b40 100644 --- a/django/core/management/base.py +++ b/django/core/management/base.py @@ -341,7 +341,7 @@ class AppCommand(BaseCommand): args = '' def handle(self, *app_labels, **options): - from django.core.apps import app_cache + from django.apps import app_cache if not app_labels: raise CommandError('Enter at least one appname.') # Populate models and don't use only_with_models_module=True when diff --git a/django/core/management/commands/dumpdata.py b/django/core/management/commands/dumpdata.py index fa657bcd72..9aebb6c7d6 100644 --- a/django/core/management/commands/dumpdata.py +++ b/django/core/management/commands/dumpdata.py @@ -37,7 +37,7 @@ class Command(BaseCommand): args = '[appname appname.ModelName ...]' def handle(self, *app_labels, **options): - from django.core.apps import app_cache + from django.apps import app_cache format = options.get('format') indent = options.get('indent') @@ -162,7 +162,7 @@ def sort_dependencies(app_list): is serialized before a normal model, and any model with a natural key dependency has it's dependencies serialized first. """ - from django.core.apps import app_cache + from django.apps import app_cache # Process the list of models, and get the list of dependencies model_dependencies = [] models = set() diff --git a/django/core/management/commands/flush.py b/django/core/management/commands/flush.py index f13e948ae5..49007bf0a2 100644 --- a/django/core/management/commands/flush.py +++ b/django/core/management/commands/flush.py @@ -2,7 +2,7 @@ import sys from importlib import import_module from optparse import make_option -from django.core.apps import app_cache +from django.apps import app_cache from django.db import connections, router, transaction, DEFAULT_DB_ALIAS from django.core.management import call_command from django.core.management.base import NoArgsCommand, CommandError diff --git a/django/core/management/commands/loaddata.py b/django/core/management/commands/loaddata.py index ee88232d9f..bfeba68aa6 100644 --- a/django/core/management/commands/loaddata.py +++ b/django/core/management/commands/loaddata.py @@ -7,8 +7,8 @@ import warnings import zipfile from optparse import make_option +from django.apps import app_cache from django.conf import settings -from django.core.apps import app_cache from django.core import serializers from django.core.management.base import BaseCommand, CommandError from django.core.management.color import no_style diff --git a/django/core/management/commands/makemigrations.py b/django/core/management/commands/makemigrations.py index 3bd7ad42be..aaf0270840 100644 --- a/django/core/management/commands/makemigrations.py +++ b/django/core/management/commands/makemigrations.py @@ -3,7 +3,7 @@ import os import operator from optparse import make_option -from django.core.apps import app_cache +from django.apps import app_cache from django.core.management.base import BaseCommand, CommandError from django.db import connections, DEFAULT_DB_ALIAS, migrations from django.db.migrations.loader import MigrationLoader diff --git a/django/core/management/commands/migrate.py b/django/core/management/commands/migrate.py index c99f26aa0c..05b4a62e87 100644 --- a/django/core/management/commands/migrate.py +++ b/django/core/management/commands/migrate.py @@ -6,7 +6,7 @@ from importlib import import_module import itertools import traceback -from django.core.apps import app_cache +from django.apps import app_cache from django.core.management import call_command from django.core.management.base import BaseCommand, CommandError from django.core.management.color import no_style diff --git a/django/core/management/commands/shell.py b/django/core/management/commands/shell.py index 5c189ac980..12af814161 100644 --- a/django/core/management/commands/shell.py +++ b/django/core/management/commands/shell.py @@ -66,7 +66,7 @@ class Command(NoArgsCommand): def handle_noargs(self, **options): # XXX: (Temporary) workaround for ticket #1796: force early loading of all # models from installed apps. - from django.core.apps import app_cache + from django.apps import app_cache app_cache.get_models() use_plain = options.get('plain', False) diff --git a/django/core/management/commands/sqlsequencereset.py b/django/core/management/commands/sqlsequencereset.py index cc35030a91..24ec25e8ed 100644 --- a/django/core/management/commands/sqlsequencereset.py +++ b/django/core/management/commands/sqlsequencereset.py @@ -2,7 +2,7 @@ from __future__ import unicode_literals from optparse import make_option -from django.core.apps import app_cache +from django.apps import app_cache from django.core.management.base import AppCommand from django.db import connections, DEFAULT_DB_ALIAS diff --git a/django/core/management/sql.py b/django/core/management/sql.py index 0b6e38124e..b2500d3787 100644 --- a/django/core/management/sql.py +++ b/django/core/management/sql.py @@ -5,8 +5,8 @@ import os import re import warnings +from django.apps import app_cache from django.conf import settings -from django.core.apps import app_cache from django.core.management.base import CommandError from django.db import models, router diff --git a/django/core/management/validation.py b/django/core/management/validation.py index 1cedcb9925..2b27a7edce 100644 --- a/django/core/management/validation.py +++ b/django/core/management/validation.py @@ -26,7 +26,7 @@ def get_validation_errors(outfile, app=None): validates all models of all installed apps. Writes errors, if any, to outfile. Returns number of errors. """ - from django.core.apps import app_cache + from django.apps import app_cache from django.db import connection, models from django.db.models.deletion import SET_NULL, SET_DEFAULT diff --git a/django/core/serializers/base.py b/django/core/serializers/base.py index b0bc8138ab..d516656a69 100644 --- a/django/core/serializers/base.py +++ b/django/core/serializers/base.py @@ -3,7 +3,7 @@ Module for abstract serializer/unserializer base classes. """ import warnings -from django.core.apps import app_cache +from django.apps import app_cache from django.db import models from django.utils import six diff --git a/django/core/serializers/python.py b/django/core/serializers/python.py index 1e4c37e2ae..c8a2b7eff2 100644 --- a/django/core/serializers/python.py +++ b/django/core/serializers/python.py @@ -5,8 +5,8 @@ other serializers. """ from __future__ import unicode_literals +from django.apps import app_cache from django.conf import settings -from django.core.apps import app_cache from django.core.serializers import base from django.db import models, DEFAULT_DB_ALIAS from django.utils.encoding import smart_text, is_protected_type diff --git a/django/core/serializers/xml_serializer.py b/django/core/serializers/xml_serializer.py index 90ad2cf398..e9bea84bb1 100644 --- a/django/core/serializers/xml_serializer.py +++ b/django/core/serializers/xml_serializer.py @@ -4,8 +4,8 @@ XML serializer. from __future__ import unicode_literals +from django.apps import app_cache from django.conf import settings -from django.core.apps import app_cache from django.core.serializers import base from django.db import models, DEFAULT_DB_ALIAS from django.utils.xmlutils import SimplerXMLGenerator diff --git a/django/db/backends/__init__.py b/django/db/backends/__init__.py index adf3b236ac..86905afe77 100644 --- a/django/db/backends/__init__.py +++ b/django/db/backends/__init__.py @@ -1268,7 +1268,7 @@ class BaseDatabaseIntrospection(object): If only_existing is True, the resulting list will only include the tables that actually exist in the database. """ - from django.core.apps import app_cache + from django.apps import app_cache from django.db import router tables = set() for app_config in app_cache.get_app_configs(only_with_models_module=True): @@ -1289,7 +1289,7 @@ class BaseDatabaseIntrospection(object): def installed_models(self, tables): "Returns a set of all models represented by the provided list of table names." - from django.core.apps import app_cache + from django.apps import app_cache from django.db import router all_models = [] for app_config in app_cache.get_app_configs(only_with_models_module=True): @@ -1302,7 +1302,7 @@ class BaseDatabaseIntrospection(object): def sequence_list(self): "Returns a list of information about all DB sequences for all models in all apps." - from django.core.apps import app_cache + from django.apps import app_cache from django.db import models, router sequence_list = [] diff --git a/django/db/backends/sqlite3/schema.py b/django/db/backends/sqlite3/schema.py index e2b9603819..52ca2de8ed 100644 --- a/django/db/backends/sqlite3/schema.py +++ b/django/db/backends/sqlite3/schema.py @@ -1,4 +1,4 @@ -from django.core.apps.cache import AppCache +from django.apps.cache import AppCache from django.db.backends.schema import BaseDatabaseSchemaEditor from django.db.models.fields.related import ManyToManyField diff --git a/django/db/migrations/loader.py b/django/db/migrations/loader.py index 4c12e05add..9a54f14e75 100644 --- a/django/db/migrations/loader.py +++ b/django/db/migrations/loader.py @@ -2,7 +2,7 @@ from importlib import import_module import os import sys -from django.core.apps import app_cache +from django.apps import app_cache from django.db.migrations.recorder import MigrationRecorder from django.db.migrations.graph import MigrationGraph from django.utils import six diff --git a/django/db/migrations/questioner.py b/django/db/migrations/questioner.py index 8a11559993..4a860dcf7e 100644 --- a/django/db/migrations/questioner.py +++ b/django/db/migrations/questioner.py @@ -2,7 +2,7 @@ import importlib import os import sys -from django.core.apps import app_cache +from django.apps import app_cache from django.utils import datetime_safe from django.utils.six.moves import input diff --git a/django/db/migrations/recorder.py b/django/db/migrations/recorder.py index c2cfd2e9af..8b0403e88f 100644 --- a/django/db/migrations/recorder.py +++ b/django/db/migrations/recorder.py @@ -1,4 +1,4 @@ -from django.core.apps.cache import AppCache +from django.apps.cache import AppCache from django.db import models from django.utils.timezone import now diff --git a/django/db/migrations/state.py b/django/db/migrations/state.py index c43728d58e..a2716e864a 100644 --- a/django/db/migrations/state.py +++ b/django/db/migrations/state.py @@ -1,4 +1,4 @@ -from django.core.apps.cache import AppCache +from django.apps.cache import AppCache from django.db import models from django.db.models.options import DEFAULT_NAMES, normalize_unique_together from django.utils import six diff --git a/django/db/migrations/writer.py b/django/db/migrations/writer.py index 04e00501f9..a23a9b1253 100644 --- a/django/db/migrations/writer.py +++ b/django/db/migrations/writer.py @@ -5,7 +5,7 @@ from importlib import import_module import os import types -from django.core.apps import app_cache +from django.apps import app_cache from django.db import models from django.db.migrations.loader import MigrationLoader from django.utils.encoding import force_text diff --git a/django/db/models/base.py b/django/db/models/base.py index 5599d81b4b..3ae0fe34bd 100644 --- a/django/db/models/base.py +++ b/django/db/models/base.py @@ -5,8 +5,8 @@ import sys from functools import update_wrapper from django.utils.six.moves import zip -from django.core.apps import app_cache -from django.core.apps.base import MODELS_MODULE_NAME +from django.apps import app_cache +from django.apps.base import MODELS_MODULE_NAME import django.db.models.manager # NOQA: Imported to register signal handler. from django.conf import settings from django.core.exceptions import (ObjectDoesNotExist, diff --git a/django/db/models/fields/__init__.py b/django/db/models/fields/__init__.py index b24323d1cf..830ff2efa2 100644 --- a/django/db/models/fields/__init__.py +++ b/django/db/models/fields/__init__.py @@ -9,7 +9,7 @@ import warnings from base64 import b64decode, b64encode from itertools import tee -from django.core.apps import app_cache +from django.apps import app_cache from django.db import connection from django.db.models.query_utils import QueryWrapper from django.conf import settings diff --git a/django/db/models/loading.py b/django/db/models/loading.py index 00fae36769..4b58ba00b5 100644 --- a/django/db/models/loading.py +++ b/django/db/models/loading.py @@ -1,6 +1,6 @@ import warnings -from django.core.apps import app_cache +from django.apps import app_cache warnings.warn( "The utilities in django.db.models.loading are deprecated " diff --git a/django/db/models/options.py b/django/db/models/options.py index fec9aa4fc4..8f181c8854 100644 --- a/django/db/models/options.py +++ b/django/db/models/options.py @@ -5,8 +5,8 @@ import re from bisect import bisect import warnings +from django.apps import app_cache from django.conf import settings -from django.core.apps import app_cache from django.db.models.fields.related import ManyToManyRel from django.db.models.fields import AutoField, FieldDoesNotExist from django.db.models.fields.proxy import OrderWrt diff --git a/django/db/models/signals.py b/django/db/models/signals.py index a6822309a3..8c835e5f5f 100644 --- a/django/db/models/signals.py +++ b/django/db/models/signals.py @@ -1,6 +1,6 @@ from collections import defaultdict -from django.core.apps import app_cache +from django.apps import app_cache from django.dispatch import Signal from django.utils import six diff --git a/django/db/utils.py b/django/db/utils.py index 4d53d252bf..702b1b4ebc 100644 --- a/django/db/utils.py +++ b/django/db/utils.py @@ -282,6 +282,6 @@ class ConnectionRouter(object): """ Return app models allowed to be synchronized on provided db. """ - from django.core.apps import app_cache + from django.apps import app_cache return [model for model in app_cache.get_models(app, include_auto_created=include_auto_created) if self.allow_migrate(db, model)] diff --git a/django/template/base.py b/django/template/base.py index 7098ea60f8..197238b1e3 100644 --- a/django/template/base.py +++ b/django/template/base.py @@ -5,8 +5,8 @@ from functools import partial from importlib import import_module from inspect import getargspec, getcallargs +from django.apps import app_cache from django.conf import settings -from django.core.apps import app_cache from django.template.context import (BaseContext, Context, RequestContext, # NOQA: imported for backwards compatibility ContextPopException) from django.utils.itercompat import is_iterable diff --git a/django/template/loaders/app_directories.py b/django/template/loaders/app_directories.py index 90baa34c7a..ff3d3b93f8 100644 --- a/django/template/loaders/app_directories.py +++ b/django/template/loaders/app_directories.py @@ -6,8 +6,8 @@ packages. import os import sys +from django.apps import app_cache from django.conf import settings -from django.core.apps import app_cache from django.template.base import TemplateDoesNotExist from django.template.loader import BaseLoader from django.utils._os import safe_join diff --git a/django/template/loaders/eggs.py b/django/template/loaders/eggs.py index e9b46b15de..99c19aed93 100644 --- a/django/template/loaders/eggs.py +++ b/django/template/loaders/eggs.py @@ -6,8 +6,8 @@ try: except ImportError: resource_string = None +from django.apps import app_cache from django.conf import settings -from django.core.apps import app_cache from django.template.base import TemplateDoesNotExist from django.template.loader import BaseLoader from django.utils import six diff --git a/django/test/client.py b/django/test/client.py index cccc3ecc42..eea9b43010 100644 --- a/django/test/client.py +++ b/django/test/client.py @@ -8,9 +8,9 @@ from copy import copy from importlib import import_module from io import BytesIO +from django.apps import app_cache from django.conf import settings from django.contrib.auth import authenticate, login, logout, get_user_model -from django.core.apps import app_cache from django.core.handlers.base import BaseHandler from django.core.handlers.wsgi import WSGIRequest from django.core.signals import (request_started, request_finished, diff --git a/django/test/simple.py b/django/test/simple.py index 6129ce1305..f2d26376df 100644 --- a/django/test/simple.py +++ b/django/test/simple.py @@ -9,7 +9,7 @@ import re import unittest as real_unittest import warnings -from django.core.apps import app_cache +from django.apps import app_cache from django.test import _doctest as doctest from django.test import runner from django.test.utils import compare_xml, strip_quotes diff --git a/django/test/testcases.py b/django/test/testcases.py index 13f56fa6cc..1480889565 100644 --- a/django/test/testcases.py +++ b/django/test/testcases.py @@ -15,9 +15,9 @@ import unittest from unittest import skipIf # NOQA: Imported here for backward compatibility from unittest.util import safe_repr +from django.apps import app_cache from django.conf import settings from django.core import mail -from django.core.apps import app_cache from django.core.exceptions import ValidationError, ImproperlyConfigured from django.core.handlers.wsgi import get_path_info, WSGIHandler from django.core.management import call_command diff --git a/django/utils/autoreload.py b/django/utils/autoreload.py index 05ffb12f74..b7a889aa61 100644 --- a/django/utils/autoreload.py +++ b/django/utils/autoreload.py @@ -36,8 +36,8 @@ import sys import time import traceback +from django.apps import app_cache from django.conf import settings -from django.core.apps import app_cache from django.core.signals import request_finished try: from django.utils.six.moves import _thread as thread diff --git a/django/utils/module_loading.py b/django/utils/module_loading.py index 8d95fc00a3..c7826be5e5 100644 --- a/django/utils/module_loading.py +++ b/django/utils/module_loading.py @@ -58,7 +58,7 @@ def autodiscover_modules(*args, **kwargs): registry. This register_to object must have a _registry instance variable to access it. """ - from django.core.apps import app_cache + from django.apps import app_cache register_to = kwargs.get('register_to') for app_config in app_cache.get_app_configs(): diff --git a/django/utils/translation/trans_real.py b/django/utils/translation/trans_real.py index 3ed6371966..1eced98d31 100644 --- a/django/utils/translation/trans_real.py +++ b/django/utils/translation/trans_real.py @@ -10,7 +10,7 @@ import gettext as gettext_module from threading import local import warnings -from django.core.apps import app_cache +from django.apps import app_cache from django.dispatch import receiver from django.test.signals import setting_changed from django.utils.encoding import force_str, force_text diff --git a/django/views/i18n.py b/django/views/i18n.py index 2f0c89a037..2cc2e35e5e 100644 --- a/django/views/i18n.py +++ b/django/views/i18n.py @@ -4,8 +4,8 @@ import os import gettext as gettext_module from django import http +from django.apps import app_cache from django.conf import settings -from django.core.apps import app_cache from django.template import Context, Template from django.utils.translation import check_for_language, to_locale, get_language from django.utils.encoding import smart_text diff --git a/tests/admin_docs/tests.py b/tests/admin_docs/tests.py index 66c125490f..9e004a5a07 100644 --- a/tests/admin_docs/tests.py +++ b/tests/admin_docs/tests.py @@ -1,10 +1,10 @@ import unittest +from django.apps import app_cache from django.conf import settings from django.contrib.sites.models import Site from django.contrib.admindocs import utils from django.contrib.auth.models import User -from django.core.apps import app_cache from django.core.urlresolvers import reverse from django.test import TestCase from django.test.utils import override_settings diff --git a/tests/app_cache/models.py b/tests/app_cache/models.py index 10e9e6f1de..9306830f9c 100644 --- a/tests/app_cache/models.py +++ b/tests/app_cache/models.py @@ -1,4 +1,4 @@ -from django.core.apps.cache import AppCache +from django.apps.cache import AppCache from django.db import models # We're testing app cache presence on load, so this is handy. diff --git a/tests/app_cache/tests.py b/tests/app_cache/tests.py index a531a22e8b..43133ab38f 100644 --- a/tests/app_cache/tests.py +++ b/tests/app_cache/tests.py @@ -1,7 +1,7 @@ from __future__ import absolute_import -from django.core.apps import app_cache -from django.core.apps.cache import AppCache +from django.apps import app_cache +from django.apps.cache import AppCache from django.db import models from django.test import TestCase diff --git a/tests/app_loading/tests.py b/tests/app_loading/tests.py index dcd0fa34c0..0692597a5b 100644 --- a/tests/app_loading/tests.py +++ b/tests/app_loading/tests.py @@ -5,8 +5,8 @@ import sys from unittest import TestCase import warnings -from django.core.apps import app_cache -from django.core.apps.cache import AppCache +from django.apps import app_cache +from django.apps.cache import AppCache from django.test.utils import override_settings from django.utils._os import upath from django.utils import six diff --git a/tests/bash_completion/tests.py b/tests/bash_completion/tests.py index 85fb58904c..5a6a6c48d2 100644 --- a/tests/bash_completion/tests.py +++ b/tests/bash_completion/tests.py @@ -5,7 +5,7 @@ import os import sys import unittest -from django.core.apps import app_cache +from django.apps import app_cache from django.core.management import ManagementUtility from django.utils.six import StringIO diff --git a/tests/commands_sql/tests.py b/tests/commands_sql/tests.py index 3088ea4d48..1c2a7f0ffa 100644 --- a/tests/commands_sql/tests.py +++ b/tests/commands_sql/tests.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals -from django.core.apps import app_cache +from django.apps import app_cache from django.core.management.color import no_style from django.core.management.sql import (sql_create, sql_delete, sql_indexes, sql_destroy_indexes, sql_all) diff --git a/tests/comment_tests/tests/test_app_api.py b/tests/comment_tests/tests/test_app_api.py index 645daf123d..7098def28a 100644 --- a/tests/comment_tests/tests/test_app_api.py +++ b/tests/comment_tests/tests/test_app_api.py @@ -1,8 +1,8 @@ +from django.apps import app_cache from django.conf import settings from django.contrib import comments from django.contrib.comments.models import Comment from django.contrib.comments.forms import CommentForm -from django.core.apps import app_cache from django.core.exceptions import ImproperlyConfigured from django.test.utils import override_settings from django.utils import six diff --git a/tests/contenttypes_tests/tests.py b/tests/contenttypes_tests/tests.py index 9cc254e665..d3c19fd910 100644 --- a/tests/contenttypes_tests/tests.py +++ b/tests/contenttypes_tests/tests.py @@ -1,7 +1,7 @@ from __future__ import unicode_literals +from django.apps.cache import AppCache from django.contrib.contenttypes.models import ContentType -from django.core.apps.cache import AppCache from django.db import models from django.test import TestCase diff --git a/tests/defer_regress/tests.py b/tests/defer_regress/tests.py index 3e9651b2d2..442af9f7cf 100644 --- a/tests/defer_regress/tests.py +++ b/tests/defer_regress/tests.py @@ -2,9 +2,9 @@ from __future__ import unicode_literals from operator import attrgetter +from django.apps import app_cache from django.contrib.contenttypes.models import ContentType from django.contrib.sessions.backends.db import SessionStore -from django.core.apps import app_cache from django.db.models import Count from django.test import TestCase from django.test.utils import override_settings diff --git a/tests/i18n/tests.py b/tests/i18n/tests.py index 339317c541..8d8b5fbe9c 100644 --- a/tests/i18n/tests.py +++ b/tests/i18n/tests.py @@ -8,8 +8,8 @@ import os import pickle from threading import local +from django.apps import app_cache from django.conf import settings -from django.core.apps import app_cache from django.template import Template, Context from django.template.base import TemplateSyntaxError from django.test import TestCase, RequestFactory diff --git a/tests/invalid_models_tests/tests.py b/tests/invalid_models_tests/tests.py index 4e0cef546b..09c19d453c 100644 --- a/tests/invalid_models_tests/tests.py +++ b/tests/invalid_models_tests/tests.py @@ -1,7 +1,7 @@ import sys import unittest -from django.core.apps import app_cache +from django.apps import app_cache from django.core.management.validation import get_validation_errors from django.test.utils import override_settings from django.utils.six import StringIO diff --git a/tests/managers_regress/tests.py b/tests/managers_regress/tests.py index b9c8244612..9d7e0d8174 100644 --- a/tests/managers_regress/tests.py +++ b/tests/managers_regress/tests.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals -from django.core.apps import app_cache +from django.apps import app_cache from django.db import models from django.template import Context, Template from django.test import TestCase diff --git a/tests/migrations/models.py b/tests/migrations/models.py index cfc9604551..b1ef6c1dd1 100644 --- a/tests/migrations/models.py +++ b/tests/migrations/models.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- from __future__ import unicode_literals -from django.core.apps.cache import AppCache +from django.apps.cache import AppCache from django.db import models from django.utils.encoding import python_2_unicode_compatible diff --git a/tests/migrations/test_commands.py b/tests/migrations/test_commands.py index 13514cac91..fcb460decc 100644 --- a/tests/migrations/test_commands.py +++ b/tests/migrations/test_commands.py @@ -5,7 +5,7 @@ import codecs import os import shutil -from django.core.apps import app_cache +from django.apps import app_cache from django.core.management import call_command, CommandError from django.test.utils import override_settings from django.utils import six diff --git a/tests/migrations/test_state.py b/tests/migrations/test_state.py index 7a06ecd474..e695248cd2 100644 --- a/tests/migrations/test_state.py +++ b/tests/migrations/test_state.py @@ -1,4 +1,4 @@ -from django.core.apps.cache import AppCache +from django.apps.cache import AppCache from django.db import models from django.db.migrations.state import ProjectState, ModelState, InvalidBasesError from django.test import TestCase diff --git a/tests/migrations/test_writer.py b/tests/migrations/test_writer.py index 3f46703207..df3d052610 100644 --- a/tests/migrations/test_writer.py +++ b/tests/migrations/test_writer.py @@ -5,7 +5,7 @@ from __future__ import unicode_literals import datetime import os -from django.core.apps import app_cache +from django.apps import app_cache from django.core.validators import RegexValidator, EmailValidator from django.db import models, migrations from django.db.migrations.writer import MigrationWriter diff --git a/tests/no_models/tests.py b/tests/no_models/tests.py index 34ef724446..f9ff80485e 100644 --- a/tests/no_models/tests.py +++ b/tests/no_models/tests.py @@ -1,4 +1,4 @@ -from django.core.apps import app_cache +from django.apps import app_cache from django.test import TestCase diff --git a/tests/proxy_model_inheritance/tests.py b/tests/proxy_model_inheritance/tests.py index 5f33ec2fee..c0b564746d 100644 --- a/tests/proxy_model_inheritance/tests.py +++ b/tests/proxy_model_inheritance/tests.py @@ -3,7 +3,7 @@ from __future__ import unicode_literals import os import sys -from django.core.apps import app_cache +from django.apps import app_cache from django.core.management import call_command from django.test import TestCase, TransactionTestCase from django.utils._os import upath diff --git a/tests/proxy_models/tests.py b/tests/proxy_models/tests.py index 0995a778c0..800fc42e6d 100644 --- a/tests/proxy_models/tests.py +++ b/tests/proxy_models/tests.py @@ -1,9 +1,9 @@ from __future__ import unicode_literals +from django.apps import app_cache from django.contrib import admin from django.contrib.contenttypes.models import ContentType from django.core import management -from django.core.apps import app_cache from django.core.exceptions import FieldError from django.db import models, DEFAULT_DB_ALIAS from django.db.models import signals diff --git a/tests/runtests.py b/tests/runtests.py index 64d363a095..88973308cf 100755 --- a/tests/runtests.py +++ b/tests/runtests.py @@ -80,14 +80,14 @@ def get_test_modules(): def get_installed(): - from django.core.apps import app_cache + from django.apps import app_cache return [app_config.name for app_config in app_cache.get_app_configs()] def setup(verbosity, test_labels): import django + from django.apps import app_cache from django.conf import settings - from django.core.apps import app_cache from django.test import TransactionTestCase, TestCase print("Testing against Django installed in '%s'" % os.path.dirname(django.__file__)) diff --git a/tests/schema/models.py b/tests/schema/models.py index 8b24b88c05..b294647f9b 100644 --- a/tests/schema/models.py +++ b/tests/schema/models.py @@ -1,4 +1,4 @@ -from django.core.apps.cache import AppCache +from django.apps.cache import AppCache from django.db import models # Because we want to test creation and deletion of these as separate things, diff --git a/tests/swappable_models/tests.py b/tests/swappable_models/tests.py index fec9db5af8..0beb95af3e 100644 --- a/tests/swappable_models/tests.py +++ b/tests/swappable_models/tests.py @@ -2,9 +2,9 @@ from __future__ import unicode_literals from django.utils.six import StringIO +from django.apps import app_cache from django.contrib.auth.models import Permission from django.contrib.contenttypes.models import ContentType -from django.core.apps import app_cache from django.core import management from django.test import TestCase from django.test.utils import override_settings diff --git a/tests/tablespaces/tests.py b/tests/tablespaces/tests.py index fa90704c45..d761a93ab9 100644 --- a/tests/tablespaces/tests.py +++ b/tests/tablespaces/tests.py @@ -1,7 +1,7 @@ from __future__ import unicode_literals +from django.apps import app_cache from django.conf import settings -from django.core.apps import app_cache from django.db import connection from django.core.management.color import no_style from django.test import TestCase, skipIfDBFeature, skipUnlessDBFeature diff --git a/tests/template_tests/test_loaders.py b/tests/template_tests/test_loaders.py index 551bd7fb72..eadb3fb02a 100644 --- a/tests/template_tests/test_loaders.py +++ b/tests/template_tests/test_loaders.py @@ -20,7 +20,7 @@ except ImportError: pkg_resources = None -from django.core.apps import app_cache +from django.apps import app_cache from django.template import TemplateDoesNotExist, Context from django.template.loaders.eggs import Loader as EggLoader from django.template import loader diff --git a/tests/template_tests/tests.py b/tests/template_tests/tests.py index 61a46a81f9..4dc0925070 100644 --- a/tests/template_tests/tests.py +++ b/tests/template_tests/tests.py @@ -16,7 +16,7 @@ import unittest import warnings from django import template -from django.core.apps import app_cache +from django.apps import app_cache from django.core import urlresolvers from django.template import (base as template_base, loader, Context, RequestContext, Template, TemplateSyntaxError) diff --git a/tests/test_runner/tests.py b/tests/test_runner/tests.py index 3c365b0225..5393ea75a2 100644 --- a/tests/test_runner/tests.py +++ b/tests/test_runner/tests.py @@ -224,7 +224,7 @@ class ModulesTestsPackages(IgnoreAllDeprecationWarningsMixin, unittest.TestCase) def test_get_tests(self): "Check that the get_tests helper function can find tests in a directory" - from django.core.apps.base import AppConfig + from django.apps.base import AppConfig from django.test.simple import get_tests app_config = AppConfig.create('test_runner.valid_app') app_config.import_models({}) @@ -233,7 +233,7 @@ class ModulesTestsPackages(IgnoreAllDeprecationWarningsMixin, unittest.TestCase) def test_import_error(self): "Test for #12658 - Tests with ImportError's shouldn't fail silently" - from django.core.apps.base import AppConfig + from django.apps.base import AppConfig from django.test.simple import get_tests app_config = AppConfig.create('test_runner_invalid_app') app_config.import_models({}) diff --git a/tests/test_suite_override/tests.py b/tests/test_suite_override/tests.py index b464659275..9666df1c19 100644 --- a/tests/test_suite_override/tests.py +++ b/tests/test_suite_override/tests.py @@ -1,6 +1,6 @@ import unittest -from django.core.apps import app_cache +from django.apps import app_cache from django.test.utils import IgnoreAllDeprecationWarningsMixin diff --git a/tests/utils_tests/test_autoreload.py b/tests/utils_tests/test_autoreload.py index 47c70fae92..5071566e92 100644 --- a/tests/utils_tests/test_autoreload.py +++ b/tests/utils_tests/test_autoreload.py @@ -1,8 +1,8 @@ import os from django import conf +from django.apps import app_cache from django.contrib import admin -from django.core.apps import app_cache from django.test import TestCase, override_settings from django.utils.autoreload import gen_filenames diff --git a/tests/utils_tests/test_module_loading.py b/tests/utils_tests/test_module_loading.py index 0c8dfe1e12..baaab36494 100644 --- a/tests/utils_tests/test_module_loading.py +++ b/tests/utils_tests/test_module_loading.py @@ -5,7 +5,7 @@ import sys import unittest from zipimport import zipimporter -from django.core.apps import app_cache +from django.apps import app_cache from django.core.exceptions import ImproperlyConfigured from django.test import SimpleTestCase from django.utils import six diff --git a/tests/validation/test_unique.py b/tests/validation/test_unique.py index f05256a6f1..be7808f460 100644 --- a/tests/validation/test_unique.py +++ b/tests/validation/test_unique.py @@ -3,7 +3,7 @@ from __future__ import unicode_literals import datetime import unittest -from django.core.apps.cache import AppCache +from django.apps.cache import AppCache from django.core.exceptions import ValidationError from django.db import models from django.test import TestCase diff --git a/tests/view_tests/tests/test_i18n.py b/tests/view_tests/tests/test_i18n.py index 19bbde286c..1e4eff66df 100644 --- a/tests/view_tests/tests/test_i18n.py +++ b/tests/view_tests/tests/test_i18n.py @@ -4,8 +4,8 @@ import os from os import path import unittest +from django.apps import app_cache from django.conf import settings -from django.core.apps import app_cache from django.core.urlresolvers import reverse from django.test import LiveServerTestCase, TestCase from django.test.utils import override_settings From 690d1cb8d0341ac71613f6bb93f0793335ec6dfd Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 22 Dec 2013 11:36:49 +0100 Subject: [PATCH 021/208] Made AppConfig importable from django.apps. It is a public API. --- django/apps/__init__.py | 1 + tests/test_runner/tests.py | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/django/apps/__init__.py b/django/apps/__init__.py index 0384b1257d..a1193eafcc 100644 --- a/django/apps/__init__.py +++ b/django/apps/__init__.py @@ -1 +1,2 @@ +from .base import AppConfig # NOQA from .cache import app_cache, UnavailableApp # NOQA diff --git a/tests/test_runner/tests.py b/tests/test_runner/tests.py index 5393ea75a2..0daf4ab3b7 100644 --- a/tests/test_runner/tests.py +++ b/tests/test_runner/tests.py @@ -224,7 +224,7 @@ class ModulesTestsPackages(IgnoreAllDeprecationWarningsMixin, unittest.TestCase) def test_get_tests(self): "Check that the get_tests helper function can find tests in a directory" - from django.apps.base import AppConfig + from django.apps import AppConfig from django.test.simple import get_tests app_config = AppConfig.create('test_runner.valid_app') app_config.import_models({}) @@ -233,7 +233,7 @@ class ModulesTestsPackages(IgnoreAllDeprecationWarningsMixin, unittest.TestCase) def test_import_error(self): "Test for #12658 - Tests with ImportError's shouldn't fail silently" - from django.apps.base import AppConfig + from django.apps import AppConfig from django.test.simple import get_tests app_config = AppConfig.create('test_runner_invalid_app') app_config.import_models({}) From ba60fcbcf7645afd82f3135ecb56562f8a9c9824 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Fri, 20 Dec 2013 14:12:25 +0100 Subject: [PATCH 022/208] Used application verbose names in the admin. --- django/contrib/admin/actions.py | 1 - django/contrib/admin/options.py | 3 --- django/contrib/admin/sites.py | 9 +++++---- .../admin/templates/admin/auth/user/change_password.html | 2 +- django/contrib/admin/templates/admin/change_form.html | 2 +- django/contrib/admin/templates/admin/change_list.html | 2 +- .../templates/admin/delete_selected_confirmation.html | 2 +- django/contrib/admin/templates/admin/object_history.html | 2 +- 8 files changed, 10 insertions(+), 13 deletions(-) diff --git a/django/contrib/admin/actions.py b/django/contrib/admin/actions.py index d215aa6259..158c436c71 100644 --- a/django/contrib/admin/actions.py +++ b/django/contrib/admin/actions.py @@ -71,7 +71,6 @@ def delete_selected(modeladmin, request, queryset): "perms_lacking": perms_needed, "protected": protected, "opts": opts, - "app_label": app_label, 'action_checkbox_name': helpers.ACTION_CHECKBOX_NAME, } diff --git a/django/contrib/admin/options.py b/django/contrib/admin/options.py index 4c5adaf0f8..02f9ed3a84 100644 --- a/django/contrib/admin/options.py +++ b/django/contrib/admin/options.py @@ -1308,7 +1308,6 @@ class ModelAdmin(BaseModelAdmin): media=media, inline_admin_formsets=inline_admin_formsets, errors=helpers.AdminErrorList(form, formsets), - app_label=opts.app_label, preserved_filters=self.get_preserved_filters(request), ) context.update(extra_context or {}) @@ -1532,7 +1531,6 @@ class ModelAdmin(BaseModelAdmin): media=media, has_add_permission=self.has_add_permission(request), opts=cl.opts, - app_label=app_label, action_form=action_form, actions_on_top=self.actions_on_top, actions_on_bottom=self.actions_on_bottom, @@ -1627,7 +1625,6 @@ class ModelAdmin(BaseModelAdmin): action_list=action_list, module_name=capfirst(force_text(opts.verbose_name_plural)), object=obj, - app_label=app_label, opts=opts, preserved_filters=self.get_preserved_filters(request), ) diff --git a/django/contrib/admin/sites.py b/django/contrib/admin/sites.py index d72666a257..22c1b29ab4 100644 --- a/django/contrib/admin/sites.py +++ b/django/contrib/admin/sites.py @@ -381,7 +381,7 @@ class AdminSite(object): app_dict[app_label]['models'].append(model_dict) else: app_dict[app_label] = { - 'name': app_label.title(), + 'name': app_cache.get_app_config(app_label).verbose_name, 'app_label': app_label, 'app_url': reverse('admin:app_list', kwargs={'app_label': app_label}, current_app=self.name), 'has_module_perms': has_module_perms, @@ -390,7 +390,7 @@ class AdminSite(object): # Sort the apps alphabetically. app_list = list(six.itervalues(app_dict)) - app_list.sort(key=lambda x: x['name']) + app_list.sort(key=lambda x: x['name'].lower()) # Sort the models alphabetically within each app. for app in app_list: @@ -408,6 +408,7 @@ class AdminSite(object): def app_index(self, request, app_label, extra_context=None): user = request.user + app_name = app_cache.get_app_config(app_label).verbose_name has_module_perms = user.has_module_perms(app_label) if not has_module_perms: raise PermissionDenied @@ -442,7 +443,7 @@ class AdminSite(object): # something to display, add in the necessary meta # information. app_dict = { - 'name': app_label.title(), + 'name': app_name, 'app_label': app_label, 'app_url': '', 'has_module_perms': has_module_perms, @@ -453,7 +454,7 @@ class AdminSite(object): # Sort the models alphabetically within each app. app_dict['models'].sort(key=lambda x: x['name']) context = dict(self.each_context(), - title=_('%s administration') % capfirst(app_label), + title=_('%s administration') % app_name, app_list=[app_dict], app_label=app_label, ) diff --git a/django/contrib/admin/templates/admin/auth/user/change_password.html b/django/contrib/admin/templates/admin/auth/user/change_password.html index 2a1b4d3c90..3634ed4083 100644 --- a/django/contrib/admin/templates/admin/auth/user/change_password.html +++ b/django/contrib/admin/templates/admin/auth/user/change_password.html @@ -11,7 +11,7 @@ {% block breadcrumbs %}
{% trans 'Home' %} -› {{ opts.app_label|capfirst|escape }} +› {{ opts.app_config.verbose_name }} › {{ opts.verbose_name_plural|capfirst }} › {{ original|truncatewords:"18" }} › {% trans 'Change password' %} diff --git a/django/contrib/admin/templates/admin/change_form.html b/django/contrib/admin/templates/admin/change_form.html index 79ea73933c..be2cd862d4 100644 --- a/django/contrib/admin/templates/admin/change_form.html +++ b/django/contrib/admin/templates/admin/change_form.html @@ -16,7 +16,7 @@ {% block breadcrumbs %}
{% trans 'Home' %} -› {{ app_label|capfirst|escape }} +› {{ opts.app_config.verbose_name }} › {% if has_change_permission %}{{ opts.verbose_name_plural|capfirst }}{% else %}{{ opts.verbose_name_plural|capfirst }}{% endif %} › {% if add %}{% trans 'Add' %} {{ opts.verbose_name }}{% else %}{{ original|truncatewords:"18" }}{% endif %}
diff --git a/django/contrib/admin/templates/admin/change_list.html b/django/contrib/admin/templates/admin/change_list.html index a5a31f9c67..766a7c0fe6 100644 --- a/django/contrib/admin/templates/admin/change_list.html +++ b/django/contrib/admin/templates/admin/change_list.html @@ -38,7 +38,7 @@ {% block breadcrumbs %}
{% trans 'Home' %} -› {{ app_label|capfirst|escape }} +› {{ cl.opts.app_config.verbose_name }} › {{ cl.opts.verbose_name_plural|capfirst }}
{% endblock %} diff --git a/django/contrib/admin/templates/admin/delete_selected_confirmation.html b/django/contrib/admin/templates/admin/delete_selected_confirmation.html index a80f4e4a54..a8f059fd46 100644 --- a/django/contrib/admin/templates/admin/delete_selected_confirmation.html +++ b/django/contrib/admin/templates/admin/delete_selected_confirmation.html @@ -6,7 +6,7 @@ {% block breadcrumbs %}
{% trans 'Home' %} -› {{ app_label|capfirst|escape }} +› {{ opts.app_config.verbose_name }} › {{ opts.verbose_name_plural|capfirst }} › {% trans 'Delete multiple objects' %}
diff --git a/django/contrib/admin/templates/admin/object_history.html b/django/contrib/admin/templates/admin/object_history.html index c750ff14b3..cf3e7e2e0d 100644 --- a/django/contrib/admin/templates/admin/object_history.html +++ b/django/contrib/admin/templates/admin/object_history.html @@ -4,7 +4,7 @@ {% block breadcrumbs %}
{% trans 'Home' %} -› {{ app_label|capfirst|escape }} +› {{ opts.app_config.verbose_name }} › {{ module_name }} › {{ object|truncatewords:"18" }} › {% trans 'History' %} From 4f064c2f0511dc900c7f4a736573c309de84dec7 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 22 Dec 2013 17:07:18 +0100 Subject: [PATCH 023/208] Changed has_app to return a boolean. That matches its name ad its purpose better. --- django/apps/cache.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/django/apps/cache.py b/django/apps/cache.py index 056aa9a60b..e7adffecdb 100644 --- a/django/apps/cache.py +++ b/django/apps/cache.py @@ -300,15 +300,15 @@ class AppCache(object): def has_app(self, app_name): """ - Returns the application config if one is registered and None otherwise. + Checks whether an application with this name exists in the app cache. + + app_name is the full name of the app eg. 'django.contrib.admin'. It's safe to call this method at import time, even while the app cache is being populated. It returns None for apps that aren't loaded yet. """ app_config = self.app_configs.get(app_name.rpartition(".")[2]) - if app_config is not None and app_config.name != app_name: - app_config = None - return app_config + return app_config is not None and app_config.name == app_name: def has_model(self, app_label, model_name): """ From 17c66e6fe77bc5eb2bd9e6f8f032a105d3cac3d7 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 22 Dec 2013 17:07:52 +0100 Subject: [PATCH 024/208] Renamed has_model to get_registered_models. That matches its return type better. --- django/apps/cache.py | 2 +- django/db/models/base.py | 4 ++-- django/db/models/fields/related.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/django/apps/cache.py b/django/apps/cache.py index e7adffecdb..6d8988ad70 100644 --- a/django/apps/cache.py +++ b/django/apps/cache.py @@ -310,7 +310,7 @@ class AppCache(object): app_config = self.app_configs.get(app_name.rpartition(".")[2]) return app_config is not None and app_config.name == app_name: - def has_model(self, app_label, model_name): + def get_registered_model(self, app_label, model_name): """ Returns the model class if one is registered and None otherwise. diff --git a/django/db/models/base.py b/django/db/models/base.py index 3ae0fe34bd..85e4be870b 100644 --- a/django/db/models/base.py +++ b/django/db/models/base.py @@ -151,7 +151,7 @@ class ModelBase(type): new_class._base_manager = new_class._base_manager._copy_to_model(new_class) # Bail out early if we have already created this class. - m = new_class._meta.app_cache.has_model(new_class._meta.app_label, name) + m = new_class._meta.app_cache.get_registered_model(new_class._meta.app_label, name) if m is not None: return m @@ -278,7 +278,7 @@ class ModelBase(type): # the first time this model tries to register with the framework. There # should only be one class for each model, so we always return the # registered version. - return new_class._meta.app_cache.has_model(new_class._meta.app_label, name) + return new_class._meta.app_cache.get_registered_model(new_class._meta.app_label, name) def copy_managers(cls, base_managers): # This is in-place sorting of an Options attribute, but that's fine. diff --git a/django/db/models/fields/related.py b/django/db/models/fields/related.py index 0218c8c693..d6d84e1b23 100644 --- a/django/db/models/fields/related.py +++ b/django/db/models/fields/related.py @@ -68,7 +68,7 @@ def add_lazy_relation(cls, field, relation, operation): # string right away. If get_model returns None, it means that the related # model isn't loaded yet, so we need to pend the relation until the class # is prepared. - model = cls._meta.app_cache.has_model(app_label, model_name) + model = cls._meta.app_cache.get_registered_model(app_label, model_name) if model: operation(field, model, cls) else: From 71450f6b4515f99bae770da69f79f5072e2ff608 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 22 Dec 2013 17:11:47 +0100 Subject: [PATCH 025/208] Syntax error. --- django/apps/cache.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/django/apps/cache.py b/django/apps/cache.py index 6d8988ad70..2c27f96a72 100644 --- a/django/apps/cache.py +++ b/django/apps/cache.py @@ -308,7 +308,7 @@ class AppCache(object): is being populated. It returns None for apps that aren't loaded yet. """ app_config = self.app_configs.get(app_name.rpartition(".")[2]) - return app_config is not None and app_config.name == app_name: + return app_config is not None and app_config.name == app_name def get_registered_model(self, app_label, model_name): """ From 865603780b0da7bc787199b839c41883cf406e6e Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 22 Dec 2013 18:50:49 +0100 Subject: [PATCH 026/208] Moved a test that didn't require Selenium. --- tests/view_tests/tests/test_i18n.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/tests/view_tests/tests/test_i18n.py b/tests/view_tests/tests/test_i18n.py index 1e4eff66df..97b73b72ac 100644 --- a/tests/view_tests/tests/test_i18n.py +++ b/tests/view_tests/tests/test_i18n.py @@ -130,6 +130,10 @@ class JsI18NTests(TestCase): response = self.client.get('/views/jsi18n/') self.assertContains(response, 'Choisir une heure') + def test_escaping(self): + # Force a language via GET otherwise the gettext functions are a noop! + response = self.client.get('/views/jsi18n_admin/?language=de') + self.assertContains(response, '\\x04') class JsI18NTestsMultiPackage(TestCase): """ @@ -207,8 +211,3 @@ class JavascriptI18nTests(LiveServerTestCase): self.assertEqual(elem.text, "1 Resultat") elem = self.selenium.find_element_by_id("npgettext_plur") self.assertEqual(elem.text, "455 Resultate") - - def test_escaping(self): - # Force a language via GET otherwise the gettext functions are a noop! - response = self.client.get('/jsi18n_admin/?language=de') - self.assertContains(response, '\\x04') From 046a8eb9c499e0281a8e263a66e05dd6305d9e4e Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 22 Dec 2013 19:04:08 +0100 Subject: [PATCH 027/208] Made apps available for loading traslations in a test. --- tests/view_tests/tests/test_i18n.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tests/view_tests/tests/test_i18n.py b/tests/view_tests/tests/test_i18n.py index 97b73b72ac..f3d676fc0f 100644 --- a/tests/view_tests/tests/test_i18n.py +++ b/tests/view_tests/tests/test_i18n.py @@ -181,7 +181,8 @@ skip_selenium = not os.environ.get('DJANGO_SELENIUM_TESTS', False) @unittest.skipUnless(firefox, 'Selenium not installed') class JavascriptI18nTests(LiveServerTestCase): - available_apps = [] + # The test cases use translations from these apps. + available_apps = ['django.contrib.admin', 'view_tests'] urls = 'view_tests.urls' @classmethod From 3a30b9c5755baca0cf74d68cf5218dc6a49c29c9 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 22 Dec 2013 20:22:56 +0100 Subject: [PATCH 028/208] Fixed a flaky test. --- tests/settings_tests/tests.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/tests/settings_tests/tests.py b/tests/settings_tests/tests.py index b148887e34..6fc08ebbe5 100644 --- a/tests/settings_tests/tests.py +++ b/tests/settings_tests/tests.py @@ -1,3 +1,4 @@ +import os import unittest import warnings @@ -231,7 +232,9 @@ class TestComplexSettingOverride(TestCase): self.assertEqual(settings.TEST_WARN, 'override') self.assertEqual(len(w), 1) - self.assertEqual(w[0].filename, __file__) + # File extension may by .py, .pyc, etc. Compare only basename. + self.assertEqual(os.path.splitext(w[0].filename)[0], + os.path.splitext(__file__)[0]) self.assertEqual(str(w[0].message), 'Overriding setting TEST_WARN can lead to unexpected behaviour.') From b4a11f2720fbbb47f7c03a5a00b3cfb334266a92 Mon Sep 17 00:00:00 2001 From: Marc Tamlyn Date: Sun, 22 Dec 2013 19:22:37 +0000 Subject: [PATCH 029/208] Fixed #21651 -- Remove recapitalize. It was not used inside Django, is not tested or documented. Consequently remove without deprecation path. Thanks to @vajrasky for bringing it to our attention. --- django/utils/text.py | 9 --------- 1 file changed, 9 deletions(-) diff --git a/django/utils/text.py b/django/utils/text.py index d172dc91f8..f44a364f5f 100644 --- a/django/utils/text.py +++ b/django/utils/text.py @@ -256,15 +256,6 @@ def normalize_newlines(text): normalize_newlines = allow_lazy(normalize_newlines, six.text_type) -def recapitalize(text): - """Recapitalizes text, placing caps after end-of-sentence punctuation.""" - text = force_text(text).lower() - capsRE = re.compile(r'(?:^|(?<=[\.\?\!] ))([a-z])') - text = capsRE.sub(lambda x: x.group(1).upper(), text) - return text -recapitalize = allow_lazy(recapitalize) - - def phone2numeric(phone): """Converts a phone number with letters into its numeric equivalent.""" char2number = {'a': '2', 'b': '2', 'c': '2', 'd': '3', 'e': '3', 'f': '3', From 8cff95e937a3a10e577082bfbcd75ed82ec0223b Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Mon, 23 Dec 2013 09:44:16 +0100 Subject: [PATCH 030/208] Used a more translator-friendly format in admin sites.py --- django/contrib/admin/sites.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/django/contrib/admin/sites.py b/django/contrib/admin/sites.py index 22c1b29ab4..c2a409a0e4 100644 --- a/django/contrib/admin/sites.py +++ b/django/contrib/admin/sites.py @@ -454,7 +454,7 @@ class AdminSite(object): # Sort the models alphabetically within each app. app_dict['models'].sort(key=lambda x: x['name']) context = dict(self.each_context(), - title=_('%s administration') % app_name, + title=_('%(app)s administration') % {'app': app_name}, app_list=[app_dict], app_label=app_label, ) From 5891990b6e6f6e90a873ceb199b321177a90c9eb Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 23 Dec 2013 00:10:53 +0100 Subject: [PATCH 031/208] Refactored INSTALLED_APPS overrides. * Introduced [un]set_installed_apps to handle changes to the INSTALLED_APPS setting. * Refactored [un]set_available_apps to share its implementation with [un]set_installed_apps. * Implemented a receiver to clear some app-related caches. * Removed test_missing_app as it is basically impossible to reproduce this situation with public methods of the new app cache. --- django/apps/__init__.py | 4 +- django/apps/cache.py | 88 +++++++++++----------- django/contrib/auth/management/__init__.py | 13 ++-- django/contrib/contenttypes/management.py | 6 +- django/test/signals.py | 10 ++- django/test/testcases.py | 18 ++++- django/test/utils.py | 7 ++ tests/app_loading/tests.py | 20 ----- 8 files changed, 85 insertions(+), 81 deletions(-) diff --git a/django/apps/__init__.py b/django/apps/__init__.py index a1193eafcc..6b47d3397f 100644 --- a/django/apps/__init__.py +++ b/django/apps/__init__.py @@ -1,2 +1,2 @@ -from .base import AppConfig # NOQA -from .cache import app_cache, UnavailableApp # NOQA +from .base import AppConfig # NOQA +from .cache import app_cache # NOQA diff --git a/django/apps/cache.py b/django/apps/cache.py index 2c27f96a72..bdd7e98e22 100644 --- a/django/apps/cache.py +++ b/django/apps/cache.py @@ -14,10 +14,6 @@ from django.utils._os import upath from .base import AppConfig -class UnavailableApp(Exception): - pass - - class AppCache(object): """ A cache that stores installed applications and their models. Used to @@ -43,9 +39,9 @@ class AppCache(object): # Mapping of labels to AppConfig instances for installed apps. self.app_configs = OrderedDict() - # Set of app names. Allows restricting the set of installed apps. - # Used by TransactionTestCase.available_apps for performance reasons. - self.available_apps = None + # Stack of app_configs. Used to store the current state in + # set_available_apps and set_installed_apps. + self.stored_app_configs = [] # Internal flags used when populating the master cache. self._apps_loaded = not self.master @@ -157,8 +153,6 @@ class AppCache(object): for app_config in self.app_configs.values(): if only_with_models_module and app_config.models_module is None: continue - if self.available_apps is not None and app_config.name not in self.available_apps: - continue yield app_config def get_app_config(self, app_label, only_with_models_module=False): @@ -167,9 +161,6 @@ class AppCache(object): Raises LookupError if no application exists with this label. - Raises UnavailableApp when set_available_apps() disables the - application with this label. - If only_with_models_module in True (non-default), imports models and considers only applications containing a models module. """ @@ -183,8 +174,6 @@ class AppCache(object): raise LookupError("No installed app with label %r." % app_label) if only_with_models_module and app_config.models_module is None: raise LookupError("App with label %r doesn't have a models module." % app_label) - if self.available_apps is not None and app_config.name not in self.available_apps: - raise UnavailableApp("App with label %r isn't available." % app_label) return app_config def get_models(self, app_mod=None, @@ -216,13 +205,7 @@ class AppCache(object): cache_key = (app_mod, include_auto_created, include_deferred, only_installed, include_swapped) model_list = None try: - model_list = self._get_models_cache[cache_key] - if self.available_apps is not None and only_installed: - model_list = [ - m for m in model_list - if self.app_configs[m._meta.app_label].name in self.available_apps - ] - return model_list + return self._get_models_cache[cache_key] except KeyError: pass self.populate_models() @@ -249,11 +232,6 @@ class AppCache(object): (not model._meta.swapped or include_swapped)) ) self._get_models_cache[cache_key] = model_list - if self.available_apps is not None and only_installed: - model_list = [ - m for m in model_list - if self.app_configs[m._meta.app_label].name in self.available_apps - ] return model_list def get_model(self, app_label, model_name, only_installed=True): @@ -262,9 +240,6 @@ class AppCache(object): model_name. Returns None if no model is found. - - Raises UnavailableApp when set_available_apps() in in effect and - doesn't include app_label. """ if not self.master: only_installed = False @@ -273,9 +248,6 @@ class AppCache(object): app_config = self.app_configs.get(app_label) if app_config is None: return None - if (self.available_apps is not None - and app_config.name not in self.available_apps): - raise UnavailableApp("App with label %s isn't available." % app_label) return self.all_models[app_label].get(model_name.lower()) def register_model(self, app_label, model): @@ -326,22 +298,57 @@ class AppCache(object): available must be an iterable of application names. Primarily used for performance optimization in TransactionTestCase. + + This method is safe is the sense that it doesn't trigger any imports. """ - if self.available_apps is not None: - raise RuntimeError("set_available_apps() may be called only once " - "in a row; make sure it's paired with unset_available_apps()") available = set(available) installed = set(app_config.name for app_config in self.get_app_configs()) if not available.issubset(installed): raise ValueError("Available apps isn't a subset of installed " "apps, extra apps: %s" % ", ".join(available - installed)) - self.available_apps = available + + self.stored_app_configs.append(self.app_configs) + self.app_configs = OrderedDict( + (label, app_config) + for label, app_config in self.app_configs.items() + if app_config.name in available) def unset_available_apps(self): """ Cancels a previous call to set_available_apps(). """ - self.available_apps = None + self.app_configs = self.stored_app_configs.pop() + + def set_installed_apps(self, installed): + """ + Enables a different set of installed_apps for get_app_config[s]. + + installed must be an iterable in the same format as INSTALLED_APPS. + + Primarily used as a receiver of the setting_changed signal in tests. + + This method may trigger new imports, which may add new models to the + registry of all imported models. They will stay in the registry even + after unset_installed_apps(). Since it isn't possible to replay + imports safely (eg. that could lead to registering listeners twice), + models are registered when they're imported and never removed. + """ + self.stored_app_configs.append(self.app_configs) + self.app_configs = OrderedDict() + try: + self._apps_loaded = False + self.populate_apps() + self._models_loaded = False + self.populate_models() + except Exception: + self.unset_installed_apps() + raise + + def unset_installed_apps(self): + """ + Cancels a previous call to set_installed_apps(). + """ + self.app_configs = self.stored_app_configs.pop() ### DANGEROUS METHODS ### (only used to preserve existing tests) @@ -353,15 +360,11 @@ class AppCache(object): else: app_config.import_models(self.all_models[app_config.label]) self.app_configs[app_config.label] = app_config - if self.available_apps is not None: - self.available_apps.add(app_config.name) return app_config def _end_with_app(self, app_config): if app_config is not None: del self.app_configs[app_config.label] - if self.available_apps is not None: - self.available_apps.discard(app_config.name) @contextmanager def _with_app(self, app_name): @@ -420,9 +423,6 @@ class AppCache(object): def get_app(self, app_label): """ Returns the module containing the models for the given app_label. - - Raises UnavailableApp when set_available_apps() in in effect and - doesn't include app_label. """ warnings.warn( "get_app_config(app_label).models_module supersedes get_app(app_label).", diff --git a/django/contrib/auth/management/__init__.py b/django/contrib/auth/management/__init__.py index 5f24bf069e..008661fac6 100644 --- a/django/contrib/auth/management/__init__.py +++ b/django/contrib/auth/management/__init__.py @@ -6,7 +6,7 @@ from __future__ import unicode_literals import getpass import unicodedata -from django.apps import app_cache, UnavailableApp +from django.apps import app_cache from django.contrib.auth import (models as auth_app, get_permission_codename, get_user_model) from django.core import exceptions @@ -61,9 +61,7 @@ def _check_permission_clashing(custom, builtin, ctype): def create_permissions(app, created_models, verbosity, db=DEFAULT_DB_ALIAS, **kwargs): - try: - app_cache.get_model('auth', 'Permission') - except UnavailableApp: + if app_cache.get_model('auth', 'Permission') is None: return if not router.allow_migrate(db, auth_app.Permission): @@ -119,12 +117,11 @@ def create_permissions(app, created_models, verbosity, db=DEFAULT_DB_ALIAS, **kw def create_superuser(app, created_models, verbosity, db, **kwargs): - try: - app_cache.get_model('auth', 'Permission') - UserModel = get_user_model() - except UnavailableApp: + if app_cache.get_model('auth', 'Permission') is None: return + UserModel = get_user_model() + from django.core.management import call_command if UserModel in created_models and kwargs.get('interactive', True): diff --git a/django/contrib/contenttypes/management.py b/django/contrib/contenttypes/management.py index 35a8a7fdc8..4ea10ebe58 100644 --- a/django/contrib/contenttypes/management.py +++ b/django/contrib/contenttypes/management.py @@ -1,4 +1,4 @@ -from django.apps import app_cache, UnavailableApp +from django.apps import app_cache from django.contrib.contenttypes.models import ContentType from django.db import DEFAULT_DB_ALIAS, router from django.db.models import signals @@ -12,9 +12,7 @@ def update_contenttypes(app, created_models, verbosity=2, db=DEFAULT_DB_ALIAS, * Creates content types for models in the given app, removing any model entries that no longer have a matching model class. """ - try: - app_cache.get_model('contenttypes', 'ContentType') - except UnavailableApp: + if app_cache.get_model('contenttypes', 'ContentType') is None: return if not router.allow_migrate(db, ContentType): diff --git a/django/test/signals.py b/django/test/signals.py index 0d6b7bedf1..03c40f259d 100644 --- a/django/test/signals.py +++ b/django/test/signals.py @@ -17,7 +17,7 @@ setting_changed = Signal(providing_args=["setting", "value", "enter"]) # except for cases where the receiver is related to a contrib app. # Settings that may not work well when using 'override_settings' (#19031) -COMPLEX_OVERRIDE_SETTINGS = set(['DATABASES', 'INSTALLED_APPS']) +COMPLEX_OVERRIDE_SETTINGS = set(['DATABASES']) @receiver(setting_changed) @@ -27,6 +27,14 @@ def clear_cache_handlers(**kwargs): caches._caches = threading.local() +@receiver(setting_changed) +def update_installed_apps(**kwargs): + if kwargs['setting'] == 'INSTALLED_APPS': + # Rebuild any AppDirectoriesFinder instance. + from django.contrib.staticfiles.finders import get_finder + get_finder.cache_clear() + + @receiver(setting_changed) def update_connections_time_zone(**kwargs): if kwargs['setting'] == 'TIME_ZONE': diff --git a/django/test/testcases.py b/django/test/testcases.py index 1480889565..1532ec433f 100644 --- a/django/test/testcases.py +++ b/django/test/testcases.py @@ -30,7 +30,7 @@ from django.forms.fields import CharField from django.http import QueryDict from django.test.client import Client from django.test.html import HTMLParseError, parse_html -from django.test.signals import template_rendered +from django.test.signals import setting_changed, template_rendered from django.test.utils import (CaptureQueriesContext, ContextList, override_settings, compare_xml) from django.utils.encoding import force_text @@ -726,6 +726,10 @@ class TransactionTestCase(SimpleTestCase): super(TransactionTestCase, self)._pre_setup() if self.available_apps is not None: app_cache.set_available_apps(self.available_apps) + setting_changed.send(sender=settings._wrapped.__class__, + setting='INSTALLED_APPS', + value=self.available_apps, + enter=True) for db_name in self._databases_names(include_mirrors=False): flush.Command.emit_post_migrate(verbosity=0, interactive=False, database=db_name) try: @@ -733,6 +737,11 @@ class TransactionTestCase(SimpleTestCase): except Exception: if self.available_apps is not None: app_cache.unset_available_apps() + setting_changed.send(sender=settings._wrapped.__class__, + setting='INSTALLED_APPS', + value=settings.INSTALLED_APPS, + enter=False) + raise def _databases_names(self, include_mirrors=True): @@ -786,7 +795,12 @@ class TransactionTestCase(SimpleTestCase): for conn in connections.all(): conn.close() finally: - app_cache.unset_available_apps() + if self.available_apps is not None: + app_cache.unset_available_apps() + setting_changed.send(sender=settings._wrapped.__class__, + setting='INSTALLED_APPS', + value=settings.INSTALLED_APPS, + enter=False) def _fixture_teardown(self): # Allow TRUNCATE ... CASCADE and don't emit the post_migrate signal diff --git a/django/test/utils.py b/django/test/utils.py index 550d7642b9..ce7536bd6d 100644 --- a/django/test/utils.py +++ b/django/test/utils.py @@ -9,6 +9,7 @@ import warnings from functools import wraps from xml.dom.minidom import parseString, Node +from django.apps import app_cache from django.conf import settings, UserSettingsHolder from django.core import mail from django.core.signals import request_started @@ -190,6 +191,8 @@ class override_settings(object): """ def __init__(self, **kwargs): self.options = kwargs + # Special case that requires updating the app cache, a core feature. + self.installed_apps = self.options.get('INSTALLED_APPS') def __enter__(self): self.enable() @@ -223,6 +226,8 @@ class override_settings(object): setattr(override, key, new_value) self.wrapped = settings._wrapped settings._wrapped = override + if self.installed_apps is not None: + app_cache.set_installed_apps(self.installed_apps) for key, new_value in self.options.items(): setting_changed.send(sender=settings._wrapped.__class__, setting=key, value=new_value, enter=True) @@ -230,6 +235,8 @@ class override_settings(object): def disable(self): settings._wrapped = self.wrapped del self.wrapped + if self.installed_apps is not None: + app_cache.unset_installed_apps() for key in self.options: new_value = getattr(settings, key, None) setting_changed.send(sender=settings._wrapped.__class__, diff --git a/tests/app_loading/tests.py b/tests/app_loading/tests.py index 0692597a5b..164e363161 100644 --- a/tests/app_loading/tests.py +++ b/tests/app_loading/tests.py @@ -3,11 +3,8 @@ from __future__ import unicode_literals import os import sys from unittest import TestCase -import warnings from django.apps import app_cache -from django.apps.cache import AppCache -from django.test.utils import override_settings from django.utils._os import upath from django.utils import six @@ -69,23 +66,6 @@ class EggLoadingTest(TestCase): with app_cache._with_app('broken_app'): app_cache.get_app_config('omelet.app_no_models').models_module - def test_missing_app(self): - """ - Test that repeated app loading doesn't succeed in case there is an - error. Refs #17667. - """ - app_cache = AppCache() - # Pretend we're the master app cache to test the population process. - app_cache._apps_loaded = False - app_cache._models_loaded = False - with warnings.catch_warnings(): - warnings.filterwarnings("ignore", "Overriding setting INSTALLED_APPS") - with override_settings(INSTALLED_APPS=['notexists']): - with self.assertRaises(ImportError): - app_cache.get_model('notexists', 'nomodel') - with self.assertRaises(ImportError): - app_cache.get_model('notexists', 'nomodel') - class GetModelsTest(TestCase): def setUp(self): From 5241763c81b6afe1c0327ff7eb0d75c643f24ce0 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 23 Dec 2013 12:39:19 +0100 Subject: [PATCH 032/208] Added modify_settings to alter settings containing lists of values. --- django/test/__init__.py | 4 +- django/test/testcases.py | 27 +++++-- django/test/utils.py | 75 ++++++++++++++++--- docs/topics/testing/overview.txt | 110 ++++++++++++++++++++++------ tests/settings_tests/tests.py | 61 ++++++++++++++- tests/view_tests/tests/test_i18n.py | 1 + 6 files changed, 229 insertions(+), 49 deletions(-) diff --git a/django/test/__init__.py b/django/test/__init__.py index 4b17ed18c9..c611ef6850 100644 --- a/django/test/__init__.py +++ b/django/test/__init__.py @@ -8,10 +8,10 @@ from django.test.testcases import ( SimpleTestCase, LiveServerTestCase, skipIfDBFeature, skipUnlessDBFeature ) -from django.test.utils import override_settings +from django.test.utils import modify_settings, override_settings __all__ = [ 'Client', 'RequestFactory', 'TestCase', 'TransactionTestCase', 'SimpleTestCase', 'LiveServerTestCase', 'skipIfDBFeature', - 'skipUnlessDBFeature', 'override_settings', + 'skipUnlessDBFeature', 'modify_settings', 'override_settings', ] diff --git a/django/test/testcases.py b/django/test/testcases.py index 1532ec433f..0e1bb78d46 100644 --- a/django/test/testcases.py +++ b/django/test/testcases.py @@ -32,7 +32,7 @@ from django.test.client import Client from django.test.html import HTMLParseError, parse_html from django.test.signals import setting_changed, template_rendered from django.test.utils import (CaptureQueriesContext, ContextList, - override_settings, compare_xml) + override_settings, modify_settings, compare_xml) from django.utils.encoding import force_text from django.utils import six from django.utils.six.moves.urllib.parse import urlsplit, urlunsplit, urlparse, unquote @@ -164,7 +164,8 @@ class SimpleTestCase(unittest.TestCase): # The class we'll use for the test client self.client. # Can be overridden in derived classes. client_class = Client - _custom_settings = None + _overridden_settings = None + _modified_settings = None def __call__(self, result=None): """ @@ -197,9 +198,12 @@ class SimpleTestCase(unittest.TestCase): * If the class has a 'urls' attribute, replace ROOT_URLCONF with it. * Clearing the mail test outbox. """ - if self._custom_settings: - self._overridden = override_settings(**self._custom_settings) - self._overridden.enable() + if self._overridden_settings: + self._overridden_context = override_settings(**self._overridden_settings) + self._overridden_context.enable() + if self._modified_settings: + self._modified_context = modify_settings(self._modified_settings) + self._modified_context.enable() self.client = self.client_class() self._urlconf_setup() mail.outbox = [] @@ -217,8 +221,10 @@ class SimpleTestCase(unittest.TestCase): * Putting back the original ROOT_URLCONF if it was changed. """ self._urlconf_teardown() - if self._custom_settings: - self._overridden.disable() + if self._modified_settings: + self._modified_context.disable() + if self._overridden_settings: + self._overridden_context.disable() def _urlconf_teardown(self): set_urlconf(None) @@ -233,6 +239,13 @@ class SimpleTestCase(unittest.TestCase): """ return override_settings(**kwargs) + def modify_settings(self, **kwargs): + """ + A context manager that temporarily applies changes a list setting and + reverts back to the original value when exiting the context. + """ + return modify_settings(**kwargs) + def assertRedirects(self, response, expected_url, status_code=302, target_status_code=200, host=None, msg_prefix='', fetch_redirect_response=True): diff --git a/django/test/utils.py b/django/test/utils.py index ce7536bd6d..60e125a86b 100644 --- a/django/test/utils.py +++ b/django/test/utils.py @@ -24,8 +24,10 @@ from django.utils.translation import deactivate __all__ = ( - 'Approximate', 'ContextList', 'get_runner', 'override_settings', - 'requires_tz_support', 'setup_test_environment', 'teardown_test_environment', + 'Approximate', 'ContextList', 'get_runner', + 'modify_settings', 'override_settings', + 'requires_tz_support', + 'setup_test_environment', 'teardown_test_environment', ) RESTORE_LOADERS_ATTR = '_original_template_source_loaders' @@ -191,8 +193,6 @@ class override_settings(object): """ def __init__(self, **kwargs): self.options = kwargs - # Special case that requires updating the app cache, a core feature. - self.installed_apps = self.options.get('INSTALLED_APPS') def __enter__(self): self.enable() @@ -207,11 +207,7 @@ class override_settings(object): raise Exception( "Only subclasses of Django SimpleTestCase can be decorated " "with override_settings") - if test_func._custom_settings: - test_func._custom_settings = dict( - test_func._custom_settings, **self.options) - else: - test_func._custom_settings = self.options + self.save_options(test_func) return test_func else: @wraps(test_func) @@ -220,14 +216,22 @@ class override_settings(object): return test_func(*args, **kwargs) return inner + def save_options(self, test_func): + if test_func._overridden_settings is None: + test_func._overridden_settings = self.options + else: + # Duplicate dict to prevent subclasses from altering their parent. + test_func._overridden_settings = dict( + test_func._overridden_settings, **self.options) + def enable(self): override = UserSettingsHolder(settings._wrapped) for key, new_value in self.options.items(): setattr(override, key, new_value) self.wrapped = settings._wrapped settings._wrapped = override - if self.installed_apps is not None: - app_cache.set_installed_apps(self.installed_apps) + if 'INSTALLED_APPS' in self.options: + app_cache.set_installed_apps(settings.INSTALLED_APPS) for key, new_value in self.options.items(): setting_changed.send(sender=settings._wrapped.__class__, setting=key, value=new_value, enter=True) @@ -235,7 +239,7 @@ class override_settings(object): def disable(self): settings._wrapped = self.wrapped del self.wrapped - if self.installed_apps is not None: + if 'INSTALLED_APPS' in self.options: app_cache.unset_installed_apps() for key in self.options: new_value = getattr(settings, key, None) @@ -243,6 +247,53 @@ class override_settings(object): setting=key, value=new_value, enter=False) +class modify_settings(override_settings): + """ + Like override_settings, but makes it possible to append, prepend or remove + items instead of redefining the entire list. + """ + def __init__(self, *args, **kwargs): + if args: + # Hack used when instaciating from SimpleTestCase._pre_setup. + assert not kwargs + self.operations = args[0] + else: + assert not args + self.operations = list(kwargs.items()) + + def save_options(self, test_func): + if test_func._modified_settings is None: + test_func._modified_settings = self.operations + else: + # Duplicate list to prevent subclasses from altering their parent. + test_func._modified_settings = list( + test_func._modified_settings) + self.operations + + def enable(self): + self.options = {} + for name, operations in self.operations: + try: + # When called from SimpleTestCase._pre_setup, values may be + # overridden several times; cumulate changes. + value = self.options[name] + except KeyError: + value = list(getattr(settings, name, [])) + for action, items in operations.items(): + # items my be a single value or an iterable. + if isinstance(items, six.string_types): + items = [items] + if action == 'append': + value = value + [item for item in items if item not in value] + elif action == 'prepend': + value = [item for item in items if item not in value] + value + elif action == 'remove': + value = [item for item in value if item not in items] + else: + raise ValueError("Unsupported action: %s" % action) + self.options[name] = value + super(modify_settings, self).enable() + + def compare_xml(want, got): """Tries to do a 'xml-comparison' of want and got. Plain string comparison doesn't always work because, for example, attribute diff --git a/docs/topics/testing/overview.txt b/docs/topics/testing/overview.txt index f8464638c2..3bdb13c28f 100644 --- a/docs/topics/testing/overview.txt +++ b/docs/topics/testing/overview.txt @@ -1335,7 +1335,7 @@ Overriding settings For testing purposes it's often useful to change a setting temporarily and revert to the original value after running the testing code. For this use case -Django provides a standard Python context manager (see :pep:`343`) +Django provides a standard Python context manager (see :pep:`343`) called :meth:`~django.test.SimpleTestCase.settings`, which can be used like this:: from django.test import TestCase @@ -1356,12 +1356,41 @@ Django provides a standard Python context manager (see :pep:`343`) This example will override the :setting:`LOGIN_URL` setting for the code in the ``with`` block and reset its value to the previous state afterwards. +.. method:: SimpleTestCase.modify_settings + +.. versionadded:: 1.7 + +It can prove unwieldy to redefine settings that contain a list of values. In +practice, adding or removing values is often sufficient. The +:meth:`~django.test.SimpleTestCase.modify_settings` context manager makes it +easy:: + + from django.test import TestCase + + class MiddlewareTestCase(TestCase): + + def test_cache_middleware(self): + with self.modify_settings(MIDDLEWARE_CLASSES={ + 'append': 'django.middleware.cache.FetchFromCacheMiddleware', + 'prepend': 'django.middleware.cache.UpdateCacheMiddleware', + 'remove': [ + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + ], + }): + response = self.client.get('/') + # ... + +For each action, you can supply either a list of values or a string. When the +value already exists in the list, ``append`` and ``prepend`` have no effect; +neither does ``remove`` when the value doesn't exist. + .. function:: override_settings -In case you want to override a setting for just one test method or even the -whole :class:`~django.test.TestCase` class, Django provides the -:func:`~django.test.override_settings` decorator (see :pep:`318`). It's -used like this:: +In case you want to override a setting for a test method, Django provides the +:func:`~django.test.override_settings` decorator (see :pep:`318`). It's used +like this:: from django.test import TestCase, override_settings @@ -1372,7 +1401,7 @@ used like this:: response = self.client.get('/sekrit/') self.assertRedirects(response, '/other/login/?next=/sekrit/') -The decorator can also be applied to test case classes:: +The decorator can also be applied to :class:`~django.test.TestCase` classes:: from django.test import TestCase, override_settings @@ -1385,17 +1414,50 @@ The decorator can also be applied to test case classes:: .. versionchanged:: 1.7 - Previously, ``override_settings`` was imported from - ``django.test.utils``. + Previously, ``override_settings`` was imported from ``django.test.utils``. + +.. function:: modify_settings + +.. versionadded:: 1.7 + +Likewise, Django provides the :func:`~django.test.modify_settings` +decorator:: + + from django.test import TestCase, modify_settings + + class MiddlewareTestCase(TestCase): + + @modify_settings(MIDDLEWARE_CLASSES={ + 'append': 'django.middleware.cache.FetchFromCacheMiddleware', + 'prepend': 'django.middleware.cache.UpdateCacheMiddleware', + }) + def test_cache_middleware(self): + response = self.client.get('/') + # ... + +The decorator can also be applied to test case classes:: + + from django.test import TestCase, modify_settings + + @modify_settings(MIDDLEWARE_CLASSES={ + 'append': 'django.middleware.cache.FetchFromCacheMiddleware', + 'prepend': 'django.middleware.cache.UpdateCacheMiddleware', + }) + class MiddlewareTestCase(TestCase): + + def test_cache_middleware(self): + response = self.client.get('/') + # ... .. note:: - When given a class, the decorator modifies the class directly and - returns it; it doesn't create and return a modified copy of it. So if - you try to tweak the above example to assign the return value to a - different name than ``LoginTestCase``, you may be surprised to find that - the original ``LoginTestCase`` is still equally affected by the - decorator. + When given a class, these decorators modify the class directly and return + it; they don't create and return a modified copy of it. So if you try to + tweak the above examples to assign the return value to a different name + than ``LoginTestCase`` or ``MiddlewareTestCase``, you may be surprised to + find that the original test case classes are still equally affected by the + decorator. For a given class, :func:`~django.test.modify_settings` is + always applied after :func:`~django.test.override_settings`. .. warning:: @@ -1403,17 +1465,17 @@ The decorator can also be applied to test case classes:: initialization of Django internals. If you change them with ``override_settings``, the setting is changed if you access it via the ``django.conf.settings`` module, however, Django's internals access it - differently. Effectively, using ``override_settings`` with these settings - is probably not going to do what you expect it to do. + differently. Effectively, using :func:`~django.test.override_settings` or + :func:`~django.test.modify_settings` with these settings is probably not + going to do what you expect it to do. - We do not recommend using ``override_settings`` with :setting:`DATABASES`. - Using ``override_settings`` with :setting:`CACHES` is possible, but a bit - tricky if you are using internals that make using of caching, like + We do not recommend altering the :setting:`DATABASES` setting. Altering + the :setting:`CACHES` setting is possible, but a bit tricky if you are + using internals that make using of caching, like :mod:`django.contrib.sessions`. For example, you will have to reinitialize the session backend in a test that uses cached sessions and overrides :setting:`CACHES`. - You can also simulate the absence of a setting by deleting it after settings have been overridden, like this:: @@ -1423,10 +1485,10 @@ have been overridden, like this:: ... When overriding settings, make sure to handle the cases in which your app's -code uses a cache or similar feature that retains state even if the -setting is changed. Django provides the -:data:`django.test.signals.setting_changed` signal that lets you register -callbacks to clean up and otherwise reset state when settings are changed. +code uses a cache or similar feature that retains state even if the setting is +changed. Django provides the :data:`django.test.signals.setting_changed` +signal that lets you register callbacks to clean up and otherwise reset state +when settings are changed. Django itself uses this signal to reset various data: diff --git a/tests/settings_tests/tests.py b/tests/settings_tests/tests.py index 6fc08ebbe5..fd3f543553 100644 --- a/tests/settings_tests/tests.py +++ b/tests/settings_tests/tests.py @@ -6,19 +6,57 @@ from django.conf import settings from django.core.exceptions import ImproperlyConfigured from django.http import HttpRequest from django.test import SimpleTestCase, TransactionTestCase, TestCase, signals -from django.test.utils import override_settings +from django.test.utils import modify_settings, override_settings from django.utils import six -@override_settings(TEST='override', TEST_OUTER='outer') +@modify_settings(ITEMS={ + 'prepend': ['b'], + 'append': ['d'], + 'remove': ['a', 'e'] +}) +@override_settings(ITEMS=['a', 'c', 'e'], ITEMS_OUTER=[1, 2, 3], + TEST='override', TEST_OUTER='outer') class FullyDecoratedTranTestCase(TransactionTestCase): available_apps = [] def test_override(self): + self.assertListEqual(settings.ITEMS, ['b', 'c', 'd']) + self.assertListEqual(settings.ITEMS_OUTER, [1, 2, 3]) self.assertEqual(settings.TEST, 'override') self.assertEqual(settings.TEST_OUTER, 'outer') + @modify_settings(ITEMS={ + 'append': ['e', 'f'], + 'prepend': ['a'], + 'remove': ['d', 'c'], + }) + def test_method_list_override(self): + self.assertListEqual(settings.ITEMS, ['a', 'b', 'e', 'f']) + self.assertListEqual(settings.ITEMS_OUTER, [1, 2, 3]) + + @modify_settings(ITEMS={ + 'append': ['b'], + 'prepend': ['d'], + 'remove': ['a', 'c', 'e'], + }) + def test_method_list_override_no_ops(self): + self.assertListEqual(settings.ITEMS, ['b', 'd']) + + @modify_settings(ITEMS={ + 'append': 'e', + 'prepend': 'a', + 'remove': 'c', + }) + def test_method_list_override_strings(self): + self.assertListEqual(settings.ITEMS, ['a', 'b', 'd', 'e']) + + @modify_settings(ITEMS={'remove': ['b', 'd']}) + @modify_settings(ITEMS={'append': ['b'], 'prepend': ['d']}) + def test_method_list_override_nested_order(self): + self.assertListEqual(settings.ITEMS, ['d', 'c', 'b']) + @override_settings(TEST='override2') def test_method_override(self): self.assertEqual(settings.TEST, 'override2') @@ -31,14 +69,26 @@ class FullyDecoratedTranTestCase(TransactionTestCase): self.assertEqual(FullyDecoratedTranTestCase.__module__, __name__) -@override_settings(TEST='override') +@modify_settings(ITEMS={ + 'prepend': ['b'], + 'append': ['d'], + 'remove': ['a', 'e'] +}) +@override_settings(ITEMS=['a', 'c', 'e'], TEST='override') class FullyDecoratedTestCase(TestCase): def test_override(self): + self.assertListEqual(settings.ITEMS, ['b', 'c', 'd']) self.assertEqual(settings.TEST, 'override') + @modify_settings(ITEMS={ + 'append': 'e', + 'prepend': 'a', + 'remove': 'c', + }) @override_settings(TEST='override2') def test_method_override(self): + self.assertListEqual(settings.ITEMS, ['a', 'b', 'd', 'e']) self.assertEqual(settings.TEST, 'override2') @@ -73,14 +123,17 @@ class ClassDecoratedTestCase(ClassDecoratedTestCaseSuper): self.fail() -@override_settings(TEST='override-parent') +@modify_settings(ITEMS={'append': 'mother'}) +@override_settings(ITEMS=['father'], TEST='override-parent') class ParentDecoratedTestCase(TestCase): pass +@modify_settings(ITEMS={'append': ['child']}) @override_settings(TEST='override-child') class ChildDecoratedTestCase(ParentDecoratedTestCase): def test_override_settings_inheritance(self): + self.assertEqual(settings.ITEMS, ['father', 'mother', 'child']) self.assertEqual(settings.TEST, 'override-child') diff --git a/tests/view_tests/tests/test_i18n.py b/tests/view_tests/tests/test_i18n.py index f3d676fc0f..8f0f9896ba 100644 --- a/tests/view_tests/tests/test_i18n.py +++ b/tests/view_tests/tests/test_i18n.py @@ -135,6 +135,7 @@ class JsI18NTests(TestCase): response = self.client.get('/views/jsi18n_admin/?language=de') self.assertContains(response, '\\x04') + class JsI18NTestsMultiPackage(TestCase): """ Tests for django views in django/views/i18n.py that need to change From da16bb30ff238aa4d59b4186d92ef5429d8d0045 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 23 Dec 2013 10:37:34 +0100 Subject: [PATCH 033/208] Dropped AppCache._empty, _with_app and _without_app. It's now easier to achieve the same effect with modify_settings or override_settings. --- django/apps/cache.py | 56 --------------- django/contrib/contenttypes/tests.py | 5 +- django/contrib/gis/tests/geoapp/test_feeds.py | 8 +-- .../contrib/gis/tests/geoapp/test_sitemaps.py | 9 +-- django/contrib/messages/tests/base.py | 69 +++++++++---------- django/contrib/redirects/tests.py | 26 +++---- django/contrib/sitemaps/tests/test_http.py | 14 ++-- django/contrib/sites/tests.py | 10 +-- tests/admin_docs/tests.py | 12 ++-- tests/app_loading/tests.py | 17 +++-- tests/comment_tests/tests/test_app_api.py | 10 +-- tests/i18n/tests.py | 10 +-- tests/invalid_models_tests/tests.py | 8 +-- tests/migrations/test_writer.py | 3 +- tests/proxy_model_inheritance/tests.py | 3 +- tests/runtests.py | 6 +- tests/template_tests/test_loaders.py | 26 ++++--- tests/template_tests/tests.py | 7 +- tests/utils_tests/test_autoreload.py | 11 ++- tests/utils_tests/test_module_loading.py | 10 +-- tests/view_tests/tests/test_i18n.py | 29 ++++---- 21 files changed, 121 insertions(+), 228 deletions(-) diff --git a/django/apps/cache.py b/django/apps/cache.py index bdd7e98e22..bd412f1192 100644 --- a/django/apps/cache.py +++ b/django/apps/cache.py @@ -1,7 +1,6 @@ "Utilities for loading models and the modules that contain them." from collections import defaultdict, OrderedDict -from contextlib import contextmanager import os import sys import warnings @@ -350,61 +349,6 @@ class AppCache(object): """ self.app_configs = self.stored_app_configs.pop() - ### DANGEROUS METHODS ### (only used to preserve existing tests) - - def _begin_with_app(self, app_name): - # Returns an opaque value that can be passed to _end_with_app(). - app_config = AppConfig.create(app_name) - if app_config.label in self.app_configs: - return None - else: - app_config.import_models(self.all_models[app_config.label]) - self.app_configs[app_config.label] = app_config - return app_config - - def _end_with_app(self, app_config): - if app_config is not None: - del self.app_configs[app_config.label] - - @contextmanager - def _with_app(self, app_name): - app_config = self._begin_with_app(app_name) - try: - yield - finally: - self._end_with_app(app_config) - - def _begin_without_app(self, app_name): - # Returns an opaque value that can be passed to _end_without_app(). - return self.app_configs.pop(app_name.rpartition(".")[2], None) - - def _end_without_app(self, app_config): - if app_config is not None: - self.app_configs[app_config.label] = app_config - - @contextmanager - def _without_app(self, app_name): - app_config = self._begin_without_app(app_name) - try: - yield - finally: - self._end_without_app(app_config) - - def _begin_empty(self): - app_configs, self.app_configs = self.app_configs, OrderedDict() - return app_configs - - def _end_empty(self, app_configs): - self.app_configs = app_configs - - @contextmanager - def _empty(self): - app_configs = self._begin_empty() - try: - yield - finally: - self._end_empty(app_configs) - ### DEPRECATED METHODS GO BELOW THIS LINE ### def load_app(self, app_name): diff --git a/django/contrib/contenttypes/tests.py b/django/contrib/contenttypes/tests.py index 302cdbb5cf..ceac7ccd1b 100644 --- a/django/contrib/contenttypes/tests.py +++ b/django/contrib/contenttypes/tests.py @@ -1,6 +1,5 @@ from __future__ import unicode_literals -from django.apps import app_cache from django.contrib.contenttypes.models import ContentType from django.contrib.contenttypes.views import shortcut from django.contrib.sites.models import get_current_site @@ -222,12 +221,12 @@ class ContentTypesTests(TestCase): user_ct = ContentType.objects.get_for_model(FooWithUrl) obj = FooWithUrl.objects.create(name="john") - with app_cache._with_app('django.contrib.sites'): + with self.modify_settings(INSTALLED_APPS={'append': 'django.contrib.sites'}): response = shortcut(request, user_ct.id, obj.id) self.assertEqual("http://%s/users/john/" % get_current_site(request).domain, response._headers.get("location")[1]) - with app_cache._without_app('django.contrib.sites'): + with self.modify_settings(INSTALLED_APPS={'remove': 'django.contrib.sites'}): response = shortcut(request, user_ct.id, obj.id) self.assertEqual("http://Example.com/users/john/", response._headers.get("location")[1]) diff --git a/django/contrib/gis/tests/geoapp/test_feeds.py b/django/contrib/gis/tests/geoapp/test_feeds.py index 638944db63..96ba26cece 100644 --- a/django/contrib/gis/tests/geoapp/test_feeds.py +++ b/django/contrib/gis/tests/geoapp/test_feeds.py @@ -3,17 +3,17 @@ from __future__ import unicode_literals from unittest import skipUnless from xml.dom import minidom -from django.apps import app_cache from django.conf import settings from django.contrib.sites.models import Site from django.contrib.gis.geos import HAS_GEOS from django.contrib.gis.tests.utils import HAS_SPATIAL_DB -from django.test import TestCase +from django.test import TestCase, modify_settings if HAS_GEOS: from .models import City +@modify_settings(INSTALLED_APPS={'append': 'django.contrib.sites'}) @skipUnless(HAS_GEOS and HAS_SPATIAL_DB, "Geos and spatial db are required.") class GeoFeedTest(TestCase): @@ -21,10 +21,6 @@ class GeoFeedTest(TestCase): def setUp(self): Site(id=settings.SITE_ID, domain="example.com", name="example.com").save() - self._with_sites = app_cache._begin_with_app('django.contrib.sites') - - def tearDown(self): - app_cache._end_with_app(self._with_sites) def assertChildNodes(self, elem, expected): "Taken from syndication/tests.py." diff --git a/django/contrib/gis/tests/geoapp/test_sitemaps.py b/django/contrib/gis/tests/geoapp/test_sitemaps.py index 909a543bb6..c41cc53674 100644 --- a/django/contrib/gis/tests/geoapp/test_sitemaps.py +++ b/django/contrib/gis/tests/geoapp/test_sitemaps.py @@ -6,12 +6,11 @@ from xml.dom import minidom import os import zipfile -from django.apps import app_cache from django.conf import settings from django.contrib.gis.geos import HAS_GEOS from django.contrib.gis.tests.utils import HAS_SPATIAL_DB from django.contrib.sites.models import Site -from django.test import TestCase +from django.test import TestCase, modify_settings from django.test.utils import IgnoreDeprecationWarningsMixin from django.utils._os import upath @@ -19,6 +18,7 @@ if HAS_GEOS: from .models import City, Country +@modify_settings(INSTALLED_APPS={'append': 'django.contrib.sites'}) @skipUnless(HAS_GEOS and HAS_SPATIAL_DB, "Geos and spatial db are required.") class GeoSitemapTest(IgnoreDeprecationWarningsMixin, TestCase): @@ -27,11 +27,6 @@ class GeoSitemapTest(IgnoreDeprecationWarningsMixin, TestCase): def setUp(self): super(GeoSitemapTest, self).setUp() Site(id=settings.SITE_ID, domain="example.com", name="example.com").save() - self._with_sites = app_cache._begin_with_app('django.contrib.sites') - - def tearDown(self): - app_cache._end_with_app(self._with_sites) - super(GeoSitemapTest, self).tearDown() def assertChildNodes(self, elem, expected): "Taken from syndication/tests.py." diff --git a/django/contrib/messages/tests/base.py b/django/contrib/messages/tests/base.py index e03d229be3..e38749c13e 100644 --- a/django/contrib/messages/tests/base.py +++ b/django/contrib/messages/tests/base.py @@ -2,14 +2,14 @@ from unittest import skipUnless from django import http from django.apps import app_cache -from django.conf import settings, global_settings +from django.conf import global_settings from django.contrib.messages import constants, utils, get_level, set_level from django.contrib.messages.api import MessageFailure from django.contrib.messages.constants import DEFAULT_LEVELS from django.contrib.messages.storage import default_storage, base from django.contrib.messages.storage.base import Message from django.core.urlresolvers import reverse -from django.test.utils import override_settings +from django.test.utils import modify_settings, override_settings from django.utils.translation import ugettext_lazy @@ -219,55 +219,48 @@ class BaseTests(object): for msg in data['messages']: self.assertContains(response, msg) - @override_settings( - MIDDLEWARE_CLASSES=filter( - lambda m: 'MessageMiddleware' not in m, settings.MIDDLEWARE_CLASSES), - TEMPLATE_CONTEXT_PROCESSORS=filter( - lambda p: 'context_processors.messages' not in p, - settings.TEMPLATE_CONTEXT_PROCESSORS), - MESSAGE_LEVEL=constants.DEBUG + @modify_settings( + INSTALLED_APPS={'remove': 'django.contrib.messages'}, + MIDDLEWARE_CLASSES={'remove': 'django.contrib.messages.middleware.MessageMiddleware'}, + TEMPLATE_CONTEXT_PROCESSORS={'remove': 'django.contrib.messages.context_processors.messages'}, ) + @override_settings(MESSAGE_LEVEL=constants.DEBUG) def test_middleware_disabled(self): """ Tests that, when the middleware is disabled, an exception is raised when one attempts to store a message. """ - with app_cache._without_app('django.contrib.messages'): - data = { - 'messages': ['Test message %d' % x for x in range(5)], - } - reverse('django.contrib.messages.tests.urls.show') - for level in ('debug', 'info', 'success', 'warning', 'error'): - add_url = reverse('django.contrib.messages.tests.urls.add', - args=(level,)) - self.assertRaises(MessageFailure, self.client.post, add_url, - data, follow=True) + data = { + 'messages': ['Test message %d' % x for x in range(5)], + } + reverse('django.contrib.messages.tests.urls.show') + for level in ('debug', 'info', 'success', 'warning', 'error'): + add_url = reverse('django.contrib.messages.tests.urls.add', + args=(level,)) + self.assertRaises(MessageFailure, self.client.post, add_url, + data, follow=True) - @override_settings( - MIDDLEWARE_CLASSES=filter( - lambda m: 'MessageMiddleware' not in m, settings.MIDDLEWARE_CLASSES), - TEMPLATE_CONTEXT_PROCESSORS=filter( - lambda p: 'context_processors.messages' not in p, - settings.TEMPLATE_CONTEXT_PROCESSORS), - MESSAGE_LEVEL=constants.DEBUG + @modify_settings( + INSTALLED_APPS={'remove': 'django.contrib.messages'}, + MIDDLEWARE_CLASSES={'remove': 'django.contrib.messages.middleware.MessageMiddleware'}, + TEMPLATE_CONTEXT_PROCESSORS={'remove': 'django.contrib.messages.context_processors.messages'}, ) def test_middleware_disabled_fail_silently(self): """ Tests that, when the middleware is disabled, an exception is not raised if 'fail_silently' = True """ - with app_cache._without_app('django.contrib.messages'): - data = { - 'messages': ['Test message %d' % x for x in range(5)], - 'fail_silently': True, - } - show_url = reverse('django.contrib.messages.tests.urls.show') - for level in ('debug', 'info', 'success', 'warning', 'error'): - add_url = reverse('django.contrib.messages.tests.urls.add', - args=(level,)) - response = self.client.post(add_url, data, follow=True) - self.assertRedirects(response, show_url) - self.assertFalse('messages' in response.context) + data = { + 'messages': ['Test message %d' % x for x in range(5)], + 'fail_silently': True, + } + show_url = reverse('django.contrib.messages.tests.urls.show') + for level in ('debug', 'info', 'success', 'warning', 'error'): + add_url = reverse('django.contrib.messages.tests.urls.add', + args=(level,)) + response = self.client.post(add_url, data, follow=True) + self.assertRedirects(response, show_url) + self.assertFalse('messages' in response.context) def stored_messages_count(self, storage, response): """ diff --git a/django/contrib/redirects/tests.py b/django/contrib/redirects/tests.py index 0784a6a6f3..99c5c3fd38 100644 --- a/django/contrib/redirects/tests.py +++ b/django/contrib/redirects/tests.py @@ -1,22 +1,18 @@ from django import http -from django.apps import app_cache from django.conf import settings from django.contrib.sites.models import Site from django.core.exceptions import ImproperlyConfigured from django.test import TestCase -from django.test.utils import override_settings +from django.test.utils import modify_settings, override_settings from django.utils import six from .middleware import RedirectFallbackMiddleware from .models import Redirect -@override_settings( - APPEND_SLASH=False, - MIDDLEWARE_CLASSES=list(settings.MIDDLEWARE_CLASSES) + - ['django.contrib.redirects.middleware.RedirectFallbackMiddleware'], - SITE_ID=1, -) +@modify_settings(MIDDLEWARE_CLASSES={'append': + 'django.contrib.redirects.middleware.RedirectFallbackMiddleware'}) +@override_settings(APPEND_SLASH=False, SITE_ID=1) class RedirectTests(TestCase): def setUp(self): @@ -57,10 +53,10 @@ class RedirectTests(TestCase): response = self.client.get('/initial') self.assertEqual(response.status_code, 410) + @modify_settings(INSTALLED_APPS={'remove': 'django.contrib.sites'}) def test_sites_not_installed(self): - with app_cache._without_app('django.contrib.sites'): - with self.assertRaises(ImproperlyConfigured): - RedirectFallbackMiddleware() + with self.assertRaises(ImproperlyConfigured): + RedirectFallbackMiddleware() class OverriddenRedirectFallbackMiddleware(RedirectFallbackMiddleware): @@ -69,11 +65,9 @@ class OverriddenRedirectFallbackMiddleware(RedirectFallbackMiddleware): response_redirect_class = http.HttpResponseRedirect -@override_settings( - MIDDLEWARE_CLASSES=list(settings.MIDDLEWARE_CLASSES) + - ['django.contrib.redirects.tests.OverriddenRedirectFallbackMiddleware'], - SITE_ID=1, -) +@modify_settings(MIDDLEWARE_CLASSES={'append': + 'django.contrib.redirects.tests.OverriddenRedirectFallbackMiddleware'}) +@override_settings(SITE_ID=1) class OverriddenRedirectMiddlewareTests(TestCase): def setUp(self): diff --git a/django/contrib/sitemaps/tests/test_http.py b/django/contrib/sitemaps/tests/test_http.py index fca644538b..583b0b44bf 100644 --- a/django/contrib/sitemaps/tests/test_http.py +++ b/django/contrib/sitemaps/tests/test_http.py @@ -9,7 +9,7 @@ from django.conf import settings from django.contrib.sitemaps import Sitemap, GenericSitemap from django.contrib.sites.models import Site from django.core.exceptions import ImproperlyConfigured -from django.test.utils import override_settings +from django.test import modify_settings, override_settings from django.utils.formats import localize from django.utils._os import upath from django.utils.translation import activate, deactivate @@ -106,17 +106,17 @@ class HTTPSitemapTests(SitemapTestsBase): self.assertContains(response, '%s' % date.today()) deactivate() + @modify_settings(INSTALLED_APPS={'remove': 'django.contrib.sites'}) def test_requestsite_sitemap(self): # Make sure hitting the flatpages sitemap without the sites framework # installed doesn't raise an exception. - with app_cache._without_app('django.contrib.sites'): - response = self.client.get('/simple/sitemap.xml') - expected_content = """ + response = self.client.get('/simple/sitemap.xml') + expected_content = """ http://testserver/location/%snever0.5 """ % date.today() - self.assertXMLEqual(response.content.decode('utf-8'), expected_content) + self.assertXMLEqual(response.content.decode('utf-8'), expected_content) @skipUnless(app_cache.has_app('django.contrib.sites'), "django.contrib.sites app not installed.") @@ -128,14 +128,14 @@ class HTTPSitemapTests(SitemapTestsBase): Site.objects.all().delete() self.assertRaises(ImproperlyConfigured, Sitemap().get_urls) + @modify_settings(INSTALLED_APPS={'remove': 'django.contrib.sites'}) def test_sitemap_get_urls_no_site_2(self): """ Check we get ImproperlyConfigured when we don't pass a site object to Sitemap.get_urls if Site objects exists, but the sites framework is not actually installed. """ - with app_cache._without_app('django.contrib.sites'): - self.assertRaises(ImproperlyConfigured, Sitemap().get_urls) + self.assertRaises(ImproperlyConfigured, Sitemap().get_urls) def test_sitemap_item(self): """ diff --git a/django/contrib/sites/tests.py b/django/contrib/sites/tests.py index 79bcae9aa6..fee1189c97 100644 --- a/django/contrib/sites/tests.py +++ b/django/contrib/sites/tests.py @@ -1,22 +1,18 @@ from __future__ import unicode_literals -from django.apps import app_cache from django.conf import settings from django.contrib.sites.models import Site, RequestSite, get_current_site from django.core.exceptions import ObjectDoesNotExist, ValidationError from django.http import HttpRequest from django.test import TestCase -from django.test.utils import override_settings +from django.test.utils import modify_settings, override_settings +@modify_settings(INSTALLED_APPS={'append': 'django.contrib.sites'}) class SitesFrameworkTests(TestCase): def setUp(self): Site(id=settings.SITE_ID, domain="example.com", name="example.com").save() - self._with_sites = app_cache._begin_with_app('django.contrib.sites') - - def tearDown(self): - app_cache._end_with_app(self._with_sites) def test_save_another(self): # Regression for #17415 @@ -67,7 +63,7 @@ class SitesFrameworkTests(TestCase): self.assertRaises(ObjectDoesNotExist, get_current_site, request) # A RequestSite is returned if the sites framework is not installed - with app_cache._without_app('django.contrib.sites'): + with self.modify_settings(INSTALLED_APPS={'remove': 'django.contrib.sites'}): site = get_current_site(request) self.assertTrue(isinstance(site, RequestSite)) self.assertEqual(site.name, "example.com") diff --git a/tests/admin_docs/tests.py b/tests/admin_docs/tests.py index 9e004a5a07..9f5ace0360 100644 --- a/tests/admin_docs/tests.py +++ b/tests/admin_docs/tests.py @@ -1,13 +1,12 @@ import unittest -from django.apps import app_cache from django.conf import settings from django.contrib.sites.models import Site from django.contrib.admindocs import utils from django.contrib.auth.models import User from django.core.urlresolvers import reverse from django.test import TestCase -from django.test.utils import override_settings +from django.test.utils import modify_settings, override_settings class MiscTests(TestCase): @@ -17,15 +16,16 @@ class MiscTests(TestCase): User.objects.create_superuser('super', None, 'secret') self.client.login(username='super', password='secret') + @modify_settings(INSTALLED_APPS={'remove': 'django.contrib.sites'}) + @override_settings(SITE_ID=None) # will restore SITE_ID after the test def test_no_sites_framework(self): """ Without the sites framework, should not access SITE_ID or Site objects. Deleting settings is fine here as UserSettingsHolder is used. """ - with self.settings(SITE_ID=None), app_cache._without_app('django.contrib.sites'): - Site.objects.all().delete() - del settings.SITE_ID - self.client.get('/admindocs/views/') # should not raise + Site.objects.all().delete() + del settings.SITE_ID + self.client.get('/admindocs/views/') # should not raise @override_settings(PASSWORD_HASHERS=('django.contrib.auth.hashers.SHA1PasswordHasher',)) diff --git a/tests/app_loading/tests.py b/tests/app_loading/tests.py index 164e363161..a9dc70f4b1 100644 --- a/tests/app_loading/tests.py +++ b/tests/app_loading/tests.py @@ -2,9 +2,9 @@ from __future__ import unicode_literals import os import sys -from unittest import TestCase from django.apps import app_cache +from django.test import TestCase from django.utils._os import upath from django.utils import six @@ -17,10 +17,9 @@ class EggLoadingTest(TestCase): # The models need to be removed after the test in order to prevent bad # interactions with the flush operation in other tests. - self._old_models = app_cache.app_configs['app_loading'].models.copy() + self._old_models = app_cache.all_models['app_loading'].copy() def tearDown(self): - app_cache.app_configs['app_loading'].models = self._old_models app_cache.all_models['app_loading'] = self._old_models app_cache._get_models_cache = {} @@ -30,7 +29,7 @@ class EggLoadingTest(TestCase): """Models module can be loaded from an app in an egg""" egg_name = '%s/modelapp.egg' % self.egg_dir sys.path.append(egg_name) - with app_cache._with_app('app_with_models'): + with self.settings(INSTALLED_APPS=['app_with_models']): models_module = app_cache.get_app_config('app_with_models').models_module self.assertIsNotNone(models_module) @@ -38,7 +37,7 @@ class EggLoadingTest(TestCase): """Loading an app from an egg that has no models returns no models (and no error)""" egg_name = '%s/nomodelapp.egg' % self.egg_dir sys.path.append(egg_name) - with app_cache._with_app('app_no_models'): + with self.settings(INSTALLED_APPS=['app_no_models']): models_module = app_cache.get_app_config('app_no_models').models_module self.assertIsNone(models_module) @@ -46,7 +45,7 @@ class EggLoadingTest(TestCase): """Models module can be loaded from an app located under an egg's top-level package""" egg_name = '%s/omelet.egg' % self.egg_dir sys.path.append(egg_name) - with app_cache._with_app('omelet.app_with_models'): + with self.settings(INSTALLED_APPS=['omelet.app_with_models']): models_module = app_cache.get_app_config('app_with_models').models_module self.assertIsNotNone(models_module) @@ -54,7 +53,7 @@ class EggLoadingTest(TestCase): """Loading an app with no models from under the top-level egg package generates no error""" egg_name = '%s/omelet.egg' % self.egg_dir sys.path.append(egg_name) - with app_cache._with_app('omelet.app_no_models'): + with self.settings(INSTALLED_APPS=['omelet.app_no_models']): models_module = app_cache.get_app_config('app_no_models').models_module self.assertIsNone(models_module) @@ -63,8 +62,8 @@ class EggLoadingTest(TestCase): egg_name = '%s/brokenapp.egg' % self.egg_dir sys.path.append(egg_name) with six.assertRaisesRegex(self, ImportError, 'modelz'): - with app_cache._with_app('broken_app'): - app_cache.get_app_config('omelet.app_no_models').models_module + with self.settings(INSTALLED_APPS=['broken_app']): + pass class GetModelsTest(TestCase): diff --git a/tests/comment_tests/tests/test_app_api.py b/tests/comment_tests/tests/test_app_api.py index 7098def28a..3d88b7e896 100644 --- a/tests/comment_tests/tests/test_app_api.py +++ b/tests/comment_tests/tests/test_app_api.py @@ -1,10 +1,9 @@ -from django.apps import app_cache from django.conf import settings from django.contrib import comments from django.contrib.comments.models import Comment from django.contrib.comments.forms import CommentForm from django.core.exceptions import ImproperlyConfigured -from django.test.utils import override_settings +from django.test import modify_settings, override_settings from django.utils import six from . import CommentTestCase @@ -35,16 +34,11 @@ class CommentAppAPITests(CommentTestCase): self.assertEqual(comments.get_approve_url(c), "/approve/12345/") +@modify_settings(INSTALLED_APPS={'append': 'comment_tests.custom_comments'}) @override_settings(COMMENTS_APP='comment_tests.custom_comments') class CustomCommentTest(CommentTestCase): urls = 'comment_tests.urls' - def setUp(self): - self._with_custom_comments = app_cache._begin_with_app('comment_tests.custom_comments') - - def tearDown(self): - app_cache._end_with_app(self._with_custom_comments) - def testGetCommentApp(self): from comment_tests import custom_comments self.assertEqual(comments.get_comment_app(), custom_comments) diff --git a/tests/i18n/tests.py b/tests/i18n/tests.py index 8d8b5fbe9c..d8d2daaf0d 100644 --- a/tests/i18n/tests.py +++ b/tests/i18n/tests.py @@ -8,7 +8,6 @@ import os import pickle from threading import local -from django.apps import app_cache from django.conf import settings from django.template import Template, Context from django.template.base import TemplateSyntaxError @@ -1039,21 +1038,18 @@ class ResolutionOrderI18NTests(TransRealMixin, TestCase): class AppResolutionOrderI18NTests(ResolutionOrderI18NTests): def test_app_translation(self): - # This test relies on an implementation detail, namely the fact that - # _with_app adds the app at the list. Adjust the test if this changes. - # Original translation. self.assertUgettext('Date/time', 'Datum/Zeit') # Different translation. - with app_cache._with_app('i18n.resolution'): + with self.modify_settings(INSTALLED_APPS={'append': 'i18n.resolution'}): self.flush_caches() activate('de') # Doesn't work because it's added later in the list. self.assertUgettext('Date/time', 'Datum/Zeit') - with app_cache._without_app('admin'): + with self.modify_settings(INSTALLED_APPS={'remove': 'django.contrib.admin'}): self.flush_caches() activate('de') @@ -1068,7 +1064,7 @@ class LocalePathsResolutionOrderI18NTests(ResolutionOrderI18NTests): self.assertUgettext('Time', 'LOCALE_PATHS') def test_locale_paths_override_app_translation(self): - with app_cache._with_app('i18n.resolution'): + with self.settings(INSTALLED_APPS=['i18n.resolution']): self.assertUgettext('Time', 'LOCALE_PATHS') diff --git a/tests/invalid_models_tests/tests.py b/tests/invalid_models_tests/tests.py index 09c19d453c..852e1dbb0d 100644 --- a/tests/invalid_models_tests/tests.py +++ b/tests/invalid_models_tests/tests.py @@ -3,7 +3,7 @@ import unittest from django.apps import app_cache from django.core.management.validation import get_validation_errors -from django.test.utils import override_settings +from django.test import override_settings from django.utils.six import StringIO @@ -26,14 +26,14 @@ class InvalidModelTestCase(unittest.TestCase): # easier to set this up as an override than to require every developer # to specify a value in their test settings. @override_settings( + INSTALLED_APPS=['invalid_models_tests.invalid_models'], TEST_SWAPPED_MODEL='invalid_models.ReplacementModel', TEST_SWAPPED_MODEL_BAD_VALUE='not-a-model', TEST_SWAPPED_MODEL_BAD_MODEL='not_an_app.Target', ) def test_invalid_models(self): - with app_cache._with_app("invalid_models_tests.invalid_models"): - module = app_cache.get_app_config("invalid_models").models_module - get_validation_errors(self.stdout, module) + module = app_cache.get_app_config("invalid_models").models_module + get_validation_errors(self.stdout, module) self.stdout.seek(0) error_log = self.stdout.read() diff --git a/tests/migrations/test_writer.py b/tests/migrations/test_writer.py index df3d052610..42e6c4356d 100644 --- a/tests/migrations/test_writer.py +++ b/tests/migrations/test_writer.py @@ -5,7 +5,6 @@ from __future__ import unicode_literals import datetime import os -from django.apps import app_cache from django.core.validators import RegexValidator, EmailValidator from django.db import models, migrations from django.db.migrations.writer import MigrationWriter @@ -123,7 +122,7 @@ class WriterTests(TestCase): base_dir = os.path.dirname(os.path.dirname(__file__)) for app in test_apps: - with app_cache._with_app(app): + with self.modify_settings(INSTALLED_APPS={'append': app}): migration = migrations.Migration('0001_initial', app.split('.')[-1]) expected_path = os.path.join(base_dir, *(app.split('.') + ['migrations', '0001_initial.py'])) writer = MigrationWriter(migration) diff --git a/tests/proxy_model_inheritance/tests.py b/tests/proxy_model_inheritance/tests.py index c0b564746d..06b47ff82d 100644 --- a/tests/proxy_model_inheritance/tests.py +++ b/tests/proxy_model_inheritance/tests.py @@ -3,7 +3,6 @@ from __future__ import unicode_literals import os import sys -from django.apps import app_cache from django.core.management import call_command from django.test import TestCase, TransactionTestCase from django.utils._os import upath @@ -28,7 +27,7 @@ class ProxyModelInheritanceTests(TransactionTestCase): sys.path = self.old_sys_path def test_table_exists(self): - with app_cache._with_app('app1'), app_cache._with_app('app2'): + with self.modify_settings(INSTALLED_APPS={'append': ['app1', 'app2']}): call_command('migrate', verbosity=0) from .app1.models import ProxyModel from .app2.models import NiceModel diff --git a/tests/runtests.py b/tests/runtests.py index 88973308cf..c75d8a3ee9 100755 --- a/tests/runtests.py +++ b/tests/runtests.py @@ -86,7 +86,7 @@ def get_installed(): def setup(verbosity, test_labels): import django - from django.apps import app_cache + from django.apps import app_cache, AppConfig from django.conf import settings from django.test import TransactionTestCase, TestCase @@ -165,9 +165,11 @@ def setup(verbosity, test_labels): if verbosity >= 2: print("Importing application %s" % module_name) # HACK. - app_cache._begin_with_app(module_label) if module_label not in settings.INSTALLED_APPS: settings.INSTALLED_APPS.append(module_label) + app_config = AppConfig.create(module_label) + app_config.import_models(app_cache.all_models[app_config.label]) + app_cache.app_configs[app_config.label] = app_config return state diff --git a/tests/template_tests/test_loaders.py b/tests/template_tests/test_loaders.py index eadb3fb02a..42330b8782 100644 --- a/tests/template_tests/test_loaders.py +++ b/tests/template_tests/test_loaders.py @@ -20,12 +20,10 @@ except ImportError: pkg_resources = None -from django.apps import app_cache from django.template import TemplateDoesNotExist, Context from django.template.loaders.eggs import Loader as EggLoader from django.template import loader -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils import six from django.utils._os import upath from django.utils.six import StringIO @@ -78,25 +76,25 @@ class EggLoaderTest(TestCase): os.path.normcase('templates/x.txt'): StringIO("x"), }) + @override_settings(INSTALLED_APPS=['egg_empty']) def test_empty(self): "Loading any template on an empty egg should fail" - with app_cache._with_app('egg_empty'): - egg_loader = EggLoader() - self.assertRaises(TemplateDoesNotExist, egg_loader.load_template_source, "not-existing.html") + egg_loader = EggLoader() + self.assertRaises(TemplateDoesNotExist, egg_loader.load_template_source, "not-existing.html") + @override_settings(INSTALLED_APPS=['egg_1']) def test_non_existing(self): "Template loading fails if the template is not in the egg" - with app_cache._with_app('egg_1'): - egg_loader = EggLoader() - self.assertRaises(TemplateDoesNotExist, egg_loader.load_template_source, "not-existing.html") + egg_loader = EggLoader() + self.assertRaises(TemplateDoesNotExist, egg_loader.load_template_source, "not-existing.html") + @override_settings(INSTALLED_APPS=['egg_1']) def test_existing(self): "A template can be loaded from an egg" - with app_cache._with_app('egg_1'): - egg_loader = EggLoader() - contents, template_name = egg_loader.load_template_source("y.html") - self.assertEqual(contents, "y") - self.assertEqual(template_name, "egg:egg_1:templates/y.html") + egg_loader = EggLoader() + contents, template_name = egg_loader.load_template_source("y.html") + self.assertEqual(contents, "y") + self.assertEqual(template_name, "egg:egg_1:templates/y.html") def test_not_installed(self): "Loading an existent template from an egg not included in any app should fail" diff --git a/tests/template_tests/tests.py b/tests/template_tests/tests.py index 4dc0925070..0afb3a8729 100644 --- a/tests/template_tests/tests.py +++ b/tests/template_tests/tests.py @@ -16,7 +16,6 @@ import unittest import warnings from django import template -from django.apps import app_cache from django.core import urlresolvers from django.template import (base as template_base, loader, Context, RequestContext, Template, TemplateSyntaxError) @@ -1879,10 +1878,10 @@ class TemplateTagLoading(TestCase): egg_name = '%s/tagsegg.egg' % self.egg_dir sys.path.append(egg_name) with self.assertRaises(template.TemplateSyntaxError): - with app_cache._with_app('tagsegg'): + with self.settings(INSTALLED_APPS=['tagsegg']): template.Template(ttext) try: - with app_cache._with_app('tagsegg'): + with self.settings(INSTALLED_APPS=['tagsegg']): template.Template(ttext) except template.TemplateSyntaxError as e: self.assertTrue('ImportError' in e.args[0]) @@ -1892,7 +1891,7 @@ class TemplateTagLoading(TestCase): ttext = "{% load working_egg %}" egg_name = '%s/tagsegg.egg' % self.egg_dir sys.path.append(egg_name) - with app_cache._with_app('tagsegg'): + with self.settings(INSTALLED_APPS=['tagsegg']): template.Template(ttext) diff --git a/tests/utils_tests/test_autoreload.py b/tests/utils_tests/test_autoreload.py index 5071566e92..1024b02efe 100644 --- a/tests/utils_tests/test_autoreload.py +++ b/tests/utils_tests/test_autoreload.py @@ -1,7 +1,6 @@ import os from django import conf -from django.apps import app_cache from django.contrib import admin from django.test import TestCase, override_settings from django.utils.autoreload import gen_filenames @@ -28,6 +27,7 @@ class TestFilenameGenerator(TestCase): self.assertIn(os.path.join(LOCALE_PATH, 'nl', 'LC_MESSAGES', 'django.mo'), filenames) + @override_settings(INSTALLED_APPS=[]) def test_project_root_locale(self): """ Test that gen_filenames also yields from the current directory (project @@ -36,22 +36,19 @@ class TestFilenameGenerator(TestCase): old_cwd = os.getcwd() os.chdir(os.path.dirname(__file__)) try: - # Remove the current app from the app cache to guarantee that the - # files will be found thanks to the current working directory. - with app_cache._empty(): - filenames = list(gen_filenames()) + filenames = list(gen_filenames()) self.assertIn( os.path.join(LOCALE_PATH, 'nl', 'LC_MESSAGES', 'django.mo'), filenames) finally: os.chdir(old_cwd) + @override_settings(INSTALLED_APPS=['django.contrib.admin']) def test_app_locales(self): """ Test that gen_filenames also yields from locale dirs in installed apps. """ - with app_cache._empty(), app_cache._with_app('django.contrib.admin'): - filenames = list(gen_filenames()) + filenames = list(gen_filenames()) self.assertIn(os.path.join(os.path.dirname(admin.__file__), 'locale', 'nl', 'LC_MESSAGES', 'django.mo'), filenames) diff --git a/tests/utils_tests/test_module_loading.py b/tests/utils_tests/test_module_loading.py index baaab36494..0bba98e8c2 100644 --- a/tests/utils_tests/test_module_loading.py +++ b/tests/utils_tests/test_module_loading.py @@ -5,9 +5,8 @@ import sys import unittest from zipimport import zipimporter -from django.apps import app_cache from django.core.exceptions import ImproperlyConfigured -from django.test import SimpleTestCase +from django.test import SimpleTestCase, modify_settings from django.utils import six from django.utils.module_loading import autodiscover_modules, import_by_path, module_has_submodule from django.utils._os import upath @@ -135,14 +134,9 @@ class ModuleImportTestCase(unittest.TestCase): 'Should have more than the calling frame in the traceback.') +@modify_settings(INSTALLED_APPS={'append': 'utils_tests.test_module'}) class AutodiscoverModulesTestCase(SimpleTestCase): - def setUp(self): - self._with_test_module = app_cache._begin_with_app('utils_tests.test_module') - - def tearDown(self): - app_cache._end_with_app(self._with_test_module) - def test_autodiscover_modules_found(self): autodiscover_modules('good_module') diff --git a/tests/view_tests/tests/test_i18n.py b/tests/view_tests/tests/test_i18n.py index 8f0f9896ba..35b37b3ea1 100644 --- a/tests/view_tests/tests/test_i18n.py +++ b/tests/view_tests/tests/test_i18n.py @@ -4,11 +4,10 @@ import os from os import path import unittest -from django.apps import app_cache from django.conf import settings from django.core.urlresolvers import reverse -from django.test import LiveServerTestCase, TestCase -from django.test.utils import override_settings +from django.test import ( + LiveServerTestCase, TestCase, modify_settings, override_settings) from django.utils import six from django.utils._os import upath from django.utils.translation import override @@ -110,16 +109,16 @@ class JsI18NTests(TestCase): response = self.client.get('/views/jsi18n/') self.assertNotContains(response, 'Choisir une heure') + @modify_settings(INSTALLED_APPS={'append': 'view_tests.app0'}) def test_nonenglish_default_english_userpref(self): """ Same as above with the difference that there IS an 'en' translation available. The Javascript i18n view must return a NON empty language catalog with the proper English translations. See #13726 for more details. """ - with app_cache._with_app('view_tests.app0'): - with self.settings(LANGUAGE_CODE='fr'), override('en-us'): - response = self.client.get('/views/jsi18n_english_translation/') - self.assertContains(response, javascript_quote('this app0 string is to be translated')) + with self.settings(LANGUAGE_CODE='fr'), override('en-us'): + response = self.client.get('/views/jsi18n_english_translation/') + self.assertContains(response, javascript_quote('this app0 string is to be translated')) def testI18NLanguageNonEnglishFallback(self): """ @@ -141,6 +140,7 @@ class JsI18NTestsMultiPackage(TestCase): Tests for django views in django/views/i18n.py that need to change settings.LANGUAGE_CODE and merge JS translation from several packages. """ + @modify_settings(INSTALLED_APPS={'append': ['view_tests.app1', 'view_tests.app2']}) def testI18NLanguageEnglishDefault(self): """ Check if the JavaScript i18n view returns a complete language catalog @@ -149,20 +149,19 @@ class JsI18NTestsMultiPackage(TestCase): translations of multiple Python packages is requested. See #13388, #3594 and #13514 for more details. """ - with app_cache._with_app('view_tests.app1'), app_cache._with_app('view_tests.app2'): - with self.settings(LANGUAGE_CODE='en-us'), override('fr'): - response = self.client.get('/views/jsi18n_multi_packages1/') - self.assertContains(response, javascript_quote('il faut traduire cette chaîne de caractères de app1')) + with self.settings(LANGUAGE_CODE='en-us'), override('fr'): + response = self.client.get('/views/jsi18n_multi_packages1/') + self.assertContains(response, javascript_quote('il faut traduire cette chaîne de caractères de app1')) + @modify_settings(INSTALLED_APPS={'append': ['view_tests.app3', 'view_tests.app4']}) def testI18NDifferentNonEnLangs(self): """ Similar to above but with neither default or requested language being English. """ - with app_cache._with_app('view_tests.app3'), app_cache._with_app('view_tests.app4'): - with self.settings(LANGUAGE_CODE='fr'), override('es-ar'): - response = self.client.get('/views/jsi18n_multi_packages2/') - self.assertContains(response, javascript_quote('este texto de app3 debe ser traducido')) + with self.settings(LANGUAGE_CODE='fr'), override('es-ar'): + response = self.client.get('/views/jsi18n_multi_packages2/') + self.assertContains(response, javascript_quote('este texto de app3 debe ser traducido')) def testI18NWithLocalePaths(self): extended_locale_paths = settings.LOCALE_PATHS + ( From e32095616c50bef9b06dc8637a99584ba947bae5 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 23 Dec 2013 16:01:13 +0100 Subject: [PATCH 034/208] Imported override_settings from its new location. --- django/contrib/auth/tests/test_auth_backends.py | 3 +-- django/contrib/auth/tests/test_basic.py | 3 +-- django/contrib/auth/tests/test_context_processors.py | 3 +-- django/contrib/auth/tests/test_forms.py | 3 +-- django/contrib/auth/tests/test_handlers.py | 2 +- django/contrib/auth/tests/test_management.py | 3 +-- django/contrib/auth/tests/test_models.py | 3 +-- django/contrib/auth/tests/test_signals.py | 2 +- django/contrib/auth/tests/test_templates.py | 2 +- django/contrib/auth/tests/test_views.py | 4 ++-- django/contrib/contenttypes/tests.py | 3 +-- django/contrib/flatpages/tests/test_csrf.py | 2 +- django/contrib/flatpages/tests/test_forms.py | 3 +-- django/contrib/flatpages/tests/test_middleware.py | 3 +-- django/contrib/flatpages/tests/test_templatetags.py | 3 +-- django/contrib/flatpages/tests/test_views.py | 3 +-- django/contrib/formtools/tests/tests.py | 3 +-- django/contrib/gis/tests/geoadmin/tests.py | 3 +-- django/contrib/humanize/tests.py | 4 ++-- django/contrib/messages/tests/base.py | 2 +- django/contrib/messages/tests/test_cookie.py | 3 +-- django/contrib/redirects/tests.py | 3 +-- django/contrib/sessions/tests.py | 4 ++-- django/contrib/sitemaps/tests/test_generic.py | 2 +- django/contrib/sitemaps/tests/test_https.py | 2 +- django/contrib/sites/tests.py | 3 +-- tests/admin_custom_urls/tests.py | 3 +-- tests/admin_docs/tests.py | 3 +-- tests/admin_filters/tests.py | 4 ++-- tests/admin_inlines/tests.py | 3 +-- tests/admin_views/tests.py | 2 +- tests/admin_widgets/tests.py | 2 +- tests/backends/tests.py | 6 +++--- tests/bulk_create/tests.py | 2 +- tests/cache/tests.py | 4 ++-- tests/comment_tests/tests/__init__.py | 3 +-- tests/comment_tests/tests/test_comment_form.py | 2 +- tests/comment_tests/tests/test_comment_utils_moderators.py | 2 +- tests/csrf_tests/tests.py | 3 +-- tests/defer_regress/tests.py | 3 +-- tests/file_storage/tests.py | 2 +- tests/file_uploads/tests.py | 2 +- tests/fixtures_regress/tests.py | 2 +- tests/forms_tests/tests/test_extra.py | 3 +-- tests/forms_tests/tests/test_input_formats.py | 2 +- tests/forms_tests/tests/test_media.py | 3 +-- tests/forms_tests/tests/test_widgets.py | 3 +-- tests/generic_inline_admin/tests.py | 3 +-- tests/generic_views/test_dates.py | 4 ++-- tests/generic_views/test_list.py | 3 +-- tests/handlers/tests.py | 2 +- tests/i18n/contenttypes/tests.py | 4 ++-- tests/i18n/patterns/tests.py | 3 +-- tests/i18n/test_compilation.py | 2 +- tests/i18n/test_extraction.py | 2 +- tests/i18n/tests.py | 4 ++-- tests/initial_sql_regress/tests.py | 3 +-- tests/logging_tests/tests.py | 4 ++-- tests/mail/tests.py | 2 +- tests/managers_regress/tests.py | 3 +-- tests/middleware/tests.py | 4 ++-- tests/middleware_exceptions/tests.py | 3 +-- tests/migrations/test_commands.py | 2 +- tests/migrations/test_executor.py | 3 ++- tests/migrations/test_loader.py | 3 +-- tests/modeladmin/tests.py | 4 ++-- tests/multiple_database/tests.py | 3 +-- tests/prefetch_related/tests.py | 3 +-- tests/proxy_models/tests.py | 3 +-- tests/requests/tests.py | 4 ++-- tests/select_for_update/tests.py | 2 +- tests/serializers/tests.py | 4 ++-- tests/servers/tests.py | 2 +- tests/settings_tests/tests.py | 4 ++-- tests/staticfiles_tests/test_liveserver.py | 2 +- tests/staticfiles_tests/tests.py | 3 +-- tests/swappable_models/tests.py | 3 +-- tests/template_tests/test_nodelist.py | 2 +- tests/template_tests/test_parser.py | 2 +- tests/template_tests/test_response.py | 2 +- tests/test_client/tests.py | 2 +- tests/test_client_regress/tests.py | 4 ++-- tests/timezones/tests.py | 4 ++-- tests/transactions_regress/tests.py | 4 ++-- tests/urlpatterns_reverse/tests.py | 3 +-- tests/utils_tests/test_dateformat.py | 3 +-- tests/utils_tests/test_timezone.py | 2 +- tests/view_tests/tests/test_debug.py | 6 +++--- tests/view_tests/tests/test_shortcuts.py | 3 +-- tests/view_tests/tests/test_static.py | 3 +-- tests/wsgi/tests.py | 3 +-- 91 files changed, 113 insertions(+), 154 deletions(-) diff --git a/django/contrib/auth/tests/test_auth_backends.py b/django/contrib/auth/tests/test_auth_backends.py index 757ad290a7..4331b8496c 100644 --- a/django/contrib/auth/tests/test_auth_backends.py +++ b/django/contrib/auth/tests/test_auth_backends.py @@ -10,8 +10,7 @@ from django.contrib.contenttypes.models import ContentType from django.core.exceptions import ImproperlyConfigured, PermissionDenied from django.contrib.auth import authenticate, get_user from django.http import HttpRequest -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.contrib.auth.hashers import MD5PasswordHasher diff --git a/django/contrib/auth/tests/test_basic.py b/django/contrib/auth/tests/test_basic.py index 34b6142632..ec33aece25 100644 --- a/django/contrib/auth/tests/test_basic.py +++ b/django/contrib/auth/tests/test_basic.py @@ -11,9 +11,8 @@ from django.contrib.auth.tests.utils import skipIfCustomUser from django.core.exceptions import ImproperlyConfigured from django.core.management import call_command from django.dispatch import receiver -from django.test import TestCase +from django.test import TestCase, override_settings from django.test.signals import setting_changed -from django.test.utils import override_settings from django.utils import translation from django.utils.encoding import force_str from django.utils.six import binary_type, PY2, StringIO diff --git a/django/contrib/auth/tests/test_context_processors.py b/django/contrib/auth/tests/test_context_processors.py index bf30790a8a..48c5b77f20 100644 --- a/django/contrib/auth/tests/test_context_processors.py +++ b/django/contrib/auth/tests/test_context_processors.py @@ -7,8 +7,7 @@ from django.contrib.auth.models import User, Permission from django.contrib.contenttypes.models import ContentType from django.contrib.auth.context_processors import PermWrapper, PermLookupDict from django.db.models import Q -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils._os import upath diff --git a/django/contrib/auth/tests/test_forms.py b/django/contrib/auth/tests/test_forms.py index 41cb3350b1..837db709a5 100644 --- a/django/contrib/auth/tests/test_forms.py +++ b/django/contrib/auth/tests/test_forms.py @@ -12,8 +12,7 @@ from django.contrib.auth.forms import (UserCreationForm, AuthenticationForm, from django.contrib.auth.tests.utils import skipIfCustomUser from django.core import mail from django.forms.fields import Field, CharField -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils.encoding import force_text from django.utils._os import upath from django.utils import translation diff --git a/django/contrib/auth/tests/test_handlers.py b/django/contrib/auth/tests/test_handlers.py index b86775fc28..f041bd54e1 100644 --- a/django/contrib/auth/tests/test_handlers.py +++ b/django/contrib/auth/tests/test_handlers.py @@ -5,7 +5,7 @@ from django.contrib.auth.models import User, Group from django.contrib.auth.tests.custom_user import CustomUser from django.contrib.auth.tests.utils import skipIfCustomUser from django.test import TransactionTestCase -from django.test.utils import override_settings +from django.test import override_settings # This must be a TransactionTestCase because the WSGI auth handler performs diff --git a/django/contrib/auth/tests/test_management.py b/django/contrib/auth/tests/test_management.py index c005e74442..57c986ac8a 100644 --- a/django/contrib/auth/tests/test_management.py +++ b/django/contrib/auth/tests/test_management.py @@ -13,8 +13,7 @@ from django.core import exceptions from django.core.management import call_command from django.core.management.base import CommandError from django.core.management.validation import get_validation_errors -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils import six from django.utils.six import StringIO diff --git a/django/contrib/auth/tests/test_models.py b/django/contrib/auth/tests/test_models.py index a858bb2566..9e2c653738 100644 --- a/django/contrib/auth/tests/test_models.py +++ b/django/contrib/auth/tests/test_models.py @@ -3,8 +3,7 @@ from django.contrib.auth.models import AbstractUser, Group, User, UserManager from django.contrib.auth.tests.utils import skipIfCustomUser from django.core import mail from django.db.models.signals import post_save -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings @skipIfCustomUser diff --git a/django/contrib/auth/tests/test_signals.py b/django/contrib/auth/tests/test_signals.py index 024f44f547..81266807c9 100644 --- a/django/contrib/auth/tests/test_signals.py +++ b/django/contrib/auth/tests/test_signals.py @@ -3,7 +3,7 @@ from django.contrib.auth.models import User from django.contrib.auth.tests.utils import skipIfCustomUser from django.test import TestCase from django.test.client import RequestFactory -from django.test.utils import override_settings +from django.test import override_settings @skipIfCustomUser diff --git a/django/contrib/auth/tests/test_templates.py b/django/contrib/auth/tests/test_templates.py index f7d74748a2..1d1a8b49a8 100644 --- a/django/contrib/auth/tests/test_templates.py +++ b/django/contrib/auth/tests/test_templates.py @@ -7,7 +7,7 @@ from django.contrib.auth.views import ( password_reset_complete, password_change, password_change_done, ) from django.test import RequestFactory, TestCase -from django.test.utils import override_settings +from django.test import override_settings from django.utils.encoding import force_bytes, force_text from django.utils.http import urlsafe_base64_encode diff --git a/django/contrib/auth/tests/test_views.py b/django/contrib/auth/tests/test_views.py index 4a1783b14d..6d841c287e 100644 --- a/django/contrib/auth/tests/test_views.py +++ b/django/contrib/auth/tests/test_views.py @@ -14,8 +14,8 @@ from django.utils.encoding import force_text from django.utils.http import urlquote from django.utils.six.moves.urllib.parse import urlparse, ParseResult from django.utils._os import upath -from django.test import TestCase -from django.test.utils import override_settings, patch_logger +from django.test import TestCase, override_settings +from django.test.utils import patch_logger from django.middleware.csrf import CsrfViewMiddleware from django.contrib.sessions.middleware import SessionMiddleware diff --git a/django/contrib/contenttypes/tests.py b/django/contrib/contenttypes/tests.py index ceac7ccd1b..2943a83095 100644 --- a/django/contrib/contenttypes/tests.py +++ b/django/contrib/contenttypes/tests.py @@ -5,8 +5,7 @@ from django.contrib.contenttypes.views import shortcut from django.contrib.sites.models import get_current_site from django.db import models from django.http import HttpRequest, Http404 -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils.http import urlquote from django.utils import six from django.utils.encoding import python_2_unicode_compatible diff --git a/django/contrib/flatpages/tests/test_csrf.py b/django/contrib/flatpages/tests/test_csrf.py index 4506433195..23c03a1e13 100644 --- a/django/contrib/flatpages/tests/test_csrf.py +++ b/django/contrib/flatpages/tests/test_csrf.py @@ -2,7 +2,7 @@ import os from django.contrib.auth.models import User from django.contrib.auth.tests.utils import skipIfCustomUser from django.test import TestCase, Client -from django.test.utils import override_settings +from django.test import override_settings @override_settings( diff --git a/django/contrib/flatpages/tests/test_forms.py b/django/contrib/flatpages/tests/test_forms.py index a216b37c67..8a6db742fa 100644 --- a/django/contrib/flatpages/tests/test_forms.py +++ b/django/contrib/flatpages/tests/test_forms.py @@ -3,8 +3,7 @@ from __future__ import unicode_literals from django.conf import settings from django.contrib.flatpages.forms import FlatpageForm from django.contrib.flatpages.models import FlatPage -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils import translation diff --git a/django/contrib/flatpages/tests/test_middleware.py b/django/contrib/flatpages/tests/test_middleware.py index dd1a0192ce..47d29bdb00 100644 --- a/django/contrib/flatpages/tests/test_middleware.py +++ b/django/contrib/flatpages/tests/test_middleware.py @@ -3,8 +3,7 @@ from django.conf import settings from django.contrib.auth.models import User from django.contrib.auth.tests.utils import skipIfCustomUser from django.contrib.flatpages.models import FlatPage -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings @override_settings( diff --git a/django/contrib/flatpages/tests/test_templatetags.py b/django/contrib/flatpages/tests/test_templatetags.py index 39ae734c8c..025c73c2cf 100644 --- a/django/contrib/flatpages/tests/test_templatetags.py +++ b/django/contrib/flatpages/tests/test_templatetags.py @@ -2,8 +2,7 @@ import os from django.contrib.auth.models import AnonymousUser, User from django.contrib.auth.tests.utils import skipIfCustomUser from django.template import Template, Context, TemplateSyntaxError -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings @override_settings( diff --git a/django/contrib/flatpages/tests/test_views.py b/django/contrib/flatpages/tests/test_views.py index 056641e301..d2683fbbf4 100644 --- a/django/contrib/flatpages/tests/test_views.py +++ b/django/contrib/flatpages/tests/test_views.py @@ -3,8 +3,7 @@ from django.conf import settings from django.contrib.auth.models import User from django.contrib.auth.tests.utils import skipIfCustomUser from django.contrib.flatpages.models import FlatPage -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings @override_settings( diff --git a/django/contrib/formtools/tests/tests.py b/django/contrib/formtools/tests/tests.py index 84b0c7e2d0..59939a1ecd 100644 --- a/django/contrib/formtools/tests/tests.py +++ b/django/contrib/formtools/tests/tests.py @@ -8,8 +8,7 @@ import warnings from django import http from django.contrib.formtools import preview, utils -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils._os import upath from django.contrib.formtools.tests.forms import ( diff --git a/django/contrib/gis/tests/geoadmin/tests.py b/django/contrib/gis/tests/geoadmin/tests.py index b39b3183dc..06a8ed245a 100644 --- a/django/contrib/gis/tests/geoadmin/tests.py +++ b/django/contrib/gis/tests/geoadmin/tests.py @@ -4,8 +4,7 @@ from unittest import skipUnless from django.contrib.gis.geos import HAS_GEOS from django.contrib.gis.tests.utils import HAS_SPATIAL_DB -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings if HAS_GEOS and HAS_SPATIAL_DB: from django.contrib.gis import admin diff --git a/django/contrib/humanize/tests.py b/django/contrib/humanize/tests.py index 0f31beb81f..ab4d53c760 100644 --- a/django/contrib/humanize/tests.py +++ b/django/contrib/humanize/tests.py @@ -11,8 +11,8 @@ except ImportError: from django.conf import settings from django.contrib.humanize.templatetags import humanize from django.template import Template, Context, defaultfilters -from django.test import TestCase -from django.test.utils import override_settings, TransRealMixin +from django.test import TestCase, override_settings +from django.test.utils import TransRealMixin from django.utils.html import escape from django.utils.timezone import utc, get_fixed_timezone from django.utils import translation diff --git a/django/contrib/messages/tests/base.py b/django/contrib/messages/tests/base.py index e38749c13e..54592e8d25 100644 --- a/django/contrib/messages/tests/base.py +++ b/django/contrib/messages/tests/base.py @@ -9,7 +9,7 @@ from django.contrib.messages.constants import DEFAULT_LEVELS from django.contrib.messages.storage import default_storage, base from django.contrib.messages.storage.base import Message from django.core.urlresolvers import reverse -from django.test.utils import modify_settings, override_settings +from django.test import modify_settings, override_settings from django.utils.translation import ugettext_lazy diff --git a/django/contrib/messages/tests/test_cookie.py b/django/contrib/messages/tests/test_cookie.py index 028f01382b..d44dd94491 100644 --- a/django/contrib/messages/tests/test_cookie.py +++ b/django/contrib/messages/tests/test_cookie.py @@ -5,8 +5,7 @@ from django.contrib.messages.tests.base import BaseTests from django.contrib.messages.storage.cookie import (CookieStorage, MessageEncoder, MessageDecoder) from django.contrib.messages.storage.base import Message -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils.safestring import SafeData, mark_safe diff --git a/django/contrib/redirects/tests.py b/django/contrib/redirects/tests.py index 99c5c3fd38..3bed0e02e5 100644 --- a/django/contrib/redirects/tests.py +++ b/django/contrib/redirects/tests.py @@ -2,8 +2,7 @@ from django import http from django.conf import settings from django.contrib.sites.models import Site from django.core.exceptions import ImproperlyConfigured -from django.test import TestCase -from django.test.utils import modify_settings, override_settings +from django.test import TestCase, modify_settings, override_settings from django.utils import six from .middleware import RedirectFallbackMiddleware diff --git a/django/contrib/sessions/tests.py b/django/contrib/sessions/tests.py index 51a65a1fef..34b8964153 100644 --- a/django/contrib/sessions/tests.py +++ b/django/contrib/sessions/tests.py @@ -20,8 +20,8 @@ from django.core.cache.backends.base import InvalidCacheBackendError from django.core import management from django.core.exceptions import ImproperlyConfigured from django.http import HttpResponse -from django.test import TestCase, RequestFactory -from django.test.utils import override_settings, patch_logger +from django.test import TestCase, RequestFactory, override_settings +from django.test.utils import patch_logger from django.utils import six from django.utils import timezone diff --git a/django/contrib/sitemaps/tests/test_generic.py b/django/contrib/sitemaps/tests/test_generic.py index 5b265736b3..870e29886d 100644 --- a/django/contrib/sitemaps/tests/test_generic.py +++ b/django/contrib/sitemaps/tests/test_generic.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals -from django.test.utils import override_settings +from django.test import override_settings from .base import TestModel, SitemapTestsBase diff --git a/django/contrib/sitemaps/tests/test_https.py b/django/contrib/sitemaps/tests/test_https.py index 9594d0f7a4..58ff68931e 100644 --- a/django/contrib/sitemaps/tests/test_https.py +++ b/django/contrib/sitemaps/tests/test_https.py @@ -2,7 +2,7 @@ from __future__ import unicode_literals from datetime import date -from django.test.utils import override_settings +from django.test import override_settings from .base import SitemapTestsBase diff --git a/django/contrib/sites/tests.py b/django/contrib/sites/tests.py index fee1189c97..efa4fefa44 100644 --- a/django/contrib/sites/tests.py +++ b/django/contrib/sites/tests.py @@ -4,8 +4,7 @@ from django.conf import settings from django.contrib.sites.models import Site, RequestSite, get_current_site from django.core.exceptions import ObjectDoesNotExist, ValidationError from django.http import HttpRequest -from django.test import TestCase -from django.test.utils import modify_settings, override_settings +from django.test import TestCase, modify_settings, override_settings @modify_settings(INSTALLED_APPS={'append': 'django.contrib.sites'}) diff --git a/tests/admin_custom_urls/tests.py b/tests/admin_custom_urls/tests.py index f7a469efe9..d629c78e04 100644 --- a/tests/admin_custom_urls/tests.py +++ b/tests/admin_custom_urls/tests.py @@ -3,8 +3,7 @@ from __future__ import unicode_literals from django.contrib.admin.utils import quote from django.core.urlresolvers import reverse from django.template.response import TemplateResponse -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from .models import Action, Person, Car diff --git a/tests/admin_docs/tests.py b/tests/admin_docs/tests.py index 9f5ace0360..d2f8386bdb 100644 --- a/tests/admin_docs/tests.py +++ b/tests/admin_docs/tests.py @@ -5,8 +5,7 @@ from django.contrib.sites.models import Site from django.contrib.admindocs import utils from django.contrib.auth.models import User from django.core.urlresolvers import reverse -from django.test import TestCase -from django.test.utils import modify_settings, override_settings +from django.test import TestCase, modify_settings, override_settings class MiscTests(TestCase): diff --git a/tests/admin_filters/tests.py b/tests/admin_filters/tests.py index 7381447051..17c67929dc 100644 --- a/tests/admin_filters/tests.py +++ b/tests/admin_filters/tests.py @@ -8,9 +8,9 @@ from django.contrib.admin.views.main import ChangeList from django.contrib.auth.admin import UserAdmin from django.contrib.auth.models import User from django.core.exceptions import ImproperlyConfigured -from django.test import TestCase, RequestFactory -from django.test.utils import override_settings, six +from django.test import TestCase, RequestFactory, override_settings from django.utils.encoding import force_text +from django.utils import six from .models import Book, Department, Employee diff --git a/tests/admin_inlines/tests.py b/tests/admin_inlines/tests.py index 8d6fc97426..e840e21b81 100644 --- a/tests/admin_inlines/tests.py +++ b/tests/admin_inlines/tests.py @@ -4,8 +4,7 @@ from django.contrib.admin.tests import AdminSeleniumWebDriverTestCase from django.contrib.admin.helpers import InlineAdminForm from django.contrib.auth.models import User, Permission from django.contrib.contenttypes.models import ContentType -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings # local test models from .admin import InnerInline diff --git a/tests/admin_views/tests.py b/tests/admin_views/tests.py index c813ee8437..d01a37725a 100644 --- a/tests/admin_views/tests.py +++ b/tests/admin_views/tests.py @@ -29,7 +29,7 @@ from django.forms.utils import ErrorList from django.template.response import TemplateResponse from django.test import TestCase from django.test.utils import patch_logger -from django.test.utils import override_settings +from django.test import override_settings from django.utils import formats from django.utils import translation from django.utils.cache import get_max_age diff --git a/tests/admin_widgets/tests.py b/tests/admin_widgets/tests.py index 04fe083eea..33833f3eff 100644 --- a/tests/admin_widgets/tests.py +++ b/tests/admin_widgets/tests.py @@ -18,7 +18,7 @@ from django.core.files.storage import default_storage from django.core.files.uploadedfile import SimpleUploadedFile from django.db.models import CharField, DateField from django.test import TestCase as DjangoTestCase -from django.test.utils import override_settings +from django.test import override_settings from django.utils import six from django.utils import translation diff --git a/tests/backends/tests.py b/tests/backends/tests.py index 3a79b79411..a4743aeb41 100644 --- a/tests/backends/tests.py +++ b/tests/backends/tests.py @@ -20,9 +20,9 @@ from django.db.models import Sum, Avg, Variance, StdDev from django.db.models.fields import (AutoField, DateField, DateTimeField, DecimalField, IntegerField, TimeField) from django.db.utils import ConnectionHandler -from django.test import (TestCase, skipUnlessDBFeature, skipIfDBFeature, - TransactionTestCase) -from django.test.utils import override_settings, str_prefix +from django.test import (TestCase, TransactionTestCase, override_settings, + skipUnlessDBFeature, skipIfDBFeature) +from django.test.utils import str_prefix from django.utils import six from django.utils.six.moves import xrange diff --git a/tests/bulk_create/tests.py b/tests/bulk_create/tests.py index 9bb95acb72..367cbde04d 100644 --- a/tests/bulk_create/tests.py +++ b/tests/bulk_create/tests.py @@ -4,7 +4,7 @@ from operator import attrgetter from django.db import connection from django.test import TestCase, skipIfDBFeature, skipUnlessDBFeature -from django.test.utils import override_settings +from django.test import override_settings from .models import Country, Restaurant, Pizzeria, State, TwoFields diff --git a/tests/cache/tests.py b/tests/cache/tests.py index 12e75e24b7..e17bad1523 100644 --- a/tests/cache/tests.py +++ b/tests/cache/tests.py @@ -23,8 +23,8 @@ from django.middleware.cache import (FetchFromCacheMiddleware, UpdateCacheMiddleware, CacheMiddleware) from django.template import Template from django.template.response import TemplateResponse -from django.test import TestCase, TransactionTestCase, RequestFactory -from django.test.utils import (override_settings, IgnoreDeprecationWarningsMixin, +from django.test import TestCase, TransactionTestCase, RequestFactory, override_settings +from django.test.utils import (IgnoreDeprecationWarningsMixin, IgnorePendingDeprecationWarningsMixin) from django.utils import six from django.utils import timezone diff --git a/tests/comment_tests/tests/__init__.py b/tests/comment_tests/tests/__init__.py index 2e247079f8..5f73a995ca 100644 --- a/tests/comment_tests/tests/__init__.py +++ b/tests/comment_tests/tests/__init__.py @@ -3,8 +3,7 @@ from django.contrib.comments.forms import CommentForm from django.contrib.comments.models import Comment from django.contrib.contenttypes.models import ContentType from django.contrib.sites.models import Site -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from ..models import Article, Author diff --git a/tests/comment_tests/tests/test_comment_form.py b/tests/comment_tests/tests/test_comment_form.py index 205b4150e8..d4399fbd2a 100644 --- a/tests/comment_tests/tests/test_comment_form.py +++ b/tests/comment_tests/tests/test_comment_form.py @@ -3,7 +3,7 @@ import time from django.conf import settings from django.contrib.comments.forms import CommentForm from django.contrib.comments.models import Comment -from django.test.utils import override_settings +from django.test import override_settings from . import CommentTestCase from ..models import Article diff --git a/tests/comment_tests/tests/test_comment_utils_moderators.py b/tests/comment_tests/tests/test_comment_utils_moderators.py index e61be48d8b..9de37e47e2 100644 --- a/tests/comment_tests/tests/test_comment_utils_moderators.py +++ b/tests/comment_tests/tests/test_comment_utils_moderators.py @@ -2,7 +2,7 @@ from django.contrib.comments.models import Comment from django.contrib.comments.moderation import (moderator, CommentModerator, AlreadyModerated) from django.core import mail -from django.test.utils import override_settings +from django.test import override_settings from . import CommentTestCase from ..models import Entry diff --git a/tests/csrf_tests/tests.py b/tests/csrf_tests/tests.py index ac48c17af6..4c9153f3a5 100644 --- a/tests/csrf_tests/tests.py +++ b/tests/csrf_tests/tests.py @@ -7,8 +7,7 @@ from django.core.context_processors import csrf from django.http import HttpRequest, HttpResponse from django.middleware.csrf import CsrfViewMiddleware, CSRF_KEY_LENGTH from django.template import RequestContext, Template -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.views.decorators.csrf import csrf_exempt, requires_csrf_token, ensure_csrf_cookie diff --git a/tests/defer_regress/tests.py b/tests/defer_regress/tests.py index 442af9f7cf..b12b3b61b0 100644 --- a/tests/defer_regress/tests.py +++ b/tests/defer_regress/tests.py @@ -6,8 +6,7 @@ from django.apps import app_cache from django.contrib.contenttypes.models import ContentType from django.contrib.sessions.backends.db import SessionStore from django.db.models import Count -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from .models import ( ResolveThis, Item, RelatedItem, Child, Leaf, Proxy, SimpleItem, Feature, diff --git a/tests/file_storage/tests.py b/tests/file_storage/tests.py index 20eaf4c89c..2f047f049a 100644 --- a/tests/file_storage/tests.py +++ b/tests/file_storage/tests.py @@ -21,7 +21,7 @@ from django.core.files.base import File, ContentFile from django.core.files.storage import FileSystemStorage, get_storage_class from django.core.files.uploadedfile import SimpleUploadedFile from django.test import LiveServerTestCase, SimpleTestCase -from django.test.utils import override_settings +from django.test import override_settings from django.utils import six from django.utils.six.moves.urllib.request import urlopen from django.utils._os import upath diff --git a/tests/file_uploads/tests.py b/tests/file_uploads/tests.py index 7aa6797630..f4e4ea31b2 100644 --- a/tests/file_uploads/tests.py +++ b/tests/file_uploads/tests.py @@ -14,7 +14,7 @@ from django.core.files import temp as tempfile from django.core.files.uploadedfile import SimpleUploadedFile from django.http.multipartparser import MultiPartParser from django.test import TestCase, client -from django.test.utils import override_settings +from django.test import override_settings from django.utils.encoding import force_bytes from django.utils.six import StringIO diff --git a/tests/fixtures_regress/tests.py b/tests/fixtures_regress/tests.py index 3757dc5180..6984db30c6 100644 --- a/tests/fixtures_regress/tests.py +++ b/tests/fixtures_regress/tests.py @@ -15,7 +15,7 @@ from django.db import transaction, IntegrityError from django.db.models import signals from django.test import (TestCase, TransactionTestCase, skipIfDBFeature, skipUnlessDBFeature) -from django.test.utils import override_settings +from django.test import override_settings from django.utils.encoding import force_text from django.utils._os import upath from django.utils import six diff --git a/tests/forms_tests/tests/test_extra.py b/tests/forms_tests/tests/test_extra.py index 7988b52da4..100c655117 100644 --- a/tests/forms_tests/tests/test_extra.py +++ b/tests/forms_tests/tests/test_extra.py @@ -12,8 +12,7 @@ from django.forms import ( ) from django.forms.extras import SelectDateWidget from django.forms.utils import ErrorList -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils import six from django.utils import translation from django.utils.dates import MONTHS_AP diff --git a/tests/forms_tests/tests/test_input_formats.py b/tests/forms_tests/tests/test_input_formats.py index b9c29c7609..f939821c75 100644 --- a/tests/forms_tests/tests/test_input_formats.py +++ b/tests/forms_tests/tests/test_input_formats.py @@ -1,7 +1,7 @@ from datetime import time, date, datetime from django import forms -from django.test.utils import override_settings +from django.test import override_settings from django.utils.translation import activate, deactivate from django.test import SimpleTestCase diff --git a/tests/forms_tests/tests/test_media.py b/tests/forms_tests/tests/test_media.py index 492655505c..c44e443eac 100644 --- a/tests/forms_tests/tests/test_media.py +++ b/tests/forms_tests/tests/test_media.py @@ -1,8 +1,7 @@ # -*- coding: utf-8 -*- from django.forms import Media, TextInput, CharField, Form, MultiWidget from django.template import Template, Context -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings @override_settings( diff --git a/tests/forms_tests/tests/test_widgets.py b/tests/forms_tests/tests/test_widgets.py index 21134d1a24..4bbed3f0a9 100644 --- a/tests/forms_tests/tests/test_widgets.py +++ b/tests/forms_tests/tests/test_widgets.py @@ -18,8 +18,7 @@ from django.forms.widgets import RadioFieldRenderer from django.utils.safestring import mark_safe from django.utils import six from django.utils.translation import activate, deactivate, override -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils.encoding import python_2_unicode_compatible, force_text from ..models import Article diff --git a/tests/generic_inline_admin/tests.py b/tests/generic_inline_admin/tests.py index 09a802a1bc..e35f0d639a 100644 --- a/tests/generic_inline_admin/tests.py +++ b/tests/generic_inline_admin/tests.py @@ -8,8 +8,7 @@ from django.contrib.contenttypes.generic import ( generic_inlineformset_factory, GenericTabularInline) from django.forms.formsets import DEFAULT_MAX_NUM from django.forms.models import ModelForm -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings # local test models from .admin import MediaInline, MediaPermanentInline diff --git a/tests/generic_views/test_dates.py b/tests/generic_views/test_dates.py index 944a3dcfe3..07cb13a3ca 100644 --- a/tests/generic_views/test_dates.py +++ b/tests/generic_views/test_dates.py @@ -3,8 +3,8 @@ from __future__ import unicode_literals import datetime from django.core.exceptions import ImproperlyConfigured -from django.test import TestCase, skipUnlessDBFeature -from django.test.utils import override_settings, requires_tz_support +from django.test import TestCase, override_settings, skipUnlessDBFeature +from django.test.utils import requires_tz_support from django.utils import timezone from .models import Book, BookSigning diff --git a/tests/generic_views/test_list.py b/tests/generic_views/test_list.py index e572af8e32..a6a5c76ff8 100644 --- a/tests/generic_views/test_list.py +++ b/tests/generic_views/test_list.py @@ -1,8 +1,7 @@ from __future__ import unicode_literals from django.core.exceptions import ImproperlyConfigured -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.views.generic.base import View from django.utils.encoding import force_str diff --git a/tests/handlers/tests.py b/tests/handlers/tests.py index f5dc7c8531..ae8b9529f5 100644 --- a/tests/handlers/tests.py +++ b/tests/handlers/tests.py @@ -6,7 +6,7 @@ from django.core.handlers.wsgi import WSGIHandler, WSGIRequest from django.core.signals import request_started, request_finished from django.db import close_old_connections, connection from django.test import RequestFactory, TestCase, TransactionTestCase -from django.test.utils import override_settings +from django.test import override_settings from django.utils.encoding import force_str from django.utils import six diff --git a/tests/i18n/contenttypes/tests.py b/tests/i18n/contenttypes/tests.py index c48f8fc6dd..894ae0a3c7 100644 --- a/tests/i18n/contenttypes/tests.py +++ b/tests/i18n/contenttypes/tests.py @@ -4,8 +4,8 @@ from __future__ import unicode_literals import os from django.contrib.contenttypes.models import ContentType -from django.test import TestCase -from django.test.utils import override_settings, TransRealMixin +from django.test import TestCase, override_settings +from django.test.utils import TransRealMixin from django.utils._os import upath from django.utils import six from django.utils import translation diff --git a/tests/i18n/patterns/tests.py b/tests/i18n/patterns/tests.py index 78f5a46aae..a96fe1f54f 100644 --- a/tests/i18n/patterns/tests.py +++ b/tests/i18n/patterns/tests.py @@ -6,8 +6,7 @@ from django.core.exceptions import ImproperlyConfigured from django.core.urlresolvers import reverse, clear_url_caches from django.http import HttpResponsePermanentRedirect from django.middleware.locale import LocaleMiddleware -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.template import Template, Context from django.utils._os import upath from django.utils import translation diff --git a/tests/i18n/test_compilation.py b/tests/i18n/test_compilation.py index 0b8365b3c9..ae92f6f368 100644 --- a/tests/i18n/test_compilation.py +++ b/tests/i18n/test_compilation.py @@ -4,7 +4,7 @@ import unittest from django.core.management import call_command, CommandError from django.core.management.utils import find_command from django.test import SimpleTestCase -from django.test.utils import override_settings +from django.test import override_settings from django.utils import translation from django.utils._os import upath from django.utils.six import StringIO diff --git a/tests/i18n/test_extraction.py b/tests/i18n/test_extraction.py index da3670ff10..bd18700076 100644 --- a/tests/i18n/test_extraction.py +++ b/tests/i18n/test_extraction.py @@ -12,7 +12,7 @@ from django.conf import settings from django.core import management from django.core.management.utils import find_command from django.test import SimpleTestCase -from django.test.utils import override_settings +from django.test import override_settings from django.utils.encoding import force_text from django.utils._os import upath from django.utils import six diff --git a/tests/i18n/tests.py b/tests/i18n/tests.py index d8d2daaf0d..116364790f 100644 --- a/tests/i18n/tests.py +++ b/tests/i18n/tests.py @@ -11,8 +11,8 @@ from threading import local from django.conf import settings from django.template import Template, Context from django.template.base import TemplateSyntaxError -from django.test import TestCase, RequestFactory -from django.test.utils import override_settings, TransRealMixin +from django.test import TestCase, RequestFactory, override_settings +from django.test.utils import TransRealMixin from django.utils import translation from django.utils.formats import (get_format, date_format, time_format, localize, localize_input, iter_format_modules, get_format_modules, diff --git a/tests/initial_sql_regress/tests.py b/tests/initial_sql_regress/tests.py index b04e638808..e725f4b102 100644 --- a/tests/initial_sql_regress/tests.py +++ b/tests/initial_sql_regress/tests.py @@ -1,8 +1,7 @@ from django.core.management.color import no_style from django.core.management.sql import custom_sql_for_model from django.db import connections, DEFAULT_DB_ALIAS -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from .models import Simple diff --git a/tests/logging_tests/tests.py b/tests/logging_tests/tests.py index 1f9c8920c9..a6791cfa76 100644 --- a/tests/logging_tests/tests.py +++ b/tests/logging_tests/tests.py @@ -5,8 +5,8 @@ import warnings from django.conf import LazySettings from django.core import mail -from django.test import TestCase, RequestFactory -from django.test.utils import override_settings, patch_logger +from django.test import TestCase, RequestFactory, override_settings +from django.test.utils import patch_logger from django.utils.encoding import force_text from django.utils.log import (CallbackFilter, RequireDebugFalse, RequireDebugTrue) diff --git a/tests/mail/tests.py b/tests/mail/tests.py index 9683374fc5..c9e4a06eaa 100644 --- a/tests/mail/tests.py +++ b/tests/mail/tests.py @@ -19,7 +19,7 @@ from django.core.mail import (EmailMessage, mail_admins, mail_managers, from django.core.mail.backends import console, dummy, locmem, filebased, smtp from django.core.mail.message import BadHeaderError from django.test import SimpleTestCase -from django.test.utils import override_settings +from django.test import override_settings from django.utils.encoding import force_str, force_text from django.utils.six import PY3, StringIO, string_types from django.utils.translation import ugettext_lazy diff --git a/tests/managers_regress/tests.py b/tests/managers_regress/tests.py index 9d7e0d8174..2b8e183e82 100644 --- a/tests/managers_regress/tests.py +++ b/tests/managers_regress/tests.py @@ -3,8 +3,7 @@ from __future__ import unicode_literals from django.apps import app_cache from django.db import models from django.template import Context, Template -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils.encoding import force_text from .models import ( diff --git a/tests/middleware/tests.py b/tests/middleware/tests.py index 0124e33c98..d4b8827f7b 100644 --- a/tests/middleware/tests.py +++ b/tests/middleware/tests.py @@ -18,8 +18,8 @@ from django.middleware.common import CommonMiddleware, BrokenLinkEmailsMiddlewar from django.middleware.http import ConditionalGetMiddleware from django.middleware.gzip import GZipMiddleware from django.middleware.transaction import TransactionMiddleware -from django.test import TransactionTestCase, TestCase, RequestFactory -from django.test.utils import override_settings, IgnoreDeprecationWarningsMixin +from django.test import TransactionTestCase, TestCase, RequestFactory, override_settings +from django.test.utils import IgnoreDeprecationWarningsMixin from django.utils import six from django.utils.encoding import force_str from django.utils.six.moves import xrange diff --git a/tests/middleware_exceptions/tests.py b/tests/middleware_exceptions/tests.py index 47852f35fa..b11986d4d0 100644 --- a/tests/middleware_exceptions/tests.py +++ b/tests/middleware_exceptions/tests.py @@ -5,8 +5,7 @@ from django.core.signals import got_request_exception from django.http import HttpResponse from django.template.response import TemplateResponse from django.template import Template -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings class TestException(Exception): diff --git a/tests/migrations/test_commands.py b/tests/migrations/test_commands.py index fcb460decc..9f740f72a2 100644 --- a/tests/migrations/test_commands.py +++ b/tests/migrations/test_commands.py @@ -7,7 +7,7 @@ import shutil from django.apps import app_cache from django.core.management import call_command, CommandError -from django.test.utils import override_settings +from django.test import override_settings from django.utils import six from django.utils._os import upath from django.utils.encoding import force_text diff --git a/tests/migrations/test_executor.py b/tests/migrations/test_executor.py index 5c0131d1d3..e8dcacd80e 100644 --- a/tests/migrations/test_executor.py +++ b/tests/migrations/test_executor.py @@ -1,6 +1,7 @@ -from django.test.utils import override_settings from django.db import connection from django.db.migrations.executor import MigrationExecutor +from django.test import override_settings + from .test_base import MigrationTestBase diff --git a/tests/migrations/test_loader.py b/tests/migrations/test_loader.py index 80ac9ffd73..4f0b463f99 100644 --- a/tests/migrations/test_loader.py +++ b/tests/migrations/test_loader.py @@ -1,7 +1,6 @@ from unittest import skipIf -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.db import connection from django.db.migrations.loader import MigrationLoader, AmbiguityError from django.db.migrations.recorder import MigrationRecorder diff --git a/tests/modeladmin/tests.py b/tests/modeladmin/tests.py index 38bfcc25dd..0c7a115fef 100644 --- a/tests/modeladmin/tests.py +++ b/tests/modeladmin/tests.py @@ -13,8 +13,8 @@ from django.contrib.admin import (SimpleListFilter, from django.core.exceptions import ImproperlyConfigured from django.forms.models import BaseModelFormSet from django.forms.widgets import Select -from django.test import TestCase -from django.test.utils import str_prefix, override_settings +from django.test import TestCase, override_settings +from django.test.utils import str_prefix from django.utils import six from .models import Band, Concert, ValidationTestModel, ValidationTestInlineModel diff --git a/tests/multiple_database/tests.py b/tests/multiple_database/tests.py index 222d236bb0..8ffe00578b 100644 --- a/tests/multiple_database/tests.py +++ b/tests/multiple_database/tests.py @@ -10,8 +10,7 @@ from django.core import management from django.db import connections, router, DEFAULT_DB_ALIAS, transaction from django.db.models import signals from django.db.utils import ConnectionRouter -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils.six import StringIO from .models import Book, Person, Pet, Review, UserProfile diff --git a/tests/prefetch_related/tests.py b/tests/prefetch_related/tests.py index 7570bdce6e..5dfca0fa99 100644 --- a/tests/prefetch_related/tests.py +++ b/tests/prefetch_related/tests.py @@ -3,8 +3,7 @@ from __future__ import unicode_literals from django.contrib.contenttypes.models import ContentType from django.db import connection from django.db.models import Prefetch -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils import six from .models import (Author, Book, Reader, Qualification, Teacher, Department, diff --git a/tests/proxy_models/tests.py b/tests/proxy_models/tests.py index 800fc42e6d..346924e320 100644 --- a/tests/proxy_models/tests.py +++ b/tests/proxy_models/tests.py @@ -7,8 +7,7 @@ from django.core import management from django.core.exceptions import FieldError from django.db import models, DEFAULT_DB_ALIAS from django.db.models import signals -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from .models import (MyPerson, Person, StatusPerson, LowerStatusPerson, diff --git a/tests/requests/tests.py b/tests/requests/tests.py index 850cf70c2f..bb56369371 100644 --- a/tests/requests/tests.py +++ b/tests/requests/tests.py @@ -13,9 +13,9 @@ from django.core.exceptions import SuspiciousOperation from django.core.handlers.wsgi import WSGIRequest, LimitedStream from django.http import (HttpRequest, HttpResponse, parse_cookie, build_request_repr, UnreadablePostError, RawPostDataException) -from django.test import SimpleTestCase, TransactionTestCase +from django.test import SimpleTestCase, TransactionTestCase, override_settings from django.test.client import FakePayload -from django.test.utils import override_settings, str_prefix +from django.test.utils import str_prefix from django.utils import six from django.utils.http import cookie_date, urlencode from django.utils.six.moves.urllib.parse import urlencode as original_urlencode diff --git a/tests/select_for_update/tests.py b/tests/select_for_update/tests.py index 6fadbdb799..278458ed39 100644 --- a/tests/select_for_update/tests.py +++ b/tests/select_for_update/tests.py @@ -8,7 +8,7 @@ from django.db import transaction, connection, router from django.db.utils import ConnectionHandler, DEFAULT_DB_ALIAS, DatabaseError from django.test import (TransactionTestCase, skipIfDBFeature, skipUnlessDBFeature) -from django.test.utils import override_settings +from django.test import override_settings from multiple_database.routers import TestRouter diff --git a/tests/serializers/tests.py b/tests/serializers/tests.py index b9e3bb543f..6433101878 100644 --- a/tests/serializers/tests.py +++ b/tests/serializers/tests.py @@ -16,8 +16,8 @@ except ImportError: from django.core import management, serializers from django.db import transaction, connection -from django.test import TestCase, TransactionTestCase -from django.test.utils import Approximate, override_settings +from django.test import TestCase, TransactionTestCase, override_settings +from django.test.utils import Approximate from django.utils import six from django.utils.six import StringIO diff --git a/tests/servers/tests.py b/tests/servers/tests.py index 5ce86d3529..8f8a310c71 100644 --- a/tests/servers/tests.py +++ b/tests/servers/tests.py @@ -9,7 +9,7 @@ import socket from django.core.exceptions import ImproperlyConfigured from django.test import LiveServerTestCase -from django.test.utils import override_settings +from django.test import override_settings from django.utils.http import urlencode from django.utils.six.moves.urllib.error import HTTPError from django.utils.six.moves.urllib.request import urlopen diff --git a/tests/settings_tests/tests.py b/tests/settings_tests/tests.py index fd3f543553..2225862f7f 100644 --- a/tests/settings_tests/tests.py +++ b/tests/settings_tests/tests.py @@ -5,8 +5,8 @@ import warnings from django.conf import settings from django.core.exceptions import ImproperlyConfigured from django.http import HttpRequest -from django.test import SimpleTestCase, TransactionTestCase, TestCase, signals -from django.test.utils import modify_settings, override_settings +from django.test import (SimpleTestCase, TransactionTestCase, TestCase, + modify_settings, override_settings, signals) from django.utils import six diff --git a/tests/staticfiles_tests/test_liveserver.py b/tests/staticfiles_tests/test_liveserver.py index 6fa64240cc..b7e309e1a7 100644 --- a/tests/staticfiles_tests/test_liveserver.py +++ b/tests/staticfiles_tests/test_liveserver.py @@ -7,7 +7,7 @@ django.test.LiveServerTestCase. import os from django.core.exceptions import ImproperlyConfigured -from django.test.utils import override_settings +from django.test import override_settings from django.utils.six.moves.urllib.request import urlopen from django.utils._os import upath diff --git a/tests/staticfiles_tests/tests.py b/tests/staticfiles_tests/tests.py index 3ad8249e76..19c244e353 100644 --- a/tests/staticfiles_tests/tests.py +++ b/tests/staticfiles_tests/tests.py @@ -14,8 +14,7 @@ from django.conf import settings from django.core.cache.backends.base import BaseCache from django.core.exceptions import ImproperlyConfigured from django.core.management import call_command -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils.encoding import force_text from django.utils.functional import empty from django.utils._os import rmtree_errorhandler, upath diff --git a/tests/swappable_models/tests.py b/tests/swappable_models/tests.py index 0beb95af3e..cdebbef374 100644 --- a/tests/swappable_models/tests.py +++ b/tests/swappable_models/tests.py @@ -6,8 +6,7 @@ from django.apps import app_cache from django.contrib.auth.models import Permission from django.contrib.contenttypes.models import ContentType from django.core import management -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from swappable_models.models import Article diff --git a/tests/template_tests/test_nodelist.py b/tests/template_tests/test_nodelist.py index 12abd20331..1c48d3f7ce 100644 --- a/tests/template_tests/test_nodelist.py +++ b/tests/template_tests/test_nodelist.py @@ -2,7 +2,7 @@ from unittest import TestCase from django.template import VariableNode, Context from django.template.loader import get_template_from_string -from django.test.utils import override_settings +from django.test import override_settings class NodelistTest(TestCase): diff --git a/tests/template_tests/test_parser.py b/tests/template_tests/test_parser.py index 275d7ea4be..017e78a863 100644 --- a/tests/template_tests/test_parser.py +++ b/tests/template_tests/test_parser.py @@ -7,7 +7,7 @@ from unittest import TestCase from django.template import (TokenParser, FilterExpression, Parser, Variable, Template, TemplateSyntaxError, Library) -from django.test.utils import override_settings +from django.test import override_settings from django.utils import six diff --git a/tests/template_tests/test_response.py b/tests/template_tests/test_response.py index f5f6158b2f..17d8f11ba5 100644 --- a/tests/template_tests/test_response.py +++ b/tests/template_tests/test_response.py @@ -10,7 +10,7 @@ from django.conf import settings from django.template import Template, Context from django.template.response import (TemplateResponse, SimpleTemplateResponse, ContentNotRenderedError) -from django.test.utils import override_settings +from django.test import override_settings from django.utils._os import upath diff --git a/tests/test_client/tests.py b/tests/test_client/tests.py index d914a89043..3693b33752 100644 --- a/tests/test_client/tests.py +++ b/tests/test_client/tests.py @@ -24,7 +24,7 @@ from __future__ import unicode_literals from django.core import mail from django.test import Client, TestCase, RequestFactory -from django.test.utils import override_settings +from django.test import override_settings from .views import get_view diff --git a/tests/test_client_regress/tests.py b/tests/test_client_regress/tests.py index 1bee0b95e7..afb3993cd1 100644 --- a/tests/test_client_regress/tests.py +++ b/tests/test_client_regress/tests.py @@ -12,9 +12,9 @@ from django.core.urlresolvers import reverse from django.template import (TemplateSyntaxError, Context, Template, loader) import django.template.context -from django.test import Client, TestCase +from django.test import Client, TestCase, override_settings from django.test.client import encode_file, RequestFactory -from django.test.utils import ContextList, override_settings, str_prefix +from django.test.utils import ContextList, str_prefix from django.template.response import SimpleTemplateResponse from django.utils._os import upath from django.utils.translation import ugettext_lazy diff --git a/tests/timezones/tests.py b/tests/timezones/tests.py index 5eb98fcf00..4b45ddbb7b 100644 --- a/tests/timezones/tests.py +++ b/tests/timezones/tests.py @@ -17,8 +17,8 @@ from django.core.urlresolvers import reverse from django.db.models import Min, Max from django.http import HttpRequest from django.template import Context, RequestContext, Template, TemplateSyntaxError -from django.test import TestCase, skipIfDBFeature, skipUnlessDBFeature -from django.test.utils import override_settings, requires_tz_support +from django.test import TestCase, override_settings, skipIfDBFeature, skipUnlessDBFeature +from django.test.utils import requires_tz_support from django.utils import six from django.utils import timezone diff --git a/tests/transactions_regress/tests.py b/tests/transactions_regress/tests.py index 24bd860731..cada46edb2 100644 --- a/tests/transactions_regress/tests.py +++ b/tests/transactions_regress/tests.py @@ -5,8 +5,8 @@ from unittest import skipIf, skipUnless, SkipTest from django.db import (connection, connections, transaction, DEFAULT_DB_ALIAS, DatabaseError, IntegrityError) from django.db.transaction import commit_on_success, commit_manually, TransactionManagementError -from django.test import TransactionTestCase, skipUnlessDBFeature -from django.test.utils import override_settings, IgnoreDeprecationWarningsMixin +from django.test import TransactionTestCase, override_settings, skipUnlessDBFeature +from django.test.utils import IgnoreDeprecationWarningsMixin from .models import Mod, M2mA, M2mB, SubMod diff --git a/tests/urlpatterns_reverse/tests.py b/tests/urlpatterns_reverse/tests.py index da0c5bee1a..a7fb342da7 100644 --- a/tests/urlpatterns_reverse/tests.py +++ b/tests/urlpatterns_reverse/tests.py @@ -12,8 +12,7 @@ from django.core.urlresolvers import (reverse, reverse_lazy, resolve, get_callab RegexURLPattern) from django.http import HttpRequest, HttpResponseRedirect, HttpResponsePermanentRedirect from django.shortcuts import redirect -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils import six from . import urlconf_outer, middleware, views diff --git a/tests/utils_tests/test_dateformat.py b/tests/utils_tests/test_dateformat.py index ebf46f3ee7..c0b42db3dc 100644 --- a/tests/utils_tests/test_dateformat.py +++ b/tests/utils_tests/test_dateformat.py @@ -3,8 +3,7 @@ from __future__ import unicode_literals from datetime import datetime, date import time -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings from django.utils.dateformat import format from django.utils import dateformat from django.utils.timezone import utc, get_fixed_timezone, get_default_timezone, make_aware diff --git a/tests/utils_tests/test_timezone.py b/tests/utils_tests/test_timezone.py index fe67d105c3..1d608d0951 100644 --- a/tests/utils_tests/test_timezone.py +++ b/tests/utils_tests/test_timezone.py @@ -3,7 +3,7 @@ import datetime import pickle import unittest -from django.test.utils import override_settings +from django.test import override_settings from django.utils import timezone diff --git a/tests/view_tests/tests/test_debug.py b/tests/view_tests/tests/test_debug.py index 261c534b2b..ca08f3cce9 100644 --- a/tests/view_tests/tests/test_debug.py +++ b/tests/view_tests/tests/test_debug.py @@ -16,9 +16,9 @@ from django.core import mail from django.core.files.uploadedfile import SimpleUploadedFile from django.core.urlresolvers import reverse from django.template.base import TemplateDoesNotExist -from django.test import TestCase, RequestFactory -from django.test.utils import (override_settings, setup_test_template_loader, - restore_template_loaders) +from django.test import TestCase, RequestFactory, override_settings +from django.test.utils import ( + setup_test_template_loader, restore_template_loaders) from django.utils.encoding import force_text, force_bytes from django.utils import six from django.views.debug import ExceptionReporter diff --git a/tests/view_tests/tests/test_shortcuts.py b/tests/view_tests/tests/test_shortcuts.py index eb08433a44..7b14637143 100644 --- a/tests/view_tests/tests/test_shortcuts.py +++ b/tests/view_tests/tests/test_shortcuts.py @@ -1,5 +1,4 @@ -from django.test import TestCase -from django.test.utils import override_settings +from django.test import TestCase, override_settings @override_settings( diff --git a/tests/view_tests/tests/test_static.py b/tests/view_tests/tests/test_static.py index 34e4021080..8b051c5e62 100644 --- a/tests/view_tests/tests/test_static.py +++ b/tests/view_tests/tests/test_static.py @@ -6,8 +6,7 @@ import unittest from django.conf.urls.static import static from django.http import HttpResponseNotModified -from django.test import SimpleTestCase -from django.test.utils import override_settings +from django.test import SimpleTestCase, override_settings from django.utils.http import http_date from django.views.static import was_modified_since diff --git a/tests/wsgi/tests.py b/tests/wsgi/tests.py index 90397bb742..567ca94f98 100644 --- a/tests/wsgi/tests.py +++ b/tests/wsgi/tests.py @@ -7,9 +7,8 @@ from django.core.servers.basehttp import get_internal_wsgi_application from django.core.signals import request_started from django.core.wsgi import get_wsgi_application from django.db import close_old_connections -from django.test import TestCase +from django.test import TestCase, override_settings from django.test.client import RequestFactory -from django.test.utils import override_settings from django.utils import six From 137a3d7c77e235e6752b00fe9901a700b68fcef2 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 23 Dec 2013 22:21:23 +0100 Subject: [PATCH 035/208] Avoided loading repeatedly the same models module. --- django/apps/cache.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/django/apps/cache.py b/django/apps/cache.py index bd412f1192..3a95ea1306 100644 --- a/django/apps/cache.py +++ b/django/apps/cache.py @@ -113,6 +113,9 @@ class AppCache(object): for app_config in self.app_configs.values(): + if app_config.models is not None: + continue + try: all_models = self.all_models[app_config.label] app_config.import_models(all_models) From 7577d03809849d3d878d0ee57ec9d6a8524b5b32 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 23 Dec 2013 23:54:44 +0100 Subject: [PATCH 036/208] Renamed two tests so they actually run. --- tests/comment_tests/tests/test_app_api.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/comment_tests/tests/test_app_api.py b/tests/comment_tests/tests/test_app_api.py index 3d88b7e896..ffb78c851e 100644 --- a/tests/comment_tests/tests/test_app_api.py +++ b/tests/comment_tests/tests/test_app_api.py @@ -58,10 +58,10 @@ class CustomCommentTest(CommentTestCase): c = Comment(id=12345) self.assertEqual(comments.get_flag_url(c), "/flag/12345/") - def getGetDeleteURL(self): + def testGetDeleteURL(self): c = Comment(id=12345) self.assertEqual(comments.get_delete_url(c), "/delete/12345/") - def getGetApproveURL(self): + def testGetApproveURL(self): c = Comment(id=12345) self.assertEqual(comments.get_approve_url(c), "/approve/12345/") From 2ec8e3443bc9345d986710244e05a3cce56c8da1 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 24 Dec 2013 00:07:54 +0100 Subject: [PATCH 037/208] Fixed override_settings when set_available_apps raises an exception. Previously, this would corrupt the settings, because __exit__ isn't called when __enter__raises an exception. --- django/apps/cache.py | 25 ++++++++++++++----------- django/test/utils.py | 14 ++++++++++---- 2 files changed, 24 insertions(+), 15 deletions(-) diff --git a/django/apps/cache.py b/django/apps/cache.py index 3a95ea1306..840b9fbf68 100644 --- a/django/apps/cache.py +++ b/django/apps/cache.py @@ -52,7 +52,7 @@ class AppCache(object): # Cache for get_models. self._get_models_cache = {} - def populate_apps(self): + def populate_apps(self, installed_apps=None): """ Populate app-related information. @@ -77,7 +77,9 @@ class AppCache(object): # Application modules aren't expected to import anything, and # especially not other application modules, even indirectly. # Therefore we simply import them sequentially. - for app_name in settings.INSTALLED_APPS: + if installed_apps is None: + installed_apps = settings.INSTALLED_APPS + for app_name in installed_apps: app_config = AppConfig.create(app_name) self.app_configs[app_config.label] = app_config @@ -299,6 +301,8 @@ class AppCache(object): available must be an iterable of application names. + set_available_apps() must be balanced with unset_available_apps(). + Primarily used for performance optimization in TransactionTestCase. This method is safe is the sense that it doesn't trigger any imports. @@ -323,10 +327,13 @@ class AppCache(object): def set_installed_apps(self, installed): """ - Enables a different set of installed_apps for get_app_config[s]. + Enables a different set of installed apps for get_app_config[s]. installed must be an iterable in the same format as INSTALLED_APPS. + set_installed_apps() must be balanced with unset_installed_apps(), + even if it exits with an exception. + Primarily used as a receiver of the setting_changed signal in tests. This method may trigger new imports, which may add new models to the @@ -337,14 +344,10 @@ class AppCache(object): """ self.stored_app_configs.append(self.app_configs) self.app_configs = OrderedDict() - try: - self._apps_loaded = False - self.populate_apps() - self._models_loaded = False - self.populate_models() - except Exception: - self.unset_installed_apps() - raise + self._apps_loaded = False + self.populate_apps(installed) + self._models_loaded = False + self.populate_models() def unset_installed_apps(self): """ diff --git a/django/test/utils.py b/django/test/utils.py index 60e125a86b..4453545dea 100644 --- a/django/test/utils.py +++ b/django/test/utils.py @@ -225,22 +225,28 @@ class override_settings(object): test_func._overridden_settings, **self.options) def enable(self): + # Keep this code at the beginning to leave the settings unchanged + # in case it raises an exception because INSTALLED_APPS is invalid. + if 'INSTALLED_APPS' in self.options: + try: + app_cache.set_installed_apps(self.options['INSTALLED_APPS']) + except Exception: + app_cache.unset_installed_apps() + raise override = UserSettingsHolder(settings._wrapped) for key, new_value in self.options.items(): setattr(override, key, new_value) self.wrapped = settings._wrapped settings._wrapped = override - if 'INSTALLED_APPS' in self.options: - app_cache.set_installed_apps(settings.INSTALLED_APPS) for key, new_value in self.options.items(): setting_changed.send(sender=settings._wrapped.__class__, setting=key, value=new_value, enter=True) def disable(self): - settings._wrapped = self.wrapped - del self.wrapped if 'INSTALLED_APPS' in self.options: app_cache.unset_installed_apps() + settings._wrapped = self.wrapped + del self.wrapped for key in self.options: new_value = getattr(settings, key, None) setting_changed.send(sender=settings._wrapped.__class__, From 82a35e24d4de58e637661591b14d9b4658bcab11 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 24 Dec 2013 10:08:04 +0100 Subject: [PATCH 038/208] Replaced ad-hoc caching of get_models with lru_cache. Invalidate properly the cache whenever all_models or app_configs change. This fixes some isolation issues in the test suite. --- django/apps/cache.py | 17 +++++++---------- tests/app_loading/tests.py | 2 +- tests/managers_regress/tests.py | 6 +++--- tests/migrations/test_commands.py | 2 +- tests/proxy_models/tests.py | 2 +- tests/runtests.py | 1 + tests/swappable_models/tests.py | 10 ---------- tests/tablespaces/tests.py | 2 +- 8 files changed, 15 insertions(+), 27 deletions(-) diff --git a/django/apps/cache.py b/django/apps/cache.py index 840b9fbf68..a67b3cf999 100644 --- a/django/apps/cache.py +++ b/django/apps/cache.py @@ -7,6 +7,7 @@ import warnings from django.conf import settings from django.core.exceptions import ImproperlyConfigured +from django.utils import lru_cache from django.utils.module_loading import import_lock from django.utils._os import upath @@ -49,9 +50,6 @@ class AppCache(object): # Pending lookups for lazy relations. self._pending_lookups = {} - # Cache for get_models. - self._get_models_cache = {} - def populate_apps(self, installed_apps=None): """ Populate app-related information. @@ -83,6 +81,7 @@ class AppCache(object): app_config = AppConfig.create(app_name) self.app_configs[app_config.label] = app_config + self.get_models.cache_clear() self._apps_loaded = True def populate_models(self): @@ -131,6 +130,7 @@ class AppCache(object): del self._postponed + self.get_models.cache_clear() self._models_loaded = True def app_cache_ready(self): @@ -180,6 +180,8 @@ class AppCache(object): raise LookupError("App with label %r doesn't have a models module." % app_label) return app_config + # This method is performance-critical at least for Django's test suite. + @lru_cache.lru_cache(maxsize=None) def get_models(self, app_mod=None, include_auto_created=False, include_deferred=False, only_installed=True, include_swapped=False): @@ -206,12 +208,7 @@ class AppCache(object): """ if not self.master: only_installed = False - cache_key = (app_mod, include_auto_created, include_deferred, only_installed, include_swapped) model_list = None - try: - return self._get_models_cache[cache_key] - except KeyError: - pass self.populate_models() if app_mod: app_label = app_mod.__name__.split('.')[-2] @@ -235,7 +232,6 @@ class AppCache(object): (not model._meta.auto_created or include_auto_created) and (not model._meta.swapped or include_swapped)) ) - self._get_models_cache[cache_key] = model_list return model_list def get_model(self, app_label, model_name, only_installed=True): @@ -272,7 +268,7 @@ class AppCache(object): if os.path.splitext(fname1)[0] == os.path.splitext(fname2)[0]: return models[model_name] = model - self._get_models_cache.clear() + self.get_models.cache_clear() def has_app(self, app_name): """ @@ -368,6 +364,7 @@ class AppCache(object): app_config = AppConfig.create(app_name) app_config.import_models(self.all_models[app_config.label]) self.app_configs[app_config.label] = app_config + self.get_models.cache_clear() return app_config.models_module def get_app(self, app_label): diff --git a/tests/app_loading/tests.py b/tests/app_loading/tests.py index a9dc70f4b1..291877108f 100644 --- a/tests/app_loading/tests.py +++ b/tests/app_loading/tests.py @@ -21,7 +21,7 @@ class EggLoadingTest(TestCase): def tearDown(self): app_cache.all_models['app_loading'] = self._old_models - app_cache._get_models_cache = {} + app_cache.get_models.cache_clear() sys.path = self.old_path diff --git a/tests/managers_regress/tests.py b/tests/managers_regress/tests.py index 2b8e183e82..bf8e5b17d4 100644 --- a/tests/managers_regress/tests.py +++ b/tests/managers_regress/tests.py @@ -128,7 +128,7 @@ class ManagersRegressionTests(TestCase): finally: app_cache.app_configs['managers_regress'].models = _old_models app_cache.all_models['managers_regress'] = _old_models - app_cache._get_models_cache = {} + app_cache.get_models.cache_clear() @override_settings(TEST_SWAPPABLE_MODEL='managers_regress.Parent') def test_custom_swappable_manager(self): @@ -156,7 +156,7 @@ class ManagersRegressionTests(TestCase): finally: app_cache.app_configs['managers_regress'].models = _old_models app_cache.all_models['managers_regress'] = _old_models - app_cache._get_models_cache = {} + app_cache.get_models.cache_clear() @override_settings(TEST_SWAPPABLE_MODEL='managers_regress.Parent') def test_explicit_swappable_manager(self): @@ -184,7 +184,7 @@ class ManagersRegressionTests(TestCase): finally: app_cache.app_configs['managers_regress'].models = _old_models app_cache.all_models['managers_regress'] = _old_models - app_cache._get_models_cache = {} + app_cache.get_models.cache_clear() def test_regress_3871(self): related = RelatedModel.objects.create() diff --git a/tests/migrations/test_commands.py b/tests/migrations/test_commands.py index 9f740f72a2..9fa9be6cbf 100644 --- a/tests/migrations/test_commands.py +++ b/tests/migrations/test_commands.py @@ -136,7 +136,7 @@ class MakeMigrationsTests(MigrationTestBase): def tearDown(self): app_cache.app_configs['migrations'].models = self._old_models app_cache.all_models['migrations'] = self._old_models - app_cache._get_models_cache = {} + app_cache.get_models.cache_clear() os.chdir(self.test_dir) try: diff --git a/tests/proxy_models/tests.py b/tests/proxy_models/tests.py index 346924e320..4a3d6e5e5a 100644 --- a/tests/proxy_models/tests.py +++ b/tests/proxy_models/tests.py @@ -175,7 +175,7 @@ class ProxyModelTests(TestCase): finally: app_cache.app_configs['proxy_models'].models = _old_models app_cache.all_models['proxy_models'] = _old_models - app_cache._get_models_cache = {} + app_cache.get_models.cache_clear() def test_myperson_manager(self): Person.objects.create(name="fred") diff --git a/tests/runtests.py b/tests/runtests.py index c75d8a3ee9..ab6f778a81 100755 --- a/tests/runtests.py +++ b/tests/runtests.py @@ -170,6 +170,7 @@ def setup(verbosity, test_labels): app_config = AppConfig.create(module_label) app_config.import_models(app_cache.all_models[app_config.label]) app_cache.app_configs[app_config.label] = app_config + app_cache.get_models.cache_clear() return state diff --git a/tests/swappable_models/tests.py b/tests/swappable_models/tests.py index cdebbef374..c703a99fcb 100644 --- a/tests/swappable_models/tests.py +++ b/tests/swappable_models/tests.py @@ -19,16 +19,6 @@ class SwappableModelTests(TestCase): 'django.contrib.contenttypes', ] - def setUp(self): - # This test modifies the installed apps, so we need to make sure - # we're not dealing with a cached app list. - app_cache._get_models_cache.clear() - - def tearDown(self): - # By fiddling with swappable models, we alter the installed models - # cache, so flush it to make sure there are no side effects. - app_cache._get_models_cache.clear() - @override_settings(TEST_ARTICLE_MODEL='swappable_models.AlternateArticle') def test_generated_data(self): "Permissions and content types are not created for a swapped model" diff --git a/tests/tablespaces/tests.py b/tests/tablespaces/tests.py index d761a93ab9..fdee877a9f 100644 --- a/tests/tablespaces/tests.py +++ b/tests/tablespaces/tests.py @@ -37,7 +37,7 @@ class TablespacesTests(TestCase): app_cache.app_configs['tablespaces'].models = self._old_models app_cache.all_models['tablespaces'] = self._old_models - app_cache._get_models_cache = {} + app_cache.get_models.cache_clear() def assertNumContains(self, haystack, needle, count): real_count = haystack.count(needle) From e9e522a8e7455900a775678e5d6bc518a289b8d1 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 24 Dec 2013 11:09:24 +0100 Subject: [PATCH 039/208] Invalidated get_models cache in a few more places. --- django/apps/cache.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/django/apps/cache.py b/django/apps/cache.py index a67b3cf999..92007f637a 100644 --- a/django/apps/cache.py +++ b/django/apps/cache.py @@ -314,12 +314,14 @@ class AppCache(object): (label, app_config) for label, app_config in self.app_configs.items() if app_config.name in available) + self.get_models.cache_clear() def unset_available_apps(self): """ Cancels a previous call to set_available_apps(). """ self.app_configs = self.stored_app_configs.pop() + self.get_models.cache_clear() def set_installed_apps(self, installed): """ @@ -340,6 +342,7 @@ class AppCache(object): """ self.stored_app_configs.append(self.app_configs) self.app_configs = OrderedDict() + self.get_models.cache_clear() self._apps_loaded = False self.populate_apps(installed) self._models_loaded = False @@ -350,6 +353,7 @@ class AppCache(object): Cancels a previous call to set_installed_apps(). """ self.app_configs = self.stored_app_configs.pop() + self.get_models.cache_clear() ### DEPRECATED METHODS GO BELOW THIS LINE ### From d7a4b156d935ffcb8cdd9290688457453fc06b24 Mon Sep 17 00:00:00 2001 From: Curtis Date: Tue, 24 Dec 2013 21:57:57 +1100 Subject: [PATCH 040/208] Use cached_property for request.GET and request.COOKIES --- django/core/handlers/wsgi.py | 29 ++++++++++------------------- 1 file changed, 10 insertions(+), 19 deletions(-) diff --git a/django/core/handlers/wsgi.py b/django/core/handlers/wsgi.py index 21cadf48b8..46efd0477e 100644 --- a/django/core/handlers/wsgi.py +++ b/django/core/handlers/wsgi.py @@ -14,6 +14,7 @@ from django.core.handlers import base from django.core.urlresolvers import set_script_prefix from django.utils import datastructures from django.utils.encoding import force_str, force_text +from django.utils.functional import cached_property from django.utils import six # For backwards compatibility -- lots of code uses this in the wild! @@ -136,15 +137,11 @@ class WSGIRequest(http.HttpRequest): self._request = datastructures.MergeDict(self.POST, self.GET) return self._request - def _get_get(self): - if not hasattr(self, '_get'): - # The WSGI spec says 'QUERY_STRING' may be absent. - raw_query_string = get_bytes_from_wsgi(self.environ, 'QUERY_STRING', '') - self._get = http.QueryDict(raw_query_string, encoding=self._encoding) - return self._get - - def _set_get(self, get): - self._get = get + @cached_property + def GET(self): + # The WSGI spec says 'QUERY_STRING' may be absent. + raw_query_string = get_bytes_from_wsgi(self.environ, 'QUERY_STRING', '') + return http.QueryDict(raw_query_string, encoding=self._encoding) def _get_post(self): if not hasattr(self, '_post'): @@ -154,23 +151,17 @@ class WSGIRequest(http.HttpRequest): def _set_post(self, post): self._post = post - def _get_cookies(self): - if not hasattr(self, '_cookies'): - raw_cookie = get_str_from_wsgi(self.environ, 'HTTP_COOKIE', '') - self._cookies = http.parse_cookie(raw_cookie) - return self._cookies - - def _set_cookies(self, cookies): - self._cookies = cookies + @cached_property + def COOKIES(self): + raw_cookie = get_str_from_wsgi(self.environ, 'HTTP_COOKIE', '') + return http.parse_cookie(raw_cookie) def _get_files(self): if not hasattr(self, '_files'): self._load_post_and_files() return self._files - GET = property(_get_get, _set_get) POST = property(_get_post, _set_post) - COOKIES = property(_get_cookies, _set_cookies) FILES = property(_get_files) REQUEST = property(_get_request) From 1716b7ce5a02b2a77188dfea2d41e25dfa58821c Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 24 Dec 2013 12:25:17 +0100 Subject: [PATCH 041/208] Renamed AppCache to Apps. Also renamed app_cache to apps and "app cache" to "app registry". Deprecated AppCache.app_cache_ready() in favor of Apps.ready(). --- django/apps/__init__.py | 2 +- django/apps/base.py | 4 +- django/apps/{cache.py => registry.py} | 41 ++++++----- django/contrib/admin/sites.py | 12 ++-- .../admin/templatetags/admin_static.py | 4 +- django/contrib/admin/validation.py | 8 +-- django/contrib/admindocs/views.py | 8 +-- django/contrib/auth/__init__.py | 4 +- django/contrib/auth/management/__init__.py | 8 +-- django/contrib/auth/tests/test_management.py | 8 +-- django/contrib/comments/__init__.py | 4 +- django/contrib/comments/views/comments.py | 4 +- django/contrib/contenttypes/management.py | 8 +-- django/contrib/contenttypes/models.py | 5 +- django/contrib/gis/sitemaps/kml.py | 4 +- django/contrib/gis/sitemaps/views.py | 4 +- django/contrib/messages/tests/base.py | 4 +- django/contrib/redirects/middleware.py | 4 +- .../contrib/sitemaps/tests/test_flatpages.py | 4 +- django/contrib/sitemaps/tests/test_http.py | 4 +- django/contrib/staticfiles/finders.py | 14 ++-- .../core/checks/compatibility/django_1_6_0.py | 4 +- django/core/management/__init__.py | 20 +++--- django/core/management/base.py | 6 +- django/core/management/commands/dumpdata.py | 20 +++--- django/core/management/commands/flush.py | 6 +- django/core/management/commands/loaddata.py | 4 +- .../management/commands/makemigrations.py | 6 +- django/core/management/commands/migrate.py | 34 ++++----- django/core/management/commands/shell.py | 4 +- .../management/commands/sqlsequencereset.py | 4 +- django/core/management/sql.py | 10 +-- django/core/management/validation.py | 12 ++-- django/core/serializers/base.py | 6 +- django/core/serializers/python.py | 6 +- django/core/serializers/xml_serializer.py | 4 +- django/db/backends/__init__.py | 12 ++-- django/db/backends/sqlite3/schema.py | 8 +-- django/db/migrations/autodetector.py | 10 +-- django/db/migrations/executor.py | 4 +- django/db/migrations/loader.py | 6 +- django/db/migrations/operations/models.py | 56 +++++++-------- django/db/migrations/operations/special.py | 2 +- django/db/migrations/questioner.py | 4 +- django/db/migrations/recorder.py | 4 +- django/db/migrations/state.py | 30 ++++---- django/db/migrations/writer.py | 4 +- django/db/models/base.py | 10 +-- django/db/models/fields/__init__.py | 10 +-- django/db/models/fields/related.py | 8 +-- django/db/models/loading.py | 30 ++++---- django/db/models/options.py | 18 ++--- django/db/models/query_utils.py | 6 +- django/db/models/signals.py | 4 +- django/db/utils.py | 4 +- django/template/base.py | 4 +- django/template/loaders/app_directories.py | 4 +- django/template/loaders/eggs.py | 4 +- django/test/client.py | 6 +- django/test/simple.py | 8 +-- django/test/testcases.py | 12 ++-- django/test/utils.py | 8 +-- django/utils/autoreload.py | 4 +- django/utils/module_loading.py | 4 +- django/utils/translation/trans_real.py | 4 +- django/views/i18n.py | 4 +- docs/internals/deprecation.txt | 4 +- tests/app_cache/tests.py | 51 ------------- tests/app_loading/tests.py | 26 +++---- tests/{app_cache => apps}/__init__.py | 0 tests/{app_cache => apps}/models.py | 8 +-- tests/apps/tests.py | 51 +++++++++++++ tests/base/models.py | 2 +- tests/bash_completion/tests.py | 4 +- tests/commands_sql/tests.py | 14 ++-- tests/contenttypes_tests/tests.py | 4 +- tests/defer_regress/tests.py | 14 ++-- tests/invalid_models_tests/tests.py | 4 +- tests/managers_regress/tests.py | 26 +++---- tests/migrations/models.py | 6 +- tests/migrations/test_commands.py | 14 ++-- tests/migrations/test_loader.py | 2 +- tests/migrations/test_operations.py | 4 +- tests/migrations/test_state.py | 72 +++++++++---------- tests/no_models/tests.py | 4 +- tests/proxy_models/tests.py | 10 +-- tests/runtests.py | 14 ++-- tests/schema/models.py | 28 ++++---- tests/swappable_models/tests.py | 2 +- tests/tablespaces/tests.py | 10 +-- tests/test_suite_override/tests.py | 4 +- tests/validation/test_unique.py | 4 +- 92 files changed, 491 insertions(+), 487 deletions(-) rename django/apps/{cache.py => registry.py} (94%) delete mode 100644 tests/app_cache/tests.py rename tests/{app_cache => apps}/__init__.py (100%) rename tests/{app_cache => apps}/models.py (56%) create mode 100644 tests/apps/tests.py diff --git a/django/apps/__init__.py b/django/apps/__init__.py index 6b47d3397f..074a448660 100644 --- a/django/apps/__init__.py +++ b/django/apps/__init__.py @@ -1,2 +1,2 @@ from .base import AppConfig # NOQA -from .cache import app_cache # NOQA +from .registry import apps # NOQA diff --git a/django/apps/base.py b/django/apps/base.py index 706ed54ef6..f1baaa5adf 100644 --- a/django/apps/base.py +++ b/django/apps/base.py @@ -97,8 +97,8 @@ class AppConfig(object): def import_models(self, all_models): # Dictionary of models for this app, stored in the 'all_models' - # attribute of the AppCache this AppConfig is attached to. Injected as - # a parameter because it may get populated before this method has run. + # attribute of the Apps this AppConfig is attached to. Injected as a + # parameter because it may get populated before this method has run. self.models = all_models if module_has_submodule(self.app_module, MODELS_MODULE_NAME): diff --git a/django/apps/cache.py b/django/apps/registry.py similarity index 94% rename from django/apps/cache.py rename to django/apps/registry.py index 92007f637a..0cb58f2049 100644 --- a/django/apps/cache.py +++ b/django/apps/registry.py @@ -14,25 +14,26 @@ from django.utils._os import upath from .base import AppConfig -class AppCache(object): +class Apps(object): """ - A cache that stores installed applications and their models. Used to - provide reverse-relations and for app introspection. + A registry that stores the configuration of installed applications. + + It also keeps track of models eg. to provide reverse-relations. """ def __init__(self, master=False): - # Only one master of the app-cache may exist at a given time, and it - # shall be the app_cache variable defined at the end of this module. - if master and hasattr(sys.modules[__name__], 'app_cache'): - raise RuntimeError("You may create only one master app cache.") + # Only one master registry may exist at a given time, and it shall be + # the apps variable defined at the end of this module. + if master and hasattr(sys.modules[__name__], 'apps'): + raise RuntimeError("You may create only one master registry.") - # When master is set to False, the app cache isn't populated from + # When master is set to False, the registry isn't populated from # INSTALLED_APPS and ignores the only_installed arguments to # get_model[s]. self.master = master # Mapping of app labels => model names => model classes. Used to - # register models before the app cache is populated and also for + # register models before the registry is populated and also for # applications that aren't installed. self.all_models = defaultdict(OrderedDict) @@ -43,7 +44,7 @@ class AppCache(object): # set_available_apps and set_installed_apps. self.stored_app_configs = [] - # Internal flags used when populating the master cache. + # Internal flags used when populating the master registry. self._apps_loaded = not self.master self._models_loaded = not self.master @@ -133,9 +134,9 @@ class AppCache(object): self.get_models.cache_clear() self._models_loaded = True - def app_cache_ready(self): + def ready(self): """ - Returns true if the model cache is fully populated. + Returns True if the registry is fully populated. Useful for code that wants to cache the results of get_models() for themselves once it is safe to do so. @@ -200,7 +201,7 @@ class AppCache(object): By default, models that aren't part of installed apps will *not* be included in the list of models. However, if you specify only_installed=False, they will be. If you're using a non-default - AppCache, this argument does nothing - all models will be included. + Apps, this argument does nothing - all models will be included. By default, models that have been swapped out will *not* be included in the list of models. However, if you specify @@ -272,11 +273,11 @@ class AppCache(object): def has_app(self, app_name): """ - Checks whether an application with this name exists in the app cache. + Checks whether an application with this name exists in the registry. app_name is the full name of the app eg. 'django.contrib.admin'. - It's safe to call this method at import time, even while the app cache + It's safe to call this method at import time, even while the registry is being populated. It returns None for apps that aren't loaded yet. """ app_config = self.app_configs.get(app_name.rpartition(".")[2]) @@ -286,7 +287,7 @@ class AppCache(object): """ Returns the model class if one is registered and None otherwise. - It's safe to call this method at import time, even while the app cache + It's safe to call this method at import time, even while the registry is being populated. It returns None for models that aren't loaded yet. """ return self.all_models[app_label].get(model_name.lower()) @@ -371,6 +372,12 @@ class AppCache(object): self.get_models.cache_clear() return app_config.models_module + def app_cache_ready(self): + warnings.warn( + "app_cache_ready() is deprecated.", + PendingDeprecationWarning, stacklevel=2) + return self.ready() + def get_app(self, app_label): """ Returns the module containing the models for the given app_label. @@ -446,4 +453,4 @@ class AppCache(object): self.register_model(app_label, model) -app_cache = AppCache(master=True) +apps = Apps(master=True) diff --git a/django/contrib/admin/sites.py b/django/contrib/admin/sites.py index c2a409a0e4..0edeca210e 100644 --- a/django/contrib/admin/sites.py +++ b/django/contrib/admin/sites.py @@ -6,7 +6,7 @@ from django.contrib.auth import logout as auth_logout, REDIRECT_FIELD_NAME from django.contrib.contenttypes import views as contenttype_views from django.views.decorators.csrf import csrf_protect from django.db.models.base import ModelBase -from django.apps import app_cache +from django.apps import apps from django.core.exceptions import ImproperlyConfigured, PermissionDenied from django.core.urlresolvers import reverse, NoReverseMatch from django.template.response import TemplateResponse @@ -160,11 +160,11 @@ class AdminSite(object): The default implementation checks that admin and contenttypes apps are installed, as well as the auth context processor. """ - app_cache.populate_apps() - if not app_cache.has_app('django.contrib.admin'): + apps.populate_apps() + if not apps.has_app('django.contrib.admin'): raise ImproperlyConfigured("Put 'django.contrib.admin' in your " "INSTALLED_APPS setting in order to use the admin application.") - if not app_cache.has_app('django.contrib.contenttypes'): + if not apps.has_app('django.contrib.contenttypes'): raise ImproperlyConfigured("Put 'django.contrib.contenttypes' in " "your INSTALLED_APPS setting in order to use the admin application.") if 'django.contrib.auth.context_processors.auth' not in settings.TEMPLATE_CONTEXT_PROCESSORS: @@ -381,7 +381,7 @@ class AdminSite(object): app_dict[app_label]['models'].append(model_dict) else: app_dict[app_label] = { - 'name': app_cache.get_app_config(app_label).verbose_name, + 'name': apps.get_app_config(app_label).verbose_name, 'app_label': app_label, 'app_url': reverse('admin:app_list', kwargs={'app_label': app_label}, current_app=self.name), 'has_module_perms': has_module_perms, @@ -408,7 +408,7 @@ class AdminSite(object): def app_index(self, request, app_label, extra_context=None): user = request.user - app_name = app_cache.get_app_config(app_label).verbose_name + app_name = apps.get_app_config(app_label).verbose_name has_module_perms = user.has_module_perms(app_label) if not has_module_perms: raise PermissionDenied diff --git a/django/contrib/admin/templatetags/admin_static.py b/django/contrib/admin/templatetags/admin_static.py index 7c7a5e5654..446ab4cab5 100644 --- a/django/contrib/admin/templatetags/admin_static.py +++ b/django/contrib/admin/templatetags/admin_static.py @@ -1,9 +1,9 @@ -from django.apps import app_cache +from django.apps import apps from django.template import Library register = Library() -if app_cache.has_app('django.contrib.staticfiles'): +if apps.has_app('django.contrib.staticfiles'): from django.contrib.staticfiles.templatetags.staticfiles import static else: from django.templatetags.static import static diff --git a/django/contrib/admin/validation.py b/django/contrib/admin/validation.py index 18e3ad48f8..23dba7c7bd 100644 --- a/django/contrib/admin/validation.py +++ b/django/contrib/admin/validation.py @@ -1,4 +1,4 @@ -from django.apps import app_cache +from django.apps import apps from django.core.exceptions import ImproperlyConfigured from django.db import models from django.db.models.fields import FieldDoesNotExist @@ -16,9 +16,9 @@ __all__ = ['BaseValidator', 'InlineValidator'] class BaseValidator(object): def __init__(self): - # Before we can introspect models, they need the app cache to be fully - # loaded so that inter-relations are set up correctly. - app_cache.populate_models() + # Before we can introspect models, they need the app registry to be + # fully loaded so that inter-relations are set up correctly. + apps.populate_models() def validate(self, cls, model): for m in dir(self): diff --git a/django/contrib/admindocs/views.py b/django/contrib/admindocs/views.py index 973c81ddaf..ebb7687dea 100644 --- a/django/contrib/admindocs/views.py +++ b/django/contrib/admindocs/views.py @@ -5,7 +5,7 @@ import re import warnings from django import template -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.contrib import admin from django.contrib.admin.views.decorators import staff_member_required @@ -174,7 +174,7 @@ class ModelIndexView(BaseAdminDocsView): template_name = 'admin_doc/model_index.html' def get_context_data(self, **kwargs): - m_list = [m._meta for m in app_cache.get_models()] + m_list = [m._meta for m in apps.get_models()] kwargs.update({'models': m_list}) return super(ModelIndexView, self).get_context_data(**kwargs) @@ -185,10 +185,10 @@ class ModelDetailView(BaseAdminDocsView): def get_context_data(self, **kwargs): # Get the model class. try: - app_cache.get_app_config(self.kwargs['app_label']) + apps.get_app_config(self.kwargs['app_label']) except LookupError: raise Http404(_("App %(app_label)r not found") % self.kwargs) - model = app_cache.get_model(self.kwargs['app_label'], self.kwargs['model_name']) + model = apps.get_model(self.kwargs['app_label'], self.kwargs['model_name']) if model is None: raise Http404(_("Model %(model_name)r not found in app %(app_label)r") % self.kwargs) diff --git a/django/contrib/auth/__init__.py b/django/contrib/auth/__init__.py index 3c5a40c184..ef44737cc0 100644 --- a/django/contrib/auth/__init__.py +++ b/django/contrib/auth/__init__.py @@ -123,13 +123,13 @@ def get_user_model(): """ Returns the User model that is active in this project. """ - from django.apps import app_cache + from django.apps import apps try: app_label, model_name = settings.AUTH_USER_MODEL.split('.') except ValueError: raise ImproperlyConfigured("AUTH_USER_MODEL must be of the form 'app_label.model_name'") - user_model = app_cache.get_model(app_label, model_name) + user_model = apps.get_model(app_label, model_name) if user_model is None: raise ImproperlyConfigured("AUTH_USER_MODEL refers to model '%s' that has not been installed" % settings.AUTH_USER_MODEL) return user_model diff --git a/django/contrib/auth/management/__init__.py b/django/contrib/auth/management/__init__.py index 008661fac6..c2111e3b98 100644 --- a/django/contrib/auth/management/__init__.py +++ b/django/contrib/auth/management/__init__.py @@ -6,7 +6,7 @@ from __future__ import unicode_literals import getpass import unicodedata -from django.apps import app_cache +from django.apps import apps from django.contrib.auth import (models as auth_app, get_permission_codename, get_user_model) from django.core import exceptions @@ -61,7 +61,7 @@ def _check_permission_clashing(custom, builtin, ctype): def create_permissions(app, created_models, verbosity, db=DEFAULT_DB_ALIAS, **kwargs): - if app_cache.get_model('auth', 'Permission') is None: + if apps.get_model('auth', 'Permission') is None: return if not router.allow_migrate(db, auth_app.Permission): @@ -69,7 +69,7 @@ def create_permissions(app, created_models, verbosity, db=DEFAULT_DB_ALIAS, **kw from django.contrib.contenttypes.models import ContentType - app_models = app_cache.get_models(app) + app_models = apps.get_models(app) # This will hold the permissions we're looking for as # (content_type, (codename, name)) @@ -117,7 +117,7 @@ def create_permissions(app, created_models, verbosity, db=DEFAULT_DB_ALIAS, **kw def create_superuser(app, created_models, verbosity, db, **kwargs): - if app_cache.get_model('auth', 'Permission') is None: + if apps.get_model('auth', 'Permission') is None: return UserModel = get_user_model() diff --git a/django/contrib/auth/tests/test_management.py b/django/contrib/auth/tests/test_management.py index 57c986ac8a..838c8650fc 100644 --- a/django/contrib/auth/tests/test_management.py +++ b/django/contrib/auth/tests/test_management.py @@ -1,7 +1,7 @@ from __future__ import unicode_literals from datetime import date -from django.apps import app_cache +from django.apps import apps from django.contrib.auth import models, management from django.contrib.auth.management import create_permissions from django.contrib.auth.management.commands import changepassword @@ -183,21 +183,21 @@ class CustomUserModelValidationTestCase(TestCase): def test_required_fields_is_list(self): "REQUIRED_FIELDS should be a list." new_io = StringIO() - get_validation_errors(new_io, app_cache.get_app_config('auth').models_module) + get_validation_errors(new_io, apps.get_app_config('auth').models_module) self.assertIn("The REQUIRED_FIELDS must be a list or tuple.", new_io.getvalue()) @override_settings(AUTH_USER_MODEL='auth.CustomUserBadRequiredFields') def test_username_not_in_required_fields(self): "USERNAME_FIELD should not appear in REQUIRED_FIELDS." new_io = StringIO() - get_validation_errors(new_io, app_cache.get_app_config('auth').models_module) + get_validation_errors(new_io, apps.get_app_config('auth').models_module) self.assertIn("The field named as the USERNAME_FIELD should not be included in REQUIRED_FIELDS on a swappable User model.", new_io.getvalue()) @override_settings(AUTH_USER_MODEL='auth.CustomUserNonUniqueUsername') def test_username_non_unique(self): "A non-unique USERNAME_FIELD should raise a model validation error." new_io = StringIO() - get_validation_errors(new_io, app_cache.get_app_config('auth').models_module) + get_validation_errors(new_io, apps.get_app_config('auth').models_module) self.assertIn("The USERNAME_FIELD must be unique. Add unique=True to the field parameters.", new_io.getvalue()) diff --git a/django/contrib/comments/__init__.py b/django/contrib/comments/__init__.py index f265875c36..a6286b48ed 100644 --- a/django/contrib/comments/__init__.py +++ b/django/contrib/comments/__init__.py @@ -1,6 +1,6 @@ from importlib import import_module import warnings -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.core import urlresolvers from django.core.exceptions import ImproperlyConfigured @@ -16,7 +16,7 @@ def get_comment_app(): Get the comment app (i.e. "django.contrib.comments") as defined in the settings """ try: - app_config = app_cache.get_app_config(get_comment_app_name().rpartition(".")[2]) + app_config = apps.get_app_config(get_comment_app_name().rpartition(".")[2]) except LookupError: raise ImproperlyConfigured("The COMMENTS_APP (%r) " "must be in INSTALLED_APPS" % settings.COMMENTS_APP) diff --git a/django/contrib/comments/views/comments.py b/django/contrib/comments/views/comments.py index 5d7c543adb..bad8eb50f7 100644 --- a/django/contrib/comments/views/comments.py +++ b/django/contrib/comments/views/comments.py @@ -1,5 +1,5 @@ from django import http -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.contrib import comments from django.contrib.comments import signals @@ -49,7 +49,7 @@ def post_comment(request, next=None, using=None): if ctype is None or object_pk is None: return CommentPostBadRequest("Missing content_type or object_pk field.") try: - model = app_cache.get_model(*ctype.split(".", 1)) + model = apps.get_model(*ctype.split(".", 1)) target = model._default_manager.using(using).get(pk=object_pk) except TypeError: return CommentPostBadRequest( diff --git a/django/contrib/contenttypes/management.py b/django/contrib/contenttypes/management.py index 4ea10ebe58..87171b1ff2 100644 --- a/django/contrib/contenttypes/management.py +++ b/django/contrib/contenttypes/management.py @@ -1,4 +1,4 @@ -from django.apps import app_cache +from django.apps import apps from django.contrib.contenttypes.models import ContentType from django.db import DEFAULT_DB_ALIAS, router from django.db.models import signals @@ -12,14 +12,14 @@ def update_contenttypes(app, created_models, verbosity=2, db=DEFAULT_DB_ALIAS, * Creates content types for models in the given app, removing any model entries that no longer have a matching model class. """ - if app_cache.get_model('contenttypes', 'ContentType') is None: + if apps.get_model('contenttypes', 'ContentType') is None: return if not router.allow_migrate(db, ContentType): return ContentType.objects.clear_cache() - app_models = app_cache.get_models(app) + app_models = apps.get_models(app) if not app_models: return # They all have the same app_label, get the first one. @@ -84,7 +84,7 @@ If you're unsure, answer 'no'. def update_all_contenttypes(verbosity=2, **kwargs): - for app_config in app_cache.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(only_with_models_module=True): update_contenttypes(app_config.models_module, None, verbosity, **kwargs) signals.post_migrate.connect(update_contenttypes) diff --git a/django/contrib/contenttypes/models.py b/django/contrib/contenttypes/models.py index 90dea5b811..6df1087cae 100644 --- a/django/contrib/contenttypes/models.py +++ b/django/contrib/contenttypes/models.py @@ -1,4 +1,4 @@ -from django.apps import app_cache +from django.apps import apps from django.db import models from django.utils.translation import ugettext_lazy as _ from django.utils.encoding import smart_text, force_text @@ -157,8 +157,7 @@ class ContentType(models.Model): def model_class(self): "Returns the Python model class for this type of content." - return app_cache.get_model(self.app_label, self.model, - only_installed=False) + return apps.get_model(self.app_label, self.model, only_installed=False) def get_object_for_this_type(self, **kwargs): """ diff --git a/django/contrib/gis/sitemaps/kml.py b/django/contrib/gis/sitemaps/kml.py index 1e4fc82550..74d7acd772 100644 --- a/django/contrib/gis/sitemaps/kml.py +++ b/django/contrib/gis/sitemaps/kml.py @@ -1,4 +1,4 @@ -from django.apps import app_cache +from django.apps import apps from django.core import urlresolvers from django.contrib.sitemaps import Sitemap from django.contrib.gis.db.models.fields import GeometryField @@ -26,7 +26,7 @@ class KMLSitemap(Sitemap): """ kml_sources = [] if sources is None: - sources = app_cache.get_models() + sources = apps.get_models() for source in sources: if isinstance(source, models.base.ModelBase): for field in source._meta.fields: diff --git a/django/contrib/gis/sitemaps/views.py b/django/contrib/gis/sitemaps/views.py index e68523981e..20a91130bb 100644 --- a/django/contrib/gis/sitemaps/views.py +++ b/django/contrib/gis/sitemaps/views.py @@ -2,7 +2,7 @@ from __future__ import unicode_literals import warnings -from django.apps import app_cache +from django.apps import apps from django.http import HttpResponse, Http404 from django.template import loader from django.contrib.sites.models import get_current_site @@ -81,7 +81,7 @@ def kml(request, label, model, field_name=None, compress=False, using=DEFAULT_DB must be that of a geographic field. """ placemarks = [] - klass = app_cache.get_model(label, model) + klass = apps.get_model(label, model) if not klass: raise Http404('You must supply a valid app label and module name. Got "%s.%s"' % (label, model)) diff --git a/django/contrib/messages/tests/base.py b/django/contrib/messages/tests/base.py index 54592e8d25..7244a6d34e 100644 --- a/django/contrib/messages/tests/base.py +++ b/django/contrib/messages/tests/base.py @@ -1,7 +1,7 @@ from unittest import skipUnless from django import http -from django.apps import app_cache +from django.apps import apps from django.conf import global_settings from django.contrib.messages import constants, utils, get_level, set_level from django.contrib.messages.api import MessageFailure @@ -15,7 +15,7 @@ from django.utils.translation import ugettext_lazy def skipUnlessAuthIsInstalled(func): return skipUnless( - app_cache.has_app('django.contrib.auth'), + apps.has_app('django.contrib.auth'), "django.contrib.auth isn't installed")(func) diff --git a/django/contrib/redirects/middleware.py b/django/contrib/redirects/middleware.py index c5b672659e..52c9a49a8f 100644 --- a/django/contrib/redirects/middleware.py +++ b/django/contrib/redirects/middleware.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.contrib.redirects.models import Redirect from django.contrib.sites.models import get_current_site @@ -15,7 +15,7 @@ class RedirectFallbackMiddleware(object): response_redirect_class = http.HttpResponsePermanentRedirect def __init__(self): - if not app_cache.has_app('django.contrib.sites'): + if not apps.has_app('django.contrib.sites'): raise ImproperlyConfigured( "You cannot use RedirectFallbackMiddleware when " "django.contrib.sites is not installed." diff --git a/django/contrib/sitemaps/tests/test_flatpages.py b/django/contrib/sitemaps/tests/test_flatpages.py index 90172e558f..4e9deb8de4 100644 --- a/django/contrib/sitemaps/tests/test_flatpages.py +++ b/django/contrib/sitemaps/tests/test_flatpages.py @@ -2,7 +2,7 @@ from __future__ import unicode_literals from unittest import skipUnless -from django.apps import app_cache +from django.apps import apps from django.conf import settings from .base import SitemapTestsBase @@ -10,7 +10,7 @@ from .base import SitemapTestsBase class FlatpagesSitemapTests(SitemapTestsBase): - @skipUnless(app_cache.has_app('django.contrib.flatpages'), + @skipUnless(apps.has_app('django.contrib.flatpages'), "django.contrib.flatpages app not installed.") def test_flatpage_sitemap(self): "Basic FlatPage sitemap test" diff --git a/django/contrib/sitemaps/tests/test_http.py b/django/contrib/sitemaps/tests/test_http.py index 583b0b44bf..e8c3409c74 100644 --- a/django/contrib/sitemaps/tests/test_http.py +++ b/django/contrib/sitemaps/tests/test_http.py @@ -4,7 +4,7 @@ import os from datetime import date from unittest import skipUnless -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.contrib.sitemaps import Sitemap, GenericSitemap from django.contrib.sites.models import Site @@ -118,7 +118,7 @@ class HTTPSitemapTests(SitemapTestsBase): """ % date.today() self.assertXMLEqual(response.content.decode('utf-8'), expected_content) - @skipUnless(app_cache.has_app('django.contrib.sites'), + @skipUnless(apps.has_app('django.contrib.sites'), "django.contrib.sites app not installed.") def test_sitemap_get_urls_no_site_1(self): """ diff --git a/django/contrib/staticfiles/finders.py b/django/contrib/staticfiles/finders.py index de907ef8ef..eede6fbaa8 100644 --- a/django/contrib/staticfiles/finders.py +++ b/django/contrib/staticfiles/finders.py @@ -1,7 +1,7 @@ from collections import OrderedDict import os -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.core.exceptions import ImproperlyConfigured from django.core.files.storage import default_storage, Storage, FileSystemStorage @@ -43,7 +43,7 @@ class FileSystemFinder(BaseFinder): A static files finder that uses the ``STATICFILES_DIRS`` setting to locate files. """ - def __init__(self, apps=None, *args, **kwargs): + def __init__(self, app_names=None, *args, **kwargs): # List of locations with static files self.locations = [] # Maps dir paths to an appropriate storage instance @@ -114,15 +114,15 @@ class AppDirectoriesFinder(BaseFinder): """ storage_class = AppStaticStorage - def __init__(self, apps=None, *args, **kwargs): + def __init__(self, app_names=None, *args, **kwargs): # The list of apps that are handled self.apps = [] # Mapping of app names to storage instances self.storages = OrderedDict() - if apps is None: - app_configs = app_cache.get_app_configs() - apps = [app_config.name for app_config in app_configs] - for app in apps: + if app_names is None: + app_configs = apps.get_app_configs() + app_names = [app_config.name for app_config in app_configs] + for app in app_names: app_storage = self.storage_class(app) if os.path.isdir(app_storage.location): self.storages[app] = app_storage diff --git a/django/core/checks/compatibility/django_1_6_0.py b/django/core/checks/compatibility/django_1_6_0.py index a42249de60..1be727f70d 100644 --- a/django/core/checks/compatibility/django_1_6_0.py +++ b/django/core/checks/compatibility/django_1_6_0.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals -from django.apps import app_cache +from django.apps import apps from django.db import models @@ -32,7 +32,7 @@ def check_boolean_field_default_value(): warns the user that the default has changed from False to Null. """ fields = [] - for cls in app_cache.get_models(): + for cls in apps.get_models(): opts = cls._meta for f in opts.local_fields: if isinstance(f, models.BooleanField) and not f.has_default(): diff --git a/django/core/management/__init__.py b/django/core/management/__init__.py index bc81b8f9d2..019837b35c 100644 --- a/django/core/management/__init__.py +++ b/django/core/management/__init__.py @@ -112,17 +112,17 @@ def get_commands(): except ImproperlyConfigured: # Still useful for commands that do not require functional # settings, like startproject or help. - apps = [] + app_names = [] else: - # Populate the app cache outside of the try/except block to avoid - # catching ImproperlyConfigured errors that aren't caused by the - # absence of a settings module. - from django.apps import app_cache - app_configs = app_cache.get_app_configs() - apps = [app_config.name for app_config in app_configs] + # Populate the app registry outside of the try/except block to + # avoid catching ImproperlyConfigured errors that aren't caused + # by the absence of a settings module. + from django.apps import apps + app_configs = apps.get_app_configs() + app_names = [app_config.name for app_config in app_configs] # Find and load the management module for each installed app. - for app_name in apps: + for app_name in app_names: try: path = find_management_module(app_name) _commands.update(dict((name, app_name) for name in find_commands(path))) @@ -346,8 +346,8 @@ class ManagementUtility(object): elif cwords[0] in ('dumpdata', 'sql', 'sqlall', 'sqlclear', 'sqlcustom', 'sqlindexes', 'sqlsequencereset', 'test'): try: - from django.apps import app_cache - app_configs = app_cache.get_app_configs() + from django.apps import apps + app_configs = apps.get_app_configs() # Get the last part of the dotted path as the app name. options += [(app_config.label, 0) for app_config in app_configs] except ImportError: diff --git a/django/core/management/base.py b/django/core/management/base.py index 101a486b40..5c3a1a6c8c 100644 --- a/django/core/management/base.py +++ b/django/core/management/base.py @@ -341,16 +341,16 @@ class AppCommand(BaseCommand): args = '' def handle(self, *app_labels, **options): - from django.apps import app_cache + from django.apps import apps if not app_labels: raise CommandError('Enter at least one appname.') # Populate models and don't use only_with_models_module=True when # calling get_app_config() to tell apart missing apps from apps # without a model module -- which can't be supported with the legacy # API since it passes the models module to handle_app(). - app_cache.populate_models() + apps.populate_models() try: - app_configs = [app_cache.get_app_config(app_label) for app_label in app_labels] + app_configs = [apps.get_app_config(app_label) for app_label in app_labels] except (LookupError, ImportError) as e: raise CommandError("%s. Are you sure your INSTALLED_APPS setting is correct?" % e) output = [] diff --git a/django/core/management/commands/dumpdata.py b/django/core/management/commands/dumpdata.py index 9aebb6c7d6..f6b9e7a4c8 100644 --- a/django/core/management/commands/dumpdata.py +++ b/django/core/management/commands/dumpdata.py @@ -37,7 +37,7 @@ class Command(BaseCommand): args = '[appname appname.ModelName ...]' def handle(self, *app_labels, **options): - from django.apps import app_cache + from django.apps import apps format = options.get('format') indent = options.get('indent') @@ -63,13 +63,13 @@ class Command(BaseCommand): for exclude in excludes: if '.' in exclude: app_label, model_name = exclude.split('.', 1) - model_obj = app_cache.get_model(app_label, model_name) + model_obj = apps.get_model(app_label, model_name) if not model_obj: raise CommandError('Unknown model in excludes: %s' % exclude) excluded_models.add(model_obj) else: try: - app_obj = app_cache.get_app_config(exclude).models_module + app_obj = apps.get_app_config(exclude).models_module if app_obj is not None: excluded_apps.add(app_obj) except LookupError: @@ -79,7 +79,7 @@ class Command(BaseCommand): if primary_keys: raise CommandError("You can only use --pks option with one model") app_list = OrderedDict((app_config.models_module, None) - for app_config in app_cache.get_app_configs(only_with_models_module=True) + for app_config in apps.get_app_configs(only_with_models_module=True) if app_config.models_module not in excluded_apps) else: if len(app_labels) > 1 and primary_keys: @@ -89,12 +89,12 @@ class Command(BaseCommand): try: app_label, model_label = label.split('.') try: - app = app_cache.get_app_config(app_label).models_module + app = apps.get_app_config(app_label).models_module except LookupError: raise CommandError("Unknown application: %s" % app_label) if app is None or app in excluded_apps: continue - model = app_cache.get_model(app_label, model_label) + model = apps.get_model(app_label, model_label) if model is None: raise CommandError("Unknown model: %s.%s" % (app_label, model_label)) @@ -109,7 +109,7 @@ class Command(BaseCommand): # This is just an app - no model qualifier app_label = label try: - app = app_cache.get_app_config(app_label).models_module + app = apps.get_app_config(app_label).models_module except LookupError: raise CommandError("Unknown application: %s" % app_label) if app is None or app in excluded_apps: @@ -162,13 +162,13 @@ def sort_dependencies(app_list): is serialized before a normal model, and any model with a natural key dependency has it's dependencies serialized first. """ - from django.apps import app_cache + from django.apps import apps # Process the list of models, and get the list of dependencies model_dependencies = [] models = set() for app, model_list in app_list: if model_list is None: - model_list = app_cache.get_models(app) + model_list = apps.get_models(app) for model in model_list: models.add(model) @@ -176,7 +176,7 @@ def sort_dependencies(app_list): if hasattr(model, 'natural_key'): deps = getattr(model.natural_key, 'dependencies', []) if deps: - deps = [app_cache.get_model(*d.split('.')) for d in deps] + deps = [apps.get_model(*d.split('.')) for d in deps] else: deps = [] diff --git a/django/core/management/commands/flush.py b/django/core/management/commands/flush.py index 49007bf0a2..619df9536c 100644 --- a/django/core/management/commands/flush.py +++ b/django/core/management/commands/flush.py @@ -2,7 +2,7 @@ import sys from importlib import import_module from optparse import make_option -from django.apps import app_cache +from django.apps import apps from django.db import connections, router, transaction, DEFAULT_DB_ALIAS from django.core.management import call_command from django.core.management.base import NoArgsCommand, CommandError @@ -41,7 +41,7 @@ class Command(NoArgsCommand): # Import the 'management' module within each installed app, to register # dispatcher events. - for app_config in app_cache.get_app_configs(): + for app_config in apps.get_app_configs(): try: import_module('.management', app_config.name) except ImportError: @@ -93,6 +93,6 @@ Are you sure you want to do this? # Emit the post migrate signal. This allows individual applications to # respond as if the database had been migrated from scratch. all_models = [] - for app_config in app_cache.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(only_with_models_module=True): all_models.extend(router.get_migratable_models(app_config.models_module, database, include_auto_created=True)) emit_post_migrate_signal(set(all_models), verbosity, interactive, database) diff --git a/django/core/management/commands/loaddata.py b/django/core/management/commands/loaddata.py index bfeba68aa6..65bc96ba99 100644 --- a/django/core/management/commands/loaddata.py +++ b/django/core/management/commands/loaddata.py @@ -7,7 +7,7 @@ import warnings import zipfile from optparse import make_option -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.core import serializers from django.core.management.base import BaseCommand, CommandError @@ -230,7 +230,7 @@ class Command(BaseCommand): current directory. """ dirs = [] - for app_config in app_cache.get_app_configs(): + for app_config in apps.get_app_configs(): d = os.path.join(app_config.path, 'fixtures') if os.path.isdir(d): dirs.append(d) diff --git a/django/core/management/commands/makemigrations.py b/django/core/management/commands/makemigrations.py index aaf0270840..411aec42b3 100644 --- a/django/core/management/commands/makemigrations.py +++ b/django/core/management/commands/makemigrations.py @@ -3,7 +3,7 @@ import os import operator from optparse import make_option -from django.apps import app_cache +from django.apps import apps from django.core.management.base import BaseCommand, CommandError from django.db import connections, DEFAULT_DB_ALIAS, migrations from django.db.migrations.loader import MigrationLoader @@ -37,7 +37,7 @@ class Command(BaseCommand): bad_app_labels = set() for app_label in app_labels: try: - app_cache.get_app_config(app_label) + apps.get_app_config(app_label) except LookupError: bad_app_labels.add(app_label) if bad_app_labels: @@ -72,7 +72,7 @@ class Command(BaseCommand): # Detect changes autodetector = MigrationAutodetector( loader.graph.project_state(), - ProjectState.from_app_cache(app_cache), + ProjectState.from_apps(apps), InteractiveMigrationQuestioner(specified_apps=app_labels), ) changes = autodetector.changes(graph=loader.graph, trim_to_apps=app_labels or None) diff --git a/django/core/management/commands/migrate.py b/django/core/management/commands/migrate.py index 05b4a62e87..1f5e9619c7 100644 --- a/django/core/management/commands/migrate.py +++ b/django/core/management/commands/migrate.py @@ -6,7 +6,7 @@ from importlib import import_module import itertools import traceback -from django.apps import app_cache +from django.apps import apps from django.core.management import call_command from django.core.management.base import BaseCommand, CommandError from django.core.management.color import no_style @@ -46,7 +46,7 @@ class Command(BaseCommand): # Import the 'management' module within each installed app, to register # dispatcher events. - for app_config in app_cache.get_app_configs(): + for app_config in apps.get_app_configs(): if module_has_submodule(app_config.app_module, "management"): import_module('.management', app_config.name) @@ -135,7 +135,7 @@ class Command(BaseCommand): # If there's changes that aren't in migrations yet, tell them how to fix it. autodetector = MigrationAutodetector( executor.loader.graph.project_state(), - ProjectState.from_app_cache(app_cache), + ProjectState.from_apps(apps), ) changes = autodetector.changes(graph=executor.loader.graph) if changes: @@ -167,8 +167,8 @@ class Command(BaseCommand): else: self.stdout.write(self.style.MIGRATE_SUCCESS(" OK")) - def sync_apps(self, connection, apps): - "Runs the old syncdb-style operation on a list of apps." + def sync_apps(self, connection, app_labels): + "Runs the old syncdb-style operation on a list of app_labels." cursor = connection.cursor() # Get a list of already installed *models* so that references work right. @@ -181,8 +181,8 @@ class Command(BaseCommand): all_models = [ (app_config.label, router.get_migratable_models(app_config.models_module, connection.alias, include_auto_created=True)) - for app_config in app_cache.get_app_configs(only_with_models_module=True) - if app_config.label in apps + for app_config in apps.get_app_configs(only_with_models_module=True) + if app_config.label in app_labels ] def model_installed(model): @@ -277,7 +277,7 @@ class Command(BaseCommand): return created_models - def show_migration_list(self, connection, apps=None): + def show_migration_list(self, connection, app_names=None): """ Shows a list of all migrations on the system, or only those of some named apps. @@ -286,24 +286,24 @@ class Command(BaseCommand): loader = MigrationLoader(connection) graph = loader.graph # If we were passed a list of apps, validate it - if apps: + if app_names: invalid_apps = [] - for app in apps: - if app not in loader.migrated_apps: - invalid_apps.append(app) + for app_name in app_names: + if app_name not in loader.migrated_apps: + invalid_apps.append(app_name) if invalid_apps: raise CommandError("No migrations present for: %s" % (", ".join(invalid_apps))) # Otherwise, show all apps in alphabetic order else: - apps = sorted(loader.migrated_apps) + app_names = sorted(loader.migrated_apps) # For each app, print its migrations in order from oldest (roots) to # newest (leaves). - for app in apps: - self.stdout.write(app, self.style.MIGRATE_LABEL) + for app_name in app_names: + self.stdout.write(app_name, self.style.MIGRATE_LABEL) shown = set() - for node in graph.leaf_nodes(app): + for node in graph.leaf_nodes(app_name): for plan_node in graph.forwards_plan(node): - if plan_node not in shown and plan_node[0] == app: + if plan_node not in shown and plan_node[0] == app_name: # Give it a nice title if it's a squashed one title = plan_node[1] if graph.nodes[plan_node].replaces: diff --git a/django/core/management/commands/shell.py b/django/core/management/commands/shell.py index 12af814161..149b9edd89 100644 --- a/django/core/management/commands/shell.py +++ b/django/core/management/commands/shell.py @@ -66,8 +66,8 @@ class Command(NoArgsCommand): def handle_noargs(self, **options): # XXX: (Temporary) workaround for ticket #1796: force early loading of all # models from installed apps. - from django.apps import app_cache - app_cache.get_models() + from django.apps import apps + apps.get_models() use_plain = options.get('plain', False) no_startup = options.get('no_startup', False) diff --git a/django/core/management/commands/sqlsequencereset.py b/django/core/management/commands/sqlsequencereset.py index 24ec25e8ed..58f171e87b 100644 --- a/django/core/management/commands/sqlsequencereset.py +++ b/django/core/management/commands/sqlsequencereset.py @@ -2,7 +2,7 @@ from __future__ import unicode_literals from optparse import make_option -from django.apps import app_cache +from django.apps import apps from django.core.management.base import AppCommand from django.db import connections, DEFAULT_DB_ALIAS @@ -21,4 +21,4 @@ class Command(AppCommand): def handle_app(self, app, **options): connection = connections[options.get('database')] - return '\n'.join(connection.ops.sequence_reset_sql(self.style, app_cache.get_models(app, include_auto_created=True))) + return '\n'.join(connection.ops.sequence_reset_sql(self.style, apps.get_models(app, include_auto_created=True))) diff --git a/django/core/management/sql.py b/django/core/management/sql.py index b2500d3787..35ce693e3b 100644 --- a/django/core/management/sql.py +++ b/django/core/management/sql.py @@ -5,7 +5,7 @@ import os import re import warnings -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.core.management.base import CommandError from django.db import models, router @@ -25,7 +25,7 @@ def sql_create(app, style, connection): # We trim models from the current app so that the sqlreset command does not # generate invalid SQL (leaving models out of known_models is harmless, so # we can be conservative). - app_models = app_cache.get_models(app, include_auto_created=True) + app_models = apps.get_models(app, include_auto_created=True) final_output = [] tables = connection.introspection.table_names() known_models = set(model for model in connection.introspection.installed_models(tables) if model not in app_models) @@ -169,7 +169,7 @@ def _split_statements(content): def custom_sql_for_model(model, style, connection): opts = model._meta app_dirs = [] - app_dir = app_cache.get_app_config(model._meta.app_label).path + app_dir = apps.get_app_config(model._meta.app_label).path app_dirs.append(os.path.normpath(os.path.join(app_dir, 'sql'))) # Deprecated location -- remove in Django 1.9 @@ -207,7 +207,7 @@ def custom_sql_for_model(model, style, connection): def emit_pre_migrate_signal(create_models, verbosity, interactive, db): # Emit the pre_migrate signal for every application. - for app_config in app_cache.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(only_with_models_module=True): if verbosity >= 2: print("Running pre-migrate handlers for application %s" % app_config.label) models.signals.pre_migrate.send( @@ -221,7 +221,7 @@ def emit_pre_migrate_signal(create_models, verbosity, interactive, db): def emit_post_migrate_signal(created_models, verbosity, interactive, db): # Emit the post_migrate signal for every application. - for app_config in app_cache.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(only_with_models_module=True): if verbosity >= 2: print("Running post-migrate handlers for application %s" % app_config.label) models.signals.post_migrate.send( diff --git a/django/core/management/validation.py b/django/core/management/validation.py index 2b27a7edce..c3b55770ce 100644 --- a/django/core/management/validation.py +++ b/django/core/management/validation.py @@ -26,13 +26,13 @@ def get_validation_errors(outfile, app=None): validates all models of all installed apps. Writes errors, if any, to outfile. Returns number of errors. """ - from django.apps import app_cache + from django.apps import apps from django.db import connection, models from django.db.models.deletion import SET_NULL, SET_DEFAULT e = ModelErrorCollection(outfile) - for cls in app_cache.get_models(app, include_swapped=True): + for cls in apps.get_models(app, include_swapped=True): opts = cls._meta # Check swappable attribute. @@ -42,7 +42,7 @@ def get_validation_errors(outfile, app=None): except ValueError: e.add(opts, "%s is not of the form 'app_label.app_name'." % opts.swappable) continue - if not app_cache.get_model(app_label, model_name): + if not apps.get_model(app_label, model_name): e.add(opts, "Model has been swapped out for '%s' which has not been installed or is abstract." % opts.swapped) # No need to perform any other validation checks on a swapped model. continue @@ -152,7 +152,7 @@ def get_validation_errors(outfile, app=None): # Check to see if the related field will clash with any existing # fields, m2m fields, m2m related objects or related objects if f.rel: - if f.rel.to not in app_cache.get_models(): + if f.rel.to not in apps.get_models(): # If the related model is swapped, provide a hint; # otherwise, the model just hasn't been installed. if not isinstance(f.rel.to, six.string_types) and f.rel.to._meta.swapped: @@ -207,7 +207,7 @@ def get_validation_errors(outfile, app=None): # Check to see if the related m2m field will clash with any # existing fields, m2m fields, m2m related objects or related # objects - if f.rel.to not in app_cache.get_models(): + if f.rel.to not in apps.get_models(): # If the related model is swapped, provide a hint; # otherwise, the model just hasn't been installed. if not isinstance(f.rel.to, six.string_types) and f.rel.to._meta.swapped: @@ -265,7 +265,7 @@ def get_validation_errors(outfile, app=None): ) else: seen_to = True - if f.rel.through not in app_cache.get_models(include_auto_created=True): + if f.rel.through not in apps.get_models(include_auto_created=True): e.add(opts, "'%s' specifies an m2m relation through model " "%s, which has not been installed." % (f.name, f.rel.through)) signature = (f.rel.to, cls, f.rel.through) diff --git a/django/core/serializers/base.py b/django/core/serializers/base.py index d516656a69..70bc651f82 100644 --- a/django/core/serializers/base.py +++ b/django/core/serializers/base.py @@ -3,7 +3,7 @@ Module for abstract serializer/unserializer base classes. """ import warnings -from django.apps import app_cache +from django.apps import apps from django.db import models from django.utils import six @@ -137,9 +137,9 @@ class Deserializer(six.Iterator): self.stream = six.StringIO(stream_or_string) else: self.stream = stream_or_string - # Make sure the app cache is loaded before deserialization starts + # Make sure the app registy is loaded before deserialization starts # (otherwise subclass calls to get_model() and friends might fail...) - app_cache.populate_models() + apps.populate_models() def __iter__(self): return self diff --git a/django/core/serializers/python.py b/django/core/serializers/python.py index c8a2b7eff2..a46adeef7a 100644 --- a/django/core/serializers/python.py +++ b/django/core/serializers/python.py @@ -5,7 +5,7 @@ other serializers. """ from __future__ import unicode_literals -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.core.serializers import base from django.db import models, DEFAULT_DB_ALIAS @@ -88,7 +88,7 @@ def Deserializer(object_list, **options): db = options.pop('using', DEFAULT_DB_ALIAS) ignore = options.pop('ignorenonexistent', False) - app_cache.populate_models() + apps.populate_models() for d in object_list: # Look up the model and starting build a dict of data for it. @@ -155,7 +155,7 @@ def _get_model(model_identifier): Helper to look up a model from an "app_label.model_name" string. """ try: - Model = app_cache.get_model(*model_identifier.split(".")) + Model = apps.get_model(*model_identifier.split(".")) except TypeError: Model = None if Model is None: diff --git a/django/core/serializers/xml_serializer.py b/django/core/serializers/xml_serializer.py index e9bea84bb1..81e41f8a32 100644 --- a/django/core/serializers/xml_serializer.py +++ b/django/core/serializers/xml_serializer.py @@ -4,7 +4,7 @@ XML serializer. from __future__ import unicode_literals -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.core.serializers import base from django.db import models, DEFAULT_DB_ALIAS @@ -277,7 +277,7 @@ class Deserializer(base.Deserializer): "<%s> node is missing the required '%s' attribute" % (node.nodeName, attr)) try: - Model = app_cache.get_model(*model_identifier.split(".")) + Model = apps.get_model(*model_identifier.split(".")) except TypeError: Model = None if Model is None: diff --git a/django/db/backends/__init__.py b/django/db/backends/__init__.py index 86905afe77..c5f650d503 100644 --- a/django/db/backends/__init__.py +++ b/django/db/backends/__init__.py @@ -1268,10 +1268,10 @@ class BaseDatabaseIntrospection(object): If only_existing is True, the resulting list will only include the tables that actually exist in the database. """ - from django.apps import app_cache + from django.apps import apps from django.db import router tables = set() - for app_config in app_cache.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(only_with_models_module=True): for model in router.get_migratable_models(app_config.models_module, self.connection.alias): if not model._meta.managed: continue @@ -1289,10 +1289,10 @@ class BaseDatabaseIntrospection(object): def installed_models(self, tables): "Returns a set of all models represented by the provided list of table names." - from django.apps import app_cache + from django.apps import apps from django.db import router all_models = [] - for app_config in app_cache.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(only_with_models_module=True): all_models.extend(router.get_migratable_models(app_config.models_module, self.connection.alias)) tables = list(map(self.table_name_converter, tables)) return set([ @@ -1302,12 +1302,12 @@ class BaseDatabaseIntrospection(object): def sequence_list(self): "Returns a list of information about all DB sequences for all models in all apps." - from django.apps import app_cache + from django.apps import apps from django.db import models, router sequence_list = [] - for app_config in app_cache.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(only_with_models_module=True): for model in router.get_migratable_models(app_config.models_module, self.connection.alias): if not model._meta.managed: continue diff --git a/django/db/backends/sqlite3/schema.py b/django/db/backends/sqlite3/schema.py index 52ca2de8ed..3196b48946 100644 --- a/django/db/backends/sqlite3/schema.py +++ b/django/db/backends/sqlite3/schema.py @@ -1,4 +1,4 @@ -from django.apps.cache import AppCache +from django.apps.registry import Apps from django.db.backends.schema import BaseDatabaseSchemaEditor from django.db.models.fields.related import ManyToManyField @@ -38,14 +38,14 @@ class DatabaseSchemaEditor(BaseDatabaseSchemaEditor): for field in delete_fields: del body[field.name] del mapping[field.column] - # Work inside a new AppCache - app_cache = AppCache() + # Work inside a new app registry + apps = Apps() # Construct a new model for the new state meta_contents = { 'app_label': model._meta.app_label, 'db_table': model._meta.db_table + "__new", 'unique_together': model._meta.unique_together if override_uniques is None else override_uniques, - 'app_cache': app_cache, + 'apps': apps, } meta = type("Meta", tuple(), meta_contents) body['Meta'] = meta diff --git a/django/db/migrations/autodetector.py b/django/db/migrations/autodetector.py index 4074366188..f71d193960 100644 --- a/django/db/migrations/autodetector.py +++ b/django/db/migrations/autodetector.py @@ -47,19 +47,19 @@ class MigrationAutodetector(object): """ # We'll store migrations as lists by app names for now self.migrations = {} - old_app_cache = self.from_state.render() - new_app_cache = self.to_state.render() + old_apps = self.from_state.render() + new_apps = self.to_state.render() # Prepare lists of old/new model keys that we care about # (i.e. ignoring proxy ones) old_model_keys = [ (al, mn) for al, mn in self.from_state.models.keys() - if not old_app_cache.get_model(al, mn)._meta.proxy + if not old_apps.get_model(al, mn)._meta.proxy ] new_model_keys = [ (al, mn) for al, mn in self.to_state.models.keys() - if not new_app_cache.get_model(al, mn)._meta.proxy + if not new_apps.get_model(al, mn)._meta.proxy ] # Adding models. Phase 1 is adding models with no outward relationships. added_models = set(new_model_keys) - set(old_model_keys) @@ -68,7 +68,7 @@ class MigrationAutodetector(object): model_state = self.to_state.models[app_label, model_name] # Are there any relationships out from this model? if so, punt it to the next phase. related_fields = [] - for field in new_app_cache.get_model(app_label, model_name)._meta.local_fields: + for field in new_apps.get_model(app_label, model_name)._meta.local_fields: if field.rel: if field.rel.to: related_fields.append((field.name, field.rel.to._meta.app_label.lower(), field.rel.to._meta.object_name.lower())) diff --git a/django/db/migrations/executor.py b/django/db/migrations/executor.py index 26d269fd9f..9ecdf771e3 100644 --- a/django/db/migrations/executor.py +++ b/django/db/migrations/executor.py @@ -129,10 +129,10 @@ class MigrationExecutor(object): on initial migrations (as it only looks for CreateModel). """ project_state = self.loader.graph.project_state((migration.app_label, migration.name), at_end=True) - app_cache = project_state.render() + apps = project_state.render() for operation in migration.operations: if isinstance(operation, migrations.CreateModel): - model = app_cache.get_model(migration.app_label, operation.name) + model = apps.get_model(migration.app_label, operation.name) if model._meta.db_table not in self.connection.introspection.get_table_list(self.connection.cursor()): return False return True diff --git a/django/db/migrations/loader.py b/django/db/migrations/loader.py index 9a54f14e75..d24f7ab889 100644 --- a/django/db/migrations/loader.py +++ b/django/db/migrations/loader.py @@ -2,7 +2,7 @@ from importlib import import_module import os import sys -from django.apps import app_cache +from django.apps import apps from django.db.migrations.recorder import MigrationRecorder from django.db.migrations.graph import MigrationGraph from django.utils import six @@ -46,7 +46,7 @@ class MigrationLoader(object): if app_label in settings.MIGRATION_MODULES: return settings.MIGRATION_MODULES[app_label] else: - return '%s.migrations' % app_cache.get_app_config(app_label).name + return '%s.migrations' % apps.get_app_config(app_label).name def load_disk(self): """ @@ -55,7 +55,7 @@ class MigrationLoader(object): self.disk_migrations = {} self.unmigrated_apps = set() self.migrated_apps = set() - for app_config in app_cache.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(only_with_models_module=True): # Get the migrations module directory module_name = self.migrations_module(app_config.label) was_loaded = module_name in sys.modules diff --git a/django/db/migrations/operations/models.py b/django/db/migrations/operations/models.py index 8c7fe126a8..1aefbd9457 100644 --- a/django/db/migrations/operations/models.py +++ b/django/db/migrations/operations/models.py @@ -20,14 +20,14 @@ class CreateModel(Operation): state.models[app_label, self.name.lower()] = ModelState(app_label, self.name, self.fields, self.options, self.bases) def database_forwards(self, app_label, schema_editor, from_state, to_state): - app_cache = to_state.render() - model = app_cache.get_model(app_label, self.name) + apps = to_state.render() + model = apps.get_model(app_label, self.name) if router.allow_migrate(schema_editor.connection.alias, model): schema_editor.create_model(model) def database_backwards(self, app_label, schema_editor, from_state, to_state): - app_cache = from_state.render() - model = app_cache.get_model(app_label, self.name) + apps = from_state.render() + model = apps.get_model(app_label, self.name) if router.allow_migrate(schema_editor.connection.alias, model): schema_editor.delete_model(model) @@ -73,14 +73,14 @@ class DeleteModel(Operation): del state.models[app_label, self.name.lower()] def database_forwards(self, app_label, schema_editor, from_state, to_state): - app_cache = from_state.render() - model = app_cache.get_model(app_label, self.name) + apps = from_state.render() + model = apps.get_model(app_label, self.name) if router.allow_migrate(schema_editor.connection.alias, model): schema_editor.delete_model(model) def database_backwards(self, app_label, schema_editor, from_state, to_state): - app_cache = to_state.render() - model = app_cache.get_model(app_label, self.name) + apps = to_state.render() + model = apps.get_model(app_label, self.name) if router.allow_migrate(schema_editor.connection.alias, model): schema_editor.create_model(model) @@ -106,10 +106,10 @@ class RenameModel(Operation): del state.models[app_label, self.old_name.lower()] def database_forwards(self, app_label, schema_editor, from_state, to_state): - old_app_cache = from_state.render() - new_app_cache = to_state.render() - old_model = old_app_cache.get_model(app_label, self.old_name) - new_model = new_app_cache.get_model(app_label, self.new_name) + old_apps = from_state.render() + new_apps = to_state.render() + old_model = old_apps.get_model(app_label, self.old_name) + new_model = new_apps.get_model(app_label, self.new_name) if router.allow_migrate(schema_editor.connection.alias, new_model): schema_editor.alter_db_table( new_model, @@ -118,10 +118,10 @@ class RenameModel(Operation): ) def database_backwards(self, app_label, schema_editor, from_state, to_state): - old_app_cache = from_state.render() - new_app_cache = to_state.render() - old_model = old_app_cache.get_model(app_label, self.new_name) - new_model = new_app_cache.get_model(app_label, self.old_name) + old_apps = from_state.render() + new_apps = to_state.render() + old_model = old_apps.get_model(app_label, self.new_name) + new_model = new_apps.get_model(app_label, self.old_name) if router.allow_migrate(schema_editor.connection.alias, new_model): schema_editor.alter_db_table( new_model, @@ -152,10 +152,10 @@ class AlterModelTable(Operation): state.models[app_label, self.name.lower()].options["db_table"] = self.table def database_forwards(self, app_label, schema_editor, from_state, to_state): - old_app_cache = from_state.render() - new_app_cache = to_state.render() - old_model = old_app_cache.get_model(app_label, self.name) - new_model = new_app_cache.get_model(app_label, self.name) + old_apps = from_state.render() + new_apps = to_state.render() + old_model = old_apps.get_model(app_label, self.name) + new_model = new_apps.get_model(app_label, self.name) if router.allow_migrate(schema_editor.connection.alias, new_model): schema_editor.alter_db_table( new_model, @@ -189,10 +189,10 @@ class AlterUniqueTogether(Operation): model_state.options["unique_together"] = self.unique_together def database_forwards(self, app_label, schema_editor, from_state, to_state): - old_app_cache = from_state.render() - new_app_cache = to_state.render() - old_model = old_app_cache.get_model(app_label, self.name) - new_model = new_app_cache.get_model(app_label, self.name) + old_apps = from_state.render() + new_apps = to_state.render() + old_model = old_apps.get_model(app_label, self.name) + new_model = new_apps.get_model(app_label, self.name) if router.allow_migrate(schema_editor.connection.alias, new_model): schema_editor.alter_unique_together( new_model, @@ -225,10 +225,10 @@ class AlterIndexTogether(Operation): model_state.options["index_together"] = self.index_together def database_forwards(self, app_label, schema_editor, from_state, to_state): - old_app_cache = from_state.render() - new_app_cache = to_state.render() - old_model = old_app_cache.get_model(app_label, self.name) - new_model = new_app_cache.get_model(app_label, self.name) + old_apps = from_state.render() + new_apps = to_state.render() + old_model = old_apps.get_model(app_label, self.name) + new_model = new_apps.get_model(app_label, self.name) if router.allow_migrate(schema_editor.connection.alias, new_model): schema_editor.alter_index_together( new_model, diff --git a/django/db/migrations/operations/special.py b/django/db/migrations/operations/special.py index f48d8cab05..65fd8125fc 100644 --- a/django/db/migrations/operations/special.py +++ b/django/db/migrations/operations/special.py @@ -134,7 +134,7 @@ class RunPython(Operation): def database_forwards(self, app_label, schema_editor, from_state, to_state): # We now execute the Python code in a context that contains a 'models' - # object, representing the versioned models as an AppCache. + # object, representing the versioned models as an app registry. # We could try to override the global cache, but then people will still # use direct imports, so we go with a documentation approach instead. if callable(self.code): diff --git a/django/db/migrations/questioner.py b/django/db/migrations/questioner.py index 4a860dcf7e..efd75189ef 100644 --- a/django/db/migrations/questioner.py +++ b/django/db/migrations/questioner.py @@ -2,7 +2,7 @@ import importlib import os import sys -from django.apps import app_cache +from django.apps import apps from django.utils import datetime_safe from django.utils.six.moves import input @@ -28,7 +28,7 @@ class MigrationQuestioner(object): # Apps from the new app template will have these; the python # file check will ensure we skip South ones. try: - app_config = app_cache.get_app_config(app_label) + app_config = apps.get_app_config(app_label) except LookupError: # It's a fake app. return self.defaults.get("ask_initial", False) migrations_import_path = "%s.migrations" % app_config.name diff --git a/django/db/migrations/recorder.py b/django/db/migrations/recorder.py index 8b0403e88f..15a3b49578 100644 --- a/django/db/migrations/recorder.py +++ b/django/db/migrations/recorder.py @@ -1,4 +1,4 @@ -from django.apps.cache import AppCache +from django.apps.registry import Apps from django.db import models from django.utils.timezone import now @@ -22,7 +22,7 @@ class MigrationRecorder(object): applied = models.DateTimeField(default=now) class Meta: - app_cache = AppCache() + apps = Apps() app_label = "migrations" db_table = "django_migrations" diff --git a/django/db/migrations/state.py b/django/db/migrations/state.py index a2716e864a..198b2c516c 100644 --- a/django/db/migrations/state.py +++ b/django/db/migrations/state.py @@ -1,4 +1,4 @@ -from django.apps.cache import AppCache +from django.apps.registry import Apps from django.db import models from django.db.models.options import DEFAULT_NAMES, normalize_unique_together from django.utils import six @@ -18,7 +18,7 @@ class ProjectState(object): def __init__(self, models=None): self.models = models or {} - self.app_cache = None + self.apps = None def add_model_state(self, model_state): self.models[(model_state.app_label, model_state.name.lower())] = model_state @@ -30,9 +30,9 @@ class ProjectState(object): ) def render(self): - "Turns the project state into actual models in a new AppCache" - if self.app_cache is None: - self.app_cache = AppCache() + "Turns the project state into actual models in a new Apps" + if self.apps is None: + self.apps = Apps() # We keep trying to render the models in a loop, ignoring invalid # base errors, until the size of the unrendered models doesn't # decrease by at least one, meaning there's a base dependency loop/ @@ -42,19 +42,19 @@ class ProjectState(object): new_unrendered_models = [] for model in unrendered_models: try: - model.render(self.app_cache) + model.render(self.apps) except InvalidBasesError: new_unrendered_models.append(model) if len(new_unrendered_models) == len(unrendered_models): raise InvalidBasesError("Cannot resolve bases for %r" % new_unrendered_models) unrendered_models = new_unrendered_models - return self.app_cache + return self.apps @classmethod - def from_app_cache(cls, app_cache): - "Takes in an AppCache and returns a ProjectState matching it" + def from_apps(cls, apps): + "Takes in an Apps and returns a ProjectState matching it" app_models = {} - for model in app_cache.get_models(): + for model in apps.get_models(): model_state = ModelState.from_model(model) app_models[(model_state.app_label, model_state.name.lower())] = model_state return cls(app_models) @@ -123,7 +123,7 @@ class ModelState(object): options = {} for name in DEFAULT_NAMES: # Ignore some special options - if name in ["app_cache", "app_label"]: + if name in ["apps", "app_label"]: continue elif name in model._meta.original_attrs: if name == "unique_together": @@ -164,17 +164,17 @@ class ModelState(object): bases=self.bases, ) - def render(self, app_cache): - "Creates a Model object from our current state into the given app_cache" + def render(self, apps): + "Creates a Model object from our current state into the given apps" # First, make a Meta object - meta_contents = {'app_label': self.app_label, "app_cache": app_cache} + meta_contents = {'app_label': self.app_label, "apps": apps} meta_contents.update(self.options) if "unique_together" in meta_contents: meta_contents["unique_together"] = list(meta_contents["unique_together"]) meta = type("Meta", tuple(), meta_contents) # Then, work out our bases bases = tuple( - (app_cache.get_model(*base.split(".", 1)) if isinstance(base, six.string_types) else base) + (apps.get_model(*base.split(".", 1)) if isinstance(base, six.string_types) else base) for base in self.bases ) if None in bases: diff --git a/django/db/migrations/writer.py b/django/db/migrations/writer.py index a23a9b1253..549c72ed60 100644 --- a/django/db/migrations/writer.py +++ b/django/db/migrations/writer.py @@ -5,7 +5,7 @@ from importlib import import_module import os import types -from django.apps import app_cache +from django.apps import apps from django.db import models from django.db.migrations.loader import MigrationLoader from django.utils.encoding import force_text @@ -69,7 +69,7 @@ class MigrationWriter(object): migrations_module = import_module(migrations_package_name) basedir = os.path.dirname(migrations_module.__file__) except ImportError: - app_config = app_cache.get_app_config(self.migration.app_label) + app_config = apps.get_app_config(self.migration.app_label) migrations_package_basename = migrations_package_name.split(".")[-1] # Alright, see if it's a direct submodule of the app diff --git a/django/db/models/base.py b/django/db/models/base.py index 85e4be870b..66c1d96762 100644 --- a/django/db/models/base.py +++ b/django/db/models/base.py @@ -5,7 +5,7 @@ import sys from functools import update_wrapper from django.utils.six.moves import zip -from django.apps import app_cache +from django.apps import apps from django.apps.base import MODELS_MODULE_NAME import django.db.models.manager # NOQA: Imported to register signal handler. from django.conf import settings @@ -151,7 +151,7 @@ class ModelBase(type): new_class._base_manager = new_class._base_manager._copy_to_model(new_class) # Bail out early if we have already created this class. - m = new_class._meta.app_cache.get_registered_model(new_class._meta.app_label, name) + m = new_class._meta.apps.get_registered_model(new_class._meta.app_label, name) if m is not None: return m @@ -273,12 +273,12 @@ class ModelBase(type): new_class._prepare() - new_class._meta.app_cache.register_model(new_class._meta.app_label, new_class) + new_class._meta.apps.register_model(new_class._meta.app_label, new_class) # Because of the way imports happen (recursively), we may or may not be # the first time this model tries to register with the framework. There # should only be one class for each model, so we always return the # registered version. - return new_class._meta.app_cache.get_registered_model(new_class._meta.app_label, name) + return new_class._meta.apps.get_registered_model(new_class._meta.app_label, name) def copy_managers(cls, base_managers): # This is in-place sorting of an Options attribute, but that's fine. @@ -1065,7 +1065,7 @@ def model_unpickle(model_id, attrs, factory): Used to unpickle Model subclasses with deferred fields. """ if isinstance(model_id, tuple): - model = app_cache.get_model(*model_id) + model = apps.get_model(*model_id) else: # Backwards compat - the model was cached directly in earlier versions. model = model_id diff --git a/django/db/models/fields/__init__.py b/django/db/models/fields/__init__.py index 830ff2efa2..6dcfd9ca70 100644 --- a/django/db/models/fields/__init__.py +++ b/django/db/models/fields/__init__.py @@ -9,7 +9,7 @@ import warnings from base64 import b64decode, b64encode from itertools import tee -from django.apps import app_cache +from django.apps import apps from django.db import connection from django.db.models.query_utils import QueryWrapper from django.conf import settings @@ -51,7 +51,7 @@ BLANK_CHOICE_DASH = [("", "---------")] def _load_field(app_label, model_name, field_name): - return app_cache.get_model(app_label, model_name)._meta.get_field_by_name(field_name)[0] + return apps.get_model(app_label, model_name)._meta.get_field_by_name(field_name)[0] class FieldDoesNotExist(Exception): @@ -287,7 +287,7 @@ class Field(object): def __reduce__(self): """ Pickling should return the model._meta.fields instance of the field, - not a new copy of that field. So, we use the app cache to load the + not a new copy of that field. So, we use the app registry to load the model and then the field back. """ if not hasattr(self, 'model'): @@ -298,8 +298,8 @@ class Field(object): # values - so, this is very close to normal pickle. return _empty, (self.__class__,), self.__dict__ if self.model._deferred: - # Deferred model will not be found from the app cache. This could - # be fixed by reconstructing the deferred model on unpickle. + # Deferred model will not be found from the app registry. This + # could be fixed by reconstructing the deferred model on unpickle. raise RuntimeError("Fields of deferred models can't be reduced") return _load_field, (self.model._meta.app_label, self.model._meta.object_name, self.name) diff --git a/django/db/models/fields/related.py b/django/db/models/fields/related.py index d6d84e1b23..769121bc01 100644 --- a/django/db/models/fields/related.py +++ b/django/db/models/fields/related.py @@ -68,13 +68,13 @@ def add_lazy_relation(cls, field, relation, operation): # string right away. If get_model returns None, it means that the related # model isn't loaded yet, so we need to pend the relation until the class # is prepared. - model = cls._meta.app_cache.get_registered_model(app_label, model_name) + model = cls._meta.apps.get_registered_model(app_label, model_name) if model: operation(field, model, cls) else: key = (app_label, model_name) value = (cls, field, operation) - cls._meta.app_cache._pending_lookups.setdefault(key, []).append(value) + cls._meta.apps._pending_lookups.setdefault(key, []).append(value) def do_pending_lookups(sender, **kwargs): @@ -82,7 +82,7 @@ def do_pending_lookups(sender, **kwargs): Handle any pending relations to the sending model. Sent from class_prepared. """ key = (sender._meta.app_label, sender.__name__) - for cls, field, operation in sender._meta.app_cache._pending_lookups.pop(key, []): + for cls, field, operation in sender._meta.apps._pending_lookups.pop(key, []): operation(field, sender, cls) signals.class_prepared.connect(do_pending_lookups) @@ -1493,7 +1493,7 @@ def create_many_to_many_intermediary_model(field, klass): 'unique_together': (from_, to), 'verbose_name': '%(from)s-%(to)s relationship' % {'from': from_, 'to': to}, 'verbose_name_plural': '%(from)s-%(to)s relationships' % {'from': from_, 'to': to}, - 'app_cache': field.model._meta.app_cache, + 'apps': field.model._meta.apps, }) # Construct and return the new class. return type(str(name), (models.Model,), { diff --git a/django/db/models/loading.py b/django/db/models/loading.py index 4b58ba00b5..42fcce8551 100644 --- a/django/db/models/loading.py +++ b/django/db/models/loading.py @@ -1,6 +1,6 @@ import warnings -from django.apps import app_cache +from django.apps import apps warnings.warn( "The utilities in django.db.models.loading are deprecated " @@ -12,24 +12,24 @@ __all__ = ('get_apps', 'get_app', 'get_models', 'get_model', 'register_models', # These methods were always module level, so are kept that way for backwards # compatibility. -get_apps = app_cache.get_apps -get_app_package = app_cache.get_app_package -get_app_path = app_cache.get_app_path -get_app_paths = app_cache.get_app_paths -get_app = app_cache.get_app -get_models = app_cache.get_models -get_model = app_cache.get_model -register_models = app_cache.register_models -load_app = app_cache.load_app -app_cache_ready = app_cache.app_cache_ready +get_apps = apps.get_apps +get_app_package = apps.get_app_package +get_app_path = apps.get_app_path +get_app_paths = apps.get_app_paths +get_app = apps.get_app +get_models = apps.get_models +get_model = apps.get_model +register_models = apps.register_models +load_app = apps.load_app +app_cache_ready = apps.ready # This method doesn't return anything interesting in Django 1.6. Maintain it # just for backwards compatibility until this module is deprecated. def get_app_errors(): try: - return app_cache.app_errors + return apps.app_errors except AttributeError: - app_cache.populate_models() - app_cache.app_errors = {} - return app_cache.app_errors + apps.populate_models() + apps.app_errors = {} + return apps.app_errors diff --git a/django/db/models/options.py b/django/db/models/options.py index 8f181c8854..1186d3b50a 100644 --- a/django/db/models/options.py +++ b/django/db/models/options.py @@ -5,7 +5,7 @@ import re from bisect import bisect import warnings -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.db.models.fields.related import ManyToManyRel from django.db.models.fields import AutoField, FieldDoesNotExist @@ -22,7 +22,7 @@ DEFAULT_NAMES = ('verbose_name', 'verbose_name_plural', 'db_table', 'ordering', 'unique_together', 'permissions', 'get_latest_by', 'order_with_respect_to', 'app_label', 'db_tablespace', 'abstract', 'managed', 'proxy', 'swappable', 'auto_created', - 'index_together', 'app_cache', 'default_permissions', + 'index_together', 'apps', 'default_permissions', 'select_on_save') @@ -88,13 +88,13 @@ class Options(object): # from *other* models. Needed for some admin checks. Internal use only. self.related_fkey_lookups = [] - # A custom AppCache to use, if you're making a separate model set. - self.app_cache = app_cache + # A custom app registry to use, if you're making a separate model set. + self.apps = apps @property def app_config(self): # Don't go through get_app_config to avoid triggering imports. - return self.app_cache.app_configs.get(self.app_label) + return self.apps.app_configs.get(self.app_label) @property def installed(self): @@ -440,7 +440,7 @@ class Options(object): if hasattr(f, 'related'): cache[f.name] = cache[f.attname] = ( f.related, None if f.model == self.model else f.model, True, False) - if app_cache.app_cache_ready(): + if apps.ready(): self._name_map = cache return cache @@ -516,7 +516,7 @@ class Options(object): cache[obj] = model # Collect also objects which are in relation to some proxy child/parent of self. proxy_cache = cache.copy() - for klass in self.app_cache.get_models(include_auto_created=True, only_installed=False): + for klass in self.apps.get_models(include_auto_created=True, only_installed=False): if not klass._meta.swapped: for f in klass._meta.local_fields: if f.rel and not isinstance(f.rel.to, six.string_types) and f.generate_reverse_relation: @@ -559,14 +559,14 @@ class Options(object): cache[obj] = parent else: cache[obj] = model - for klass in self.app_cache.get_models(only_installed=False): + for klass in self.apps.get_models(only_installed=False): if not klass._meta.swapped: for f in klass._meta.local_many_to_many: if (f.rel and not isinstance(f.rel.to, six.string_types) and self == f.rel.to._meta): cache[f.related] = None - if app_cache.app_cache_ready(): + if apps.ready(): self._related_many_to_many_cache = cache return cache diff --git a/django/db/models/query_utils.py b/django/db/models/query_utils.py index a7d98f60fe..2aa4856cf0 100644 --- a/django/db/models/query_utils.py +++ b/django/db/models/query_utils.py @@ -189,9 +189,9 @@ def deferred_class_factory(model, attrs): proxy = True app_label = model._meta.app_label - # The app_cache wants a unique name for each model, otherwise the new class - # won't be created (we get an old one back). Therefore, we generate the - # name using the passed in attrs. It's OK to reuse an existing class + # The app registry wants a unique name for each model, otherwise the new + # class won't be created (we get an old one back). Therefore, we generate + # the name using the passed in attrs. It's OK to reuse an existing class # object if the attrs are identical. name = "%s_Deferred_%s" % (model.__name__, '_'.join(sorted(list(attrs)))) name = utils.truncate_name(name, 80, 32) diff --git a/django/db/models/signals.py b/django/db/models/signals.py index 8c835e5f5f..10da3e22a5 100644 --- a/django/db/models/signals.py +++ b/django/db/models/signals.py @@ -1,6 +1,6 @@ from collections import defaultdict -from django.apps import app_cache +from django.apps import apps from django.dispatch import Signal from django.utils import six @@ -41,7 +41,7 @@ class ModelSignal(Signal): "Specified sender must either be a model or a " "model name of the 'app_label.ModelName' form." ) - sender = app_cache.get_model(app_label, object_name, only_installed=False) + sender = apps.get_model(app_label, object_name, only_installed=False) if sender is None: reference = (app_label, object_name) self.unresolved_references[reference].append( diff --git a/django/db/utils.py b/django/db/utils.py index 702b1b4ebc..85eabb934e 100644 --- a/django/db/utils.py +++ b/django/db/utils.py @@ -282,6 +282,6 @@ class ConnectionRouter(object): """ Return app models allowed to be synchronized on provided db. """ - from django.apps import app_cache - return [model for model in app_cache.get_models(app, include_auto_created=include_auto_created) + from django.apps import apps + return [model for model in apps.get_models(app, include_auto_created=include_auto_created) if self.allow_migrate(db, model)] diff --git a/django/template/base.py b/django/template/base.py index 197238b1e3..883609cf3e 100644 --- a/django/template/base.py +++ b/django/template/base.py @@ -5,7 +5,7 @@ from functools import partial from importlib import import_module from inspect import getargspec, getcallargs -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.template.context import (BaseContext, Context, RequestContext, # NOQA: imported for backwards compatibility ContextPopException) @@ -1306,7 +1306,7 @@ def get_templatetags_modules(): templatetags_modules_candidates = ['django.templatetags'] templatetags_modules_candidates += ['%s.templatetags' % app_config.name - for app_config in app_cache.get_app_configs()] + for app_config in apps.get_app_configs()] for templatetag_module in templatetags_modules_candidates: try: import_module(templatetag_module) diff --git a/django/template/loaders/app_directories.py b/django/template/loaders/app_directories.py index ff3d3b93f8..a2e741b419 100644 --- a/django/template/loaders/app_directories.py +++ b/django/template/loaders/app_directories.py @@ -6,7 +6,7 @@ packages. import os import sys -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.template.base import TemplateDoesNotExist from django.template.loader import BaseLoader @@ -17,7 +17,7 @@ from django.utils import six if six.PY2: fs_encoding = sys.getfilesystemencoding() or sys.getdefaultencoding() app_template_dirs = [] -for app_config in app_cache.get_app_configs(): +for app_config in apps.get_app_configs(): template_dir = os.path.join(app_config.path, 'templates') if os.path.isdir(template_dir): if six.PY2: diff --git a/django/template/loaders/eggs.py b/django/template/loaders/eggs.py index 99c19aed93..bb49b302c9 100644 --- a/django/template/loaders/eggs.py +++ b/django/template/loaders/eggs.py @@ -6,7 +6,7 @@ try: except ImportError: resource_string = None -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.template.base import TemplateDoesNotExist from django.template.loader import BaseLoader @@ -24,7 +24,7 @@ class Loader(BaseLoader): """ if resource_string is not None: pkg_name = 'templates/' + template_name - for app_config in app_cache.get_app_configs(): + for app_config in apps.get_app_configs(): try: resource = resource_string(app_config.name, pkg_name) except Exception: diff --git a/django/test/client.py b/django/test/client.py index eea9b43010..a2da8bcd38 100644 --- a/django/test/client.py +++ b/django/test/client.py @@ -8,7 +8,7 @@ from copy import copy from importlib import import_module from io import BytesIO -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.contrib.auth import authenticate, login, logout, get_user_model from django.core.handlers.base import BaseHandler @@ -390,7 +390,7 @@ class Client(RequestFactory): """ Obtains the current session variables. """ - if app_cache.has_app('django.contrib.sessions'): + if apps.has_app('django.contrib.sessions'): engine = import_module(settings.SESSION_ENGINE) cookie = self.cookies.get(settings.SESSION_COOKIE_NAME, None) if cookie: @@ -551,7 +551,7 @@ class Client(RequestFactory): """ user = authenticate(**credentials) if (user and user.is_active and - app_cache.has_app('django.contrib.sessions')): + apps.has_app('django.contrib.sessions')): engine = import_module(settings.SESSION_ENGINE) # Create a fake request that goes through request middleware diff --git a/django/test/simple.py b/django/test/simple.py index f2d26376df..fa70738447 100644 --- a/django/test/simple.py +++ b/django/test/simple.py @@ -9,7 +9,7 @@ import re import unittest as real_unittest import warnings -from django.apps import app_cache +from django.apps import apps from django.test import _doctest as doctest from django.test import runner from django.test.utils import compare_xml, strip_quotes @@ -168,7 +168,7 @@ def build_test(label): raise ValueError("Test label '%s' should be of the form app.TestCase " "or app.TestCase.test_method" % label) - app_config = app_cache.get_app_config(parts[0]) + app_config = apps.get_app_config(parts[0]) models_module = app_config.models_module tests_module = get_tests(app_config) @@ -237,10 +237,10 @@ class DjangoTestSuiteRunner(runner.DiscoverRunner): if '.' in label: suite.addTest(build_test(label)) else: - app_config = app_cache.get_app_config(label) + app_config = apps.get_app_config(label) suite.addTest(build_suite(app_config)) else: - for app_config in app_cache.get_app_configs(): + for app_config in apps.get_app_configs(): suite.addTest(build_suite(app_config)) if extra_tests: diff --git a/django/test/testcases.py b/django/test/testcases.py index 0e1bb78d46..056eb5469f 100644 --- a/django/test/testcases.py +++ b/django/test/testcases.py @@ -15,7 +15,7 @@ import unittest from unittest import skipIf # NOQA: Imported here for backward compatibility from unittest.util import safe_repr -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.core import mail from django.core.exceptions import ValidationError, ImproperlyConfigured @@ -732,13 +732,13 @@ class TransactionTestCase(SimpleTestCase): """Performs any pre-test setup. This includes: * If the class has an 'available_apps' attribute, restricting the app - cache to these applications, then firing post_migrate -- it must run - with the correct set of applications for the test case. + registry to these applications, then firing post_migrate -- it must + run with the correct set of applications for the test case. * If the class has a 'fixtures' attribute, installing these fixtures. """ super(TransactionTestCase, self)._pre_setup() if self.available_apps is not None: - app_cache.set_available_apps(self.available_apps) + apps.set_available_apps(self.available_apps) setting_changed.send(sender=settings._wrapped.__class__, setting='INSTALLED_APPS', value=self.available_apps, @@ -749,7 +749,7 @@ class TransactionTestCase(SimpleTestCase): self._fixture_setup() except Exception: if self.available_apps is not None: - app_cache.unset_available_apps() + apps.unset_available_apps() setting_changed.send(sender=settings._wrapped.__class__, setting='INSTALLED_APPS', value=settings.INSTALLED_APPS, @@ -809,7 +809,7 @@ class TransactionTestCase(SimpleTestCase): conn.close() finally: if self.available_apps is not None: - app_cache.unset_available_apps() + apps.unset_available_apps() setting_changed.send(sender=settings._wrapped.__class__, setting='INSTALLED_APPS', value=settings.INSTALLED_APPS, diff --git a/django/test/utils.py b/django/test/utils.py index 4453545dea..42cb127129 100644 --- a/django/test/utils.py +++ b/django/test/utils.py @@ -9,7 +9,7 @@ import warnings from functools import wraps from xml.dom.minidom import parseString, Node -from django.apps import app_cache +from django.apps import apps from django.conf import settings, UserSettingsHolder from django.core import mail from django.core.signals import request_started @@ -229,9 +229,9 @@ class override_settings(object): # in case it raises an exception because INSTALLED_APPS is invalid. if 'INSTALLED_APPS' in self.options: try: - app_cache.set_installed_apps(self.options['INSTALLED_APPS']) + apps.set_installed_apps(self.options['INSTALLED_APPS']) except Exception: - app_cache.unset_installed_apps() + apps.unset_installed_apps() raise override = UserSettingsHolder(settings._wrapped) for key, new_value in self.options.items(): @@ -244,7 +244,7 @@ class override_settings(object): def disable(self): if 'INSTALLED_APPS' in self.options: - app_cache.unset_installed_apps() + apps.unset_installed_apps() settings._wrapped = self.wrapped del self.wrapped for key in self.options: diff --git a/django/utils/autoreload.py b/django/utils/autoreload.py index b7a889aa61..94c74e582a 100644 --- a/django/utils/autoreload.py +++ b/django/utils/autoreload.py @@ -36,7 +36,7 @@ import sys import time import traceback -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.core.signals import request_finished try: @@ -90,7 +90,7 @@ def gen_filenames(): basedirs = [os.path.join(os.path.dirname(os.path.dirname(__file__)), 'conf', 'locale'), 'locale'] - for app_config in reversed(list(app_cache.get_app_configs())): + for app_config in reversed(list(apps.get_app_configs())): basedirs.append(os.path.join(app_config.path, 'locale')) basedirs.extend(settings.LOCALE_PATHS) basedirs = [os.path.abspath(basedir) for basedir in basedirs diff --git a/django/utils/module_loading.py b/django/utils/module_loading.py index c7826be5e5..1ed7d93e31 100644 --- a/django/utils/module_loading.py +++ b/django/utils/module_loading.py @@ -58,10 +58,10 @@ def autodiscover_modules(*args, **kwargs): registry. This register_to object must have a _registry instance variable to access it. """ - from django.apps import app_cache + from django.apps import apps register_to = kwargs.get('register_to') - for app_config in app_cache.get_app_configs(): + for app_config in apps.get_app_configs(): # Attempt to import the app's module. try: if register_to: diff --git a/django/utils/translation/trans_real.py b/django/utils/translation/trans_real.py index 1eced98d31..29c133006e 100644 --- a/django/utils/translation/trans_real.py +++ b/django/utils/translation/trans_real.py @@ -10,7 +10,7 @@ import gettext as gettext_module from threading import local import warnings -from django.apps import app_cache +from django.apps import apps from django.dispatch import receiver from django.test.signals import setting_changed from django.utils.encoding import force_str, force_text @@ -179,7 +179,7 @@ def translation(language): res.merge(t) return res - for app_config in reversed(list(app_cache.get_app_configs())): + for app_config in reversed(list(apps.get_app_configs())): apppath = os.path.join(app_config.path, 'locale') if os.path.isdir(apppath): res = _merge(apppath) diff --git a/django/views/i18n.py b/django/views/i18n.py index 2cc2e35e5e..7182f4f3cd 100644 --- a/django/views/i18n.py +++ b/django/views/i18n.py @@ -4,7 +4,7 @@ import os import gettext as gettext_module from django import http -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.template import Context, Template from django.utils.translation import check_for_language, to_locale, get_language @@ -188,7 +188,7 @@ def render_javascript_catalog(catalog=None, plural=None): def get_javascript_catalog(locale, domain, packages): default_locale = to_locale(settings.LANGUAGE_CODE) - app_configs = app_cache.get_app_configs() + app_configs = apps.get_app_configs() allowable_packages = set(app_config.name for app_config in app_configs) allowable_packages.add('django.conf') packages = [p for p in packages if p in allowable_packages] diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index ef2561a05d..29a68ff0c1 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -222,9 +222,7 @@ these changes. * ``django.core.cache.get_cache`` will be removed. Add suitable entries to :setting:`CACHES` and use :data:`django.core.cache.caches` instead. -* ``django.db.models.loading`` will be removed. Use the new application - loading APIs instead. Several undocumented methods of the ``AppCache`` class - will also be removed. +* ``django.db.models.loading`` will be removed. * Passing callable arguments to querysets will no longer be possible. diff --git a/tests/app_cache/tests.py b/tests/app_cache/tests.py deleted file mode 100644 index 43133ab38f..0000000000 --- a/tests/app_cache/tests.py +++ /dev/null @@ -1,51 +0,0 @@ -from __future__ import absolute_import - -from django.apps import app_cache -from django.apps.cache import AppCache -from django.db import models -from django.test import TestCase - -from .models import TotallyNormal, SoAlternative, new_app_cache - - -class AppCacheTests(TestCase): - - def test_models_py(self): - """ - Tests that the models in the models.py file were loaded correctly. - """ - self.assertEqual(app_cache.get_model("app_cache", "TotallyNormal"), TotallyNormal) - self.assertEqual(app_cache.get_model("app_cache", "SoAlternative"), None) - - self.assertEqual(new_app_cache.get_model("app_cache", "TotallyNormal"), None) - self.assertEqual(new_app_cache.get_model("app_cache", "SoAlternative"), SoAlternative) - - def test_dynamic_load(self): - """ - Makes a new model at runtime and ensures it goes into the right place. - """ - old_models = app_cache.get_models(app_cache.get_app_config("app_cache").models_module) - # Construct a new model in a new app cache - body = {} - new_app_cache = AppCache() - meta_contents = { - 'app_label': "app_cache", - 'app_cache': new_app_cache, - } - meta = type("Meta", tuple(), meta_contents) - body['Meta'] = meta - body['__module__'] = TotallyNormal.__module__ - temp_model = type("SouthPonies", (models.Model,), body) - # Make sure it appeared in the right place! - self.assertEqual( - old_models, - app_cache.get_models(app_cache.get_app_config("app_cache").models_module), - ) - self.assertEqual(new_app_cache.get_model("app_cache", "SouthPonies"), temp_model) - - def test_singleton_master(self): - """ - Ensures that only one master app cache can exist. - """ - with self.assertRaises(RuntimeError): - AppCache(master=True) diff --git a/tests/app_loading/tests.py b/tests/app_loading/tests.py index 291877108f..19a1d03d74 100644 --- a/tests/app_loading/tests.py +++ b/tests/app_loading/tests.py @@ -3,7 +3,7 @@ from __future__ import unicode_literals import os import sys -from django.apps import app_cache +from django.apps import apps from django.test import TestCase from django.utils._os import upath from django.utils import six @@ -17,11 +17,11 @@ class EggLoadingTest(TestCase): # The models need to be removed after the test in order to prevent bad # interactions with the flush operation in other tests. - self._old_models = app_cache.all_models['app_loading'].copy() + self._old_models = apps.all_models['app_loading'].copy() def tearDown(self): - app_cache.all_models['app_loading'] = self._old_models - app_cache.get_models.cache_clear() + apps.all_models['app_loading'] = self._old_models + apps.get_models.cache_clear() sys.path = self.old_path @@ -30,7 +30,7 @@ class EggLoadingTest(TestCase): egg_name = '%s/modelapp.egg' % self.egg_dir sys.path.append(egg_name) with self.settings(INSTALLED_APPS=['app_with_models']): - models_module = app_cache.get_app_config('app_with_models').models_module + models_module = apps.get_app_config('app_with_models').models_module self.assertIsNotNone(models_module) def test_egg2(self): @@ -38,7 +38,7 @@ class EggLoadingTest(TestCase): egg_name = '%s/nomodelapp.egg' % self.egg_dir sys.path.append(egg_name) with self.settings(INSTALLED_APPS=['app_no_models']): - models_module = app_cache.get_app_config('app_no_models').models_module + models_module = apps.get_app_config('app_no_models').models_module self.assertIsNone(models_module) def test_egg3(self): @@ -46,7 +46,7 @@ class EggLoadingTest(TestCase): egg_name = '%s/omelet.egg' % self.egg_dir sys.path.append(egg_name) with self.settings(INSTALLED_APPS=['omelet.app_with_models']): - models_module = app_cache.get_app_config('app_with_models').models_module + models_module = apps.get_app_config('app_with_models').models_module self.assertIsNotNone(models_module) def test_egg4(self): @@ -54,7 +54,7 @@ class EggLoadingTest(TestCase): egg_name = '%s/omelet.egg' % self.egg_dir sys.path.append(egg_name) with self.settings(INSTALLED_APPS=['omelet.app_no_models']): - models_module = app_cache.get_app_config('app_no_models').models_module + models_module = apps.get_app_config('app_no_models').models_module self.assertIsNone(models_module) def test_egg5(self): @@ -73,26 +73,26 @@ class GetModelsTest(TestCase): def test_get_model_only_returns_installed_models(self): self.assertEqual( - app_cache.get_model("not_installed", "NotInstalledModel"), None) + apps.get_model("not_installed", "NotInstalledModel"), None) def test_get_model_with_not_installed(self): self.assertEqual( - app_cache.get_model( + apps.get_model( "not_installed", "NotInstalledModel", only_installed=False), self.not_installed_module.NotInstalledModel) def test_get_models_only_returns_installed_models(self): self.assertNotIn( "NotInstalledModel", - [m.__name__ for m in app_cache.get_models()]) + [m.__name__ for m in apps.get_models()]) def test_get_models_with_app_label_only_returns_installed_models(self): - self.assertEqual(app_cache.get_models(self.not_installed_module), []) + self.assertEqual(apps.get_models(self.not_installed_module), []) def test_get_models_with_not_installed(self): self.assertIn( "NotInstalledModel", - [m.__name__ for m in app_cache.get_models(only_installed=False)]) + [m.__name__ for m in apps.get_models(only_installed=False)]) class NotInstalledModelsTest(TestCase): diff --git a/tests/app_cache/__init__.py b/tests/apps/__init__.py similarity index 100% rename from tests/app_cache/__init__.py rename to tests/apps/__init__.py diff --git a/tests/app_cache/models.py b/tests/apps/models.py similarity index 56% rename from tests/app_cache/models.py rename to tests/apps/models.py index 9306830f9c..c3f764a70b 100644 --- a/tests/app_cache/models.py +++ b/tests/apps/models.py @@ -1,9 +1,9 @@ -from django.apps.cache import AppCache +from django.apps.registry import Apps from django.db import models -# We're testing app cache presence on load, so this is handy. +# We're testing app registry presence on load, so this is handy. -new_app_cache = AppCache() +new_apps = Apps() class TotallyNormal(models.Model): @@ -14,4 +14,4 @@ class SoAlternative(models.Model): name = models.CharField(max_length=255) class Meta: - app_cache = new_app_cache + apps = new_apps diff --git a/tests/apps/tests.py b/tests/apps/tests.py new file mode 100644 index 0000000000..c38d16f8bb --- /dev/null +++ b/tests/apps/tests.py @@ -0,0 +1,51 @@ +from __future__ import absolute_import + +from django.apps import apps +from django.apps.registry import Apps +from django.db import models +from django.test import TestCase + +from .models import TotallyNormal, SoAlternative, new_apps + + +class AppsTests(TestCase): + + def test_models_py(self): + """ + Tests that the models in the models.py file were loaded correctly. + """ + self.assertEqual(apps.get_model("apps", "TotallyNormal"), TotallyNormal) + self.assertEqual(apps.get_model("apps", "SoAlternative"), None) + + self.assertEqual(new_apps.get_model("apps", "TotallyNormal"), None) + self.assertEqual(new_apps.get_model("apps", "SoAlternative"), SoAlternative) + + def test_dynamic_load(self): + """ + Makes a new model at runtime and ensures it goes into the right place. + """ + old_models = apps.get_models(apps.get_app_config("apps").models_module) + # Construct a new model in a new app registry + body = {} + new_apps = Apps() + meta_contents = { + 'app_label': "apps", + 'apps': new_apps, + } + meta = type("Meta", tuple(), meta_contents) + body['Meta'] = meta + body['__module__'] = TotallyNormal.__module__ + temp_model = type("SouthPonies", (models.Model,), body) + # Make sure it appeared in the right place! + self.assertEqual( + old_models, + apps.get_models(apps.get_app_config("apps").models_module), + ) + self.assertEqual(new_apps.get_model("apps", "SouthPonies"), temp_model) + + def test_singleton_master(self): + """ + Ensures that only one master registry can exist. + """ + with self.assertRaises(RuntimeError): + Apps(master=True) diff --git a/tests/base/models.py b/tests/base/models.py index 23efdf9d5b..f84d64df53 100644 --- a/tests/base/models.py +++ b/tests/base/models.py @@ -5,7 +5,7 @@ from django.utils import six # The models definitions below used to crash. Generating models dynamically -# at runtime is a bad idea because it pollutes the app cache. This doesn't +# at runtime is a bad idea because it pollutes the app registry. This doesn't # integrate well with the test suite but at least it prevents regressions. diff --git a/tests/bash_completion/tests.py b/tests/bash_completion/tests.py index 5a6a6c48d2..8653af3c85 100644 --- a/tests/bash_completion/tests.py +++ b/tests/bash_completion/tests.py @@ -5,7 +5,7 @@ import os import sys import unittest -from django.apps import app_cache +from django.apps import apps from django.core.management import ManagementUtility from django.utils.six import StringIO @@ -85,6 +85,6 @@ class BashCompletionTests(unittest.TestCase): self._user_input('django-admin.py sqlall a') output = self._run_autocomplete() a_labels = sorted(app_config.label - for app_config in app_cache.get_app_configs() + for app_config in apps.get_app_configs() if app_config.label.startswith('a')) self.assertEqual(output, a_labels) diff --git a/tests/commands_sql/tests.py b/tests/commands_sql/tests.py index 1c2a7f0ffa..00f4017b9c 100644 --- a/tests/commands_sql/tests.py +++ b/tests/commands_sql/tests.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals -from django.apps import app_cache +from django.apps import apps from django.core.management.color import no_style from django.core.management.sql import (sql_create, sql_delete, sql_indexes, sql_destroy_indexes, sql_all) @@ -17,7 +17,7 @@ class SQLCommandsTestCase(TestCase): return len([o for o in output if o.startswith(cmd)]) def test_sql_create(self): - app = app_cache.get_app_config('commands_sql').models_module + app = apps.get_app_config('commands_sql').models_module output = sql_create(app, no_style(), connections[DEFAULT_DB_ALIAS]) create_tables = [o for o in output if o.startswith('CREATE TABLE')] self.assertEqual(len(create_tables), 3) @@ -26,7 +26,7 @@ class SQLCommandsTestCase(TestCase): six.assertRegex(self, sql, r'^create table .commands_sql_book.*') def test_sql_delete(self): - app = app_cache.get_app_config('commands_sql').models_module + app = apps.get_app_config('commands_sql').models_module output = sql_delete(app, no_style(), connections[DEFAULT_DB_ALIAS]) drop_tables = [o for o in output if o.startswith('DROP TABLE')] self.assertEqual(len(drop_tables), 3) @@ -35,19 +35,19 @@ class SQLCommandsTestCase(TestCase): six.assertRegex(self, sql, r'^drop table .commands_sql_comment.*') def test_sql_indexes(self): - app = app_cache.get_app_config('commands_sql').models_module + app = apps.get_app_config('commands_sql').models_module output = sql_indexes(app, no_style(), connections[DEFAULT_DB_ALIAS]) # PostgreSQL creates one additional index for CharField self.assertIn(self.count_ddl(output, 'CREATE INDEX'), [3, 4]) def test_sql_destroy_indexes(self): - app = app_cache.get_app_config('commands_sql').models_module + app = apps.get_app_config('commands_sql').models_module output = sql_destroy_indexes(app, no_style(), connections[DEFAULT_DB_ALIAS]) # PostgreSQL creates one additional index for CharField self.assertIn(self.count_ddl(output, 'DROP INDEX'), [3, 4]) def test_sql_all(self): - app = app_cache.get_app_config('commands_sql').models_module + app = apps.get_app_config('commands_sql').models_module output = sql_all(app, no_style(), connections[DEFAULT_DB_ALIAS]) self.assertEqual(self.count_ddl(output, 'CREATE TABLE'), 3) @@ -69,7 +69,7 @@ class SQLCommandsRouterTestCase(TestCase): router.routers = self._old_routers def test_router_honored(self): - app = app_cache.get_app_config('commands_sql').models_module + app = apps.get_app_config('commands_sql').models_module for sql_command in (sql_all, sql_create, sql_delete, sql_indexes, sql_destroy_indexes): output = sql_command(app, no_style(), connections[DEFAULT_DB_ALIAS]) self.assertEqual(len(output), 0, diff --git a/tests/contenttypes_tests/tests.py b/tests/contenttypes_tests/tests.py index d3c19fd910..1f0af709cb 100644 --- a/tests/contenttypes_tests/tests.py +++ b/tests/contenttypes_tests/tests.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals -from django.apps.cache import AppCache +from django.apps.registry import Apps from django.contrib.contenttypes.models import ContentType from django.db import models from django.test import TestCase @@ -61,7 +61,7 @@ class ContentTypesViewsTests(TestCase): class Meta: verbose_name = 'a model created on the fly' app_label = 'my_great_app' - app_cache = AppCache() + apps = Apps() ct = ContentType.objects.get_for_model(ModelCreatedOnTheFly) self.assertEqual(ct.app_label, 'my_great_app') diff --git a/tests/defer_regress/tests.py b/tests/defer_regress/tests.py index b12b3b61b0..22c2d281da 100644 --- a/tests/defer_regress/tests.py +++ b/tests/defer_regress/tests.py @@ -2,7 +2,7 @@ from __future__ import unicode_literals from operator import attrgetter -from django.apps import app_cache +from django.apps import apps from django.contrib.contenttypes.models import ContentType from django.contrib.sessions.backends.db import SessionStore from django.db.models import Count @@ -102,7 +102,7 @@ class DeferRegressionTest(TestCase): klasses = set( map( attrgetter("__name__"), - app_cache.get_models(app_cache.get_app_config("defer_regress").models_module) + apps.get_models(apps.get_app_config("defer_regress").models_module) ) ) self.assertIn("Child", klasses) @@ -110,13 +110,13 @@ class DeferRegressionTest(TestCase): self.assertNotIn("Child_Deferred_value", klasses) self.assertNotIn("Item_Deferred_name", klasses) self.assertFalse(any( - k._deferred for k in app_cache.get_models(app_cache.get_app_config("defer_regress").models_module))) + k._deferred for k in apps.get_models(apps.get_app_config("defer_regress").models_module))) klasses_with_deferred = set( map( attrgetter("__name__"), - app_cache.get_models( - app_cache.get_app_config("defer_regress").models_module, include_deferred=True + apps.get_models( + apps.get_app_config("defer_regress").models_module, include_deferred=True ), ) ) @@ -125,8 +125,8 @@ class DeferRegressionTest(TestCase): self.assertIn("Child_Deferred_value", klasses_with_deferred) self.assertIn("Item_Deferred_name", klasses_with_deferred) self.assertTrue(any( - k._deferred for k in app_cache.get_models( - app_cache.get_app_config("defer_regress").models_module, include_deferred=True)) + k._deferred for k in apps.get_models( + apps.get_app_config("defer_regress").models_module, include_deferred=True)) ) @override_settings(SESSION_SERIALIZER='django.contrib.sessions.serializers.PickleSerializer') diff --git a/tests/invalid_models_tests/tests.py b/tests/invalid_models_tests/tests.py index 852e1dbb0d..2c98f39807 100644 --- a/tests/invalid_models_tests/tests.py +++ b/tests/invalid_models_tests/tests.py @@ -1,7 +1,7 @@ import sys import unittest -from django.apps import app_cache +from django.apps import apps from django.core.management.validation import get_validation_errors from django.test import override_settings from django.utils.six import StringIO @@ -32,7 +32,7 @@ class InvalidModelTestCase(unittest.TestCase): TEST_SWAPPED_MODEL_BAD_MODEL='not_an_app.Target', ) def test_invalid_models(self): - module = app_cache.get_app_config("invalid_models").models_module + module = apps.get_app_config("invalid_models").models_module get_validation_errors(self.stdout, module) self.stdout.seek(0) diff --git a/tests/managers_regress/tests.py b/tests/managers_regress/tests.py index bf8e5b17d4..8e0b4cd017 100644 --- a/tests/managers_regress/tests.py +++ b/tests/managers_regress/tests.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals -from django.apps import app_cache +from django.apps import apps from django.db import models from django.template import Context, Template from django.test import TestCase, override_settings @@ -110,7 +110,7 @@ class ManagersRegressionTests(TestCase): def test_swappable_manager(self): # The models need to be removed after the test in order to prevent bad # interactions with the flush operation in other tests. - _old_models = app_cache.app_configs['managers_regress'].models.copy() + _old_models = apps.app_configs['managers_regress'].models.copy() try: class SwappableModel(models.Model): @@ -126,15 +126,15 @@ class ManagersRegressionTests(TestCase): self.assertEqual(str(e), "Manager isn't available; SwappableModel has been swapped for 'managers_regress.Parent'") finally: - app_cache.app_configs['managers_regress'].models = _old_models - app_cache.all_models['managers_regress'] = _old_models - app_cache.get_models.cache_clear() + apps.app_configs['managers_regress'].models = _old_models + apps.all_models['managers_regress'] = _old_models + apps.get_models.cache_clear() @override_settings(TEST_SWAPPABLE_MODEL='managers_regress.Parent') def test_custom_swappable_manager(self): # The models need to be removed after the test in order to prevent bad # interactions with the flush operation in other tests. - _old_models = app_cache.app_configs['managers_regress'].models.copy() + _old_models = apps.app_configs['managers_regress'].models.copy() try: class SwappableModel(models.Model): @@ -154,15 +154,15 @@ class ManagersRegressionTests(TestCase): self.assertEqual(str(e), "Manager isn't available; SwappableModel has been swapped for 'managers_regress.Parent'") finally: - app_cache.app_configs['managers_regress'].models = _old_models - app_cache.all_models['managers_regress'] = _old_models - app_cache.get_models.cache_clear() + apps.app_configs['managers_regress'].models = _old_models + apps.all_models['managers_regress'] = _old_models + apps.get_models.cache_clear() @override_settings(TEST_SWAPPABLE_MODEL='managers_regress.Parent') def test_explicit_swappable_manager(self): # The models need to be removed after the test in order to prevent bad # interactions with the flush operation in other tests. - _old_models = app_cache.app_configs['managers_regress'].models.copy() + _old_models = apps.app_configs['managers_regress'].models.copy() try: class SwappableModel(models.Model): @@ -182,9 +182,9 @@ class ManagersRegressionTests(TestCase): self.assertEqual(str(e), "Manager isn't available; SwappableModel has been swapped for 'managers_regress.Parent'") finally: - app_cache.app_configs['managers_regress'].models = _old_models - app_cache.all_models['managers_regress'] = _old_models - app_cache.get_models.cache_clear() + apps.app_configs['managers_regress'].models = _old_models + apps.all_models['managers_regress'] = _old_models + apps.get_models.cache_clear() def test_regress_3871(self): related = RelatedModel.objects.create() diff --git a/tests/migrations/models.py b/tests/migrations/models.py index b1ef6c1dd1..f76a84054f 100644 --- a/tests/migrations/models.py +++ b/tests/migrations/models.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- from __future__ import unicode_literals -from django.apps.cache import AppCache +from django.apps.registry import Apps from django.db import models from django.utils.encoding import python_2_unicode_compatible @@ -12,7 +12,7 @@ class UnicodeModel(models.Model): class Meta: # Disable auto loading of this model as we load it on our own - app_cache = AppCache() + apps = Apps() verbose_name = 'úñí©óðé µóðéø' verbose_name_plural = 'úñí©óðé µóðéøß' @@ -32,4 +32,4 @@ class UnserializableModel(models.Model): class Meta: # Disable auto loading of this model as we load it on our own - app_cache = AppCache() + apps = Apps() diff --git a/tests/migrations/test_commands.py b/tests/migrations/test_commands.py index 9fa9be6cbf..3219a62f5a 100644 --- a/tests/migrations/test_commands.py +++ b/tests/migrations/test_commands.py @@ -5,7 +5,7 @@ import codecs import os import shutil -from django.apps import app_cache +from django.apps import apps from django.core.management import call_command, CommandError from django.test import override_settings from django.utils import six @@ -131,12 +131,12 @@ class MakeMigrationsTests(MigrationTestBase): self.test_dir = os.path.abspath(os.path.dirname(upath(__file__))) self.migration_dir = os.path.join(self.test_dir, 'migrations_%d' % self.creation_counter) self.migration_pkg = "migrations.migrations_%d" % self.creation_counter - self._old_models = app_cache.app_configs['migrations'].models.copy() + self._old_models = apps.app_configs['migrations'].models.copy() def tearDown(self): - app_cache.app_configs['migrations'].models = self._old_models - app_cache.all_models['migrations'] = self._old_models - app_cache.get_models.cache_clear() + apps.app_configs['migrations'].models = self._old_models + apps.all_models['migrations'] = self._old_models + apps.get_models.cache_clear() os.chdir(self.test_dir) try: @@ -152,7 +152,7 @@ class MakeMigrationsTests(MigrationTestBase): def test_files_content(self): self.assertTableNotExists("migrations_unicodemodel") - app_cache.register_model('migrations', UnicodeModel) + apps.register_model('migrations', UnicodeModel) with override_settings(MIGRATION_MODULES={"migrations": self.migration_pkg}): call_command("makemigrations", "migrations", verbosity=0) @@ -188,7 +188,7 @@ class MakeMigrationsTests(MigrationTestBase): def test_failing_migration(self): #21280 - If a migration fails to serialize, it shouldn't generate an empty file. - app_cache.register_model('migrations', UnserializableModel) + apps.register_model('migrations', UnserializableModel) with six.assertRaisesRegex(self, ValueError, r'Cannot serialize'): with override_settings(MIGRATION_MODULES={"migrations": self.migration_pkg}): diff --git a/tests/migrations/test_loader.py b/tests/migrations/test_loader.py index 4f0b463f99..7b9ce72aab 100644 --- a/tests/migrations/test_loader.py +++ b/tests/migrations/test_loader.py @@ -43,7 +43,7 @@ class LoaderTests(TestCase): def test_load(self): """ Makes sure the loader can load the migrations for the test apps, - and then render them out to a new AppCache. + and then render them out to a new Apps. """ # Load and test the plan migration_loader = MigrationLoader(connection) diff --git a/tests/migrations/test_operations.py b/tests/migrations/test_operations.py index 0ce030a66c..d11fda23c8 100644 --- a/tests/migrations/test_operations.py +++ b/tests/migrations/test_operations.py @@ -203,8 +203,8 @@ class OperationTests(MigrationTestBase): self.assertColumnNotExists("test_adflmm_pony", "stables") # Make sure the M2M field actually works with atomic(): - new_app_cache = new_state.render() - Pony = new_app_cache.get_model("test_adflmm", "Pony") + new_apps = new_state.render() + Pony = new_apps.get_model("test_adflmm", "Pony") p = Pony.objects.create(pink=False, weight=4.55) p.stables.create() self.assertEqual(p.stables.count(), 1) diff --git a/tests/migrations/test_state.py b/tests/migrations/test_state.py index e695248cd2..b7af48fede 100644 --- a/tests/migrations/test_state.py +++ b/tests/migrations/test_state.py @@ -1,4 +1,4 @@ -from django.apps.cache import AppCache +from django.apps.registry import Apps from django.db import models from django.db.migrations.state import ProjectState, ModelState, InvalidBasesError from django.test import TestCase @@ -11,10 +11,10 @@ class StateTests(TestCase): def test_create(self): """ - Tests making a ProjectState from an AppCache + Tests making a ProjectState from an Apps """ - new_app_cache = AppCache() + new_apps = Apps() class Author(models.Model): name = models.CharField(max_length=255) @@ -23,13 +23,13 @@ class StateTests(TestCase): class Meta: app_label = "migrations" - app_cache = new_app_cache + apps = new_apps unique_together = ["name", "bio"] class AuthorProxy(Author): class Meta: app_label = "migrations" - app_cache = new_app_cache + apps = new_apps proxy = True ordering = ["name"] @@ -40,11 +40,11 @@ class StateTests(TestCase): class Meta: app_label = "migrations" - app_cache = new_app_cache + apps = new_apps verbose_name = "tome" db_table = "test_tome" - project_state = ProjectState.from_app_cache(new_app_cache) + project_state = ProjectState.from_apps(new_apps) author_state = project_state.models['migrations', 'author'] author_proxy_state = project_state.models['migrations', 'authorproxy'] book_state = project_state.models['migrations', 'book'] @@ -75,7 +75,7 @@ class StateTests(TestCase): def test_render(self): """ - Tests rendering a ProjectState into an AppCache. + Tests rendering a ProjectState into an Apps. """ project_state = ProjectState() project_state.add_model_state(ModelState( @@ -90,9 +90,9 @@ class StateTests(TestCase): None, )) - new_app_cache = project_state.render() - self.assertEqual(new_app_cache.get_model("migrations", "Tag")._meta.get_field_by_name("name")[0].max_length, 100) - self.assertEqual(new_app_cache.get_model("migrations", "Tag")._meta.get_field_by_name("hidden")[0].null, False) + new_apps = project_state.render() + self.assertEqual(new_apps.get_model("migrations", "Tag")._meta.get_field_by_name("name")[0].max_length, 100) + self.assertEqual(new_apps.get_model("migrations", "Tag")._meta.get_field_by_name("hidden")[0].null, False) def test_render_model_inheritance(self): class Book(models.Model): @@ -100,90 +100,90 @@ class StateTests(TestCase): class Meta: app_label = "migrations" - app_cache = AppCache() + apps = Apps() class Novel(Book): class Meta: app_label = "migrations" - app_cache = AppCache() + apps = Apps() # First, test rendering individually - app_cache = AppCache() + apps = Apps() # We shouldn't be able to render yet ms = ModelState.from_model(Novel) with self.assertRaises(InvalidBasesError): - ms.render(app_cache) + ms.render(apps) - # Once the parent model is in the app cache, it should be fine - ModelState.from_model(Book).render(app_cache) - ModelState.from_model(Novel).render(app_cache) + # Once the parent model is in the app registry, it should be fine + ModelState.from_model(Book).render(apps) + ModelState.from_model(Novel).render(apps) def test_render_model_with_multiple_inheritance(self): class Foo(models.Model): class Meta: app_label = "migrations" - app_cache = AppCache() + apps = Apps() class Bar(models.Model): class Meta: app_label = "migrations" - app_cache = AppCache() + apps = Apps() class FooBar(Foo, Bar): class Meta: app_label = "migrations" - app_cache = AppCache() + apps = Apps() - app_cache = AppCache() + apps = Apps() # We shouldn't be able to render yet ms = ModelState.from_model(FooBar) with self.assertRaises(InvalidBasesError): - ms.render(app_cache) + ms.render(apps) - # Once the parent models are in the app cache, it should be fine - ModelState.from_model(Foo).render(app_cache) - ModelState.from_model(Bar).render(app_cache) - ModelState.from_model(FooBar).render(app_cache) + # Once the parent models are in the app registry, it should be fine + ModelState.from_model(Foo).render(apps) + ModelState.from_model(Bar).render(apps) + ModelState.from_model(FooBar).render(apps) def test_render_project_dependencies(self): """ Tests that the ProjectState render method correctly renders models to account for inter-model base dependencies. """ - new_app_cache = AppCache() + new_apps = Apps() class A(models.Model): class Meta: app_label = "migrations" - app_cache = new_app_cache + apps = new_apps class B(A): class Meta: app_label = "migrations" - app_cache = new_app_cache + apps = new_apps class C(B): class Meta: app_label = "migrations" - app_cache = new_app_cache + apps = new_apps class D(A): class Meta: app_label = "migrations" - app_cache = new_app_cache + apps = new_apps class E(B): class Meta: app_label = "migrations" - app_cache = new_app_cache + apps = new_apps proxy = True class F(D): class Meta: app_label = "migrations" - app_cache = new_app_cache + apps = new_apps proxy = True # Make a ProjectState and render it @@ -194,8 +194,8 @@ class StateTests(TestCase): project_state.add_model_state(ModelState.from_model(D)) project_state.add_model_state(ModelState.from_model(E)) project_state.add_model_state(ModelState.from_model(F)) - final_app_cache = project_state.render() - self.assertEqual(len(final_app_cache.get_models()), 6) + final_apps = project_state.render() + self.assertEqual(len(final_apps.get_models()), 6) # Now make an invalid ProjectState and make sure it fails project_state = ProjectState() diff --git a/tests/no_models/tests.py b/tests/no_models/tests.py index f9ff80485e..bd17364071 100644 --- a/tests/no_models/tests.py +++ b/tests/no_models/tests.py @@ -1,4 +1,4 @@ -from django.apps import app_cache +from django.apps import apps from django.test import TestCase @@ -6,5 +6,5 @@ class NoModelTests(TestCase): def test_no_models(self): """Test that it's possible to load an app with no models.py file.""" - app_config = app_cache.get_app_config('no_models') + app_config = apps.get_app_config('no_models') self.assertIsNone(app_config.models_module) diff --git a/tests/proxy_models/tests.py b/tests/proxy_models/tests.py index 4a3d6e5e5a..fe294aeb1e 100644 --- a/tests/proxy_models/tests.py +++ b/tests/proxy_models/tests.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals -from django.apps import app_cache +from django.apps import apps from django.contrib import admin from django.contrib.contenttypes.models import ContentType from django.core import management @@ -155,7 +155,7 @@ class ProxyModelTests(TestCase): def test_swappable(self): # The models need to be removed after the test in order to prevent bad # interactions with the flush operation in other tests. - _old_models = app_cache.app_configs['proxy_models'].models.copy() + _old_models = apps.app_configs['proxy_models'].models.copy() try: class SwappableModel(models.Model): @@ -173,9 +173,9 @@ class ProxyModelTests(TestCase): class Meta: proxy = True finally: - app_cache.app_configs['proxy_models'].models = _old_models - app_cache.all_models['proxy_models'] = _old_models - app_cache.get_models.cache_clear() + apps.app_configs['proxy_models'].models = _old_models + apps.all_models['proxy_models'] = _old_models + apps.get_models.cache_clear() def test_myperson_manager(self): Person.objects.create(name="fred") diff --git a/tests/runtests.py b/tests/runtests.py index ab6f778a81..5f39eef400 100755 --- a/tests/runtests.py +++ b/tests/runtests.py @@ -80,13 +80,13 @@ def get_test_modules(): def get_installed(): - from django.apps import app_cache - return [app_config.name for app_config in app_cache.get_app_configs()] + from django.apps import apps + return [app_config.name for app_config in apps.get_app_configs()] def setup(verbosity, test_labels): import django - from django.apps import app_cache, AppConfig + from django.apps import apps, AppConfig from django.conf import settings from django.test import TransactionTestCase, TestCase @@ -128,7 +128,7 @@ def setup(verbosity, test_labels): # Load all the ALWAYS_INSTALLED_APPS. with warnings.catch_warnings(): warnings.filterwarnings('ignore', 'django.contrib.comments is deprecated and will be removed before Django 1.8.', DeprecationWarning) - app_cache.populate_models() + apps.populate_models() # Load all the test model apps. test_modules = get_test_modules() @@ -168,9 +168,9 @@ def setup(verbosity, test_labels): if module_label not in settings.INSTALLED_APPS: settings.INSTALLED_APPS.append(module_label) app_config = AppConfig.create(module_label) - app_config.import_models(app_cache.all_models[app_config.label]) - app_cache.app_configs[app_config.label] = app_config - app_cache.get_models.cache_clear() + app_config.import_models(apps.all_models[app_config.label]) + apps.app_configs[app_config.label] = app_config + apps.get_models.cache_clear() return state diff --git a/tests/schema/models.py b/tests/schema/models.py index b294647f9b..44fecf7ebd 100644 --- a/tests/schema/models.py +++ b/tests/schema/models.py @@ -1,11 +1,11 @@ -from django.apps.cache import AppCache +from django.apps.registry import Apps from django.db import models # Because we want to test creation and deletion of these as separate things, -# these models are all inserted into a separate AppCache so the main test +# these models are all inserted into a separate Apps so the main test # runner doesn't migrate them. -new_app_cache = AppCache() +new_apps = Apps() class Author(models.Model): @@ -13,14 +13,14 @@ class Author(models.Model): height = models.PositiveIntegerField(null=True, blank=True) class Meta: - app_cache = new_app_cache + apps = new_apps class AuthorWithM2M(models.Model): name = models.CharField(max_length=255) class Meta: - app_cache = new_app_cache + apps = new_apps class Book(models.Model): @@ -30,7 +30,7 @@ class Book(models.Model): # tags = models.ManyToManyField("Tag", related_name="books") class Meta: - app_cache = new_app_cache + apps = new_apps class BookWithM2M(models.Model): @@ -40,7 +40,7 @@ class BookWithM2M(models.Model): tags = models.ManyToManyField("TagM2MTest", related_name="books") class Meta: - app_cache = new_app_cache + apps = new_apps class BookWithSlug(models.Model): @@ -50,7 +50,7 @@ class BookWithSlug(models.Model): slug = models.CharField(max_length=20, unique=True) class Meta: - app_cache = new_app_cache + apps = new_apps db_table = "schema_book" @@ -59,7 +59,7 @@ class Tag(models.Model): slug = models.SlugField(unique=True) class Meta: - app_cache = new_app_cache + apps = new_apps class TagM2MTest(models.Model): @@ -67,7 +67,7 @@ class TagM2MTest(models.Model): slug = models.SlugField(unique=True) class Meta: - app_cache = new_app_cache + apps = new_apps class TagIndexed(models.Model): @@ -75,7 +75,7 @@ class TagIndexed(models.Model): slug = models.SlugField(unique=True) class Meta: - app_cache = new_app_cache + apps = new_apps index_together = [["slug", "title"]] @@ -84,7 +84,7 @@ class TagUniqueRename(models.Model): slug2 = models.SlugField(unique=True) class Meta: - app_cache = new_app_cache + apps = new_apps db_table = "schema_tag" @@ -93,7 +93,7 @@ class UniqueTest(models.Model): slug = models.SlugField(unique=False) class Meta: - app_cache = new_app_cache + apps = new_apps unique_together = ["year", "slug"] @@ -101,4 +101,4 @@ class BookWithLongName(models.Model): author_foreign_key_with_really_long_field_name = models.ForeignKey(Author) class Meta: - app_cache = new_app_cache + apps = new_apps diff --git a/tests/swappable_models/tests.py b/tests/swappable_models/tests.py index c703a99fcb..3bf5b46d66 100644 --- a/tests/swappable_models/tests.py +++ b/tests/swappable_models/tests.py @@ -2,7 +2,7 @@ from __future__ import unicode_literals from django.utils.six import StringIO -from django.apps import app_cache +from django.apps import apps from django.contrib.auth.models import Permission from django.contrib.contenttypes.models import ContentType from django.core import management diff --git a/tests/tablespaces/tests.py b/tests/tablespaces/tests.py index fdee877a9f..5e22608551 100644 --- a/tests/tablespaces/tests.py +++ b/tests/tablespaces/tests.py @@ -1,6 +1,6 @@ from __future__ import unicode_literals -from django.apps import app_cache +from django.apps import apps from django.conf import settings from django.db import connection from django.core.management.color import no_style @@ -26,7 +26,7 @@ class TablespacesTests(TestCase): def setUp(self): # The unmanaged models need to be removed after the test in order to # prevent bad interactions with the flush operation in other tests. - self._old_models = app_cache.app_configs['tablespaces'].models.copy() + self._old_models = apps.app_configs['tablespaces'].models.copy() for model in Article, Authors, Reviewers, Scientist: model._meta.managed = True @@ -35,9 +35,9 @@ class TablespacesTests(TestCase): for model in Article, Authors, Reviewers, Scientist: model._meta.managed = False - app_cache.app_configs['tablespaces'].models = self._old_models - app_cache.all_models['tablespaces'] = self._old_models - app_cache.get_models.cache_clear() + apps.app_configs['tablespaces'].models = self._old_models + apps.all_models['tablespaces'] = self._old_models + apps.get_models.cache_clear() def assertNumContains(self, haystack, needle, count): real_count = haystack.count(needle) diff --git a/tests/test_suite_override/tests.py b/tests/test_suite_override/tests.py index 9666df1c19..c485b801bc 100644 --- a/tests/test_suite_override/tests.py +++ b/tests/test_suite_override/tests.py @@ -1,6 +1,6 @@ import unittest -from django.apps import app_cache +from django.apps import apps from django.test.utils import IgnoreAllDeprecationWarningsMixin @@ -20,7 +20,7 @@ class SuiteOverrideTest(IgnoreAllDeprecationWarningsMixin, unittest.TestCase): """ from django.test.simple import build_suite - app_config = app_cache.get_app_config("test_suite_override") + app_config = apps.get_app_config("test_suite_override") suite = build_suite(app_config) self.assertEqual(suite.countTestCases(), 1) diff --git a/tests/validation/test_unique.py b/tests/validation/test_unique.py index be7808f460..76c7ec174f 100644 --- a/tests/validation/test_unique.py +++ b/tests/validation/test_unique.py @@ -3,7 +3,7 @@ from __future__ import unicode_literals import datetime import unittest -from django.apps.cache import AppCache +from django.apps.registry import Apps from django.core.exceptions import ValidationError from django.db import models from django.test import TestCase @@ -58,7 +58,7 @@ class GetUniqueCheckTests(unittest.TestCase): Meta = type(str('Meta'), (), { 'unique_together': unique_together, - 'app_cache': AppCache() + 'apps': Apps() }) checks, _ = M()._get_unique_checks() From 542198c1d059b3ecf64477c1c10c0518d229345b Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Tue, 24 Dec 2013 15:19:25 +0100 Subject: [PATCH 042/208] Fixed #21662 -- Kept parent reference in prepared geometry Thanks Robert Scott for the report. --- django/contrib/gis/geos/prepared.py | 4 ++++ django/contrib/gis/geos/tests/test_geos.py | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/django/contrib/gis/geos/prepared.py b/django/contrib/gis/geos/prepared.py index a6a205da5e..d5b531bb43 100644 --- a/django/contrib/gis/geos/prepared.py +++ b/django/contrib/gis/geos/prepared.py @@ -12,6 +12,10 @@ class PreparedGeometry(GEOSBase): ptr_type = capi.PREPGEOM_PTR def __init__(self, geom): + # Keeping a reference to the original geometry object to prevent it + # from being garbage collected which could then crash the prepared one + # See #21662 + self._base_geom = geom if not isinstance(geom, GEOSGeometry): raise TypeError self.ptr = capi.geos_prepare(geom.ptr) diff --git a/django/contrib/gis/geos/tests/test_geos.py b/django/contrib/gis/geos/tests/test_geos.py index 3f0ce0652b..9ce7e0d73d 100644 --- a/django/contrib/gis/geos/tests/test_geos.py +++ b/django/contrib/gis/geos/tests/test_geos.py @@ -1046,6 +1046,10 @@ class GEOSTest(unittest.TestCase, TestDataMixin): self.assertEqual(mpoly.intersects(pnt), prep.intersects(pnt)) self.assertEqual(c, prep.covers(pnt)) + # Original geometry deletion should not crash the prepared one (#21662) + del mpoly + self.assertTrue(prep.covers(Point(5, 5))) + def test_line_merge(self): "Testing line merge support" ref_geoms = (fromstr('LINESTRING(1 1, 1 1, 3 3)'), From d17404aa90cf0a439828e7f14105f3f522ab3bcc Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Tue, 24 Dec 2013 15:57:13 +0100 Subject: [PATCH 043/208] Dropped support for GEOS < 3.1 --- django/contrib/gis/geos/__init__.py | 4 +- django/contrib/gis/geos/collections.py | 8 +--- django/contrib/gis/geos/geometry.py | 39 +++++++------------ django/contrib/gis/geos/libgeos.py | 24 +++--------- django/contrib/gis/geos/prototypes/misc.py | 16 +++----- .../contrib/gis/geos/prototypes/topology.py | 22 +++++------ django/contrib/gis/geos/tests/test_geos.py | 31 ++++----------- docs/ref/contrib/gis/geos.txt | 20 ---------- docs/ref/contrib/gis/install/geolibs.txt | 3 +- docs/ref/contrib/gis/model-api.txt | 3 +- docs/releases/1.7.txt | 2 + 11 files changed, 51 insertions(+), 121 deletions(-) diff --git a/django/contrib/gis/geos/__init__.py b/django/contrib/gis/geos/__init__.py index 70b73fad8b..d5fe479dae 100644 --- a/django/contrib/gis/geos/__init__.py +++ b/django/contrib/gis/geos/__init__.py @@ -6,9 +6,9 @@ for more details: __all__ = ['HAS_GEOS'] try: - from .libgeos import geos_version, geos_version_info, GEOS_PREPARE # NOQA: flake8 detects only the last __all__ + from .libgeos import geos_version, geos_version_info # NOQA: flake8 detects only the last __all__ HAS_GEOS = True - __all__ += ['geos_version', 'geos_version_info', 'GEOS_PREPARE'] + __all__ += ['geos_version', 'geos_version_info'] except ImportError: HAS_GEOS = False diff --git a/django/contrib/gis/geos/collections.py b/django/contrib/gis/geos/collections.py index 426cf3833d..483cb6f405 100644 --- a/django/contrib/gis/geos/collections.py +++ b/django/contrib/gis/geos/collections.py @@ -3,9 +3,8 @@ GeometryCollection, MultiPoint, MultiLineString, and MultiPolygon """ from ctypes import c_int, c_uint, byref -from django.contrib.gis.geos.error import GEOSException from django.contrib.gis.geos.geometry import GEOSGeometry -from django.contrib.gis.geos.libgeos import get_pointer_arr, GEOS_PREPARE +from django.contrib.gis.geos.libgeos import get_pointer_arr from django.contrib.gis.geos.linestring import LineString, LinearRing from django.contrib.gis.geos.point import Point from django.contrib.gis.geos.polygon import Polygon @@ -119,10 +118,7 @@ class MultiPolygon(GeometryCollection): @property def cascaded_union(self): "Returns a cascaded union of this MultiPolygon." - if GEOS_PREPARE: - return GEOSGeometry(capi.geos_cascaded_union(self.ptr), self.srid) - else: - raise GEOSException('The cascaded union operation requires GEOS 3.1+.') + return GEOSGeometry(capi.geos_cascaded_union(self.ptr), self.srid) # Setting the allowed types here since GeometryCollection is defined before # its subclasses. diff --git a/django/contrib/gis/geos/geometry.py b/django/contrib/gis/geos/geometry.py index 073415abea..f453f113f7 100644 --- a/django/contrib/gis/geos/geometry.py +++ b/django/contrib/gis/geos/geometry.py @@ -17,7 +17,7 @@ from django.contrib.gis.gdal.error import SRSException from django.contrib.gis.geos.base import GEOSBase, gdal from django.contrib.gis.geos.coordseq import GEOSCoordSeq from django.contrib.gis.geos.error import GEOSException, GEOSIndexError -from django.contrib.gis.geos.libgeos import GEOM_PTR, GEOS_PREPARE +from django.contrib.gis.geos.libgeos import GEOM_PTR # All other functions in this module come from the ctypes # prototypes module -- which handles all interaction with @@ -289,8 +289,6 @@ class GEOSGeometry(GEOSBase, ListMixin): """ Returns a string containing the reason for any invalidity. """ - if not GEOS_PREPARE: - raise GEOSException('Upgrade GEOS to 3.1 to get validity reason.') return capi.geos_isvalidreason(self.ptr).decode() #### Binary predicates. #### @@ -411,9 +409,6 @@ class GEOSGeometry(GEOSBase, ListMixin): extension of the WKB specification that includes SRID value that are a part of this geometry. """ - if self.hasz and not GEOS_PREPARE: - # See: http://trac.osgeo.org/geos/ticket/216 - raise GEOSException('Upgrade GEOS to 3.1 to get valid 3D HEXEWKB.') return ewkb_w(3 if self.hasz else 2).write_hex(self) @property @@ -443,9 +438,6 @@ class GEOSGeometry(GEOSBase, ListMixin): This is an extension of the WKB specification that includes any SRID value that are a part of this geometry. """ - if self.hasz and not GEOS_PREPARE: - # See: http://trac.osgeo.org/geos/ticket/216 - raise GEOSException('Upgrade GEOS to 3.1 to get valid 3D EWKB.') return ewkb_w(3 if self.hasz else 2).write(self) @property @@ -460,10 +452,7 @@ class GEOSGeometry(GEOSBase, ListMixin): Returns a PreparedGeometry corresponding to this geometry -- it is optimized for the contains, intersects, and covers operations. """ - if GEOS_PREPARE: - return PreparedGeometry(self) - else: - raise GEOSException('GEOS 3.1+ required for prepared geometry support.') + return PreparedGeometry(self) #### GDAL-specific output routines #### @property @@ -707,16 +696,14 @@ from django.contrib.gis.geos.linestring import LineString, LinearRing from django.contrib.gis.geos.point import Point from django.contrib.gis.geos.polygon import Polygon from django.contrib.gis.geos.collections import GeometryCollection, MultiPoint, MultiLineString, MultiPolygon -GEOS_CLASSES = {0: Point, - 1: LineString, - 2: LinearRing, - 3: Polygon, - 4: MultiPoint, - 5: MultiLineString, - 6: MultiPolygon, - 7: GeometryCollection, - } - -# If supported, import the PreparedGeometry class. -if GEOS_PREPARE: - from django.contrib.gis.geos.prepared import PreparedGeometry +from django.contrib.gis.geos.prepared import PreparedGeometry +GEOS_CLASSES = { + 0: Point, + 1: LineString, + 2: LinearRing, + 3: Polygon, + 4: MultiPoint, + 5: MultiLineString, + 6: MultiPolygon, + 7: GeometryCollection, +} diff --git a/django/contrib/gis/geos/libgeos.py b/django/contrib/gis/geos/libgeos.py index 239067a433..5be05cee50 100644 --- a/django/contrib/gis/geos/libgeos.py +++ b/django/contrib/gis/geos/libgeos.py @@ -155,22 +155,10 @@ GEOS_MINOR_VERSION = int(_verinfo['minor']) GEOS_SUBMINOR_VERSION = int(_verinfo['subminor']) del _verinfo GEOS_VERSION = (GEOS_MAJOR_VERSION, GEOS_MINOR_VERSION, GEOS_SUBMINOR_VERSION) -GEOS_PREPARE = GEOS_VERSION >= (3, 1, 0) -if GEOS_PREPARE: - # Here we set up the prototypes for the initGEOS_r and finishGEOS_r - # routines. These functions aren't actually called until they are - # attached to a GEOS context handle -- this actually occurs in - # geos/prototypes/threadsafe.py. - lgeos.initGEOS_r.restype = CONTEXT_PTR - lgeos.finishGEOS_r.argtypes = [CONTEXT_PTR] -else: - # When thread-safety isn't available, the initGEOS routine must be called - # first. This function takes the notice and error functions, defined - # as Python callbacks above, as parameters. Here is the C code that is - # wrapped: - # extern void GEOS_DLL initGEOS(GEOSMessageHandler notice_function, GEOSMessageHandler error_function); - lgeos.initGEOS(notice_h, error_h) - # Calling finishGEOS() upon exit of the interpreter. - import atexit - atexit.register(lgeos.finishGEOS) +# Here we set up the prototypes for the initGEOS_r and finishGEOS_r +# routines. These functions aren't actually called until they are +# attached to a GEOS context handle -- this actually occurs in +# geos/prototypes/threadsafe.py. +lgeos.initGEOS_r.restype = CONTEXT_PTR +lgeos.finishGEOS_r.argtypes = [CONTEXT_PTR] diff --git a/django/contrib/gis/geos/prototypes/misc.py b/django/contrib/gis/geos/prototypes/misc.py index 6b10396aba..a8bb3cbd58 100644 --- a/django/contrib/gis/geos/prototypes/misc.py +++ b/django/contrib/gis/geos/prototypes/misc.py @@ -3,13 +3,13 @@ ones that return the area, distance, and length. """ from ctypes import c_int, c_double, POINTER -from django.contrib.gis.geos.libgeos import GEOM_PTR, GEOS_PREPARE +from django.contrib.gis.geos.libgeos import GEOM_PTR from django.contrib.gis.geos.prototypes.errcheck import check_dbl, check_string from django.contrib.gis.geos.prototypes.geom import geos_char_p from django.contrib.gis.geos.prototypes.threadsafe import GEOSFunc from django.utils.six.moves import xrange -__all__ = ['geos_area', 'geos_distance', 'geos_length'] +__all__ = ['geos_area', 'geos_distance', 'geos_length', 'geos_isvalidreason'] ### ctypes generator function ### @@ -31,11 +31,7 @@ def dbl_from_geom(func, num_geom=1): geos_area = dbl_from_geom(GEOSFunc('GEOSArea')) geos_distance = dbl_from_geom(GEOSFunc('GEOSDistance'), num_geom=2) geos_length = dbl_from_geom(GEOSFunc('GEOSLength')) - -# Validity reason; only in GEOS 3.1+ -if GEOS_PREPARE: - geos_isvalidreason = GEOSFunc('GEOSisValidReason') - geos_isvalidreason.argtypes = [GEOM_PTR] - geos_isvalidreason.restype = geos_char_p - geos_isvalidreason.errcheck = check_string - __all__.append('geos_isvalidreason') +geos_isvalidreason = GEOSFunc('GEOSisValidReason') +geos_isvalidreason.argtypes = [GEOM_PTR] +geos_isvalidreason.restype = geos_char_p +geos_isvalidreason.errcheck = check_string diff --git a/django/contrib/gis/geos/prototypes/topology.py b/django/contrib/gis/geos/prototypes/topology.py index 5bc99e8409..60db46ec14 100644 --- a/django/contrib/gis/geos/prototypes/topology.py +++ b/django/contrib/gis/geos/prototypes/topology.py @@ -2,13 +2,14 @@ This module houses the GEOS ctypes prototype functions for the topological operations on geometries. """ -__all__ = ['geos_boundary', 'geos_buffer', 'geos_centroid', 'geos_convexhull', - 'geos_difference', 'geos_envelope', 'geos_intersection', - 'geos_linemerge', 'geos_pointonsurface', 'geos_preservesimplify', - 'geos_simplify', 'geos_symdifference', 'geos_union', 'geos_relate'] +__all__ = ['geos_boundary', 'geos_buffer', 'geos_cascaded_union', + 'geos_centroid', 'geos_convexhull', 'geos_difference', + 'geos_envelope', 'geos_intersection', 'geos_linemerge', + 'geos_pointonsurface', 'geos_preservesimplify', 'geos_simplify', + 'geos_symdifference', 'geos_union', 'geos_relate'] from ctypes import c_double, c_int -from django.contrib.gis.geos.libgeos import geos_version_info, GEOM_PTR, GEOS_PREPARE +from django.contrib.gis.geos.libgeos import geos_version_info, GEOM_PTR from django.contrib.gis.geos.prototypes.errcheck import check_geom, check_minus_one, check_string from django.contrib.gis.geos.prototypes.geom import geos_char_p from django.contrib.gis.geos.prototypes.threadsafe import GEOSFunc @@ -39,19 +40,16 @@ geos_simplify = topology(GEOSFunc('GEOSSimplify'), c_double) geos_symdifference = topology(GEOSFunc('GEOSSymDifference'), GEOM_PTR) geos_union = topology(GEOSFunc('GEOSUnion'), GEOM_PTR) +geos_cascaded_union = GEOSFunc('GEOSUnionCascaded') +geos_cascaded_union.argtypes = [GEOM_PTR] +geos_cascaded_union.restype = GEOM_PTR + # GEOSRelate returns a string, not a geometry. geos_relate = GEOSFunc('GEOSRelate') geos_relate.argtypes = [GEOM_PTR, GEOM_PTR] geos_relate.restype = geos_char_p geos_relate.errcheck = check_string -# Routines only in GEOS 3.1+ -if GEOS_PREPARE: - geos_cascaded_union = GEOSFunc('GEOSUnionCascaded') - geos_cascaded_union.argtypes = [GEOM_PTR] - geos_cascaded_union.restype = GEOM_PTR - __all__.append('geos_cascaded_union') - # Linear referencing routines info = geos_version_info() if info['version'] >= '3.2.0': diff --git a/django/contrib/gis/geos/tests/test_geos.py b/django/contrib/gis/geos/tests/test_geos.py index 9ce7e0d73d..8356343839 100644 --- a/django/contrib/gis/geos/tests/test_geos.py +++ b/django/contrib/gis/geos/tests/test_geos.py @@ -22,8 +22,7 @@ from .. import HAS_GEOS if HAS_GEOS: from .. import (GEOSException, GEOSIndexError, GEOSGeometry, GeometryCollection, Point, MultiPoint, Polygon, MultiPolygon, LinearRing, - LineString, MultiLineString, fromfile, fromstr, geos_version_info, - GEOS_PREPARE) + LineString, MultiLineString, fromfile, fromstr, geos_version_info) from ..base import gdal, numpy, GEOSBase @@ -121,20 +120,12 @@ class GEOSTest(unittest.TestCase, TestDataMixin): # a bug in versions prior to 3.1 that puts the X coordinate in # place of Z; an exception should be raised on those versions. self.assertEqual(hexewkb_2d, pnt_2d.hexewkb) - if GEOS_PREPARE: - self.assertEqual(hexewkb_3d, pnt_3d.hexewkb) - self.assertEqual(True, GEOSGeometry(hexewkb_3d).hasz) - else: - with self.assertRaises(GEOSException): - pnt_3d.hexewkb + self.assertEqual(hexewkb_3d, pnt_3d.hexewkb) + self.assertEqual(True, GEOSGeometry(hexewkb_3d).hasz) # Same for EWKB. self.assertEqual(memoryview(a2b_hex(hexewkb_2d)), pnt_2d.ewkb) - if GEOS_PREPARE: - self.assertEqual(memoryview(a2b_hex(hexewkb_3d)), pnt_3d.ewkb) - else: - with self.assertRaises(GEOSException): - pnt_3d.ewkb + self.assertEqual(memoryview(a2b_hex(hexewkb_3d)), pnt_3d.ewkb) # Redundant sanity check. self.assertEqual(4326, GEOSGeometry(hexewkb_2d).srid) @@ -869,10 +860,9 @@ class GEOSTest(unittest.TestCase, TestDataMixin): self.assertIsInstance(g1.ogr, gdal.OGRGeometry) self.assertIsNone(g1.srs) - if GEOS_PREPARE: - g1_3d = fromstr('POINT(5 23 8)') - self.assertIsInstance(g1_3d.ogr, gdal.OGRGeometry) - self.assertEqual(g1_3d.ogr.z, 8) + g1_3d = fromstr('POINT(5 23 8)') + self.assertIsInstance(g1_3d.ogr, gdal.OGRGeometry) + self.assertEqual(g1_3d.ogr.z, 8) g2 = fromstr('LINESTRING(0 0, 5 5, 23 23)', srid=4326) self.assertIsInstance(g2.ogr, gdal.OGRGeometry) @@ -918,10 +908,7 @@ class GEOSTest(unittest.TestCase, TestDataMixin): def test_transform_3d(self): p3d = GEOSGeometry('POINT (5 23 100)', 4326) p3d.transform(2774) - if GEOS_PREPARE: - self.assertEqual(p3d.z, 100) - else: - self.assertIsNone(p3d.z) + self.assertEqual(p3d.z, 100) @skipUnless(HAS_GDAL, "GDAL is required.") def test_transform_noop(self): @@ -1030,7 +1017,6 @@ class GEOSTest(unittest.TestCase, TestDataMixin): if not no_srid: self.assertEqual(geom.srid, tmpg.srid) - @skipUnless(HAS_GEOS and GEOS_PREPARE, "geos >= 3.1.0 is required") def test_prepared(self): "Testing PreparedGeometry support." # Creating a simple multipolygon and getting a prepared version. @@ -1061,7 +1047,6 @@ class GEOSTest(unittest.TestCase, TestDataMixin): for geom, merged in zip(ref_geoms, ref_merged): self.assertEqual(merged, geom.merged) - @skipUnless(HAS_GEOS and GEOS_PREPARE, "geos >= 3.1.0 is required") def test_valid_reason(self): "Testing IsValidReason support" diff --git a/docs/ref/contrib/gis/geos.txt b/docs/ref/contrib/gis/geos.txt index d557af96a3..a1f92b31c7 100644 --- a/docs/ref/contrib/gis/geos.txt +++ b/docs/ref/contrib/gis/geos.txt @@ -282,10 +282,6 @@ Returns the EWKB of this Geometry in hexadecimal form. This is an extension of the WKB specification that includes the SRID value that are a part of this geometry. -.. note:: - - GEOS 3.1 is *required* if you want valid 3D HEXEWKB. - .. attribute:: GEOSGeometry.json Returns the GeoJSON representation of the geometry. @@ -329,10 +325,6 @@ Return the EWKB representation of this Geometry as a Python buffer. This is an extension of the WKB specification that includes any SRID value that are a part of this geometry. -.. note:: - - GEOS 3.1 is *required* if you want valid 3D EWKB. - .. attribute:: GEOSGeometry.wkt Returns the Well-Known Text of the geometry (an OGC standard). @@ -533,10 +525,6 @@ a :class:`Polygon`). .. attribute:: GEOSGeometry.prepared -.. note:: - - Support for prepared geometries requires GEOS 3.1. - Returns a GEOS ``PreparedGeometry`` for the contents of this geometry. ``PreparedGeometry`` objects are optimized for the contains, intersects, and covers operations. Refer to the :ref:`prepared-geometries` documentation @@ -710,10 +698,6 @@ Geometry Collections more efficient (faster) than trying to union the geometries together individually. [#fncascadedunion]_ - .. note:: - - GEOS 3.1 is *required* to peform cascaded unions. - ``GeometryCollection`` ---------------------- @@ -740,10 +724,6 @@ geometry can be orders of magnitude faster -- the more complex the geometry that is prepared, the larger the speedup in the operation. For more information, please consult the `GEOS wiki page on prepared geometries `_. -.. note:: - - GEOS 3.1 is *required* in order to use prepared geometries. - For example:: >>> from django.contrib.gis.geos import Point, Polygon diff --git a/docs/ref/contrib/gis/install/geolibs.txt b/docs/ref/contrib/gis/install/geolibs.txt index 508bf7809c..a529a497d2 100644 --- a/docs/ref/contrib/gis/install/geolibs.txt +++ b/docs/ref/contrib/gis/install/geolibs.txt @@ -10,7 +10,7 @@ geospatial libraries: ======================== ==================================== ================================ ========================== Program Description Required Supported Versions ======================== ==================================== ================================ ========================== -:ref:`GEOS ` Geometry Engine Open Source Yes 3.3, 3.2, 3.1, 3.0 +:ref:`GEOS ` Geometry Engine Open Source Yes 3.3, 3.2, 3.1 `PROJ.4`_ Cartographic Projections library Yes (PostgreSQL and SQLite only) 4.8, 4.7, 4.6, 4.5, 4.4 :ref:`GDAL ` Geospatial Data Abstraction Library No (but, required for SQLite) 1.9, 1.8, 1.7, 1.6 :ref:`GeoIP ` IP-based geolocation library No 1.4 @@ -20,7 +20,6 @@ Program Description Required .. Libs release dates: - GEOS 3.0.0 2008-08-14 GEOS 3.1.0 2009-03-11 GEOS 3.2.0 2009-12-14 GEOS 3.3.0 2011-05-30 diff --git a/docs/ref/contrib/gis/model-api.txt b/docs/ref/contrib/gis/model-api.txt index 81b619e338..10cc2957d8 100644 --- a/docs/ref/contrib/gis/model-api.txt +++ b/docs/ref/contrib/gis/model-api.txt @@ -172,8 +172,7 @@ three-dimensonal support. .. note:: - At this time 3D support requires that GEOS 3.1 be installed, and is - limited only to the PostGIS spatial backend. + At this time 3D support is limited to the PostGIS spatial backend. ``geography`` ------------- diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 3a1568fe45..21449b4e7c 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -722,6 +722,8 @@ Miscellaneous ``select_related('foo').select_related('bar')``. Previously the latter would have been equivalent to ``select_related('bar')``. +* GeoDjango dropped support for GEOS < 3.1. + Features deprecated in 1.7 ========================== From 9267fb88efb5a81adcf5aac582fb62b3ee269c08 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Tue, 24 Dec 2013 16:53:09 +0100 Subject: [PATCH 044/208] Added more spatial predicates for prepared geometries GEOS 3.3 added crosses, disjoint, overlaps, touches and within predicates on prepared geometries. --- django/contrib/gis/geos/prepared.py | 34 ++++++++++++-- .../contrib/gis/geos/prototypes/prepared.py | 9 +++- django/contrib/gis/geos/tests/test_geos.py | 10 +++++ docs/ref/contrib/gis/geos.txt | 44 ++++++++++++++++++- docs/releases/1.7.txt | 4 ++ 5 files changed, 95 insertions(+), 6 deletions(-) diff --git a/django/contrib/gis/geos/prepared.py b/django/contrib/gis/geos/prepared.py index d5b531bb43..90a3f4df21 100644 --- a/django/contrib/gis/geos/prepared.py +++ b/django/contrib/gis/geos/prepared.py @@ -1,6 +1,7 @@ -from django.contrib.gis.geos.base import GEOSBase -from django.contrib.gis.geos.geometry import GEOSGeometry -from django.contrib.gis.geos.prototypes import prepared as capi +from .base import GEOSBase +from .geometry import GEOSGeometry +from .libgeos import geos_version_info +from .prototypes import prepared as capi class PreparedGeometry(GEOSBase): @@ -35,3 +36,30 @@ class PreparedGeometry(GEOSBase): def intersects(self, other): return capi.prepared_intersects(self.ptr, other.ptr) + + # Added in GEOS 3.3: + + def crosses(self, other): + if geos_version_info()['version'] < '3.3.0': + raise GEOSException("crosses on prepared geometries requires GEOS >= 3.3.0") + return capi.prepared_crosses(self.ptr, other.ptr) + + def disjoint(self, other): + if geos_version_info()['version'] < '3.3.0': + raise GEOSException("disjoint on prepared geometries requires GEOS >= 3.3.0") + return capi.prepared_disjoint(self.ptr, other.ptr) + + def overlaps(self, other): + if geos_version_info()['version'] < '3.3.0': + raise GEOSException("overlaps on prepared geometries requires GEOS >= 3.3.0") + return capi.prepared_overlaps(self.ptr, other.ptr) + + def touches(self, other): + if geos_version_info()['version'] < '3.3.0': + raise GEOSException("touches on prepared geometries requires GEOS >= 3.3.0") + return capi.prepared_touches(self.ptr, other.ptr) + + def within(self, other): + if geos_version_info()['version'] < '3.3.0': + raise GEOSException("within on prepared geometries requires GEOS >= 3.3.0") + return capi.prepared_within(self.ptr, other.ptr) diff --git a/django/contrib/gis/geos/prototypes/prepared.py b/django/contrib/gis/geos/prototypes/prepared.py index eef141a2f7..ced56395b0 100644 --- a/django/contrib/gis/geos/prototypes/prepared.py +++ b/django/contrib/gis/geos/prototypes/prepared.py @@ -1,5 +1,5 @@ from ctypes import c_char -from django.contrib.gis.geos.libgeos import GEOM_PTR, PREPGEOM_PTR +from django.contrib.gis.geos.libgeos import GEOM_PTR, PREPGEOM_PTR, geos_version_info from django.contrib.gis.geos.prototypes.errcheck import check_predicate from django.contrib.gis.geos.prototypes.threadsafe import GEOSFunc @@ -24,3 +24,10 @@ prepared_contains = prepared_predicate(GEOSFunc('GEOSPreparedContains')) prepared_contains_properly = prepared_predicate(GEOSFunc('GEOSPreparedContainsProperly')) prepared_covers = prepared_predicate(GEOSFunc('GEOSPreparedCovers')) prepared_intersects = prepared_predicate(GEOSFunc('GEOSPreparedIntersects')) + +if geos_version_info()['version'] > '3.3.0': + prepared_crosses = prepared_predicate(GEOSFunc('GEOSPreparedCrosses')) + prepared_disjoint = prepared_predicate(GEOSFunc('GEOSPreparedDisjoint')) + prepared_overlaps = prepared_predicate(GEOSFunc('GEOSPreparedOverlaps')) + prepared_touches = prepared_predicate(GEOSFunc('GEOSPreparedTouches')) + prepared_within = prepared_predicate(GEOSFunc('GEOSPreparedWithin')) diff --git a/django/contrib/gis/geos/tests/test_geos.py b/django/contrib/gis/geos/tests/test_geos.py index 8356343839..4c38c9bfcb 100644 --- a/django/contrib/gis/geos/tests/test_geos.py +++ b/django/contrib/gis/geos/tests/test_geos.py @@ -1032,6 +1032,16 @@ class GEOSTest(unittest.TestCase, TestDataMixin): self.assertEqual(mpoly.intersects(pnt), prep.intersects(pnt)) self.assertEqual(c, prep.covers(pnt)) + if geos_version_info()['version'] > '3.3.0': + self.assertTrue(prep.crosses(fromstr('LINESTRING(1 1, 15 15)'))) + self.assertTrue(prep.disjoint(Point(-5, -5))) + poly = Polygon(((-1, -1), (1, 1), (1, 0), (-1, -1))) + self.assertTrue(prep.overlaps(poly)) + poly = Polygon(((-5, 0), (-5, 5), (0, 5), (-5, 0))) + self.assertTrue(prep.touches(poly)) + poly = Polygon(((-1, -1), (-1, 11), (11, 11), (11, -1), (-1, -1))) + self.assertTrue(prep.within(poly)) + # Original geometry deletion should not crash the prepared one (#21662) del mpoly self.assertTrue(prep.covers(Point(5, 5))) diff --git a/docs/ref/contrib/gis/geos.txt b/docs/ref/contrib/gis/geos.txt index a1f92b31c7..769c2cdd32 100644 --- a/docs/ref/contrib/gis/geos.txt +++ b/docs/ref/contrib/gis/geos.txt @@ -527,8 +527,8 @@ a :class:`Polygon`). Returns a GEOS ``PreparedGeometry`` for the contents of this geometry. ``PreparedGeometry`` objects are optimized for the contains, intersects, -and covers operations. Refer to the :ref:`prepared-geometries` documentation -for more information. +covers, crosses, disjoint, overlaps, touches and within operations. Refer to +the :ref:`prepared-geometries` documentation for more information. .. attribute:: GEOSGeometry.srs @@ -746,8 +746,48 @@ For example:: .. method:: covers(other) + .. method:: crosses(other) + + .. versionadded:: 1.7 + + .. note:: + + GEOS 3.3 is *required* to use this predicate. + + .. method:: disjoint(other) + + .. versionadded:: 1.7 + + .. note:: + + GEOS 3.3 is *required* to use this predicate. + .. method:: intersects(other) + .. method:: overlaps(other) + + .. versionadded:: 1.7 + + .. note:: + + GEOS 3.3 is *required* to use this predicate. + + .. method:: touches(other) + + .. versionadded:: 1.7 + + .. note:: + + GEOS 3.3 is *required* to use this predicate. + + .. method:: within(other) + + .. versionadded:: 1.7 + + .. note:: + + GEOS 3.3 is *required* to use this predicate. + Geometry Factories ================== diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 21449b4e7c..106de20ec1 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -211,6 +211,10 @@ Minor features * The default OpenLayers library version included in widgets has been updated from 2.11 to 2.13. +* Prepared geometries now also support the ``crosses``, ``disjoint``, + ``overlaps``, ``touches`` and ``within`` predicates, if GEOS 3.3 or later is + installed. + :mod:`django.contrib.messages` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ From f326720a7363f305a6767d71fc3a8db2dcb05c0e Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 24 Dec 2013 15:40:12 +0100 Subject: [PATCH 045/208] Documented the Apps and AppConfig APIs. --- django/apps/registry.py | 4 +- docs/index.txt | 3 + docs/ref/applications.txt | 191 ++++++++++++++++++++++++++++++++++++++ docs/ref/index.txt | 1 + 4 files changed, 197 insertions(+), 2 deletions(-) create mode 100644 docs/ref/applications.txt diff --git a/django/apps/registry.py b/django/apps/registry.py index 0cb58f2049..bedd8cdb02 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -278,7 +278,7 @@ class Apps(object): app_name is the full name of the app eg. 'django.contrib.admin'. It's safe to call this method at import time, even while the registry - is being populated. It returns None for apps that aren't loaded yet. + is being populated. It returns False for apps that aren't loaded yet. """ app_config = self.app_configs.get(app_name.rpartition(".")[2]) return app_config is not None and app_config.name == app_name @@ -288,7 +288,7 @@ class Apps(object): Returns the model class if one is registered and None otherwise. It's safe to call this method at import time, even while the registry - is being populated. It returns None for models that aren't loaded yet. + is being populated. It returns False for models that aren't loaded yet. """ return self.all_models[app_label].get(model_name.lower()) diff --git a/docs/index.txt b/docs/index.txt index bd3baf8a9c..f37a597276 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -179,6 +179,9 @@ testing of Django applications: :doc:`Overview ` | :doc:`Full list of settings ` +* **Applications:** + :doc:`Overview ` + * **Exceptions:** :doc:`Overview ` diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt new file mode 100644 index 0000000000..0f5090cf1a --- /dev/null +++ b/docs/ref/applications.txt @@ -0,0 +1,191 @@ +============ +Applications +============ + +.. module:: django.apps + +.. versionadded:: 1.7 + +Django contains a registry of installed applications that stores configuration +and provides introspection. It also maintains a list of available :doc:`models +`. + +This registry is simply called :attr:`~django.apps.apps` and it's available in +:mod:`django.apps`:: + + >>> from django.apps import apps + >>> apps.get_app_config('admin').verbose_name + 'Admin' + +Projects and applications +========================= + +Django has historically used the term **project** to describe an installation +of Django. A project is defined primarily by a settings module. + +The term **application** describes a Python package that provides some set of +features. Applications may be reused in various projects. + +.. note:: + This terminology is somewhat confusing these days as it became common to + use the phrase "web app" to describe what equates to a Django project. + +Applications include some combination of models, views, templates, template +tags, static files, URLs, middleware, etc. They're generally wired into +projects with the :setting:`INSTALLED_APPS` setting and optionally with other +mechanisms such as URLconfs, the :setting:`MIDDLEWARE_CLASSES` setting, or +template inheritance. + +It is important to understand that a Django application is just a set of code +that interacts with various parts of the framework. There's no such thing as +an ``Application`` object. However, there's a few places where Django needs to +interact with installed applications, mainly for configuration and also for +introspection. That's why the application registry maintains metadata in an +:class:`~django.apps.AppConfig` instance for each installed application. + +Configuring applications +======================== + +To configure an application, subclass :class:`~django.apps.AppConfig` and put +the dotted path to that subclass in :setting:`INSTALLED_APPS`. + +Django uses the default :class:`~django.apps.AppConfig` class when +:setting:`INSTALLED_APPS` simply contains the dotted path to an application +module. + +For application authors +----------------------- + +If you're creating a pluggable app called "Rock ’n’ roll", here's how you +would provide a proper name for the admin:: + + # rock_n_roll/app.py + + from django.apps import AppConfig + + class RockNRollConfig(AppConfig): + name = 'rock_n_roll' + verbose_name = "Rock ’n’ roll" + +You would then tell your users to add ``'rock_n_roll.app.RockNRollConfig'`` to +their :setting:`INSTALLED_APPS`. + +The recommended convention is to put the configuration class in a submodule of +the application called ``app``. However, this isn't enforced by Django. + +You must include the :attr:`~django.apps.AppConfig.name` attribute for Django +to determine which application this configuration applies to. You can define +any attributes documented in the :class:`~django.apps.AppConfig` API +reference. + +For application users +--------------------- + +If you're using "Rock ’n’ roll" in a project called ``anthology``, but you +want it to show up as "Gypsy jazz" instead, you can provide your own +configuration:: + + # anthology/apps.py + + from rock_n_roll.app import RockNRollConfig + + class GypsyJazzConfig(RockNRollConfig): + verbose_name = "Gypsy jazz" + + # anthology/settings.py + + INSTALLED_APPS = [ + 'anthology.apps.GypsyJazzConfig', + # ... + ] + +Again, defining project-specific configuration classes in a submodule called +``apps`` is a convention, not a requirement. + +Application registry +==================== + +.. data:: django.apps.apps + + The application registry provides the following public API. Methods that + aren't listed below are considered private and may change without notice. + +.. method:: django.apps.apps.ready() + + Returns ``True`` if the registry is fully populated. + +.. method:: django.apps.apps.get_app_configs(only_with_models_module=False) + + Returns an iterable of :class:`~django.apps.AppConfig` instances. + + If only applications containing a models module are of interest, this method + can be called with ``only_with_models_module=True``. + +.. method:: django.apps.apps.get_app_config(app_label, only_with_models_module=False) + + Returns an :class:`~django.apps.AppConfig` for the application with the + given ``app_label``. Raises :exc:`LookupError` if no such application + exists. + + If only applications containing a models module are of interest, this method + can be called with ``only_with_models_module=True``. + +.. method:: django.apps.apps.has_app(app_name) + + Checks whether an application with the given name exists in the registry. + ``app_name`` is the full name of the app, e.g. 'django.contrib.admin'. + + Unlike :meth:`~django.apps.apps.get_app_config`, this method can be called + safely at import time. If the registry is still being populated, it may + return ``False``, even though the app will become available later. + +Application configuration +========================= + +.. class:: django.apps.AppConfig + + Application configuration objects store metadata for an application. Some + attributes can be configured in :class:`~django.apps.AppConfig` + subclasses. Others are set by Django and read-only. + +Configurable attributes +----------------------- + +.. data:: django.apps.AppConfig.verbose_name + + Human-readable name for the application, e.g. "Admin". + + If this isn't provided, Django uses ``label.title()``. + +Read-only attributes +-------------------- + +.. data:: django.apps.AppConfig.name + + Full Python path to the application, e.g. ``'django.contrib.admin'``. + +.. data:: django.apps.AppConfig.label + + Last component of the Python path to the application, e.g. ``'admin'``. + + This value must be unique across a Django project. + +.. data:: django.apps.AppConfig.path + + Filesystem path to the application directory, e.g. + ``'/usr/lib/python2.7/dist-packages/django/contrib/admin'``. + + It may be ``None`` if the application isn't stored in a directory, for + instance if it's loaded from an egg. + +.. data:: django.apps.AppConfig.app_module + + Root module for the application, e.g. ````. + +.. data:: django.apps.AppConfig.models_module + + Module containing the models, e.g. ````. + + It may be ``None`` if the application doesn't contain a ``models`` module. diff --git a/docs/ref/index.txt b/docs/ref/index.txt index 1d71b62f41..6d7bfd4da4 100644 --- a/docs/ref/index.txt +++ b/docs/ref/index.txt @@ -5,6 +5,7 @@ API Reference .. toctree:: :maxdepth: 1 + applications class-based-views/index clickjacking contrib/index From 9b8192ce5101b622dbbae61f5ce784cd3e144a4d Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 24 Dec 2013 16:28:31 +0100 Subject: [PATCH 046/208] Updated a few doc paragraphs following the app-loading refactor. --- .../contributing/writing-code/unit-tests.txt | 1 - docs/intro/reusable-apps.txt | 16 ++++++++-------- docs/ref/settings.txt | 19 +++++++++---------- 3 files changed, 17 insertions(+), 19 deletions(-) diff --git a/docs/internals/contributing/writing-code/unit-tests.txt b/docs/internals/contributing/writing-code/unit-tests.txt index 2bbd9dcf0e..3690264875 100644 --- a/docs/internals/contributing/writing-code/unit-tests.txt +++ b/docs/internals/contributing/writing-code/unit-tests.txt @@ -222,7 +222,6 @@ Tests for contrib apps go in their respective directories under ``django/contrib``, in a ``tests.py`` file. You can split the tests over multiple modules by using a ``tests`` directory in the normal Python way. -For the tests to be found, a ``models.py`` file must exist, even if it's empty. If you have URLs that need to be mapped, put them in ``tests/urls.py``. To run tests for just one contrib app (e.g. ``auth``), use the same diff --git a/docs/intro/reusable-apps.txt b/docs/intro/reusable-apps.txt index 8959aae06a..4c6e2173db 100644 --- a/docs/intro/reusable-apps.txt +++ b/docs/intro/reusable-apps.txt @@ -42,9 +42,10 @@ projects and ready to publish for others to install and use. bar``. For a directory (like ``polls``) to form a package, it must contain a special file ``__init__.py``, even if this file is empty. - A Django *app* is just a Python package that is specifically intended for - use in a Django project. An app may also use common Django conventions, - such as having a ``models.py`` file. + A Django *application* is just a Python package that is specifically + intended for use in a Django project. An application may use common Django + conventions, such as having ``models``, ``tests``, ``urls``, and ``views`` + submodules. Later on we use the term *packaging* to describe the process of making a Python package easy for others to install. It can be a little confusing, we @@ -128,11 +129,10 @@ this. For a small app like polls, this process isn't too difficult. This helps others looking for Django apps identify your app as Django specific. - The application names (that is, the final dotted part of the - path to the module containing ``models.py``) defined in - :setting:`INSTALLED_APPS` *must* be unique. Avoid using the - same name as any of the Django :doc:`contrib packages - `, for example ``auth``, ``admin`` or + Application labels (that is, the final part of the dotted path to + application packages) *must* be unique in :setting:`INSTALLED_APPS`. + Avoid using the same label as any of the Django :doc:`contrib packages + `, for example ``auth``, ``admin``, or ``messages``. 2. Move the ``polls`` directory into the ``django-polls`` directory. diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index 3e625ace85..fbd06976cc 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -1285,18 +1285,17 @@ INSTALLED_APPS Default: ``()`` (Empty tuple) -A tuple of strings designating all applications that are enabled in this Django -installation. Each string should be a full Python path to a Python package that -contains a Django application, as created by :djadmin:`django-admin.py startapp -`. +A tuple of strings designating all applications that are enabled in this +Django installation. Each string should be a full Python path to an +application configuration class or to a Python package containing a +application. :ref:` Learn more about applications `. -.. admonition:: App names must be unique +.. admonition:: Application labels must be unique - The application names (that is, the final dotted part of the - path to the module containing ``models.py``) defined in - :setting:`INSTALLED_APPS` *must* be unique. For example, you can't - include both ``django.contrib.auth`` and ``myproject.auth`` in - INSTALLED_APPS. + Application labels (that is, the final part of the dotted path to + application packages) *must* be unique in :setting:`INSTALLED_APPS`. + For example, you can't include both ``django.contrib.auth`` and + ``myproject.auth``. .. setting:: INTERNAL_IPS From 96967f642fbbd01a10e1c1e17764dd6af7c35e97 Mon Sep 17 00:00:00 2001 From: Jonas Gastal Date: Tue, 24 Dec 2013 14:26:50 -0200 Subject: [PATCH 047/208] Typo fix for exception message. --- django/db/models/fields/related.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/django/db/models/fields/related.py b/django/db/models/fields/related.py index 769121bc01..247067d60a 100644 --- a/django/db/models/fields/related.py +++ b/django/db/models/fields/related.py @@ -1084,7 +1084,7 @@ class ForeignObject(RelatedField): if len(self.from_fields) < 1 or len(self.from_fields) != len(self.to_fields): raise ValueError('Foreign Object from and to fields must be the same non-zero length') if isinstance(self.rel.to, six.string_types): - raise ValueError('Related model %r cannot been resolved' % self.rel.to) + raise ValueError('Related model %r cannot be resolved' % self.rel.to) related_fields = [] for index in range(len(self.from_fields)): from_field_name = self.from_fields[index] From dbe2fb632de6d4e116f00f9e74b583a5bdc051a9 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Tue, 24 Dec 2013 08:35:13 -0800 Subject: [PATCH 048/208] Added a missing import and removed an unneeded import --- django/contrib/gis/geos/prepared.py | 1 + tests/swappable_models/tests.py | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/django/contrib/gis/geos/prepared.py b/django/contrib/gis/geos/prepared.py index 90a3f4df21..5458264f19 100644 --- a/django/contrib/gis/geos/prepared.py +++ b/django/contrib/gis/geos/prepared.py @@ -1,4 +1,5 @@ from .base import GEOSBase +from .error import GEOSException from .geometry import GEOSGeometry from .libgeos import geos_version_info from .prototypes import prepared as capi diff --git a/tests/swappable_models/tests.py b/tests/swappable_models/tests.py index 3bf5b46d66..de2105d2ec 100644 --- a/tests/swappable_models/tests.py +++ b/tests/swappable_models/tests.py @@ -2,7 +2,6 @@ from __future__ import unicode_literals from django.utils.six import StringIO -from django.apps import apps from django.contrib.auth.models import Permission from django.contrib.contenttypes.models import ContentType from django.core import management From 285e765891149704cbd5ddb784887ad187416ef7 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 24 Dec 2013 19:00:29 +0100 Subject: [PATCH 049/208] Added release notes for app loading changes. --- docs/ref/applications.txt | 4 ++-- docs/ref/settings.txt | 9 +++++++++ docs/releases/1.7.txt | 37 +++++++++++++++++++++++++++++++++++++ 3 files changed, 48 insertions(+), 2 deletions(-) diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt index 0f5090cf1a..5d13d0d4d8 100644 --- a/docs/ref/applications.txt +++ b/docs/ref/applications.txt @@ -124,8 +124,8 @@ Application registry .. method:: django.apps.apps.get_app_config(app_label, only_with_models_module=False) Returns an :class:`~django.apps.AppConfig` for the application with the - given ``app_label``. Raises :exc:`LookupError` if no such application - exists. + given ``app_label``. Raises :exc:`~exceptions.LookupError` if no such + application exists. If only applications containing a models module are of interest, this method can be called with ``only_with_models_module=True``. diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index fbd06976cc..d82f68a2a4 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -1290,6 +1290,15 @@ Django installation. Each string should be a full Python path to an application configuration class or to a Python package containing a application. :ref:` Learn more about applications `. +.. versionchanged:: 1.7 + + :setting:`INSTALLED_APPS` now supports application configurations. + +.. admonition:: Use the application registry for introspection + + Your code should never access :setting:`INSTALLED_APPS` directly. Use the + app registry, :attr:`~django.apps.apps`, instead. + .. admonition:: Application labels must be unique Application labels (that is, the final part of the dotted path to diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 106de20ec1..ab2aa3442b 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -58,6 +58,27 @@ but a few of the key features are: will still work, but that method name is deprecated and you should change it as soon as possible (nothing more than renaming is required). +App-loading refactor +~~~~~~~~~~~~~~~~~~~~ + +Historically, Django applications were tightly linked to models. A singleton +known as the "app cache" dealt with both installed applications and models. +The models module was used as an identifier for applications in many APIs. + +As the concept of :doc:`Django applications ` matured, this +code showed some shortcomings. It was refactored into an "app registry" where +models modules no longer have a central role models and where it's possible to +attach configuration data to applications. + +Not only does this prepare the ground for further improvements, but it also +brings some concrete improvements: + +* It is possible to omit ``models.py`` entirely if an application doesn't + have any models. + +* The name of applications can be customized in the admin with the + :attr:`~django.apps.AppConfig.verbose_name` of application configurations. + New method on Field subclasses ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -570,6 +591,22 @@ For apps with migrations, ``allow_migrate`` will now get passed without custom attributes, methods or managers. Make sure your ``allow_migrate`` methods are only referring to fields or other items in ``model._meta``. +App-loading changes +~~~~~~~~~~~~~~~~~~~ + +Since :setting:`INSTALLED_APPS` now supports application configuration classes +in addition to application modules, you should review code that accesses this +setting directly and use the app registry (:attr:`django.apps.apps`) instead. + +The "app registry" that manages the list of installed applications doesn't +have the same features as the old "app cache". However, even though the "app +cache" was a private API, most of its methods were temporarily preserved and +will go through a deprecation path. + +While the new implementation is believed to be more robust, regressions cannot +be ruled out, especially during the import sequence. Circular imports that +didn't happen with previous versions of Django might appear. + Behavior of ``LocMemCache`` regarding pickle errors ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 8c78cba47f78f6b56ca1948b108f0f37965f387d Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 24 Dec 2013 23:48:22 +0100 Subject: [PATCH 050/208] Copy-edited previous commit. Thanks Tim for the review. --- docs/ref/settings.txt | 2 +- docs/releases/1.7.txt | 7 +++---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index d82f68a2a4..e9b98fb711 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -1297,7 +1297,7 @@ application. :ref:` Learn more about applications `. .. admonition:: Use the application registry for introspection Your code should never access :setting:`INSTALLED_APPS` directly. Use the - app registry, :attr:`~django.apps.apps`, instead. + app registry, :attr:`django.apps.apps`, instead. .. admonition:: Application labels must be unique diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index ab2aa3442b..5aba3ca096 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -66,12 +66,11 @@ known as the "app cache" dealt with both installed applications and models. The models module was used as an identifier for applications in many APIs. As the concept of :doc:`Django applications ` matured, this -code showed some shortcomings. It was refactored into an "app registry" where -models modules no longer have a central role models and where it's possible to +code showed some shortcomings. It has been refactored into an "app registry" +where models modules no longer have a central role and where it's possible to attach configuration data to applications. -Not only does this prepare the ground for further improvements, but it also -brings some concrete improvements: +Improvements thus far include: * It is possible to omit ``models.py`` entirely if an application doesn't have any models. From 5d826586578d09d183b8bd0b64571b7cfebe888b Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Wed, 25 Dec 2013 06:02:43 -0500 Subject: [PATCH 051/208] Fixed #21669 -- Typo in docs/ref/forms/fields.txt. Thanks alex_koval for the report. --- docs/ref/forms/fields.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ref/forms/fields.txt b/docs/ref/forms/fields.txt index f2cd122526..62273fd38e 100644 --- a/docs/ref/forms/fields.txt +++ b/docs/ref/forms/fields.txt @@ -936,7 +936,7 @@ Slightly complex built-in ``Field`` classes required=False), ) super(PhoneField, self).__init__( - self, error_messages=error_messages, fields=fields, + error_messages=error_messages, fields=fields, require_all_fields=False, *args, **kwargs) .. attribute:: MultiValueField.widget From e82e7ae1e8b7300017bb390462e5c2f7b48e2cde Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Wed, 25 Dec 2013 06:06:25 -0500 Subject: [PATCH 052/208] Fixed #21663 -- Added missing WSGIPythonPath in mod_wsgi config. Thanks carrie.hazelton at altamiracorp.com for the report. --- docs/howto/deployment/wsgi/apache-auth.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/howto/deployment/wsgi/apache-auth.txt b/docs/howto/deployment/wsgi/apache-auth.txt index 80219ffdf4..98bafad530 100644 --- a/docs/howto/deployment/wsgi/apache-auth.txt +++ b/docs/howto/deployment/wsgi/apache-auth.txt @@ -38,6 +38,7 @@ only authenticated users to be able to view: .. code-block:: apache WSGIScriptAlias / /path/to/mysite.com/mysite/wsgi.py + WSGIPythonPath /path/to/mysite.com WSGIProcessGroup %{GLOBAL} WSGIApplicationGroup django @@ -76,7 +77,6 @@ function: .. code-block:: python import os - import sys os.environ['DJANGO_SETTINGS_MODULE'] = 'mysite.settings' From b798d2bf97a48aac1b0a70e9b3d82457a5212123 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Wed, 25 Dec 2013 09:56:41 -0500 Subject: [PATCH 053/208] Added versionadded annotations for redirect middleware attributes. refs #19321 --- docs/ref/contrib/redirects.txt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/ref/contrib/redirects.txt b/docs/ref/contrib/redirects.txt index e987e3961c..80f0f3bc90 100644 --- a/docs/ref/contrib/redirects.txt +++ b/docs/ref/contrib/redirects.txt @@ -89,6 +89,8 @@ Middleware .. attribute:: response_gone_class + .. versionadded:: 1.7 + The :class:`~django.http.HttpResponse` class used when a :class:`~django.contrib.redirects.models.Redirect` is not found for the requested path or has a blank ``new_path`` @@ -98,6 +100,8 @@ Middleware .. attribute:: response_redirect_class + .. versionadded:: 1.7 + The :class:`~django.http.HttpResponse` class that handles the redirect. From 0dd907562247cbf88092a736b82d7d0c27407328 Mon Sep 17 00:00:00 2001 From: Levi Gross Date: Wed, 25 Dec 2013 12:18:14 -0500 Subject: [PATCH 054/208] Fixed unittest typo --- tests/model_formsets/tests.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/model_formsets/tests.py b/tests/model_formsets/tests.py index ac9d68132e..c1e01cd6be 100644 --- a/tests/model_formsets/tests.py +++ b/tests/model_formsets/tests.py @@ -55,8 +55,8 @@ class DeletionTests(TestCase): 'form-0-name': 'test', 'form-1-id': '', 'form-1-name': 'x' * 1000, # Too long - 'form-1-id': six.text_type(poet.id), # Violate unique constraint - 'form-1-name': 'test2', + 'form-2-id': six.text_type(poet.id), # Violate unique constraint + 'form-2-name': 'test2', } formset = PoetFormSet(data, queryset=Poet.objects.all()) # Make sure this form doesn't pass validation. From 80027d2c38d8980bbe570a62f44e1fd5a7882ae2 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Wed, 25 Dec 2013 14:54:14 -0500 Subject: [PATCH 055/208] Unified listing of shell commands/code - use code-block:: bash - prefix the command with $ --- docs/howto/upgrade-version.txt | 2 +- .../contributing/writing-code/unit-tests.txt | 44 ++++++++++++------- docs/intro/tutorial01.txt | 21 ++++++--- docs/intro/tutorial02.txt | 2 +- docs/ref/django-admin.txt | 4 +- 5 files changed, 45 insertions(+), 28 deletions(-) diff --git a/docs/howto/upgrade-version.txt b/docs/howto/upgrade-version.txt index 34cb3e65d6..82666d677b 100644 --- a/docs/howto/upgrade-version.txt +++ b/docs/howto/upgrade-version.txt @@ -54,7 +54,7 @@ The most convenient way is to use pip_ with the ``--upgrade`` or ``-U`` flag: .. code-block:: bash - pip install -U Django + $ pip install -U Django pip_ also automatically uninstalls the previous version of Django. diff --git a/docs/internals/contributing/writing-code/unit-tests.txt b/docs/internals/contributing/writing-code/unit-tests.txt index 3690264875..d6a031b3ae 100644 --- a/docs/internals/contributing/writing-code/unit-tests.txt +++ b/docs/internals/contributing/writing-code/unit-tests.txt @@ -30,15 +30,17 @@ sample settings module that uses the SQLite database. To run the tests: .. code-block:: bash - git clone git@github.com:django/django.git django-repo - cd django-repo/tests - PYTHONPATH=..:$PYTHONPATH ./runtests.py + $ git clone git@github.com:django/django.git django-repo + $ cd django-repo/tests + $ PYTHONPATH=..:$PYTHONPATH ./runtests.py .. versionchanged:: 1.7 -Older versions of Django required specifying a settings file:: +Older versions of Django required specifying a settings file: - PYTHONPATH=..:$PYTHONPATH python ./runtests.py --settings=test_sqlite +.. code-block:: bash + + $ PYTHONPATH=..:$PYTHONPATH python ./runtests.py --settings=test_sqlite ``runtests.py`` now uses ``test_sqlite`` by default if settings aren't provided through either ``--settings`` or :envvar:`DJANGO_SETTINGS_MODULE`. @@ -111,7 +113,7 @@ internationalization, type: .. code-block:: bash - ./runtests.py --settings=path.to.settings generic_relations i18n + $ ./runtests.py --settings=path.to.settings generic_relations i18n How do you find out the names of individual tests? Look in ``tests/`` — each directory name there is the name of a test. Contrib app names are also valid @@ -123,13 +125,13 @@ of the ``i18n`` module, type: .. code-block:: bash - ./runtests.py --settings=path.to.settings i18n.tests.TranslationTests + $ ./runtests.py --settings=path.to.settings i18n.tests.TranslationTests Going beyond that, you can specify an individual test method like this: .. code-block:: bash - ./runtests.py --settings=path.to.settings i18n.tests.TranslationTests.test_lazy_objects + $ ./runtests.py --settings=path.to.settings i18n.tests.TranslationTests.test_lazy_objects Running the Selenium tests ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -141,7 +143,7 @@ the tests with the ``--selenium`` option: .. code-block:: bash - ./runtests.py --settings=test_sqlite --selenium admin_inlines + $ ./runtests.py --settings=test_sqlite --selenium admin_inlines .. _running-unit-tests-dependencies: @@ -165,9 +167,11 @@ dependencies: You can find these dependencies in `pip requirements files`_ inside the ``tests/requirements`` directory of the Django source tree and install them -like so:: +like so: - pip install -r tests/requirements/py2.txt # Python 3: py3.txt +.. code-block:: bash + + $ pip install -r tests/requirements/py2.txt # Python 3: py3.txt You can also install the database adapter(s) of your choice using ``oracle.txt``, ``mysql.txt``, or ``postgres.txt``. @@ -200,13 +204,17 @@ Contributors are encouraged to run coverage on the test suite to identify areas that need additional tests. The coverage tool installation and use is described in :ref:`testing code coverage`. -To run coverage on the Django test suite using the standard test settings:: +To run coverage on the Django test suite using the standard test settings: - coverage run ./runtests.py --settings=test_sqlite +.. code-block:: bash -After running coverage, generate the html report by running:: + $ coverage run ./runtests.py --settings=test_sqlite - coverage html +After running coverage, generate the html report by running: + +.. code-block:: bash + + $ coverage html When running coverage for the Django tests, the included ``.coveragerc`` settings file defines ``coverage_html`` as the output directory for the report @@ -225,6 +233,8 @@ multiple modules by using a ``tests`` directory in the normal Python way. If you have URLs that need to be mapped, put them in ``tests/urls.py``. To run tests for just one contrib app (e.g. ``auth``), use the same -method as above:: +method as above: - ./runtests.py --settings=settings django.contrib.auth +.. code-block:: bash + + $ ./runtests.py --settings=settings django.contrib.auth diff --git a/docs/intro/tutorial01.txt b/docs/intro/tutorial01.txt index d8e62a70ed..e8b6fc10e0 100644 --- a/docs/intro/tutorial01.txt +++ b/docs/intro/tutorial01.txt @@ -17,7 +17,7 @@ tell Django is installed and which version by running the following command: .. code-block:: bash - python -c "import django; print(django.get_version())" + $ python -c "import django; print(django.get_version())" If Django is installed, you should see the version of your installation. If it isn't, you'll get an error telling "No module named django". @@ -55,7 +55,7 @@ code, then run the following command: .. code-block:: bash - django-admin.py startproject mysite + $ django-admin.py startproject mysite This will create a ``mysite`` directory in your current directory. If it didn't work, see :ref:`troubleshooting-django-admin-py`. @@ -131,8 +131,13 @@ The development server ---------------------- Let's verify this worked. Change into the outer :file:`mysite` directory, if -you haven't already, and run the command ``python manage.py runserver``. You'll -see the following output on the command line: +you haven't already, and run the command: + +.. code-block:: bash + + $ python manage.py runserver + +You'll see the following output on the command line: .. parsed-literal:: @@ -568,9 +573,11 @@ make new ones - it specialises in upgrading your database live, without losing data. We'll cover them in more depth in a later part of the tutorial, but for now, remember the three-step guide to making model changes: -* Change your models (in models.py) -* Run ``python manage.py makemigrations`` to create migrations for those changes -* Run ``python manage.py migrate`` to apply those changes to the database. +* Change your models (in ``models.py``). +* Run :djadmin:`python manage.py makemigrations ` to create + migrations for those changes +* Run :djadmin:`python manage.py migrate ` to apply those changes to + the database. The reason there's separate commands to make and apply migrations is because you'll commit migrations to your version control system and ship them with diff --git a/docs/intro/tutorial02.txt b/docs/intro/tutorial02.txt index b703200428..11c0bece6b 100644 --- a/docs/intro/tutorial02.txt +++ b/docs/intro/tutorial02.txt @@ -469,7 +469,7 @@ template directory in the source code of Django itself .. code-block:: bash - python -c " + $ python -c " import sys sys.path = sys.path[1:] import django diff --git a/docs/ref/django-admin.txt b/docs/ref/django-admin.txt index cac7a5bc22..9a458152c9 100644 --- a/docs/ref/django-admin.txt +++ b/docs/ref/django-admin.txt @@ -38,8 +38,8 @@ Usage .. code-block:: bash - django-admin.py [options] - manage.py [options] + $ django-admin.py [options] + $ manage.py [options] ``command`` should be one of the commands listed in this document. ``options``, which is optional, should be zero or more of the options available From 7df049c417e7d1e538755a7010c57c71ca9d5b5e Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 25 Dec 2013 21:57:52 +0100 Subject: [PATCH 056/208] Swapped app registry and app config API docs. Thanks David Larlet for the suggestion. Also fixed some Sphinx warnings and improved ReST markup. --- docs/ref/applications.txt | 88 +++++++++++++++++++-------------------- docs/ref/settings.txt | 2 +- 2 files changed, 45 insertions(+), 45 deletions(-) diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt index 5d13d0d4d8..a675d55a9d 100644 --- a/docs/ref/applications.txt +++ b/docs/ref/applications.txt @@ -102,47 +102,10 @@ configuration:: Again, defining project-specific configuration classes in a submodule called ``apps`` is a convention, not a requirement. -Application registry -==================== - -.. data:: django.apps.apps - - The application registry provides the following public API. Methods that - aren't listed below are considered private and may change without notice. - -.. method:: django.apps.apps.ready() - - Returns ``True`` if the registry is fully populated. - -.. method:: django.apps.apps.get_app_configs(only_with_models_module=False) - - Returns an iterable of :class:`~django.apps.AppConfig` instances. - - If only applications containing a models module are of interest, this method - can be called with ``only_with_models_module=True``. - -.. method:: django.apps.apps.get_app_config(app_label, only_with_models_module=False) - - Returns an :class:`~django.apps.AppConfig` for the application with the - given ``app_label``. Raises :exc:`~exceptions.LookupError` if no such - application exists. - - If only applications containing a models module are of interest, this method - can be called with ``only_with_models_module=True``. - -.. method:: django.apps.apps.has_app(app_name) - - Checks whether an application with the given name exists in the registry. - ``app_name`` is the full name of the app, e.g. 'django.contrib.admin'. - - Unlike :meth:`~django.apps.apps.get_app_config`, this method can be called - safely at import time. If the registry is still being populated, it may - return ``False``, even though the app will become available later. - Application configuration ========================= -.. class:: django.apps.AppConfig +.. class:: AppConfig Application configuration objects store metadata for an application. Some attributes can be configured in :class:`~django.apps.AppConfig` @@ -151,7 +114,7 @@ Application configuration Configurable attributes ----------------------- -.. data:: django.apps.AppConfig.verbose_name +.. attribute:: AppConfig.verbose_name Human-readable name for the application, e.g. "Admin". @@ -160,17 +123,17 @@ Configurable attributes Read-only attributes -------------------- -.. data:: django.apps.AppConfig.name +.. attribute:: AppConfig.name Full Python path to the application, e.g. ``'django.contrib.admin'``. -.. data:: django.apps.AppConfig.label +.. attribute:: AppConfig.label Last component of the Python path to the application, e.g. ``'admin'``. This value must be unique across a Django project. -.. data:: django.apps.AppConfig.path +.. attribute:: AppConfig.path Filesystem path to the application directory, e.g. ``'/usr/lib/python2.7/dist-packages/django/contrib/admin'``. @@ -178,14 +141,51 @@ Read-only attributes It may be ``None`` if the application isn't stored in a directory, for instance if it's loaded from an egg. -.. data:: django.apps.AppConfig.app_module +.. attribute:: AppConfig.app_module Root module for the application, e.g. ````. -.. data:: django.apps.AppConfig.models_module +.. attribute:: AppConfig.models_module Module containing the models, e.g. ````. It may be ``None`` if the application doesn't contain a ``models`` module. + +Application registry +==================== + +.. data:: apps + + The application registry provides the following public API. Methods that + aren't listed below are considered private and may change without notice. + +.. method:: apps.ready() + + Returns ``True`` if the registry is fully populated. + +.. method:: apps.get_app_configs(only_with_models_module=False) + + Returns an iterable of :class:`~django.apps.AppConfig` instances. + + If only applications containing a models module are of interest, this method + can be called with ``only_with_models_module=True``. + +.. method:: apps.get_app_config(app_label, only_with_models_module=False) + + Returns an :class:`~django.apps.AppConfig` for the application with the + given ``app_label``. Raises :exc:`~exceptions.LookupError` if no such + application exists. + + If only applications containing a models module are of interest, this method + can be called with ``only_with_models_module=True``. + +.. method:: apps.has_app(app_name) + + Checks whether an application with the given name exists in the registry. + ``app_name`` is the full name of the app, e.g. 'django.contrib.admin'. + + Unlike :meth:`~django.apps.apps.get_app_config`, this method can be called + safely at import time. If the registry is still being populated, it may + return ``False``, even though the app will become available later. diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index e9b98fb711..e4dfa7fbfe 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -1288,7 +1288,7 @@ Default: ``()`` (Empty tuple) A tuple of strings designating all applications that are enabled in this Django installation. Each string should be a full Python path to an application configuration class or to a Python package containing a -application. :ref:` Learn more about applications `. +application. :doc:`Learn more about applications `. .. versionchanged:: 1.7 From cb488c5c352ac3388917769db991cb02b07e952f Mon Sep 17 00:00:00 2001 From: Levi Gross Date: Wed, 25 Dec 2013 17:22:13 -0500 Subject: [PATCH 057/208] Removed redundant line --- django/db/backends/oracle/base.py | 1 - 1 file changed, 1 deletion(-) diff --git a/django/db/backends/oracle/base.py b/django/db/backends/oracle/base.py index 6078eecb20..aae3240e12 100644 --- a/django/db/backends/oracle/base.py +++ b/django/db/backends/oracle/base.py @@ -103,7 +103,6 @@ class DatabaseFeatures(BaseDatabaseFeatures): nulls_order_largest = True requires_literal_defaults = True connection_persists_old_columns = True - nulls_order_largest = True closed_cursor_error_class = InterfaceError From 318cdc07dea58bdd21adee838b9ee8ddfdcfaa7c Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Thu, 26 Dec 2013 11:09:58 +0100 Subject: [PATCH 058/208] Added 1.6.2 release note for 542198c1d --- docs/releases/1.6.2.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/releases/1.6.2.txt b/docs/releases/1.6.2.txt index cae18b86fa..fa8bd5bc93 100644 --- a/docs/releases/1.6.2.txt +++ b/docs/releases/1.6.2.txt @@ -9,4 +9,5 @@ This is Django 1.6.2, a bugfix release for Django 1.6. Bug fixes ========= -... +* Prevented the base geometry object of a prepared geometry to be garbage + collected, which could lead to crash Django (#21662). From 398642fd9b6e9b4d83baed7b9708ca0cd942540b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=20L=C3=B8nne?= Date: Wed, 18 Dec 2013 20:04:53 +0100 Subject: [PATCH 059/208] Fixed #21627 -- Added unicode_literals to changepassword command. Fixed a crash when executing changepassword command when the user object representation contained non-ASCII characters. --- .../auth/management/commands/changepassword.py | 2 ++ django/contrib/auth/tests/test_management.py | 12 ++++++++++++ docs/releases/1.6.2.txt | 3 +++ 3 files changed, 17 insertions(+) diff --git a/django/contrib/auth/management/commands/changepassword.py b/django/contrib/auth/management/commands/changepassword.py index 32a5373fb0..e333cafb04 100644 --- a/django/contrib/auth/management/commands/changepassword.py +++ b/django/contrib/auth/management/commands/changepassword.py @@ -1,3 +1,5 @@ +from __future__ import unicode_literals + import getpass from optparse import make_option diff --git a/django/contrib/auth/tests/test_management.py b/django/contrib/auth/tests/test_management.py index 838c8650fc..c332125ce8 100644 --- a/django/contrib/auth/tests/test_management.py +++ b/django/contrib/auth/tests/test_management.py @@ -82,6 +82,18 @@ class ChangepasswordManagementCommandTestCase(TestCase): with self.assertRaises(CommandError): command.execute("joe", stdout=self.stdout, stderr=self.stderr) + def test_that_changepassword_command_works_with_nonascii_output(self): + """ + #21627 -- Executing the changepassword management command should allow + non-ASCII characters from the User object representation. + """ + # 'Julia' with accented 'u': + models.User.objects.create_user(username='J\xfalia', password='qwerty') + + command = changepassword.Command() + command._get_pass = lambda *args: 'not qwerty' + + command.execute("J\xfalia", stdout=self.stdout) @skipIfCustomUser class CreatesuperuserManagementCommandTestCase(TestCase): diff --git a/docs/releases/1.6.2.txt b/docs/releases/1.6.2.txt index fa8bd5bc93..41bc86e906 100644 --- a/docs/releases/1.6.2.txt +++ b/docs/releases/1.6.2.txt @@ -11,3 +11,6 @@ Bug fixes * Prevented the base geometry object of a prepared geometry to be garbage collected, which could lead to crash Django (#21662). + +* Fixed a crash when executing the :djadmin:`changepassword` command when the + user object representation contained non-ASCII characters (#21627). From 4e7aa573ec3b9c8e0784db9013dbc31b6c3eaac5 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Thu, 26 Dec 2013 07:52:31 -0500 Subject: [PATCH 060/208] Added missing newline in previous commit. --- django/contrib/auth/tests/test_management.py | 1 + 1 file changed, 1 insertion(+) diff --git a/django/contrib/auth/tests/test_management.py b/django/contrib/auth/tests/test_management.py index c332125ce8..db4b698d8b 100644 --- a/django/contrib/auth/tests/test_management.py +++ b/django/contrib/auth/tests/test_management.py @@ -95,6 +95,7 @@ class ChangepasswordManagementCommandTestCase(TestCase): command.execute("J\xfalia", stdout=self.stdout) + @skipIfCustomUser class CreatesuperuserManagementCommandTestCase(TestCase): From 8f04f53dd847896f49a9bc367bb7269984ebdb6e Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 26 Dec 2013 13:46:15 +0100 Subject: [PATCH 061/208] Removed a few gratuitous lambdas. --- django/contrib/admin/options.py | 7 +++++-- django/contrib/admin/templatetags/admin_list.py | 2 +- django/contrib/auth/forms.py | 6 +++++- django/contrib/messages/storage/__init__.py | 14 +++++++++----- django/db/models/options.py | 8 +++----- django/utils/text.py | 10 ++++++++++ tests/runtests.py | 10 ++++------ 7 files changed, 37 insertions(+), 20 deletions(-) diff --git a/django/contrib/admin/options.py b/django/contrib/admin/options.py index 02f9ed3a84..263d1f4a87 100644 --- a/django/contrib/admin/options.py +++ b/django/contrib/admin/options.py @@ -46,9 +46,12 @@ from django.views.decorators.csrf import csrf_protect IS_POPUP_VAR = '_popup' TO_FIELD_VAR = '_to_field' + HORIZONTAL, VERTICAL = 1, 2 -# returns the
    class for a given radio_admin field -get_ul_class = lambda x: 'radiolist%s' % (' inline' if x == HORIZONTAL else '') + + +def get_ul_class(radio_style): + return 'radiolist' if radio_style == VERTICAL else 'radiolist inline' class IncorrectLookupParameters(Exception): diff --git a/django/contrib/admin/templatetags/admin_list.py b/django/contrib/admin/templatetags/admin_list.py index 0181f665ad..42ab18007e 100644 --- a/django/contrib/admin/templatetags/admin_list.py +++ b/django/contrib/admin/templatetags/admin_list.py @@ -333,7 +333,7 @@ def date_hierarchy(cl): month_lookup = cl.params.get(month_field) day_lookup = cl.params.get(day_field) - link = lambda d: cl.get_query_string(d, [field_generic]) + link = lambda filters: cl.get_query_string(filters, [field_generic]) if not (year_lookup or month_lookup or day_lookup): # select appropriate start level diff --git a/django/contrib/auth/forms.py b/django/contrib/auth/forms.py index e3c139a5fd..459a42febb 100644 --- a/django/contrib/auth/forms.py +++ b/django/contrib/auth/forms.py @@ -21,7 +21,11 @@ from django.contrib.sites.models import get_current_site UNMASKED_DIGITS_TO_SHOW = 6 -mask_password = lambda p: "%s%s" % (p[:UNMASKED_DIGITS_TO_SHOW], "*" * max(len(p) - UNMASKED_DIGITS_TO_SHOW, 0)) + +def mask_password(password): + shown = password[:UNMASKED_DIGITS_TO_SHOW] + masked = "*" * max(len(password) - UNMASKED_DIGITS_TO_SHOW, 0) + return shown + masked class ReadOnlyPasswordHashWidget(forms.Widget): diff --git a/django/contrib/messages/storage/__init__.py b/django/contrib/messages/storage/__init__.py index 9a09aff007..591ae14d7c 100644 --- a/django/contrib/messages/storage/__init__.py +++ b/django/contrib/messages/storage/__init__.py @@ -1,8 +1,12 @@ from django.conf import settings -from django.utils.module_loading import import_by_path as get_storage +from django.utils.module_loading import import_by_path -# Callable with the same interface as the storage classes i.e. accepts a -# 'request' object. It is wrapped in a lambda to stop 'settings' being used at -# the module level -default_storage = lambda request: get_storage(settings.MESSAGE_STORAGE)(request) +def default_storage(request): + """ + Callable with the same interface as the storage classes. + + This isn't just default_storage = import_by_path(settings.MESSAGE_STORAGE) + to avoid accessing the settings at the module level. + """ + return import_by_path(settings.MESSAGE_STORAGE)(request) diff --git a/django/db/models/options.py b/django/db/models/options.py index 1186d3b50a..4c5519441e 100644 --- a/django/db/models/options.py +++ b/django/db/models/options.py @@ -1,8 +1,7 @@ from __future__ import unicode_literals -from collections import OrderedDict -import re from bisect import bisect +from collections import OrderedDict import warnings from django.apps import apps @@ -13,10 +12,9 @@ from django.db.models.fields.proxy import OrderWrt from django.utils import six from django.utils.functional import cached_property from django.utils.encoding import force_text, smart_text, python_2_unicode_compatible +from django.utils.text import camel_case_to_spaces from django.utils.translation import activate, deactivate_all, get_language, string_concat -# Calculate the verbose_name by converting from InitialCaps to "lowercase with spaces". -get_verbose_name = lambda class_name: re.sub('(((?<=[a-z])[A-Z])|([A-Z](?![A-Z]|$)))', ' \\1', class_name).lower().strip() DEFAULT_NAMES = ('verbose_name', 'verbose_name_plural', 'db_table', 'ordering', 'unique_together', 'permissions', 'get_latest_by', @@ -109,7 +107,7 @@ class Options(object): # First, construct the default values for these options. self.object_name = cls.__name__ self.model_name = self.object_name.lower() - self.verbose_name = get_verbose_name(self.object_name) + self.verbose_name = camel_case_to_spaces(self.object_name) # Store the original user-defined values for each option, # for use when serializing the model definition diff --git a/django/utils/text.py b/django/utils/text.py index f44a364f5f..f52050cccc 100644 --- a/django/utils/text.py +++ b/django/utils/text.py @@ -17,6 +17,7 @@ if six.PY2: # people rely on it being here. from django.utils.encoding import force_unicode # NOQA + # Capitalizes the first letter of a string. capfirst = lambda x: x and force_text(x)[0].upper() + force_text(x)[1:] capfirst = allow_lazy(capfirst, six.text_type) @@ -25,6 +26,7 @@ capfirst = allow_lazy(capfirst, six.text_type) re_words = re.compile(r'<.*?>|((?:\w[-\w]*|&.*?;)+)', re.U | re.S) re_tag = re.compile(r'<(/)?([^ ]+?)(?:(\s*/)| .*?)?>', re.S) re_newlines = re.compile(r'\r\n|\r') # Used in normalize_newlines +re_camel_case = re.compile(r'(((?<=[a-z])[A-Z])|([A-Z](?![A-Z]|$)))') def wrap(text, width): @@ -420,3 +422,11 @@ def slugify(value): value = re.sub('[^\w\s-]', '', value).strip().lower() return mark_safe(re.sub('[-\s]+', '-', value)) slugify = allow_lazy(slugify, six.text_type) + + +def camel_case_to_spaces(value): + """ + Splits CamelCase and converts to lower case. Also strips leading and + trailing whitespace. + """ + return re_camel_case.sub(r' \1', value).strip().lower() diff --git a/tests/runtests.py b/tests/runtests.py index 5f39eef400..3998a7bf92 100755 --- a/tests/runtests.py +++ b/tests/runtests.py @@ -154,12 +154,10 @@ def setup(verbosity, test_labels): if not test_labels: module_found_in_labels = True else: - match = lambda label: ( - module_label == label or # exact match - module_label.startswith(label + '.') # ancestor match - ) - - module_found_in_labels = any(match(l) for l in test_labels_set) + module_found_in_labels = any( + # exact match or ancestor match + module_label == label or module_label.startswith(label + '.') + for label in test_labels_set) if module_found_in_labels: if verbosity >= 2: From 922430177ccdaed2561ec442a76de3eb89ae88a0 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 26 Dec 2013 14:12:30 +0100 Subject: [PATCH 062/208] Beefed up the comments for AppConfig.all_models. --- django/apps/base.py | 7 ++++--- django/apps/registry.py | 10 +++++++--- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/django/apps/base.py b/django/apps/base.py index f1baaa5adf..5d2cfd88a7 100644 --- a/django/apps/base.py +++ b/django/apps/base.py @@ -96,9 +96,10 @@ class AppConfig(object): return cls(entry) def import_models(self, all_models): - # Dictionary of models for this app, stored in the 'all_models' - # attribute of the Apps this AppConfig is attached to. Injected as a - # parameter because it may get populated before this method has run. + # Dictionary of models for this app, primarily maintained in the + # 'all_models' attribute of the Apps this AppConfig is attached to. + # Injected as a parameter because it gets populated when models are + # imported, which may happen before populate_models() runs. self.models = all_models if module_has_submodule(self.app_module, MODELS_MODULE_NAME): diff --git a/django/apps/registry.py b/django/apps/registry.py index bedd8cdb02..2a09513152 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -32,9 +32,13 @@ class Apps(object): # get_model[s]. self.master = master - # Mapping of app labels => model names => model classes. Used to - # register models before the registry is populated and also for - # applications that aren't installed. + # Mapping of app labels => model names => model classes. Every time a + # model is imported, ModelBase.__new__ calls apps.register_model which + # creates an entry in all_models. All imported models are registered, + # regardless of whether they're defined in an installed application + # and whether the registry has been populated. Since it isn't possible + # to reimport a module safely (it could reexecute initialization code) + # all_models is never overridden or reset. self.all_models = defaultdict(OrderedDict) # Mapping of labels to AppConfig instances for installed apps. From 52325b0a04cf1fcf444cece197585a35cf65bab9 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 26 Dec 2013 15:04:58 +0100 Subject: [PATCH 063/208] Turned apps.ready into a property. Added tests. --- django/apps/registry.py | 7 ++++--- django/db/models/options.py | 4 ++-- tests/apps/tests.py | 30 +++++++++++++++++++++++------- 3 files changed, 29 insertions(+), 12 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index 2a09513152..e39fb43fa4 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -138,9 +138,10 @@ class Apps(object): self.get_models.cache_clear() self._models_loaded = True + @property def ready(self): """ - Returns True if the registry is fully populated. + Whether the registry is fully populated. Useful for code that wants to cache the results of get_models() for themselves once it is safe to do so. @@ -378,9 +379,9 @@ class Apps(object): def app_cache_ready(self): warnings.warn( - "app_cache_ready() is deprecated.", + "app_cache_ready() is deprecated in favor of the ready property.", PendingDeprecationWarning, stacklevel=2) - return self.ready() + return self.ready def get_app(self, app_label): """ diff --git a/django/db/models/options.py b/django/db/models/options.py index 4c5519441e..f50c639975 100644 --- a/django/db/models/options.py +++ b/django/db/models/options.py @@ -438,7 +438,7 @@ class Options(object): if hasattr(f, 'related'): cache[f.name] = cache[f.attname] = ( f.related, None if f.model == self.model else f.model, True, False) - if apps.ready(): + if apps.ready: self._name_map = cache return cache @@ -564,7 +564,7 @@ class Options(object): and not isinstance(f.rel.to, six.string_types) and self == f.rel.to._meta): cache[f.related] = None - if apps.ready(): + if apps.ready: self._related_many_to_many_cache = cache return cache diff --git a/tests/apps/tests.py b/tests/apps/tests.py index c38d16f8bb..a14199d41c 100644 --- a/tests/apps/tests.py +++ b/tests/apps/tests.py @@ -10,6 +10,29 @@ from .models import TotallyNormal, SoAlternative, new_apps class AppsTests(TestCase): + def test_singleton_master(self): + """ + Ensures that only one master registry can exist. + """ + with self.assertRaises(RuntimeError): + Apps(master=True) + + def test_ready(self): + """ + Tests the ready property of the master registry. + """ + # The master app registry is always ready when the tests run. + self.assertTrue(apps.ready) + + def test_non_master_ready(self): + """ + Tests the ready property of a registry other than the master. + """ + apps = Apps() + # Currently, non-master app registries are artificially considered + # ready regardless of whether populate_models() has run. + self.assertTrue(apps.ready) + def test_models_py(self): """ Tests that the models in the models.py file were loaded correctly. @@ -42,10 +65,3 @@ class AppsTests(TestCase): apps.get_models(apps.get_app_config("apps").models_module), ) self.assertEqual(new_apps.get_model("apps", "SouthPonies"), temp_model) - - def test_singleton_master(self): - """ - Ensures that only one master registry can exist. - """ - with self.assertRaises(RuntimeError): - Apps(master=True) From aef019de6113e6c750e3ba49dc1e9f2a179eb0ca Mon Sep 17 00:00:00 2001 From: Preston Timmons Date: Mon, 16 Dec 2013 10:04:28 -0600 Subject: [PATCH 064/208] Fixed #21206 -- No longer run discovery if the test label doesn't point to a package or directory. Thanks thepapermen for the report and Carl Meyer for the review. --- django/test/runner.py | 21 +++++++++++++--- tests/test_discovery_sample/empty.py | 0 tests/test_discovery_sample/tests_sample.py | 4 +++ tests/test_runner/test_discover_runner.py | 28 +++++++++++++++++++++ 4 files changed, 50 insertions(+), 3 deletions(-) create mode 100644 tests/test_discovery_sample/empty.py diff --git a/django/test/runner.py b/django/test/runner.py index 21e4a81604..d8994d5ec2 100644 --- a/django/test/runner.py +++ b/django/test/runner.py @@ -1,3 +1,4 @@ +from importlib import import_module import os from optparse import make_option import unittest @@ -89,11 +90,11 @@ class DiscoverRunner(object): break kwargs['top_level_dir'] = top_level - if not (tests and tests.countTestCases()): - # if no tests found, it's probably a package; try discovery + if not (tests and tests.countTestCases()) and is_discoverable(label): + # Try discovery if path is a package or directory tests = self.test_loader.discover(start_dir=label, **kwargs) - # make unittest forget the top-level dir it calculated from this + # Make unittest forget the top-level dir it calculated from this # run, to support running tests from two different top-levels. self.test_loader._top_level_dir = None @@ -150,6 +151,20 @@ class DiscoverRunner(object): return self.suite_result(suite, result) +def is_discoverable(label): + """ + Check if a test label points to a python package or file directory. + """ + try: + mod = import_module(label) + except ImportError: + pass + else: + return hasattr(mod, '__path__') + + return os.path.isdir(os.path.abspath(label)) + + def dependency_ordered(test_databases, dependencies): """ Reorder test_databases into an order that honors the dependencies diff --git a/tests/test_discovery_sample/empty.py b/tests/test_discovery_sample/empty.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/tests/test_discovery_sample/tests_sample.py b/tests/test_discovery_sample/tests_sample.py index fb1e14c715..d538771b0f 100644 --- a/tests/test_discovery_sample/tests_sample.py +++ b/tests/test_discovery_sample/tests_sample.py @@ -13,3 +13,7 @@ class TestDjangoTestCase(DjangoTestCase): def test_sample(self): self.assertEqual(1, 1) + + +class EmptyTestCase(TestCase): + pass diff --git a/tests/test_runner/test_discover_runner.py b/tests/test_runner/test_discover_runner.py index d577f26826..fd68949678 100644 --- a/tests/test_runner/test_discover_runner.py +++ b/tests/test_runner/test_discover_runner.py @@ -68,6 +68,34 @@ class DiscoverRunnerTest(TestCase): self.assertEqual(count, 3) + def test_empty_test_case(self): + count = DiscoverRunner().build_suite( + ["test_discovery_sample.tests_sample.EmptyTestCase"], + ).countTestCases() + + self.assertEqual(count, 0) + + def test_discovery_on_package(self): + count = DiscoverRunner().build_suite( + ["test_discovery_sample.tests"], + ).countTestCases() + + self.assertEqual(count, 1) + + def test_ignore_adjacent(self): + """ + When given a dotted path to a module, unittest discovery searches + not just the module, but also the directory containing the module. + + This results in tests from adjacent modules being run when they + should not. The discover runner avoids this behavior. + """ + count = DiscoverRunner().build_suite( + ["test_discovery_sample.empty"], + ).countTestCases() + + self.assertEqual(count, 0) + def test_overrideable_test_suite(self): self.assertEqual(DiscoverRunner().test_suite, TestSuite) From 8925aaf61304c22f5ba86dad5d6b15c277b33cfb Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 26 Dec 2013 18:03:17 +0100 Subject: [PATCH 065/208] Added basic tests for get_app_config[s]. --- tests/apps/models.py | 3 ++ tests/apps/tests.py | 73 +++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 72 insertions(+), 4 deletions(-) diff --git a/tests/apps/models.py b/tests/apps/models.py index c3f764a70b..a7a9b691c3 100644 --- a/tests/apps/models.py +++ b/tests/apps/models.py @@ -1,6 +1,9 @@ +from __future__ import unicode_literals + from django.apps.registry import Apps from django.db import models + # We're testing app registry presence on load, so this is handy. new_apps = Apps() diff --git a/tests/apps/tests.py b/tests/apps/tests.py index a14199d41c..a597bc955b 100644 --- a/tests/apps/tests.py +++ b/tests/apps/tests.py @@ -1,13 +1,33 @@ -from __future__ import absolute_import +from __future__ import absolute_import, unicode_literals from django.apps import apps from django.apps.registry import Apps +from django.conf import settings from django.db import models -from django.test import TestCase +from django.test import TestCase, override_settings from .models import TotallyNormal, SoAlternative, new_apps +# Small list with a variety of cases for tests that iterate on installed apps. +# Intentionally not in alphabetical order to check if the order is preserved. + +SOME_INSTALLED_APPS = [ + 'apps.apps.MyAdmin', + 'apps.apps.MyAuth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', +] + +SOME_INSTALLED_APPS_NAMES = [ + 'django.contrib.admin', + 'django.contrib.auth', +] + SOME_INSTALLED_APPS[2:] + +SOME_INSTALLED_APPS_WTH_MODELS_NAMES = SOME_INSTALLED_APPS_NAMES[:4] + class AppsTests(TestCase): def test_singleton_master(self): @@ -33,6 +53,51 @@ class AppsTests(TestCase): # ready regardless of whether populate_models() has run. self.assertTrue(apps.ready) + @override_settings(INSTALLED_APPS=SOME_INSTALLED_APPS) + def test_get_app_configs(self): + """ + Tests get_app_configs(). + """ + app_configs = apps.get_app_configs() + self.assertListEqual( + [app_config.name for app_config in app_configs], + SOME_INSTALLED_APPS_NAMES) + + @override_settings(INSTALLED_APPS=SOME_INSTALLED_APPS) + def test_get_app_configs_with_models(self): + """ + Tests get_app_configs(only_with_models_module=True). + """ + app_configs = apps.get_app_configs(only_with_models_module=True) + self.assertListEqual( + [app_config.name for app_config in app_configs], + SOME_INSTALLED_APPS_WTH_MODELS_NAMES) + + @override_settings(INSTALLED_APPS=SOME_INSTALLED_APPS) + def test_get_app_config(self): + """ + Tests get_app_config(). + """ + app_config = apps.get_app_config('admin') + self.assertEqual(app_config.name, 'django.contrib.admin') + + app_config = apps.get_app_config('staticfiles') + self.assertEqual(app_config.name, 'django.contrib.staticfiles') + + with self.assertRaises(LookupError): + apps.get_app_config('webdesign') + + @override_settings(INSTALLED_APPS=SOME_INSTALLED_APPS) + def test_get_app_config_with_models(self): + """ + Tests get_app_config(only_with_models_module=True). + """ + app_config = apps.get_app_config('admin', only_with_models_module=True) + self.assertEqual(app_config.name, 'django.contrib.admin') + + with self.assertRaises(LookupError): + apps.get_app_config('staticfiles', only_with_models_module=True) + def test_models_py(self): """ Tests that the models in the models.py file were loaded correctly. @@ -55,10 +120,10 @@ class AppsTests(TestCase): 'app_label': "apps", 'apps': new_apps, } - meta = type("Meta", tuple(), meta_contents) + meta = type(str("Meta"), tuple(), meta_contents) body['Meta'] = meta body['__module__'] = TotallyNormal.__module__ - temp_model = type("SouthPonies", (models.Model,), body) + temp_model = type(str("SouthPonies"), (models.Model,), body) # Make sure it appeared in the right place! self.assertEqual( old_models, From fec5330c7937efe30294d060a57af6400ce073a9 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 26 Dec 2013 18:37:04 +0100 Subject: [PATCH 066/208] Made unset_installed_apps reset the app registry state. Previously the _apps/models_loaded flags could remain set to False if set_installed_apps exited with an exception, which is going to happen as soon as we add tests for invalid values of INSTALLED_APPS. --- django/apps/registry.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index e39fb43fa4..737fc960b8 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -346,7 +346,7 @@ class Apps(object): imports safely (eg. that could lead to registering listeners twice), models are registered when they're imported and never removed. """ - self.stored_app_configs.append(self.app_configs) + self.stored_app_configs.append((self.app_configs, self._apps_loaded, self._models_loaded)) self.app_configs = OrderedDict() self.get_models.cache_clear() self._apps_loaded = False @@ -358,7 +358,7 @@ class Apps(object): """ Cancels a previous call to set_installed_apps(). """ - self.app_configs = self.stored_app_configs.pop() + self.app_configs, self._apps_loaded, self._models_loaded = self.stored_app_configs.pop() self.get_models.cache_clear() ### DEPRECATED METHODS GO BELOW THIS LINE ### From ce1bc2c94b30a42a2c7c0d58e6cb6d8875cadf60 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 26 Dec 2013 18:40:28 +0100 Subject: [PATCH 067/208] Made the AppConfig API marginally more consistent. Eliminated the app_ prefix that was more confusing than useful. --- django/apps/base.py | 17 ++++++++++------- django/contrib/comments/__init__.py | 2 +- django/core/management/commands/migrate.py | 2 +- django/test/simple.py | 2 +- django/utils/module_loading.py | 2 +- docs/ref/applications.txt | 2 +- 6 files changed, 15 insertions(+), 12 deletions(-) diff --git a/django/apps/base.py b/django/apps/base.py index 5d2cfd88a7..3f9f2d9bcd 100644 --- a/django/apps/base.py +++ b/django/apps/base.py @@ -13,13 +13,13 @@ class AppConfig(object): Class representing a Django application and its configuration. """ - def __init__(self, app_name): + def __init__(self, app_name, app_module): # Full Python path to the application eg. 'django.contrib.admin'. self.name = app_name # Root module for the application eg. . - self.app_module = import_module(app_name) + self.module = app_module # The following attributes could be defined at the class level in a # subclass, hence the test-and-set pattern. @@ -39,7 +39,7 @@ class AppConfig(object): # egg. Otherwise it's a unicode on Python 2 and a str on Python 3. if not hasattr(self, 'path'): try: - self.path = upath(self.app_module.__path__[0]) + self.path = upath(app_module.__path__[0]) except AttributeError: self.path = None @@ -63,7 +63,7 @@ class AppConfig(object): try: # If import_module succeeds, entry is a path to an app module. # Otherwise, entry is a path to an app config class or an error. - import_module(entry) + module = import_module(entry) except ImportError: # Raise the original exception when entry cannot be a path to an @@ -88,12 +88,15 @@ class AppConfig(object): raise ImproperlyConfigured( "%r must supply a name attribute." % entry) + # Ensure app_names points to a valid module. + app_module = import_module(app_name) + # Entry is a path to an app config class. - return cls(app_name) + return cls(app_name, app_module) else: # Entry is a path to an app module. - return cls(entry) + return cls(entry, module) def import_models(self, all_models): # Dictionary of models for this app, primarily maintained in the @@ -102,6 +105,6 @@ class AppConfig(object): # imported, which may happen before populate_models() runs. self.models = all_models - if module_has_submodule(self.app_module, MODELS_MODULE_NAME): + if module_has_submodule(self.module, MODELS_MODULE_NAME): models_module_name = '%s.%s' % (self.name, MODELS_MODULE_NAME) self.models_module = import_module(models_module_name) diff --git a/django/contrib/comments/__init__.py b/django/contrib/comments/__init__.py index a6286b48ed..19dd7ef9a1 100644 --- a/django/contrib/comments/__init__.py +++ b/django/contrib/comments/__init__.py @@ -20,7 +20,7 @@ def get_comment_app(): except LookupError: raise ImproperlyConfigured("The COMMENTS_APP (%r) " "must be in INSTALLED_APPS" % settings.COMMENTS_APP) - return app_config.app_module + return app_config.module def get_comment_app_name(): """ diff --git a/django/core/management/commands/migrate.py b/django/core/management/commands/migrate.py index 1f5e9619c7..1c808f1c7e 100644 --- a/django/core/management/commands/migrate.py +++ b/django/core/management/commands/migrate.py @@ -47,7 +47,7 @@ class Command(BaseCommand): # Import the 'management' module within each installed app, to register # dispatcher events. for app_config in apps.get_app_configs(): - if module_has_submodule(app_config.app_module, "management"): + if module_has_submodule(app_config.module, "management"): import_module('.management', app_config.name) # Get the database we're operating from diff --git a/django/test/simple.py b/django/test/simple.py index fa70738447..5f33044de6 100644 --- a/django/test/simple.py +++ b/django/test/simple.py @@ -102,7 +102,7 @@ def get_tests(app_config): except ImportError: # Couldn't import tests.py. Was it due to a missing file, or # due to an import error in a tests.py that actually exists? - if not module_has_submodule(app_config.app_module, TEST_MODULE): + if not module_has_submodule(app_config.module, TEST_MODULE): test_module = None else: # The module exists, so there must be an import error in the test diff --git a/django/utils/module_loading.py b/django/utils/module_loading.py index 1ed7d93e31..bd012cd55b 100644 --- a/django/utils/module_loading.py +++ b/django/utils/module_loading.py @@ -80,7 +80,7 @@ def autodiscover_modules(*args, **kwargs): # Decide whether to bubble up this error. If the app just # doesn't have an admin module, we can ignore the error # attempting to import it, otherwise we want it to bubble up. - if module_has_submodule(app_config.app_module, module_to_search): + if module_has_submodule(app_config.module, module_to_search): raise diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt index a675d55a9d..15cc481f51 100644 --- a/docs/ref/applications.txt +++ b/docs/ref/applications.txt @@ -141,7 +141,7 @@ Read-only attributes It may be ``None`` if the application isn't stored in a directory, for instance if it's loaded from an egg. -.. attribute:: AppConfig.app_module +.. attribute:: AppConfig.module Root module for the application, e.g. ````. From b355e98a5091a76ad4b8657a6a971e7e0595aa26 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 26 Dec 2013 19:05:45 +0100 Subject: [PATCH 068/208] Normalized exceptions raised by AppConfig.create. It raises ImportError whenever an entry in INSTALLED_APPS points (directly or indirectly via AppConfig.name) to a non-existing module and ImproperlyConfigured in all other cases. Catching ImportError and re-raising ImproperlyConfigured tends to make circular imports more difficult to diagnose. --- django/apps/base.py | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/django/apps/base.py b/django/apps/base.py index 3f9f2d9bcd..4102780560 100644 --- a/django/apps/base.py +++ b/django/apps/base.py @@ -1,7 +1,7 @@ from importlib import import_module from django.core.exceptions import ImproperlyConfigured -from django.utils.module_loading import import_by_path, module_has_submodule +from django.utils.module_loading import module_has_submodule from django.utils._os import upath @@ -66,13 +66,24 @@ class AppConfig(object): module = import_module(entry) except ImportError: + # Avoid django.utils.module_loading.import_by_path because it + # masks errors -- it reraises ImportError as ImproperlyConfigured. + mod_path, _, cls_name = entry.rpartition('.') + # Raise the original exception when entry cannot be a path to an - # app config class. Since module names are allowable here, the - # standard exception message from import_by_path is unsuitable. - if '.' not in entry: + # app config class. + if not mod_path: raise - cls = import_by_path(entry) + mod = import_module(mod_path) + try: + cls = getattr(mod, cls_name) + except AttributeError: + # Emulate the error that "from import " + # would raise when exists but not , with + # more context (Python just says "cannot import name ..."). + raise ImportError( + "cannot import name %r from %r" % (cls_name, mod_path)) # Check for obvious errors. (This check prevents duck typing, but # it could be removed if it became a problem in practice.) From e179291fa58b08c6e52cceb1590666fbcca8f363 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 26 Dec 2013 19:20:38 +0100 Subject: [PATCH 069/208] Added tests for invalid values of INSTALLED_APPS. --- tests/apps/tests.py | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/tests/apps/tests.py b/tests/apps/tests.py index a597bc955b..53afd8e8e9 100644 --- a/tests/apps/tests.py +++ b/tests/apps/tests.py @@ -3,6 +3,7 @@ from __future__ import absolute_import, unicode_literals from django.apps import apps from django.apps.registry import Apps from django.conf import settings +from django.core.exceptions import ImproperlyConfigured from django.db import models from django.test import TestCase, override_settings @@ -28,6 +29,7 @@ SOME_INSTALLED_APPS_NAMES = [ SOME_INSTALLED_APPS_WTH_MODELS_NAMES = SOME_INSTALLED_APPS_NAMES[:4] + class AppsTests(TestCase): def test_singleton_master(self): @@ -53,6 +55,38 @@ class AppsTests(TestCase): # ready regardless of whether populate_models() has run. self.assertTrue(apps.ready) + def test_bad_app_config(self): + """ + Tests when INSTALLED_APPS contains an incorrect app config. + """ + with self.assertRaises(ImproperlyConfigured): + with self.settings(INSTALLED_APPS=['apps.apps.BadConfig']): + pass + + def test_not_an_app_config(self): + """ + Tests when INSTALLED_APPS contains a class that isn't an app config. + """ + with self.assertRaises(ImproperlyConfigured): + with self.settings(INSTALLED_APPS=['apps.apps.NotAConfig']): + pass + + def test_no_such_app(self): + """ + Tests when INSTALLED_APPS contains an app config for an app that doesn't exist. + """ + with self.assertRaises(ImportError): + with self.settings(INSTALLED_APPS=['apps.apps.NoSuchApp']): + pass + + def test_no_such_app_config(self): + """ + Tests when INSTALLED_APPS contains an entry that doesn't exist. + """ + with self.assertRaises(ImportError): + with self.settings(INSTALLED_APPS=['apps.apps.NoSuchConfig']): + pass + @override_settings(INSTALLED_APPS=SOME_INSTALLED_APPS) def test_get_app_configs(self): """ From cfbdd587f6964f65fd8b7de049227fa1ead858da Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 26 Dec 2013 19:29:32 +0100 Subject: [PATCH 070/208] Added file forgotten in previous commit, plus one more test. --- tests/apps/apps.py | 27 +++++++++++++++++++++++++++ tests/apps/tests.py | 6 +++++- 2 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 tests/apps/apps.py diff --git a/tests/apps/apps.py b/tests/apps/apps.py new file mode 100644 index 0000000000..2012a34fd4 --- /dev/null +++ b/tests/apps/apps.py @@ -0,0 +1,27 @@ +from __future__ import unicode_literals + +from django.apps import AppConfig + + +class MyAdmin(AppConfig): + name = 'django.contrib.admin' + verbose_name = "Admin sweet admin." + + +class MyAuth(AppConfig): + name = 'django.contrib.auth' + verbose_name = "All your password are belong to us." + + +class BadConfig(AppConfig): + """This class doesn't supply the mandatory 'name' attribute.""" + + +class NotAConfig(object): + name = 'apps' + + +class NoSuchApp(AppConfig): + name = 'there is no such app' + + diff --git a/tests/apps/tests.py b/tests/apps/tests.py index 53afd8e8e9..c743ba04a3 100644 --- a/tests/apps/tests.py +++ b/tests/apps/tests.py @@ -73,8 +73,12 @@ class AppsTests(TestCase): def test_no_such_app(self): """ - Tests when INSTALLED_APPS contains an app config for an app that doesn't exist. + Tests when INSTALLED_APPS contains an app that doesn't exist, either + directly or via an app config. """ + with self.assertRaises(ImportError): + with self.settings(INSTALLED_APPS=['there is no such app']): + pass with self.assertRaises(ImportError): with self.settings(INSTALLED_APPS=['apps.apps.NoSuchApp']): pass From d430f1d98b564543d1c90d067efdf1ee6851d8d3 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Thu, 26 Dec 2013 13:41:03 -0500 Subject: [PATCH 071/208] Fixed #21609 -- Amended CONTRIBUTING.rst pull request guidelines. Thanks cjerdonek for the suggestion. --- CONTRIBUTING.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 1563c25043..4a5887b117 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -15,7 +15,8 @@ Extensive contribution guidelines are available in the repository at https://docs.djangoproject.com/en/dev/internals/contributing/ -**Warning: pull requests are ignored!** `File a ticket`__ to suggest changes. +**Warning: non-trivial pull requests (anything more than fixing a typo) without +Trac tickets will be closed!** `Please file a ticket`__ to suggest changes. __ https://code.djangoproject.com/newticket From 8779aa806e6b5442e60c111f9d5d6874a026e001 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 26 Dec 2013 20:04:06 +0100 Subject: [PATCH 072/208] Added a test for Apps.has_app. --- tests/apps/tests.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/tests/apps/tests.py b/tests/apps/tests.py index c743ba04a3..a516b6e662 100644 --- a/tests/apps/tests.py +++ b/tests/apps/tests.py @@ -136,6 +136,12 @@ class AppsTests(TestCase): with self.assertRaises(LookupError): apps.get_app_config('staticfiles', only_with_models_module=True) + @override_settings(INSTALLED_APPS=SOME_INSTALLED_APPS) + def test_has_app(self): + self.assertTrue(apps.has_app('django.contrib.admin')) + self.assertTrue(apps.has_app('django.contrib.staticfiles')) + self.assertFalse(apps.has_app('django.contrib.webdesign')) + def test_models_py(self): """ Tests that the models in the models.py file were loaded correctly. From d8d83777ebbe15af7587a24698435555ba3bb842 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Thu, 26 Dec 2013 15:50:33 -0500 Subject: [PATCH 073/208] Fixed #21629 -- Added instructions for loading MySQL time zone definitions. Thanks Aymeric for the suggestion. --- docs/ref/databases.txt | 11 +++++++++++ docs/topics/i18n/timezones.txt | 6 ++++++ 2 files changed, 17 insertions(+) diff --git a/docs/ref/databases.txt b/docs/ref/databases.txt index f04b8830f7..f7c4f0f9fb 100644 --- a/docs/ref/databases.txt +++ b/docs/ref/databases.txt @@ -305,6 +305,17 @@ The Django adapter is currently only available in the Dev branch. .. _release branches: http://dev.mysql.com/downloads/connector/python/ +.. _mysql-time-zone-definitions: + +Time zone definitions +--------------------- + +If you plan on using Django's :doc:`timezone support `, +use `mysql_tzinfo_to_sql`_ to load time zone tables into the MySQL database. +This needs to be done just once for your MySQL server, not per database. + +.. _mysql_tzinfo_to_sql: http://dev.mysql.com/doc/refman/5.5/en/mysql-tzinfo-to-sql.html + Creating your database ---------------------- diff --git a/docs/topics/i18n/timezones.txt b/docs/topics/i18n/timezones.txt index 5e3a482154..839813a823 100644 --- a/docs/topics/i18n/timezones.txt +++ b/docs/topics/i18n/timezones.txt @@ -649,6 +649,12 @@ Troubleshooting >>> local.date() datetime.date(2012, 3, 3) +4. **I get an error** "``Are time zone definitions for your database and pytz + installed?``" **pytz is installed, so I guess the problem is my database?** + + If you are using MySQL, see the :ref:`mysql-time-zone-definitions` section + of the MySQL notes for instructions on loading time zone definitions. + Usage ----- From 6e3ca6507cd0a431d63924a708c39f6faa21341b Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 26 Dec 2013 22:55:13 +0100 Subject: [PATCH 074/208] Used app_config.verbose_name instead of app_label|capfirst. An admin view performed the capitalization in the template, unlike all others. Refs #10436. --- django/contrib/admin/templates/admin/delete_confirmation.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/django/contrib/admin/templates/admin/delete_confirmation.html b/django/contrib/admin/templates/admin/delete_confirmation.html index 2e94b61485..c2057a635e 100644 --- a/django/contrib/admin/templates/admin/delete_confirmation.html +++ b/django/contrib/admin/templates/admin/delete_confirmation.html @@ -6,7 +6,7 @@ {% block breadcrumbs %}
    {% trans 'Home' %} -› {{ app_label|capfirst }} +› {{ opts.app_config.verbose_name }} › {{ opts.verbose_name_plural|capfirst|escape }} › {{ object|truncatewords:"18" }} › {% trans 'Delete' %} From 025ec2e7fe3f4056835eda94d204ec87901fa11f Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Thu, 26 Dec 2013 20:04:28 -0500 Subject: [PATCH 075/208] Fixed #21582 -- Corrected URL namespace example. Thanks oubiga for the report. --- docs/topics/http/urls.txt | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/topics/http/urls.txt b/docs/topics/http/urls.txt index d72d1a26e6..a170a4e18d 100644 --- a/docs/topics/http/urls.txt +++ b/docs/topics/http/urls.txt @@ -866,7 +866,7 @@ For example:: url(r'^advanced/$', 'apps.help.views.views.advanced'), ) - url(r'^help/', include(help_patterns, 'bar', 'foo')), + url(r'^help/', include((help_patterns, 'bar', 'foo'))), This will include the nominated URL patterns into the given application and instance namespace. @@ -877,3 +877,8 @@ attribute: A 3-tuple that contains all the patterns in the corresponding admin site, plus the application namespace ``'admin'``, and the name of the admin instance. It is this ``urls`` attribute that you ``include()`` into your projects ``urlpatterns`` when you deploy an Admin instance. + +Be sure to pass a tuple to ``include()``. If you simply pass three arguments: +``include(help_patterns, 'bar', 'foo')``, Django won't throw an error but due +to the signature of ``include()``, ``'bar'`` will be the instance namespace and +``'foo'`` will be the application namespace instead of vice versa. From 6aa1a316604c063db88a8aa4cd2f25065ae1394c Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Fri, 27 Dec 2013 11:17:25 +0100 Subject: [PATCH 076/208] Properly app_template_dirs when INSTALLED_APPS change. --- django/template/loaders/app_directories.py | 27 ++++++++++++---------- django/test/signals.py | 3 +++ 2 files changed, 18 insertions(+), 12 deletions(-) diff --git a/django/template/loaders/app_directories.py b/django/template/loaders/app_directories.py index a2e741b419..587bfb0547 100644 --- a/django/template/loaders/app_directories.py +++ b/django/template/loaders/app_directories.py @@ -13,19 +13,22 @@ from django.template.loader import BaseLoader from django.utils._os import safe_join from django.utils import six -# At compile time, cache the directories to search. -if six.PY2: - fs_encoding = sys.getfilesystemencoding() or sys.getdefaultencoding() -app_template_dirs = [] -for app_config in apps.get_app_configs(): - template_dir = os.path.join(app_config.path, 'templates') - if os.path.isdir(template_dir): - if six.PY2: - template_dir = template_dir.decode(fs_encoding) - app_template_dirs.append(template_dir) -# It won't change, so convert it to a tuple to save memory. -app_template_dirs = tuple(app_template_dirs) +def calculate_app_template_dirs(): + if six.PY2: + fs_encoding = sys.getfilesystemencoding() or sys.getdefaultencoding() + app_template_dirs = [] + for app_config in apps.get_app_configs(): + template_dir = os.path.join(app_config.path, 'templates') + if os.path.isdir(template_dir): + if six.PY2: + template_dir = template_dir.decode(fs_encoding) + app_template_dirs.append(template_dir) + return tuple(app_template_dirs) + + +# At compile time, cache the directories to search. +app_template_dirs = calculate_app_template_dirs() class Loader(BaseLoader): diff --git a/django/test/signals.py b/django/test/signals.py index 03c40f259d..49bfc64292 100644 --- a/django/test/signals.py +++ b/django/test/signals.py @@ -33,6 +33,9 @@ def update_installed_apps(**kwargs): # Rebuild any AppDirectoriesFinder instance. from django.contrib.staticfiles.finders import get_finder get_finder.cache_clear() + # Rebuild app_template_dirs cache. + from django.template.loaders import app_directories as mod + mod.app_template_dirs = mod.calculate_app_template_dirs() @receiver(setting_changed) From f00243f36df8dfe504491e03be5d5aea076340b3 Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Fri, 27 Dec 2013 11:42:24 +0100 Subject: [PATCH 077/208] Don't try to load app directory templates from apps with a path (eg eggs) --- django/template/loaders/app_directories.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/django/template/loaders/app_directories.py b/django/template/loaders/app_directories.py index 587bfb0547..b66adaed08 100644 --- a/django/template/loaders/app_directories.py +++ b/django/template/loaders/app_directories.py @@ -19,6 +19,8 @@ def calculate_app_template_dirs(): fs_encoding = sys.getfilesystemencoding() or sys.getdefaultencoding() app_template_dirs = [] for app_config in apps.get_app_configs(): + if not app_config.path: + continue template_dir = os.path.join(app_config.path, 'templates') if os.path.isdir(template_dir): if six.PY2: From 2504a50cc2285b5e5f17d5403c9a79b620471b25 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Fri, 27 Dec 2013 15:36:19 +0100 Subject: [PATCH 078/208] Created a constant for the migrations module name. Mostly for consistency with MODELS_MODULE_NAME; it's unlikely to change. --- django/db/migrations/loader.py | 8 ++++++-- django/db/migrations/questioner.py | 4 +++- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/django/db/migrations/loader.py b/django/db/migrations/loader.py index d24f7ab889..a3ed25793a 100644 --- a/django/db/migrations/loader.py +++ b/django/db/migrations/loader.py @@ -9,6 +9,9 @@ from django.utils import six from django.conf import settings +MIGRATIONS_MODULE_NAME = 'migrations' + + class MigrationLoader(object): """ Loads migration files from disk, and their status from the database. @@ -46,7 +49,8 @@ class MigrationLoader(object): if app_label in settings.MIGRATION_MODULES: return settings.MIGRATION_MODULES[app_label] else: - return '%s.migrations' % apps.get_app_config(app_label).name + app_package_name = apps.get_app_config(app_label).name + return '%s.%s' % (app_package_name, MIGRATIONS_MODULE_NAME) def load_disk(self): """ @@ -64,7 +68,7 @@ class MigrationLoader(object): except ImportError as e: # I hate doing this, but I don't want to squash other import errors. # Might be better to try a directory check directly. - if "No module named" in str(e) and "migrations" in str(e): + if "No module named" in str(e) and MIGRATIONS_MODULE_NAME in str(e): self.unmigrated_apps.add(app_config.label) continue raise diff --git a/django/db/migrations/questioner.py b/django/db/migrations/questioner.py index efd75189ef..3c43c29c11 100644 --- a/django/db/migrations/questioner.py +++ b/django/db/migrations/questioner.py @@ -6,6 +6,8 @@ from django.apps import apps from django.utils import datetime_safe from django.utils.six.moves import input +from .loader import MIGRATIONS_MODULE_NAME + class MigrationQuestioner(object): """ @@ -31,7 +33,7 @@ class MigrationQuestioner(object): app_config = apps.get_app_config(app_label) except LookupError: # It's a fake app. return self.defaults.get("ask_initial", False) - migrations_import_path = "%s.migrations" % app_config.name + migrations_import_path = "%s.%s" % (app_config.name, MIGRATIONS_MODULE_NAME) try: migrations_module = importlib.import_module(migrations_import_path) except ImportError: From 85270ef3f5bf96b556e697bc5a46bf925ec4be21 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Fri, 27 Dec 2013 09:57:56 -0500 Subject: [PATCH 079/208] Fixed #21650 -- Corrected bad advice for plural translation. Thanks nedbatchelder and claudep. --- docs/topics/i18n/translation.txt | 51 ++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 23 deletions(-) diff --git a/docs/topics/i18n/translation.txt b/docs/topics/i18n/translation.txt index cc4c24d364..f3f871617b 100644 --- a/docs/topics/i18n/translation.txt +++ b/docs/topics/i18n/translation.txt @@ -206,7 +206,9 @@ For example:: In this example the number of objects is passed to the translation languages as the ``count`` variable. -Lets see a slightly more complex usage example:: +Note that pluralization is complicated and works differently in each language. +Comparing ``count`` to 1 isn't always the correct rule. This code looks +sophisticated, but will produce incorrect results for some languages:: from django.utils.translation import ungettext from myapp.models import Report @@ -218,42 +220,45 @@ Lets see a slightly more complex usage example:: name = Report._meta.verbose_name_plural text = ungettext( - 'There is %(count)d %(name)s available.', - 'There are %(count)d %(name)s available.', - count + 'There is %(count)d %(name)s available.', + 'There are %(count)d %(name)s available.', + count ) % { 'count': count, 'name': name } -Here we reuse localizable, hopefully already translated literals (contained in -the ``verbose_name`` and ``verbose_name_plural`` model ``Meta`` options) for -other parts of the sentence so all of it is consistently based on the -cardinality of the elements at play. +Don't try to implement your own singular-or-plural logic, it won't be correct. +In a case like this, consider something like the following:: + + text = ungettext( + 'There is %(count)d %(name)s object available.', + 'There are %(count)d %(name)s objects available.', + count + ) % { + 'count': count, + 'name': Report._meta.verbose_name, + } .. _pluralization-var-notes: .. note:: - When using this technique, make sure you use a single name for every - extrapolated variable included in the literal. In the example above note how - we used the ``name`` Python variable in both translation strings. This - example would fail:: + When using ``ungettext()``, make sure you use a single name for every + extrapolated variable included in the literal. In the examples above, note + how we used the ``name`` Python variable in both translation strings. This + example, besides being incorrect in some languages as noted above, would + fail:: - from django.utils.translation import ungettext - from myapp.models import Report - - count = Report.objects.count() - d = { - 'count': count, + text = ungettext( + 'There is %(count)d %(name)s available.', + 'There are %(count)d %(plural_name)s available.', + count + ) % { + 'count': Report.objects.count(), 'name': Report._meta.verbose_name, 'plural_name': Report._meta.verbose_name_plural } - text = ungettext( - 'There is %(count)d %(name)s available.', - 'There are %(count)d %(plural_name)s available.', - count - ) % d You would get an error when running :djadmin:`django-admin.py compilemessages `:: From 40b876763539e1700826ebffcd9402043054b13b Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Fri, 27 Dec 2013 21:06:28 +0100 Subject: [PATCH 080/208] Fixed a couple flake8 warnings. --- tests/apps/apps.py | 2 -- tests/apps/tests.py | 1 - 2 files changed, 3 deletions(-) diff --git a/tests/apps/apps.py b/tests/apps/apps.py index 2012a34fd4..22c8f3062f 100644 --- a/tests/apps/apps.py +++ b/tests/apps/apps.py @@ -23,5 +23,3 @@ class NotAConfig(object): class NoSuchApp(AppConfig): name = 'there is no such app' - - diff --git a/tests/apps/tests.py b/tests/apps/tests.py index a516b6e662..f7de95ebe3 100644 --- a/tests/apps/tests.py +++ b/tests/apps/tests.py @@ -2,7 +2,6 @@ from __future__ import absolute_import, unicode_literals from django.apps import apps from django.apps.registry import Apps -from django.conf import settings from django.core.exceptions import ImproperlyConfigured from django.db import models from django.test import TestCase, override_settings From efddae252ce8fe469196839a29a564c0b4942c89 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Fri, 27 Dec 2013 21:25:35 +0100 Subject: [PATCH 081/208] Refactored dumpdata with app configs instead of models modules. --- django/core/management/commands/dumpdata.py | 43 +++++++++------------ 1 file changed, 19 insertions(+), 24 deletions(-) diff --git a/django/core/management/commands/dumpdata.py b/django/core/management/commands/dumpdata.py index f6b9e7a4c8..5982f07445 100644 --- a/django/core/management/commands/dumpdata.py +++ b/django/core/management/commands/dumpdata.py @@ -3,6 +3,7 @@ import warnings from collections import OrderedDict from optparse import make_option +from django.apps import apps from django.core.management.base import BaseCommand, CommandError from django.core import serializers from django.db import router, DEFAULT_DB_ALIAS @@ -37,8 +38,6 @@ class Command(BaseCommand): args = '[appname appname.ModelName ...]' def handle(self, *app_labels, **options): - from django.apps import apps - format = options.get('format') indent = options.get('indent') using = options.get('database') @@ -63,24 +62,23 @@ class Command(BaseCommand): for exclude in excludes: if '.' in exclude: app_label, model_name = exclude.split('.', 1) - model_obj = apps.get_model(app_label, model_name) - if not model_obj: + model = apps.get_model(app_label, model_name) + if not model: raise CommandError('Unknown model in excludes: %s' % exclude) - excluded_models.add(model_obj) + excluded_models.add(model) else: try: - app_obj = apps.get_app_config(exclude).models_module - if app_obj is not None: - excluded_apps.add(app_obj) + app_config = apps.get_app_config(exclude) except LookupError: raise CommandError('Unknown app in excludes: %s' % exclude) + excluded_apps.add(app_config) if len(app_labels) == 0: if primary_keys: raise CommandError("You can only use --pks option with one model") - app_list = OrderedDict((app_config.models_module, None) + app_list = OrderedDict((app_config, None) for app_config in apps.get_app_configs(only_with_models_module=True) - if app_config.models_module not in excluded_apps) + if app_config not in excluded_apps) else: if len(app_labels) > 1 and primary_keys: raise CommandError("You can only use --pks option with one model") @@ -89,32 +87,30 @@ class Command(BaseCommand): try: app_label, model_label = label.split('.') try: - app = apps.get_app_config(app_label).models_module + app_config = apps.get_app_config(app_label) except LookupError: raise CommandError("Unknown application: %s" % app_label) - if app is None or app in excluded_apps: + if app_config.models_module is None or app_config in excluded_apps: continue model = apps.get_model(app_label, model_label) if model is None: raise CommandError("Unknown model: %s.%s" % (app_label, model_label)) - if app in app_list.keys(): - if app_list[app] and model not in app_list[app]: - app_list[app].append(model) - else: - app_list[app] = [model] + app_list_value = app_list.setdefault(app_config, []) + if model not in app_list_value: + app_list_value.append(model) except ValueError: if primary_keys: raise CommandError("You can only use --pks option with one model") # This is just an app - no model qualifier app_label = label try: - app = apps.get_app_config(app_label).models_module + app_config = apps.get_app_config(app_label) except LookupError: raise CommandError("Unknown application: %s" % app_label) - if app is None or app in excluded_apps: + if app_config.models_module is None or app_config in excluded_apps: continue - app_list[app] = None + app_list[app_config] = None # Check that the serialization format exists; this is a shortcut to # avoid collating all the objects and _then_ failing. @@ -156,19 +152,18 @@ class Command(BaseCommand): def sort_dependencies(app_list): - """Sort a list of app,modellist pairs into a single list of models. + """Sort a list of (app_config, models) pairs into a single list of models. The single list of models is sorted so that any model with a natural key is serialized before a normal model, and any model with a natural key dependency has it's dependencies serialized first. """ - from django.apps import apps # Process the list of models, and get the list of dependencies model_dependencies = [] models = set() - for app, model_list in app_list: + for app_config, model_list in app_list: if model_list is None: - model_list = apps.get_models(app) + model_list = apps.get_models(app_config.models_module) for model in model_list: models.add(model) From 3efd1b8b939c0a600b2d63317d224ebaab766f01 Mon Sep 17 00:00:00 2001 From: Ramiro Morales Date: Sun, 22 Dec 2013 16:44:49 -0300 Subject: [PATCH 082/208] Fixed #21692 -- Quote table name when creating it. --- django/db/backends/schema.py | 2 +- tests/schema/models.py | 13 +++++++++++++ tests/schema/tests.py | 28 ++++++++++++++++++++++++++-- 3 files changed, 40 insertions(+), 3 deletions(-) diff --git a/django/db/backends/schema.py b/django/db/backends/schema.py index e33956763c..5ac8d51a3d 100644 --- a/django/db/backends/schema.py +++ b/django/db/backends/schema.py @@ -227,7 +227,7 @@ class BaseDatabaseSchemaEditor(object): }) # Make the table sql = self.sql_create_table % { - "table": model._meta.db_table, + "table": self.quote_name(model._meta.db_table), "definition": ", ".join(column_sqls) } self.execute(sql, params) diff --git a/tests/schema/models.py b/tests/schema/models.py index 44fecf7ebd..c4c8225970 100644 --- a/tests/schema/models.py +++ b/tests/schema/models.py @@ -1,5 +1,6 @@ from django.apps.registry import Apps from django.db import models +from django.utils.encoding import python_2_unicode_compatible # Because we want to test creation and deletion of these as separate things, # these models are all inserted into a separate Apps so the main test @@ -102,3 +103,15 @@ class BookWithLongName(models.Model): class Meta: apps = new_apps + + +# Based on tests/reserved_names/models.py +@python_2_unicode_compatible +class Thing(models.Model): + when = models.CharField(max_length=1, primary_key=True) + + class Meta: + db_table = 'select' + + def __str__(self): + return self.when diff --git a/tests/schema/tests.py b/tests/schema/tests.py index 66450956ef..e0000e2b9d 100644 --- a/tests/schema/tests.py +++ b/tests/schema/tests.py @@ -3,13 +3,13 @@ import datetime import unittest from django.test import TransactionTestCase -from django.db import connection, DatabaseError, IntegrityError +from django.db import connection, DatabaseError, IntegrityError, OperationalError from django.db.models.fields import IntegerField, TextField, CharField, SlugField from django.db.models.fields.related import ManyToManyField, ForeignKey from django.db.transaction import atomic from .models import (Author, AuthorWithM2M, Book, BookWithLongName, BookWithSlug, BookWithM2M, Tag, TagIndexed, TagM2MTest, TagUniqueRename, - UniqueTest) + UniqueTest, Thing) class SchemaTests(TransactionTestCase): @@ -26,6 +26,7 @@ class SchemaTests(TransactionTestCase): models = [ Author, AuthorWithM2M, Book, BookWithLongName, BookWithSlug, BookWithM2M, Tag, TagIndexed, TagM2MTest, TagUniqueRename, UniqueTest, + Thing ] # Utility functions @@ -683,3 +684,26 @@ class SchemaTests(TransactionTestCase): column_name, connection.introspection.get_indexes(connection.cursor(), BookWithLongName._meta.db_table), ) + + def test_creation_deletion_reserved_names(self): + """ + Tries creating a model's table, and then deleting it when it has a + SQL reserved name. + """ + # Create the table + with connection.schema_editor() as editor: + try: + editor.create_model(Thing) + except OperationalError as e: + self.fail("Errors when applying initial migration for a model " + "with a table named after a SQL reserved word: %s" % e) + # Check that it's there + list(Thing.objects.all()) + # Clean up that table + with connection.schema_editor() as editor: + editor.delete_model(Thing) + # Check that it's gone + self.assertRaises( + DatabaseError, + lambda: list(Thing.objects.all()), + ) From 14bcbd9937f50ec21196dbb2bc3126e6a4427b37 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Fri, 27 Dec 2013 23:17:59 +0100 Subject: [PATCH 083/208] Avoided %r formatting on possibly unicode strings. The u prefix looks bad on Python 2. --- django/apps/base.py | 6 +++--- django/apps/registry.py | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/django/apps/base.py b/django/apps/base.py index 4102780560..40b72c9448 100644 --- a/django/apps/base.py +++ b/django/apps/base.py @@ -83,13 +83,13 @@ class AppConfig(object): # would raise when exists but not , with # more context (Python just says "cannot import name ..."). raise ImportError( - "cannot import name %r from %r" % (cls_name, mod_path)) + "cannot import name '%s' from '%s'" % (cls_name, mod_path)) # Check for obvious errors. (This check prevents duck typing, but # it could be removed if it became a problem in practice.) if not issubclass(cls, AppConfig): raise ImproperlyConfigured( - "%r isn't a subclass of AppConfig." % entry) + "'%s' isn't a subclass of AppConfig." % entry) # Obtain app name here rather than in AppClass.__init__ to keep # all error checking for entries in INSTALLED_APPS in one place. @@ -97,7 +97,7 @@ class AppConfig(object): app_name = cls.name except AttributeError: raise ImproperlyConfigured( - "%r must supply a name attribute." % entry) + "'%s' must supply a name attribute." % entry) # Ensure app_names points to a valid module. app_module = import_module(app_name) diff --git a/django/apps/registry.py b/django/apps/registry.py index 737fc960b8..8a25bad281 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -181,9 +181,9 @@ class Apps(object): app_config = self.app_configs.get(app_label) if app_config is None: - raise LookupError("No installed app with label %r." % app_label) + raise LookupError("No installed app with label '%s'." % app_label) if only_with_models_module and app_config.models_module is None: - raise LookupError("App with label %r doesn't have a models module." % app_label) + raise LookupError("App with label '%s' doesn't have a models module." % app_label) return app_config # This method is performance-critical at least for Django's test suite. From 3518e9ec1f23f0278aefea6738f9d49eb7d4fe52 Mon Sep 17 00:00:00 2001 From: Ramiro Morales Date: Fri, 27 Dec 2013 20:58:18 -0300 Subject: [PATCH 084/208] Amend test table name so it doesn't clash. Refs #21692 and 3efd1b8b939. --- tests/schema/models.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/schema/models.py b/tests/schema/models.py index c4c8225970..67cfcf6a89 100644 --- a/tests/schema/models.py +++ b/tests/schema/models.py @@ -111,7 +111,7 @@ class Thing(models.Model): when = models.CharField(max_length=1, primary_key=True) class Meta: - db_table = 'select' + db_table = 'drop' def __str__(self): return self.when From aff57793b46e108c6e48d5ce3b889bf90b513df9 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Fri, 27 Dec 2013 23:03:03 +0100 Subject: [PATCH 085/208] Simplified the implementation of register_model. register_model is called exactly once in the entire Django code base, at the bottom of ModelBase.__new__: new_class._meta.apps.register_model(new_class._meta.app_label, new_class) ModelBase.__new__ exits prematurely 120 lines earlier (sigh) if a model with the same name is already registered: if new_class._meta.apps.get_registered_model(new_class._meta.app_label, name): return (This isn't the exact code, but it's equivalent.) apps.register_model and apps.get_registered_model are essentially a setter and a getter for apps.all_models, and apps.register_model is the only setter. As a consequence, new_class._meta.apps.all_models cannot change in-between. Considering that name == new_class.__name__, we can conclude that register_model(app_label, model) is always called with such arguments that get_registered_model(app_label, model.__name__) returns None. Considering that model._meta.model_name == model.__name__.lower(), and looking at the implementation of register_model and get_registered_model, this proves that self.all_models[app_label] doesn't contain model._meta.model_name in register_model, allowing us to simplify the implementation. --- django/apps/registry.py | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index 8a25bad281..42affbbc13 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -261,19 +261,13 @@ class Apps(object): # perform imports because of the risk of import loops. It mustn't # call get_app_config(). model_name = model._meta.model_name - models = self.all_models[app_label] - if model_name in models: - # The same model may be imported via different paths (e.g. - # appname.models and project.appname.models). We use the source - # filename as a means to detect identity. - fname1 = os.path.abspath(upath(sys.modules[model.__module__].__file__)) - fname2 = os.path.abspath(upath(sys.modules[models[model_name].__module__].__file__)) - # Since the filename extension could be .py the first time and - # .pyc or .pyo the second time, ignore the extension when - # comparing. - if os.path.splitext(fname1)[0] == os.path.splitext(fname2)[0]: - return - models[model_name] = model + app_models = self.all_models[app_label] + # Defensive check for extra safety. + if model_name in app_models: + raise RuntimeError( + "Conflicting '%s' models in application '%s': %s and %s." % + (model_name, app_label, app_models[model_name], model)) + app_models[model_name] = model self.get_models.cache_clear() def has_app(self, app_name): From bb8ec71f61066587aa3a8feb0aedab213422775a Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 24 Dec 2013 23:43:47 +0100 Subject: [PATCH 086/208] Updated the AppCommand API to support apps without a models module. --- django/core/management/base.py | 51 ++++++++++++++--------- docs/howto/custom-management-commands.txt | 33 +++++++++++---- docs/internals/deprecation.txt | 2 + docs/releases/1.7.txt | 4 ++ 4 files changed, 63 insertions(+), 27 deletions(-) diff --git a/django/core/management/base.py b/django/core/management/base.py index 5c3a1a6c8c..59224049d2 100644 --- a/django/core/management/base.py +++ b/django/core/management/base.py @@ -7,6 +7,7 @@ from __future__ import unicode_literals import os import sys +import warnings from optparse import make_option, OptionParser @@ -112,8 +113,8 @@ class BaseCommand(object): ``args`` A string listing the arguments accepted by the command, suitable for use in help messages; e.g., a command which takes - a list of application names might set this to ''. + a list of application names might set this to ''. ``can_import_settings`` A boolean indicating whether the command needs to be able to @@ -331,19 +332,18 @@ class BaseCommand(object): class AppCommand(BaseCommand): """ - A management command which takes one or more installed application - names as arguments, and does something with each of them. + A management command which takes one or more installed application labels + as arguments, and does something with each of them. Rather than implementing ``handle()``, subclasses must implement - ``handle_app()``, which will be called once for each application. - + ``handle_app_config()``, which will be called once for each application. """ - args = '' + args = '' def handle(self, *app_labels, **options): from django.apps import apps if not app_labels: - raise CommandError('Enter at least one appname.') + raise CommandError("Enter at least one application label.") # Populate models and don't use only_with_models_module=True when # calling get_app_config() to tell apart missing apps from apps # without a model module -- which can't be supported with the legacy @@ -355,23 +355,36 @@ class AppCommand(BaseCommand): raise CommandError("%s. Are you sure your INSTALLED_APPS setting is correct?" % e) output = [] for app_config in app_configs: - if app_config.models_module is None: - raise CommandError( - "AppCommand cannot handle app %r because it doesn't have " - "a models module." % app_config.label) - app_output = self.handle_app(app_config.models_module, **options) + app_output = self.handle_app_config(app_config, **options) if app_output: output.append(app_output) return '\n'.join(output) - def handle_app(self, app, **options): + def handle_app_config(self, app_config, **options): """ - Perform the command's actions for ``app``, which will be the - Python module corresponding to an application name given on - the command line. - + Perform the command's actions for app_config, an AppConfig instance + corresponding to an application label given on the command line. """ - raise NotImplementedError('subclasses of AppCommand must provide a handle_app() method') + try: + # During the deprecation path, keep delegating to handle_app if + # handle_app_config isn't implemented in a subclass. + handle_app = self.handle_app + except AttributeError: + # Keep only this exception when the deprecation completes. + raise NotImplementedError( + "Subclasses of AppCommand must provide" + "a handle_app_config() method.") + else: + warnings.warn( + "AppCommand.handle_app() is superseded by " + "AppCommand.handle_app_config().", + PendingDeprecationWarning, stacklevel=2) + if app_config.models_module is None: + raise CommandError( + "AppCommand cannot handle app '%s' in legacy mode " + "because it doesn't have a models module." + % app_config.label) + return handle_app(app_config.models_module, **options) class LabelCommand(BaseCommand): diff --git a/docs/howto/custom-management-commands.txt b/docs/howto/custom-management-commands.txt index 2325e32ac2..4f95838760 100644 --- a/docs/howto/custom-management-commands.txt +++ b/docs/howto/custom-management-commands.txt @@ -313,17 +313,34 @@ BaseCommand subclasses .. class:: AppCommand -A management command which takes one or more installed application -names as arguments, and does something with each of them. +A management command which takes one or more installed application labels as +arguments, and does something with each of them. -Rather than implementing :meth:`~BaseCommand.handle`, subclasses must implement -:meth:`~AppCommand.handle_app`, which will be called once for each application. +Rather than implementing :meth:`~BaseCommand.handle`, subclasses must +implement :meth:`~AppCommand.handle_app_config`, which will be called once for +each application. -.. method:: AppCommand.handle_app(app, **options) +.. method:: AppCommand.handle_app_config(app_config, **options) - Perform the command's actions for ``app``, which will be the - Python module corresponding to an application name given on - the command line. + Perform the command's actions for ``app_config``, which will be an + :class:`~django.apps.AppConfig` instance corresponding to an application + label given on the command line. + +.. versionchanged:: 1.7 + + Previously, :class:`AppCommand` subclasses had to implement + ``handle_app(app, **options)`` where ``app`` was a models module. The new + API makes it possible to handle applications without a models module. The + fastest way to migrate is as follows:: + + def handle_app_config(app_config, **options): + if app_config.models_module is None: + return # Or raise an exception. + app = app_config.models_module + # Copy the implementation of handle_app(app_config, **options) here. + + However, you may be able to simplify the implementation by using directly + the attributes of ``app_config``. .. class:: LabelCommand diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index 29a68ff0c1..29f7df53ae 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -179,6 +179,8 @@ these changes. * The model and form ``IPAddressField`` will be removed. +* ``AppCommand.handle_app()`` will no longer be supported. + * FastCGI support via the ``runfcgi`` management command will be removed. Please deploy your project using WSGI. diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 5aba3ca096..2c3e3f217d 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -593,6 +593,10 @@ methods are only referring to fields or other items in ``model._meta``. App-loading changes ~~~~~~~~~~~~~~~~~~~ +Subclasses of :class:`~django.core.management.AppCommand` must now implement a +:meth:`~django.core.management.AppCommand.handle_app_config` method instead of +``handle_app()``. This method receives an :class:`~django.apps.AppConfig` instance. + Since :setting:`INSTALLED_APPS` now supports application configuration classes in addition to application modules, you should review code that accesses this setting directly and use the app registry (:attr:`django.apps.apps`) instead. From a7add2f2965dac3c2f63b1459c8bde725250c977 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Fri, 27 Dec 2013 15:17:56 +0100 Subject: [PATCH 087/208] Migrated built-in AppCommands to use handle_app_config. --- django/core/management/commands/sql.py | 8 ++++++-- django/core/management/commands/sqlall.py | 8 ++++++-- django/core/management/commands/sqlclear.py | 8 ++++++-- django/core/management/commands/sqlcustom.py | 8 ++++++-- .../core/management/commands/sqldropindexes.py | 8 ++++++-- django/core/management/commands/sqlindexes.py | 8 ++++++-- .../management/commands/sqlsequencereset.py | 8 ++++++-- .../management/commands/app_command.py | 4 ++-- tests/admin_scripts/tests.py | 17 +++++++---------- 9 files changed, 51 insertions(+), 26 deletions(-) diff --git a/django/core/management/commands/sql.py b/django/core/management/commands/sql.py index 399458693e..b846cc7cd4 100644 --- a/django/core/management/commands/sql.py +++ b/django/core/management/commands/sql.py @@ -18,5 +18,9 @@ class Command(AppCommand): output_transaction = True - def handle_app(self, app, **options): - return '\n'.join(sql_create(app, self.style, connections[options.get('database')])) + def handle_app_config(self, app_config, **options): + if app_config.models_module is None: + return + connection = connections[options.get('database')] + statements = sql_create(app_config.models_module, self.style, connection) + return '\n'.join(statements) diff --git a/django/core/management/commands/sqlall.py b/django/core/management/commands/sqlall.py index 0e2c05ba82..b4e65487f4 100644 --- a/django/core/management/commands/sqlall.py +++ b/django/core/management/commands/sqlall.py @@ -18,5 +18,9 @@ class Command(AppCommand): output_transaction = True - def handle_app(self, app, **options): - return '\n'.join(sql_all(app, self.style, connections[options.get('database')])) + def handle_app_config(self, app_config, **options): + if app_config.models_module is None: + return + connection = connections[options.get('database')] + statements = sql_all(app_config.models_module, self.style, connection) + return '\n'.join(statements) diff --git a/django/core/management/commands/sqlclear.py b/django/core/management/commands/sqlclear.py index efcdbbca35..15efb7872b 100644 --- a/django/core/management/commands/sqlclear.py +++ b/django/core/management/commands/sqlclear.py @@ -18,5 +18,9 @@ class Command(AppCommand): output_transaction = True - def handle_app(self, app, **options): - return '\n'.join(sql_delete(app, self.style, connections[options.get('database')])) + def handle_app_config(self, app_config, **options): + if app_config.models_module is None: + return + connection = connections[options.get('database')] + statements = sql_delete(app_config.models_module, self.style, connection) + return '\n'.join(statements) diff --git a/django/core/management/commands/sqlcustom.py b/django/core/management/commands/sqlcustom.py index b71a3dd6d4..0988654816 100644 --- a/django/core/management/commands/sqlcustom.py +++ b/django/core/management/commands/sqlcustom.py @@ -18,5 +18,9 @@ class Command(AppCommand): output_transaction = True - def handle_app(self, app, **options): - return '\n'.join(sql_custom(app, self.style, connections[options.get('database')])) + def handle_app_config(self, app_config, **options): + if app_config.models_module is None: + return + connection = connections[options.get('database')] + statements = sql_custom(app_config.models_module, self.style, connection) + return '\n'.join(statements) diff --git a/django/core/management/commands/sqldropindexes.py b/django/core/management/commands/sqldropindexes.py index d531808996..ac8469c700 100644 --- a/django/core/management/commands/sqldropindexes.py +++ b/django/core/management/commands/sqldropindexes.py @@ -19,5 +19,9 @@ class Command(AppCommand): output_transaction = True - def handle_app(self, app, **options): - return '\n'.join(sql_destroy_indexes(app, self.style, connections[options.get('database')])) + def handle_app_config(self, app_config, **options): + if app_config.models_module is None: + return + connection = connections[options.get('database')] + statements = sql_destroy_indexes(app_config.models_module, self.style, connection) + return '\n'.join(statements) diff --git a/django/core/management/commands/sqlindexes.py b/django/core/management/commands/sqlindexes.py index 2dc4f35dc6..0ff1ab3914 100644 --- a/django/core/management/commands/sqlindexes.py +++ b/django/core/management/commands/sqlindexes.py @@ -19,5 +19,9 @@ class Command(AppCommand): output_transaction = True - def handle_app(self, app, **options): - return '\n'.join(sql_indexes(app, self.style, connections[options.get('database')])) + def handle_app_config(self, app_config, **options): + if app_config.models_module is None: + return + connection = connections[options.get('database')] + statements = sql_indexes(app_config.models_module, self.style, connection) + return '\n'.join(statements) diff --git a/django/core/management/commands/sqlsequencereset.py b/django/core/management/commands/sqlsequencereset.py index 58f171e87b..d32ff3c5d0 100644 --- a/django/core/management/commands/sqlsequencereset.py +++ b/django/core/management/commands/sqlsequencereset.py @@ -19,6 +19,10 @@ class Command(AppCommand): output_transaction = True - def handle_app(self, app, **options): + def handle_app_config(self, app_config, **options): + if app_config.models_module is None: + return connection = connections[options.get('database')] - return '\n'.join(connection.ops.sequence_reset_sql(self.style, apps.get_models(app, include_auto_created=True))) + models = apps.get_models(app_config.models_module, include_auto_created=True) + statements = connection.ops.sequence_reset_sql(self.style, models) + return '\n'.join(statements) diff --git a/tests/admin_scripts/management/commands/app_command.py b/tests/admin_scripts/management/commands/app_command.py index 5cbddb6e96..5f221f48ee 100644 --- a/tests/admin_scripts/management/commands/app_command.py +++ b/tests/admin_scripts/management/commands/app_command.py @@ -6,5 +6,5 @@ class Command(AppCommand): requires_model_validation = False args = '[appname ...]' - def handle_app(self, app, **options): - print('EXECUTE:AppCommand app=%s, options=%s' % (app, sorted(options.items()))) + def handle_app_config(self, app_config, **options): + print('EXECUTE:AppCommand name=%s, options=%s' % (app_config.name, sorted(options.items()))) diff --git a/tests/admin_scripts/tests.py b/tests/admin_scripts/tests.py index 3f9a336c16..cc0531a124 100644 --- a/tests/admin_scripts/tests.py +++ b/tests/admin_scripts/tests.py @@ -1416,27 +1416,24 @@ class CommandTypes(AdminScriptTestCase): args = ['app_command', 'auth'] out, err = self.run_manage(args) self.assertNoOutput(err) - self.assertOutput(out, "EXECUTE:AppCommand app=, options=[('no_color', False), ('pythonpath', None), ('settings', None), ('traceback', None), ('verbosity', %(_)s'1')]")) + self.assertOutput(out, "EXECUTE:AppCommand name=django.contrib.auth, options=") + self.assertOutput(out, str_prefix(", options=[('no_color', False), ('pythonpath', None), ('settings', None), ('traceback', None), ('verbosity', %(_)s'1')]")) def test_app_command_no_apps(self): "User AppCommands raise an error when no app name is provided" args = ['app_command'] out, err = self.run_manage(args) - self.assertOutput(err, 'Error: Enter at least one appname.') + self.assertOutput(err, 'Error: Enter at least one application label.') def test_app_command_multiple_apps(self): "User AppCommands raise an error when multiple app names are provided" args = ['app_command', 'auth', 'contenttypes'] out, err = self.run_manage(args) self.assertNoOutput(err) - self.assertOutput(out, "EXECUTE:AppCommand app=, options=[('no_color', False), ('pythonpath', None), ('settings', None), ('traceback', None), ('verbosity', %(_)s'1')]")) - self.assertOutput(out, "EXECUTE:AppCommand app=, options=[('no_color', False), ('pythonpath', None), ('settings', None), ('traceback', None), ('verbosity', %(_)s'1')]")) + self.assertOutput(out, "EXECUTE:AppCommand name=django.contrib.auth, options=") + self.assertOutput(out, str_prefix(", options=[('no_color', False), ('pythonpath', None), ('settings', None), ('traceback', None), ('verbosity', %(_)s'1')]")) + self.assertOutput(out, "EXECUTE:AppCommand name=django.contrib.contenttypes, options=") + self.assertOutput(out, str_prefix(", options=[('no_color', False), ('pythonpath', None), ('settings', None), ('traceback', None), ('verbosity', %(_)s'1')]")) def test_app_command_invalid_appname(self): "User AppCommands can execute when a single app name is provided" From c81fae6b9588ab9ef1edd7309c00e72a87154bc1 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sat, 28 Dec 2013 09:53:02 +0100 Subject: [PATCH 088/208] Used app_label instead of appname. The last component of the dotted path to the application module is consistently referenced as the application "label". For instance it's AppConfig.label. appname could be confused with AppConfig.name, which is the full dotted path. --- django/core/management/commands/dumpdata.py | 20 +++--- django/core/management/commands/inspectdb.py | 2 +- django/core/management/commands/migrate.py | 2 +- django/core/management/commands/sqlmigrate.py | 2 +- django/db/migrations/executor.py | 2 +- django/views/debug.py | 2 +- docs/howto/custom-management-commands.txt | 4 +- docs/howto/initial-data.txt | 4 +- docs/man/django-admin.1 | 24 +++---- docs/ref/contrib/admin/admindocs.txt | 4 +- docs/ref/django-admin.txt | 72 +++++++++---------- docs/topics/migrations.txt | 2 +- .../management/commands/app_command.py | 2 +- tests/admin_scripts/tests.py | 4 +- 14 files changed, 75 insertions(+), 71 deletions(-) diff --git a/django/core/management/commands/dumpdata.py b/django/core/management/commands/dumpdata.py index 5982f07445..82d8432bc1 100644 --- a/django/core/management/commands/dumpdata.py +++ b/django/core/management/commands/dumpdata.py @@ -16,10 +16,12 @@ class Command(BaseCommand): make_option('--indent', default=None, dest='indent', type='int', help='Specifies the indent level to use when pretty-printing output'), make_option('--database', action='store', dest='database', - default=DEFAULT_DB_ALIAS, help='Nominates a specific database to dump ' - 'fixtures from. Defaults to the "default" database.'), + default=DEFAULT_DB_ALIAS, + help='Nominates a specific database to dump fixtures from. ' + 'Defaults to the "default" database.'), make_option('-e', '--exclude', dest='exclude', action='append', default=[], - help='An appname or appname.ModelName to exclude (use multiple --exclude to exclude multiple apps/models).'), + help='An app_label or app_label.ModelName to exclude ' + '(use multiple --exclude to exclude multiple apps/models).'), make_option('-n', '--natural', action='store_true', dest='use_natural_keys', default=False, help='Use natural keys if they are available.'), make_option('--natural-foreign', action='store_true', dest='use_natural_foreign_keys', default=False, @@ -27,15 +29,17 @@ class Command(BaseCommand): make_option('--natural-primary', action='store_true', dest='use_natural_primary_keys', default=False, help='Use natural primary keys if they are available.'), make_option('-a', '--all', action='store_true', dest='use_base_manager', default=False, - help="Use Django's base manager to dump all models stored in the database, including those that would otherwise be filtered or modified by a custom manager."), - make_option('--pks', dest='primary_keys', help="Only dump objects with " - "given primary keys. Accepts a comma separated list of keys. " - "This option will only work when you specify one model."), + help="Use Django's base manager to dump all models stored in the database, " + "including those that would otherwise be filtered or modified by a custom manager."), + make_option('--pks', dest='primary_keys', + help="Only dump objects with given primary keys. " + "Accepts a comma separated list of keys. " + "This option will only work when you specify one model."), ) help = ("Output the contents of the database as a fixture of the given " "format (using each model's default manager unless --all is " "specified).") - args = '[appname appname.ModelName ...]' + args = '[app_label app_label.ModelName ...]' def handle(self, *app_labels, **options): format = options.get('format') diff --git a/django/core/management/commands/inspectdb.py b/django/core/management/commands/inspectdb.py index a24ae2b51e..0f291237f7 100644 --- a/django/core/management/commands/inspectdb.py +++ b/django/core/management/commands/inspectdb.py @@ -45,7 +45,7 @@ class Command(NoArgsCommand): yield "# * Remove `managed = False` lines for those models you wish to give write DB access" yield "# Feel free to rename the models, but don't rename db_table values or field names." yield "#" - yield "# Also note: You'll have to insert the output of 'django-admin.py sqlcustom [appname]'" + yield "# Also note: You'll have to insert the output of 'django-admin.py sqlcustom [app_label]'" yield "# into your database." yield "from __future__ import unicode_literals" yield '' diff --git a/django/core/management/commands/migrate.py b/django/core/management/commands/migrate.py index 1c808f1c7e..d7daafd279 100644 --- a/django/core/management/commands/migrate.py +++ b/django/core/management/commands/migrate.py @@ -75,7 +75,7 @@ class Command(BaseCommand): run_syncdb = False target_app_labels_only = True if len(args) > 2: - raise CommandError("Too many command-line arguments (expecting 'appname' or 'appname migrationname')") + raise CommandError("Too many command-line arguments (expecting 'app_label' or 'app_label migrationname')") elif len(args) == 2: app_label, migration_name = args if app_label not in executor.loader.migrated_apps: diff --git a/django/core/management/commands/sqlmigrate.py b/django/core/management/commands/sqlmigrate.py index 0e6da940e9..e828733f2c 100644 --- a/django/core/management/commands/sqlmigrate.py +++ b/django/core/management/commands/sqlmigrate.py @@ -31,7 +31,7 @@ class Command(BaseCommand): # Resolve command-line arguments into a migration if len(args) != 2: - raise CommandError("Wrong number of arguments (expecting 'sqlmigrate appname migrationname')") + raise CommandError("Wrong number of arguments (expecting 'sqlmigrate app_label migrationname')") else: app_label, migration_name = args if app_label not in executor.loader.migrated_apps: diff --git a/django/db/migrations/executor.py b/django/db/migrations/executor.py index 9ecdf771e3..7ebfe3d13b 100644 --- a/django/db/migrations/executor.py +++ b/django/db/migrations/executor.py @@ -22,7 +22,7 @@ class MigrationExecutor(object): plan = [] applied = set(self.loader.applied_migrations) for target in targets: - # If the target is (appname, None), that means unmigrate everything + # If the target is (app_label, None), that means unmigrate everything if target[1] is None: for root in self.loader.graph.root_nodes(): if root[0] == target[0]: diff --git a/django/views/debug.py b/django/views/debug.py index 8f7f9dc00a..4f2097600f 100644 --- a/django/views/debug.py +++ b/django/views/debug.py @@ -1149,7 +1149,7 @@ DEFAULT_URLCONF_TEMPLATE = """

    Of course, you haven't actually done any work yet. - Next, start your first app by running python manage.py startapp [appname]. + Next, start your first app by running python manage.py startapp [app_label].

    diff --git a/docs/howto/custom-management-commands.txt b/docs/howto/custom-management-commands.txt index 4f95838760..b5d461e2ce 100644 --- a/docs/howto/custom-management-commands.txt +++ b/docs/howto/custom-management-commands.txt @@ -199,8 +199,8 @@ All attributes can be set in your derived class and can be used in A string listing the arguments accepted by the command, suitable for use in help messages; e.g., a command which takes - a list of application names might set this to ''. + a list of application names might set this to ''. .. attribute:: BaseCommand.can_import_settings diff --git a/docs/howto/initial-data.txt b/docs/howto/initial-data.txt index 61885a0803..d003db6497 100644 --- a/docs/howto/initial-data.txt +++ b/docs/howto/initial-data.txt @@ -150,13 +150,13 @@ Database-backend-specific SQL data There's also a hook for backend-specific SQL data. For example, you can have separate initial-data files for PostgreSQL and SQLite. For each app, Django looks for a file called -``/sql/..sql``, where ```` is +``/sql/..sql``, where ```` is your app directory, ```` is the model's name in lowercase and ```` is the last part of the module name provided for the :setting:`ENGINE ` in your settings file (e.g., if you have defined a database with an :setting:`ENGINE ` value of ``django.db.backends.sqlite3``, Django will look for -``/sql/.sqlite3.sql``). +``/sql/.sqlite3.sql``). Backend-specific SQL data is executed before non-backend-specific SQL data. For example, if your app contains the files ``sql/person.sql`` diff --git a/docs/man/django-admin.1 b/docs/man/django-admin.1 index c72c3520b5..c9932ac36f 100644 --- a/docs/man/django-admin.1 +++ b/docs/man/django-admin.1 @@ -40,7 +40,7 @@ Displays differences between the current and Django's default settings. Settings that don't appear in the defaults are followed by "###". .TP -.BI "dumpdata [" "\-\-all" "] [" "\-\-format=FMT" "] [" "\-\-indent=NUM" "] [" "\-\-natural=NATURAL" "] [" "appname appname appname.Model ..." "]" +.BI "dumpdata [" "\-\-all" "] [" "\-\-format=FMT" "] [" "\-\-indent=NUM" "] [" "\-\-natural=NATURAL" "] [" "app_label app_label app_label.Model ..." "]" Outputs to standard output all data in the database associated with the named application(s). .TP @@ -54,7 +54,7 @@ model module. .BI "loaddata [" "fixture fixture ..." "]" Searches for and loads the contents of the named fixture into the database. .TP -.BI "install [" "appname ..." "]" +.BI "install [" "app_label ..." "]" Executes .B sqlall for the given app(s) in the current database. @@ -79,33 +79,33 @@ The option forces the use of the standard Python interpreter even when IPython is installed. .TP -.BI "sql [" "appname ..." "]" +.BI "sql [" "app_label ..." "]" Prints the CREATE TABLE SQL statements for the given app name(s). .TP -.BI "sqlall [" "appname ..." "]" +.BI "sqlall [" "app_label ..." "]" Prints the CREATE TABLE, initial\-data and CREATE INDEX SQL statements for the given model module name(s). .TP -.BI "sqlclear [" "appname ..." "]" +.BI "sqlclear [" "app_label ..." "]" Prints the DROP TABLE SQL statements for the given app name(s). .TP -.BI "sqlcustom [" "appname ..." "]" +.BI "sqlcustom [" "app_label ..." "]" Prints the custom SQL statements for the given app name(s). .TP -.BI "sqlflush [" "appname ..." "]" +.BI "sqlflush [" "app_label ..." "]" Prints the SQL statements that would be executed for the "flush" command. .TP -.BI "sqlindexes [" "appname ..." "]" +.BI "sqlindexes [" "app_label ..." "]" Prints the CREATE INDEX SQL statements for the given model module name(s). .TP -.BI "sqlinitialdata [" "appname ..." "]" +.BI "sqlinitialdata [" "app_label ..." "]" Prints the initial INSERT SQL statements for the given app name(s). .TP -.BI "sqlsequencereset [" "appname ..." "]" +.BI "sqlsequencereset [" "app_label ..." "]" Prints the SQL statements for resetting PostgreSQL sequences for the given app name(s). .TP -.BI "startapp [" "\-\-template=PATH_OR_URL" "] [" "\-\-extension=EXTENSION" "] [" "\-\-name=FILENAME" "] [" "appname" "] [" "destination" "]" +.BI "startapp [" "\-\-template=PATH_OR_URL" "] [" "\-\-extension=EXTENSION" "] [" "\-\-name=FILENAME" "] [" "app_label" "] [" "destination" "]" Creates a Django app directory structure for the given app name in the current directory or the optional destination. .TP @@ -117,7 +117,7 @@ in the current directory or the optional destination. Runs migrations for apps containing migrations, and just creates missing tables for apps without migrations. .TP -.BI "test [" "\-\-verbosity" "] [" "\-\-failfast" "] [" "appname ..." "]" +.BI "test [" "\-\-verbosity" "] [" "\-\-failfast" "] [" "app_label ..." "]" Runs the test suite for the specified applications, or the entire project if no apps are specified .TP diff --git a/docs/ref/contrib/admin/admindocs.txt b/docs/ref/contrib/admin/admindocs.txt index f903e8efff..c5386c5b2f 100644 --- a/docs/ref/contrib/admin/admindocs.txt +++ b/docs/ref/contrib/admin/admindocs.txt @@ -44,8 +44,8 @@ hyperlinks to other components: ================= ======================= Django Component reStructuredText roles ================= ======================= -Models ``:model:`appname.ModelName``` -Views ``:view:`appname.view_name``` +Models ``:model:`app_label.ModelName``` +Views ``:view:`app_label.view_name``` Template tags ``:tag:`tagname``` Template filters ``:filter:`filtername``` Templates ``:template:`path/to/template.html``` diff --git a/docs/ref/django-admin.txt b/docs/ref/django-admin.txt index 9a458152c9..97923011f0 100644 --- a/docs/ref/django-admin.txt +++ b/docs/ref/django-admin.txt @@ -183,8 +183,8 @@ if they have Django's default value. Such settings are prefixed by ``"###"``. The :djadminopt:`--all` option was added. -dumpdata --------------------------------------------- +dumpdata +-------------------------------------------------- .. django-admin:: dumpdata @@ -217,10 +217,10 @@ easy for humans to read, so you can use the ``--indent`` option to pretty-print the output with a number of indentation spaces. The :djadminopt:`--exclude` option may be provided to prevent specific -applications or models (specified as in the form of ``appname.ModelName``) from -being dumped. If you specify a model name to ``dumpdata``, the dumped output -will be restricted to that model, rather than the entire application. You can -also mix application names and model names. +applications or models (specified as in the form of ``app_label.ModelName``) +from being dumped. If you specify a model name to ``dumpdata``, the dumped +output will be restricted to that model, rather than the entire application. +You can also mix application names and model names. The :djadminopt:`--database` option can be used to specify the database from which data will be dumped. @@ -398,7 +398,7 @@ directories will be included in the search path. For example:: django-admin.py loaddata foo/bar/mydata.json -would search ``/fixtures/foo/bar/mydata.json`` for each installed +would search ``/fixtures/foo/bar/mydata.json`` for each installed application, ``/foo/bar/mydata.json`` for each directory in :setting:`FIXTURE_DIRS`, and the literal path ``foo/bar/mydata.json``. @@ -587,8 +587,8 @@ Use the ``--keep-pot`` option to prevent Django from deleting the temporary .pot files it generates before creating the .po file. This is useful for debugging errors which may prevent the final language files from being created. -makemigrations [] --------------------------- +makemigrations [] +---------------------------- .. django-admin:: makemigrations @@ -610,8 +610,8 @@ for advanced users and should not be used unless you are familiar with the migration format, migration operations, and the dependencies between your migrations. -migrate [ []] -------------------------------------- +migrate [ []] +--------------------------------------- .. django-admin:: migrate @@ -625,10 +625,10 @@ The behavior of this command changes depending on the arguments provided: * No arguments: All migrated apps have all of their migrations run, and all unmigrated apps are synchronized with the database, -* ````: The specified app has its migrations run, up to the most +* ````: The specified app has its migrations run, up to the most recent migration. This may involve running other apps' migrations too, due to dependencies. -* `` ``: Brings the database schema to a state where it +* `` ``: Brings the database schema to a state where it would have just run the given migration, but no further - this may involve unapplying migrations if you have previously migrated past the named migration. Use the name `zero` to unapply all migrations for an app. @@ -942,8 +942,8 @@ behavior you can use the ``--no-startup`` option. e.g.:: The ``--no-startup`` option was added in Django 1.6. -sql -------------------------- +sql +----------------------------- .. django-admin:: sql @@ -952,8 +952,8 @@ Prints the CREATE TABLE SQL statements for the given app name(s). The :djadminopt:`--database` option can be used to specify the database for which to print the SQL. -sqlall ----------------------------- +sqlall +-------------------------------- .. django-admin:: sqlall @@ -965,8 +965,8 @@ specify initial data. The :djadminopt:`--database` option can be used to specify the database for which to print the SQL. -sqlclear ------------------------------- +sqlclear +---------------------------------- .. django-admin:: sqlclear @@ -975,19 +975,19 @@ Prints the DROP TABLE SQL statements for the given app name(s). The :djadminopt:`--database` option can be used to specify the database for which to print the SQL. -sqlcustom -------------------------------- +sqlcustom +----------------------------------- .. django-admin:: sqlcustom Prints the custom SQL statements for the given app name(s). For each model in each specified app, this command looks for the file -``/sql/.sql``, where ```` is the given app name and -```` is the model's name in lowercase. For example, if you have an -app ``news`` that includes a ``Story`` model, ``sqlcustom`` will attempt -to read a file ``news/sql/story.sql`` and append it to the output of this -command. +``/sql/.sql``, where ```` is the given app +name and ```` is the model's name in lowercase. For example, if you +have an app ``news`` that includes a ``Story`` model, ``sqlcustom`` will +attempt to read a file ``news/sql/story.sql`` and append it to the output of +this command. Each of the SQL files, if given, is expected to contain valid SQL. The SQL files are piped directly into the database after all of the models' @@ -999,8 +999,8 @@ Note that the order in which the SQL files are processed is undefined. The :djadminopt:`--database` option can be used to specify the database for which to print the SQL. -sqldropindexes ------------------------------------- +sqldropindexes +---------------------------------------- .. django-admin:: sqldropindexes @@ -1022,8 +1022,8 @@ command. The :djadminopt:`--database` option can be used to specify the database for which to print the SQL. -sqlindexes --------------------------------- +sqlindexes +------------------------------------ .. django-admin:: sqlindexes @@ -1032,8 +1032,8 @@ Prints the CREATE INDEX SQL statements for the given app name(s). The :djadminopt:`--database` option can be used to specify the database for which to print the SQL. -sqlmigrate ------------------------------------- +sqlmigrate +-------------------------------------- .. django-admin:: sqlmigrate @@ -1050,8 +1050,8 @@ By default, the SQL created is for running the migration in the forwards direction. Pass ``--backwards`` to generate the SQL for un-applying the migration instead. -sqlsequencereset --------------------------------------- +sqlsequencereset +------------------------------------------ .. django-admin:: sqlsequencereset @@ -1066,8 +1066,8 @@ of sync with its automatically incremented field data. The :djadminopt:`--database` option can be used to specify the database for which to print the SQL. -startapp [destination] --------------------------------- +startapp [destination] +---------------------------------- .. django-admin:: startapp diff --git a/docs/topics/migrations.txt b/docs/topics/migrations.txt index ead5ecffdb..6621c4e959 100644 --- a/docs/topics/migrations.txt +++ b/docs/topics/migrations.txt @@ -264,7 +264,7 @@ If your app already has models and database tables, and doesn't have migrations yet (for example, you created it against a previous Django version), you'll need to convert it to use migrations; this is a simple process:: - $ python manage.py makemigrations yourappname + $ python manage.py makemigrations your_app_label This will make a new initial migration for your app. Now, when you run :djadmin:`migrate`, Django will detect that you have an initial migration diff --git a/tests/admin_scripts/management/commands/app_command.py b/tests/admin_scripts/management/commands/app_command.py index 5f221f48ee..4706645484 100644 --- a/tests/admin_scripts/management/commands/app_command.py +++ b/tests/admin_scripts/management/commands/app_command.py @@ -4,7 +4,7 @@ from django.core.management.base import AppCommand class Command(AppCommand): help = 'Test Application-based commands' requires_model_validation = False - args = '[appname ...]' + args = '[app_label ...]' def handle_app_config(self, app_config, **options): print('EXECUTE:AppCommand name=%s, options=%s' % (app_config.name, sorted(options.items()))) diff --git a/tests/admin_scripts/tests.py b/tests/admin_scripts/tests.py index cc0531a124..3587748c8e 100644 --- a/tests/admin_scripts/tests.py +++ b/tests/admin_scripts/tests.py @@ -1435,13 +1435,13 @@ class CommandTypes(AdminScriptTestCase): self.assertOutput(out, "EXECUTE:AppCommand name=django.contrib.contenttypes, options=") self.assertOutput(out, str_prefix(", options=[('no_color', False), ('pythonpath', None), ('settings', None), ('traceback', None), ('verbosity', %(_)s'1')]")) - def test_app_command_invalid_appname(self): + def test_app_command_invalid_app_label(self): "User AppCommands can execute when a single app name is provided" args = ['app_command', 'NOT_AN_APP'] out, err = self.run_manage(args) self.assertOutput(err, "No installed app with label 'NOT_AN_APP'.") - def test_app_command_some_invalid_appnames(self): + def test_app_command_some_invalid_app_labels(self): "User AppCommands can execute when some of the provided app names are invalid" args = ['app_command', 'auth', 'NOT_AN_APP'] out, err = self.run_manage(args) From b7a7baa55471e67b98d509cddf2f0994f7ce786f Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Sat, 28 Dec 2013 11:08:50 +0100 Subject: [PATCH 089/208] Fixed #21618 -- Added hints about openlayers.js hosting Thanks kz26 for the report and Tim Graham for the excellent review. --- docs/ref/contrib/gis/forms-api.txt | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/ref/contrib/gis/forms-api.txt b/docs/ref/contrib/gis/forms-api.txt index 435bcfc8b1..a556fac1fc 100644 --- a/docs/ref/contrib/gis/forms-api.txt +++ b/docs/ref/contrib/gis/forms-api.txt @@ -156,6 +156,20 @@ Widget classes This is the default widget used by all GeoDjango form fields. ``template_name`` is ``gis/openlayers.html``. + ``OpenLayersWidget`` and :class:`OSMWidget` use the ``openlayers.js`` file + hosted on the ``openlayers.org`` Web site. This works for basic usage + during development, but isn't appropropriate for a production deployment as + ``openlayers.org/api/`` has no guaranteed uptime and runs on a slow server. + You are therefore advised to subclass these widgets in order to specify + your own version of the ``openlayers.js`` file in the ``js`` property of + the inner ``Media`` class (see :ref:`assets-as-a-static-definition`). You + can host a copy of ``openlayers.js`` + `tailored to your needs`_ on your own server or refer to a copy from a + content-delivery network like http://cdnjs.com/. This will also allow + you to serve the JavaScript file(s) using the ``https`` protocol if needed. + + .. _tailored to your needs: http://docs.openlayers.org/library/deploying.html + ``OSMWidget`` .. class:: OSMWidget @@ -163,3 +177,9 @@ Widget classes This widget uses an OpenStreetMap base layer (Mapnik) to display geographic objects on. ``template_name`` is ``gis/openlayers-osm.html``. + + The :class:`OpenLayersWidget` note about JavaScript file hosting above also + applies here. See also this `FAQ answer`_ about ``https`` access to map + tiles. + + .. _FAQ answer: https://help.openstreetmap.org/questions/10920/how-to-embed-a-map-in-my-https-site From f28ea0230846c81e9b6725454bb3a10df24678aa Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Sat, 28 Dec 2013 12:40:10 +0100 Subject: [PATCH 090/208] Fixed #21093 -- Ensured that mails are not base64 encoded on python 3.3.3+. Thanks to Arfrever for the report and Aymeric for the review. --- django/core/mail/message.py | 71 ++++++++++++++++--------------------- 1 file changed, 30 insertions(+), 41 deletions(-) diff --git a/django/core/mail/message.py b/django/core/mail/message.py index 85699aacec..051a00fa81 100644 --- a/django/core/mail/message.py +++ b/django/core/mail/message.py @@ -3,9 +3,10 @@ from __future__ import unicode_literals import mimetypes import os import random +import sys import time -from email import charset as Charset, encoders as Encoders, message_from_string -from email.generator import Generator +from email import (charset as Charset, encoders as Encoders, + message_from_string, generator) from email.message import Message from email.mime.text import MIMEText from email.mime.multipart import MIMEMultipart @@ -121,13 +122,7 @@ def sanitize_address(addr, encoding): return formataddr((nm, addr)) -class SafeMIMEMessage(MIMEMessage): - - def __setitem__(self, name, val): - # message/rfc822 attachments must be ASCII - name, val = forbid_multi_line_headers(name, val, 'ascii') - MIMEMessage.__setitem__(self, name, val) - +class MIMEMixin(): def as_string(self, unixfrom=False): """Return the entire formatted message as a string. Optional `unixfrom' when True, means include the Unix From_ envelope @@ -136,13 +131,33 @@ class SafeMIMEMessage(MIMEMessage): This overrides the default as_string() implementation to not mangle lines that begin with 'From '. See bug #13433 for details. """ - fp = six.StringIO() - g = Generator(fp, mangle_from_=False) - g.flatten(self, unixfrom=unixfrom) - return fp.getvalue() + # Using a normal Generator on python 3 will yield a string, which will + # get base64 encoded in some cases to ensure that it's always convertable + # to ascii. We don't want base64 encoded emails, so we use a BytesGenertor + # which will do the right thing and then decode according to our known + # encoding. See #21093 and #3472 for details. + if six.PY3 and sys.version_info >= (3, 3, 3): + fp = six.BytesIO() + g = generator.BytesGenerator(fp, mangle_from_=False) + g.flatten(self, unixfrom=unixfrom) + encoding = self.get_charset().get_output_charset() if self.get_charset() else 'utf-8' + return fp.getvalue().decode(encoding) + else: + fp = six.StringIO() + g = generator.Generator(fp, mangle_from_=False) + g.flatten(self, unixfrom=unixfrom) + return fp.getvalue() -class SafeMIMEText(MIMEText): +class SafeMIMEMessage(MIMEMixin, MIMEMessage): + + def __setitem__(self, name, val): + # message/rfc822 attachments must be ASCII + name, val = forbid_multi_line_headers(name, val, 'ascii') + MIMEMessage.__setitem__(self, name, val) + + +class SafeMIMEText(MIMEMixin, MIMEText): def __init__(self, text, subtype, charset): self.encoding = charset @@ -161,21 +176,8 @@ class SafeMIMEText(MIMEText): name, val = forbid_multi_line_headers(name, val, self.encoding) MIMEText.__setitem__(self, name, val) - def as_string(self, unixfrom=False): - """Return the entire formatted message as a string. - Optional `unixfrom' when True, means include the Unix From_ envelope - header. - This overrides the default as_string() implementation to not mangle - lines that begin with 'From '. See bug #13433 for details. - """ - fp = six.StringIO() - g = Generator(fp, mangle_from_=False) - g.flatten(self, unixfrom=unixfrom) - return fp.getvalue() - - -class SafeMIMEMultipart(MIMEMultipart): +class SafeMIMEMultipart(MIMEMixin, MIMEMultipart): def __init__(self, _subtype='mixed', boundary=None, _subparts=None, encoding=None, **_params): self.encoding = encoding @@ -185,19 +187,6 @@ class SafeMIMEMultipart(MIMEMultipart): name, val = forbid_multi_line_headers(name, val, self.encoding) MIMEMultipart.__setitem__(self, name, val) - def as_string(self, unixfrom=False): - """Return the entire formatted message as a string. - Optional `unixfrom' when True, means include the Unix From_ envelope - header. - - This overrides the default as_string() implementation to not mangle - lines that begin with 'From '. See bug #13433 for details. - """ - fp = six.StringIO() - g = Generator(fp, mangle_from_=False) - g.flatten(self, unixfrom=unixfrom) - return fp.getvalue() - class EmailMessage(object): """ From 6a6136141b133aff7583d51d687719961d261244 Mon Sep 17 00:00:00 2001 From: Ramiro Morales Date: Sat, 28 Dec 2013 11:05:56 -0300 Subject: [PATCH 091/208] Implemented #10164 for new schema migration code. Made it use 'AUTOINCREMENT' suffix for PK creation. This way it doeesn't regress when compared with the 'traditional' DB backend creation infrastructure. Refs #10164. --- django/db/backends/schema.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/django/db/backends/schema.py b/django/db/backends/schema.py index 5ac8d51a3d..b26f41c89a 100644 --- a/django/db/backends/schema.py +++ b/django/db/backends/schema.py @@ -185,6 +185,10 @@ class BaseDatabaseSchemaEditor(object): db_params = field.db_parameters(connection=self.connection) if db_params['check']: definition += " CHECK (%s)" % db_params['check'] + # Autoincrement SQL (for backends with inline variant) + col_type_suffix = field.db_type_suffix(connection=self.connection) + if col_type_suffix: + definition += " %s" % col_type_suffix # Add the SQL to our big list column_sqls.append("%s %s" % ( self.quote_name(field.column), @@ -214,7 +218,7 @@ class BaseDatabaseSchemaEditor(object): "to_column": self.quote_name(to_column), } ) - # Autoincrement SQL + # Autoincrement SQL (for backends with post table definition variant) if field.get_internal_type() == "AutoField": autoinc_sql = self.connection.ops.autoinc_sql(model._meta.db_table, field.column) if autoinc_sql: From 280c1a65ccacd679bf298bf2b169ff01e7266b8e Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Sat, 28 Dec 2013 15:24:25 +0100 Subject: [PATCH 092/208] Worked around a bug in python 3.3.3. Refs #21093 --- django/core/mail/message.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/django/core/mail/message.py b/django/core/mail/message.py index 051a00fa81..cde37ea6d2 100644 --- a/django/core/mail/message.py +++ b/django/core/mail/message.py @@ -167,7 +167,14 @@ class SafeMIMEText(MIMEMixin, MIMEText): # We do it manually and trigger re-encoding of the payload. MIMEText.__init__(self, text, subtype, None) del self['Content-Transfer-Encoding'] - self.set_payload(text, utf8_charset) + # Work around a bug in python 3.3.3 [sic], see + # http://bugs.python.org/issue19063 for details. + if sys.version_info[:3] == (3, 3, 3): + payload = text.encode(utf8_charset.output_charset) + self._payload = payload.decode('ascii', 'surrogateescape') + self.set_charset(utf8_charset) + else: + self.set_payload(text, utf8_charset) self.replace_header('Content-Type', 'text/%s; charset="%s"' % (subtype, charset)) else: MIMEText.__init__(self, text, subtype, charset) From 71a03e01aa19cbde08e915d156abf39b67d904ef Mon Sep 17 00:00:00 2001 From: ijl Date: Thu, 26 Dec 2013 23:14:08 -0500 Subject: [PATCH 093/208] Fixed #20346 -- Made cache middleware vary on the full URL. Previously, only the URL path was included in the cache key. Thanks jamey for the suggestion. --- django/utils/cache.py | 20 ++++++------- docs/releases/1.7.txt | 13 ++++++++ docs/topics/cache.txt | 8 ++++- tests/cache/tests.py | 70 ++++++++++++++++++++++++++++++++++++++----- 4 files changed, 92 insertions(+), 19 deletions(-) diff --git a/django/utils/cache.py b/django/utils/cache.py index d89408a7a2..365733fedf 100644 --- a/django/utils/cache.py +++ b/django/utils/cache.py @@ -191,25 +191,25 @@ def _generate_cache_key(request, method, headerlist, key_prefix): value = request.META.get(header, None) if value is not None: ctx.update(force_bytes(value)) - path = hashlib.md5(force_bytes(iri_to_uri(request.get_full_path()))) + url = hashlib.md5(force_bytes(iri_to_uri(request.build_absolute_uri()))) cache_key = 'views.decorators.cache.cache_page.%s.%s.%s.%s' % ( - key_prefix, method, path.hexdigest(), ctx.hexdigest()) + key_prefix, method, url.hexdigest(), ctx.hexdigest()) return _i18n_cache_key_suffix(request, cache_key) def _generate_cache_header_key(key_prefix, request): """Returns a cache key for the header cache.""" - path = hashlib.md5(force_bytes(iri_to_uri(request.get_full_path()))) + url = hashlib.md5(force_bytes(iri_to_uri(request.build_absolute_uri()))) cache_key = 'views.decorators.cache.cache_header.%s.%s' % ( - key_prefix, path.hexdigest()) + key_prefix, url.hexdigest()) return _i18n_cache_key_suffix(request, cache_key) def get_cache_key(request, key_prefix=None, method='GET', cache=None): """ - Returns a cache key based on the request path and query. It can be used + Returns a cache key based on the request URL and query. It can be used in the request phase because it pulls the list of headers to take into - account from the global path registry and uses those to build a cache key + account from the global URL registry and uses those to build a cache key to check against. If there is no headerlist stored, the page needs to be rebuilt, so this @@ -229,9 +229,9 @@ def get_cache_key(request, key_prefix=None, method='GET', cache=None): def learn_cache_key(request, response, cache_timeout=None, key_prefix=None, cache=None): """ - Learns what headers to take into account for some request path from the - response object. It stores those headers in a global path registry so that - later access to that path will know what headers to take into account + Learns what headers to take into account for some request URL from the + response object. It stores those headers in a global URL registry so that + later access to that URL will know what headers to take into account without building the response object itself. The headers are named in the Vary header of the response, but we want to prevent response generation. @@ -264,7 +264,7 @@ def learn_cache_key(request, response, cache_timeout=None, key_prefix=None, cach return _generate_cache_key(request, request.method, headerlist, key_prefix) else: # if there is no Vary header, we still need a cache key - # for the request.get_full_path() + # for the request.build_absolute_uri() cache.set(cache_key, [], cache_timeout) return _generate_cache_key(request, request.method, [], key_prefix) diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 2c3e3f217d..dbbdcf9c81 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -622,6 +622,19 @@ cache-specific errors. This has been fixed in Django 1.7, see .. _Ticket #21200: https://code.djangoproject.com/ticket/21200 +Cache keys are now generated from the request's absolute URL +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Previous versions of Django generated cache keys using a request's path and +query string but not the scheme or host. If a Django application was serving +multiple subdomains or domains, cache keys could collide. In Django 1.7, cache +keys vary by the absolute URL of the request including scheme, host, path, and +query string. For example, the URL portion of a cache key is now generated from +``http://www.example.com/path/to/?key=val`` rather than ``/path/to/?key=val``. +The cache keys generated by Django 1.7 will be different from the keys +generated by older versions of Django. After upgrading to Django 1.7, the first +request to any previously cached URL will be a cache miss . + Passing ``None`` to ``Manager.db_manager()`` ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/topics/cache.txt b/docs/topics/cache.txt index 7ef7285fb7..5fc352f4ec 100644 --- a/docs/topics/cache.txt +++ b/docs/topics/cache.txt @@ -1046,13 +1046,19 @@ the contents of a Web page depend on a user's language preference, the page is said to "vary on language." By default, Django's cache system creates its cache keys using the requested -path and query -- e.g., ``"/stories/2005/?order_by=author"``. This means every +fully-qualified URL -- e.g., +``"http://www.example.com/stories/2005/?order_by=author"``. This means every request to that URL will use the same cached version, regardless of user-agent differences such as cookies or language preferences. However, if this page produces different content based on some difference in request headers -- such as a cookie, or a language, or a user-agent -- you'll need to use the ``Vary`` header to tell caching mechanisms that the page output depends on those things. + .. versionchanged:: 1.7 + + Cache keys use the request's fully-qualified URL rather than path + and query string. + To do this in Django, use the convenient :func:`django.views.decorators.vary.vary_on_headers` view decorator, like so:: diff --git a/tests/cache/tests.py b/tests/cache/tests.py index e17bad1523..94790ed740 100644 --- a/tests/cache/tests.py +++ b/tests/cache/tests.py @@ -1198,8 +1198,20 @@ class CacheUtils(TestCase): """TestCase for django.utils.cache functions.""" def setUp(self): + self.host = 'www.example.com' self.path = '/cache/test/' - self.factory = RequestFactory() + self.factory = RequestFactory(HTTP_HOST=self.host) + + def _get_request_cache(self, method='GET', query_string=None, update_cache=None): + request = self._get_request(self.host, self.path, + method, query_string=query_string) + request._cache_update_cache = True if not update_cache else update_cache + return request + + def _set_cache(self, request, msg): + response = HttpResponse() + response.content = msg + return UpdateCacheMiddleware().process_response(request, response) def test_patch_vary_headers(self): headers = ( @@ -1229,10 +1241,19 @@ class CacheUtils(TestCase): self.assertEqual(get_cache_key(request), None) # Set headers to an empty list. learn_cache_key(request, response) - self.assertEqual(get_cache_key(request), 'views.decorators.cache.cache_page.settingsprefix.GET.9fa0fd092afb73bdce204bb4f94d5804.d41d8cd98f00b204e9800998ecf8427e') + + self.assertEqual( + get_cache_key(request), + 'views.decorators.cache.cache_page.settingsprefix.GET.' + '18a03f9c9649f7d684af5db3524f5c99.d41d8cd98f00b204e9800998ecf8427e' + ) # Verify that a specified key_prefix is taken into account. learn_cache_key(request, response, key_prefix=key_prefix) - self.assertEqual(get_cache_key(request, key_prefix=key_prefix), 'views.decorators.cache.cache_page.localprefix.GET.9fa0fd092afb73bdce204bb4f94d5804.d41d8cd98f00b204e9800998ecf8427e') + self.assertEqual( + get_cache_key(request, key_prefix=key_prefix), + 'views.decorators.cache.cache_page.localprefix.GET.' + '18a03f9c9649f7d684af5db3524f5c99.d41d8cd98f00b204e9800998ecf8427e' + ) def test_get_cache_key_with_query(self): request = self.factory.get(self.path, {'test': 1}) @@ -1242,7 +1263,22 @@ class CacheUtils(TestCase): # Set headers to an empty list. learn_cache_key(request, response) # Verify that the querystring is taken into account. - self.assertEqual(get_cache_key(request), 'views.decorators.cache.cache_page.settingsprefix.GET.d11198ba31883732b0de5786a80cc12b.d41d8cd98f00b204e9800998ecf8427e') + + self.assertEqual( + get_cache_key(request), + 'views.decorators.cache.cache_page.settingsprefix.GET.' + 'beaf87a9a99ee81c673ea2d67ccbec2a.d41d8cd98f00b204e9800998ecf8427e' + ) + + def test_cache_key_varies_by_url(self): + """ + get_cache_key keys differ by fully-qualfied URL instead of path + """ + request1 = self.factory.get(self.path, HTTP_HOST='sub-1.example.com') + learn_cache_key(request1, HttpResponse()) + request2 = self.factory.get(self.path, HTTP_HOST='sub-2.example.com') + learn_cache_key(request2, HttpResponse()) + self.assertTrue(get_cache_key(request1) != get_cache_key(request2)) def test_learn_cache_key(self): request = self.factory.head(self.path) @@ -1250,7 +1286,12 @@ class CacheUtils(TestCase): response['Vary'] = 'Pony' # Make sure that the Vary header is added to the key hash learn_cache_key(request, response) - self.assertEqual(get_cache_key(request), 'views.decorators.cache.cache_page.settingsprefix.GET.9fa0fd092afb73bdce204bb4f94d5804.d41d8cd98f00b204e9800998ecf8427e') + + self.assertEqual( + get_cache_key(request), + 'views.decorators.cache.cache_page.settingsprefix.GET.' + '18a03f9c9649f7d684af5db3524f5c99.d41d8cd98f00b204e9800998ecf8427e' + ) def test_patch_cache_control(self): tests = ( @@ -1874,10 +1915,19 @@ class TestWithTemplateResponse(TestCase): self.assertEqual(get_cache_key(request), None) # Set headers to an empty list. learn_cache_key(request, response) - self.assertEqual(get_cache_key(request), 'views.decorators.cache.cache_page.settingsprefix.GET.9fa0fd092afb73bdce204bb4f94d5804.d41d8cd98f00b204e9800998ecf8427e') + + self.assertEqual( + get_cache_key(request), + 'views.decorators.cache.cache_page.settingsprefix.GET.' + '58a0a05c8a5620f813686ff969c26853.d41d8cd98f00b204e9800998ecf8427e' + ) # Verify that a specified key_prefix is taken into account. learn_cache_key(request, response, key_prefix=key_prefix) - self.assertEqual(get_cache_key(request, key_prefix=key_prefix), 'views.decorators.cache.cache_page.localprefix.GET.9fa0fd092afb73bdce204bb4f94d5804.d41d8cd98f00b204e9800998ecf8427e') + self.assertEqual( + get_cache_key(request, key_prefix=key_prefix), + 'views.decorators.cache.cache_page.localprefix.GET.' + '58a0a05c8a5620f813686ff969c26853.d41d8cd98f00b204e9800998ecf8427e' + ) def test_get_cache_key_with_query(self): request = self.factory.get(self.path, {'test': 1}) @@ -1887,7 +1937,11 @@ class TestWithTemplateResponse(TestCase): # Set headers to an empty list. learn_cache_key(request, response) # Verify that the querystring is taken into account. - self.assertEqual(get_cache_key(request), 'views.decorators.cache.cache_page.settingsprefix.GET.d11198ba31883732b0de5786a80cc12b.d41d8cd98f00b204e9800998ecf8427e') + self.assertEqual( + get_cache_key(request), + 'views.decorators.cache.cache_page.settingsprefix.GET.' + '0f1c2d56633c943073c4569d9a9502fe.d41d8cd98f00b204e9800998ecf8427e' + ) @override_settings(USE_ETAGS=False) def test_without_etag(self): From 81a5e35c8d357051e558e6f0d1b6ff7a7523a537 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Sat, 28 Dec 2013 11:33:24 -0500 Subject: [PATCH 094/208] Fixed doc indentation in previous commit. --- docs/topics/cache.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/topics/cache.txt b/docs/topics/cache.txt index 5fc352f4ec..37e94957db 100644 --- a/docs/topics/cache.txt +++ b/docs/topics/cache.txt @@ -1054,10 +1054,10 @@ produces different content based on some difference in request headers -- such as a cookie, or a language, or a user-agent -- you'll need to use the ``Vary`` header to tell caching mechanisms that the page output depends on those things. - .. versionchanged:: 1.7 +.. versionchanged:: 1.7 - Cache keys use the request's fully-qualified URL rather than path - and query string. + Cache keys use the request's fully-qualified URL rather than just the path + and query string. To do this in Django, use the convenient :func:`django.views.decorators.vary.vary_on_headers` view decorator, like so:: From 5dfd824d38ec7d1f695494e46d603e89cae68661 Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Sat, 28 Dec 2013 18:35:17 +0100 Subject: [PATCH 095/208] Introduced as_bytes for SafeMIMEText (and other SafeMIME-classes). This is to provide a consistent interface (namely bytes) for the smtp backend which after all sends bytes over the wire; encoding with as_string yields different results since mails as unicode are not really specified. as_string stays for backwardscompatibilty mostly and some debug outputs. But keep in mind that the output doesn't match as_bytes! --- django/core/mail/backends/smtp.py | 5 +--- django/core/mail/message.py | 33 +++++++++++---------- tests/mail/tests.py | 48 +++++++++++++++++-------------- 3 files changed, 45 insertions(+), 41 deletions(-) diff --git a/django/core/mail/backends/smtp.py b/django/core/mail/backends/smtp.py index c9e0a18728..e72e372ca9 100644 --- a/django/core/mail/backends/smtp.py +++ b/django/core/mail/backends/smtp.py @@ -7,7 +7,6 @@ from django.conf import settings from django.core.mail.backends.base import BaseEmailBackend from django.core.mail.utils import DNS_NAME from django.core.mail.message import sanitize_address -from django.utils.encoding import force_bytes class EmailBackend(BaseEmailBackend): @@ -111,10 +110,8 @@ class EmailBackend(BaseEmailBackend): recipients = [sanitize_address(addr, email_message.encoding) for addr in email_message.recipients()] message = email_message.message() - charset = message.get_charset().get_output_charset() if message.get_charset() else 'utf-8' try: - self.connection.sendmail(from_email, recipients, - force_bytes(message.as_string(), charset)) + self.connection.sendmail(from_email, recipients, message.as_bytes()) except smtplib.SMTPException: if not self.fail_silently: raise diff --git a/django/core/mail/message.py b/django/core/mail/message.py index cde37ea6d2..cdd265521b 100644 --- a/django/core/mail/message.py +++ b/django/core/mail/message.py @@ -131,21 +131,25 @@ class MIMEMixin(): This overrides the default as_string() implementation to not mangle lines that begin with 'From '. See bug #13433 for details. """ - # Using a normal Generator on python 3 will yield a string, which will - # get base64 encoded in some cases to ensure that it's always convertable - # to ascii. We don't want base64 encoded emails, so we use a BytesGenertor - # which will do the right thing and then decode according to our known - # encoding. See #21093 and #3472 for details. - if six.PY3 and sys.version_info >= (3, 3, 3): + fp = six.StringIO() + g = generator.Generator(fp, mangle_from_=False) + g.flatten(self, unixfrom=unixfrom) + return fp.getvalue() + + if six.PY2: + as_bytes = as_string + else: + def as_bytes(self, unixfrom=False): + """Return the entire formatted message as bytes. + Optional `unixfrom' when True, means include the Unix From_ envelope + header. + + This overrides the default as_bytes() implementation to not mangle + lines that begin with 'From '. See bug #13433 for details. + """ fp = six.BytesIO() g = generator.BytesGenerator(fp, mangle_from_=False) g.flatten(self, unixfrom=unixfrom) - encoding = self.get_charset().get_output_charset() if self.get_charset() else 'utf-8' - return fp.getvalue().decode(encoding) - else: - fp = six.StringIO() - g = generator.Generator(fp, mangle_from_=False) - g.flatten(self, unixfrom=unixfrom) return fp.getvalue() @@ -167,9 +171,8 @@ class SafeMIMEText(MIMEMixin, MIMEText): # We do it manually and trigger re-encoding of the payload. MIMEText.__init__(self, text, subtype, None) del self['Content-Transfer-Encoding'] - # Work around a bug in python 3.3.3 [sic], see - # http://bugs.python.org/issue19063 for details. - if sys.version_info[:3] == (3, 3, 3): + # Workaround for versions without http://bugs.python.org/issue19063 + if (3, 2) < sys.version_info < (3, 3, 4): payload = text.encode(utf8_charset.output_charset) self._payload = payload.decode('ascii', 'surrogateescape') self.set_charset(utf8_charset) diff --git a/tests/mail/tests.py b/tests/mail/tests.py index c9e4a06eaa..f7b9e07359 100644 --- a/tests/mail/tests.py +++ b/tests/mail/tests.py @@ -20,14 +20,16 @@ from django.core.mail.backends import console, dummy, locmem, filebased, smtp from django.core.mail.message import BadHeaderError from django.test import SimpleTestCase from django.test import override_settings -from django.utils.encoding import force_str, force_text +from django.utils.encoding import force_str, force_text, force_bytes from django.utils.six import PY3, StringIO, string_types from django.utils.translation import ugettext_lazy if PY3: from email.utils import parseaddr + from email import message_from_bytes else: from email.Utils import parseaddr + message_from_bytes = message_from_string class HeadersCheckMixin(object): @@ -231,13 +233,13 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): ('MIME-Version', '1.0'), ('Content-Type', 'text/plain; charset="iso-8859-1"'), ('Content-Transfer-Encoding', 'quoted-printable')}) - self.assertTrue(payload0.as_string().endswith('\n\nFirstname S=FCrname is a great guy.')) + self.assertTrue(payload0.as_bytes().endswith(b'\n\nFirstname S=FCrname is a great guy.')) payload1 = msg.message().get_payload(1) self.assertMessageHasHeaders(payload1, { ('MIME-Version', '1.0'), ('Content-Type', 'text/html; charset="iso-8859-1"'), ('Content-Transfer-Encoding', 'quoted-printable')}) - self.assertTrue(payload1.as_string().endswith('\n\n

    Firstname S=FCrname is a great guy.

    ')) + self.assertTrue(payload1.as_bytes().endswith(b'\n\n

    Firstname S=FCrname is a great guy.

    ')) def test_attachments(self): """Regression test for #9367""" @@ -248,8 +250,8 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): msg = EmailMultiAlternatives(subject, text_content, from_email, [to], headers=headers) msg.attach_alternative(html_content, "text/html") msg.attach("an attachment.pdf", b"%PDF-1.4.%...", mimetype="application/pdf") - msg_str = msg.message().as_string() - message = message_from_string(msg_str) + msg_bytes = msg.message().as_bytes() + message = message_from_bytes(msg_bytes) self.assertTrue(message.is_multipart()) self.assertEqual(message.get_content_type(), 'multipart/mixed') self.assertEqual(message.get_default_type(), 'text/plain') @@ -265,8 +267,8 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): msg = EmailMessage(subject, content, from_email, [to], headers=headers) # Unicode in file name msg.attach("une pièce jointe.pdf", b"%PDF-1.4.%...", mimetype="application/pdf") - msg_str = msg.message().as_string() - message = message_from_string(msg_str) + msg_bytes = msg.message().as_bytes() + message = message_from_bytes(msg_bytes) payload = message.get_payload() self.assertEqual(payload[1].get_filename(), 'une pièce jointe.pdf') @@ -348,31 +350,31 @@ class MailTests(HeadersCheckMixin, SimpleTestCase): # Regression for #13433 - Make sure that EmailMessage doesn't mangle # 'From ' in message body. email = EmailMessage('Subject', 'From the future', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'}) - self.assertFalse('>From the future' in email.message().as_string()) + self.assertFalse(b'>From the future' in email.message().as_bytes()) def test_dont_base64_encode(self): # Ticket #3472 # Shouldn't use Base64 encoding at all msg = EmailMessage('Subject', 'UTF-8 encoded body', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'}) - self.assertFalse('Content-Transfer-Encoding: base64' in msg.message().as_string()) + self.assertFalse(b'Content-Transfer-Encoding: base64' in msg.message().as_bytes()) # Ticket #11212 # Shouldn't use quoted printable, should detect it can represent content with 7 bit data msg = EmailMessage('Subject', 'Body with only ASCII characters.', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'}) - s = msg.message().as_string() - self.assertFalse('Content-Transfer-Encoding: quoted-printable' in s) - self.assertTrue('Content-Transfer-Encoding: 7bit' in s) + s = msg.message().as_bytes() + self.assertFalse(b'Content-Transfer-Encoding: quoted-printable' in s) + self.assertTrue(b'Content-Transfer-Encoding: 7bit' in s) # Shouldn't use quoted printable, should detect it can represent content with 8 bit data msg = EmailMessage('Subject', 'Body with latin characters: àáä.', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'}) - s = msg.message().as_string() - self.assertFalse(str('Content-Transfer-Encoding: quoted-printable') in s) - self.assertTrue(str('Content-Transfer-Encoding: 8bit') in s) + s = msg.message().as_bytes() + self.assertFalse(b'Content-Transfer-Encoding: quoted-printable' in s) + self.assertTrue(b'Content-Transfer-Encoding: 8bit' in s) msg = EmailMessage('Subject', 'Body with non latin characters: А Б В Г Д Е Ж Ѕ З И І К Л М Н О П.', 'bounce@example.com', ['to@example.com'], headers={'From': 'from@example.com'}) - s = msg.message().as_string() - self.assertFalse(str('Content-Transfer-Encoding: quoted-printable') in s) - self.assertTrue(str('Content-Transfer-Encoding: 8bit') in s) + s = msg.message().as_bytes() + self.assertFalse(b'Content-Transfer-Encoding: quoted-printable' in s) + self.assertTrue(b'Content-Transfer-Encoding: 8bit' in s) def test_dont_base64_encode_message_rfc822(self): # Ticket #18967 @@ -476,7 +478,7 @@ class BaseEmailBackendTests(HeadersCheckMixin, object): self.assertEqual(num_sent, 1) message = self.get_the_message() self.assertEqual(message["subject"], '=?utf-8?q?Ch=C3=A8re_maman?=') - self.assertEqual(force_text(message.get_payload()), 'Je t\'aime très fort') + self.assertEqual(force_text(message.get_payload(decode=True)), 'Je t\'aime très fort') def test_send_many(self): email1 = EmailMessage('Subject', 'Content1', 'from@example.com', ['to@example.com']) @@ -746,8 +748,8 @@ class ConsoleBackendTests(BaseEmailBackendTests, SimpleTestCase): self.stream = sys.stdout = StringIO() def get_mailbox_content(self): - messages = force_text(self.stream.getvalue()).split('\n' + ('-' * 79) + '\n') - return [message_from_string(force_str(m)) for m in messages if m] + messages = self.stream.getvalue().split(force_str('\n' + ('-' * 79) + '\n')) + return [message_from_bytes(force_bytes(m)) for m in messages if m] def test_console_stream_kwarg(self): """ @@ -793,7 +795,9 @@ class FakeSMTPServer(smtpd.SMTPServer, threading.Thread): self.sink_lock = threading.Lock() def process_message(self, peer, mailfrom, rcpttos, data): - m = message_from_string(data) + if PY3: + data = data.encode('utf-8') + m = message_from_bytes(data) maddr = parseaddr(m.get('from'))[1] if mailfrom != maddr: return "553 '%s' != '%s'" % (mailfrom, maddr) From bbdf01e00aed1e86f6aaeba81065be21af35d415 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sat, 28 Dec 2013 20:13:08 +0100 Subject: [PATCH 096/208] Populated non-master app registries. This removes the gap between the master app registry and ad-hoc app registries created by the migration framework, specifically in terms of behavior of the get_model[s] methods. This commit contains a stealth feature that I'd rather not describe. --- django/apps/base.py | 2 +- django/apps/registry.py | 18 ++++++++++-------- django/db/migrations/state.py | 19 +++++++++++++++++++ tests/apps/tests.py | 6 ++++-- 4 files changed, 34 insertions(+), 11 deletions(-) diff --git a/django/apps/base.py b/django/apps/base.py index 40b72c9448..e0d637c96e 100644 --- a/django/apps/base.py +++ b/django/apps/base.py @@ -53,7 +53,7 @@ class AppConfig(object): self.models = None def __repr__(self): - return '' % self.label + return '<%s: %s>' % (self.__class__.__name__, self.label) @classmethod def create(cls, entry): diff --git a/django/apps/registry.py b/django/apps/registry.py index 42affbbc13..6556fbf852 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -27,9 +27,8 @@ class Apps(object): if master and hasattr(sys.modules[__name__], 'apps'): raise RuntimeError("You may create only one master registry.") - # When master is set to False, the registry isn't populated from - # INSTALLED_APPS and ignores the only_installed arguments to - # get_model[s]. + # When master is set to False, the registry ignores the only_installed + # arguments to get_model[s]. self.master = master # Mapping of app labels => model names => model classes. Every time a @@ -48,9 +47,9 @@ class Apps(object): # set_available_apps and set_installed_apps. self.stored_app_configs = [] - # Internal flags used when populating the master registry. - self._apps_loaded = not self.master - self._models_loaded = not self.master + # Internal flags used when populating the registry. + self._apps_loaded = False + self._models_loaded = False # Pending lookups for lazy relations. self._pending_lookups = {} @@ -82,8 +81,11 @@ class Apps(object): # Therefore we simply import them sequentially. if installed_apps is None: installed_apps = settings.INSTALLED_APPS - for app_name in installed_apps: - app_config = AppConfig.create(app_name) + for entry in installed_apps: + if isinstance(entry, AppConfig): + app_config = entry + else: + app_config = AppConfig.create(entry) self.app_configs[app_config.label] = app_config self.get_models.cache_clear() diff --git a/django/db/migrations/state.py b/django/db/migrations/state.py index 198b2c516c..21009f4da5 100644 --- a/django/db/migrations/state.py +++ b/django/db/migrations/state.py @@ -1,3 +1,4 @@ +from django.apps import AppConfig from django.apps.registry import Apps from django.db import models from django.db.models.options import DEFAULT_NAMES, normalize_unique_together @@ -33,6 +34,11 @@ class ProjectState(object): "Turns the project state into actual models in a new Apps" if self.apps is None: self.apps = Apps() + # Populate the app registry with a stub for each application. + app_labels = set(model_state.app_label for model_state in self.models.values()) + app_configs = [AppConfigStub(label) for label in sorted(app_labels)] + self.apps.populate_apps(app_configs) + self.apps.populate_models() # We keep trying to render the models in a loop, ignoring invalid # base errors, until the size of the unrendered models doesn't # decrease by at least one, meaning there's a base dependency loop/ @@ -68,6 +74,19 @@ class ProjectState(object): return not (self == other) +class AppConfigStub(AppConfig): + """ + Stubs a Django AppConfig. Only provides a label and a dict of models. + """ + def __init__(self, label): + self.label = label + self.path = None + super(AppConfigStub, self).__init__(None, None) + + def import_models(self, all_models): + self.models = all_models + + class ModelState(object): """ Represents a Django Model. We don't use the actual Model class diff --git a/tests/apps/tests.py b/tests/apps/tests.py index f7de95ebe3..4e988493fc 100644 --- a/tests/apps/tests.py +++ b/tests/apps/tests.py @@ -50,8 +50,10 @@ class AppsTests(TestCase): Tests the ready property of a registry other than the master. """ apps = Apps() - # Currently, non-master app registries are artificially considered - # ready regardless of whether populate_models() has run. + self.assertFalse(apps.ready) + apps.populate_apps([]) + self.assertFalse(apps.ready) + apps.populate_models() self.assertTrue(apps.ready) def test_bad_app_config(self): From 81354b82bf647fd100e836dae2639e9c8d76c5eb Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sat, 28 Dec 2013 14:24:14 +0100 Subject: [PATCH 097/208] Stopped calling apps.get_model with only_installed=False. ContentTypes are only created for installed applications, and I could make a case for not returning a model that isn't installed any more. The check for stale ContentTypes in update_contenttypes doesn't use model_class. ModelSignal actually needs get_registered_model since the lookup happens at import time. I took this opportunity to perform a small refactoring. --- django/contrib/contenttypes/models.py | 2 +- django/db/models/signals.py | 15 ++++++--------- tests/app_loading/tests.py | 6 ------ 3 files changed, 7 insertions(+), 16 deletions(-) diff --git a/django/contrib/contenttypes/models.py b/django/contrib/contenttypes/models.py index 6df1087cae..6b80b9fe7e 100644 --- a/django/contrib/contenttypes/models.py +++ b/django/contrib/contenttypes/models.py @@ -157,7 +157,7 @@ class ContentType(models.Model): def model_class(self): "Returns the Python model class for this type of content." - return apps.get_model(self.app_label, self.model, only_installed=False) + return apps.get_model(self.app_label, self.model) def get_object_for_this_type(self, **kwargs): """ diff --git a/django/db/models/signals.py b/django/db/models/signals.py index 10da3e22a5..97352460ee 100644 --- a/django/db/models/signals.py +++ b/django/db/models/signals.py @@ -1,5 +1,3 @@ -from collections import defaultdict - from django.apps import apps from django.dispatch import Signal from django.utils import six @@ -16,7 +14,7 @@ class ModelSignal(Signal): def __init__(self, *args, **kwargs): super(ModelSignal, self).__init__(*args, **kwargs) - self.unresolved_references = defaultdict(list) + self.unresolved_references = {} class_prepared.connect(self._resolve_references) def _resolve_references(self, sender, **kwargs): @@ -35,18 +33,17 @@ class ModelSignal(Signal): def connect(self, receiver, sender=None, weak=True, dispatch_uid=None): if isinstance(sender, six.string_types): try: - app_label, object_name = sender.split('.') + app_label, model_name = sender.split('.') except ValueError: raise ValueError( "Specified sender must either be a model or a " "model name of the 'app_label.ModelName' form." ) - sender = apps.get_model(app_label, object_name, only_installed=False) + sender = apps.get_registered_model(app_label, model_name) if sender is None: - reference = (app_label, object_name) - self.unresolved_references[reference].append( - (receiver, weak, dispatch_uid) - ) + ref = (app_label, model_name) + refs = self.unresolved_references.setdefault(ref, []) + refs.append((receiver, weak, dispatch_uid)) return super(ModelSignal, self).connect( receiver, sender=sender, weak=weak, dispatch_uid=dispatch_uid diff --git a/tests/app_loading/tests.py b/tests/app_loading/tests.py index 19a1d03d74..d61205330a 100644 --- a/tests/app_loading/tests.py +++ b/tests/app_loading/tests.py @@ -75,12 +75,6 @@ class GetModelsTest(TestCase): self.assertEqual( apps.get_model("not_installed", "NotInstalledModel"), None) - def test_get_model_with_not_installed(self): - self.assertEqual( - apps.get_model( - "not_installed", "NotInstalledModel", only_installed=False), - self.not_installed_module.NotInstalledModel) - def test_get_models_only_returns_installed_models(self): self.assertNotIn( "NotInstalledModel", From 54790e669d73269bea6320c947ed8a46e98b8025 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sat, 28 Dec 2013 14:41:11 +0100 Subject: [PATCH 098/208] Simplified Apps.get_model and added AppConfig.get_model. Documented them as public APIs. --- django/apps/base.py | 17 +++++++++++++++++ django/apps/registry.py | 28 ++++++++++++++-------------- docs/ref/applications.txt | 15 +++++++++++++++ 3 files changed, 46 insertions(+), 14 deletions(-) diff --git a/django/apps/base.py b/django/apps/base.py index e0d637c96e..31d75bf5ed 100644 --- a/django/apps/base.py +++ b/django/apps/base.py @@ -109,6 +109,23 @@ class AppConfig(object): # Entry is a path to an app module. return cls(entry, module) + def get_model(self, model_name): + """ + Returns the model with the given case-insensitive model_name. + + Raises LookupError if no model exists with this name. + + This method assumes that apps.populate_models() has run. + """ + if self.models is None: + raise LookupError( + "App '%s' doesn't have any models." % self.label) + try: + return self.models[model_name.lower()] + except KeyError: + raise LookupError( + "App '%s' doesn't have a '%s' model." % (self.label, model_name)) + def import_models(self, all_models): # Dictionary of models for this app, primarily maintained in the # 'all_models' attribute of the Apps this AppConfig is attached to. diff --git a/django/apps/registry.py b/django/apps/registry.py index 6556fbf852..4f10ad8346 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -185,7 +185,7 @@ class Apps(object): if app_config is None: raise LookupError("No installed app with label '%s'." % app_label) if only_with_models_module and app_config.models_module is None: - raise LookupError("App with label '%s' doesn't have a models module." % app_label) + raise LookupError("App '%s' doesn't have a models module." % app_label) return app_config # This method is performance-critical at least for Django's test suite. @@ -242,21 +242,20 @@ class Apps(object): ) return model_list - def get_model(self, app_label, model_name, only_installed=True): + def get_model(self, app_label, model_name): """ - Returns the model matching the given app_label and case-insensitive - model_name. + Returns the model matching the given app_label and model_name. - Returns None if no model is found. + model_name is case-insensitive. + + Returns None if no application exists with this label, or no model + exists with this name in the application. """ - if not self.master: - only_installed = False self.populate_models() - if only_installed: - app_config = self.app_configs.get(app_label) - if app_config is None: - return None - return self.all_models[app_label].get(model_name.lower()) + try: + return self.get_app_config(app_label).get_model(model_name.lower()) + except LookupError: + return None def register_model(self, app_label, model): # Since this method is called when models are imported, it cannot @@ -286,10 +285,11 @@ class Apps(object): def get_registered_model(self, app_label, model_name): """ - Returns the model class if one is registered and None otherwise. + Similar to get_model(), but doesn't require that an app exists with + the given app_label. It's safe to call this method at import time, even while the registry - is being populated. It returns False for models that aren't loaded yet. + is being populated. It returns None for models that aren't loaded yet. """ return self.all_models[app_label].get(model_name.lower()) diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt index 15cc481f51..8f868f751e 100644 --- a/docs/ref/applications.txt +++ b/docs/ref/applications.txt @@ -153,6 +153,15 @@ Read-only attributes It may be ``None`` if the application doesn't contain a ``models`` module. +Methods +------- + +.. method:: AppConfig.get_model(model_name) + + Returns the :class:`~django.db.models.Model` with the given + ``model_name``. Raises :exc:`~exceptions.LookupError` if no such model + exists. ``model_name`` is case-insensitive. + Application registry ==================== @@ -189,3 +198,9 @@ Application registry Unlike :meth:`~django.apps.apps.get_app_config`, this method can be called safely at import time. If the registry is still being populated, it may return ``False``, even though the app will become available later. + +.. method:: apps.get_model(app_label, model_name) + + Returns the :class:`~django.db.models.Model` with the given ``app_label`` + and ``model_name``. Returns ``None`` if no such application or model + exists. ``model_name`` is case-insensitive. From ba7206cd81458865bace85914905392291b05829 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sat, 28 Dec 2013 14:55:54 +0100 Subject: [PATCH 099/208] Changed get_model to raise an exception on errors. Returning None on errors required unpythonic error checking and was inconsistent with get_app_config. get_model was a private API until the previous commit, but given that it was certainly used in third party software, the change is explained in the release notes. Applied the same change to get_registered_model, which is a new private API introduced during the recent refactoring. --- django/apps/registry.py | 17 +++++++++-------- django/contrib/admindocs/views.py | 5 +++-- django/contrib/auth/__init__.py | 5 +++-- django/contrib/auth/management/__init__.py | 8 ++++++-- django/contrib/comments/views/comments.py | 2 +- django/contrib/contenttypes/management.py | 4 +++- django/contrib/contenttypes/models.py | 5 ++++- django/contrib/gis/sitemaps/views.py | 5 +++-- django/core/management/commands/dumpdata.py | 10 ++++++---- django/core/management/validation.py | 4 +++- django/core/serializers/python.py | 4 +--- django/core/serializers/xml_serializer.py | 4 +--- django/db/migrations/state.py | 11 ++++++----- django/db/models/base.py | 7 ++++--- django/db/models/fields/related.py | 9 +++++---- django/db/models/signals.py | 5 +++-- docs/ref/applications.txt | 4 ++-- docs/releases/1.7.txt | 12 +++++++++--- tests/app_loading/tests.py | 4 ++-- tests/apps/tests.py | 8 ++++++-- 20 files changed, 80 insertions(+), 53 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index 4f10ad8346..e5d46e9305 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -248,14 +248,11 @@ class Apps(object): model_name is case-insensitive. - Returns None if no application exists with this label, or no model - exists with this name in the application. + Raises LookupError if no application exists with this label, or no + model exists with this name in the application. """ self.populate_models() - try: - return self.get_app_config(app_label).get_model(model_name.lower()) - except LookupError: - return None + return self.get_app_config(app_label).get_model(model_name.lower()) def register_model(self, app_label, model): # Since this method is called when models are imported, it cannot @@ -289,9 +286,13 @@ class Apps(object): the given app_label. It's safe to call this method at import time, even while the registry - is being populated. It returns None for models that aren't loaded yet. + is being populated. """ - return self.all_models[app_label].get(model_name.lower()) + model = self.all_models[app_label].get(model_name.lower()) + if model is None: + raise LookupError( + "Model '%s.%s' not registered." % (app_label, model_name)) + return model def set_available_apps(self, available): """ diff --git a/django/contrib/admindocs/views.py b/django/contrib/admindocs/views.py index ebb7687dea..7afb11ef34 100644 --- a/django/contrib/admindocs/views.py +++ b/django/contrib/admindocs/views.py @@ -188,8 +188,9 @@ class ModelDetailView(BaseAdminDocsView): apps.get_app_config(self.kwargs['app_label']) except LookupError: raise Http404(_("App %(app_label)r not found") % self.kwargs) - model = apps.get_model(self.kwargs['app_label'], self.kwargs['model_name']) - if model is None: + try: + model = apps.get_model(self.kwargs['app_label'], self.kwargs['model_name']) + except LookupError: raise Http404(_("Model %(model_name)r not found in app %(app_label)r") % self.kwargs) opts = model._meta diff --git a/django/contrib/auth/__init__.py b/django/contrib/auth/__init__.py index ef44737cc0..f2bcaba390 100644 --- a/django/contrib/auth/__init__.py +++ b/django/contrib/auth/__init__.py @@ -129,8 +129,9 @@ def get_user_model(): app_label, model_name = settings.AUTH_USER_MODEL.split('.') except ValueError: raise ImproperlyConfigured("AUTH_USER_MODEL must be of the form 'app_label.model_name'") - user_model = apps.get_model(app_label, model_name) - if user_model is None: + try: + user_model = apps.get_model(app_label, model_name) + except LookupError: raise ImproperlyConfigured("AUTH_USER_MODEL refers to model '%s' that has not been installed" % settings.AUTH_USER_MODEL) return user_model diff --git a/django/contrib/auth/management/__init__.py b/django/contrib/auth/management/__init__.py index c2111e3b98..306b051284 100644 --- a/django/contrib/auth/management/__init__.py +++ b/django/contrib/auth/management/__init__.py @@ -61,7 +61,9 @@ def _check_permission_clashing(custom, builtin, ctype): def create_permissions(app, created_models, verbosity, db=DEFAULT_DB_ALIAS, **kwargs): - if apps.get_model('auth', 'Permission') is None: + try: + apps.get_model('auth', 'Permission') + except LookupError: return if not router.allow_migrate(db, auth_app.Permission): @@ -117,7 +119,9 @@ def create_permissions(app, created_models, verbosity, db=DEFAULT_DB_ALIAS, **kw def create_superuser(app, created_models, verbosity, db, **kwargs): - if apps.get_model('auth', 'Permission') is None: + try: + apps.get_model('auth', 'Permission') + except LookupError: return UserModel = get_user_model() diff --git a/django/contrib/comments/views/comments.py b/django/contrib/comments/views/comments.py index bad8eb50f7..165f2b6574 100644 --- a/django/contrib/comments/views/comments.py +++ b/django/contrib/comments/views/comments.py @@ -54,7 +54,7 @@ def post_comment(request, next=None, using=None): except TypeError: return CommentPostBadRequest( "Invalid content_type value: %r" % escape(ctype)) - except AttributeError: + except LookupError: return CommentPostBadRequest( "The given content-type %r does not resolve to a valid model." % \ escape(ctype)) diff --git a/django/contrib/contenttypes/management.py b/django/contrib/contenttypes/management.py index 87171b1ff2..6b2d2d22f1 100644 --- a/django/contrib/contenttypes/management.py +++ b/django/contrib/contenttypes/management.py @@ -12,7 +12,9 @@ def update_contenttypes(app, created_models, verbosity=2, db=DEFAULT_DB_ALIAS, * Creates content types for models in the given app, removing any model entries that no longer have a matching model class. """ - if apps.get_model('contenttypes', 'ContentType') is None: + try: + apps.get_model('contenttypes', 'ContentType') + except LookupError: return if not router.allow_migrate(db, ContentType): diff --git a/django/contrib/contenttypes/models.py b/django/contrib/contenttypes/models.py index 6b80b9fe7e..0dc048cfa2 100644 --- a/django/contrib/contenttypes/models.py +++ b/django/contrib/contenttypes/models.py @@ -157,7 +157,10 @@ class ContentType(models.Model): def model_class(self): "Returns the Python model class for this type of content." - return apps.get_model(self.app_label, self.model) + try: + return apps.get_model(self.app_label, self.model) + except LookupError: + return None def get_object_for_this_type(self, **kwargs): """ diff --git a/django/contrib/gis/sitemaps/views.py b/django/contrib/gis/sitemaps/views.py index 20a91130bb..a65612a541 100644 --- a/django/contrib/gis/sitemaps/views.py +++ b/django/contrib/gis/sitemaps/views.py @@ -81,8 +81,9 @@ def kml(request, label, model, field_name=None, compress=False, using=DEFAULT_DB must be that of a geographic field. """ placemarks = [] - klass = apps.get_model(label, model) - if not klass: + try: + klass = apps.get_model(label, model) + except LookupError: raise Http404('You must supply a valid app label and module name. Got "%s.%s"' % (label, model)) if field_name: diff --git a/django/core/management/commands/dumpdata.py b/django/core/management/commands/dumpdata.py index 82d8432bc1..c4501c5b24 100644 --- a/django/core/management/commands/dumpdata.py +++ b/django/core/management/commands/dumpdata.py @@ -66,8 +66,9 @@ class Command(BaseCommand): for exclude in excludes: if '.' in exclude: app_label, model_name = exclude.split('.', 1) - model = apps.get_model(app_label, model_name) - if not model: + try: + model = apps.get_model(app_label, model_name) + except LookupError: raise CommandError('Unknown model in excludes: %s' % exclude) excluded_models.add(model) else: @@ -96,8 +97,9 @@ class Command(BaseCommand): raise CommandError("Unknown application: %s" % app_label) if app_config.models_module is None or app_config in excluded_apps: continue - model = apps.get_model(app_label, model_label) - if model is None: + try: + model = apps.get_model(app_label, model_label) + except LookupError: raise CommandError("Unknown model: %s.%s" % (app_label, model_label)) app_list_value = app_list.setdefault(app_config, []) diff --git a/django/core/management/validation.py b/django/core/management/validation.py index c3b55770ce..0af92bb5b7 100644 --- a/django/core/management/validation.py +++ b/django/core/management/validation.py @@ -42,7 +42,9 @@ def get_validation_errors(outfile, app=None): except ValueError: e.add(opts, "%s is not of the form 'app_label.app_name'." % opts.swappable) continue - if not apps.get_model(app_label, model_name): + try: + apps.get_model(app_label, model_name) + except LookupError: e.add(opts, "Model has been swapped out for '%s' which has not been installed or is abstract." % opts.swapped) # No need to perform any other validation checks on a swapped model. continue diff --git a/django/core/serializers/python.py b/django/core/serializers/python.py index a46adeef7a..9a59f61d70 100644 --- a/django/core/serializers/python.py +++ b/django/core/serializers/python.py @@ -156,8 +156,6 @@ def _get_model(model_identifier): """ try: Model = apps.get_model(*model_identifier.split(".")) - except TypeError: - Model = None - if Model is None: + except (LookupError, TypeError): raise base.DeserializationError("Invalid model identifier: '%s'" % model_identifier) return Model diff --git a/django/core/serializers/xml_serializer.py b/django/core/serializers/xml_serializer.py index 81e41f8a32..06dd134754 100644 --- a/django/core/serializers/xml_serializer.py +++ b/django/core/serializers/xml_serializer.py @@ -278,9 +278,7 @@ class Deserializer(base.Deserializer): % (node.nodeName, attr)) try: Model = apps.get_model(*model_identifier.split(".")) - except TypeError: - Model = None - if Model is None: + except (LookupError, TypeError): raise base.DeserializationError( "<%s> node has invalid model identifier: '%s'" % (node.nodeName, model_identifier)) diff --git a/django/db/migrations/state.py b/django/db/migrations/state.py index 21009f4da5..7eedcdbac6 100644 --- a/django/db/migrations/state.py +++ b/django/db/migrations/state.py @@ -192,11 +192,12 @@ class ModelState(object): meta_contents["unique_together"] = list(meta_contents["unique_together"]) meta = type("Meta", tuple(), meta_contents) # Then, work out our bases - bases = tuple( - (apps.get_model(*base.split(".", 1)) if isinstance(base, six.string_types) else base) - for base in self.bases - ) - if None in bases: + try: + bases = tuple( + (apps.get_model(*base.split(".", 1)) if isinstance(base, six.string_types) else base) + for base in self.bases + ) + except LookupError: raise InvalidBasesError("Cannot resolve one or more bases from %r" % (self.bases,)) # Turn fields into a dict for the body, add other bits body = dict(self.fields) diff --git a/django/db/models/base.py b/django/db/models/base.py index 66c1d96762..03f1e8b693 100644 --- a/django/db/models/base.py +++ b/django/db/models/base.py @@ -151,9 +151,10 @@ class ModelBase(type): new_class._base_manager = new_class._base_manager._copy_to_model(new_class) # Bail out early if we have already created this class. - m = new_class._meta.apps.get_registered_model(new_class._meta.app_label, name) - if m is not None: - return m + try: + return new_class._meta.apps.get_registered_model(new_class._meta.app_label, name) + except LookupError: + pass # Add all attributes to the class. for obj_name, obj in attrs.items(): diff --git a/django/db/models/fields/related.py b/django/db/models/fields/related.py index 247067d60a..beaa48c6f1 100644 --- a/django/db/models/fields/related.py +++ b/django/db/models/fields/related.py @@ -68,13 +68,14 @@ def add_lazy_relation(cls, field, relation, operation): # string right away. If get_model returns None, it means that the related # model isn't loaded yet, so we need to pend the relation until the class # is prepared. - model = cls._meta.apps.get_registered_model(app_label, model_name) - if model: - operation(field, model, cls) - else: + try: + model = cls._meta.apps.get_registered_model(app_label, model_name) + except LookupError: key = (app_label, model_name) value = (cls, field, operation) cls._meta.apps._pending_lookups.setdefault(key, []).append(value) + else: + operation(field, model, cls) def do_pending_lookups(sender, **kwargs): diff --git a/django/db/models/signals.py b/django/db/models/signals.py index 97352460ee..f5e1ac2cf4 100644 --- a/django/db/models/signals.py +++ b/django/db/models/signals.py @@ -39,8 +39,9 @@ class ModelSignal(Signal): "Specified sender must either be a model or a " "model name of the 'app_label.ModelName' form." ) - sender = apps.get_registered_model(app_label, model_name) - if sender is None: + try: + sender = apps.get_registered_model(app_label, model_name) + except LookupError: ref = (app_label, model_name) refs = self.unresolved_references.setdefault(ref, []) refs.append((receiver, weak, dispatch_uid)) diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt index 8f868f751e..1fc74f6bee 100644 --- a/docs/ref/applications.txt +++ b/docs/ref/applications.txt @@ -202,5 +202,5 @@ Application registry .. method:: apps.get_model(app_label, model_name) Returns the :class:`~django.db.models.Model` with the given ``app_label`` - and ``model_name``. Returns ``None`` if no such application or model - exists. ``model_name`` is case-insensitive. + and ``model_name``. Raises :exc:`~exceptions.LookupError` if no such + application or model exists. ``model_name`` is case-insensitive. diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index dbbdcf9c81..2c1b2bf26f 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -602,9 +602,15 @@ in addition to application modules, you should review code that accesses this setting directly and use the app registry (:attr:`django.apps.apps`) instead. The "app registry" that manages the list of installed applications doesn't -have the same features as the old "app cache". However, even though the "app -cache" was a private API, most of its methods were temporarily preserved and -will go through a deprecation path. +have the same features as the old "app cache". Even though the "app cache" was +a private API, obsolete methods will be removed after a standard deprecation +period. In addition, the following changes take effect immediately: + +* ``get_model`` raises :exc:`~exceptions.LookupError` instead of returning + ``None`` when no model is found. + +* The ``only_installed`` and ``seed_cache`` arguments of ``get_model`` no + longer exist. While the new implementation is believed to be more robust, regressions cannot be ruled out, especially during the import sequence. Circular imports that diff --git a/tests/app_loading/tests.py b/tests/app_loading/tests.py index d61205330a..04ca30e88d 100644 --- a/tests/app_loading/tests.py +++ b/tests/app_loading/tests.py @@ -72,8 +72,8 @@ class GetModelsTest(TestCase): self.not_installed_module = models def test_get_model_only_returns_installed_models(self): - self.assertEqual( - apps.get_model("not_installed", "NotInstalledModel"), None) + with self.assertRaises(LookupError): + apps.get_model("not_installed", "NotInstalledModel") def test_get_models_only_returns_installed_models(self): self.assertNotIn( diff --git a/tests/apps/tests.py b/tests/apps/tests.py index 4e988493fc..4cd35c38cf 100644 --- a/tests/apps/tests.py +++ b/tests/apps/tests.py @@ -148,9 +148,11 @@ class AppsTests(TestCase): Tests that the models in the models.py file were loaded correctly. """ self.assertEqual(apps.get_model("apps", "TotallyNormal"), TotallyNormal) - self.assertEqual(apps.get_model("apps", "SoAlternative"), None) + with self.assertRaises(LookupError): + apps.get_model("apps", "SoAlternative") - self.assertEqual(new_apps.get_model("apps", "TotallyNormal"), None) + with self.assertRaises(LookupError): + new_apps.get_model("apps", "TotallyNormal") self.assertEqual(new_apps.get_model("apps", "SoAlternative"), SoAlternative) def test_dynamic_load(self): @@ -174,4 +176,6 @@ class AppsTests(TestCase): old_models, apps.get_models(apps.get_app_config("apps").models_module), ) + with self.assertRaises(LookupError): + apps.get_model("apps", "SouthPonies") self.assertEqual(new_apps.get_model("apps", "SouthPonies"), temp_model) From 9f13c3328199d2fa70235cdc63bb06b1efc5b117 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sat, 28 Dec 2013 18:27:33 +0100 Subject: [PATCH 100/208] Removed the only_installed argument of Apps.get_models. Refs #15903, #15866, #15850. --- django/apps/registry.py | 32 +++++++------------------------- django/db/models/options.py | 4 ++-- docs/releases/1.7.txt | 8 ++++++-- tests/app_loading/tests.py | 13 ------------- 4 files changed, 15 insertions(+), 42 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index e5d46e9305..67cca2cfdf 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -27,10 +27,6 @@ class Apps(object): if master and hasattr(sys.modules[__name__], 'apps'): raise RuntimeError("You may create only one master registry.") - # When master is set to False, the registry ignores the only_installed - # arguments to get_model[s]. - self.master = master - # Mapping of app labels => model names => model classes. Every time a # model is imported, ModelBase.__new__ calls apps.register_model which # creates an entry in all_models. All imported models are registered, @@ -190,9 +186,8 @@ class Apps(object): # This method is performance-critical at least for Django's test suite. @lru_cache.lru_cache(maxsize=None) - def get_models(self, app_mod=None, - include_auto_created=False, include_deferred=False, - only_installed=True, include_swapped=False): + def get_models(self, app_mod=None, include_auto_created=False, + include_deferred=False, include_swapped=False): """ Given a module containing models, returns a list of the models. Otherwise returns a list of all installed models. @@ -205,33 +200,20 @@ class Apps(object): queries are *not* included in the list of models. However, if you specify include_deferred, they will be. - By default, models that aren't part of installed apps will *not* - be included in the list of models. However, if you specify - only_installed=False, they will be. If you're using a non-default - Apps, this argument does nothing - all models will be included. - By default, models that have been swapped out will *not* be included in the list of models. However, if you specify include_swapped, they will be. """ - if not self.master: - only_installed = False model_list = None self.populate_models() if app_mod: app_label = app_mod.__name__.split('.')[-2] - if only_installed: - try: - model_dicts = [self.app_configs[app_label].models] - except KeyError: - model_dicts = [] - else: - model_dicts = [self.all_models[app_label]] + try: + model_dicts = [self.app_configs[app_label].models] + except KeyError: + model_dicts = [] else: - if only_installed: - model_dicts = [app_config.models for app_config in self.app_configs.values()] - else: - model_dicts = self.all_models.values() + model_dicts = [app_config.models for app_config in self.app_configs.values()] model_list = [] for model_dict in model_dicts: model_list.extend( diff --git a/django/db/models/options.py b/django/db/models/options.py index f50c639975..6ad914e025 100644 --- a/django/db/models/options.py +++ b/django/db/models/options.py @@ -514,7 +514,7 @@ class Options(object): cache[obj] = model # Collect also objects which are in relation to some proxy child/parent of self. proxy_cache = cache.copy() - for klass in self.apps.get_models(include_auto_created=True, only_installed=False): + for klass in self.apps.get_models(include_auto_created=True): if not klass._meta.swapped: for f in klass._meta.local_fields: if f.rel and not isinstance(f.rel.to, six.string_types) and f.generate_reverse_relation: @@ -557,7 +557,7 @@ class Options(object): cache[obj] = parent else: cache[obj] = model - for klass in self.apps.get_models(only_installed=False): + for klass in self.apps.get_models(): if not klass._meta.swapped: for f in klass._meta.local_many_to_many: if (f.rel diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 2c1b2bf26f..0d83c3aa81 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -593,6 +593,10 @@ methods are only referring to fields or other items in ``model._meta``. App-loading changes ~~~~~~~~~~~~~~~~~~~ +You should make sure that your project doesn't import models from applications +that aren't in :setting:`INSTALLED_APPS`. Relations involving such models may +not be created properly. + Subclasses of :class:`~django.core.management.AppCommand` must now implement a :meth:`~django.core.management.AppCommand.handle_app_config` method instead of ``handle_app()``. This method receives an :class:`~django.apps.AppConfig` instance. @@ -609,8 +613,8 @@ period. In addition, the following changes take effect immediately: * ``get_model`` raises :exc:`~exceptions.LookupError` instead of returning ``None`` when no model is found. -* The ``only_installed`` and ``seed_cache`` arguments of ``get_model`` no - longer exist. +* The ``only_installed`` argument of ``get_model`` and ``get_models`` no + longer exists, nor does the ``seed_cache`` argument of ``get_model``. While the new implementation is believed to be more robust, regressions cannot be ruled out, especially during the import sequence. Circular imports that diff --git a/tests/app_loading/tests.py b/tests/app_loading/tests.py index 04ca30e88d..fddf75f30e 100644 --- a/tests/app_loading/tests.py +++ b/tests/app_loading/tests.py @@ -82,16 +82,3 @@ class GetModelsTest(TestCase): def test_get_models_with_app_label_only_returns_installed_models(self): self.assertEqual(apps.get_models(self.not_installed_module), []) - - def test_get_models_with_not_installed(self): - self.assertIn( - "NotInstalledModel", - [m.__name__ for m in apps.get_models(only_installed=False)]) - - -class NotInstalledModelsTest(TestCase): - def test_related_not_installed_model(self): - from .not_installed.models import NotInstalledModel - self.assertEqual( - set(NotInstalledModel._meta.get_all_field_names()), - set(["id", "relatedmodel", "m2mrelatedmodel"])) From 6d66ba59488bbd0d4f0c2f32b2921f1512301143 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Sat, 21 Dec 2013 00:15:39 +0100 Subject: [PATCH 101/208] Fixed #21242 -- Allowed more IANA schemes in URLValidator Thanks Sascha Peilicke for the report and initial patch, and Tim Graham for the review. --- django/core/validators.py | 16 ++++++++++++++-- docs/ref/validators.txt | 18 ++++++++++++++++-- docs/releases/1.7.txt | 7 +++++++ tests/validators/tests.py | 7 +++++++ 4 files changed, 44 insertions(+), 4 deletions(-) diff --git a/django/core/validators.py b/django/core/validators.py index 695dda258b..5559bca28f 100644 --- a/django/core/validators.py +++ b/django/core/validators.py @@ -44,7 +44,7 @@ class RegexValidator(object): @deconstructible class URLValidator(RegexValidator): regex = re.compile( - r'^(?:http|ftp)s?://' # http:// or https:// + r'^(?:[a-z0-9\.\-]*)://' # scheme is validated separately r'(?:(?:[A-Z0-9](?:[A-Z0-9-]{0,61}[A-Z0-9])?\.)+(?:[A-Z]{2,6}\.?|[A-Z0-9-]{2,}\.?)|' # domain... r'localhost|' # localhost... r'\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|' # ...or ipv4 @@ -52,14 +52,26 @@ class URLValidator(RegexValidator): r'(?::\d+)?' # optional port r'(?:/?|[/?]\S+)$', re.IGNORECASE) message = _('Enter a valid URL.') + schemes = ['http', 'https', 'ftp', 'ftps'] + + def __init__(self, schemes=None, **kwargs): + super(URLValidator, self).__init__(**kwargs) + if schemes is not None: + self.schemes = schemes def __call__(self, value): + value = force_text(value) + # Check first if the scheme is valid + scheme = value.split('://')[0].lower() + if scheme not in self.schemes: + raise ValidationError(self.message, code=self.code) + + # Then check full URL try: super(URLValidator, self).__call__(value) except ValidationError as e: # Trivial case failed. Try for possible IDN domain if value: - value = force_text(value) scheme, netloc, path, query, fragment = urlsplit(value) try: netloc = netloc.encode('idna').decode('ascii') # IDN -> ACE diff --git a/docs/ref/validators.txt b/docs/ref/validators.txt index 92e257ca85..1b706ab8e3 100644 --- a/docs/ref/validators.txt +++ b/docs/ref/validators.txt @@ -87,10 +87,24 @@ to, or in lieu of custom ``field.clean()`` methods. ``URLValidator`` ---------------- -.. class:: URLValidator() +.. class:: URLValidator([schemes=None, regex=None, message=None, code=None]) A :class:`RegexValidator` that ensures a value looks like a URL, and raises - an error code of ``'invalid'`` if it doesn't. + an error code of ``'invalid'`` if it doesn't. In addition to the optional + arguments of its parent :class:`RegexValidator` class, ``URLValidator`` + accepts an extra optional attribute: + + .. attribute:: schemes + + URL/URI scheme list to validate against. If not provided, the default + list is ``['http', 'https', 'ftp', 'ftps']``. As a reference, the IANA + Web site provides a full list of `valid URI schemes`_. + + .. _valid URI schemes: https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml + + .. versionchanged:: 1.7 + + The optional ``schemes`` attribute was added. ``validate_email`` ------------------ diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 0d83c3aa81..a7e7da6d15 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -567,6 +567,13 @@ Tests * :meth:`~django.test.TransactionTestCase.assertNumQueries` now prints out the list of executed queries if the assertion fails. +Validators +^^^^^^^^^^ + +* :class:`~django.core.validators.URLValidator` now accepts an optional + ``schemes`` argument which allows customization of the accepted URI schemes + (instead of the defaults ``http(s)`` and ``ftp(s)``). + Backwards incompatible changes in 1.7 ===================================== diff --git a/tests/validators/tests.py b/tests/validators/tests.py index b0d1376aee..23fa1e3830 100644 --- a/tests/validators/tests.py +++ b/tests/validators/tests.py @@ -18,6 +18,7 @@ from django.test.utils import str_prefix NOW = datetime.now() +EXTENDED_SCHEMES = ['http', 'https', 'ftp', 'ftps', 'git', 'file'] TEST_DATA = ( # (validator, value, expected), @@ -141,6 +142,7 @@ TEST_DATA = ( (MinLengthValidator(10), '', ValidationError), (URLValidator(), 'http://www.djangoproject.com/', None), + (URLValidator(), 'HTTP://WWW.DJANGOPROJECT.COM/', None), (URLValidator(), 'http://localhost/', None), (URLValidator(), 'http://example.com/', None), (URLValidator(), 'http://www.example.com/', None), @@ -155,6 +157,8 @@ TEST_DATA = ( (URLValidator(), 'https://example.com/', None), (URLValidator(), 'ftp://example.com/', None), (URLValidator(), 'ftps://example.com/', None), + (URLValidator(EXTENDED_SCHEMES), 'file://localhost/path', None), + (URLValidator(EXTENDED_SCHEMES), 'git://example.com/', None), (URLValidator(), 'foo', ValidationError), (URLValidator(), 'http://', ValidationError), @@ -165,6 +169,9 @@ TEST_DATA = ( (URLValidator(), 'http://-invalid.com', ValidationError), (URLValidator(), 'http://inv-.alid-.com', ValidationError), (URLValidator(), 'http://inv-.-alid.com', ValidationError), + (URLValidator(), 'file://localhost/path', ValidationError), + (URLValidator(), 'git://example.com/', ValidationError), + (URLValidator(EXTENDED_SCHEMES), 'git://-invalid.com', ValidationError), (BaseValidator(True), True, None), (BaseValidator(True), False, ValidationError), From 5782c94f2382303dd28a35a9b9591ad480286220 Mon Sep 17 00:00:00 2001 From: Ramiro Morales Date: Sat, 28 Dec 2013 18:00:16 -0300 Subject: [PATCH 102/208] Added generation of SQLite FK DDL in initial migrations. SQLite accepts the relevant standard SQL (although by default it doesn't enforce the constraint), and the 'traditional' creation backend helper generate it, so this allows us to: - Maintain the status quo - Improve readability of the SQL code generated for that backend. Also, we will need this for when we fix Refs #14204. --- django/db/backends/schema.py | 31 +++++++++++++++++----------- django/db/backends/sqlite3/schema.py | 1 + 2 files changed, 20 insertions(+), 12 deletions(-) diff --git a/django/db/backends/schema.py b/django/db/backends/schema.py index b26f41c89a..e690567738 100644 --- a/django/db/backends/schema.py +++ b/django/db/backends/schema.py @@ -52,6 +52,7 @@ class BaseDatabaseSchemaEditor(object): sql_delete_unique = "ALTER TABLE %(table)s DROP CONSTRAINT %(name)s" sql_create_fk = "ALTER TABLE %(table)s ADD CONSTRAINT %(name)s FOREIGN KEY (%(column)s) REFERENCES %(to_table)s (%(to_column)s) DEFERRABLE INITIALLY DEFERRED" + sql_create_inline_fk = None sql_delete_fk = "ALTER TABLE %(table)s DROP CONSTRAINT %(name)s" sql_create_index = "CREATE INDEX %(name)s ON %(table)s (%(columns)s)%(extra)s" @@ -189,11 +190,6 @@ class BaseDatabaseSchemaEditor(object): col_type_suffix = field.db_type_suffix(connection=self.connection) if col_type_suffix: definition += " %s" % col_type_suffix - # Add the SQL to our big list - column_sqls.append("%s %s" % ( - self.quote_name(field.column), - definition, - )) params.extend(extra_params) # Indexes if field.db_index and not field.unique: @@ -206,18 +202,29 @@ class BaseDatabaseSchemaEditor(object): } ) # FK - if field.rel and self.connection.features.supports_foreign_keys: + if field.rel: to_table = field.rel.to._meta.db_table to_column = field.rel.to._meta.get_field(field.rel.field_name).column - self.deferred_sql.append( - self.sql_create_fk % { - "name": self._create_index_name(model, [field.column], suffix="_fk_%s_%s" % (to_table, to_column)), - "table": self.quote_name(model._meta.db_table), - "column": self.quote_name(field.column), + if self.connection.features.supports_foreign_keys: + self.deferred_sql.append( + self.sql_create_fk % { + "name": self._create_index_name(model, [field.column], suffix="_fk_%s_%s" % (to_table, to_column)), + "table": self.quote_name(model._meta.db_table), + "column": self.quote_name(field.column), + "to_table": self.quote_name(to_table), + "to_column": self.quote_name(to_column), + } + ) + elif self.sql_create_inline_fk: + definition += " " + self.sql_create_inline_fk % { "to_table": self.quote_name(to_table), "to_column": self.quote_name(to_column), } - ) + # Add the SQL to our big list + column_sqls.append("%s %s" % ( + self.quote_name(field.column), + definition, + )) # Autoincrement SQL (for backends with post table definition variant) if field.get_internal_type() == "AutoField": autoinc_sql = self.connection.ops.autoinc_sql(model._meta.db_table, field.column) diff --git a/django/db/backends/sqlite3/schema.py b/django/db/backends/sqlite3/schema.py index 3196b48946..41391724f6 100644 --- a/django/db/backends/sqlite3/schema.py +++ b/django/db/backends/sqlite3/schema.py @@ -6,6 +6,7 @@ from django.db.models.fields.related import ManyToManyField class DatabaseSchemaEditor(BaseDatabaseSchemaEditor): sql_delete_table = "DROP TABLE %(table)s" + sql_create_inline_fk = "REFERENCES %(to_table)s (%(to_column)s)" def _remake_table(self, model, create_fields=[], delete_fields=[], alter_fields=[], rename_fields=[], override_uniques=None): """ From 00110904ac67050c639f93cfd7b5e19218bcef5b Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Fri, 27 Dec 2013 20:55:58 +0100 Subject: [PATCH 103/208] Refactored the migration signals to use app configs. De-aliased pre/post_syncdb to pre/post_migrate to increase backwards-compatibility. --- django/contrib/auth/management/__init__.py | 27 +++-- django/contrib/auth/tests/test_management.py | 18 ++- django/contrib/contenttypes/management.py | 16 ++- django/contrib/sites/management.py | 26 +++-- django/core/management/sql.py | 14 +++ django/db/models/signals.py | 9 +- docs/internals/deprecation.txt | 5 +- docs/ref/signals.txt | 117 ++++++++++++++++--- docs/releases/1.7.txt | 9 +- tests/migrate_signals/models.py | 4 +- tests/migrate_signals/tests.py | 18 ++- 11 files changed, 187 insertions(+), 76 deletions(-) diff --git a/django/contrib/auth/management/__init__.py b/django/contrib/auth/management/__init__.py index 306b051284..f933b61c86 100644 --- a/django/contrib/auth/management/__init__.py +++ b/django/contrib/auth/management/__init__.py @@ -60,18 +60,21 @@ def _check_permission_clashing(custom, builtin, ctype): pool.add(codename) -def create_permissions(app, created_models, verbosity, db=DEFAULT_DB_ALIAS, **kwargs): +def create_permissions(app_config, verbosity=22, interactive=True, db=DEFAULT_DB_ALIAS, **kwargs): + if not app_config.models_module: + return + try: - apps.get_model('auth', 'Permission') + Permission = apps.get_model('auth', 'Permission') except LookupError: return - if not router.allow_migrate(db, auth_app.Permission): + if not router.allow_migrate(db, Permission): return from django.contrib.contenttypes.models import ContentType - app_models = apps.get_models(app) + app_models = apps.get_models(app_config.models_module) # This will hold the permissions we're looking for as # (content_type, (codename, name)) @@ -89,20 +92,20 @@ def create_permissions(app, created_models, verbosity, db=DEFAULT_DB_ALIAS, **kw # Find all the Permissions that have a content_type for a model we're # looking for. We don't need to check for codenames since we already have # a list of the ones we're going to create. - all_perms = set(auth_app.Permission.objects.using(db).filter( + all_perms = set(Permission.objects.using(db).filter( content_type__in=ctypes, ).values_list( "content_type", "codename" )) perms = [ - auth_app.Permission(codename=codename, name=name, content_type=ctype) + Permission(codename=codename, name=name, content_type=ctype) for ctype, (codename, name) in searched_perms if (ctype.pk, codename) not in all_perms ] # Validate the permissions before bulk_creation to avoid cryptic # database error when the verbose_name is longer than 50 characters - permission_name_max_length = auth_app.Permission._meta.get_field('name').max_length + permission_name_max_length = Permission._meta.get_field('name').max_length verbose_name_max_length = permission_name_max_length - 11 # len('Can change ') prefix for perm in perms: if len(perm.name) > permission_name_max_length: @@ -112,13 +115,13 @@ def create_permissions(app, created_models, verbosity, db=DEFAULT_DB_ALIAS, **kw verbose_name_max_length, ) ) - auth_app.Permission.objects.using(db).bulk_create(perms) + Permission.objects.using(db).bulk_create(perms) if verbosity >= 2: for perm in perms: print("Adding permission '%s'" % perm) -def create_superuser(app, created_models, verbosity, db, **kwargs): +def create_superuser(app_config, verbosity=22, interactive=True, db=DEFAULT_DB_ALIAS, **kwargs): try: apps.get_model('auth', 'Permission') except LookupError: @@ -128,7 +131,7 @@ def create_superuser(app, created_models, verbosity, db, **kwargs): from django.core.management import call_command - if UserModel in created_models and kwargs.get('interactive', True): + if not UserModel.objects.exists() and interactive: msg = ("\nYou just installed Django's auth system, which means you " "don't have any superusers defined.\nWould you like to create one " "now? (yes/no): ") @@ -203,7 +206,9 @@ def get_default_username(check_db=True): return '' return default_username + signals.post_migrate.connect(create_permissions, dispatch_uid="django.contrib.auth.management.create_permissions") signals.post_migrate.connect(create_superuser, - sender=auth_app, dispatch_uid="django.contrib.auth.management.create_superuser") + sender=apps.get_app_config('auth'), + dispatch_uid="django.contrib.auth.management.create_superuser") diff --git a/django/contrib/auth/tests/test_management.py b/django/contrib/auth/tests/test_management.py index db4b698d8b..c60346c2ac 100644 --- a/django/contrib/auth/tests/test_management.py +++ b/django/contrib/auth/tests/test_management.py @@ -232,13 +232,15 @@ class PermissionTestCase(TestCase): Test that we show proper error message if we are trying to create duplicate permissions. """ + auth_app_config = apps.get_app_config('auth') + # check duplicated default permission models.Permission._meta.permissions = [ ('change_permission', 'Can edit permission (duplicate)')] six.assertRaisesRegex(self, CommandError, "The permission codename 'change_permission' clashes with a " "builtin permission for model 'auth.Permission'.", - create_permissions, models, [], verbosity=0) + create_permissions, auth_app_config, verbosity=0) # check duplicated custom permissions models.Permission._meta.permissions = [ @@ -249,21 +251,23 @@ class PermissionTestCase(TestCase): six.assertRaisesRegex(self, CommandError, "The permission codename 'my_custom_permission' is duplicated for model " "'auth.Permission'.", - create_permissions, models, [], verbosity=0) + create_permissions, auth_app_config, verbosity=0) # should not raise anything models.Permission._meta.permissions = [ ('my_custom_permission', 'Some permission'), ('other_one', 'Some other permission'), ] - create_permissions(models, [], verbosity=0) + create_permissions(auth_app_config, verbosity=0) def test_default_permissions(self): + auth_app_config = apps.get_app_config('auth') + permission_content_type = ContentType.objects.get_by_natural_key('auth', 'permission') models.Permission._meta.permissions = [ ('my_custom_permission', 'Some permission'), ] - create_permissions(models, [], verbosity=0) + create_permissions(auth_app_config, verbosity=0) # add/change/delete permission by default + custom permission self.assertEqual(models.Permission.objects.filter( @@ -272,7 +276,7 @@ class PermissionTestCase(TestCase): models.Permission.objects.filter(content_type=permission_content_type).delete() models.Permission._meta.default_permissions = [] - create_permissions(models, [], verbosity=0) + create_permissions(auth_app_config, verbosity=0) # custom permission only since default permissions is empty self.assertEqual(models.Permission.objects.filter( @@ -280,10 +284,12 @@ class PermissionTestCase(TestCase): ).count(), 1) def test_verbose_name_length(self): + auth_app_config = apps.get_app_config('auth') + permission_content_type = ContentType.objects.get_by_natural_key('auth', 'permission') models.Permission.objects.filter(content_type=permission_content_type).delete() models.Permission._meta.verbose_name = "some ridiculously long verbose name that is out of control" six.assertRaisesRegex(self, exceptions.ValidationError, "The verbose_name of permission is longer than 39 characters", - create_permissions, models, [], verbosity=0) + create_permissions, auth_app_config, verbosity=0) diff --git a/django/contrib/contenttypes/management.py b/django/contrib/contenttypes/management.py index 6b2d2d22f1..a7b47456a6 100644 --- a/django/contrib/contenttypes/management.py +++ b/django/contrib/contenttypes/management.py @@ -1,5 +1,4 @@ from django.apps import apps -from django.contrib.contenttypes.models import ContentType from django.db import DEFAULT_DB_ALIAS, router from django.db.models import signals from django.utils.encoding import smart_text @@ -7,13 +6,16 @@ from django.utils import six from django.utils.six.moves import input -def update_contenttypes(app, created_models, verbosity=2, db=DEFAULT_DB_ALIAS, **kwargs): +def update_contenttypes(app_config, verbosity=2, interactive=True, db=DEFAULT_DB_ALIAS, **kwargs): """ Creates content types for models in the given app, removing any model entries that no longer have a matching model class. """ + if not app_config.models_module: + return + try: - apps.get_model('contenttypes', 'ContentType') + ContentType = apps.get_model('contenttypes', 'ContentType') except LookupError: return @@ -21,7 +23,7 @@ def update_contenttypes(app, created_models, verbosity=2, db=DEFAULT_DB_ALIAS, * return ContentType.objects.clear_cache() - app_models = apps.get_models(app) + app_models = apps.get_models(app_config.models_module) if not app_models: return # They all have the same app_label, get the first one. @@ -85,11 +87,13 @@ If you're unsure, answer 'no'. print("Stale content types remain.") -def update_all_contenttypes(verbosity=2, **kwargs): +def update_all_contenttypes(**kwargs): for app_config in apps.get_app_configs(only_with_models_module=True): - update_contenttypes(app_config.models_module, None, verbosity, **kwargs) + update_contenttypes(app_config, **kwargs) + signals.post_migrate.connect(update_contenttypes) + if __name__ == "__main__": update_all_contenttypes() diff --git a/django/contrib/sites/management.py b/django/contrib/sites/management.py index 7dec568fa4..ab9ff69c35 100644 --- a/django/contrib/sites/management.py +++ b/django/contrib/sites/management.py @@ -2,17 +2,22 @@ Creates the default Site object. """ -from django.db.models import signals -from django.db import connections -from django.db import router -from django.contrib.sites.models import Site -from django.contrib.sites import models as site_app +from django.apps import apps from django.core.management.color import no_style +from django.db import DEFAULT_DB_ALIAS, connections, router +from django.db.models import signals -def create_default_site(app, created_models, verbosity, db, **kwargs): - # Only create the default sites in databases where Django created the table - if Site in created_models and router.allow_migrate(db, Site): +def create_default_site(app_config, verbosity=22, interactive=True, db=DEFAULT_DB_ALIAS, **kwargs): + try: + Site = apps.get_model('sites', 'Site') + except LookupError: + return + + if not router.allow_migrate(db, Site): + return + + if not Site.objects.exists(): # The default settings set SITE_ID = 1, and some tests in Django's test # suite rely on this value. However, if database sequences are reused # (e.g. in the test suite after flush/syncdb), it isn't guaranteed that @@ -32,6 +37,7 @@ def create_default_site(app, created_models, verbosity, db, **kwargs): for command in sequence_sql: cursor.execute(command) - Site.objects.clear_cache() + Site.objects.clear_cache() -signals.post_migrate.connect(create_default_site, sender=site_app) + +signals.post_migrate.connect(create_default_site, sender=apps.get_app_config('sites')) diff --git a/django/core/management/sql.py b/django/core/management/sql.py index 35ce693e3b..40becd34d7 100644 --- a/django/core/management/sql.py +++ b/django/core/management/sql.py @@ -211,6 +211,13 @@ def emit_pre_migrate_signal(create_models, verbosity, interactive, db): if verbosity >= 2: print("Running pre-migrate handlers for application %s" % app_config.label) models.signals.pre_migrate.send( + sender=app_config, + app_config=app_config, + verbosity=verbosity, + interactive=interactive, + db=db) + # For backwards-compatibility -- remove in Django 1.9. + models.signals.pre_syncdb.send( sender=app_config.models_module, app=app_config.models_module, create_models=create_models, @@ -225,6 +232,13 @@ def emit_post_migrate_signal(created_models, verbosity, interactive, db): if verbosity >= 2: print("Running post-migrate handlers for application %s" % app_config.label) models.signals.post_migrate.send( + sender=app_config, + app_config=app_config, + verbosity=verbosity, + interactive=interactive, + db=db) + # For backwards-compatibility -- remove in Django 1.9. + models.signals.post_syncdb.send( sender=app_config.models_module, app=app_config.models_module, created_models=created_models, diff --git a/django/db/models/signals.py b/django/db/models/signals.py index f5e1ac2cf4..627358ac63 100644 --- a/django/db/models/signals.py +++ b/django/db/models/signals.py @@ -62,7 +62,8 @@ post_delete = ModelSignal(providing_args=["instance", "using"], use_caching=True m2m_changed = ModelSignal(providing_args=["action", "instance", "reverse", "model", "pk_set", "using"], use_caching=True) -pre_migrate = Signal(providing_args=["app", "create_models", "verbosity", "interactive", "db"]) -pre_syncdb = pre_migrate -post_migrate = Signal(providing_args=["class", "app", "created_models", "verbosity", "interactive", "db"]) -post_syncdb = post_migrate +pre_migrate = Signal(providing_args=["app_config", "verbosity", "interactive", "db"]) +post_migrate = Signal(providing_args=["app_config", "verbosity", "interactive", "db"]) + +pre_syncdb = Signal(providing_args=["app", "create_models", "verbosity", "interactive", "db"]) +post_syncdb = Signal(providing_args=["class", "app", "created_models", "verbosity", "interactive", "db"]) diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index 29f7df53ae..1b8b45a520 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -165,10 +165,7 @@ these changes. * The ``syncdb`` command will be removed. * ``django.db.models.signals.pre_syncdb`` and - ``django.db.models.signals.post_syncdb`` will be removed, and - ``django.db.models.signals.pre_migrate`` and - ``django.db.models.signals.post_migrate`` will lose their - ``create_models`` and ``created_models`` arguments. + ``django.db.models.signals.post_syncdb`` will be removed. * ``allow_syncdb`` on database routers will no longer automatically become ``allow_migrate``. diff --git a/docs/ref/signals.txt b/docs/ref/signals.txt index 1abfed8806..ece6990aa7 100644 --- a/docs/ref/signals.txt +++ b/docs/ref/signals.txt @@ -381,12 +381,10 @@ handlers are registered anywhere else they may not be loaded by Arguments sent with this signal: ``sender`` - The ``models`` module of the app about to be migrated/synced. - For example, if :djadmin:`migrate` is about to install - an app called ``"foo.bar.myapp"``, ``sender`` will be the - ``foo.bar.myapp.models`` module. + An :class:`~django.apps.AppConfig` instance for the application about to + be migrated/synced. -``app`` +``app_config`` Same as ``sender``. ``verbosity`` @@ -415,14 +413,48 @@ pre_syncdb .. deprecated:: 1.7 - This signal has been renamed to :data:`~django.db.models.signals.pre_migrate`. + This signal has been replaced by :data:`~django.db.models.signals.pre_migrate`. -Alias of :data:`django.db.models.signals.pre_migrate`. As long as this alias -is present, for backwards-compatibility this signal has an extra argument it sends: +Sent by the :djadmin:`syncdb` command before it starts to install an +application. + +Any handlers that listen to this signal need to be written in a particular +place: a ``management`` module in one of your :setting:`INSTALLED_APPS`. If +handlers are registered anywhere else they may not be loaded by +:djadmin:`syncdb`. + +Arguments sent with this signal: + +``sender`` + The ``models`` module that was just installed. That is, if + :djadmin:`syncdb` just installed an app called ``"foo.bar.myapp"``, + ``sender`` will be the ``foo.bar.myapp.models`` module. + +``app`` + Same as ``sender``. ``create_models`` - A list of the model classes from any app which :djadmin:`migrate` is - going to create, **only if the app has no migrations**. + A list of the model classes from any app which :djadmin:`syncdb` plans to + create. + + +``verbosity`` + Indicates how much information manage.py is printing on screen. See + the :djadminopt:`--verbosity` flag for details. + + Functions which listen for :data:`pre_syncdb` should adjust what they + output to the screen based on the value of this argument. + +``interactive`` + If ``interactive`` is ``True``, it's safe to prompt the user to input + things on the command line. If ``interactive`` is ``False``, functions + which listen for this signal should not try to prompt for anything. + + For example, the :mod:`django.contrib.auth` app only prompts to create a + superuser when ``interactive`` is ``True``. + +``db`` + The alias of database on which a command will operate. post_migrate ------------ @@ -444,11 +476,10 @@ idempotent changes (e.g. no database alterations) as this may cause the Arguments sent with this signal: ``sender`` - The ``models`` module that was just installed. That is, if - :djadmin:`migrate` just installed an app called ``"foo.bar.myapp"``, - ``sender`` will be the ``foo.bar.myapp.models`` module. + An :class:`~django.apps.AppConfig` instance for the application that was + just installed. -``app`` +``app_config`` Same as ``sender``. ``verbosity`` @@ -489,14 +520,62 @@ post_syncdb .. deprecated:: 1.7 - This signal has been renamed to :data:`~django.db.models.signals.post_migrate`. + This signal has been replaced by :data:`~django.db.models.signals.post_migrate`. -Alias of :data:`django.db.models.signals.post_migrate`. As long as this alias -is present, for backwards-compatibility this signal has an extra argument it sends: +Sent by the :djadmin:`syncdb` command after it installs an application, and the +:djadmin:`flush` command. + +Any handlers that listen to this signal need to be written in a particular +place: a ``management`` module in one of your :setting:`INSTALLED_APPS`. If +handlers are registered anywhere else they may not be loaded by +:djadmin:`syncdb`. It is important that handlers of this signal perform +idempotent changes (e.g. no database alterations) as this may cause the +:djadmin:`flush` management command to fail if it also ran during the +:djadmin:`syncdb` command. + +Arguments sent with this signal: + +``sender`` + The ``models`` module that was just installed. That is, if + :djadmin:`syncdb` just installed an app called ``"foo.bar.myapp"``, + ``sender`` will be the ``foo.bar.myapp.models`` module. + +``app`` + Same as ``sender``. ``created_models`` - A list of the model classes from any app which :djadmin:`migrate` has - created, **only if the app has no migrations**. + A list of the model classes from any app which :djadmin:`syncdb` has + created so far. + +``verbosity`` + Indicates how much information manage.py is printing on screen. See + the :djadminopt:`--verbosity` flag for details. + + Functions which listen for :data:`post_syncdb` should adjust what they + output to the screen based on the value of this argument. + +``interactive`` + If ``interactive`` is ``True``, it's safe to prompt the user to input + things on the command line. If ``interactive`` is ``False``, functions + which listen for this signal should not try to prompt for anything. + + For example, the :mod:`django.contrib.auth` app only prompts to create a + superuser when ``interactive`` is ``True``. + +``db`` + The database alias used for synchronization. Defaults to the ``default`` + database. + +For example, ``yourapp/management/__init__.py`` could be written like:: + + from django.db.models.signals import post_syncdb + import yourapp.models + + def my_callback(sender, **kwargs): + # Your specific logic here + pass + + post_syncdb.connect(my_callback, sender=yourapp.models) Request/response signals ======================== diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index a7e7da6d15..5416d9dc0b 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -47,11 +47,12 @@ but a few of the key features are: * A new ``makemigrations`` command provides an easy way to autodetect changes to your models and make migrations for them. -* :data:`~django.db.models.signals.pre_syncdb` and - :data:`~django.db.models.signals.post_syncdb` have been renamed to + :data:`~django.db.models.signals.pre_syncdb` and + :data:`~django.db.models.signals.post_syncdb` have been replaced by :data:`~django.db.models.signals.pre_migrate` and - :data:`~django.db.models.signals.post_migrate` respectively. The - ``create_models``/``created_models`` argument has also been deprecated. + :data:`~django.db.models.signals.post_migrate` respectively. These new + signals have slightly different arguments. Check the documentation for + details. * The ``allow_syncdb`` method on database routers is now called ``allow_migrate``, but still performs the same function. Routers with ``allow_syncdb`` methods diff --git a/tests/migrate_signals/models.py b/tests/migrate_signals/models.py index 55a8657a3c..2cd71391fb 100644 --- a/tests/migrate_signals/models.py +++ b/tests/migrate_signals/models.py @@ -1,2 +1,2 @@ -# Remove this module when pre/post_migrate are refactored to use something -# other than a models module for their "sender" argument. +# This module has to exist, otherwise pre/post_migrate aren't sent for the +# migrate_signals application. diff --git a/tests/migrate_signals/tests.py b/tests/migrate_signals/tests.py index 9daa7ae376..7e1d5be103 100644 --- a/tests/migrate_signals/tests.py +++ b/tests/migrate_signals/tests.py @@ -1,12 +1,12 @@ +from django.apps import apps from django.db.models import signals from django.test import TestCase from django.core import management from django.utils import six -from . import models - -PRE_MIGRATE_ARGS = ['app', 'create_models', 'verbosity', 'interactive', 'db'] +APP_CONFIG = apps.get_app_config('migrate_signals') +PRE_MIGRATE_ARGS = ['app_config', 'verbosity', 'interactive', 'db'] MIGRATE_DATABASE = 'default' MIGRATE_VERBOSITY = 1 MIGRATE_INTERACTIVE = False @@ -39,7 +39,7 @@ class OneTimeReceiver(object): self.call_counter = self.call_counter + 1 self.call_args = kwargs # we need to test only one call of migrate - signals.pre_migrate.disconnect(pre_migrate_receiver, sender=models) + signals.pre_migrate.disconnect(pre_migrate_receiver, sender=APP_CONFIG) # We connect receiver here and not in unit test code because we need to @@ -51,21 +51,19 @@ class OneTimeReceiver(object): # 3. Test runner calls migrate for create default database. # 4. Test runner execute our unit test code. pre_migrate_receiver = OneTimeReceiver() -signals.pre_migrate.connect(pre_migrate_receiver, sender=models) +signals.pre_migrate.connect(pre_migrate_receiver, sender=APP_CONFIG) class MigrateSignalTests(TestCase): - available_apps = [ - 'migrate_signals', - ] + available_apps = ['migrate_signals'] def test_pre_migrate_call_time(self): self.assertEqual(pre_migrate_receiver.call_counter, 1) def test_pre_migrate_args(self): r = PreMigrateReceiver() - signals.pre_migrate.connect(r, sender=models) + signals.pre_migrate.connect(r, sender=APP_CONFIG) management.call_command('migrate', database=MIGRATE_DATABASE, verbosity=MIGRATE_VERBOSITY, interactive=MIGRATE_INTERACTIVE, load_initial_data=False, stdout=six.StringIO()) @@ -73,7 +71,7 @@ class MigrateSignalTests(TestCase): args = r.call_args self.assertEqual(r.call_counter, 1) self.assertEqual(set(args), set(PRE_MIGRATE_ARGS)) - self.assertEqual(args['app'], models) + self.assertEqual(args['app_config'], APP_CONFIG) self.assertEqual(args['verbosity'], MIGRATE_VERBOSITY) self.assertEqual(args['interactive'], MIGRATE_INTERACTIVE) self.assertEqual(args['db'], 'default') From 308960b92af90849874ff94862ef5b07b4f4d9fd Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 29 Dec 2013 18:25:22 +0100 Subject: [PATCH 104/208] Cleared get_models cache when swapping User model. Thanks Florian for isolating the shortest way to reproduce this issue: ./runtests.py \ django.contrib.auth.tests.test_context_processors.AuthContextProcessorTests.test_perms_attrs \ django.contrib.auth.tests.test_auth_backends.ChangedBackendSettingsTest.test_changed_backend_settings \ django.contrib.auth.tests.test_auth_backends.CustomUserModelBackendAuthenticateTest.test_authenticate \ django.contrib.auth.tests.test_basic.BasicTestCase.test_createsuperuser_management_command --- django/contrib/auth/tests/test_basic.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/django/contrib/auth/tests/test_basic.py b/django/contrib/auth/tests/test_basic.py index ec33aece25..beaa97f285 100644 --- a/django/contrib/auth/tests/test_basic.py +++ b/django/contrib/auth/tests/test_basic.py @@ -3,6 +3,7 @@ from __future__ import unicode_literals import locale +from django.apps import apps from django.contrib.auth import get_user_model from django.contrib.auth.management.commands import createsuperuser from django.contrib.auth.models import User, AnonymousUser @@ -25,6 +26,7 @@ def user_model_swapped(**kwargs): # Reset User manager setattr(User, 'objects', User._default_manager) ensure_default_manager(User) + apps.get_models.cache_clear() def mock_inputs(inputs): From 20d487c27b40bb70496ddc7419011ca78b7d4940 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 29 Dec 2013 18:42:12 +0100 Subject: [PATCH 105/208] Replaced Options.object_name.lower() by Options.model_name. Thanks Simon for the suggestion. Also removed inappropriate lowercasing of app labels in migrations. Unlike model names, they are case sensitive. --- .../admin/templates/admin/auth/user/change_password.html | 2 +- django/contrib/admin/templates/admin/change_form.html | 2 +- django/contrib/admin/templates/admin/change_list.html | 2 +- django/contrib/admin/templates/admin/delete_confirmation.html | 2 +- .../admin/templates/admin/delete_selected_confirmation.html | 2 +- django/contrib/admindocs/templates/admin_doc/model_index.html | 2 +- django/db/migrations/autodetector.py | 4 ++-- django/db/migrations/state.py | 2 +- django/db/models/fields/related.py | 2 +- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/django/contrib/admin/templates/admin/auth/user/change_password.html b/django/contrib/admin/templates/admin/auth/user/change_password.html index 3634ed4083..f37f35c6a3 100644 --- a/django/contrib/admin/templates/admin/auth/user/change_password.html +++ b/django/contrib/admin/templates/admin/auth/user/change_password.html @@ -6,7 +6,7 @@ {% endblock %} {% block extrastyle %}{{ block.super }}{% endblock %} -{% block bodyclass %}{{ opts.app_label }}-{{ opts.object_name.lower }} change-form{% endblock %} +{% block bodyclass %}{{ opts.app_label }}-{{ opts.model_name }} change-form{% endblock %} {% if not is_popup %} {% block breadcrumbs %}
    diff --git a/django/contrib/admin/templates/admin/change_form.html b/django/contrib/admin/templates/admin/change_form.html index be2cd862d4..bd71d97f3c 100644 --- a/django/contrib/admin/templates/admin/change_form.html +++ b/django/contrib/admin/templates/admin/change_form.html @@ -10,7 +10,7 @@ {% block coltype %}colM{% endblock %} -{% block bodyclass %}app-{{ opts.app_label }} model-{{ opts.object_name.lower }} change-form{% endblock %} +{% block bodyclass %}app-{{ opts.app_label }} model-{{ opts.model_name }} change-form{% endblock %} {% if not is_popup %} {% block breadcrumbs %} diff --git a/django/contrib/admin/templates/admin/change_list.html b/django/contrib/admin/templates/admin/change_list.html index 766a7c0fe6..407b0e0774 100644 --- a/django/contrib/admin/templates/admin/change_list.html +++ b/django/contrib/admin/templates/admin/change_list.html @@ -32,7 +32,7 @@ {% endif %}{% endif %} {% endblock %} -{% block bodyclass %}app-{{ opts.app_label }} model-{{ opts.object_name.lower }} change-list{% endblock %} +{% block bodyclass %}app-{{ opts.app_label }} model-{{ opts.model_name }} change-list{% endblock %} {% if not is_popup %} {% block breadcrumbs %} diff --git a/django/contrib/admin/templates/admin/delete_confirmation.html b/django/contrib/admin/templates/admin/delete_confirmation.html index c2057a635e..8e8962ff08 100644 --- a/django/contrib/admin/templates/admin/delete_confirmation.html +++ b/django/contrib/admin/templates/admin/delete_confirmation.html @@ -1,7 +1,7 @@ {% extends "admin/base_site.html" %} {% load i18n admin_urls %} -{% block bodyclass %}app-{{ opts.app_label }} model-{{ opts.object_name.lower }} delete-confirmation{% endblock %} +{% block bodyclass %}app-{{ opts.app_label }} model-{{ opts.model_name }} delete-confirmation{% endblock %} {% block breadcrumbs %}
    diff --git a/django/contrib/admin/templates/admin/delete_selected_confirmation.html b/django/contrib/admin/templates/admin/delete_selected_confirmation.html index a8f059fd46..3013c6a235 100644 --- a/django/contrib/admin/templates/admin/delete_selected_confirmation.html +++ b/django/contrib/admin/templates/admin/delete_selected_confirmation.html @@ -1,7 +1,7 @@ {% extends "admin/base_site.html" %} {% load i18n l10n admin_urls %} -{% block bodyclass %}app-{{ opts.app_label }} model-{{ opts.object_name.lower }} delete-confirmation delete-selected-confirmation{% endblock %} +{% block bodyclass %}app-{{ opts.app_label }} model-{{ opts.model_name }} delete-confirmation delete-selected-confirmation{% endblock %} {% block breadcrumbs %}
    diff --git a/django/contrib/admindocs/templates/admin_doc/model_index.html b/django/contrib/admindocs/templates/admin_doc/model_index.html index d4cde8334f..f48f80dd9f 100644 --- a/django/contrib/admindocs/templates/admin_doc/model_index.html +++ b/django/contrib/admindocs/templates/admin_doc/model_index.html @@ -27,7 +27,7 @@ {% for model in group.list %} - + {% endfor %}
    {{ model.object_name }}{{ model.object_name }}
    diff --git a/django/db/migrations/autodetector.py b/django/db/migrations/autodetector.py index f71d193960..b98aef2f9a 100644 --- a/django/db/migrations/autodetector.py +++ b/django/db/migrations/autodetector.py @@ -71,9 +71,9 @@ class MigrationAutodetector(object): for field in new_apps.get_model(app_label, model_name)._meta.local_fields: if field.rel: if field.rel.to: - related_fields.append((field.name, field.rel.to._meta.app_label.lower(), field.rel.to._meta.object_name.lower())) + related_fields.append((field.name, field.rel.to._meta.app_label, field.rel.to._meta.model_name)) if hasattr(field.rel, "through") and not field.rel.though._meta.auto_created: - related_fields.append((field.name, field.rel.through._meta.app_label.lower(), field.rel.through._meta.object_name.lower())) + related_fields.append((field.name, field.rel.through._meta.app_label, field.rel.through._meta.model_name)) if related_fields: pending_add[app_label, model_name] = related_fields else: diff --git a/django/db/migrations/state.py b/django/db/migrations/state.py index 7eedcdbac6..fcf639837e 100644 --- a/django/db/migrations/state.py +++ b/django/db/migrations/state.py @@ -152,7 +152,7 @@ class ModelState(object): options[name] = model._meta.original_attrs[name] # Make our record bases = tuple( - ("%s.%s" % (base._meta.app_label, base._meta.object_name.lower()) if hasattr(base, "_meta") else base) + ("%s.%s" % (base._meta.app_label, base._meta.model_name) if hasattr(base, "_meta") else base) for base in model.__bases__ if (not hasattr(base, "_meta") or not base._meta.abstract) ) diff --git a/django/db/models/fields/related.py b/django/db/models/fields/related.py index beaa48c6f1..82e7725dac 100644 --- a/django/db/models/fields/related.py +++ b/django/db/models/fields/related.py @@ -1278,7 +1278,7 @@ class ForeignKey(ForeignObject): def __init__(self, to, to_field=None, rel_class=ManyToOneRel, db_constraint=True, **kwargs): try: - to._meta.object_name.lower() + to._meta.model_name except AttributeError: # to._meta doesn't exist, so it must be RECURSIVE_RELATIONSHIP_CONSTANT assert isinstance(to, six.string_types), "%s(%r) is invalid. First parameter to ForeignKey must be either a model, a model name, or the string %r" % (self.__class__.__name__, to, RECURSIVE_RELATIONSHIP_CONSTANT) else: From 98b52ae201f17b3fb702403ce676c7d324f3bfbc Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Sun, 29 Dec 2013 19:17:25 +0100 Subject: [PATCH 106/208] Cleared global templatetags module cache. TOOOOO MUCH GLOBAL STATE (you didn't see that). --- django/test/signals.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/django/test/signals.py b/django/test/signals.py index 49bfc64292..b806592919 100644 --- a/django/test/signals.py +++ b/django/test/signals.py @@ -36,6 +36,9 @@ def update_installed_apps(**kwargs): # Rebuild app_template_dirs cache. from django.template.loaders import app_directories as mod mod.app_template_dirs = mod.calculate_app_template_dirs() + # Rebuild templatetags module cache. + from django.template import base + base.templatetags_modules[:] = [] @receiver(setting_changed) From 7b88a96553bffcaffb3d8ecb54d0ef7c3c0e934f Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 29 Dec 2013 20:26:13 +0100 Subject: [PATCH 107/208] Added AppConfig.get_models(). --- django/apps/base.py | 26 +++++++++++++++++++ django/contrib/auth/management/__init__.py | 4 +-- django/contrib/contenttypes/management.py | 14 +++++----- django/core/management/commands/dumpdata.py | 2 +- .../management/commands/sqlsequencereset.py | 2 +- docs/ref/applications.txt | 4 +++ 6 files changed, 40 insertions(+), 12 deletions(-) diff --git a/django/apps/base.py b/django/apps/base.py index 31d75bf5ed..784c460bcd 100644 --- a/django/apps/base.py +++ b/django/apps/base.py @@ -126,6 +126,32 @@ class AppConfig(object): raise LookupError( "App '%s' doesn't have a '%s' model." % (self.label, model_name)) + def get_models(self, include_auto_created=False, + include_deferred=False, include_swapped=False): + """ + Returns an iterable of models. + + By default, the following models aren't included: + + - auto-created models for many-to-many relations without + an explicit intermediate table, + - models created to satisfy deferred attribute queries, + - models that have been swapped out. + + Set the corresponding keyword argument to True to include such models. + Keyword arguments aren't documented; they're a private API. + + This method assumes that apps.populate_models() has run. + """ + for model in self.models.values(): + if model._deferred and not include_deferred: + continue + if model._meta.auto_created and not include_auto_created: + continue + if model._meta.swapped and not include_swapped: + continue + yield model + def import_models(self, all_models): # Dictionary of models for this app, primarily maintained in the # 'all_models' attribute of the Apps this AppConfig is attached to. diff --git a/django/contrib/auth/management/__init__.py b/django/contrib/auth/management/__init__.py index f933b61c86..e24cdd6865 100644 --- a/django/contrib/auth/management/__init__.py +++ b/django/contrib/auth/management/__init__.py @@ -74,14 +74,12 @@ def create_permissions(app_config, verbosity=22, interactive=True, db=DEFAULT_DB from django.contrib.contenttypes.models import ContentType - app_models = apps.get_models(app_config.models_module) - # This will hold the permissions we're looking for as # (content_type, (codename, name)) searched_perms = list() # The codenames and ctypes that should exist. ctypes = set() - for klass in app_models: + for klass in app_config.get_models(): # Force looking up the content types in the current database # before creating foreign keys to them. ctype = ContentType.objects.db_manager(db).get_for_model(klass) diff --git a/django/contrib/contenttypes/management.py b/django/contrib/contenttypes/management.py index a7b47456a6..1b499d85f1 100644 --- a/django/contrib/contenttypes/management.py +++ b/django/contrib/contenttypes/management.py @@ -23,15 +23,15 @@ def update_contenttypes(app_config, verbosity=2, interactive=True, db=DEFAULT_DB return ContentType.objects.clear_cache() - app_models = apps.get_models(app_config.models_module) - if not app_models: - return - # They all have the same app_label, get the first one. - app_label = app_models[0]._meta.app_label + + app_label = app_config.label + app_models = dict( (model._meta.model_name, model) - for model in app_models - ) + for model in app_config.get_models()) + + if not app_models: + return # Get all the content types content_types = dict( diff --git a/django/core/management/commands/dumpdata.py b/django/core/management/commands/dumpdata.py index c4501c5b24..d4d8b54af6 100644 --- a/django/core/management/commands/dumpdata.py +++ b/django/core/management/commands/dumpdata.py @@ -169,7 +169,7 @@ def sort_dependencies(app_list): models = set() for app_config, model_list in app_list: if model_list is None: - model_list = apps.get_models(app_config.models_module) + model_list = app_config.get_models() for model in model_list: models.add(model) diff --git a/django/core/management/commands/sqlsequencereset.py b/django/core/management/commands/sqlsequencereset.py index d32ff3c5d0..65fee8183f 100644 --- a/django/core/management/commands/sqlsequencereset.py +++ b/django/core/management/commands/sqlsequencereset.py @@ -23,6 +23,6 @@ class Command(AppCommand): if app_config.models_module is None: return connection = connections[options.get('database')] - models = apps.get_models(app_config.models_module, include_auto_created=True) + models = app_config.get_models(include_auto_created=True) statements = connection.ops.sequence_reset_sql(self.style, models) return '\n'.join(statements) diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt index 1fc74f6bee..8505784737 100644 --- a/docs/ref/applications.txt +++ b/docs/ref/applications.txt @@ -156,6 +156,10 @@ Read-only attributes Methods ------- +.. method:: AppConfig.get_models() + + Returns an iterable of :class:`~django.db.models.Model` classes. + .. method:: AppConfig.get_model(model_name) Returns the :class:`~django.db.models.Model` with the given From 82aadbb5d50cca5e4c42f3f5b7cb1707b818ab28 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 29 Dec 2013 20:35:58 +0100 Subject: [PATCH 108/208] Fixed a typo. Thanks Simon. --- django/contrib/auth/management/__init__.py | 4 ++-- django/contrib/sites/management.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/django/contrib/auth/management/__init__.py b/django/contrib/auth/management/__init__.py index e24cdd6865..212946ac54 100644 --- a/django/contrib/auth/management/__init__.py +++ b/django/contrib/auth/management/__init__.py @@ -60,7 +60,7 @@ def _check_permission_clashing(custom, builtin, ctype): pool.add(codename) -def create_permissions(app_config, verbosity=22, interactive=True, db=DEFAULT_DB_ALIAS, **kwargs): +def create_permissions(app_config, verbosity=2, interactive=True, db=DEFAULT_DB_ALIAS, **kwargs): if not app_config.models_module: return @@ -119,7 +119,7 @@ def create_permissions(app_config, verbosity=22, interactive=True, db=DEFAULT_DB print("Adding permission '%s'" % perm) -def create_superuser(app_config, verbosity=22, interactive=True, db=DEFAULT_DB_ALIAS, **kwargs): +def create_superuser(app_config, verbosity=2, interactive=True, db=DEFAULT_DB_ALIAS, **kwargs): try: apps.get_model('auth', 'Permission') except LookupError: diff --git a/django/contrib/sites/management.py b/django/contrib/sites/management.py index ab9ff69c35..e7624e75cf 100644 --- a/django/contrib/sites/management.py +++ b/django/contrib/sites/management.py @@ -8,7 +8,7 @@ from django.db import DEFAULT_DB_ALIAS, connections, router from django.db.models import signals -def create_default_site(app_config, verbosity=22, interactive=True, db=DEFAULT_DB_ALIAS, **kwargs): +def create_default_site(app_config, verbosity=2, interactive=True, db=DEFAULT_DB_ALIAS, **kwargs): try: Site = apps.get_model('sites', 'Site') except LookupError: From 21f22f9544b0c6c4390bcd1acd98e6e5201ed83e Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 29 Dec 2013 20:43:10 +0100 Subject: [PATCH 109/208] Added Apps.clear_cache(). This avoid leaking implementation details to tests that swap models. --- django/apps/registry.py | 24 ++++++++++++++++-------- django/contrib/auth/tests/test_basic.py | 2 +- 2 files changed, 17 insertions(+), 9 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index 67cca2cfdf..a66e561566 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -84,7 +84,7 @@ class Apps(object): app_config = AppConfig.create(entry) self.app_configs[app_config.label] = app_config - self.get_models.cache_clear() + self.clear_cache() self._apps_loaded = True def populate_models(self): @@ -133,7 +133,7 @@ class Apps(object): del self._postponed - self.get_models.cache_clear() + self.clear_cache() self._models_loaded = True @property @@ -248,7 +248,7 @@ class Apps(object): "Conflicting '%s' models in application '%s': %s and %s." % (model_name, app_label, app_models[model_name], model)) app_models[model_name] = model - self.get_models.cache_clear() + self.clear_cache() def has_app(self, app_name): """ @@ -299,14 +299,14 @@ class Apps(object): (label, app_config) for label, app_config in self.app_configs.items() if app_config.name in available) - self.get_models.cache_clear() + self.clear_cache() def unset_available_apps(self): """ Cancels a previous call to set_available_apps(). """ self.app_configs = self.stored_app_configs.pop() - self.get_models.cache_clear() + self.clear_cache() def set_installed_apps(self, installed): """ @@ -327,7 +327,7 @@ class Apps(object): """ self.stored_app_configs.append((self.app_configs, self._apps_loaded, self._models_loaded)) self.app_configs = OrderedDict() - self.get_models.cache_clear() + self.clear_cache() self._apps_loaded = False self.populate_apps(installed) self._models_loaded = False @@ -338,7 +338,15 @@ class Apps(object): Cancels a previous call to set_installed_apps(). """ self.app_configs, self._apps_loaded, self._models_loaded = self.stored_app_configs.pop() - self.get_models.cache_clear() + self.clear_cache() + + def clear_cache(self): + """ + Clears all internal caches, for methods that alter the app registry. + + This is mostly used in tests. + """ + self.clear_cache() ### DEPRECATED METHODS GO BELOW THIS LINE ### @@ -353,7 +361,7 @@ class Apps(object): app_config = AppConfig.create(app_name) app_config.import_models(self.all_models[app_config.label]) self.app_configs[app_config.label] = app_config - self.get_models.cache_clear() + self.clear_cache() return app_config.models_module def app_cache_ready(self): diff --git a/django/contrib/auth/tests/test_basic.py b/django/contrib/auth/tests/test_basic.py index beaa97f285..0bcd2c47c2 100644 --- a/django/contrib/auth/tests/test_basic.py +++ b/django/contrib/auth/tests/test_basic.py @@ -26,7 +26,7 @@ def user_model_swapped(**kwargs): # Reset User manager setattr(User, 'objects', User._default_manager) ensure_default_manager(User) - apps.get_models.cache_clear() + apps.clear_cache() def mock_inputs(inputs): From d1eb362afb0a45f16ac9f1163dd467c361de2c8d Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 29 Dec 2013 20:45:25 +0100 Subject: [PATCH 110/208] Removed obsolete docstring. --- django/apps/registry.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index a66e561566..dfb7f09c91 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -1,5 +1,3 @@ -"Utilities for loading models and the modules that contain them." - from collections import defaultdict, OrderedDict import os import sys From 368d90e2616d3eb9746675e157688457e7ffcf96 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 29 Dec 2013 20:45:34 +0100 Subject: [PATCH 111/208] Removed unused import. --- django/core/management/commands/sqlsequencereset.py | 1 - 1 file changed, 1 deletion(-) diff --git a/django/core/management/commands/sqlsequencereset.py b/django/core/management/commands/sqlsequencereset.py index 65fee8183f..9d25125efb 100644 --- a/django/core/management/commands/sqlsequencereset.py +++ b/django/core/management/commands/sqlsequencereset.py @@ -2,7 +2,6 @@ from __future__ import unicode_literals from optparse import make_option -from django.apps import apps from django.core.management.base import AppCommand from django.db import connections, DEFAULT_DB_ALIAS From 8cfcd801c4b2e6402c1c814f64db99a5b7501170 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 29 Dec 2013 20:57:03 +0100 Subject: [PATCH 112/208] Fixed stupid error in 21f22f95. --- django/apps/registry.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index dfb7f09c91..d8265ce4d2 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -344,7 +344,7 @@ class Apps(object): This is mostly used in tests. """ - self.clear_cache() + self.get_models.cache_clear() ### DEPRECATED METHODS GO BELOW THIS LINE ### From 38ce41103fecf58418163b19403608988a291b56 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 29 Dec 2013 21:24:40 +0100 Subject: [PATCH 113/208] Used Apps.clear_cache() in tests that alter the app registry. --- tests/app_loading/tests.py | 2 +- tests/managers_regress/tests.py | 6 +++--- tests/migrations/test_commands.py | 2 +- tests/proxy_models/tests.py | 2 +- tests/runtests.py | 2 +- tests/tablespaces/tests.py | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/tests/app_loading/tests.py b/tests/app_loading/tests.py index fddf75f30e..5219b5315d 100644 --- a/tests/app_loading/tests.py +++ b/tests/app_loading/tests.py @@ -21,7 +21,7 @@ class EggLoadingTest(TestCase): def tearDown(self): apps.all_models['app_loading'] = self._old_models - apps.get_models.cache_clear() + apps.clear_cache() sys.path = self.old_path diff --git a/tests/managers_regress/tests.py b/tests/managers_regress/tests.py index 8e0b4cd017..0d24873a10 100644 --- a/tests/managers_regress/tests.py +++ b/tests/managers_regress/tests.py @@ -128,7 +128,7 @@ class ManagersRegressionTests(TestCase): finally: apps.app_configs['managers_regress'].models = _old_models apps.all_models['managers_regress'] = _old_models - apps.get_models.cache_clear() + apps.clear_cache() @override_settings(TEST_SWAPPABLE_MODEL='managers_regress.Parent') def test_custom_swappable_manager(self): @@ -156,7 +156,7 @@ class ManagersRegressionTests(TestCase): finally: apps.app_configs['managers_regress'].models = _old_models apps.all_models['managers_regress'] = _old_models - apps.get_models.cache_clear() + apps.clear_cache() @override_settings(TEST_SWAPPABLE_MODEL='managers_regress.Parent') def test_explicit_swappable_manager(self): @@ -184,7 +184,7 @@ class ManagersRegressionTests(TestCase): finally: apps.app_configs['managers_regress'].models = _old_models apps.all_models['managers_regress'] = _old_models - apps.get_models.cache_clear() + apps.clear_cache() def test_regress_3871(self): related = RelatedModel.objects.create() diff --git a/tests/migrations/test_commands.py b/tests/migrations/test_commands.py index 3219a62f5a..e53b26c638 100644 --- a/tests/migrations/test_commands.py +++ b/tests/migrations/test_commands.py @@ -136,7 +136,7 @@ class MakeMigrationsTests(MigrationTestBase): def tearDown(self): apps.app_configs['migrations'].models = self._old_models apps.all_models['migrations'] = self._old_models - apps.get_models.cache_clear() + apps.clear_cache() os.chdir(self.test_dir) try: diff --git a/tests/proxy_models/tests.py b/tests/proxy_models/tests.py index fe294aeb1e..0f2b5349be 100644 --- a/tests/proxy_models/tests.py +++ b/tests/proxy_models/tests.py @@ -175,7 +175,7 @@ class ProxyModelTests(TestCase): finally: apps.app_configs['proxy_models'].models = _old_models apps.all_models['proxy_models'] = _old_models - apps.get_models.cache_clear() + apps.clear_cache() def test_myperson_manager(self): Person.objects.create(name="fred") diff --git a/tests/runtests.py b/tests/runtests.py index 3998a7bf92..4c917fbbed 100755 --- a/tests/runtests.py +++ b/tests/runtests.py @@ -168,7 +168,7 @@ def setup(verbosity, test_labels): app_config = AppConfig.create(module_label) app_config.import_models(apps.all_models[app_config.label]) apps.app_configs[app_config.label] = app_config - apps.get_models.cache_clear() + apps.clear_cache() return state diff --git a/tests/tablespaces/tests.py b/tests/tablespaces/tests.py index 5e22608551..8c69e70a19 100644 --- a/tests/tablespaces/tests.py +++ b/tests/tablespaces/tests.py @@ -37,7 +37,7 @@ class TablespacesTests(TestCase): apps.app_configs['tablespaces'].models = self._old_models apps.all_models['tablespaces'] = self._old_models - apps.get_models.cache_clear() + apps.clear_cache() def assertNumContains(self, haystack, needle, count): real_count = haystack.count(needle) From 1d4bcb86eab521aa3f9dfc52e77d8a51448aa0f7 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 29 Dec 2013 21:11:12 +0100 Subject: [PATCH 114/208] Changed sql_* to use an app config instead of a models module. --- django/core/management/commands/sql.py | 2 +- django/core/management/commands/sqlall.py | 2 +- django/core/management/commands/sqlclear.py | 2 +- django/core/management/commands/sqlcustom.py | 2 +- .../management/commands/sqldropindexes.py | 2 +- django/core/management/commands/sqlindexes.py | 2 +- django/core/management/sql.py | 26 +++++++++---------- tests/commands_sql/tests.py | 24 ++++++++--------- 8 files changed, 31 insertions(+), 31 deletions(-) diff --git a/django/core/management/commands/sql.py b/django/core/management/commands/sql.py index b846cc7cd4..3fd081940d 100644 --- a/django/core/management/commands/sql.py +++ b/django/core/management/commands/sql.py @@ -22,5 +22,5 @@ class Command(AppCommand): if app_config.models_module is None: return connection = connections[options.get('database')] - statements = sql_create(app_config.models_module, self.style, connection) + statements = sql_create(app_config, self.style, connection) return '\n'.join(statements) diff --git a/django/core/management/commands/sqlall.py b/django/core/management/commands/sqlall.py index b4e65487f4..69746f1c3d 100644 --- a/django/core/management/commands/sqlall.py +++ b/django/core/management/commands/sqlall.py @@ -22,5 +22,5 @@ class Command(AppCommand): if app_config.models_module is None: return connection = connections[options.get('database')] - statements = sql_all(app_config.models_module, self.style, connection) + statements = sql_all(app_config, self.style, connection) return '\n'.join(statements) diff --git a/django/core/management/commands/sqlclear.py b/django/core/management/commands/sqlclear.py index 15efb7872b..e611390533 100644 --- a/django/core/management/commands/sqlclear.py +++ b/django/core/management/commands/sqlclear.py @@ -22,5 +22,5 @@ class Command(AppCommand): if app_config.models_module is None: return connection = connections[options.get('database')] - statements = sql_delete(app_config.models_module, self.style, connection) + statements = sql_delete(app_config, self.style, connection) return '\n'.join(statements) diff --git a/django/core/management/commands/sqlcustom.py b/django/core/management/commands/sqlcustom.py index 0988654816..bfc6f395d4 100644 --- a/django/core/management/commands/sqlcustom.py +++ b/django/core/management/commands/sqlcustom.py @@ -22,5 +22,5 @@ class Command(AppCommand): if app_config.models_module is None: return connection = connections[options.get('database')] - statements = sql_custom(app_config.models_module, self.style, connection) + statements = sql_custom(app_config, self.style, connection) return '\n'.join(statements) diff --git a/django/core/management/commands/sqldropindexes.py b/django/core/management/commands/sqldropindexes.py index ac8469c700..4bdb42d608 100644 --- a/django/core/management/commands/sqldropindexes.py +++ b/django/core/management/commands/sqldropindexes.py @@ -23,5 +23,5 @@ class Command(AppCommand): if app_config.models_module is None: return connection = connections[options.get('database')] - statements = sql_destroy_indexes(app_config.models_module, self.style, connection) + statements = sql_destroy_indexes(app_config, self.style, connection) return '\n'.join(statements) diff --git a/django/core/management/commands/sqlindexes.py b/django/core/management/commands/sqlindexes.py index 0ff1ab3914..2f1fd8d103 100644 --- a/django/core/management/commands/sqlindexes.py +++ b/django/core/management/commands/sqlindexes.py @@ -23,5 +23,5 @@ class Command(AppCommand): if app_config.models_module is None: return connection = connections[options.get('database')] - statements = sql_indexes(app_config.models_module, self.style, connection) + statements = sql_indexes(app_config, self.style, connection) return '\n'.join(statements) diff --git a/django/core/management/sql.py b/django/core/management/sql.py index 40becd34d7..6f98282a9c 100644 --- a/django/core/management/sql.py +++ b/django/core/management/sql.py @@ -11,7 +11,7 @@ from django.core.management.base import CommandError from django.db import models, router -def sql_create(app, style, connection): +def sql_create(app_config, style, connection): "Returns a list of the CREATE TABLE SQL statements for the given app." if connection.settings_dict['ENGINE'] == 'django.db.backends.dummy': @@ -25,13 +25,13 @@ def sql_create(app, style, connection): # We trim models from the current app so that the sqlreset command does not # generate invalid SQL (leaving models out of known_models is harmless, so # we can be conservative). - app_models = apps.get_models(app, include_auto_created=True) + app_models = app_config.get_models(include_auto_created=True) final_output = [] tables = connection.introspection.table_names() known_models = set(model for model in connection.introspection.installed_models(tables) if model not in app_models) pending_references = {} - for model in router.get_migratable_models(app, connection.alias, include_auto_created=True): + for model in router.get_migratable_models(app_config.models_module, connection.alias, include_auto_created=True): output, references = connection.creation.sql_create_model(model, style, known_models) final_output.extend(output) for refto, refs in references.items(): @@ -57,7 +57,7 @@ def sql_create(app, style, connection): return final_output -def sql_delete(app, style, connection): +def sql_delete(app_config, style, connection): "Returns a list of the DROP TABLE SQL statements for the given app." # This should work even if a connection isn't available @@ -78,7 +78,7 @@ def sql_delete(app, style, connection): to_delete = set() references_to_delete = {} - app_models = router.get_migratable_models(app, connection.alias, include_auto_created=True) + app_models = router.get_migratable_models(app_config.models_module, connection.alias, include_auto_created=True) for model in app_models: if cursor and connection.introspection.table_name_converter(model._meta.db_table) in table_names: # The table exists, so it needs to be dropped @@ -118,11 +118,11 @@ def sql_flush(style, connection, only_django=False, reset_sequences=True, allow_ return statements -def sql_custom(app, style, connection): +def sql_custom(app_config, style, connection): "Returns a list of the custom table modifying SQL statements for the given app." output = [] - app_models = router.get_migratable_models(app, connection.alias) + app_models = router.get_migratable_models(app_config.models_module, connection.alias) for model in app_models: output.extend(custom_sql_for_model(model, style, connection)) @@ -130,25 +130,25 @@ def sql_custom(app, style, connection): return output -def sql_indexes(app, style, connection): +def sql_indexes(app_config, style, connection): "Returns a list of the CREATE INDEX SQL statements for all models in the given app." output = [] - for model in router.get_migratable_models(app, connection.alias, include_auto_created=True): + for model in router.get_migratable_models(app_config.models_module, connection.alias, include_auto_created=True): output.extend(connection.creation.sql_indexes_for_model(model, style)) return output -def sql_destroy_indexes(app, style, connection): +def sql_destroy_indexes(app_config, style, connection): "Returns a list of the DROP INDEX SQL statements for all models in the given app." output = [] - for model in router.get_migratable_models(app, connection.alias, include_auto_created=True): + for model in router.get_migratable_models(app_config.models_module, connection.alias, include_auto_created=True): output.extend(connection.creation.sql_destroy_indexes_for_model(model, style)) return output -def sql_all(app, style, connection): +def sql_all(app_config, style, connection): "Returns a list of CREATE TABLE SQL, initial-data inserts, and CREATE INDEX SQL for the given module." - return sql_create(app, style, connection) + sql_custom(app, style, connection) + sql_indexes(app, style, connection) + return sql_create(app_config, style, connection) + sql_custom(app_config, style, connection) + sql_indexes(app_config, style, connection) def _split_statements(content): diff --git a/tests/commands_sql/tests.py b/tests/commands_sql/tests.py index 00f4017b9c..7ef28f83db 100644 --- a/tests/commands_sql/tests.py +++ b/tests/commands_sql/tests.py @@ -17,8 +17,8 @@ class SQLCommandsTestCase(TestCase): return len([o for o in output if o.startswith(cmd)]) def test_sql_create(self): - app = apps.get_app_config('commands_sql').models_module - output = sql_create(app, no_style(), connections[DEFAULT_DB_ALIAS]) + app_config = apps.get_app_config('commands_sql') + output = sql_create(app_config, no_style(), connections[DEFAULT_DB_ALIAS]) create_tables = [o for o in output if o.startswith('CREATE TABLE')] self.assertEqual(len(create_tables), 3) # Lower so that Oracle's upper case tbl names wont break @@ -26,8 +26,8 @@ class SQLCommandsTestCase(TestCase): six.assertRegex(self, sql, r'^create table .commands_sql_book.*') def test_sql_delete(self): - app = apps.get_app_config('commands_sql').models_module - output = sql_delete(app, no_style(), connections[DEFAULT_DB_ALIAS]) + app_config = apps.get_app_config('commands_sql') + output = sql_delete(app_config, no_style(), connections[DEFAULT_DB_ALIAS]) drop_tables = [o for o in output if o.startswith('DROP TABLE')] self.assertEqual(len(drop_tables), 3) # Lower so that Oracle's upper case tbl names wont break @@ -35,20 +35,20 @@ class SQLCommandsTestCase(TestCase): six.assertRegex(self, sql, r'^drop table .commands_sql_comment.*') def test_sql_indexes(self): - app = apps.get_app_config('commands_sql').models_module - output = sql_indexes(app, no_style(), connections[DEFAULT_DB_ALIAS]) + app_config = apps.get_app_config('commands_sql') + output = sql_indexes(app_config, no_style(), connections[DEFAULT_DB_ALIAS]) # PostgreSQL creates one additional index for CharField self.assertIn(self.count_ddl(output, 'CREATE INDEX'), [3, 4]) def test_sql_destroy_indexes(self): - app = apps.get_app_config('commands_sql').models_module - output = sql_destroy_indexes(app, no_style(), connections[DEFAULT_DB_ALIAS]) + app_config = apps.get_app_config('commands_sql') + output = sql_destroy_indexes(app_config, no_style(), connections[DEFAULT_DB_ALIAS]) # PostgreSQL creates one additional index for CharField self.assertIn(self.count_ddl(output, 'DROP INDEX'), [3, 4]) def test_sql_all(self): - app = apps.get_app_config('commands_sql').models_module - output = sql_all(app, no_style(), connections[DEFAULT_DB_ALIAS]) + app_config = apps.get_app_config('commands_sql') + output = sql_all(app_config, no_style(), connections[DEFAULT_DB_ALIAS]) self.assertEqual(self.count_ddl(output, 'CREATE TABLE'), 3) # PostgreSQL creates one additional index for CharField @@ -69,8 +69,8 @@ class SQLCommandsRouterTestCase(TestCase): router.routers = self._old_routers def test_router_honored(self): - app = apps.get_app_config('commands_sql').models_module + app_config = apps.get_app_config('commands_sql') for sql_command in (sql_all, sql_create, sql_delete, sql_indexes, sql_destroy_indexes): - output = sql_command(app, no_style(), connections[DEFAULT_DB_ALIAS]) + output = sql_command(app_config, no_style(), connections[DEFAULT_DB_ALIAS]) self.assertEqual(len(output), 0, "%s command is not honoring routers" % sql_command.__name__) From 856aaaf2b15228bd5babbe44654c3c1ca39e8fd7 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 29 Dec 2013 21:21:23 +0100 Subject: [PATCH 115/208] Changed get_migratable_models to use an app config. --- django/core/management/commands/flush.py | 2 +- django/core/management/commands/migrate.py | 2 +- django/core/management/sql.py | 10 +++++----- django/db/backends/__init__.py | 6 +++--- django/db/utils.py | 7 +++---- 5 files changed, 13 insertions(+), 14 deletions(-) diff --git a/django/core/management/commands/flush.py b/django/core/management/commands/flush.py index 619df9536c..5b4733ecad 100644 --- a/django/core/management/commands/flush.py +++ b/django/core/management/commands/flush.py @@ -94,5 +94,5 @@ Are you sure you want to do this? # respond as if the database had been migrated from scratch. all_models = [] for app_config in apps.get_app_configs(only_with_models_module=True): - all_models.extend(router.get_migratable_models(app_config.models_module, database, include_auto_created=True)) + all_models.extend(router.get_migratable_models(app_config, database, include_auto_created=True)) emit_post_migrate_signal(set(all_models), verbosity, interactive, database) diff --git a/django/core/management/commands/migrate.py b/django/core/management/commands/migrate.py index d7daafd279..5da5e51a48 100644 --- a/django/core/management/commands/migrate.py +++ b/django/core/management/commands/migrate.py @@ -180,7 +180,7 @@ class Command(BaseCommand): # Build the manifest of apps and models that are to be synchronized all_models = [ (app_config.label, - router.get_migratable_models(app_config.models_module, connection.alias, include_auto_created=True)) + router.get_migratable_models(app_config, connection.alias, include_auto_created=True)) for app_config in apps.get_app_configs(only_with_models_module=True) if app_config.label in app_labels ] diff --git a/django/core/management/sql.py b/django/core/management/sql.py index 6f98282a9c..4cced4f566 100644 --- a/django/core/management/sql.py +++ b/django/core/management/sql.py @@ -31,7 +31,7 @@ def sql_create(app_config, style, connection): known_models = set(model for model in connection.introspection.installed_models(tables) if model not in app_models) pending_references = {} - for model in router.get_migratable_models(app_config.models_module, connection.alias, include_auto_created=True): + for model in router.get_migratable_models(app_config, connection.alias, include_auto_created=True): output, references = connection.creation.sql_create_model(model, style, known_models) final_output.extend(output) for refto, refs in references.items(): @@ -78,7 +78,7 @@ def sql_delete(app_config, style, connection): to_delete = set() references_to_delete = {} - app_models = router.get_migratable_models(app_config.models_module, connection.alias, include_auto_created=True) + app_models = router.get_migratable_models(app_config, connection.alias, include_auto_created=True) for model in app_models: if cursor and connection.introspection.table_name_converter(model._meta.db_table) in table_names: # The table exists, so it needs to be dropped @@ -122,7 +122,7 @@ def sql_custom(app_config, style, connection): "Returns a list of the custom table modifying SQL statements for the given app." output = [] - app_models = router.get_migratable_models(app_config.models_module, connection.alias) + app_models = router.get_migratable_models(app_config, connection.alias) for model in app_models: output.extend(custom_sql_for_model(model, style, connection)) @@ -133,7 +133,7 @@ def sql_custom(app_config, style, connection): def sql_indexes(app_config, style, connection): "Returns a list of the CREATE INDEX SQL statements for all models in the given app." output = [] - for model in router.get_migratable_models(app_config.models_module, connection.alias, include_auto_created=True): + for model in router.get_migratable_models(app_config, connection.alias, include_auto_created=True): output.extend(connection.creation.sql_indexes_for_model(model, style)) return output @@ -141,7 +141,7 @@ def sql_indexes(app_config, style, connection): def sql_destroy_indexes(app_config, style, connection): "Returns a list of the DROP INDEX SQL statements for all models in the given app." output = [] - for model in router.get_migratable_models(app_config.models_module, connection.alias, include_auto_created=True): + for model in router.get_migratable_models(app_config, connection.alias, include_auto_created=True): output.extend(connection.creation.sql_destroy_indexes_for_model(model, style)) return output diff --git a/django/db/backends/__init__.py b/django/db/backends/__init__.py index c5f650d503..5b681756e9 100644 --- a/django/db/backends/__init__.py +++ b/django/db/backends/__init__.py @@ -1272,7 +1272,7 @@ class BaseDatabaseIntrospection(object): from django.db import router tables = set() for app_config in apps.get_app_configs(only_with_models_module=True): - for model in router.get_migratable_models(app_config.models_module, self.connection.alias): + for model in router.get_migratable_models(app_config, self.connection.alias): if not model._meta.managed: continue tables.add(model._meta.db_table) @@ -1293,7 +1293,7 @@ class BaseDatabaseIntrospection(object): from django.db import router all_models = [] for app_config in apps.get_app_configs(only_with_models_module=True): - all_models.extend(router.get_migratable_models(app_config.models_module, self.connection.alias)) + all_models.extend(router.get_migratable_models(app_config, self.connection.alias)) tables = list(map(self.table_name_converter, tables)) return set([ m for m in all_models @@ -1308,7 +1308,7 @@ class BaseDatabaseIntrospection(object): sequence_list = [] for app_config in apps.get_app_configs(only_with_models_module=True): - for model in router.get_migratable_models(app_config.models_module, self.connection.alias): + for model in router.get_migratable_models(app_config, self.connection.alias): if not model._meta.managed: continue if model._meta.swapped: diff --git a/django/db/utils.py b/django/db/utils.py index 85eabb934e..0bcf33f252 100644 --- a/django/db/utils.py +++ b/django/db/utils.py @@ -278,10 +278,9 @@ class ConnectionRouter(object): return allow return True - def get_migratable_models(self, app, db, include_auto_created=False): + def get_migratable_models(self, app_config, db, include_auto_created=False): """ Return app models allowed to be synchronized on provided db. """ - from django.apps import apps - return [model for model in apps.get_models(app, include_auto_created=include_auto_created) - if self.allow_migrate(db, model)] + models = app_config.get_models(include_auto_created=include_auto_created) + return [model for model in models if self.allow_migrate(db, model)] From e5bcd1d455cd11d3892adf6717a51ae04169f705 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 29 Dec 2013 21:46:26 +0100 Subject: [PATCH 116/208] Changed get_validation_errors to use an app config. --- django/contrib/auth/tests/test_management.py | 6 +++--- django/core/management/base.py | 10 +++++----- django/core/management/validation.py | 4 ++-- tests/invalid_models_tests/tests.py | 6 +++--- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/django/contrib/auth/tests/test_management.py b/django/contrib/auth/tests/test_management.py index c60346c2ac..8a591fc7a9 100644 --- a/django/contrib/auth/tests/test_management.py +++ b/django/contrib/auth/tests/test_management.py @@ -196,21 +196,21 @@ class CustomUserModelValidationTestCase(TestCase): def test_required_fields_is_list(self): "REQUIRED_FIELDS should be a list." new_io = StringIO() - get_validation_errors(new_io, apps.get_app_config('auth').models_module) + get_validation_errors(new_io, apps.get_app_config('auth')) self.assertIn("The REQUIRED_FIELDS must be a list or tuple.", new_io.getvalue()) @override_settings(AUTH_USER_MODEL='auth.CustomUserBadRequiredFields') def test_username_not_in_required_fields(self): "USERNAME_FIELD should not appear in REQUIRED_FIELDS." new_io = StringIO() - get_validation_errors(new_io, apps.get_app_config('auth').models_module) + get_validation_errors(new_io, apps.get_app_config('auth')) self.assertIn("The field named as the USERNAME_FIELD should not be included in REQUIRED_FIELDS on a swappable User model.", new_io.getvalue()) @override_settings(AUTH_USER_MODEL='auth.CustomUserNonUniqueUsername') def test_username_non_unique(self): "A non-unique USERNAME_FIELD should raise a model validation error." new_io = StringIO() - get_validation_errors(new_io, apps.get_app_config('auth').models_module) + get_validation_errors(new_io, apps.get_app_config('auth')) self.assertIn("The USERNAME_FIELD must be unique. Add unique=True to the field parameters.", new_io.getvalue()) diff --git a/django/core/management/base.py b/django/core/management/base.py index 59224049d2..413592a8f3 100644 --- a/django/core/management/base.py +++ b/django/core/management/base.py @@ -141,8 +141,8 @@ class BaseCommand(object): performed prior to executing the command. Default value is ``True``. To validate an individual application's models rather than all applications' models, call - ``self.validate(app)`` from ``handle()``, where ``app`` is the - application's Python module. + ``self.validate(app_config)`` from ``handle()``, where ``app_config`` + is the application's configuration provided by the app registry. ``leave_locale_alone`` A boolean indicating whether the locale set in settings should be @@ -304,16 +304,16 @@ class BaseCommand(object): if saved_locale is not None: translation.activate(saved_locale) - def validate(self, app=None, display_num_errors=False): + def validate(self, app_config=None, display_num_errors=False): """ Validates the given app, raising CommandError for any errors. - If app is None, then this will validate all installed apps. + If app_config is None, then this will validate all installed apps. """ from django.core.management.validation import get_validation_errors s = StringIO() - num_errors = get_validation_errors(s, app) + num_errors = get_validation_errors(s, app_config) if num_errors: s.seek(0) error_text = s.read() diff --git a/django/core/management/validation.py b/django/core/management/validation.py index 0af92bb5b7..e5eee65fef 100644 --- a/django/core/management/validation.py +++ b/django/core/management/validation.py @@ -20,7 +20,7 @@ class ModelErrorCollection: self.outfile.write(self.style.ERROR(force_str("%s: %s\n" % (context, error)))) -def get_validation_errors(outfile, app=None): +def get_validation_errors(outfile, app_config=None): """ Validates all models that are part of the specified app. If no app name is provided, validates all models of all installed apps. Writes errors, if any, to outfile. @@ -32,7 +32,7 @@ def get_validation_errors(outfile, app=None): e = ModelErrorCollection(outfile) - for cls in apps.get_models(app, include_swapped=True): + for cls in (app_config or apps).get_models(include_swapped=True): opts = cls._meta # Check swappable attribute. diff --git a/tests/invalid_models_tests/tests.py b/tests/invalid_models_tests/tests.py index 2c98f39807..08cea2e15f 100644 --- a/tests/invalid_models_tests/tests.py +++ b/tests/invalid_models_tests/tests.py @@ -32,13 +32,13 @@ class InvalidModelTestCase(unittest.TestCase): TEST_SWAPPED_MODEL_BAD_MODEL='not_an_app.Target', ) def test_invalid_models(self): - module = apps.get_app_config("invalid_models").models_module - get_validation_errors(self.stdout, module) + app_config = apps.get_app_config("invalid_models") + get_validation_errors(self.stdout, app_config) self.stdout.seek(0) error_log = self.stdout.read() actual = error_log.split('\n') - expected = module.model_errors.split('\n') + expected = app_config.models_module.model_errors.split('\n') unexpected = [err for err in actual if err not in expected] missing = [err for err in expected if err not in actual] From 34a215d5066f8ae0629070916714801b0ea03eab Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 29 Dec 2013 21:47:55 +0100 Subject: [PATCH 117/208] Deprecated the app argument of apps.get_models. Use app_config.get_models() instead. --- django/apps/registry.py | 47 ++++++++++++++++-------------------- docs/releases/1.7.txt | 5 ++-- tests/app_loading/tests.py | 3 --- tests/apps/tests.py | 7 ++---- tests/defer_regress/tests.py | 34 +++++++------------------- 5 files changed, 35 insertions(+), 61 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index d8265ce4d2..5dbb4696d7 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -187,40 +187,35 @@ class Apps(object): def get_models(self, app_mod=None, include_auto_created=False, include_deferred=False, include_swapped=False): """ - Given a module containing models, returns a list of the models. - Otherwise returns a list of all installed models. + Returns a list of all installed models. - By default, auto-created models (i.e., m2m models without an - explicit intermediate table) are not included. However, if you - specify include_auto_created=True, they will be. + By default, the following models aren't included: - By default, models created to satisfy deferred attribute - queries are *not* included in the list of models. However, if - you specify include_deferred, they will be. + - auto-created models for many-to-many relations without + an explicit intermediate table, + - models created to satisfy deferred attribute queries, + - models that have been swapped out. - By default, models that have been swapped out will *not* be - included in the list of models. However, if you specify - include_swapped, they will be. + Set the corresponding keyword argument to True to include such models. """ - model_list = None self.populate_models() + if app_mod: + warnings.warn( + "The app_mod argument of get_models is deprecated.", + PendingDeprecationWarning, stacklevel=2) app_label = app_mod.__name__.split('.')[-2] try: - model_dicts = [self.app_configs[app_label].models] - except KeyError: - model_dicts = [] - else: - model_dicts = [app_config.models for app_config in self.app_configs.values()] - model_list = [] - for model_dict in model_dicts: - model_list.extend( - model for model in model_dict.values() - if ((not model._deferred or include_deferred) and - (not model._meta.auto_created or include_auto_created) and - (not model._meta.swapped or include_swapped)) - ) - return model_list + return list(self.get_app_config(app_label).get_models( + include_auto_created, include_deferred, include_swapped)) + except LookupError: + return [] + + result = [] + for app_config in self.app_configs.values(): + result.extend(list(app_config.get_models( + include_auto_created, include_deferred, include_swapped))) + return result def get_model(self, app_label, model_name): """ diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 5416d9dc0b..b4ee180c73 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -615,8 +615,9 @@ setting directly and use the app registry (:attr:`django.apps.apps`) instead. The "app registry" that manages the list of installed applications doesn't have the same features as the old "app cache". Even though the "app cache" was -a private API, obsolete methods will be removed after a standard deprecation -period. In addition, the following changes take effect immediately: +a private API, obsolete methods and arguments will be removed after a standard +deprecation period. In addition, the following changes take effect +immediately: * ``get_model`` raises :exc:`~exceptions.LookupError` instead of returning ``None`` when no model is found. diff --git a/tests/app_loading/tests.py b/tests/app_loading/tests.py index 5219b5315d..46c5955c53 100644 --- a/tests/app_loading/tests.py +++ b/tests/app_loading/tests.py @@ -79,6 +79,3 @@ class GetModelsTest(TestCase): self.assertNotIn( "NotInstalledModel", [m.__name__ for m in apps.get_models()]) - - def test_get_models_with_app_label_only_returns_installed_models(self): - self.assertEqual(apps.get_models(self.not_installed_module), []) diff --git a/tests/apps/tests.py b/tests/apps/tests.py index 4cd35c38cf..a75ae94a75 100644 --- a/tests/apps/tests.py +++ b/tests/apps/tests.py @@ -159,7 +159,7 @@ class AppsTests(TestCase): """ Makes a new model at runtime and ensures it goes into the right place. """ - old_models = apps.get_models(apps.get_app_config("apps").models_module) + old_models = list(apps.get_app_config("apps").get_models()) # Construct a new model in a new app registry body = {} new_apps = Apps() @@ -172,10 +172,7 @@ class AppsTests(TestCase): body['__module__'] = TotallyNormal.__module__ temp_model = type(str("SouthPonies"), (models.Model,), body) # Make sure it appeared in the right place! - self.assertEqual( - old_models, - apps.get_models(apps.get_app_config("apps").models_module), - ) + self.assertListEqual(list(apps.get_app_config("apps").get_models()), old_models) with self.assertRaises(LookupError): apps.get_model("apps", "SouthPonies") self.assertEqual(new_apps.get_model("apps", "SouthPonies"), temp_model) diff --git a/tests/defer_regress/tests.py b/tests/defer_regress/tests.py index 22c2d281da..97d7e7e302 100644 --- a/tests/defer_regress/tests.py +++ b/tests/defer_regress/tests.py @@ -92,42 +92,26 @@ class DeferRegressionTest(TestCase): list) def test_ticket_11936(self): - # Regression for #11936 - loading.get_models should not return deferred - # models by default. - # Run a couple of defer queries so that app-cache must contain some - # deferred classes. It might contain a lot more classes depending on - # the order the tests are ran. + app_config = apps.get_app_config("defer_regress") + # Regression for #11936 - get_models should not return deferred models + # by default. Run a couple of defer queries so that app registry must + # contain some deferred classes. It might contain a lot more classes + # depending on the order the tests are ran. list(Item.objects.defer("name")) list(Child.objects.defer("value")) - klasses = set( - map( - attrgetter("__name__"), - apps.get_models(apps.get_app_config("defer_regress").models_module) - ) - ) + klasses = {model.__name__ for model in app_config.get_models()} self.assertIn("Child", klasses) self.assertIn("Item", klasses) self.assertNotIn("Child_Deferred_value", klasses) self.assertNotIn("Item_Deferred_name", klasses) - self.assertFalse(any( - k._deferred for k in apps.get_models(apps.get_app_config("defer_regress").models_module))) + self.assertFalse(any(k._deferred for k in app_config.get_models())) - klasses_with_deferred = set( - map( - attrgetter("__name__"), - apps.get_models( - apps.get_app_config("defer_regress").models_module, include_deferred=True - ), - ) - ) + klasses_with_deferred = {model.__name__ for model in app_config.get_models(include_deferred=True)} self.assertIn("Child", klasses_with_deferred) self.assertIn("Item", klasses_with_deferred) self.assertIn("Child_Deferred_value", klasses_with_deferred) self.assertIn("Item_Deferred_name", klasses_with_deferred) - self.assertTrue(any( - k._deferred for k in apps.get_models( - apps.get_app_config("defer_regress").models_module, include_deferred=True)) - ) + self.assertTrue(any(k._deferred for k in app_config.get_models(include_deferred=True))) @override_settings(SESSION_SERIALIZER='django.contrib.sessions.serializers.PickleSerializer') def test_ticket_12163(self): From 5892a83b1827a2724725f95b0ed92d2a05a11304 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 29 Dec 2013 21:35:49 +0100 Subject: [PATCH 118/208] Stopped calling get_models() for a side effect. --- django/core/management/commands/shell.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/django/core/management/commands/shell.py b/django/core/management/commands/shell.py index 149b9edd89..eea233bcff 100644 --- a/django/core/management/commands/shell.py +++ b/django/core/management/commands/shell.py @@ -67,7 +67,7 @@ class Command(NoArgsCommand): # XXX: (Temporary) workaround for ticket #1796: force early loading of all # models from installed apps. from django.apps import apps - apps.get_models() + apps.populate_models() use_plain = options.get('plain', False) no_startup = options.get('no_startup', False) From 7d7b27d2b1256787849c9e3902d7aa26ac71685b Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 29 Dec 2013 22:35:37 +0100 Subject: [PATCH 119/208] Converted links to HTTPS and linked to stable docs. --- README.rst | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index ca2cd5e5a9..95029a6fce 100644 --- a/README.rst +++ b/README.rst @@ -2,8 +2,8 @@ Django is a high-level Python Web framework that encourages rapid development and clean, pragmatic design. Thanks for checking it out. All documentation is in the "docs" directory and online at -http://docs.djangoproject.com/en/dev/. If you're just getting started, here's -how we recommend you read the docs: +https://docs.djangoproject.com/en/stable/. If you're just getting started, +here's how we recommend you read the docs: * First, read docs/intro/install.txt for instructions on installing Django. @@ -19,11 +19,9 @@ how we recommend you read the docs: * See docs/README for instructions on building an HTML version of the docs. -Docs are updated rigorously. If you find any problems in the docs, or think they -should be clarified in any way, please take 30 seconds to fill out a ticket -here: - -http://code.djangoproject.com/newticket +Docs are updated rigorously. If you find any problems in the docs, or think +they should be clarified in any way, please take 30 seconds to fill out a +ticket here: https://code.djangoproject.com/newticket To get more help: @@ -31,11 +29,11 @@ To get more help: there. Read the archives at http://django-irc-logs.com/. * Join the django-users mailing list, or read the archives, at - http://groups.google.com/group/django-users. + https://groups.google.com/group/django-users. To contribute to Django: -* Check out http://www.djangoproject.com/community/ for information about +* Check out https://www.djangoproject.com/community/ for information about getting involved. To run Django's test suite: From 99649ddcb21b5c07258569d4585ffe3cf9eb4f38 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 30 Dec 2013 18:15:49 +0100 Subject: [PATCH 120/208] Assumed Python 3 throughout docs/intro. Various small fixes while I was proof-reading. --- docs/intro/contributing.txt | 5 +-- docs/intro/index.txt | 10 ++--- docs/intro/install.txt | 8 ++-- docs/intro/overview.txt | 23 ++++++----- docs/intro/reusable-apps.txt | 7 ++-- docs/intro/tutorial01.txt | 74 ++++++++++++++++-------------------- docs/topics/install.txt | 4 +- 7 files changed, 58 insertions(+), 73 deletions(-) diff --git a/docs/intro/contributing.txt b/docs/intro/contributing.txt index 8f41b71056..8a16a9b0d0 100644 --- a/docs/intro/contributing.txt +++ b/docs/intro/contributing.txt @@ -20,8 +20,8 @@ For this tutorial, we expect that you have at least a basic understanding of how Django works. This means you should be comfortable going through the existing tutorials on :doc:`writing your first Django app`. In addition, you should have a good understanding of Python itself. But if you -don't, "Dive Into Python" (for `Python 2`__, for `Python 3`__) is a fantastic -(and free) online book for beginning Python programmers. +don't, `Dive Into Python`__ is a fantastic (and free) online book for +beginning Python programmers. Those of you who are unfamiliar with version control systems and Trac will find that this tutorial and its links include just enough information to get started. @@ -37,7 +37,6 @@ so that it can be of use to the widest audience. to |django-developers| or drop by `#django-dev on irc.freenode.net`__ to chat with other Django users who might be able to help. -__ http://diveintopython.net/toc/index.html __ http://diveintopython3.net/ __ irc://irc.freenode.net/django-dev diff --git a/docs/intro/index.txt b/docs/intro/index.txt index a7872017b9..18664ef053 100644 --- a/docs/intro/index.txt +++ b/docs/intro/index.txt @@ -29,14 +29,10 @@ place: read this material to quickly get up and running. `list of Python resources for non-programmers`_ If you already know a few other languages and want to get up to speed with - Python quickly, we recommend "Dive Into Python" (for `Python 2`_, for - `Python 3`_, also available in a - `dead-tree version`_). If that's not quite your style, there are quite - a few other `books about Python`_. + Python quickly, we recommend `Dive Into Python`_. If that's not quite your + style, there are many other `books about Python`_. .. _python: http://python.org/ .. _list of Python resources for non-programmers: https://wiki.python.org/moin/BeginnersGuide/NonProgrammers - .. _Python 2: http://diveintopython.net/ - .. _Python 3: http://diveintopython3.net/ - .. _dead-tree version: http://www.amazon.com/exec/obidos/ASIN/1590593561/ref=nosim/jacobian20 + .. _Dive Into Python: http://diveintopython3.net/ .. _books about Python: https://wiki.python.org/moin/PythonBooks diff --git a/docs/intro/install.txt b/docs/intro/install.txt index 3ef59dcafb..1d58b5dc3f 100644 --- a/docs/intro/install.txt +++ b/docs/intro/install.txt @@ -15,8 +15,8 @@ SQLite_ so you won't need to set up a database just yet. .. _sqlite: http://sqlite.org/ -Get Python at http://www.python.org. If you're running Linux or Mac OS X, you -probably already have it installed. +Get the latest version of Python at http://www.python.org/download/ or with +your operating system's package manager. .. admonition:: Django on Jython @@ -28,8 +28,8 @@ probably already have it installed. You can verify that Python is installed by typing ``python`` from your shell; you should see something like:: - Python 2.7.3 (default, Jan 2 2013, 13:56:14) - [GCC 4.7.2] on linux2 + Python 3.3.3 (default, Nov 26 2013, 13:33:18) + [GCC 4.8.2] on linux Type "help", "copyright", "credits" or "license" for more information. >>> diff --git a/docs/intro/overview.txt b/docs/intro/overview.txt index 2a1b979a20..6ec3baf0ec 100644 --- a/docs/intro/overview.txt +++ b/docs/intro/overview.txt @@ -22,7 +22,7 @@ code. .. _object-relational mapper: http://en.wikipedia.org/wiki/Object-relational_mapping The :doc:`data-model syntax ` offers many rich ways of -representing your models -- so far, it's been solving two years' worth of +representing your models -- so far, it's been solving many years' worth of database-schema problems. Here's a quick example, which might be saved in the file ``mysite/news/models.py``:: @@ -31,8 +31,7 @@ the file ``mysite/news/models.py``:: class Reporter(models.Model): full_name = models.CharField(max_length=70) - # On Python 3: def __str__(self): - def __unicode__(self): + def __str__(self): # __unicode__ on Python 2 return self.full_name class Article(models.Model): @@ -41,8 +40,7 @@ the file ``mysite/news/models.py``:: content = models.TextField() reporter = models.ForeignKey(Reporter) - # On Python 3: def __str__(self): - def __unicode__(self): + def __str__(self): # __unicode__ on Python 2 return self.headline Install it @@ -127,7 +125,7 @@ necessary: # The API follows relationships as far as you need, performing efficient # JOINs for you behind the scenes. # This finds all articles by a reporter whose name starts with "John". - >>> Article.objects.filter(reporter__full_name__startswith="John") + >>> Article.objects.filter(reporter__full_name__startswith='John') [] # Change an object by altering its attributes and calling save(). @@ -224,11 +222,12 @@ Generally, a view retrieves data according to the parameters, loads a template and renders the template with the retrieved data. Here's an example view for ``year_archive`` from above:: - from django.shortcuts import render_to_response + from django.shortcuts import render def year_archive(request, year): a_list = Article.objects.filter(pub_date__year=year) - return render_to_response('news/year_archive.html', {'year': year, 'article_list': a_list}) + context = {'year': year, 'article_list': a_list} + return render(request, 'news/year_archive.html', context) This example uses Django's :doc:`template system `, which has several powerful features but strives to stay simple enough for non-programmers @@ -265,7 +264,7 @@ might look like: Variables are surrounded by double-curly braces. ``{{ article.headline }}`` means "Output the value of the article's headline attribute." But dots aren't -used only for attribute lookup: They also can do dictionary-key lookup, index +used only for attribute lookup. They also can do dictionary-key lookup, index lookup and function calls. Note ``{{ article.pub_date|date:"F j, Y" }}`` uses a Unix-style "pipe" (the "|" @@ -278,7 +277,7 @@ template filters `. You can write :doc:`custom template tags `, which run custom Python code behind the scenes. -Finally, Django uses the concept of "template inheritance": That's what the +Finally, Django uses the concept of "template inheritance". That's what the ``{% extends "base.html" %}`` does. It means "First load the template called 'base', which has defined a bunch of blocks, and fill the blocks with the following blocks." In short, that lets you dramatically cut down on redundancy @@ -306,8 +305,8 @@ easy as changing a single file -- the base template. It also lets you create multiple versions of a site, with different base templates, while reusing child templates. Django's creators have used this -technique to create strikingly different cell-phone editions of sites -- simply -by creating a new base template. +technique to create strikingly different mobile versions of sites -- simply by +creating a new base template. Note that you don't have to use Django's template system if you prefer another system. While Django's template system is particularly well-integrated with diff --git a/docs/intro/reusable-apps.txt b/docs/intro/reusable-apps.txt index 4c6e2173db..7f1d984d1f 100644 --- a/docs/intro/reusable-apps.txt +++ b/docs/intro/reusable-apps.txt @@ -215,9 +215,10 @@ this. For a small app like polls, this process isn't too difficult. 'License :: OSI Approved :: BSD License', # example license 'Operating System :: OS Independent', 'Programming Language :: Python', - # replace these appropriately if you are using Python 3 - 'Programming Language :: Python :: 2', - 'Programming Language :: Python :: 2.7', + # Replace these appropriately if you are stuck on Python 2. + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.2', + 'Programming Language :: Python :: 3.3', 'Topic :: Internet :: WWW/HTTP', 'Topic :: Internet :: WWW/HTTP :: Dynamic Content', ], diff --git a/docs/intro/tutorial01.txt b/docs/intro/tutorial01.txt index e8b6fc10e0..4382f21a0f 100644 --- a/docs/intro/tutorial01.txt +++ b/docs/intro/tutorial01.txt @@ -22,13 +22,12 @@ tell Django is installed and which version by running the following command: If Django is installed, you should see the version of your installation. If it isn't, you'll get an error telling "No module named django". -This tutorial is written for Django |version| and Python 2.x. If the Django -version doesn't match, you can refer to the tutorial for your version of -Django by using the version switcher at the bottom right corner of this page, -or update Django to the newest version. If you are using Python 3.x, be aware -that your code may need to differ from what is in the tutorial and you should -continue using the tutorial only if you know what you are doing with Python -3.x. +This tutorial is written for Django |version| and Python 3.2 or later. If the +Django version doesn't match, you can refer to the tutorial for your version +of Django by using the version switcher at the bottom right corner of this +page, or update Django to the newest version. If you are still using Python +2.7, you will need to adjust the code samples slightly, as described in +comments. See :doc:`How to install Django ` for advice on how to remove older versions of Django and install a newer one. @@ -154,7 +153,7 @@ purely in Python. We've included this with Django so you can develop things rapidly, without having to deal with configuring a production server -- such as Apache -- until you're ready for production. -Now's a good time to note: **Don't** use this server in anything resembling a +Now's a good time to note: **don't** use this server in anything resembling a production environment. It's intended only for use while developing. (We're in the business of making Web frameworks, not Web servers.) @@ -190,9 +189,8 @@ It worked! The development server automatically reloads Python code for each request as needed. You don't need to restart the server for code changes to take - effect. However, some actions like adding files or compiling translation - files don't trigger a restart, so you'll have to restart the server in - these cases. + effect. However, some actions like adding files don't trigger a restart, + so you'll have to restart the server in these cases. Database setup -------------- @@ -214,8 +212,8 @@ settings: ``'django.db.backends.sqlite3'``, ``'django.db.backends.postgresql_psycopg2'``, ``'django.db.backends.mysql'``, or - ``'django.db.backends.oracle'``. Other backends are :setting:`also available - `. + ``'django.db.backends.oracle'``. Other backends are :ref:`also available + `. * :setting:`NAME` -- The name of your database. If you're using SQLite, the database will be a file on your computer; in that case, :setting:`NAME` @@ -654,9 +652,8 @@ Once you're in the shell, explore the :doc:`database API `:: Wait a minute. ```` is, utterly, an unhelpful representation of this object. Let's fix that by editing the ``Question`` model (in the ``polls/models.py`` file) and adding a -:meth:`~django.db.models.Model.__unicode__` method to both ``Question`` and -``Choice``. On Python 3, simply replace ``__unicode__`` by ``__str__`` in the -following example: +:meth:`~django.db.models.Model.__str__` method to both ``Question`` and +``Choice``: .. snippet:: :filename: polls/models.py @@ -665,42 +662,35 @@ following example: class Question(models.Model): # ... - def __unicode__(self): # Python 3: def __str__(self): + def __str__(self): # __unicode__ on Python 2 return self.question_text class Choice(models.Model): # ... - def __unicode__(self): # Python 3: def __str__(self): + def __str__(self): # __unicode__ on Python 2 return self.choice_text -It's important to add :meth:`~django.db.models.Model.__unicode__` methods (or -:meth:`~django.db.models.Model.__str__` on Python 3) to your models, not only -for your own sanity when dealing with the interactive prompt, but also because -objects' representations are used throughout Django's automatically-generated -admin. +It's important to add :meth:`~django.db.models.Model.__str__` methods to your +models, not only for your own sanity when dealing with the interactive prompt, +but also because objects' representations are used throughout Django's +automatically-generated admin. -.. admonition:: ``__unicode__`` or ``__str__``? +.. admonition:: ``__str__`` or ``__unicode__``? - On Python 3, things are simpler, just use - :meth:`~django.db.models.Model.__str__` and forget about - :meth:`~django.db.models.Model.__unicode__`. + On Python 3, it's easy, just use + :meth:`~django.db.models.Model.__str__`. - If you're familiar with Python 2, you might be in the habit of adding - :meth:`~django.db.models.Model.__str__` methods to your classes, not - :meth:`~django.db.models.Model.__unicode__` methods. We use - :meth:`~django.db.models.Model.__unicode__` here because Django models deal - with Unicode by default. All data stored in your database is converted to - Unicode when it's returned. + On Python 2, you should define :meth:`~django.db.models.Model.__unicode__` + methods returning ``unicode`` values instead. Django models have a default + :meth:`~django.db.models.Model.__str__` method that calls + :meth:`~django.db.models.Model.__unicode__` and converts the result to a + UTF-8 bytestring. This means that ``unicode(p)`` will return a Unicode + string, and ``str(p)`` will return a bytestring, with characters encoded + as UTF-8. Python does the opposite: :class:`object` has a ``__unicode__`` + method that calls ``__str__`` and interprets the result as an ASCII + bytestring. This difference can create confusion. - Django models have a default :meth:`~django.db.models.Model.__str__` method - that calls :meth:`~django.db.models.Model.__unicode__` and converts the - result to a UTF-8 bytestring. This means that ``unicode(p)`` will return a - Unicode string, and ``str(p)`` will return a normal string, with characters - encoded as UTF-8. - - If all of this is gibberish to you, just remember to add - :meth:`~django.db.models.Model.__unicode__` methods to your models. With any - luck, things should Just Work for you. + If all of this is gibberish to you, just use Python 3. Note these are normal Python methods. Let's add a custom method, just for demonstration: diff --git a/docs/topics/install.txt b/docs/topics/install.txt index d14f40a7bb..c410f86831 100644 --- a/docs/topics/install.txt +++ b/docs/topics/install.txt @@ -10,8 +10,8 @@ Install Python Being a Python Web framework, Django requires Python. It works with Python 2.7, 3.2 or 3.3. -Get Python at http://www.python.org. If you're running Linux or Mac OS X, you -probably already have it installed. +Get the latest version of Python at http://www.python.org/download/ or with +your operating system's package manager. .. admonition:: Django on Jython From e5c89c62f2ea0b4d873eea8945d61cec3ba82673 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 30 Dec 2013 18:52:22 +0100 Subject: [PATCH 121/208] Pointed intersphinx links to Python's default version. Currently it's 3.3. --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 49e70fab84..6bc293d02a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -110,7 +110,7 @@ pygments_style = 'trac' # Links to Python's docs should reference the most recent version of the 2.x # branch, which is located at this URL. intersphinx_mapping = { - 'python': ('http://docs.python.org/2.7', None), + 'python': ('http://docs.python.org/', None), 'sphinx': ('http://sphinx-doc.org/', None), 'six': ('http://pythonhosted.org/six/', None), 'simplejson': ('http://simplejson.readthedocs.org/en/latest/', None), From d6dc88cbc1ebc4cfba6faf39edf6eebd41873029 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 30 Dec 2013 17:00:50 +0100 Subject: [PATCH 122/208] Avoided leaking state on exceptions in populate_models(). --- django/apps/registry.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index 5dbb4696d7..1bb00f37f7 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -125,11 +125,12 @@ class Apps(object): self._postponed.append(app_config) if outermost: - for app_config in self._postponed: - all_models = self.all_models[app_config.label] - app_config.import_models(all_models) - - del self._postponed + try: + for app_config in self._postponed: + all_models = self.all_models[app_config.label] + app_config.import_models(all_models) + finally: + del self._postponed self.clear_cache() self._models_loaded = True From 0d2c8ff2be733c7cc83a023bbafe0258faa5603c Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 30 Dec 2013 11:12:40 +0100 Subject: [PATCH 123/208] Populated the app registry earlier at startup. Refs #1796, #21676. --- django/core/management/__init__.py | 7 ++++++- django/core/management/base.py | 8 +++----- django/core/management/commands/shell.py | 10 +++------- django/core/wsgi.py | 7 +++++++ 4 files changed, 19 insertions(+), 13 deletions(-) diff --git a/django/core/management/__init__.py b/django/core/management/__init__.py index 019837b35c..c9ccd6a370 100644 --- a/django/core/management/__init__.py +++ b/django/core/management/__init__.py @@ -41,6 +41,9 @@ def find_management_module(app_name): Raises ImportError if the management module cannot be found for any reason. """ + # TODO: this method is only called from get_commands() which has already + # imported the application module at that point. + parts = app_name.split('.') parts.append('management') parts.reverse() @@ -108,7 +111,7 @@ def get_commands(): # Find the installed apps try: - settings.INSTALLED_APPS + installed_apps = settings.INSTALLED_APPS except ImproperlyConfigured: # Still useful for commands that do not require functional # settings, like startproject or help. @@ -118,6 +121,8 @@ def get_commands(): # avoid catching ImproperlyConfigured errors that aren't caused # by the absence of a settings module. from django.apps import apps + apps.populate_apps(installed_apps) + apps.populate_models() app_configs = apps.get_app_configs() app_names = [app_config.name for app_config in app_configs] diff --git a/django/core/management/base.py b/django/core/management/base.py index 413592a8f3..a71cc78588 100644 --- a/django/core/management/base.py +++ b/django/core/management/base.py @@ -344,11 +344,9 @@ class AppCommand(BaseCommand): from django.apps import apps if not app_labels: raise CommandError("Enter at least one application label.") - # Populate models and don't use only_with_models_module=True when - # calling get_app_config() to tell apart missing apps from apps - # without a model module -- which can't be supported with the legacy - # API since it passes the models module to handle_app(). - apps.populate_models() + # Don't use only_with_models_module=True in get_app_config() to tell + # apart missing apps from apps without a model module -- which can't + # be supported with the legacy API since it passes the models module. try: app_configs = [apps.get_app_config(app_label) for app_label in app_labels] except (LookupError, ImportError) as e: diff --git a/django/core/management/commands/shell.py b/django/core/management/commands/shell.py index eea233bcff..5ef51db3f9 100644 --- a/django/core/management/commands/shell.py +++ b/django/core/management/commands/shell.py @@ -1,6 +1,7 @@ -import os -from django.core.management.base import NoArgsCommand from optparse import make_option +import os + +from django.core.management.base import NoArgsCommand class Command(NoArgsCommand): @@ -64,11 +65,6 @@ class Command(NoArgsCommand): raise ImportError def handle_noargs(self, **options): - # XXX: (Temporary) workaround for ticket #1796: force early loading of all - # models from installed apps. - from django.apps import apps - apps.populate_models() - use_plain = options.get('plain', False) no_startup = options.get('no_startup', False) interface = options.get('interface', None) diff --git a/django/core/wsgi.py b/django/core/wsgi.py index edea3334c9..d2dadee623 100644 --- a/django/core/wsgi.py +++ b/django/core/wsgi.py @@ -1,3 +1,5 @@ +from django.apps import apps +from django.conf import settings from django.core.handlers.wsgi import WSGIHandler @@ -10,4 +12,9 @@ def get_wsgi_application(): case the internal WSGI implementation changes or moves in the future. """ + # Configure the settings (this happens automatically on the first access). + # Populate the app registry. + apps.populate_apps(settings.INSTALLED_APPS) + apps.populate_models() + return WSGIHandler() From e187caa3afd7d292353fb32be1647da2cf0968da Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 30 Dec 2013 12:49:53 +0100 Subject: [PATCH 124/208] Added AppConfig.setup() to run setup code. --- django/apps/base.py | 5 +++++ django/apps/registry.py | 3 +++ docs/ref/applications.txt | 6 ++++++ 3 files changed, 14 insertions(+) diff --git a/django/apps/base.py b/django/apps/base.py index 784c460bcd..eaf8993624 100644 --- a/django/apps/base.py +++ b/django/apps/base.py @@ -162,3 +162,8 @@ class AppConfig(object): if module_has_submodule(self.module, MODELS_MODULE_NAME): models_module_name = '%s.%s' % (self.name, MODELS_MODULE_NAME) self.models_module = import_module(models_module_name) + + def setup(self): + """ + Override this method in subclasses to run setup code. + """ diff --git a/django/apps/registry.py b/django/apps/registry.py index 1bb00f37f7..c23fe69362 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -135,6 +135,9 @@ class Apps(object): self.clear_cache() self._models_loaded = True + for app_config in self.get_app_configs(): + app_config.setup() + @property def ready(self): """ diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt index 8505784737..5d9db49140 100644 --- a/docs/ref/applications.txt +++ b/docs/ref/applications.txt @@ -166,6 +166,12 @@ Methods ``model_name``. Raises :exc:`~exceptions.LookupError` if no such model exists. ``model_name`` is case-insensitive. +.. method:: AppConfig.setup() + + Subclasses can override this method to perform setup tasks such as + registering signals. It is called as soon as the registry is fully + populated. + Application registry ==================== From c31d7c48139260ccb72deda9b0033db0db86e84a Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 30 Dec 2013 13:24:24 +0100 Subject: [PATCH 125/208] Updated advice on connecting signals at startup. --- docs/ref/signals.txt | 6 ++++++ docs/topics/signals.txt | 42 ++++++++++++++++++++++++++--------------- 2 files changed, 33 insertions(+), 15 deletions(-) diff --git a/docs/ref/signals.txt b/docs/ref/signals.txt index ece6990aa7..2e9f6ccea6 100644 --- a/docs/ref/signals.txt +++ b/docs/ref/signals.txt @@ -354,6 +354,12 @@ Sent whenever a model class has been "prepared" -- that is, once model has been defined and registered with Django's model system. Django uses this signal internally; it's not generally used in third-party applications. +Since this signal is sent during the app registry population process, and +:meth:`AppConfig.setup() ` runs after the app +registry is fully populated, receivers cannot be connected in that method. +One possibility is to connect them ``AppConfig.__init__()`` instead, taking +care not to import models or trigger calls to the app registry. + Arguments that are sent with this signal: ``sender`` diff --git a/docs/topics/signals.txt b/docs/topics/signals.txt index 587590096c..9a311cd506 100644 --- a/docs/topics/signals.txt +++ b/docs/topics/signals.txt @@ -48,8 +48,7 @@ Listening to signals ==================== To receive a signal, you need to register a *receiver* function that gets -called when the signal is sent by using the -:meth:`.Signal.connect` method: +called when the signal is sent by using the :meth:`Signal.connect` method: .. method:: Signal.connect(receiver, [sender=None, weak=True, dispatch_uid=None]) @@ -115,8 +114,13 @@ manual connect route: request_finished.connect(my_callback) -Alternatively, you can use a ``receiver`` decorator when you define your -receiver: +Alternatively, you can use a :func:`receiver` decorator: + +.. function:: receiver(signal) + + :param signal: A signal or a list of signals to connect a function to. + +Here's how you connect with the decorator: .. code-block:: python @@ -129,16 +133,25 @@ receiver: Now, our ``my_callback`` function will be called each time a request finishes. -Note that ``receiver`` can also take a list of signals to connect a function -to. .. admonition:: Where should this code live? - You can put signal handling and registration code anywhere you like. - However, you'll need to make sure that the module it's in gets imported - early on so that the signal handling gets registered before any signals need - to be sent. This makes your app's ``models.py`` a good place to put - registration of signal handlers. + Strictly speaking, signal handling and registration code can live anywhere + you like, although it's recommended to avoid the application's root module + and its ``models`` module to minimize side-effects of importing code. + + In practice, signal handlers are usually defined in a ``signals`` + submodule of the application they relate to. Signal receivers are + connected in the :meth:`~django.apps.AppConfig.setup` method of your + application configuration class. If you're using the :func:`receiver` + decorator, simply import the ``signals`` submodule inside + :meth:`~django.apps.AppConfig.setup`. + + .. versionchanged:: 1.7 + + Since :meth:`~django.apps.AppConfig.setup` didn't exist in previous + versions of Django, signal registration usually happened in the + ``models`` module. .. _connecting-to-specific-signals: @@ -178,10 +191,9 @@ particular signal. Preventing duplicate signals ---------------------------- -In some circumstances, the module in which you are connecting signals may be -imported multiple times. This can cause your receiver function to be -registered more than once, and thus called multiples times for a single signal -event. +In some circumstances, the code connecting receivers to signals may run +multiple times. This can cause your receiver function to be registered more +than once, and thus called multiples times for a single signal event. If this behavior is problematic (such as when using signals to send an email whenever a model is saved), pass a unique identifier as From 7ed20e015335076fc98ad805eaf241f8a0d872d5 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 30 Dec 2013 16:03:06 +0100 Subject: [PATCH 126/208] Populated Apps instances immediately by default. --- django/apps/registry.py | 18 ++++++++++++------ django/db/migrations/state.py | 5 +---- tests/apps/models.py | 2 +- tests/apps/tests.py | 17 ++++------------- tests/migrations/test_state.py | 6 +++--- 5 files changed, 21 insertions(+), 27 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index c23fe69362..35c4ac3cea 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -19,11 +19,12 @@ class Apps(object): It also keeps track of models eg. to provide reverse-relations. """ - def __init__(self, master=False): - # Only one master registry may exist at a given time, and it shall be - # the apps variable defined at the end of this module. - if master and hasattr(sys.modules[__name__], 'apps'): - raise RuntimeError("You may create only one master registry.") + def __init__(self, installed_apps=()): + # installed_apps is set to None when creating the master registry + # because it cannot be populated at that point. Other registries must + # provide a list of installed apps and are populated immediately. + if installed_apps is None and hasattr(sys.modules[__name__], 'apps'): + raise RuntimeError("You must supply an installed_apps argument.") # Mapping of app labels => model names => model classes. Every time a # model is imported, ModelBase.__new__ calls apps.register_model which @@ -48,6 +49,11 @@ class Apps(object): # Pending lookups for lazy relations. self._pending_lookups = {} + # Populate apps and models, unless it's the master registry. + if installed_apps is not None: + self.populate_apps(installed_apps) + self.populate_models() + def populate_apps(self, installed_apps=None): """ Populate app-related information. @@ -442,4 +448,4 @@ class Apps(object): self.register_model(app_label, model) -apps = Apps(master=True) +apps = Apps(installed_apps=None) diff --git a/django/db/migrations/state.py b/django/db/migrations/state.py index fcf639837e..ff2e26c7a0 100644 --- a/django/db/migrations/state.py +++ b/django/db/migrations/state.py @@ -33,12 +33,9 @@ class ProjectState(object): def render(self): "Turns the project state into actual models in a new Apps" if self.apps is None: - self.apps = Apps() # Populate the app registry with a stub for each application. app_labels = set(model_state.app_label for model_state in self.models.values()) - app_configs = [AppConfigStub(label) for label in sorted(app_labels)] - self.apps.populate_apps(app_configs) - self.apps.populate_models() + self.apps = Apps([AppConfigStub(label) for label in sorted(app_labels)]) # We keep trying to render the models in a loop, ignoring invalid # base errors, until the size of the unrendered models doesn't # decrease by at least one, meaning there's a base dependency loop/ diff --git a/tests/apps/models.py b/tests/apps/models.py index a7a9b691c3..d6907eced1 100644 --- a/tests/apps/models.py +++ b/tests/apps/models.py @@ -6,7 +6,7 @@ from django.db import models # We're testing app registry presence on load, so this is handy. -new_apps = Apps() +new_apps = Apps(['apps']) class TotallyNormal(models.Model): diff --git a/tests/apps/tests.py b/tests/apps/tests.py index a75ae94a75..326ddcb6ab 100644 --- a/tests/apps/tests.py +++ b/tests/apps/tests.py @@ -36,7 +36,7 @@ class AppsTests(TestCase): Ensures that only one master registry can exist. """ with self.assertRaises(RuntimeError): - Apps(master=True) + Apps(installed_apps=None) def test_ready(self): """ @@ -44,17 +44,8 @@ class AppsTests(TestCase): """ # The master app registry is always ready when the tests run. self.assertTrue(apps.ready) - - def test_non_master_ready(self): - """ - Tests the ready property of a registry other than the master. - """ - apps = Apps() - self.assertFalse(apps.ready) - apps.populate_apps([]) - self.assertFalse(apps.ready) - apps.populate_models() - self.assertTrue(apps.ready) + # Non-master app registries are populated in __init__. + self.assertTrue(Apps().ready) def test_bad_app_config(self): """ @@ -162,7 +153,7 @@ class AppsTests(TestCase): old_models = list(apps.get_app_config("apps").get_models()) # Construct a new model in a new app registry body = {} - new_apps = Apps() + new_apps = Apps(["apps"]) meta_contents = { 'app_label': "apps", 'apps': new_apps, diff --git a/tests/migrations/test_state.py b/tests/migrations/test_state.py index b7af48fede..e2d970e0f5 100644 --- a/tests/migrations/test_state.py +++ b/tests/migrations/test_state.py @@ -14,7 +14,7 @@ class StateTests(TestCase): Tests making a ProjectState from an Apps """ - new_apps = Apps() + new_apps = Apps(["migrations"]) class Author(models.Model): name = models.CharField(max_length=255) @@ -108,7 +108,7 @@ class StateTests(TestCase): apps = Apps() # First, test rendering individually - apps = Apps() + apps = Apps(["migrations"]) # We shouldn't be able to render yet ms = ModelState.from_model(Novel) @@ -135,7 +135,7 @@ class StateTests(TestCase): app_label = "migrations" apps = Apps() - apps = Apps() + apps = Apps(["migrations"]) # We shouldn't be able to render yet ms = ModelState.from_model(FooBar) From 80d74097b4bd7186ad99b6d41d0ed90347a39b21 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 30 Dec 2013 15:42:15 +0100 Subject: [PATCH 127/208] Stopped populating the app registry as a side effect. Since it triggers imports, it shouldn't be done lightly. This commit adds a public API for doing it explicitly, django.setup(), and does it automatically when using manage.py and wsgi.py. --- django/__init__.py | 9 ++++++ django/apps/base.py | 7 ++--- django/apps/registry.py | 44 +++++++++++++++--------------- django/contrib/admin/sites.py | 1 - django/contrib/admin/validation.py | 5 ---- django/core/serializers/base.py | 4 --- django/core/serializers/python.py | 2 -- django/core/wsgi.py | 9 ++---- django/db/models/loading.py | 1 - docs/intro/tutorial01.txt | 16 +++++++++-- docs/ref/django-admin.txt | 6 ++++ docs/releases/1.7.txt | 9 ++++++ tests/runtests.py | 4 +-- 13 files changed, 65 insertions(+), 52 deletions(-) diff --git a/django/__init__.py b/django/__init__.py index 5b4034bfed..61413abe8e 100644 --- a/django/__init__.py +++ b/django/__init__.py @@ -6,3 +6,12 @@ def get_version(*args, **kwargs): # Only import if it's actually called. from django.utils.version import get_version return get_version(*args, **kwargs) + + +def setup(): + # Configure the settings (this happens as a side effect of accessing + # INSTALLED_APPS or any other setting) and populate the app registry. + from django.apps import apps + from django.conf import settings + apps.populate_apps(settings.INSTALLED_APPS) + apps.populate_models() diff --git a/django/apps/base.py b/django/apps/base.py index eaf8993624..ae2abaae84 100644 --- a/django/apps/base.py +++ b/django/apps/base.py @@ -114,8 +114,6 @@ class AppConfig(object): Returns the model with the given case-insensitive model_name. Raises LookupError if no model exists with this name. - - This method assumes that apps.populate_models() has run. """ if self.models is None: raise LookupError( @@ -140,8 +138,6 @@ class AppConfig(object): Set the corresponding keyword argument to True to include such models. Keyword arguments aren't documented; they're a private API. - - This method assumes that apps.populate_models() has run. """ for model in self.models.values(): if model._deferred and not include_deferred: @@ -156,7 +152,8 @@ class AppConfig(object): # Dictionary of models for this app, primarily maintained in the # 'all_models' attribute of the Apps this AppConfig is attached to. # Injected as a parameter because it gets populated when models are - # imported, which may happen before populate_models() runs. + # imported, which might happen before populate_models() runs (or at + # least used to). self.models = all_models if module_has_submodule(self.module, MODELS_MODULE_NAME): diff --git a/django/apps/registry.py b/django/apps/registry.py index 35c4ac3cea..0e39068e1f 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -3,7 +3,6 @@ import os import sys import warnings -from django.conf import settings from django.core.exceptions import ImproperlyConfigured from django.utils import lru_cache from django.utils.module_loading import import_lock @@ -79,8 +78,6 @@ class Apps(object): # Application modules aren't expected to import anything, and # especially not other application modules, even indirectly. # Therefore we simply import them sequentially. - if installed_apps is None: - installed_apps = settings.INSTALLED_APPS for entry in installed_apps: if isinstance(entry, AppConfig): app_config = entry @@ -108,7 +105,9 @@ class Apps(object): if self._models_loaded: return - self.populate_apps() + if not self._apps_loaded: + raise RuntimeError( + "populate_models() must run after populate_apps()") # Models modules are likely to import other models modules, for # example to reference related objects. As a consequence: @@ -144,6 +143,15 @@ class Apps(object): for app_config in self.get_app_configs(): app_config.setup() + def check_ready(self): + """ + Raises an exception if the registry isn't ready. + """ + if not self._models_loaded: + raise RuntimeError( + "App registry isn't populated yet. " + "Have you called django.setup()?") + @property def ready(self): """ @@ -161,11 +169,7 @@ class Apps(object): If only_with_models_module in True (non-default), imports models and considers only applications containing a models module. """ - if only_with_models_module: - self.populate_models() - else: - self.populate_apps() - + self.check_ready() for app_config in self.app_configs.values(): if only_with_models_module and app_config.models_module is None: continue @@ -180,11 +184,7 @@ class Apps(object): If only_with_models_module in True (non-default), imports models and considers only applications containing a models module. """ - if only_with_models_module: - self.populate_models() - else: - self.populate_apps() - + self.check_ready() app_config = self.app_configs.get(app_label) if app_config is None: raise LookupError("No installed app with label '%s'." % app_label) @@ -208,8 +208,7 @@ class Apps(object): Set the corresponding keyword argument to True to include such models. """ - self.populate_models() - + self.check_ready() if app_mod: warnings.warn( "The app_mod argument of get_models is deprecated.", @@ -236,7 +235,7 @@ class Apps(object): Raises LookupError if no application exists with this label, or no model exists with this name in the application. """ - self.populate_models() + self.check_ready() return self.get_app_config(app_label).get_model(model_name.lower()) def register_model(self, app_label, model): @@ -328,7 +327,8 @@ class Apps(object): imports safely (eg. that could lead to registering listeners twice), models are registered when they're imported and never removed. """ - self.stored_app_configs.append((self.app_configs, self._apps_loaded, self._models_loaded)) + self.check_ready() + self.stored_app_configs.append(self.app_configs) self.app_configs = OrderedDict() self.clear_cache() self._apps_loaded = False @@ -340,7 +340,9 @@ class Apps(object): """ Cancels a previous call to set_installed_apps(). """ - self.app_configs, self._apps_loaded, self._models_loaded = self.stored_app_configs.pop() + self.app_configs = self.stored_app_configs.pop() + self._apps_loaded = True + self._models_loaded = True self.clear_cache() def clear_cache(self): @@ -429,9 +431,7 @@ class Apps(object): warnings.warn( "[a.path for a in get_app_configs()] supersedes get_app_paths().", PendingDeprecationWarning, stacklevel=2) - - self.populate_models() - + self.check_ready() app_paths = [] for app in self.get_apps(): app_paths.append(self._get_app_path(app)) diff --git a/django/contrib/admin/sites.py b/django/contrib/admin/sites.py index 0edeca210e..0626c5aa45 100644 --- a/django/contrib/admin/sites.py +++ b/django/contrib/admin/sites.py @@ -160,7 +160,6 @@ class AdminSite(object): The default implementation checks that admin and contenttypes apps are installed, as well as the auth context processor. """ - apps.populate_apps() if not apps.has_app('django.contrib.admin'): raise ImproperlyConfigured("Put 'django.contrib.admin' in your " "INSTALLED_APPS setting in order to use the admin application.") diff --git a/django/contrib/admin/validation.py b/django/contrib/admin/validation.py index 23dba7c7bd..784bee6f8b 100644 --- a/django/contrib/admin/validation.py +++ b/django/contrib/admin/validation.py @@ -1,4 +1,3 @@ -from django.apps import apps from django.core.exceptions import ImproperlyConfigured from django.db import models from django.db.models.fields import FieldDoesNotExist @@ -15,10 +14,6 @@ __all__ = ['BaseValidator', 'InlineValidator'] class BaseValidator(object): - def __init__(self): - # Before we can introspect models, they need the app registry to be - # fully loaded so that inter-relations are set up correctly. - apps.populate_models() def validate(self, cls, model): for m in dir(self): diff --git a/django/core/serializers/base.py b/django/core/serializers/base.py index 70bc651f82..e5c295131e 100644 --- a/django/core/serializers/base.py +++ b/django/core/serializers/base.py @@ -3,7 +3,6 @@ Module for abstract serializer/unserializer base classes. """ import warnings -from django.apps import apps from django.db import models from django.utils import six @@ -137,9 +136,6 @@ class Deserializer(six.Iterator): self.stream = six.StringIO(stream_or_string) else: self.stream = stream_or_string - # Make sure the app registy is loaded before deserialization starts - # (otherwise subclass calls to get_model() and friends might fail...) - apps.populate_models() def __iter__(self): return self diff --git a/django/core/serializers/python.py b/django/core/serializers/python.py index 9a59f61d70..3d14a1b509 100644 --- a/django/core/serializers/python.py +++ b/django/core/serializers/python.py @@ -88,8 +88,6 @@ def Deserializer(object_list, **options): db = options.pop('using', DEFAULT_DB_ALIAS) ignore = options.pop('ignorenonexistent', False) - apps.populate_models() - for d in object_list: # Look up the model and starting build a dict of data for it. Model = _get_model(d["model"]) diff --git a/django/core/wsgi.py b/django/core/wsgi.py index d2dadee623..4ff41318d3 100644 --- a/django/core/wsgi.py +++ b/django/core/wsgi.py @@ -1,5 +1,4 @@ -from django.apps import apps -from django.conf import settings +import django from django.core.handlers.wsgi import WSGIHandler @@ -12,9 +11,5 @@ def get_wsgi_application(): case the internal WSGI implementation changes or moves in the future. """ - # Configure the settings (this happens automatically on the first access). - # Populate the app registry. - apps.populate_apps(settings.INSTALLED_APPS) - apps.populate_models() - + django.setup() return WSGIHandler() diff --git a/django/db/models/loading.py b/django/db/models/loading.py index 42fcce8551..6c4ee6bf68 100644 --- a/django/db/models/loading.py +++ b/django/db/models/loading.py @@ -30,6 +30,5 @@ def get_app_errors(): try: return apps.app_errors except AttributeError: - apps.populate_models() apps.app_errors = {} return apps.app_errors diff --git a/docs/intro/tutorial01.txt b/docs/intro/tutorial01.txt index 4382f21a0f..0bd3d0abaf 100644 --- a/docs/intro/tutorial01.txt +++ b/docs/intro/tutorial01.txt @@ -602,9 +602,19 @@ the Python import path to your :file:`mysite/settings.py` file. .. admonition:: Bypassing manage.py If you'd rather not use :file:`manage.py`, no problem. Just set the - ``DJANGO_SETTINGS_MODULE`` environment variable to ``mysite.settings`` and - run ``python`` from the same directory :file:`manage.py` is in (or ensure - that directory is on the Python path, so that ``import mysite`` works). + :envvar:`DJANGO_SETTINGS_MODULE` environment variable to + ``mysite.settings``, start a plain Python shell, and set up Django:: + + >>> import django + >>> django.setup() + + If this raises an :exc:`~exceptions.AttributeError`, you're probably using + a version of Django that doesn't match this tutorial version. You'll want + to either switch to the older tutorial or the newer Django version. + + You must run ``python`` from the same directory :file:`manage.py` is in, + or ensure that directory is on the Python path, so that ``import mysite`` + works. For more information on all of this, see the :doc:`django-admin.py documentation `. diff --git a/docs/ref/django-admin.txt b/docs/ref/django-admin.txt index 97923011f0..06f589ee63 100644 --- a/docs/ref/django-admin.txt +++ b/docs/ref/django-admin.txt @@ -14,6 +14,12 @@ two things for you before delegating to ``django-admin.py``: * It sets the :envvar:`DJANGO_SETTINGS_MODULE` environment variable so that it points to your project's ``settings.py`` file. +* It calls ``django.setup()`` to initialize various internals of Django. + +.. versionadded:: 1.7 + + ``django.setup()`` didn't exist in previous versions of Django. + The ``django-admin.py`` script should be on your system path if you installed Django via its ``setup.py`` utility. If it's not on your path, you can find it in ``site-packages/django/bin`` within your Python installation. Consider diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index b4ee180c73..87fa419188 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -613,6 +613,15 @@ Since :setting:`INSTALLED_APPS` now supports application configuration classes in addition to application modules, you should review code that accesses this setting directly and use the app registry (:attr:`django.apps.apps`) instead. +If you're using Django in a plain Python script (not a management command) and +rely on the :envvar:`DJANGO_SETTINGS_MODULE` environment variable, you must +now explicitly initialize Django at the beginning of your script with:: + + >>> import django + >>> django.setup() + +Otherwise, you will most likely encounter a :exc:`~exceptions.RuntimeError`. + The "app registry" that manages the list of installed applications doesn't have the same features as the old "app cache". Even though the "app cache" was a private API, obsolete methods and arguments will be removed after a standard diff --git a/tests/runtests.py b/tests/runtests.py index 4c917fbbed..e33533a083 100755 --- a/tests/runtests.py +++ b/tests/runtests.py @@ -9,6 +9,7 @@ import sys import tempfile import warnings +import django from django import contrib from django.utils._os import upath from django.utils import six @@ -85,7 +86,6 @@ def get_installed(): def setup(verbosity, test_labels): - import django from django.apps import apps, AppConfig from django.conf import settings from django.test import TransactionTestCase, TestCase @@ -128,7 +128,7 @@ def setup(verbosity, test_labels): # Load all the ALWAYS_INSTALLED_APPS. with warnings.catch_warnings(): warnings.filterwarnings('ignore', 'django.contrib.comments is deprecated and will be removed before Django 1.8.', DeprecationWarning) - apps.populate_models() + django.setup() # Load all the test model apps. test_modules = get_test_modules() From 966de8497373dc47756105516b4b839734ed316e Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 30 Dec 2013 23:01:00 +0100 Subject: [PATCH 128/208] Removed postponing in Apps.populate_models. To the best of my understanding, since populate_models() is now called as soon as Django starts, it cannot be called while a models module is being imported, and that removes the need for postponing. (If hell breaks loose we'll revert this commit.) Refs #21681. --- django/apps/registry.py | 36 ++++++------------------------------ 1 file changed, 6 insertions(+), 30 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index 0e39068e1f..9152e80593 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -109,39 +109,15 @@ class Apps(object): raise RuntimeError( "populate_models() must run after populate_apps()") - # Models modules are likely to import other models modules, for - # example to reference related objects. As a consequence: - # - we deal with import loops by postponing affected modules. - # - we provide reentrancy by making import_models() idempotent. - - outermost = not hasattr(self, '_postponed') - if outermost: - self._postponed = [] - for app_config in self.app_configs.values(): + all_models = self.all_models[app_config.label] + app_config.import_models(all_models) - if app_config.models is not None: - continue + self.clear_cache() + self._models_loaded = True - try: - all_models = self.all_models[app_config.label] - app_config.import_models(all_models) - except ImportError: - self._postponed.append(app_config) - - if outermost: - try: - for app_config in self._postponed: - all_models = self.all_models[app_config.label] - app_config.import_models(all_models) - finally: - del self._postponed - - self.clear_cache() - self._models_loaded = True - - for app_config in self.get_app_configs(): - app_config.setup() + for app_config in self.get_app_configs(): + app_config.setup() def check_ready(self): """ From 1c242a297b5b1857d76cab9b24f9f1d3b7f5240d Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 30 Dec 2013 23:15:29 +0100 Subject: [PATCH 129/208] Merged Apps.populate_apps() and populate_models(). After the recent series of refactorings, there's no reason to keep two distinct methods. Refs #21681. --- django/__init__.py | 3 +- django/apps/base.py | 3 +- django/apps/registry.py | 78 ++++++++---------------------- django/core/management/__init__.py | 3 +- 4 files changed, 22 insertions(+), 65 deletions(-) diff --git a/django/__init__.py b/django/__init__.py index 61413abe8e..69be8c9984 100644 --- a/django/__init__.py +++ b/django/__init__.py @@ -13,5 +13,4 @@ def setup(): # INSTALLED_APPS or any other setting) and populate the app registry. from django.apps import apps from django.conf import settings - apps.populate_apps(settings.INSTALLED_APPS) - apps.populate_models() + apps.populate(settings.INSTALLED_APPS) diff --git a/django/apps/base.py b/django/apps/base.py index ae2abaae84..1aa5c29fd2 100644 --- a/django/apps/base.py +++ b/django/apps/base.py @@ -152,8 +152,7 @@ class AppConfig(object): # Dictionary of models for this app, primarily maintained in the # 'all_models' attribute of the Apps this AppConfig is attached to. # Injected as a parameter because it gets populated when models are - # imported, which might happen before populate_models() runs (or at - # least used to). + # imported, which might happen before populate() imports models. self.models = all_models if module_has_submodule(self.module, MODELS_MODULE_NAME): diff --git a/django/apps/registry.py b/django/apps/registry.py index 9152e80593..a6b807e608 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -41,43 +41,39 @@ class Apps(object): # set_available_apps and set_installed_apps. self.stored_app_configs = [] - # Internal flags used when populating the registry. - self._apps_loaded = False - self._models_loaded = False + # Whether the registry is populated. + self.ready = False # Pending lookups for lazy relations. self._pending_lookups = {} # Populate apps and models, unless it's the master registry. if installed_apps is not None: - self.populate_apps(installed_apps) - self.populate_models() + self.populate(installed_apps) - def populate_apps(self, installed_apps=None): + def populate(self, installed_apps=None): """ - Populate app-related information. + Loads application configurations and models. - This method imports each application module. + This method imports each application module and then each model module. It is thread safe and idempotent, but not reentrant. """ - if self._apps_loaded: + if self.ready: return - # Since populate_apps() may be a side effect of imports, and since - # it will itself import modules, an ABBA deadlock between threads - # would be possible if we didn't take the import lock. See #18251. + # Since populate() may be a side effect of imports, and since it will + # itself import modules, an ABBA deadlock between threads would be + # possible if we didn't take the import lock. See #18251. with import_lock(): - if self._apps_loaded: + if self.ready: return # app_config should be pristine, otherwise the code below won't # guarantee that the order matches the order in INSTALLED_APPS. if self.app_configs: - raise RuntimeError("populate_apps() isn't reentrant") + raise RuntimeError("populate() isn't reentrant") - # Application modules aren't expected to import anything, and - # especially not other application modules, even indirectly. - # Therefore we simply import them sequentially. + # Load app configs and app modules. for entry in installed_apps: if isinstance(entry, AppConfig): app_config = entry @@ -85,36 +81,13 @@ class Apps(object): app_config = AppConfig.create(entry) self.app_configs[app_config.label] = app_config - self.clear_cache() - self._apps_loaded = True - - def populate_models(self): - """ - Populate model-related information. - - This method imports each models module. - - It is thread safe, idempotent and reentrant. - """ - if self._models_loaded: - return - # Since populate_models() may be a side effect of imports, and since - # it will itself import modules, an ABBA deadlock between threads - # would be possible if we didn't take the import lock. See #18251. - with import_lock(): - if self._models_loaded: - return - - if not self._apps_loaded: - raise RuntimeError( - "populate_models() must run after populate_apps()") - + # Load models. for app_config in self.app_configs.values(): all_models = self.all_models[app_config.label] app_config.import_models(all_models) self.clear_cache() - self._models_loaded = True + self.ready = True for app_config in self.get_app_configs(): app_config.setup() @@ -123,21 +96,11 @@ class Apps(object): """ Raises an exception if the registry isn't ready. """ - if not self._models_loaded: + if not self.ready: raise RuntimeError( "App registry isn't populated yet. " "Have you called django.setup()?") - @property - def ready(self): - """ - Whether the registry is fully populated. - - Useful for code that wants to cache the results of get_models() for - themselves once it is safe to do so. - """ - return self._models_loaded # implies self._apps_loaded. - def get_app_configs(self, only_with_models_module=False): """ Imports applications and returns an iterable of app configs. @@ -306,19 +269,16 @@ class Apps(object): self.check_ready() self.stored_app_configs.append(self.app_configs) self.app_configs = OrderedDict() + self.ready = False self.clear_cache() - self._apps_loaded = False - self.populate_apps(installed) - self._models_loaded = False - self.populate_models() + self.populate(installed) def unset_installed_apps(self): """ Cancels a previous call to set_installed_apps(). """ self.app_configs = self.stored_app_configs.pop() - self._apps_loaded = True - self._models_loaded = True + self.ready = True self.clear_cache() def clear_cache(self): diff --git a/django/core/management/__init__.py b/django/core/management/__init__.py index c9ccd6a370..2a4fd96fc7 100644 --- a/django/core/management/__init__.py +++ b/django/core/management/__init__.py @@ -121,8 +121,7 @@ def get_commands(): # avoid catching ImproperlyConfigured errors that aren't caused # by the absence of a settings module. from django.apps import apps - apps.populate_apps(installed_apps) - apps.populate_models() + apps.populate(installed_apps) app_configs = apps.get_app_configs() app_names = [app_config.name for app_config in app_configs] From 0150830687188681ba7e4ae9b6da1a832a6d5141 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Mon, 30 Dec 2013 17:42:11 -0500 Subject: [PATCH 130/208] Fixed #21710 -- Documented User.get_short_name() Thanks Keryn Knight for the report. --- docs/ref/contrib/auth.txt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/ref/contrib/auth.txt b/docs/ref/contrib/auth.txt index 154c0ab75b..ac78da1ece 100644 --- a/docs/ref/contrib/auth.txt +++ b/docs/ref/contrib/auth.txt @@ -128,6 +128,10 @@ Methods the :attr:`~django.contrib.auth.models.User.last_name`, with a space in between. + .. method:: get_short_name() + + Returns the :attr:`~django.contrib.auth.models.User.first_name`. + .. method:: set_password(raw_password) Sets the user's password to the given raw string, taking care of the From c988745cca1225496bfd36910dc3cec5065d8cc4 Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Mon, 30 Dec 2013 23:45:43 +0100 Subject: [PATCH 131/208] Changed console and filebackend to use msg.as_bytes to output the data as it would get send via smtp. --- django/core/mail/backends/console.py | 13 ++++++--- django/core/mail/backends/filebased.py | 7 ++++- tests/mail/tests.py | 37 ++++++++++++-------------- 3 files changed, 33 insertions(+), 24 deletions(-) diff --git a/django/core/mail/backends/console.py b/django/core/mail/backends/console.py index d0ecac74ea..57fa32952d 100644 --- a/django/core/mail/backends/console.py +++ b/django/core/mail/backends/console.py @@ -5,6 +5,7 @@ import sys import threading from django.core.mail.backends.base import BaseEmailBackend +from django.utils import six class EmailBackend(BaseEmailBackend): @@ -13,6 +14,14 @@ class EmailBackend(BaseEmailBackend): self._lock = threading.RLock() super(EmailBackend, self).__init__(*args, **kwargs) + def write_message(self, message): + msg = message.message().as_bytes() + if six.PY3: + msg = msg.decode() + self.stream.write('%s\n' % msg) + self.stream.write('-' * 79) + self.stream.write('\n') + def send_messages(self, email_messages): """Write all messages to the stream in a thread-safe way.""" if not email_messages: @@ -22,9 +31,7 @@ class EmailBackend(BaseEmailBackend): try: stream_created = self.open() for message in email_messages: - self.stream.write('%s\n' % message.message().as_string()) - self.stream.write('-' * 79) - self.stream.write('\n') + self.write_message(message) self.stream.flush() # flush after each message msg_count += 1 if stream_created: diff --git a/django/core/mail/backends/filebased.py b/django/core/mail/backends/filebased.py index 3f26551dab..5caedd5802 100644 --- a/django/core/mail/backends/filebased.py +++ b/django/core/mail/backends/filebased.py @@ -38,6 +38,11 @@ class EmailBackend(ConsoleEmailBackend): kwargs['stream'] = None super(EmailBackend, self).__init__(*args, **kwargs) + def write_message(self, message): + self.stream.write(message.message().as_bytes() + b'\n') + self.stream.write(b'-' * 79) + self.stream.write(b'\n') + def _get_filename(self): """Return a unique file name.""" if self._fname is None: @@ -48,7 +53,7 @@ class EmailBackend(ConsoleEmailBackend): def open(self): if self.stream is None: - self.stream = open(self._get_filename(), 'a') + self.stream = open(self._get_filename(), 'ab') return True return False diff --git a/tests/mail/tests.py b/tests/mail/tests.py index f7b9e07359..ebb8ec5448 100644 --- a/tests/mail/tests.py +++ b/tests/mail/tests.py @@ -2,7 +2,6 @@ from __future__ import unicode_literals import asyncore -from email import message_from_file, message_from_string from email.mime.text import MIMEText import os import shutil @@ -20,16 +19,17 @@ from django.core.mail.backends import console, dummy, locmem, filebased, smtp from django.core.mail.message import BadHeaderError from django.test import SimpleTestCase from django.test import override_settings -from django.utils.encoding import force_str, force_text, force_bytes -from django.utils.six import PY3, StringIO, string_types +from django.utils.encoding import force_text, force_bytes +from django.utils.six import PY3, StringIO, binary_type from django.utils.translation import ugettext_lazy if PY3: from email.utils import parseaddr - from email import message_from_bytes + from email import message_from_bytes, message_from_binary_file else: from email.Utils import parseaddr - message_from_bytes = message_from_string + from email import (message_from_string as message_from_bytes, + message_from_file as message_from_binary_file) class HeadersCheckMixin(object): @@ -42,13 +42,9 @@ class HeadersCheckMixin(object): string with the contens of an email message. :param headers: should be a set of (header-name, header-value) tuples. """ - if isinstance(message, string_types): - just_headers = message.split('\n\n', 1)[0] - hlist = just_headers.split('\n') - pairs = [hl.split(':', 1) for hl in hlist] - msg_headers = {(n, v.lstrip()) for (n, v) in pairs} - else: - msg_headers = set(message.items()) + if isinstance(message, binary_type): + message = message_from_bytes(message) + msg_headers = set(message.items()) self.assertTrue(headers.issubset(msg_headers), msg='Message is missing ' 'the following headers: %s' % (headers - msg_headers),) @@ -694,9 +690,9 @@ class FileBackendTests(BaseEmailBackendTests, SimpleTestCase): def get_mailbox_content(self): messages = [] for filename in os.listdir(self.tmp_dir): - with open(os.path.join(self.tmp_dir, filename), 'r') as fp: - session = force_text(fp.read()).split('\n' + ('-' * 79) + '\n') - messages.extend(message_from_string(force_str(m)) for m in session if m) + with open(os.path.join(self.tmp_dir, filename), 'rb') as fp: + session = fp.read().split(force_bytes('\n' + ('-' * 79) + '\n', encoding='ascii')) + messages.extend(message_from_bytes(m) for m in session if m) return messages def test_file_sessions(self): @@ -706,8 +702,8 @@ class FileBackendTests(BaseEmailBackendTests, SimpleTestCase): connection.send_messages([msg]) self.assertEqual(len(os.listdir(self.tmp_dir)), 1) - with open(os.path.join(self.tmp_dir, os.listdir(self.tmp_dir)[0])) as fp: - message = message_from_file(fp) + with open(os.path.join(self.tmp_dir, os.listdir(self.tmp_dir)[0]), 'rb') as fp: + message = message_from_binary_file(fp) self.assertEqual(message.get_content_type(), 'text/plain') self.assertEqual(message.get('subject'), 'Subject') self.assertEqual(message.get('from'), 'from@example.com') @@ -748,7 +744,7 @@ class ConsoleBackendTests(BaseEmailBackendTests, SimpleTestCase): self.stream = sys.stdout = StringIO() def get_mailbox_content(self): - messages = self.stream.getvalue().split(force_str('\n' + ('-' * 79) + '\n')) + messages = self.stream.getvalue().split(str('\n' + ('-' * 79) + '\n')) return [message_from_bytes(force_bytes(m)) for m in messages if m] def test_console_stream_kwarg(self): @@ -758,14 +754,15 @@ class ConsoleBackendTests(BaseEmailBackendTests, SimpleTestCase): s = StringIO() connection = mail.get_connection('django.core.mail.backends.console.EmailBackend', stream=s) send_mail('Subject', 'Content', 'from@example.com', ['to@example.com'], connection=connection) - self.assertMessageHasHeaders(s.getvalue(), { + message = force_bytes(s.getvalue().split('\n' + ('-' * 79) + '\n')[0]) + self.assertMessageHasHeaders(message, { ('MIME-Version', '1.0'), ('Content-Type', 'text/plain; charset="utf-8"'), ('Content-Transfer-Encoding', '7bit'), ('Subject', 'Subject'), ('From', 'from@example.com'), ('To', 'to@example.com')}) - self.assertIn('\nDate: ', s.getvalue()) + self.assertIn(b'\nDate: ', message) class FakeSMTPChannel(smtpd.SMTPChannel): From bfe9052831c6d7ad7501b71c884525b3b471eebc Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Mon, 30 Dec 2013 23:54:12 +0100 Subject: [PATCH 132/208] Decode mails using the message encoding. --- django/core/mail/backends/console.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/django/core/mail/backends/console.py b/django/core/mail/backends/console.py index 57fa32952d..0ce88534ea 100644 --- a/django/core/mail/backends/console.py +++ b/django/core/mail/backends/console.py @@ -15,10 +15,12 @@ class EmailBackend(BaseEmailBackend): super(EmailBackend, self).__init__(*args, **kwargs) def write_message(self, message): - msg = message.message().as_bytes() + msg = message.message() + msg_data = msg.as_bytes() if six.PY3: - msg = msg.decode() - self.stream.write('%s\n' % msg) + charset = msg.get_charset().get_output_charset() if msg.get_charset() else 'utf-8' + msg_data = msg_data.decode(charset) + self.stream.write('%s\n' % msg_data) self.stream.write('-' * 79) self.stream.write('\n') From 270f7e21676f043464e9a3e252fec0a63e3c0b2a Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Mon, 30 Dec 2013 17:55:12 -0500 Subject: [PATCH 133/208] Fixed #21708 -- Added some headings to separate unrelated topics. Thanks ashley at ashleymills.com for the suggestion. --- docs/topics/http/urls.txt | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/topics/http/urls.txt b/docs/topics/http/urls.txt index a170a4e18d..36a43ed704 100644 --- a/docs/topics/http/urls.txt +++ b/docs/topics/http/urls.txt @@ -178,8 +178,8 @@ The URLconf doesn't look at the request method. In other words, all request methods -- ``POST``, ``GET``, ``HEAD``, etc. -- will be routed to the same function for the same URL. -Notes on capturing text in URLs -=============================== +Captured arguments are always strings +===================================== Each captured argument is sent to the view as a plain Python string, regardless of what sort of match the regular expression makes. For example, in this @@ -190,6 +190,9 @@ URLconf line:: ...the ``year`` argument to ``news.views.year_archive()`` will be a string, not an integer, even though the ``\d{4}`` will only match integer strings. +Specifying defaults for view arguments +====================================== + A convenient trick is to specify default parameters for your views' arguments. Here's an example URLconf and view:: From ec020cab7ef4b1943a8fe9a4d6872f7e874db707 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Mon, 30 Dec 2013 17:59:18 -0500 Subject: [PATCH 134/208] Fixed a broken link in docs/intro/tutorial01.txt. --- docs/intro/tutorial01.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/intro/tutorial01.txt b/docs/intro/tutorial01.txt index 0bd3d0abaf..3fa07e132c 100644 --- a/docs/intro/tutorial01.txt +++ b/docs/intro/tutorial01.txt @@ -696,7 +696,7 @@ automatically-generated admin. :meth:`~django.db.models.Model.__unicode__` and converts the result to a UTF-8 bytestring. This means that ``unicode(p)`` will return a Unicode string, and ``str(p)`` will return a bytestring, with characters encoded - as UTF-8. Python does the opposite: :class:`object` has a ``__unicode__`` + as UTF-8. Python does the opposite: ``object`` has a ``__unicode__`` method that calls ``__str__`` and interprets the result as an ASCII bytestring. This difference can create confusion. From bfcc686d22df10c268752635947dd242317ba156 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 30 Dec 2013 23:53:54 +0100 Subject: [PATCH 135/208] Removed the only_with_models_module argument of get_model[s]. Now that the refactorings are complete, it isn't particularly useful any more, nor very well named. Let's keep the API as simple as possible. Fixed #21689. --- django/apps/registry.py | 35 +++++++++------------ django/contrib/contenttypes/management.py | 2 +- django/core/management/base.py | 3 -- django/core/management/commands/dumpdata.py | 4 +-- django/core/management/commands/flush.py | 2 +- django/core/management/commands/migrate.py | 4 +-- django/core/management/sql.py | 8 +++-- django/db/backends/__init__.py | 6 ++-- django/db/migrations/loader.py | 4 ++- docs/ref/applications.txt | 10 ++---- tests/apps/tests.py | 23 -------------- 11 files changed, 34 insertions(+), 67 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index a6b807e608..bdd566c388 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -101,35 +101,24 @@ class Apps(object): "App registry isn't populated yet. " "Have you called django.setup()?") - def get_app_configs(self, only_with_models_module=False): + def get_app_configs(self): """ Imports applications and returns an iterable of app configs. - - If only_with_models_module in True (non-default), imports models and - considers only applications containing a models module. """ self.check_ready() - for app_config in self.app_configs.values(): - if only_with_models_module and app_config.models_module is None: - continue - yield app_config + return self.app_configs.values() - def get_app_config(self, app_label, only_with_models_module=False): + def get_app_config(self, app_label): """ Imports applications and returns an app config for the given label. Raises LookupError if no application exists with this label. - - If only_with_models_module in True (non-default), imports models and - considers only applications containing a models module. """ self.check_ready() - app_config = self.app_configs.get(app_label) - if app_config is None: + try: + return self.app_configs[app_label] + except KeyError: raise LookupError("No installed app with label '%s'." % app_label) - if only_with_models_module and app_config.models_module is None: - raise LookupError("App '%s' doesn't have a models module." % app_label) - return app_config # This method is performance-critical at least for Django's test suite. @lru_cache.lru_cache(maxsize=None) @@ -319,11 +308,14 @@ class Apps(object): "get_app_config(app_label).models_module supersedes get_app(app_label).", PendingDeprecationWarning, stacklevel=2) try: - return self.get_app_config( - app_label, only_with_models_module=True).models_module + models_module = self.get_app_config(app_label).models_module except LookupError as exc: # Change the exception type for backwards compatibility. raise ImproperlyConfigured(*exc.args) + if models_module is None: + raise ImproperlyConfigured( + "App '%s' doesn't have a models module." % app_label) + return models_module def get_apps(self): """ @@ -332,8 +324,9 @@ class Apps(object): warnings.warn( "[a.models_module for a in get_app_configs()] supersedes get_apps().", PendingDeprecationWarning, stacklevel=2) - app_configs = self.get_app_configs(only_with_models_module=True) - return [app_config.models_module for app_config in app_configs] + app_configs = self.get_app_configs() + return [app_config.models_module for app_config in app_configs + if app_config.models_module is not None] def _get_app_package(self, app): return '.'.join(app.__name__.split('.')[:-1]) diff --git a/django/contrib/contenttypes/management.py b/django/contrib/contenttypes/management.py index 1b499d85f1..58f7da820e 100644 --- a/django/contrib/contenttypes/management.py +++ b/django/contrib/contenttypes/management.py @@ -88,7 +88,7 @@ If you're unsure, answer 'no'. def update_all_contenttypes(**kwargs): - for app_config in apps.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(): update_contenttypes(app_config, **kwargs) diff --git a/django/core/management/base.py b/django/core/management/base.py index a71cc78588..e55f777b75 100644 --- a/django/core/management/base.py +++ b/django/core/management/base.py @@ -344,9 +344,6 @@ class AppCommand(BaseCommand): from django.apps import apps if not app_labels: raise CommandError("Enter at least one application label.") - # Don't use only_with_models_module=True in get_app_config() to tell - # apart missing apps from apps without a model module -- which can't - # be supported with the legacy API since it passes the models module. try: app_configs = [apps.get_app_config(app_label) for app_label in app_labels] except (LookupError, ImportError) as e: diff --git a/django/core/management/commands/dumpdata.py b/django/core/management/commands/dumpdata.py index d4d8b54af6..1242bd4e57 100644 --- a/django/core/management/commands/dumpdata.py +++ b/django/core/management/commands/dumpdata.py @@ -82,8 +82,8 @@ class Command(BaseCommand): if primary_keys: raise CommandError("You can only use --pks option with one model") app_list = OrderedDict((app_config, None) - for app_config in apps.get_app_configs(only_with_models_module=True) - if app_config not in excluded_apps) + for app_config in apps.get_app_configs() + if app_config.models_module is not None and app_config not in excluded_apps) else: if len(app_labels) > 1 and primary_keys: raise CommandError("You can only use --pks option with one model") diff --git a/django/core/management/commands/flush.py b/django/core/management/commands/flush.py index 5b4733ecad..4a3f7c2d8b 100644 --- a/django/core/management/commands/flush.py +++ b/django/core/management/commands/flush.py @@ -93,6 +93,6 @@ Are you sure you want to do this? # Emit the post migrate signal. This allows individual applications to # respond as if the database had been migrated from scratch. all_models = [] - for app_config in apps.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(): all_models.extend(router.get_migratable_models(app_config, database, include_auto_created=True)) emit_post_migrate_signal(set(all_models), verbosity, interactive, database) diff --git a/django/core/management/commands/migrate.py b/django/core/management/commands/migrate.py index 5da5e51a48..cb863509c8 100644 --- a/django/core/management/commands/migrate.py +++ b/django/core/management/commands/migrate.py @@ -181,8 +181,8 @@ class Command(BaseCommand): all_models = [ (app_config.label, router.get_migratable_models(app_config, connection.alias, include_auto_created=True)) - for app_config in apps.get_app_configs(only_with_models_module=True) - if app_config.label in app_labels + for app_config in apps.get_app_configs() + if app_config.models_module is not None and app_config.label in app_labels ] def model_installed(model): diff --git a/django/core/management/sql.py b/django/core/management/sql.py index 4cced4f566..d2c7786390 100644 --- a/django/core/management/sql.py +++ b/django/core/management/sql.py @@ -207,7 +207,9 @@ def custom_sql_for_model(model, style, connection): def emit_pre_migrate_signal(create_models, verbosity, interactive, db): # Emit the pre_migrate signal for every application. - for app_config in apps.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(): + if app_config.models_module is None: + continue if verbosity >= 2: print("Running pre-migrate handlers for application %s" % app_config.label) models.signals.pre_migrate.send( @@ -228,7 +230,9 @@ def emit_pre_migrate_signal(create_models, verbosity, interactive, db): def emit_post_migrate_signal(created_models, verbosity, interactive, db): # Emit the post_migrate signal for every application. - for app_config in apps.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(): + if app_config.models_module is None: + continue if verbosity >= 2: print("Running post-migrate handlers for application %s" % app_config.label) models.signals.post_migrate.send( diff --git a/django/db/backends/__init__.py b/django/db/backends/__init__.py index 5b681756e9..00ae64e09b 100644 --- a/django/db/backends/__init__.py +++ b/django/db/backends/__init__.py @@ -1271,7 +1271,7 @@ class BaseDatabaseIntrospection(object): from django.apps import apps from django.db import router tables = set() - for app_config in apps.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(): for model in router.get_migratable_models(app_config, self.connection.alias): if not model._meta.managed: continue @@ -1292,7 +1292,7 @@ class BaseDatabaseIntrospection(object): from django.apps import apps from django.db import router all_models = [] - for app_config in apps.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(): all_models.extend(router.get_migratable_models(app_config, self.connection.alias)) tables = list(map(self.table_name_converter, tables)) return set([ @@ -1307,7 +1307,7 @@ class BaseDatabaseIntrospection(object): sequence_list = [] - for app_config in apps.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(): for model in router.get_migratable_models(app_config, self.connection.alias): if not model._meta.managed: continue diff --git a/django/db/migrations/loader.py b/django/db/migrations/loader.py index a3ed25793a..66d2259b79 100644 --- a/django/db/migrations/loader.py +++ b/django/db/migrations/loader.py @@ -59,7 +59,9 @@ class MigrationLoader(object): self.disk_migrations = {} self.unmigrated_apps = set() self.migrated_apps = set() - for app_config in apps.get_app_configs(only_with_models_module=True): + for app_config in apps.get_app_configs(): + if app_config.models_module is None: + continue # Get the migrations module directory module_name = self.migrations_module(app_config.label) was_loaded = module_name in sys.modules diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt index 5d9db49140..eadf9895ca 100644 --- a/docs/ref/applications.txt +++ b/docs/ref/applications.txt @@ -184,22 +184,16 @@ Application registry Returns ``True`` if the registry is fully populated. -.. method:: apps.get_app_configs(only_with_models_module=False) +.. method:: apps.get_app_configs() Returns an iterable of :class:`~django.apps.AppConfig` instances. - If only applications containing a models module are of interest, this method - can be called with ``only_with_models_module=True``. - -.. method:: apps.get_app_config(app_label, only_with_models_module=False) +.. method:: apps.get_app_config(app_label) Returns an :class:`~django.apps.AppConfig` for the application with the given ``app_label``. Raises :exc:`~exceptions.LookupError` if no such application exists. - If only applications containing a models module are of interest, this method - can be called with ``only_with_models_module=True``. - .. method:: apps.has_app(app_name) Checks whether an application with the given name exists in the registry. diff --git a/tests/apps/tests.py b/tests/apps/tests.py index 326ddcb6ab..2a41acf2e8 100644 --- a/tests/apps/tests.py +++ b/tests/apps/tests.py @@ -26,8 +26,6 @@ SOME_INSTALLED_APPS_NAMES = [ 'django.contrib.auth', ] + SOME_INSTALLED_APPS[2:] -SOME_INSTALLED_APPS_WTH_MODELS_NAMES = SOME_INSTALLED_APPS_NAMES[:4] - class AppsTests(TestCase): @@ -93,16 +91,6 @@ class AppsTests(TestCase): [app_config.name for app_config in app_configs], SOME_INSTALLED_APPS_NAMES) - @override_settings(INSTALLED_APPS=SOME_INSTALLED_APPS) - def test_get_app_configs_with_models(self): - """ - Tests get_app_configs(only_with_models_module=True). - """ - app_configs = apps.get_app_configs(only_with_models_module=True) - self.assertListEqual( - [app_config.name for app_config in app_configs], - SOME_INSTALLED_APPS_WTH_MODELS_NAMES) - @override_settings(INSTALLED_APPS=SOME_INSTALLED_APPS) def test_get_app_config(self): """ @@ -117,17 +105,6 @@ class AppsTests(TestCase): with self.assertRaises(LookupError): apps.get_app_config('webdesign') - @override_settings(INSTALLED_APPS=SOME_INSTALLED_APPS) - def test_get_app_config_with_models(self): - """ - Tests get_app_config(only_with_models_module=True). - """ - app_config = apps.get_app_config('admin', only_with_models_module=True) - self.assertEqual(app_config.name, 'django.contrib.admin') - - with self.assertRaises(LookupError): - apps.get_app_config('staticfiles', only_with_models_module=True) - @override_settings(INSTALLED_APPS=SOME_INSTALLED_APPS) def test_has_app(self): self.assertTrue(apps.has_app('django.contrib.admin')) From a5e2a0e569809b7ea0c379e12d637ef0e5c9c8b9 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 31 Dec 2013 00:08:55 +0100 Subject: [PATCH 136/208] Added release notes for today's app-loading improvements. --- docs/releases/1.7.txt | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 87fa419188..728c7e64b0 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -73,12 +73,19 @@ attach configuration data to applications. Improvements thus far include: +* Applications can run code at startup, before Django does anything else, with + the :meth:`~django.apps.AppConfig.setup` method of their configuration. + * It is possible to omit ``models.py`` entirely if an application doesn't have any models. * The name of applications can be customized in the admin with the :attr:`~django.apps.AppConfig.verbose_name` of application configurations. +* Django imports all application configurations and models as soon as it + starts, through a deterministic and straightforward process. This should + make it easier to diagnose import issues such as import loops. + New method on Field subclasses ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 0b825adcf2a4608c8fb02a19cc56dc96ef1414a1 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Tue, 31 Dec 2013 11:25:02 +0100 Subject: [PATCH 137/208] Renamed syndication tests To resolve the conflict between application names. --- tests/{syndication => syndication_tests}/__init__.py | 0 tests/{syndication => syndication_tests}/feeds.py | 0 tests/{syndication => syndication_tests}/fixtures/feeddata.json | 0 tests/{syndication => syndication_tests}/models.py | 0 .../templates/syndication/description.html | 0 .../templates/syndication/description_context.html | 0 .../templates/syndication/title.html | 0 .../templates/syndication/title_context.html | 0 tests/{syndication => syndication_tests}/tests.py | 0 tests/{syndication => syndication_tests}/urls.py | 0 10 files changed, 0 insertions(+), 0 deletions(-) rename tests/{syndication => syndication_tests}/__init__.py (100%) rename tests/{syndication => syndication_tests}/feeds.py (100%) rename tests/{syndication => syndication_tests}/fixtures/feeddata.json (100%) rename tests/{syndication => syndication_tests}/models.py (100%) rename tests/{syndication => syndication_tests}/templates/syndication/description.html (100%) rename tests/{syndication => syndication_tests}/templates/syndication/description_context.html (100%) rename tests/{syndication => syndication_tests}/templates/syndication/title.html (100%) rename tests/{syndication => syndication_tests}/templates/syndication/title_context.html (100%) rename tests/{syndication => syndication_tests}/tests.py (100%) rename tests/{syndication => syndication_tests}/urls.py (100%) diff --git a/tests/syndication/__init__.py b/tests/syndication_tests/__init__.py similarity index 100% rename from tests/syndication/__init__.py rename to tests/syndication_tests/__init__.py diff --git a/tests/syndication/feeds.py b/tests/syndication_tests/feeds.py similarity index 100% rename from tests/syndication/feeds.py rename to tests/syndication_tests/feeds.py diff --git a/tests/syndication/fixtures/feeddata.json b/tests/syndication_tests/fixtures/feeddata.json similarity index 100% rename from tests/syndication/fixtures/feeddata.json rename to tests/syndication_tests/fixtures/feeddata.json diff --git a/tests/syndication/models.py b/tests/syndication_tests/models.py similarity index 100% rename from tests/syndication/models.py rename to tests/syndication_tests/models.py diff --git a/tests/syndication/templates/syndication/description.html b/tests/syndication_tests/templates/syndication/description.html similarity index 100% rename from tests/syndication/templates/syndication/description.html rename to tests/syndication_tests/templates/syndication/description.html diff --git a/tests/syndication/templates/syndication/description_context.html b/tests/syndication_tests/templates/syndication/description_context.html similarity index 100% rename from tests/syndication/templates/syndication/description_context.html rename to tests/syndication_tests/templates/syndication/description_context.html diff --git a/tests/syndication/templates/syndication/title.html b/tests/syndication_tests/templates/syndication/title.html similarity index 100% rename from tests/syndication/templates/syndication/title.html rename to tests/syndication_tests/templates/syndication/title.html diff --git a/tests/syndication/templates/syndication/title_context.html b/tests/syndication_tests/templates/syndication/title_context.html similarity index 100% rename from tests/syndication/templates/syndication/title_context.html rename to tests/syndication_tests/templates/syndication/title_context.html diff --git a/tests/syndication/tests.py b/tests/syndication_tests/tests.py similarity index 100% rename from tests/syndication/tests.py rename to tests/syndication_tests/tests.py diff --git a/tests/syndication/urls.py b/tests/syndication_tests/urls.py similarity index 100% rename from tests/syndication/urls.py rename to tests/syndication_tests/urls.py From 7b119c1c77c8e0d17b55088f83a1552c73ceb31c Mon Sep 17 00:00:00 2001 From: Thomas Schreiber Date: Tue, 31 Dec 2013 03:31:21 +0100 Subject: [PATCH 138/208] only attempt to create the postgis extension when it does not already exist --- django/contrib/gis/db/backends/postgis/creation.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/django/contrib/gis/db/backends/postgis/creation.py b/django/contrib/gis/db/backends/postgis/creation.py index 4f64ecce29..51ac197b8e 100644 --- a/django/contrib/gis/db/backends/postgis/creation.py +++ b/django/contrib/gis/db/backends/postgis/creation.py @@ -89,7 +89,7 @@ class PostGISCreation(DatabaseCreation): self.connection.close() self.connection.settings_dict["NAME"] = test_database_name cursor = self.connection.cursor() - cursor.execute("CREATE EXTENSION postgis") + cursor.execute("CREATE EXTENSION IF NOT EXISTS postgis") cursor.connection.commit() return test_database_name From 1fb873cd6bb1867b71151bcf0c84ba8ebd205326 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Tue, 31 Dec 2013 11:56:41 +0100 Subject: [PATCH 139/208] Finished renaming syndication to syndication_tests --- tests/syndication_tests/fixtures/feeddata.json | 12 ++++++------ tests/syndication_tests/tests.py | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/tests/syndication_tests/fixtures/feeddata.json b/tests/syndication_tests/fixtures/feeddata.json index 52e5028fcd..b273e21cae 100644 --- a/tests/syndication_tests/fixtures/feeddata.json +++ b/tests/syndication_tests/fixtures/feeddata.json @@ -1,6 +1,6 @@ [ { - "model": "syndication.entry", + "model": "syndication_tests.entry", "pk": 1, "fields": { "title": "My first entry", @@ -9,7 +9,7 @@ } }, { - "model": "syndication.entry", + "model": "syndication_tests.entry", "pk": 2, "fields": { "title": "My second entry", @@ -18,7 +18,7 @@ } }, { - "model": "syndication.entry", + "model": "syndication_tests.entry", "pk": 3, "fields": { "title": "My third entry", @@ -27,7 +27,7 @@ } }, { - "model": "syndication.entry", + "model": "syndication_tests.entry", "pk": 4, "fields": { "title": "A & B < C > D", @@ -36,7 +36,7 @@ } }, { - "model": "syndication.entry", + "model": "syndication_tests.entry", "pk": 5, "fields": { "title": "My last entry", @@ -45,7 +45,7 @@ } }, { - "model": "syndication.article", + "model": "syndication_tests.article", "pk": 1, "fields": { "title": "My first article", diff --git a/tests/syndication_tests/tests.py b/tests/syndication_tests/tests.py index a3b75369be..b5d1ec4bfc 100644 --- a/tests/syndication_tests/tests.py +++ b/tests/syndication_tests/tests.py @@ -54,7 +54,7 @@ class SyndicationFeedTest(FeedTestCase): """ Tests for the high-level syndication feed framework. """ - urls = 'syndication.urls' + urls = 'syndication_tests.urls' def test_rss2_feed(self): """ From 6b172a6d6dcfe88be4dc0e5052707a756c1c830c Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 31 Dec 2013 13:09:47 +0100 Subject: [PATCH 140/208] Called django.setup() explicitly in management commands. This avoids duplicating code. --- django/core/management/__init__.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/django/core/management/__init__.py b/django/core/management/__init__.py index 2a4fd96fc7..fcd7c7ccd8 100644 --- a/django/core/management/__init__.py +++ b/django/core/management/__init__.py @@ -5,6 +5,7 @@ from optparse import OptionParser, NO_DEFAULT import os import sys +import django from django.conf import settings from django.core.exceptions import ImproperlyConfigured from django.core.management.base import BaseCommand, CommandError, handle_default_options @@ -111,17 +112,16 @@ def get_commands(): # Find the installed apps try: - installed_apps = settings.INSTALLED_APPS + settings.INSTALLED_APPS except ImproperlyConfigured: # Still useful for commands that do not require functional # settings, like startproject or help. app_names = [] else: - # Populate the app registry outside of the try/except block to - # avoid catching ImproperlyConfigured errors that aren't caused - # by the absence of a settings module. - from django.apps import apps - apps.populate(installed_apps) + # Setup Django outside of the try/except block to avoid catching + # ImproperlyConfigured errors that aren't caused by the absence of + # a settings module. + django.setup() app_configs = apps.get_app_configs() app_names = [app_config.name for app_config in app_configs] From 587b678d41e481294a302a8467121162bf06f274 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Tue, 31 Dec 2013 13:12:30 +0100 Subject: [PATCH 141/208] Made DeprecationDisplayTest more robust --- tests/test_runner/tests.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tests/test_runner/tests.py b/tests/test_runner/tests.py index 0daf4ab3b7..2066181c67 100644 --- a/tests/test_runner/tests.py +++ b/tests/test_runner/tests.py @@ -364,12 +364,14 @@ class DeprecationDisplayTest(AdminScriptTestCase): def test_runner_deprecation_verbosity_default(self): args = ['test', '--settings=test_project.settings', 'test_runner_deprecation_app'] out, err = self.run_django_admin(args) + self.assertIn("Ran 1 test", err) self.assertIn("DeprecationWarning: warning from test", err) self.assertIn("DeprecationWarning: module-level warning from deprecation_app", err) def test_runner_deprecation_verbosity_zero(self): - args = ['test', '--settings=settings', '--verbosity=0'] + args = ['test', '--settings=test_project.settings', '--verbosity=0', 'test_runner_deprecation_app'] out, err = self.run_django_admin(args) + self.assertIn("Ran 1 test", err) self.assertFalse("DeprecationWarning: warning from test" in err) From a95f74e7078e2f38935e3de5e3229b8ff585ae00 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 31 Dec 2013 13:16:34 +0100 Subject: [PATCH 142/208] Oops. --- django/core/management/__init__.py | 1 + 1 file changed, 1 insertion(+) diff --git a/django/core/management/__init__.py b/django/core/management/__init__.py index fcd7c7ccd8..3d6482f236 100644 --- a/django/core/management/__init__.py +++ b/django/core/management/__init__.py @@ -6,6 +6,7 @@ import os import sys import django +from django.apps import apps from django.conf import settings from django.core.exceptions import ImproperlyConfigured from django.core.management.base import BaseCommand, CommandError, handle_default_options From 9953e98e6ad9298869cd12e20bd3c05c0d19fa10 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Tue, 31 Dec 2013 06:24:11 -0500 Subject: [PATCH 143/208] Fixed #21701 -- Improved testing doc titles and added testing/tools.txt. Thanks cjerdonek for the suggestion. --- .../contributing/writing-code/unit-tests.txt | 4 +- docs/intro/contributing.txt | 2 +- docs/topics/email.txt | 5 +- docs/topics/testing/index.txt | 16 +- docs/topics/testing/overview.txt | 1605 +---------------- docs/topics/testing/tools.txt | 1596 ++++++++++++++++ 6 files changed, 1614 insertions(+), 1614 deletions(-) create mode 100644 docs/topics/testing/tools.txt diff --git a/docs/internals/contributing/writing-code/unit-tests.txt b/docs/internals/contributing/writing-code/unit-tests.txt index d6a031b3ae..36f767614a 100644 --- a/docs/internals/contributing/writing-code/unit-tests.txt +++ b/docs/internals/contributing/writing-code/unit-tests.txt @@ -13,8 +13,8 @@ The tests cover: We appreciate any and all contributions to the test suite! The Django tests all use the testing infrastructure that ships with Django for -testing applications. See :doc:`Testing Django applications -` for an explanation of how to write new tests. +testing applications. See :doc:`/topics/testing/overview` for an explanation of +how to write new tests. .. _running-unit-tests: diff --git a/docs/intro/contributing.txt b/docs/intro/contributing.txt index 8a16a9b0d0..7250f9e676 100644 --- a/docs/intro/contributing.txt +++ b/docs/intro/contributing.txt @@ -281,7 +281,7 @@ correctly in a couple different situations. computer programming, so there's lots of information out there: * A good first look at writing tests for Django can be found in the - documentation on :doc:`Testing Django applications `. + documentation on :doc:`/topics/testing/overview`. * Dive Into Python (a free online book for beginning Python developers) includes a great `introduction to Unit Testing`__. * After reading those, if you want something a little meatier to sink diff --git a/docs/topics/email.txt b/docs/topics/email.txt index 058a007721..6b93d7d2b8 100644 --- a/docs/topics/email.txt +++ b/docs/topics/email.txt @@ -629,6 +629,5 @@ the email body. You then only need to set the :setting:`EMAIL_HOST` and :setting:`EMAIL_PORT` accordingly. For a more detailed discussion of SMTP server options, see the Python documentation for the :mod:`smtpd` module. -For information about unit-testing the sending of emails in your -application, see the :ref:`topics-testing-email` section of :doc:`Testing -Django applications `. +For information about unit-testing the sending of emails in your application, +see the :ref:`topics-testing-email` section of the testing documentation. diff --git a/docs/topics/testing/index.txt b/docs/topics/testing/index.txt index 1a99a399b4..e8cab96277 100644 --- a/docs/topics/testing/index.txt +++ b/docs/topics/testing/index.txt @@ -2,12 +2,6 @@ Testing in Django ================= -.. toctree:: - :hidden: - - overview - advanced - Automated testing is an extremely useful bug-killing tool for the modern Web developer. You can use a collection of tests -- a **test suite** -- to solve, or avoid, a number of problems: @@ -28,9 +22,6 @@ it should be doing. The best part is, it's really easy. -Where to go from here -===================== - The preferred way to write tests in Django is using the :mod:`unittest` module built in to the Python standard library. This is covered in detail in the :doc:`overview` document. @@ -38,3 +29,10 @@ built in to the Python standard library. This is covered in detail in the You can also use any *other* Python test framework; Django provides an API and tools for that kind of integration. They are described in the :ref:`other-testing-frameworks` section of :doc:`advanced`. + +.. toctree:: + :maxdepth: 1 + + overview + tools + advanced diff --git a/docs/topics/testing/overview.txt b/docs/topics/testing/overview.txt index 3bdb13c28f..078c2a1da9 100644 --- a/docs/topics/testing/overview.txt +++ b/docs/topics/testing/overview.txt @@ -1,14 +1,15 @@ -=========================== -Testing Django applications -=========================== +========================= +Writing and running tests +========================= .. module:: django.test :synopsis: Testing tools for Django applications. .. seealso:: - The :doc:`testing tutorial ` and the - :doc:`advanced testing topics `. + The :doc:`testing tutorial `, the :doc:`testing tools + reference `, and the :doc:`advanced testing topics + `. This document is split into two primary sections. First, we explain how to write tests with Django. Then, we explain how to run them. @@ -302,1597 +303,3 @@ to a faster hashing algorithm:: Don't forget to also include in :setting:`PASSWORD_HASHERS` any hashing algorithm used in fixtures, if any. - -Testing tools -============= - -Django provides a small set of tools that come in handy when writing tests. - -.. _test-client: - -The test client ---------------- - -The test client is a Python class that acts as a dummy Web browser, allowing -you to test your views and interact with your Django-powered application -programmatically. - -Some of the things you can do with the test client are: - -* Simulate GET and POST requests on a URL and observe the response -- - everything from low-level HTTP (result headers and status codes) to - page content. - -* See the chain of redirects (if any) and check the URL and status code at - each step. - -* Test that a given request is rendered by a given Django template, with - a template context that contains certain values. - -Note that the test client is not intended to be a replacement for Selenium_ or -other "in-browser" frameworks. Django's test client has a different focus. In -short: - -* Use Django's test client to establish that the correct template is being - rendered and that the template is passed the correct context data. - -* Use in-browser frameworks like Selenium_ to test *rendered* HTML and the - *behavior* of Web pages, namely JavaScript functionality. Django also - provides special support for those frameworks; see the section on - :class:`~django.test.LiveServerTestCase` for more details. - -A comprehensive test suite should use a combination of both test types. - -Overview and a quick example -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To use the test client, instantiate ``django.test.Client`` and retrieve -Web pages:: - - >>> from django.test import Client - >>> c = Client() - >>> response = c.post('/login/', {'username': 'john', 'password': 'smith'}) - >>> response.status_code - 200 - >>> response = c.get('/customer/details/') - >>> response.content - '>> c.get('/login/') - - This is incorrect:: - - >>> c.get('http://www.example.com/login/') - - The test client is not capable of retrieving Web pages that are not - powered by your Django project. If you need to retrieve other Web pages, - use a Python standard library module such as :mod:`urllib` or - :mod:`urllib2`. - -* To resolve URLs, the test client uses whatever URLconf is pointed-to by - your :setting:`ROOT_URLCONF` setting. - -* Although the above example would work in the Python interactive - interpreter, some of the test client's functionality, notably the - template-related functionality, is only available *while tests are - running*. - - The reason for this is that Django's test runner performs a bit of black - magic in order to determine which template was loaded by a given view. - This black magic (essentially a patching of Django's template system in - memory) only happens during test running. - -* By default, the test client will disable any CSRF checks - performed by your site. - - If, for some reason, you *want* the test client to perform CSRF - checks, you can create an instance of the test client that - enforces CSRF checks. To do this, pass in the - ``enforce_csrf_checks`` argument when you construct your - client:: - - >>> from django.test import Client - >>> csrf_client = Client(enforce_csrf_checks=True) - -Making requests -~~~~~~~~~~~~~~~ - -Use the ``django.test.Client`` class to make requests. - -.. class:: Client(enforce_csrf_checks=False, **defaults) - - It requires no arguments at time of construction. However, you can use - keywords arguments to specify some default headers. For example, this will - send a ``User-Agent`` HTTP header in each request:: - - >>> c = Client(HTTP_USER_AGENT='Mozilla/5.0') - - The values from the ``extra`` keywords arguments passed to - :meth:`~django.test.Client.get()`, - :meth:`~django.test.Client.post()`, etc. have precedence over - the defaults passed to the class constructor. - - The ``enforce_csrf_checks`` argument can be used to test CSRF - protection (see above). - - Once you have a ``Client`` instance, you can call any of the following - methods: - - .. method:: Client.get(path, data={}, follow=False, secure=False, **extra) - - .. versionadded:: 1.7 - - The ``secure`` argument was added. - - Makes a GET request on the provided ``path`` and returns a ``Response`` - object, which is documented below. - - The key-value pairs in the ``data`` dictionary are used to create a GET - data payload. For example:: - - >>> c = Client() - >>> c.get('/customers/details/', {'name': 'fred', 'age': 7}) - - ...will result in the evaluation of a GET request equivalent to:: - - /customers/details/?name=fred&age=7 - - The ``extra`` keyword arguments parameter can be used to specify - headers to be sent in the request. For example:: - - >>> c = Client() - >>> c.get('/customers/details/', {'name': 'fred', 'age': 7}, - ... HTTP_X_REQUESTED_WITH='XMLHttpRequest') - - ...will send the HTTP header ``HTTP_X_REQUESTED_WITH`` to the - details view, which is a good way to test code paths that use the - :meth:`django.http.HttpRequest.is_ajax()` method. - - .. admonition:: CGI specification - - The headers sent via ``**extra`` should follow CGI_ specification. - For example, emulating a different "Host" header as sent in the - HTTP request from the browser to the server should be passed - as ``HTTP_HOST``. - - .. _CGI: http://www.w3.org/CGI/ - - If you already have the GET arguments in URL-encoded form, you can - use that encoding instead of using the data argument. For example, - the previous GET request could also be posed as:: - - >>> c = Client() - >>> c.get('/customers/details/?name=fred&age=7') - - If you provide a URL with both an encoded GET data and a data argument, - the data argument will take precedence. - - If you set ``follow`` to ``True`` the client will follow any redirects - and a ``redirect_chain`` attribute will be set in the response object - containing tuples of the intermediate urls and status codes. - - If you had a URL ``/redirect_me/`` that redirected to ``/next/``, that - redirected to ``/final/``, this is what you'd see:: - - >>> response = c.get('/redirect_me/', follow=True) - >>> response.redirect_chain - [(u'http://testserver/next/', 302), (u'http://testserver/final/', 302)] - - If you set ``secure`` to ``True`` the client will emulate an HTTPS - request. - - .. method:: Client.post(path, data={}, content_type=MULTIPART_CONTENT, follow=False, secure=False, **extra) - - Makes a POST request on the provided ``path`` and returns a - ``Response`` object, which is documented below. - - The key-value pairs in the ``data`` dictionary are used to submit POST - data. For example:: - - >>> c = Client() - >>> c.post('/login/', {'name': 'fred', 'passwd': 'secret'}) - - ...will result in the evaluation of a POST request to this URL:: - - /login/ - - ...with this POST data:: - - name=fred&passwd=secret - - If you provide ``content_type`` (e.g. :mimetype:`text/xml` for an XML - payload), the contents of ``data`` will be sent as-is in the POST - request, using ``content_type`` in the HTTP ``Content-Type`` header. - - If you don't provide a value for ``content_type``, the values in - ``data`` will be transmitted with a content type of - :mimetype:`multipart/form-data`. In this case, the key-value pairs in - ``data`` will be encoded as a multipart message and used to create the - POST data payload. - - To submit multiple values for a given key -- for example, to specify - the selections for a ``', - '') - - ``html1`` and ``html2`` must be valid HTML. An ``AssertionError`` will be - raised if one of them cannot be parsed. - - Output in case of error can be customized with the ``msg`` argument. - -.. method:: SimpleTestCase.assertHTMLNotEqual(html1, html2, msg=None) - - Asserts that the strings ``html1`` and ``html2`` are *not* equal. The - comparison is based on HTML semantics. See - :meth:`~SimpleTestCase.assertHTMLEqual` for details. - - ``html1`` and ``html2`` must be valid HTML. An ``AssertionError`` will be - raised if one of them cannot be parsed. - - Output in case of error can be customized with the ``msg`` argument. - -.. method:: SimpleTestCase.assertXMLEqual(xml1, xml2, msg=None) - - Asserts that the strings ``xml1`` and ``xml2`` are equal. The - comparison is based on XML semantics. Similarly to - :meth:`~SimpleTestCase.assertHTMLEqual`, the comparison is - made on parsed content, hence only semantic differences are considered, not - syntax differences. When unvalid XML is passed in any parameter, an - ``AssertionError`` is always raised, even if both string are identical. - - Output in case of error can be customized with the ``msg`` argument. - -.. method:: SimpleTestCase.assertXMLNotEqual(xml1, xml2, msg=None) - - Asserts that the strings ``xml1`` and ``xml2`` are *not* equal. The - comparison is based on XML semantics. See - :meth:`~SimpleTestCase.assertXMLEqual` for details. - - Output in case of error can be customized with the ``msg`` argument. - -.. method:: SimpleTestCase.assertInHTML(needle, haystack, count=None, msg_prefix='') - - Asserts that the HTML fragment ``needle`` is contained in the ``haystack`` one. - - If the ``count`` integer argument is specified, then additionally the number - of ``needle`` occurrences will be strictly verified. - - Whitespace in most cases is ignored, and attribute ordering is not - significant. The passed-in arguments must be valid HTML. - -.. method:: SimpleTestCase.assertJSONEqual(raw, expected_data, msg=None) - - Asserts that the JSON fragments ``raw`` and ``expected_data`` are equal. - Usual JSON non-significant whitespace rules apply as the heavyweight is - delegated to the :mod:`json` library. - - Output in case of error can be customized with the ``msg`` argument. - -.. method:: TransactionTestCase.assertQuerysetEqual(qs, values, transform=repr, ordered=True) - - Asserts that a queryset ``qs`` returns a particular list of values ``values``. - - The comparison of the contents of ``qs`` and ``values`` is performed using - the function ``transform``; by default, this means that the ``repr()`` of - each value is compared. Any other callable can be used if ``repr()`` doesn't - provide a unique or helpful comparison. - - By default, the comparison is also ordering dependent. If ``qs`` doesn't - provide an implicit ordering, you can set the ``ordered`` parameter to - ``False``, which turns the comparison into a Python set comparison. - - .. versionchanged:: 1.6 - - The method now checks for undefined order and raises ``ValueError`` - if undefined order is spotted. The ordering is seen as undefined if - the given ``qs`` isn't ordered and the comparison is against more - than one ordered values. - -.. method:: TransactionTestCase.assertNumQueries(num, func, *args, **kwargs) - - Asserts that when ``func`` is called with ``*args`` and ``**kwargs`` that - ``num`` database queries are executed. - - If a ``"using"`` key is present in ``kwargs`` it is used as the database - alias for which to check the number of queries. If you wish to call a - function with a ``using`` parameter you can do it by wrapping the call with - a ``lambda`` to add an extra parameter:: - - self.assertNumQueries(7, lambda: my_function(using=7)) - - You can also use this as a context manager:: - - with self.assertNumQueries(2): - Person.objects.create(name="Aaron") - Person.objects.create(name="Daniel") - -.. _topics-testing-email: - -Email services --------------- - -If any of your Django views send email using :doc:`Django's email -functionality `, you probably don't want to send email each time -you run a test using that view. For this reason, Django's test runner -automatically redirects all Django-sent email to a dummy outbox. This lets you -test every aspect of sending email -- from the number of messages sent to the -contents of each message -- without actually sending the messages. - -The test runner accomplishes this by transparently replacing the normal -email backend with a testing backend. -(Don't worry -- this has no effect on any other email senders outside of -Django, such as your machine's mail server, if you're running one.) - -.. currentmodule:: django.core.mail - -.. data:: django.core.mail.outbox - -During test running, each outgoing email is saved in -``django.core.mail.outbox``. This is a simple list of all -:class:`~django.core.mail.EmailMessage` instances that have been sent. -The ``outbox`` attribute is a special attribute that is created *only* when -the ``locmem`` email backend is used. It doesn't normally exist as part of the -:mod:`django.core.mail` module and you can't import it directly. The code -below shows how to access this attribute correctly. - -Here's an example test that examines ``django.core.mail.outbox`` for length -and contents:: - - from django.core import mail - from django.test import TestCase - - class EmailTest(TestCase): - def test_send_email(self): - # Send message. - mail.send_mail('Subject here', 'Here is the message.', - 'from@example.com', ['to@example.com'], - fail_silently=False) - - # Test that one message has been sent. - self.assertEqual(len(mail.outbox), 1) - - # Verify that the subject of the first message is correct. - self.assertEqual(mail.outbox[0].subject, 'Subject here') - -As noted :ref:`previously `, the test outbox is emptied -at the start of every test in a Django ``*TestCase``. To empty the outbox -manually, assign the empty list to ``mail.outbox``:: - - from django.core import mail - - # Empty the test outbox - mail.outbox = [] - -.. _skipping-tests: - -Skipping tests --------------- - -.. currentmodule:: django.test - -The unittest library provides the :func:`@skipIf ` and -:func:`@skipUnless ` decorators to allow you to skip tests -if you know ahead of time that those tests are going to fail under certain -conditions. - -For example, if your test requires a particular optional library in order to -succeed, you could decorate the test case with :func:`@skipIf -`. Then, the test runner will report that the test wasn't -executed and why, instead of failing the test or omitting the test altogether. - -To supplement these test skipping behaviors, Django provides two -additional skip decorators. Instead of testing a generic boolean, -these decorators check the capabilities of the database, and skip the -test if the database doesn't support a specific named feature. - -The decorators use a string identifier to describe database features. -This string corresponds to attributes of the database connection -features class. See ``django.db.backends.BaseDatabaseFeatures`` -class for a full list of database features that can be used as a basis -for skipping tests. - -.. function:: skipIfDBFeature(feature_name_string) - -Skip the decorated test or ``TestCase`` if the named database feature is -supported. - -For example, the following test will not be executed if the database -supports transactions (e.g., it would *not* run under PostgreSQL, but -it would under MySQL with MyISAM tables):: - - class MyTests(TestCase): - @skipIfDBFeature('supports_transactions') - def test_transaction_behavior(self): - # ... conditional test code - -.. versionchanged:: 1.7 - - ``skipIfDBFeature`` can now be used to decorate a ``TestCase`` class. - -.. function:: skipUnlessDBFeature(feature_name_string) - -Skip the decorated test or ``TestCase`` if the named database feature is *not* -supported. - -For example, the following test will only be executed if the database -supports transactions (e.g., it would run under PostgreSQL, but *not* -under MySQL with MyISAM tables):: - - class MyTests(TestCase): - @skipUnlessDBFeature('supports_transactions') - def test_transaction_behavior(self): - # ... conditional test code - -.. versionchanged:: 1.7 - - ``skipUnlessDBFeature`` can now be used to decorate a ``TestCase`` class. diff --git a/docs/topics/testing/tools.txt b/docs/topics/testing/tools.txt new file mode 100644 index 0000000000..d97644fb72 --- /dev/null +++ b/docs/topics/testing/tools.txt @@ -0,0 +1,1596 @@ +============= +Testing tools +============= + +.. currentmodule:: django.test + +Django provides a small set of tools that come in handy when writing tests. + +.. _test-client: + +The test client +--------------- + +The test client is a Python class that acts as a dummy Web browser, allowing +you to test your views and interact with your Django-powered application +programmatically. + +Some of the things you can do with the test client are: + +* Simulate GET and POST requests on a URL and observe the response -- + everything from low-level HTTP (result headers and status codes) to + page content. + +* See the chain of redirects (if any) and check the URL and status code at + each step. + +* Test that a given request is rendered by a given Django template, with + a template context that contains certain values. + +Note that the test client is not intended to be a replacement for Selenium_ or +other "in-browser" frameworks. Django's test client has a different focus. In +short: + +* Use Django's test client to establish that the correct template is being + rendered and that the template is passed the correct context data. + +* Use in-browser frameworks like Selenium_ to test *rendered* HTML and the + *behavior* of Web pages, namely JavaScript functionality. Django also + provides special support for those frameworks; see the section on + :class:`~django.test.LiveServerTestCase` for more details. + +A comprehensive test suite should use a combination of both test types. + +Overview and a quick example +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To use the test client, instantiate ``django.test.Client`` and retrieve +Web pages:: + + >>> from django.test import Client + >>> c = Client() + >>> response = c.post('/login/', {'username': 'john', 'password': 'smith'}) + >>> response.status_code + 200 + >>> response = c.get('/customer/details/') + >>> response.content + '>> c.get('/login/') + + This is incorrect:: + + >>> c.get('http://www.example.com/login/') + + The test client is not capable of retrieving Web pages that are not + powered by your Django project. If you need to retrieve other Web pages, + use a Python standard library module such as :mod:`urllib` or + :mod:`urllib2`. + +* To resolve URLs, the test client uses whatever URLconf is pointed-to by + your :setting:`ROOT_URLCONF` setting. + +* Although the above example would work in the Python interactive + interpreter, some of the test client's functionality, notably the + template-related functionality, is only available *while tests are + running*. + + The reason for this is that Django's test runner performs a bit of black + magic in order to determine which template was loaded by a given view. + This black magic (essentially a patching of Django's template system in + memory) only happens during test running. + +* By default, the test client will disable any CSRF checks + performed by your site. + + If, for some reason, you *want* the test client to perform CSRF + checks, you can create an instance of the test client that + enforces CSRF checks. To do this, pass in the + ``enforce_csrf_checks`` argument when you construct your + client:: + + >>> from django.test import Client + >>> csrf_client = Client(enforce_csrf_checks=True) + +Making requests +~~~~~~~~~~~~~~~ + +Use the ``django.test.Client`` class to make requests. + +.. class:: Client(enforce_csrf_checks=False, **defaults) + + It requires no arguments at time of construction. However, you can use + keywords arguments to specify some default headers. For example, this will + send a ``User-Agent`` HTTP header in each request:: + + >>> c = Client(HTTP_USER_AGENT='Mozilla/5.0') + + The values from the ``extra`` keywords arguments passed to + :meth:`~django.test.Client.get()`, + :meth:`~django.test.Client.post()`, etc. have precedence over + the defaults passed to the class constructor. + + The ``enforce_csrf_checks`` argument can be used to test CSRF + protection (see above). + + Once you have a ``Client`` instance, you can call any of the following + methods: + + .. method:: Client.get(path, data={}, follow=False, secure=False, **extra) + + .. versionadded:: 1.7 + + The ``secure`` argument was added. + + Makes a GET request on the provided ``path`` and returns a ``Response`` + object, which is documented below. + + The key-value pairs in the ``data`` dictionary are used to create a GET + data payload. For example:: + + >>> c = Client() + >>> c.get('/customers/details/', {'name': 'fred', 'age': 7}) + + ...will result in the evaluation of a GET request equivalent to:: + + /customers/details/?name=fred&age=7 + + The ``extra`` keyword arguments parameter can be used to specify + headers to be sent in the request. For example:: + + >>> c = Client() + >>> c.get('/customers/details/', {'name': 'fred', 'age': 7}, + ... HTTP_X_REQUESTED_WITH='XMLHttpRequest') + + ...will send the HTTP header ``HTTP_X_REQUESTED_WITH`` to the + details view, which is a good way to test code paths that use the + :meth:`django.http.HttpRequest.is_ajax()` method. + + .. admonition:: CGI specification + + The headers sent via ``**extra`` should follow CGI_ specification. + For example, emulating a different "Host" header as sent in the + HTTP request from the browser to the server should be passed + as ``HTTP_HOST``. + + .. _CGI: http://www.w3.org/CGI/ + + If you already have the GET arguments in URL-encoded form, you can + use that encoding instead of using the data argument. For example, + the previous GET request could also be posed as:: + + >>> c = Client() + >>> c.get('/customers/details/?name=fred&age=7') + + If you provide a URL with both an encoded GET data and a data argument, + the data argument will take precedence. + + If you set ``follow`` to ``True`` the client will follow any redirects + and a ``redirect_chain`` attribute will be set in the response object + containing tuples of the intermediate urls and status codes. + + If you had a URL ``/redirect_me/`` that redirected to ``/next/``, that + redirected to ``/final/``, this is what you'd see:: + + >>> response = c.get('/redirect_me/', follow=True) + >>> response.redirect_chain + [(u'http://testserver/next/', 302), (u'http://testserver/final/', 302)] + + If you set ``secure`` to ``True`` the client will emulate an HTTPS + request. + + .. method:: Client.post(path, data={}, content_type=MULTIPART_CONTENT, follow=False, secure=False, **extra) + + Makes a POST request on the provided ``path`` and returns a + ``Response`` object, which is documented below. + + The key-value pairs in the ``data`` dictionary are used to submit POST + data. For example:: + + >>> c = Client() + >>> c.post('/login/', {'name': 'fred', 'passwd': 'secret'}) + + ...will result in the evaluation of a POST request to this URL:: + + /login/ + + ...with this POST data:: + + name=fred&passwd=secret + + If you provide ``content_type`` (e.g. :mimetype:`text/xml` for an XML + payload), the contents of ``data`` will be sent as-is in the POST + request, using ``content_type`` in the HTTP ``Content-Type`` header. + + If you don't provide a value for ``content_type``, the values in + ``data`` will be transmitted with a content type of + :mimetype:`multipart/form-data`. In this case, the key-value pairs in + ``data`` will be encoded as a multipart message and used to create the + POST data payload. + + To submit multiple values for a given key -- for example, to specify + the selections for a ``', + '') + + ``html1`` and ``html2`` must be valid HTML. An ``AssertionError`` will be + raised if one of them cannot be parsed. + + Output in case of error can be customized with the ``msg`` argument. + +.. method:: SimpleTestCase.assertHTMLNotEqual(html1, html2, msg=None) + + Asserts that the strings ``html1`` and ``html2`` are *not* equal. The + comparison is based on HTML semantics. See + :meth:`~SimpleTestCase.assertHTMLEqual` for details. + + ``html1`` and ``html2`` must be valid HTML. An ``AssertionError`` will be + raised if one of them cannot be parsed. + + Output in case of error can be customized with the ``msg`` argument. + +.. method:: SimpleTestCase.assertXMLEqual(xml1, xml2, msg=None) + + Asserts that the strings ``xml1`` and ``xml2`` are equal. The + comparison is based on XML semantics. Similarly to + :meth:`~SimpleTestCase.assertHTMLEqual`, the comparison is + made on parsed content, hence only semantic differences are considered, not + syntax differences. When unvalid XML is passed in any parameter, an + ``AssertionError`` is always raised, even if both string are identical. + + Output in case of error can be customized with the ``msg`` argument. + +.. method:: SimpleTestCase.assertXMLNotEqual(xml1, xml2, msg=None) + + Asserts that the strings ``xml1`` and ``xml2`` are *not* equal. The + comparison is based on XML semantics. See + :meth:`~SimpleTestCase.assertXMLEqual` for details. + + Output in case of error can be customized with the ``msg`` argument. + +.. method:: SimpleTestCase.assertInHTML(needle, haystack, count=None, msg_prefix='') + + Asserts that the HTML fragment ``needle`` is contained in the ``haystack`` one. + + If the ``count`` integer argument is specified, then additionally the number + of ``needle`` occurrences will be strictly verified. + + Whitespace in most cases is ignored, and attribute ordering is not + significant. The passed-in arguments must be valid HTML. + +.. method:: SimpleTestCase.assertJSONEqual(raw, expected_data, msg=None) + + Asserts that the JSON fragments ``raw`` and ``expected_data`` are equal. + Usual JSON non-significant whitespace rules apply as the heavyweight is + delegated to the :mod:`json` library. + + Output in case of error can be customized with the ``msg`` argument. + +.. method:: TransactionTestCase.assertQuerysetEqual(qs, values, transform=repr, ordered=True) + + Asserts that a queryset ``qs`` returns a particular list of values ``values``. + + The comparison of the contents of ``qs`` and ``values`` is performed using + the function ``transform``; by default, this means that the ``repr()`` of + each value is compared. Any other callable can be used if ``repr()`` doesn't + provide a unique or helpful comparison. + + By default, the comparison is also ordering dependent. If ``qs`` doesn't + provide an implicit ordering, you can set the ``ordered`` parameter to + ``False``, which turns the comparison into a Python set comparison. + + .. versionchanged:: 1.6 + + The method now checks for undefined order and raises ``ValueError`` + if undefined order is spotted. The ordering is seen as undefined if + the given ``qs`` isn't ordered and the comparison is against more + than one ordered values. + +.. method:: TransactionTestCase.assertNumQueries(num, func, *args, **kwargs) + + Asserts that when ``func`` is called with ``*args`` and ``**kwargs`` that + ``num`` database queries are executed. + + If a ``"using"`` key is present in ``kwargs`` it is used as the database + alias for which to check the number of queries. If you wish to call a + function with a ``using`` parameter you can do it by wrapping the call with + a ``lambda`` to add an extra parameter:: + + self.assertNumQueries(7, lambda: my_function(using=7)) + + You can also use this as a context manager:: + + with self.assertNumQueries(2): + Person.objects.create(name="Aaron") + Person.objects.create(name="Daniel") + +.. _topics-testing-email: + +Email services +-------------- + +If any of your Django views send email using :doc:`Django's email +functionality `, you probably don't want to send email each time +you run a test using that view. For this reason, Django's test runner +automatically redirects all Django-sent email to a dummy outbox. This lets you +test every aspect of sending email -- from the number of messages sent to the +contents of each message -- without actually sending the messages. + +The test runner accomplishes this by transparently replacing the normal +email backend with a testing backend. +(Don't worry -- this has no effect on any other email senders outside of +Django, such as your machine's mail server, if you're running one.) + +.. currentmodule:: django.core.mail + +.. data:: django.core.mail.outbox + +During test running, each outgoing email is saved in +``django.core.mail.outbox``. This is a simple list of all +:class:`~django.core.mail.EmailMessage` instances that have been sent. +The ``outbox`` attribute is a special attribute that is created *only* when +the ``locmem`` email backend is used. It doesn't normally exist as part of the +:mod:`django.core.mail` module and you can't import it directly. The code +below shows how to access this attribute correctly. + +Here's an example test that examines ``django.core.mail.outbox`` for length +and contents:: + + from django.core import mail + from django.test import TestCase + + class EmailTest(TestCase): + def test_send_email(self): + # Send message. + mail.send_mail('Subject here', 'Here is the message.', + 'from@example.com', ['to@example.com'], + fail_silently=False) + + # Test that one message has been sent. + self.assertEqual(len(mail.outbox), 1) + + # Verify that the subject of the first message is correct. + self.assertEqual(mail.outbox[0].subject, 'Subject here') + +As noted :ref:`previously `, the test outbox is emptied +at the start of every test in a Django ``*TestCase``. To empty the outbox +manually, assign the empty list to ``mail.outbox``:: + + from django.core import mail + + # Empty the test outbox + mail.outbox = [] + +.. _skipping-tests: + +Skipping tests +-------------- + +.. currentmodule:: django.test + +The unittest library provides the :func:`@skipIf ` and +:func:`@skipUnless ` decorators to allow you to skip tests +if you know ahead of time that those tests are going to fail under certain +conditions. + +For example, if your test requires a particular optional library in order to +succeed, you could decorate the test case with :func:`@skipIf +`. Then, the test runner will report that the test wasn't +executed and why, instead of failing the test or omitting the test altogether. + +To supplement these test skipping behaviors, Django provides two +additional skip decorators. Instead of testing a generic boolean, +these decorators check the capabilities of the database, and skip the +test if the database doesn't support a specific named feature. + +The decorators use a string identifier to describe database features. +This string corresponds to attributes of the database connection +features class. See ``django.db.backends.BaseDatabaseFeatures`` +class for a full list of database features that can be used as a basis +for skipping tests. + +.. function:: skipIfDBFeature(feature_name_string) + +Skip the decorated test or ``TestCase`` if the named database feature is +supported. + +For example, the following test will not be executed if the database +supports transactions (e.g., it would *not* run under PostgreSQL, but +it would under MySQL with MyISAM tables):: + + class MyTests(TestCase): + @skipIfDBFeature('supports_transactions') + def test_transaction_behavior(self): + # ... conditional test code + +.. versionchanged:: 1.7 + + ``skipIfDBFeature`` can now be used to decorate a ``TestCase`` class. + +.. function:: skipUnlessDBFeature(feature_name_string) + +Skip the decorated test or ``TestCase`` if the named database feature is *not* +supported. + +For example, the following test will only be executed if the database +supports transactions (e.g., it would run under PostgreSQL, but *not* +under MySQL with MyISAM tables):: + + class MyTests(TestCase): + @skipUnlessDBFeature('supports_transactions') + def test_transaction_behavior(self): + # ... conditional test code + +.. versionchanged:: 1.7 + + ``skipUnlessDBFeature`` can now be used to decorate a ``TestCase`` class. From 80004c7cc08b849ec7d18f1699429dd9cc95af57 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 31 Dec 2013 14:07:40 +0100 Subject: [PATCH 144/208] Turned django.db.models.app_cache_ready back into a method. Thanks Anssi for noticing this mistake in a refactoring. --- django/db/models/loading.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/django/db/models/loading.py b/django/db/models/loading.py index 6c4ee6bf68..2d24ca646d 100644 --- a/django/db/models/loading.py +++ b/django/db/models/loading.py @@ -21,7 +21,7 @@ get_models = apps.get_models get_model = apps.get_model register_models = apps.register_models load_app = apps.load_app -app_cache_ready = apps.ready +app_cache_ready = apps.app_cache_ready # This method doesn't return anything interesting in Django 1.6. Maintain it From f46603f8304a5b39c3b3064ec819587a78937113 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 31 Dec 2013 14:09:19 +0100 Subject: [PATCH 145/208] Fleshed out release notes for app loading. Fixed #21715. --- django/apps/registry.py | 4 +- docs/releases/1.7.txt | 82 ++++++++++++++++++++++++++++++----------- 2 files changed, 62 insertions(+), 24 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index bdd566c388..c7c9a05679 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -97,9 +97,7 @@ class Apps(object): Raises an exception if the registry isn't ready. """ if not self.ready: - raise RuntimeError( - "App registry isn't populated yet. " - "Have you called django.setup()?") + raise RuntimeError("App registry isn't ready yet.") def get_app_configs(self): """ diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 728c7e64b0..c17f62aeee 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -608,32 +608,76 @@ methods are only referring to fields or other items in ``model._meta``. App-loading changes ~~~~~~~~~~~~~~~~~~~ +Start-up sequence +^^^^^^^^^^^^^^^^^ + +Django 1.7 loads application configurations and models as soon as it starts. +While this behavior is more straightforward and is believed to be more robust, +regressions cannot be ruled out. You may encounter the following exceptions: + +* ``RuntimeError: App registry isn't ready yet.`` This happens when importing + an application configuration or a models module triggers code that depends + on the app registry. + + For example, :func:`~django.utils.translation.ugettext()` uses the app + registry to look up translation catalogs in applications. To translate at + import time, you need :func:`~django.utils.translation.ugettext_lazy()` + instead. (Using :func:`~django.utils.translation.ugettext()` would be a bug, + because the translation would happen at import time, rather than at each + request depending on the active language.) + + Executing database queries with the ORM at import time in models modules + will also trigger this exception. The ORM cannot function properly until all + models are available. + +* ``ImportError: cannot import name ...`` This happens if the import sequence + ends up in a loop. + + To eliminate such problems, you should minimize dependencies between your + models modules and do as little work as possible at import time. To avoid + executing code at import time, you can move it into a function and cache its + results. The code will be executed when you first need its results. This + concept is known as "lazy evaluation". + +Standalone scripts +^^^^^^^^^^^^^^^^^^ + +If you're using Django in a plain Python script — rather than a management +command — and you rely on the :envvar:`DJANGO_SETTINGS_MODULE` environment +variable, you must now explicitly initialize Django at the beginning of your +script with:: + + >>> import django + >>> django.setup() + +Otherwise, you will hit ``RuntimeError: App registry isn't ready yet.`` + +Subclassing AppCommand +^^^^^^^^^^^^^^^^^^^^^^ + +Subclasses of :class:`~django.core.management.AppCommand` must now implement a +:meth:`~django.core.management.AppCommand.handle_app_config` method instead of +``handle_app()``. This method receives an :class:`~django.apps.AppConfig` +instance instead of a models module. + +App registry consistency +^^^^^^^^^^^^^^^^^^^^^^^^ + You should make sure that your project doesn't import models from applications that aren't in :setting:`INSTALLED_APPS`. Relations involving such models may not be created properly. -Subclasses of :class:`~django.core.management.AppCommand` must now implement a -:meth:`~django.core.management.AppCommand.handle_app_config` method instead of -``handle_app()``. This method receives an :class:`~django.apps.AppConfig` instance. +Introspecting applications +^^^^^^^^^^^^^^^^^^^^^^^^^^ Since :setting:`INSTALLED_APPS` now supports application configuration classes in addition to application modules, you should review code that accesses this setting directly and use the app registry (:attr:`django.apps.apps`) instead. -If you're using Django in a plain Python script (not a management command) and -rely on the :envvar:`DJANGO_SETTINGS_MODULE` environment variable, you must -now explicitly initialize Django at the beginning of your script with:: - - >>> import django - >>> django.setup() - -Otherwise, you will most likely encounter a :exc:`~exceptions.RuntimeError`. - -The "app registry" that manages the list of installed applications doesn't -have the same features as the old "app cache". Even though the "app cache" was -a private API, obsolete methods and arguments will be removed after a standard -deprecation period. In addition, the following changes take effect -immediately: +The app registry has preserved some features of the old app cache. Even though +the app cache was a private API, obsolete methods and arguments will be +removed through a standard deprecation path, with the exception of the +following changes that take effect immediately: * ``get_model`` raises :exc:`~exceptions.LookupError` instead of returning ``None`` when no model is found. @@ -641,10 +685,6 @@ immediately: * The ``only_installed`` argument of ``get_model`` and ``get_models`` no longer exists, nor does the ``seed_cache`` argument of ``get_model``. -While the new implementation is believed to be more robust, regressions cannot -be ruled out, especially during the import sequence. Circular imports that -didn't happen with previous versions of Django might appear. - Behavior of ``LocMemCache`` regarding pickle errors ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 69f0249d7b6dfbf278bbc2d5907f598d5ed241af Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Tue, 31 Dec 2013 10:20:44 -0500 Subject: [PATCH 146/208] Fixed #19395 -- Added a simple example logging config. Thanks ken.nelson at maclaren.com. --- docs/topics/logging.txt | 37 +++++++++++++++++++++++++++++++++---- 1 file changed, 33 insertions(+), 4 deletions(-) diff --git a/docs/topics/logging.txt b/docs/topics/logging.txt index 15c1aa9dd8..d75875f2c8 100644 --- a/docs/topics/logging.txt +++ b/docs/topics/logging.txt @@ -230,13 +230,40 @@ use in your project code. .. _dictConfig format: http://docs.python.org/library/logging.config.html#configuration-dictionary-schema -An example ----------- +Examples +-------- The full documentation for `dictConfig format`_ is the best source of information about logging configuration dictionaries. However, to give -you a taste of what is possible, here is an example of a fairly -complex logging setup, configured using :func:`logging.config.dictConfig`:: +you a taste of what is possible, here are a couple examples. + +First, here's a simple configuration which writes all request logging from the +:ref:`django-request-logger` logger to a local file:: + + LOGGING = { + 'version': 1, + 'disable_existing_loggers': False, + 'handlers': { + 'file': { + 'level': 'DEBUG', + 'class': 'logging.FileHandler', + 'filename': '/path/to/django/debug.log', + }, + }, + 'loggers': { + 'django.request': { + 'handlers': ['file'], + 'level': 'DEBUG', + 'propagate': True, + }, + }, + } + +If you use this example, be sure to change the ``'filename'`` path to a +location that's writable by the user that's running the Django application. + +Second, here's an example of a fairly complex logging setup, configured using +:func:`logging.config.dictConfig`:: LOGGING = { 'version': 1, @@ -396,6 +423,8 @@ Django provides four built-in loggers. ``django`` is the catch-all logger. No messages are posted directly to this logger. +.. _django-request-logger: + ``django.request`` ~~~~~~~~~~~~~~~~~~ From 75220d3b5dbe03ef70d42433178a9598133a4ac1 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 31 Dec 2013 16:13:40 +0100 Subject: [PATCH 147/208] Small style cleanup. --- django/db/models/options.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/django/db/models/options.py b/django/db/models/options.py index 6ad914e025..414271a95e 100644 --- a/django/db/models/options.py +++ b/django/db/models/options.py @@ -42,9 +42,11 @@ def normalize_unique_together(unique_together): @python_2_unicode_compatible class Options(object): def __init__(self, meta, app_label=None): - self.local_fields, self.local_many_to_many = [], [] + self.local_fields = [] + self.local_many_to_many = [] self.virtual_fields = [] - self.model_name, self.verbose_name = None, None + self.model_name = None + self.verbose_name = None self.verbose_name_plural = None self.db_table = '' self.ordering = [] @@ -53,13 +55,15 @@ class Options(object): self.select_on_save = False self.default_permissions = ('add', 'change', 'delete') self.permissions = [] - self.object_name, self.app_label = None, app_label + self.object_name = None + self.app_label = app_label self.get_latest_by = None self.order_with_respect_to = None self.db_tablespace = settings.DEFAULT_TABLESPACE self.meta = meta self.pk = None - self.has_auto_field, self.auto_field = False, None + self.has_auto_field = False + self.auto_field = None self.abstract = False self.managed = True self.proxy = False From d0eeddd6fcd93b23bb632ad3ea95ae3f871907e3 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Tue, 31 Dec 2013 14:36:45 +0100 Subject: [PATCH 148/208] Fixed #21716 -- Only passed arguments supported by ogrinspect Thanks Marco Badan for the report. --- .../gis/management/commands/ogrinspect.py | 20 ++++++++----------- django/contrib/gis/tests/inspectapp/tests.py | 7 +++++++ 2 files changed, 15 insertions(+), 12 deletions(-) diff --git a/django/contrib/gis/management/commands/ogrinspect.py b/django/contrib/gis/management/commands/ogrinspect.py index c7b1389574..78c610635a 100644 --- a/django/contrib/gis/management/commands/ogrinspect.py +++ b/django/contrib/gis/management/commands/ogrinspect.py @@ -1,4 +1,6 @@ +import inspect from optparse import make_option + from django.contrib.gis import gdal from django.core.management.base import LabelCommand, CommandError @@ -83,27 +85,21 @@ class Command(LabelCommand): if not gdal.HAS_GDAL: raise CommandError('GDAL is required to inspect geospatial data sources.') - # Removing options with `None` values. - options = dict((k, v) for k, v in options.items() if not v is None) - # Getting the OGR DataSource from the string parameter. try: ds = gdal.DataSource(data_source) except gdal.OGRException as msg: raise CommandError(msg) - # Whether the user wants to generate the LayerMapping dictionary as well. - show_mapping = options.pop('mapping', False) - - # Getting rid of settings that `_ogrinspect` doesn't like. - options.pop('verbosity', False) - options.pop('settings', False) - # Returning the output of ogrinspect with the given arguments # and options. from django.contrib.gis.utils.ogrinspect import _ogrinspect, mapping - output = [s for s in _ogrinspect(ds, model_name, **options)] - if show_mapping: + # Filter options to params accepted by `_ogrinspect` + ogr_options = dict((k, v) for k, v in options.items() + if k in inspect.getargspec(_ogrinspect).args and v is not None) + output = [s for s in _ogrinspect(ds, model_name, **ogr_options)] + + if options['mapping']: # Constructing the keyword arguments for `mapping`, and # calling it on the data source. kwargs = {'geom_name': options['geom_name'], diff --git a/django/contrib/gis/tests/inspectapp/tests.py b/django/contrib/gis/tests/inspectapp/tests.py index 17642ea8df..2690dc484d 100644 --- a/django/contrib/gis/tests/inspectapp/tests.py +++ b/django/contrib/gis/tests/inspectapp/tests.py @@ -115,6 +115,13 @@ class OGRInspectTest(TestCase): ' objects = models.GeoManager()' )) + def test_management_command(self): + shp_file = os.path.join(TEST_DATA, 'cities', 'cities.shp') + out = StringIO() + call_command('ogrinspect', shp_file, 'City', stdout=out) + output = out.getvalue() + self.assertIn('class City(models.Model):', output) + def get_ogr_db_string(): """ From 553500133cc4426f20407391f3493716357db45f Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 31 Dec 2013 16:22:07 +0100 Subject: [PATCH 149/208] Removed an obsolete unicity check. It doesn't account for app configs. Refs #21679. --- django/conf/__init__.py | 5 ----- tests/settings_tests/tests.py | 21 --------------------- 2 files changed, 26 deletions(-) diff --git a/django/conf/__init__.py b/django/conf/__init__.py index ac074d5166..3449368cb0 100644 --- a/django/conf/__init__.py +++ b/django/conf/__init__.py @@ -104,11 +104,6 @@ class BaseSettings(object): elif name == "ALLOWED_INCLUDE_ROOTS" and isinstance(value, six.string_types): raise ValueError("The ALLOWED_INCLUDE_ROOTS setting must be set " "to a tuple, not a string.") - elif name == "INSTALLED_APPS": - value = list(value) # force evaluation of generators on Python 3 - if len(value) != len(set(value)): - raise ImproperlyConfigured("The INSTALLED_APPS setting must contain unique values.") - object.__setattr__(self, name, value) diff --git a/tests/settings_tests/tests.py b/tests/settings_tests/tests.py index 2225862f7f..9b2f5c79fa 100644 --- a/tests/settings_tests/tests.py +++ b/tests/settings_tests/tests.py @@ -292,27 +292,6 @@ class TestComplexSettingOverride(TestCase): 'Overriding setting TEST_WARN can lead to unexpected behaviour.') -class UniqueSettingsTests(TestCase): - """ - Tests for the INSTALLED_APPS setting. - """ - settings_module = settings - - def setUp(self): - self._installed_apps = self.settings_module.INSTALLED_APPS - - def tearDown(self): - self.settings_module.INSTALLED_APPS = self._installed_apps - - def test_unique(self): - """ - An ImproperlyConfigured exception is raised if the INSTALLED_APPS contains - any duplicate strings. - """ - with self.assertRaises(ImproperlyConfigured): - self.settings_module.INSTALLED_APPS = ("myApp1", "myApp1", "myApp2", "myApp3") - - class TrailingSlashURLTests(TestCase): """ Tests for the MEDIA_URL and STATIC_URL settings. From 5dfec4e23b4a3b81f8ec19bf0cf45147ad6b18e5 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 31 Dec 2013 16:22:42 +0100 Subject: [PATCH 150/208] Checked unicity of app config names when populating the app registry. This check will miss duplicates until the check for duplicate labels is added. Refs #21679. --- django/apps/registry.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index c7c9a05679..317bde33fe 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -1,4 +1,4 @@ -from collections import defaultdict, OrderedDict +from collections import Counter, defaultdict, OrderedDict import os import sys import warnings @@ -79,8 +79,19 @@ class Apps(object): app_config = entry else: app_config = AppConfig.create(entry) + # TODO: check for duplicate app labels here (#21679). self.app_configs[app_config.label] = app_config + # Check for duplicate app names. + counts = Counter( + app_config.name for app_config in self.app_configs.values()) + duplicates = [ + name for name, count in counts.most_common() if count > 1] + if duplicates: + raise ImproperlyConfigured( + "Application names aren't unique, " + "duplicates: %s" % ", ".join(duplicates)) + # Load models. for app_config in self.app_configs.values(): all_models = self.all_models[app_config.label] From c40209dcc09f19524fb85251f39a4051491bbec0 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 31 Dec 2013 16:23:42 +0100 Subject: [PATCH 151/208] Made it possible to change an application's label in its configuration. Fixed #21683. --- django/apps/registry.py | 21 ++++++++++++++ django/db/migrations/state.py | 4 +-- django/db/models/base.py | 40 +++++++++++++++++--------- docs/ref/applications.txt | 31 +++++++++++++------- docs/releases/1.7.txt | 3 ++ tests/apps/apps.py | 5 ++++ tests/apps/tests.py | 4 +++ tests/proxy_model_inheritance/tests.py | 6 ++-- 8 files changed, 83 insertions(+), 31 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index 317bde33fe..7ff1c6625d 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -201,6 +201,27 @@ class Apps(object): app_config = self.app_configs.get(app_name.rpartition(".")[2]) return app_config is not None and app_config.name == app_name + def get_containing_app_config(self, object_name): + """ + Look for an app config containing a given object. + + object_name is the dotted Python path to the object. + + Returns the app config for the inner application in case of nesting. + Returns None if the object isn't in any registered app config. + + It's safe to call this method at import time, even while the registry + is being populated. + """ + candidates = [] + for app_config in self.app_configs.values(): + if object_name.startswith(app_config.name): + subpath = object_name[len(app_config.name):] + if subpath == '' or subpath[0] == '.': + candidates.append(app_config) + if candidates: + return sorted(candidates, key=lambda ac: -len(ac.name))[0] + def get_registered_model(self, app_label, model_name): """ Similar to get_model(), but doesn't require that an app exists with diff --git a/django/db/migrations/state.py b/django/db/migrations/state.py index ff2e26c7a0..3bc7837089 100644 --- a/django/db/migrations/state.py +++ b/django/db/migrations/state.py @@ -76,9 +76,7 @@ class AppConfigStub(AppConfig): Stubs a Django AppConfig. Only provides a label and a dict of models. """ def __init__(self, label): - self.label = label - self.path = None - super(AppConfigStub, self).__init__(None, None) + super(AppConfigStub, self).__init__(label, None) def import_models(self, all_models): self.models = all_models diff --git a/django/db/models/base.py b/django/db/models/base.py index 03f1e8b693..0de21fafc9 100644 --- a/django/db/models/base.py +++ b/django/db/models/base.py @@ -86,23 +86,35 @@ class ModelBase(type): meta = attr_meta base_meta = getattr(new_class, '_meta', None) + # Look for an application configuration to attach the model to. + app_config = apps.get_containing_app_config(module) + if getattr(meta, 'app_label', None) is None: - # Figure out the app_label by looking one level up from the package - # or module named 'models'. If no such package or module exists, - # fall back to looking one level up from the module this model is - # defined in. - # For 'django.contrib.sites.models', this would be 'sites'. - # For 'geo.models.places' this would be 'geo'. + if app_config is None: + # If the model is imported before the configuration for its + # application is created (#21719), or isn't in an installed + # application (#21680), use the legacy logic to figure out the + # app_label by looking one level up from the package or module + # named 'models'. If no such package or module exists, fall + # back to looking one level up from the module this model is + # defined in. + + # For 'django.contrib.sites.models', this would be 'sites'. + # For 'geo.models.places' this would be 'geo'. + + model_module = sys.modules[new_class.__module__] + package_components = model_module.__name__.split('.') + package_components.reverse() # find the last occurrence of 'models' + try: + app_label_index = package_components.index(MODELS_MODULE_NAME) + 1 + except ValueError: + app_label_index = 1 + kwargs = {"app_label": package_components[app_label_index]} + + else: + kwargs = {"app_label": app_config.label} - model_module = sys.modules[new_class.__module__] - package_components = model_module.__name__.split('.') - package_components.reverse() # find the last occurrence of 'models' - try: - app_label_index = package_components.index(MODELS_MODULE_NAME) + 1 - except ValueError: - app_label_index = 1 - kwargs = {"app_label": package_components[app_label_index]} else: kwargs = {} diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt index eadf9895ca..38bf474371 100644 --- a/docs/ref/applications.txt +++ b/docs/ref/applications.txt @@ -114,24 +114,33 @@ Application configuration Configurable attributes ----------------------- -.. attribute:: AppConfig.verbose_name - - Human-readable name for the application, e.g. "Admin". - - If this isn't provided, Django uses ``label.title()``. - -Read-only attributes --------------------- - .. attribute:: AppConfig.name Full Python path to the application, e.g. ``'django.contrib.admin'``. + This attribute defines which application the configuration applies to. It + must be set in all :class:`~django.apps.AppConfig` subclasses. + + It must be unique across a Django project. + .. attribute:: AppConfig.label - Last component of the Python path to the application, e.g. ``'admin'``. + Short name for the application, e.g. ``'admin'`` - This value must be unique across a Django project. + This attribute allows relabelling an application when two applications + have conflicting labels. It defaults to the last component of ``name``. + It should be a valid Python identifier. + + It must be unique across a Django project. + +.. attribute:: AppConfig.verbose_name + + Human-readable name for the application, e.g. "Admin". + + This attribute defaults to ``label.title()``. + +Read-only attributes +-------------------- .. attribute:: AppConfig.path diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index c17f62aeee..453714b6f1 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -79,6 +79,9 @@ Improvements thus far include: * It is possible to omit ``models.py`` entirely if an application doesn't have any models. +* Applications can be relabeled with the :attr:`~django.apps.AppConfig.label` + attribute of application configurations, to work around label conflicts. + * The name of applications can be customized in the admin with the :attr:`~django.apps.AppConfig.verbose_name` of application configurations. diff --git a/tests/apps/apps.py b/tests/apps/apps.py index 22c8f3062f..c9d761deb0 100644 --- a/tests/apps/apps.py +++ b/tests/apps/apps.py @@ -23,3 +23,8 @@ class NotAConfig(object): class NoSuchApp(AppConfig): name = 'there is no such app' + + +class RelabeledAppsConfig(AppConfig): + name = 'apps' + label = 'relabeled' diff --git a/tests/apps/tests.py b/tests/apps/tests.py index 2a41acf2e8..495d24dc3e 100644 --- a/tests/apps/tests.py +++ b/tests/apps/tests.py @@ -111,6 +111,10 @@ class AppsTests(TestCase): self.assertTrue(apps.has_app('django.contrib.staticfiles')) self.assertFalse(apps.has_app('django.contrib.webdesign')) + @override_settings(INSTALLED_APPS=['apps.apps.RelabeledAppsConfig']) + def test_relabeling(self): + self.assertEqual(apps.get_app_config('relabeled').name, 'apps') + def test_models_py(self): """ Tests that the models in the models.py file were loaded correctly. diff --git a/tests/proxy_model_inheritance/tests.py b/tests/proxy_model_inheritance/tests.py index 06b47ff82d..5ad5e08c25 100644 --- a/tests/proxy_model_inheritance/tests.py +++ b/tests/proxy_model_inheritance/tests.py @@ -1,4 +1,4 @@ -from __future__ import unicode_literals +from __future__ import absolute_import, unicode_literals import os import sys @@ -29,8 +29,8 @@ class ProxyModelInheritanceTests(TransactionTestCase): def test_table_exists(self): with self.modify_settings(INSTALLED_APPS={'append': ['app1', 'app2']}): call_command('migrate', verbosity=0) - from .app1.models import ProxyModel - from .app2.models import NiceModel + from app1.models import ProxyModel + from app2.models import NiceModel self.assertEqual(NiceModel.objects.all().count(), 0) self.assertEqual(ProxyModel.objects.all().count(), 0) From 63137a8304d4387132e749c97aad1049526f601c Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 31 Dec 2013 17:25:57 +0100 Subject: [PATCH 152/208] Enforced unicity of app labels. Fixed #21679. --- django/apps/registry.py | 6 +++++- docs/releases/1.7.txt | 23 ++++++++++++++++------- tests/apps/apps.py | 4 ++++ tests/apps/tests.py | 11 +++++++++++ 4 files changed, 36 insertions(+), 8 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index 7ff1c6625d..3cd6d480f1 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -79,7 +79,11 @@ class Apps(object): app_config = entry else: app_config = AppConfig.create(entry) - # TODO: check for duplicate app labels here (#21679). + if app_config.label in self.app_configs: + raise ImproperlyConfigured( + "Application labels aren't unique, " + "duplicates: %s" % app_config.label) + self.app_configs[app_config.label] = app_config # Check for duplicate app names. diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 453714b6f1..af0acd7152 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -655,6 +655,22 @@ script with:: Otherwise, you will hit ``RuntimeError: App registry isn't ready yet.`` +App registry consistency +^^^^^^^^^^^^^^^^^^^^^^^^ + +It is no longer possible to have multiple installed applications with the same +label. In previous versions of Django, this didn't always work correctly, but +didn't crash outright either. + +If you have two apps with the same label, you should create an +:class:`~django.apps.AppConfig` for one of them and override its +:class:`~django.apps.AppConfig.label` there. You should then adjust your code +wherever it references this application or its models with the old label. + +You should make sure that your project doesn't import models from applications +that aren't in :setting:`INSTALLED_APPS`. Relations involving such models may +not be created properly. Future versions of Django may forbid this entirely. + Subclassing AppCommand ^^^^^^^^^^^^^^^^^^^^^^ @@ -663,13 +679,6 @@ Subclasses of :class:`~django.core.management.AppCommand` must now implement a ``handle_app()``. This method receives an :class:`~django.apps.AppConfig` instance instead of a models module. -App registry consistency -^^^^^^^^^^^^^^^^^^^^^^^^ - -You should make sure that your project doesn't import models from applications -that aren't in :setting:`INSTALLED_APPS`. Relations involving such models may -not be created properly. - Introspecting applications ^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/tests/apps/apps.py b/tests/apps/apps.py index c9d761deb0..a2c49fcbff 100644 --- a/tests/apps/apps.py +++ b/tests/apps/apps.py @@ -25,6 +25,10 @@ class NoSuchApp(AppConfig): name = 'there is no such app' +class PlainAppsConfig(AppConfig): + name = 'apps' + + class RelabeledAppsConfig(AppConfig): name = 'apps' label = 'relabeled' diff --git a/tests/apps/tests.py b/tests/apps/tests.py index 495d24dc3e..c31174a1f1 100644 --- a/tests/apps/tests.py +++ b/tests/apps/tests.py @@ -5,6 +5,7 @@ from django.apps.registry import Apps from django.core.exceptions import ImproperlyConfigured from django.db import models from django.test import TestCase, override_settings +from django.utils import six from .models import TotallyNormal, SoAlternative, new_apps @@ -115,6 +116,16 @@ class AppsTests(TestCase): def test_relabeling(self): self.assertEqual(apps.get_app_config('relabeled').name, 'apps') + def test_duplicate_labels(self): + with six.assertRaisesRegex(self, ImproperlyConfigured, "Application labels aren't unique"): + with self.settings(INSTALLED_APPS=['apps.apps.PlainAppsConfig', 'apps']): + pass + + def test_duplicate_names(self): + with six.assertRaisesRegex(self, ImproperlyConfigured, "Application names aren't unique"): + with self.settings(INSTALLED_APPS=['apps.apps.RelabeledAppsConfig', 'apps']): + pass + def test_models_py(self): """ Tests that the models in the models.py file were loaded correctly. From 1d23d766ab85301eb527629400933fd601355f1a Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Tue, 31 Dec 2013 17:55:12 +0100 Subject: [PATCH 153/208] Renamed AppConfig.setup to ready. Thanks Jannis and Marc for the feedback. Fixed #21717. --- django/apps/base.py | 4 ++-- django/apps/registry.py | 2 +- docs/ref/applications.txt | 6 +++--- docs/ref/signals.txt | 2 +- docs/releases/1.7.txt | 2 +- docs/topics/signals.txt | 6 +++--- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/django/apps/base.py b/django/apps/base.py index 1aa5c29fd2..47f0a57711 100644 --- a/django/apps/base.py +++ b/django/apps/base.py @@ -159,7 +159,7 @@ class AppConfig(object): models_module_name = '%s.%s' % (self.name, MODELS_MODULE_NAME) self.models_module = import_module(models_module_name) - def setup(self): + def ready(self): """ - Override this method in subclasses to run setup code. + Override this method in subclasses to run code when Django starts. """ diff --git a/django/apps/registry.py b/django/apps/registry.py index 3cd6d480f1..db75f999c5 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -105,7 +105,7 @@ class Apps(object): self.ready = True for app_config in self.get_app_configs(): - app_config.setup() + app_config.ready() def check_ready(self): """ diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt index 38bf474371..ed3f33a2cc 100644 --- a/docs/ref/applications.txt +++ b/docs/ref/applications.txt @@ -175,10 +175,10 @@ Methods ``model_name``. Raises :exc:`~exceptions.LookupError` if no such model exists. ``model_name`` is case-insensitive. -.. method:: AppConfig.setup() +.. method:: AppConfig.ready() - Subclasses can override this method to perform setup tasks such as - registering signals. It is called as soon as the registry is fully + Subclasses can override this method to perform initialization tasks such + as registering signals. It is called as soon as the registry is fully populated. Application registry diff --git a/docs/ref/signals.txt b/docs/ref/signals.txt index 2e9f6ccea6..5c3d544c5a 100644 --- a/docs/ref/signals.txt +++ b/docs/ref/signals.txt @@ -355,7 +355,7 @@ been defined and registered with Django's model system. Django uses this signal internally; it's not generally used in third-party applications. Since this signal is sent during the app registry population process, and -:meth:`AppConfig.setup() ` runs after the app +:meth:`AppConfig.ready() ` runs after the app registry is fully populated, receivers cannot be connected in that method. One possibility is to connect them ``AppConfig.__init__()`` instead, taking care not to import models or trigger calls to the app registry. diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index af0acd7152..b559445e7c 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -74,7 +74,7 @@ attach configuration data to applications. Improvements thus far include: * Applications can run code at startup, before Django does anything else, with - the :meth:`~django.apps.AppConfig.setup` method of their configuration. + the :meth:`~django.apps.AppConfig.ready` method of their configuration. * It is possible to omit ``models.py`` entirely if an application doesn't have any models. diff --git a/docs/topics/signals.txt b/docs/topics/signals.txt index 9a311cd506..ee6fb847a2 100644 --- a/docs/topics/signals.txt +++ b/docs/topics/signals.txt @@ -142,14 +142,14 @@ Now, our ``my_callback`` function will be called each time a request finishes. In practice, signal handlers are usually defined in a ``signals`` submodule of the application they relate to. Signal receivers are - connected in the :meth:`~django.apps.AppConfig.setup` method of your + connected in the :meth:`~django.apps.AppConfig.ready` method of your application configuration class. If you're using the :func:`receiver` decorator, simply import the ``signals`` submodule inside - :meth:`~django.apps.AppConfig.setup`. + :meth:`~django.apps.AppConfig.ready`. .. versionchanged:: 1.7 - Since :meth:`~django.apps.AppConfig.setup` didn't exist in previous + Since :meth:`~django.apps.AppConfig.ready` didn't exist in previous versions of Django, signal registration usually happened in the ``models`` module. From b8e3373f458aa363d59c61b58be390a5a1156467 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Tue, 31 Dec 2013 12:28:01 +0100 Subject: [PATCH 154/208] Fixed #21714 -- Moved logging configuration to global setup() Thanks Aymeric Augustin for the report and the review. --- django/__init__.py | 9 +++++++-- django/conf/__init__.py | 27 --------------------------- django/utils/log.py | 21 +++++++++++++++++++++ docs/topics/logging.txt | 8 +++----- tests/logging_tests/tests.py | 12 +++++------- 5 files changed, 36 insertions(+), 41 deletions(-) diff --git a/django/__init__.py b/django/__init__.py index 69be8c9984..14c941601a 100644 --- a/django/__init__.py +++ b/django/__init__.py @@ -9,8 +9,13 @@ def get_version(*args, **kwargs): def setup(): - # Configure the settings (this happens as a side effect of accessing - # INSTALLED_APPS or any other setting) and populate the app registry. + """ + Configure the settings (this happens as a side effect of accessing the + first setting), configure logging and populate the app registry. + """ from django.apps import apps from django.conf import settings + from django.utils.log import configure_logging + + configure_logging(settings.LOGGING_CONFIG, settings.LOGGING) apps.populate(settings.INSTALLED_APPS) diff --git a/django/conf/__init__.py b/django/conf/__init__.py index 3449368cb0..e10d4b1afb 100644 --- a/django/conf/__init__.py +++ b/django/conf/__init__.py @@ -7,16 +7,12 @@ a list of all possible variables. """ import importlib -import logging import os -import sys import time # Needed for Windows -import warnings from django.conf import global_settings from django.core.exceptions import ImproperlyConfigured from django.utils.functional import LazyObject, empty -from django.utils.module_loading import import_by_path from django.utils import six ENVIRONMENT_VARIABLE = "DJANGO_SETTINGS_MODULE" @@ -44,34 +40,12 @@ class LazySettings(LazyObject): % (desc, ENVIRONMENT_VARIABLE)) self._wrapped = Settings(settings_module) - self._configure_logging() def __getattr__(self, name): if self._wrapped is empty: self._setup(name) return getattr(self._wrapped, name) - def _configure_logging(self): - """ - Setup logging from LOGGING_CONFIG and LOGGING settings. - """ - if not sys.warnoptions: - # Route warnings through python logging - logging.captureWarnings(True) - # Allow DeprecationWarnings through the warnings filters - warnings.simplefilter("default", DeprecationWarning) - - if self.LOGGING_CONFIG: - from django.utils.log import DEFAULT_LOGGING - # First find the logging configuration function ... - logging_config_func = import_by_path(self.LOGGING_CONFIG) - - logging_config_func(DEFAULT_LOGGING) - - # ... then invoke it with the logging settings - if self.LOGGING: - logging_config_func(self.LOGGING) - def configure(self, default_settings=global_settings, **options): """ Called to manually configure the settings. The 'default_settings' @@ -84,7 +58,6 @@ class LazySettings(LazyObject): for name, value in options.items(): setattr(holder, name, value) self._wrapped = holder - self._configure_logging() @property def configured(self): diff --git a/django/utils/log.py b/django/utils/log.py index 488632882c..cf778b619b 100644 --- a/django/utils/log.py +++ b/django/utils/log.py @@ -1,8 +1,11 @@ import logging +import sys +import warnings from django.conf import settings from django.core import mail from django.core.mail import get_connection +from django.utils.module_loading import import_by_path from django.views.debug import ExceptionReporter, get_exception_reporter_filter # Imports kept for backwards-compatibility in Django 1.7. @@ -61,6 +64,24 @@ DEFAULT_LOGGING = { } +def configure_logging(logging_config, logging_settings): + if not sys.warnoptions: + # Route warnings through python logging + logging.captureWarnings(True) + # Allow DeprecationWarnings through the warnings filters + warnings.simplefilter("default", DeprecationWarning) + + if logging_config: + # First find the logging configuration function ... + logging_config_func = import_by_path(logging_config) + + logging_config_func(DEFAULT_LOGGING) + + # ... then invoke it with the logging settings + if logging_settings: + logging_config_func(logging_settings) + + class AdminEmailHandler(logging.Handler): """An exception log handler that emails log entries to site admins. diff --git a/docs/topics/logging.txt b/docs/topics/logging.txt index d75875f2c8..03145fc41d 100644 --- a/docs/topics/logging.txt +++ b/docs/topics/logging.txt @@ -222,11 +222,9 @@ set to ``True`` (which is the default) the default configuration is completely overridden. Alternatively you can redefine some or all of the loggers by setting ``disable_existing_loggers`` to ``False``. -Logging is configured as soon as settings have been loaded -(either manually using :func:`~django.conf.settings.configure` or when at least -one setting is accessed). Since the loading of settings is one of the first -things that Django does, you can be certain that loggers are always ready for -use in your project code. +Logging is configured as part of the general Django ``setup()`` function. +Therefore, you can be certain that loggers are always ready for use in your +project code. .. _dictConfig format: http://docs.python.org/library/logging.config.html#configuration-dictionary-schema diff --git a/tests/logging_tests/tests.py b/tests/logging_tests/tests.py index a6791cfa76..f020bfddef 100644 --- a/tests/logging_tests/tests.py +++ b/tests/logging_tests/tests.py @@ -3,7 +3,6 @@ from __future__ import unicode_literals import logging import warnings -from django.conf import LazySettings from django.core import mail from django.test import TestCase, RequestFactory, override_settings from django.test.utils import patch_logger @@ -342,15 +341,14 @@ def dictConfig(config): dictConfig.called = False -class SettingsConfigureLogging(TestCase): +class SetupConfigureLogging(TestCase): """ - Test that calling settings.configure() initializes the logging - configuration. + Test that calling django.setup() initializes the logging configuration. """ + @override_settings(LOGGING_CONFIG='logging_tests.tests.dictConfig') def test_configure_initializes_logging(self): - settings = LazySettings() - settings.configure( - LOGGING_CONFIG='logging_tests.tests.dictConfig') + from django import setup + setup() self.assertTrue(dictConfig.called) From 4d8d76e7a89858932b6f4f280a0ebf4cf94ab4b7 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Tue, 31 Dec 2013 13:02:01 -0500 Subject: [PATCH 155/208] Fixed #21484 -- Documented that SQL logging does not include "framework level" queries. --- docs/topics/logging.txt | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/topics/logging.txt b/docs/topics/logging.txt index 03145fc41d..751563e4b9 100644 --- a/docs/topics/logging.txt +++ b/docs/topics/logging.txt @@ -441,9 +441,9 @@ Messages to this logger have the following extra context: ``django.db.backends`` ~~~~~~~~~~~~~~~~~~~~~~ -Messages relating to the interaction of code with the database. -For example, every SQL statement executed by a request is logged -at the ``DEBUG`` level to this logger. +Messages relating to the interaction of code with the database. For example, +every application-level SQL statement executed by a request is logged at the +``DEBUG`` level to this logger. Messages to this logger have the following extra context: @@ -455,6 +455,11 @@ For performance reasons, SQL logging is only enabled when ``settings.DEBUG`` is set to ``True``, regardless of the logging level or handlers that are installed. +This logging does not include framework-level initialization (e.g. +``SET TIMEZONE``) or transaction management queries (e.g. ``BEGIN``, +``COMMIT``, and ``ROLLBACK``). Turn on query logging in your database if you +wish the view all database queries. + ``django.security.*`` ~~~~~~~~~~~~~~~~~~~~~~ From 4befb3015c26810a68cfcf57e0cd8b062f56f1c5 Mon Sep 17 00:00:00 2001 From: Loic Bistuer Date: Tue, 10 Dec 2013 00:29:39 +0700 Subject: [PATCH 156/208] Fixed #21581 -- Fixed a number of issues with collectstatic. When STATIC_ROOT wasn't set, collectstatic --clear would delete every files within the current directory and its descendants. This patch makes the following changes: Prevent collectstatic from running if STATIC_ROOT isn't set. Fixed an issue that prevented collectstatic from displaying the destination directory. Changed the warning header to notify when the command is run in dry-run mode. --- django/conf/global_settings.py | 2 +- .../management/commands/collectstatic.py | 40 +++++++++++-------- django/contrib/staticfiles/storage.py | 11 ++--- docs/ref/settings.txt | 2 +- docs/releases/1.6.2.txt | 5 +++ tests/staticfiles_tests/tests.py | 11 +++++ 6 files changed, 45 insertions(+), 26 deletions(-) diff --git a/django/conf/global_settings.py b/django/conf/global_settings.py index d29dd5ec34..d86a4272cd 100644 --- a/django/conf/global_settings.py +++ b/django/conf/global_settings.py @@ -290,7 +290,7 @@ MEDIA_URL = '' # Absolute path to the directory static files should be collected to. # Example: "/var/www/example.com/static/" -STATIC_ROOT = '' +STATIC_ROOT = None # URL that handles the static files served from STATIC_ROOT. # Example: "http://example.com/static/", "http://static.example.com/" diff --git a/django/contrib/staticfiles/management/commands/collectstatic.py b/django/contrib/staticfiles/management/commands/collectstatic.py index 67fa6229c4..9009b82c67 100644 --- a/django/contrib/staticfiles/management/commands/collectstatic.py +++ b/django/contrib/staticfiles/management/commands/collectstatic.py @@ -137,32 +137,38 @@ class Command(NoArgsCommand): def handle_noargs(self, **options): self.set_options(**options) - # Warn before doing anything more. - if (isinstance(self.storage, FileSystemStorage) and + + message = ['\n'] + if self.dry_run: + message.append( + 'You have activated the --dry-run option so no files will be modified.\n\n' + ) + + message.append( + 'You have requested to collect static files at the destination\n' + 'location as specified in your settings' + ) + + if (isinstance(self.storage._wrapped, FileSystemStorage) and self.storage.location): destination_path = self.storage.location - destination_display = ':\n\n %s' % destination_path + message.append(':\n\n %s\n\n' % destination_path) else: destination_path = None - destination_display = '.' + message.append('.\n\n') if self.clear: - clear_display = 'This will DELETE EXISTING FILES!' + message.append('This will DELETE EXISTING FILES!\n') else: - clear_display = 'This will overwrite existing files!' + message.append('This will overwrite existing files!\n') - if self.interactive: - confirm = input(""" -You have requested to collect static files at the destination -location as specified in your settings%s + message.append( + 'Are you sure you want to do this?\n\n' + "Type 'yes' to continue, or 'no' to cancel: " + ) -%s -Are you sure you want to do this? - -Type 'yes' to continue, or 'no' to cancel: """ -% (destination_display, clear_display)) - if confirm != 'yes': - raise CommandError("Collecting static files cancelled.") + if self.interactive and input(''.join(message)) != 'yes': + raise CommandError("Collecting static files cancelled.") collected = self.collect() modified_count = len(collected['modified']) diff --git a/django/contrib/staticfiles/storage.py b/django/contrib/staticfiles/storage.py index 5190a299e4..b5d05aa6b2 100644 --- a/django/contrib/staticfiles/storage.py +++ b/django/contrib/staticfiles/storage.py @@ -32,16 +32,13 @@ class StaticFilesStorage(FileSystemStorage): location = settings.STATIC_ROOT if base_url is None: base_url = settings.STATIC_URL - check_settings(base_url) - super(StaticFilesStorage, self).__init__(location, base_url, - *args, **kwargs) - - def path(self, name): - if not self.location: + if not location: raise ImproperlyConfigured("You're using the staticfiles app " "without having set the STATIC_ROOT " "setting to a filesystem path.") - return super(StaticFilesStorage, self).path(name) + check_settings(base_url) + super(StaticFilesStorage, self).__init__(location, base_url, + *args, **kwargs) class CachedFilesMixin(object): diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index e4dfa7fbfe..0fa463ebb9 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -2535,7 +2535,7 @@ Settings for :mod:`django.contrib.staticfiles`. STATIC_ROOT ----------- -Default: ``''`` (Empty string) +Default: ``None`` The absolute path to the directory where :djadmin:`collectstatic` will collect static files for deployment. diff --git a/docs/releases/1.6.2.txt b/docs/releases/1.6.2.txt index 41bc86e906..6043d21815 100644 --- a/docs/releases/1.6.2.txt +++ b/docs/releases/1.6.2.txt @@ -14,3 +14,8 @@ Bug fixes * Fixed a crash when executing the :djadmin:`changepassword` command when the user object representation contained non-ASCII characters (#21627). + +* The :djadmin:`collectstatic` command will raise an error rather than + default to using the current working directory if :setting:`STATIC_ROOT` is + not set. Combined with the ``--clear`` option, the previous behavior could + wipe anything below the current working directory. diff --git a/tests/staticfiles_tests/tests.py b/tests/staticfiles_tests/tests.py index 19c244e353..1de9f9ed84 100644 --- a/tests/staticfiles_tests/tests.py +++ b/tests/staticfiles_tests/tests.py @@ -224,6 +224,17 @@ class TestFindStatic(CollectionTestCase, TestDefaults): self.assertIn('apps', force_text(lines[1])) +class TestConfiguration(StaticFilesTestCase): + def test_location_empty(self): + err = six.StringIO() + for root in ['', None]: + with override_settings(STATIC_ROOT=root): + with six.assertRaisesRegex( + self, ImproperlyConfigured, + 'without having set the STATIC_ROOT setting to a filesystem path'): + call_command('collectstatic', interactive=False, verbosity=0, stderr=err) + + class TestCollection(CollectionTestCase, TestDefaults): """ Test ``collectstatic`` management command. From a502bbb2f0910753007b344e8cc07e74a93dcc09 Mon Sep 17 00:00:00 2001 From: Matt Robenolt Date: Tue, 31 Dec 2013 16:23:20 -0800 Subject: [PATCH 157/208] Django sees more than 1mm hits per hour Disqus regularly does 40-50k/s --- docs/faq/general.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/faq/general.txt b/docs/faq/general.txt index 801cb334ca..6bee5a1fdd 100644 --- a/docs/faq/general.txt +++ b/docs/faq/general.txt @@ -47,7 +47,7 @@ Is Django stable? ----------------- Yes, it's quite stable. World Online has been using Django for many years. Sites built on -Django have weathered traffic spikes of over one million hits an hour. +Django have weathered traffic spikes of over 50 thousand hits per second. Does Django scale? ------------------ From fecfd5030036d370c10114f1817605a3e47e73ff Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 1 Jan 2014 11:01:46 +0100 Subject: [PATCH 158/208] Properly assigned app_label to GIS test models. Used abstract inheritance to cut down on code repetition. --- django/contrib/gis/tests/distapp/models.py | 64 +++++----------- django/contrib/gis/tests/geo3d/models.py | 74 +++++++------------ django/contrib/gis/tests/geoadmin/models.py | 4 + django/contrib/gis/tests/geoapp/models.py | 70 +++++++++--------- django/contrib/gis/tests/geogapp/models.py | 25 +++---- django/contrib/gis/tests/inspectapp/models.py | 4 + django/contrib/gis/tests/layermap/models.py | 48 +++++++----- django/contrib/gis/tests/relatedapp/models.py | 36 +++++---- 8 files changed, 153 insertions(+), 172 deletions(-) diff --git a/django/contrib/gis/tests/distapp/models.py b/django/contrib/gis/tests/distapp/models.py index 811c275faf..d10ce76158 100644 --- a/django/contrib/gis/tests/distapp/models.py +++ b/django/contrib/gis/tests/distapp/models.py @@ -3,77 +3,53 @@ from django.utils.encoding import python_2_unicode_compatible @python_2_unicode_compatible -class SouthTexasCity(models.Model): +class NamedModel(models.Model): + name = models.CharField(max_length=30) + + objects = models.GeoManager() + + class Meta: + abstract = True + app_label = 'distapp' + + def __str__(self): + return self.name + + +class SouthTexasCity(NamedModel): "City model on projected coordinate system for South Texas." - name = models.CharField(max_length=30) point = models.PointField(srid=32140) - objects = models.GeoManager() - - def __str__(self): - return self.name -@python_2_unicode_compatible -class SouthTexasCityFt(models.Model): +class SouthTexasCityFt(NamedModel): "Same City model as above, but U.S. survey feet are the units." - name = models.CharField(max_length=30) point = models.PointField(srid=2278) - objects = models.GeoManager() - - def __str__(self): - return self.name -@python_2_unicode_compatible -class AustraliaCity(models.Model): +class AustraliaCity(NamedModel): "City model for Australia, using WGS84." - name = models.CharField(max_length=30) point = models.PointField() - objects = models.GeoManager() - - def __str__(self): - return self.name -@python_2_unicode_compatible -class CensusZipcode(models.Model): +class CensusZipcode(NamedModel): "Model for a few South Texas ZIP codes (in original Census NAD83)." name = models.CharField(max_length=5) poly = models.PolygonField(srid=4269) - objects = models.GeoManager() - - def __str__(self): - return self.name -@python_2_unicode_compatible -class SouthTexasZipcode(models.Model): +class SouthTexasZipcode(NamedModel): "Model for a few South Texas ZIP codes." name = models.CharField(max_length=5) poly = models.PolygonField(srid=32140, null=True) - objects = models.GeoManager() - - def __str__(self): - return self.name -@python_2_unicode_compatible -class Interstate(models.Model): +class Interstate(NamedModel): "Geodetic model for U.S. Interstates." name = models.CharField(max_length=10) path = models.LineStringField() - objects = models.GeoManager() - - def __str__(self): - return self.name -@python_2_unicode_compatible -class SouthTexasInterstate(models.Model): +class SouthTexasInterstate(NamedModel): "Projected model for South Texas Interstates." name = models.CharField(max_length=10) - path = models.LineStringField(srid=32140) - objects = models.GeoManager() - def __str__(self): - return self.name diff --git a/django/contrib/gis/tests/geo3d/models.py b/django/contrib/gis/tests/geo3d/models.py index 023c71ead1..2244ed8b15 100644 --- a/django/contrib/gis/tests/geo3d/models.py +++ b/django/contrib/gis/tests/geo3d/models.py @@ -3,85 +3,63 @@ from django.utils.encoding import python_2_unicode_compatible @python_2_unicode_compatible -class City3D(models.Model): +class NamedModel(models.Model): name = models.CharField(max_length=30) - point = models.PointField(dim=3) + objects = models.GeoManager() + class Meta: + abstract = True + app_label = 'geo3d' + def __str__(self): return self.name -@python_2_unicode_compatible -class Interstate2D(models.Model): - name = models.CharField(max_length=30) +class City3D(NamedModel): + point = models.PointField(dim=3) + + +class Interstate2D(NamedModel): line = models.LineStringField(srid=4269) - objects = models.GeoManager() - - def __str__(self): - return self.name -@python_2_unicode_compatible -class Interstate3D(models.Model): - name = models.CharField(max_length=30) +class Interstate3D(NamedModel): line = models.LineStringField(dim=3, srid=4269) - objects = models.GeoManager() - - def __str__(self): - return self.name -@python_2_unicode_compatible -class InterstateProj2D(models.Model): - name = models.CharField(max_length=30) +class InterstateProj2D(NamedModel): line = models.LineStringField(srid=32140) - objects = models.GeoManager() - - def __str__(self): - return self.name -@python_2_unicode_compatible -class InterstateProj3D(models.Model): - name = models.CharField(max_length=30) +class InterstateProj3D(NamedModel): line = models.LineStringField(dim=3, srid=32140) - objects = models.GeoManager() - - def __str__(self): - return self.name -@python_2_unicode_compatible -class Polygon2D(models.Model): - name = models.CharField(max_length=30) +class Polygon2D(NamedModel): poly = models.PolygonField(srid=32140) - objects = models.GeoManager() - - def __str__(self): - return self.name -@python_2_unicode_compatible -class Polygon3D(models.Model): - name = models.CharField(max_length=30) +class Polygon3D(NamedModel): poly = models.PolygonField(dim=3, srid=32140) + + +class SimpleModel(models.Model): + objects = models.GeoManager() - def __str__(self): - return self.name + class Meta: + abstract = True + app_label = 'geo3d' -class Point2D(models.Model): +class Point2D(SimpleModel): point = models.PointField() - objects = models.GeoManager() -class Point3D(models.Model): +class Point3D(SimpleModel): point = models.PointField(dim=3) - objects = models.GeoManager() -class MultiPoint3D(models.Model): +class MultiPoint3D(SimpleModel): mpoint = models.MultiPointField(dim=3) - objects = models.GeoManager() diff --git a/django/contrib/gis/tests/geoadmin/models.py b/django/contrib/gis/tests/geoadmin/models.py index d1d671954a..381a752570 100644 --- a/django/contrib/gis/tests/geoadmin/models.py +++ b/django/contrib/gis/tests/geoadmin/models.py @@ -7,8 +7,12 @@ from django.utils.encoding import python_2_unicode_compatible class City(models.Model): name = models.CharField(max_length=30) point = models.PointField() + objects = models.GeoManager() + class Meta: + app_label = 'geoadmin' + def __str__(self): return self.name diff --git a/django/contrib/gis/tests/geoapp/models.py b/django/contrib/gis/tests/geoapp/models.py index 8234bc8d9b..3e1e927155 100644 --- a/django/contrib/gis/tests/geoapp/models.py +++ b/django/contrib/gis/tests/geoapp/models.py @@ -7,66 +7,66 @@ null_flag = not mysql @python_2_unicode_compatible -class Country(models.Model): +class NamedModel(models.Model): name = models.CharField(max_length=30) + + objects = models.GeoManager() + + class Meta: + abstract = True + app_label = 'geoapp' + + def __str__(self): + return self.name + +class Country(NamedModel): mpoly = models.MultiPolygonField() # SRID, by default, is 4326 - objects = models.GeoManager() - - def __str__(self): - return self.name -@python_2_unicode_compatible -class City(models.Model): - name = models.CharField(max_length=30) +class City(NamedModel): point = models.PointField() - objects = models.GeoManager() - - def __str__(self): - return self.name # This is an inherited model from City class PennsylvaniaCity(City): county = models.CharField(max_length=30) founded = models.DateTimeField(null=True) - objects = models.GeoManager() # TODO: This should be implicitly inherited. + + # TODO: This should be implicitly inherited. + + objects = models.GeoManager() + + class Meta: + app_label = 'geoapp' -@python_2_unicode_compatible -class State(models.Model): - name = models.CharField(max_length=30) +class State(NamedModel): poly = models.PolygonField(null=null_flag) # Allowing NULL geometries here. - objects = models.GeoManager() - - def __str__(self): - return self.name -@python_2_unicode_compatible -class Track(models.Model): - name = models.CharField(max_length=30) +class Track(NamedModel): line = models.LineStringField() - objects = models.GeoManager() - - def __str__(self): - return self.name class Truth(models.Model): val = models.BooleanField(default=False) + objects = models.GeoManager() -if not spatialite: - @python_2_unicode_compatible - class Feature(models.Model): - name = models.CharField(max_length=20) - geom = models.GeometryField() - objects = models.GeoManager() + class Meta: + app_label = 'geoapp' + + +if not spatialite: + + class Feature(NamedModel): + geom = models.GeometryField() - def __str__(self): - return self.name class MinusOneSRID(models.Model): geom = models.PointField(srid=-1) # Minus one SRID. + objects = models.GeoManager() + + class Meta: + app_label = 'geoapp' diff --git a/django/contrib/gis/tests/geogapp/models.py b/django/contrib/gis/tests/geogapp/models.py index 1953bc5a29..ce637c38a5 100644 --- a/django/contrib/gis/tests/geogapp/models.py +++ b/django/contrib/gis/tests/geogapp/models.py @@ -3,31 +3,30 @@ from django.utils.encoding import python_2_unicode_compatible @python_2_unicode_compatible -class City(models.Model): +class NamedModel(models.Model): name = models.CharField(max_length=30) - point = models.PointField(geography=True) + objects = models.GeoManager() + class Meta: + abstract = True + app_label = 'geogapp' + def __str__(self): return self.name -@python_2_unicode_compatible -class Zipcode(models.Model): - code = models.CharField(max_length=10) +class City(NamedModel): + point = models.PointField(geography=True) + + +class Zipcode(NamedModel): poly = models.PolygonField(geography=True) - objects = models.GeoManager() - - def __str__(self): - return self.code -@python_2_unicode_compatible -class County(models.Model): - name = models.CharField(max_length=25) +class County(NamedModel): state = models.CharField(max_length=20) mpoly = models.MultiPolygonField(geography=True) - objects = models.GeoManager() def __str__(self): return ' County, '.join([self.name, self.state]) diff --git a/django/contrib/gis/tests/inspectapp/models.py b/django/contrib/gis/tests/inspectapp/models.py index 37c67a72fe..caf45fad9a 100644 --- a/django/contrib/gis/tests/inspectapp/models.py +++ b/django/contrib/gis/tests/inspectapp/models.py @@ -2,6 +2,7 @@ from django.contrib.gis.db import models class AllOGRFields(models.Model): + f_decimal = models.FloatField() f_float = models.FloatField() f_int = models.IntegerField() @@ -13,3 +14,6 @@ class AllOGRFields(models.Model): point = models.PointField() objects = models.GeoManager() + + class Meta: + app_label = 'inspectapp' diff --git a/django/contrib/gis/tests/layermap/models.py b/django/contrib/gis/tests/layermap/models.py index 1b66c6d94c..246af1458d 100644 --- a/django/contrib/gis/tests/layermap/models.py +++ b/django/contrib/gis/tests/layermap/models.py @@ -1,61 +1,75 @@ from django.contrib.gis.db import models +from django.utils.encoding import python_2_unicode_compatible -class State(models.Model): - name = models.CharField(max_length=20) +@python_2_unicode_compatible +class NamedModel(models.Model): + name = models.CharField(max_length=25) + objects = models.GeoManager() + class Meta: + abstract = True + app_label = 'layermap' -class County(models.Model): - name = models.CharField(max_length=25) + def __str__(self): + return self.name + + +class State(NamedModel): + pass + + +class County(NamedModel): state = models.ForeignKey(State) mpoly = models.MultiPolygonField(srid=4269) # Multipolygon in NAD83 - objects = models.GeoManager() -class CountyFeat(models.Model): - name = models.CharField(max_length=25) +class CountyFeat(NamedModel): poly = models.PolygonField(srid=4269) - objects = models.GeoManager() -class City(models.Model): - name = models.CharField(max_length=25) +class City(NamedModel): name_txt = models.TextField(default='') population = models.IntegerField() density = models.DecimalField(max_digits=7, decimal_places=1) dt = models.DateField() point = models.PointField() - objects = models.GeoManager() -class Interstate(models.Model): - name = models.CharField(max_length=20) +class Interstate(NamedModel): length = models.DecimalField(max_digits=6, decimal_places=2) path = models.LineStringField() - objects = models.GeoManager() # Same as `City` above, but for testing model inheritance. -class CityBase(models.Model): - name = models.CharField(max_length=25) +class CityBase(NamedModel): population = models.IntegerField() density = models.DecimalField(max_digits=7, decimal_places=1) point = models.PointField() - objects = models.GeoManager() class ICity1(CityBase): dt = models.DateField() + class Meta(CityBase.Meta): + pass + class ICity2(ICity1): dt_time = models.DateTimeField(auto_now=True) + class Meta(ICity1.Meta): + pass + class Invalid(models.Model): point = models.PointField() + class Meta: + app_label = 'layermap' + + # Mapping dictionaries for the models above. co_mapping = {'name': 'Name', 'state': {'name': 'State'}, # ForeignKey's use another mapping dictionary for the _related_ Model (State in this case). diff --git a/django/contrib/gis/tests/relatedapp/models.py b/django/contrib/gis/tests/relatedapp/models.py index 6d4b530c58..3b4364f7b9 100644 --- a/django/contrib/gis/tests/relatedapp/models.py +++ b/django/contrib/gis/tests/relatedapp/models.py @@ -2,21 +2,28 @@ from django.contrib.gis.db import models from django.utils.encoding import python_2_unicode_compatible -@python_2_unicode_compatible -class Location(models.Model): - point = models.PointField() +class SimpleModel(models.Model): + objects = models.GeoManager() + class Meta: + abstract = True + app_label = 'relatedapp' + + +@python_2_unicode_compatible +class Location(SimpleModel): + point = models.PointField() + def __str__(self): return self.point.wkt @python_2_unicode_compatible -class City(models.Model): +class City(SimpleModel): name = models.CharField(max_length=50) state = models.CharField(max_length=2) location = models.ForeignKey(Location) - objects = models.GeoManager() def __str__(self): return self.name @@ -24,17 +31,20 @@ class City(models.Model): class AugmentedLocation(Location): extra_text = models.TextField(blank=True) + objects = models.GeoManager() + class Meta: + app_label = 'relatedapp' -class DirectoryEntry(models.Model): + +class DirectoryEntry(SimpleModel): listing_text = models.CharField(max_length=50) location = models.ForeignKey(AugmentedLocation) - objects = models.GeoManager() @python_2_unicode_compatible -class Parcel(models.Model): +class Parcel(SimpleModel): name = models.CharField(max_length=30) city = models.ForeignKey(City) center1 = models.PointField() @@ -42,26 +52,22 @@ class Parcel(models.Model): center2 = models.PointField(srid=2276, db_column='mycenter') border1 = models.PolygonField() border2 = models.PolygonField(srid=2276) - objects = models.GeoManager() def __str__(self): return self.name # These use the GeoManager but do not have any geographic fields. -class Author(models.Model): +class Author(SimpleModel): name = models.CharField(max_length=100) dob = models.DateField() - objects = models.GeoManager() -class Article(models.Model): +class Article(SimpleModel): title = models.CharField(max_length=100) author = models.ForeignKey(Author, unique=True) - objects = models.GeoManager() -class Book(models.Model): +class Book(SimpleModel): title = models.CharField(max_length=100) author = models.ForeignKey(Author, related_name='books', null=True) - objects = models.GeoManager() From 6edd5b0793281865833edec17ac45b1ddb21ba50 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 1 Jan 2014 11:52:56 +0100 Subject: [PATCH 159/208] Fixed a few issues in previous commit. --- django/contrib/gis/tests/distapp/models.py | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/django/contrib/gis/tests/distapp/models.py b/django/contrib/gis/tests/distapp/models.py index d10ce76158..4490ca9213 100644 --- a/django/contrib/gis/tests/distapp/models.py +++ b/django/contrib/gis/tests/distapp/models.py @@ -33,23 +33,20 @@ class AustraliaCity(NamedModel): class CensusZipcode(NamedModel): "Model for a few South Texas ZIP codes (in original Census NAD83)." - name = models.CharField(max_length=5) poly = models.PolygonField(srid=4269) class SouthTexasZipcode(NamedModel): "Model for a few South Texas ZIP codes." - name = models.CharField(max_length=5) poly = models.PolygonField(srid=32140, null=True) class Interstate(NamedModel): "Geodetic model for U.S. Interstates." - name = models.CharField(max_length=10) path = models.LineStringField() class SouthTexasInterstate(NamedModel): "Projected model for South Texas Interstates." - name = models.CharField(max_length=10) + path = models.LineStringField(srid=32140) From fbbe7ca30c9bd4c1f1d4611118da6c746be89566 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Wed, 1 Jan 2014 12:07:43 +0100 Subject: [PATCH 160/208] Readded field unadvertantly removed in fedfd5030 --- django/contrib/gis/tests/geogapp/models.py | 1 + 1 file changed, 1 insertion(+) diff --git a/django/contrib/gis/tests/geogapp/models.py b/django/contrib/gis/tests/geogapp/models.py index ce637c38a5..f6f127ca96 100644 --- a/django/contrib/gis/tests/geogapp/models.py +++ b/django/contrib/gis/tests/geogapp/models.py @@ -21,6 +21,7 @@ class City(NamedModel): class Zipcode(NamedModel): + code = models.CharField(max_length=10) poly = models.PolygonField(geography=True) From 18d962f2e6cc8829d60d6f6dfb3ee3855fa5362e Mon Sep 17 00:00:00 2001 From: Preston Timmons Date: Tue, 31 Dec 2013 11:41:34 -0600 Subject: [PATCH 161/208] Fixed #21206 -- Fixed test discovery without labels Added test to verify an empty label performs discovery on the current working directory. --- django/test/runner.py | 4 ++- tests/test_runner/test_discover_runner.py | 36 ++++++++++++++++------- 2 files changed, 28 insertions(+), 12 deletions(-) diff --git a/django/test/runner.py b/django/test/runner.py index d8994d5ec2..d3c53ffc44 100644 --- a/django/test/runner.py +++ b/django/test/runner.py @@ -154,10 +154,12 @@ class DiscoverRunner(object): def is_discoverable(label): """ Check if a test label points to a python package or file directory. + + Relative labels like "." and ".." are seen as directories. """ try: mod = import_module(label) - except ImportError: + except (ImportError, TypeError): pass else: return hasattr(mod, '__path__') diff --git a/tests/test_runner/test_discover_runner.py b/tests/test_runner/test_discover_runner.py index fd68949678..0b723e3243 100644 --- a/tests/test_runner/test_discover_runner.py +++ b/tests/test_runner/test_discover_runner.py @@ -13,6 +13,18 @@ def expectedFailureIf(condition): return lambda func: func +@contextmanager +def change_cwd(directory): + current_dir = os.path.abspath(os.path.dirname(__file__)) + new_dir = os.path.join(current_dir, directory) + old_cwd = os.getcwd() + os.chdir(new_dir) + try: + yield + finally: + os.chdir(old_cwd) + + class DiscoverRunnerTest(TestCase): def test_dotted_test_module(self): @@ -51,23 +63,25 @@ class DiscoverRunnerTest(TestCase): self.assertEqual(count, 1) def test_file_path(self): - @contextmanager - def change_cwd_to_tests(): - """Change CWD to tests directory (one level up from this file)""" - current_dir = os.path.abspath(os.path.dirname(__file__)) - tests_dir = os.path.join(current_dir, '..') - old_cwd = os.getcwd() - os.chdir(tests_dir) - yield - os.chdir(old_cwd) - - with change_cwd_to_tests(): + with change_cwd(".."): count = DiscoverRunner().build_suite( ["test_discovery_sample/"], ).countTestCases() self.assertEqual(count, 3) + def test_empty_label(self): + """ + If the test label is empty, discovery should happen on the current + working directory. + """ + with change_cwd("."): + suite = DiscoverRunner().build_suite([]) + self.assertEqual( + suite._tests[0].id().split(".")[0], + os.path.basename(os.getcwd()), + ) + def test_empty_test_case(self): count = DiscoverRunner().build_suite( ["test_discovery_sample.tests_sample.EmptyTestCase"], From 2139e09d83aa40fa12d2a0b726d21521eec86583 Mon Sep 17 00:00:00 2001 From: Preston Timmons Date: Tue, 31 Dec 2013 14:47:14 -0600 Subject: [PATCH 162/208] Removed unused function in test_runner tests This was used for python 2.6 and unittest2 compatibility. It was forgotten when the code that used it was removed. --- tests/test_runner/test_discover_runner.py | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/tests/test_runner/test_discover_runner.py b/tests/test_runner/test_discover_runner.py index 0b723e3243..c0448bd43a 100644 --- a/tests/test_runner/test_discover_runner.py +++ b/tests/test_runner/test_discover_runner.py @@ -1,18 +1,11 @@ from contextlib import contextmanager import os -from unittest import expectedFailure, TestSuite, TextTestRunner, defaultTestLoader +from unittest import TestSuite, TextTestRunner, defaultTestLoader from django.test import TestCase from django.test.runner import DiscoverRunner -def expectedFailureIf(condition): - """Marks a test as an expected failure if ``condition`` is met.""" - if condition: - return expectedFailure - return lambda func: func - - @contextmanager def change_cwd(directory): current_dir = os.path.abspath(os.path.dirname(__file__)) From 8a2f304a798497373a19530e58d7290d13e35e6d Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 1 Jan 2014 16:48:16 +0100 Subject: [PATCH 163/208] Documented unicity rules in INSTALLED_APPS. Refs #12288, #21679. --- docs/ref/settings.txt | 33 +++++++++++++++++++++++---------- 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index 0fa463ebb9..62e7920c01 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -1286,9 +1286,12 @@ INSTALLED_APPS Default: ``()`` (Empty tuple) A tuple of strings designating all applications that are enabled in this -Django installation. Each string should be a full Python path to an -application configuration class or to a Python package containing a -application. :doc:`Learn more about applications `. +Django installation. Each string should be a dotted Python path to: + +* an application configuration class, or +* a package containing a application. + +:doc:`Learn more about application configurations `. .. versionchanged:: 1.7 @@ -1296,15 +1299,25 @@ application. :doc:`Learn more about applications `. .. admonition:: Use the application registry for introspection - Your code should never access :setting:`INSTALLED_APPS` directly. Use the - app registry, :attr:`django.apps.apps`, instead. + Your code should never access :setting:`INSTALLED_APPS` directly. Use + :attr:`django.apps.apps` instead. -.. admonition:: Application labels must be unique +.. admonition:: Application names and labels must be unique in + :setting:`INSTALLED_APPS` - Application labels (that is, the final part of the dotted path to - application packages) *must* be unique in :setting:`INSTALLED_APPS`. - For example, you can't include both ``django.contrib.auth`` and - ``myproject.auth``. + Application :attr:`names ` — the dotted Python + path to the application package — must be unique. There is no way to + include the same application twice, short of duplicating its code under + another name. + + Application :attr:`labels ` — by default the + final part of the name — must be unique too. For example, you can't + include both ``django.contrib.auth`` and ``myproject.auth``. However, you + can relabel an application with a custom configuration that defines a + different :attr:`~django.apps.AppConfig.label`. + + These rules apply regardless of whether :setting:`INSTALLED_APPS` + references application configuration classes on application packages. .. setting:: INTERNAL_IPS From f17d00278ee4a22421dc8148588d94fe7fa17427 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 1 Jan 2014 18:01:06 +0100 Subject: [PATCH 164/208] Wiped get_commands() cache when INSTALLED_APPS changes. Refs #21018, #21688. --- django/core/management/__init__.py | 54 ++++++++++++++---------------- django/test/signals.py | 3 ++ 2 files changed, 28 insertions(+), 29 deletions(-) diff --git a/django/core/management/__init__.py b/django/core/management/__init__.py index 3d6482f236..1b9597ee3d 100644 --- a/django/core/management/__init__.py +++ b/django/core/management/__init__.py @@ -11,15 +11,12 @@ from django.conf import settings from django.core.exceptions import ImproperlyConfigured from django.core.management.base import BaseCommand, CommandError, handle_default_options from django.core.management.color import color_style +from django.utils import lru_cache from django.utils import six # For backwards compatibility: get_version() used to be in this module. from django import get_version -# A cache of loaded commands, so that call_command -# doesn't have to reload every time it's called. -_commands = None - def find_commands(management_dir): """ @@ -85,6 +82,7 @@ def load_command_class(app_name, name): return module.Command() +@lru_cache.lru_cache(maxsize=None) def get_commands(): """ Returns a dictionary mapping command names to their callback applications. @@ -107,34 +105,32 @@ def get_commands(): The dictionary is cached on the first call and reused on subsequent calls. """ - global _commands - if _commands is None: - _commands = dict((name, 'django.core') for name in find_commands(__path__[0])) + commands = {name: 'django.core' for name in find_commands(__path__[0])} - # Find the installed apps + # Find the installed apps + try: + settings.INSTALLED_APPS + except ImproperlyConfigured: + # Still useful for commands that do not require functional + # settings, like startproject or help. + app_names = [] + else: + # Setup Django outside of the try/except block to avoid catching + # ImproperlyConfigured errors that aren't caused by the absence of + # a settings module. + django.setup() + app_configs = apps.get_app_configs() + app_names = [app_config.name for app_config in app_configs] + + # Find and load the management module for each installed app. + for app_name in app_names: try: - settings.INSTALLED_APPS - except ImproperlyConfigured: - # Still useful for commands that do not require functional - # settings, like startproject or help. - app_names = [] - else: - # Setup Django outside of the try/except block to avoid catching - # ImproperlyConfigured errors that aren't caused by the absence of - # a settings module. - django.setup() - app_configs = apps.get_app_configs() - app_names = [app_config.name for app_config in app_configs] + path = find_management_module(app_name) + commands.update({name: app_name for name in find_commands(path)}) + except ImportError: + pass # No management module - ignore this app - # Find and load the management module for each installed app. - for app_name in app_names: - try: - path = find_management_module(app_name) - _commands.update(dict((name, app_name) for name in find_commands(path))) - except ImportError: - pass # No management module - ignore this app - - return _commands + return commands def call_command(name, *args, **options): diff --git a/django/test/signals.py b/django/test/signals.py index b806592919..d5b98081b9 100644 --- a/django/test/signals.py +++ b/django/test/signals.py @@ -39,6 +39,9 @@ def update_installed_apps(**kwargs): # Rebuild templatetags module cache. from django.template import base base.templatetags_modules[:] = [] + # Rebuild management commands cache + from django.core.management import get_commands + get_commands.cache_clear() @receiver(setting_changed) From 0ce945a67151acf2c58bc35a47f4c3d45ff30085 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 1 Jan 2014 18:05:12 +0100 Subject: [PATCH 165/208] Fixed #21018 -- Reversed precedence order for management commands. --- django/core/management/__init__.py | 2 +- docs/ref/settings.txt | 4 ++++ docs/releases/1.7.txt | 12 +++++++++++ .../complex_app/management/__init__.py | 0 .../management/commands/__init__.py | 0 .../management/commands/duplicate.py | 7 +++++++ .../simple_app/management/__init__.py | 0 .../management/commands/__init__.py | 0 .../management/commands/duplicate.py | 7 +++++++ tests/admin_scripts/tests.py | 20 ++++++++++++++++++- 10 files changed, 50 insertions(+), 2 deletions(-) create mode 100644 tests/admin_scripts/complex_app/management/__init__.py create mode 100644 tests/admin_scripts/complex_app/management/commands/__init__.py create mode 100644 tests/admin_scripts/complex_app/management/commands/duplicate.py create mode 100644 tests/admin_scripts/simple_app/management/__init__.py create mode 100644 tests/admin_scripts/simple_app/management/commands/__init__.py create mode 100644 tests/admin_scripts/simple_app/management/commands/duplicate.py diff --git a/django/core/management/__init__.py b/django/core/management/__init__.py index 1b9597ee3d..33cef35b4c 100644 --- a/django/core/management/__init__.py +++ b/django/core/management/__init__.py @@ -120,7 +120,7 @@ def get_commands(): # a settings module. django.setup() app_configs = apps.get_app_configs() - app_names = [app_config.name for app_config in app_configs] + app_names = [app_config.name for app_config in reversed(app_configs)] # Find and load the management module for each installed app. for app_name in app_names: diff --git a/docs/ref/settings.txt b/docs/ref/settings.txt index 62e7920c01..4181d152ef 100644 --- a/docs/ref/settings.txt +++ b/docs/ref/settings.txt @@ -1319,6 +1319,10 @@ Django installation. Each string should be a dotted Python path to: These rules apply regardless of whether :setting:`INSTALLED_APPS` references application configuration classes on application packages. +When several applications provide different versions of the same resource +(template, static file, management command, translation), the application +listed first in :setting:`INSTALLED_APPS` has precedence. + .. setting:: INTERNAL_IPS INTERNAL_IPS diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index b559445e7c..fced7a7508 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -697,6 +697,18 @@ following changes that take effect immediately: * The ``only_installed`` argument of ``get_model`` and ``get_models`` no longer exists, nor does the ``seed_cache`` argument of ``get_model``. +Management commands and order of :setting:`INSTALLED_APPS` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When several applications provide management commands with the same name, +Django loads the command from the application that comes first in +:setting:`INSTALLED_APPS`. Previous versions loaded the command from the +applicatino that came last. + +This brings discovery of management commands in line with other parts of +Django that rely on the order of :setting:`INSTALLED_APPS`, such as static +files, templates, and translations. + Behavior of ``LocMemCache`` regarding pickle errors ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/tests/admin_scripts/complex_app/management/__init__.py b/tests/admin_scripts/complex_app/management/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/tests/admin_scripts/complex_app/management/commands/__init__.py b/tests/admin_scripts/complex_app/management/commands/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/tests/admin_scripts/complex_app/management/commands/duplicate.py b/tests/admin_scripts/complex_app/management/commands/duplicate.py new file mode 100644 index 0000000000..11b183843f --- /dev/null +++ b/tests/admin_scripts/complex_app/management/commands/duplicate.py @@ -0,0 +1,7 @@ +from django.core.management.base import NoArgsCommand + + +class Command(NoArgsCommand): + + def handle_noargs(self, **options): + self.stdout.write('complex_app') diff --git a/tests/admin_scripts/simple_app/management/__init__.py b/tests/admin_scripts/simple_app/management/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/tests/admin_scripts/simple_app/management/commands/__init__.py b/tests/admin_scripts/simple_app/management/commands/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/tests/admin_scripts/simple_app/management/commands/duplicate.py b/tests/admin_scripts/simple_app/management/commands/duplicate.py new file mode 100644 index 0000000000..a451f3991c --- /dev/null +++ b/tests/admin_scripts/simple_app/management/commands/duplicate.py @@ -0,0 +1,7 @@ +from django.core.management.base import NoArgsCommand + + +class Command(NoArgsCommand): + + def handle_noargs(self, **options): + self.stdout.write('simple_app') diff --git a/tests/admin_scripts/tests.py b/tests/admin_scripts/tests.py index 3587748c8e..e052a1a6d7 100644 --- a/tests/admin_scripts/tests.py +++ b/tests/admin_scripts/tests.py @@ -25,7 +25,7 @@ from django.test.utils import str_prefix from django.utils.encoding import force_text from django.utils._os import upath from django.utils.six import StringIO -from django.test import LiveServerTestCase +from django.test import LiveServerTestCase, TestCase test_dir = os.path.realpath(os.path.join(os.environ['DJANGO_TEST_TEMP_DIR'], 'test_project')) @@ -1469,6 +1469,24 @@ class CommandTypes(AdminScriptTestCase): self.assertOutput(out, str_prefix("EXECUTE:LabelCommand label=anotherlabel, options=[('no_color', False), ('pythonpath', None), ('settings', None), ('traceback', None), ('verbosity', %(_)s'1')]")) +class Discovery(TestCase): + + def test_precedence(self): + """ + Apps listed first in INSTALLED_APPS have precendence. + """ + with self.settings(INSTALLED_APPS=['admin_scripts.complex_app', + 'admin_scripts.simple_app']): + out = StringIO() + call_command('duplicate', stdout=out) + self.assertEqual(out.getvalue().strip(), 'complex_app') + with self.settings(INSTALLED_APPS=['admin_scripts.simple_app', + 'admin_scripts.complex_app']): + out = StringIO() + call_command('duplicate', stdout=out) + self.assertEqual(out.getvalue().strip(), 'simple_app') + + class ArgumentOrder(AdminScriptTestCase): """Tests for 2-stage argument parsing scheme. From 791142e8b3e35bb387f4efbb6c7f73f2171a7164 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Wed, 1 Jan 2014 09:37:52 -0800 Subject: [PATCH 166/208] Several small whitespace fixes for styleguide/flake8 violations --- django/contrib/gis/tests/distapp/models.py | 1 - django/contrib/gis/tests/geoapp/models.py | 4 ++-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/django/contrib/gis/tests/distapp/models.py b/django/contrib/gis/tests/distapp/models.py index 4490ca9213..4d95b219d7 100644 --- a/django/contrib/gis/tests/distapp/models.py +++ b/django/contrib/gis/tests/distapp/models.py @@ -49,4 +49,3 @@ class Interstate(NamedModel): class SouthTexasInterstate(NamedModel): "Projected model for South Texas Interstates." path = models.LineStringField(srid=32140) - diff --git a/django/contrib/gis/tests/geoapp/models.py b/django/contrib/gis/tests/geoapp/models.py index 3e1e927155..2550854b76 100644 --- a/django/contrib/gis/tests/geoapp/models.py +++ b/django/contrib/gis/tests/geoapp/models.py @@ -19,6 +19,7 @@ class NamedModel(models.Model): def __str__(self): return self.name + class Country(NamedModel): mpoly = models.MultiPolygonField() # SRID, by default, is 4326 @@ -37,7 +38,7 @@ class PennsylvaniaCity(City): objects = models.GeoManager() class Meta: - app_label = 'geoapp' + app_label = 'geoapp' class State(NamedModel): @@ -62,7 +63,6 @@ if not spatialite: class Feature(NamedModel): geom = models.GeometryField() - class MinusOneSRID(models.Model): geom = models.PointField(srid=-1) # Minus one SRID. From 30a42a4fc36edfad51f0e4f28e5c776434302d1c Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 1 Jan 2014 19:11:54 +0100 Subject: [PATCH 167/208] Adjusted previous commit for Python 3. --- django/core/management/__init__.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/django/core/management/__init__.py b/django/core/management/__init__.py index 33cef35b4c..5966d8929e 100644 --- a/django/core/management/__init__.py +++ b/django/core/management/__init__.py @@ -120,10 +120,10 @@ def get_commands(): # a settings module. django.setup() app_configs = apps.get_app_configs() - app_names = [app_config.name for app_config in reversed(app_configs)] + app_names = [app_config.name for app_config in app_configs] # Find and load the management module for each installed app. - for app_name in app_names: + for app_name in reversed(app_names): try: path = find_management_module(app_name) commands.update({name: app_name for name in find_commands(path)}) From 1386075f62dfdee4584e76e7d86dff72f5d3c7ed Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Wed, 1 Jan 2014 19:44:39 +0100 Subject: [PATCH 168/208] Updated release notes on app_label. Django determines automatically which application models belong to, provided the application can be imported without importing models. --- docs/ref/models/options.txt | 4 ++-- docs/releases/1.7.txt | 3 --- 2 files changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/ref/models/options.txt b/docs/ref/models/options.txt index c1bf34ba86..ba07dfaeb9 100644 --- a/docs/ref/models/options.txt +++ b/docs/ref/models/options.txt @@ -33,7 +33,7 @@ Available ``Meta`` options .. versionadded:: 1.7 ``app_label`` is no longer required for models that are defined - in a ``models`` package within an app. + outside the ``models`` module of an application. ``db_table`` ------------ @@ -81,7 +81,7 @@ Django quotes column and table names behind the scenes. db_table = '"name_left_in_lowercase"' - Such quoted names can also be used with Django's other supported database + Such quoted names can also be used with Django's other supported database backends; except for Oracle, however, the quotes have no effect. See the :ref:`Oracle notes ` for more details. diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index fced7a7508..2d040d92f9 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -466,9 +466,6 @@ Models ``Meta`` option allows you to customize (or disable) creation of the default add, change, and delete permissions. -* :attr:`~django.db.models.Options.app_label` is no longer required for models - that are defined in a ``models`` package within an app. - * Explicit :class:`~django.db.models.OneToOneField` for :ref:`multi-table-inheritance` are now discovered in abstract classes. From b2d78939d171f12ae7baaf0a2fa5a29b43bb2e47 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Wed, 1 Jan 2014 22:55:50 +0100 Subject: [PATCH 169/208] Prevented calling setup() inside catch_warnings When django.setup() (and then configure_logging) is called inside catch_warnings, logging setup is negatively affected (notably warnings.showwarning definition). --- tests/logging_tests/tests.py | 4 ++-- tests/runtests.py | 9 ++++++--- 2 files changed, 8 insertions(+), 5 deletions(-) diff --git a/tests/logging_tests/tests.py b/tests/logging_tests/tests.py index f020bfddef..5b536f9e82 100644 --- a/tests/logging_tests/tests.py +++ b/tests/logging_tests/tests.py @@ -91,8 +91,8 @@ class WarningLoggerTests(TestCase): """ def setUp(self): # If tests are invoke with "-Wall" (or any -W flag actually) then - # warning logging gets disabled (see django/conf/__init__.py). However, - # these tests expect warnings to be logged, so manually force warnings + # warning logging gets disabled (see configure_logging in django/utils/log.py). + # However, these tests expect warnings to be logged, so manually force warnings # to the logs. Use getattr() here because the logging capture state is # undocumented and (I assume) brittle. self._old_capture_state = bool(getattr(logging, '_warnings_showwarning', False)) diff --git a/tests/runtests.py b/tests/runtests.py index e33533a083..bb14a27fd6 100755 --- a/tests/runtests.py +++ b/tests/runtests.py @@ -125,10 +125,13 @@ def setup(verbosity, test_labels): handler = logging.StreamHandler() logger.addHandler(handler) + warnings.filterwarnings( + 'ignore', + 'django.contrib.comments is deprecated and will be removed before Django 1.8.', + DeprecationWarning + ) # Load all the ALWAYS_INSTALLED_APPS. - with warnings.catch_warnings(): - warnings.filterwarnings('ignore', 'django.contrib.comments is deprecated and will be removed before Django 1.8.', DeprecationWarning) - django.setup() + django.setup() # Load all the test model apps. test_modules = get_test_modules() From 7a30eab06e05f9c5901ad2f70378948450473c88 Mon Sep 17 00:00:00 2001 From: Marc Tamlyn Date: Thu, 2 Jan 2014 09:06:52 +0000 Subject: [PATCH 170/208] Fix typo in 0ce945a67151acf2c58bc35a47f4c3d45ff30085. Thanks to Loic for the report. --- docs/releases/1.7.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index 2d040d92f9..c684454181 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -700,7 +700,7 @@ Management commands and order of :setting:`INSTALLED_APPS` When several applications provide management commands with the same name, Django loads the command from the application that comes first in :setting:`INSTALLED_APPS`. Previous versions loaded the command from the -applicatino that came last. +application that came last. This brings discovery of management commands in line with other parts of Django that rely on the order of :setting:`INSTALLED_APPS`, such as static From 6dd8631617de56aae72f7d6b3708b83459d629c2 Mon Sep 17 00:00:00 2001 From: Frank Tobia Date: Thu, 2 Jan 2014 14:22:52 -0500 Subject: [PATCH 171/208] Fixed typos. Changed grammar. Minor typos. Some grammar changes. --- docs/topics/db/sql.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/topics/db/sql.txt b/docs/topics/db/sql.txt index 1369ed84f5..1b806ca42f 100644 --- a/docs/topics/db/sql.txt +++ b/docs/topics/db/sql.txt @@ -23,11 +23,11 @@ return model instances: .. method:: Manager.raw(raw_query, params=None, translations=None) -This method method takes a raw SQL query, executes it, and returns a +This method takes a raw SQL query, executes it, and returns a ``django.db.models.query.RawQuerySet`` instance. This ``RawQuerySet`` instance -can be iterated over just like an normal QuerySet to provide object instances. +can be iterated over just like a normal QuerySet to provide object instances. -This is best illustrated with an example. Suppose you've got the following model:: +This is best illustrated with an example. Suppose you have the following model:: class Person(models.Model): first_name = models.CharField(...) @@ -108,7 +108,7 @@ write:: >>> first_person = Person.objects.raw('SELECT * from myapp_person')[0] However, the indexing and slicing are not performed at the database level. If -you have a big amount of ``Person`` objects in your database, it is more +you have a large number of ``Person`` objects in your database, it is more efficient to limit the query at the SQL level:: >>> first_person = Person.objects.raw('SELECT * from myapp_person LIMIT 1')[0] @@ -323,4 +323,4 @@ is equivalent to: try: c.execute(...) finally: - c.close() \ No newline at end of file + c.close() From aaf5b3e7aad6fc8250143655854cc03c3b0a68c8 Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Thu, 2 Jan 2014 20:43:45 +0100 Subject: [PATCH 172/208] Moved django.setup() to ManagementUtility In get_commands, setup() might already have been called, for example when the management command is called through call_command. Moving setup() to ManagementUtility so as it is only called when the command is run from command line. --- django/core/management/__init__.py | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/django/core/management/__init__.py b/django/core/management/__init__.py index 5966d8929e..34597bfa5f 100644 --- a/django/core/management/__init__.py +++ b/django/core/management/__init__.py @@ -115,10 +115,6 @@ def get_commands(): # settings, like startproject or help. app_names = [] else: - # Setup Django outside of the try/except block to avoid catching - # ImproperlyConfigured errors that aren't caused by the absence of - # a settings module. - django.setup() app_configs = apps.get_app_configs() app_names = [app_config.name for app_config in app_configs] @@ -389,6 +385,12 @@ class ManagementUtility(object): except: # Needed because parser.parse_args can raise SystemExit pass # Ignore any option errors at this point. + try: + django.setup() + except ImproperlyConfigured: + # Some commands are supposed to work without configured settings + pass + try: subcommand = self.argv[1] except IndexError: From 44d40ba5216f396aabaee6c7a0c7be75e1173ff2 Mon Sep 17 00:00:00 2001 From: Nathan Smith Date: Thu, 2 Jan 2014 15:14:11 -0500 Subject: [PATCH 173/208] Fixed minor typos. --- docs/ref/contrib/gis/geos.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/ref/contrib/gis/geos.txt b/docs/ref/contrib/gis/geos.txt index 769c2cdd32..4a2a26b725 100644 --- a/docs/ref/contrib/gis/geos.txt +++ b/docs/ref/contrib/gis/geos.txt @@ -303,7 +303,7 @@ geometry. This should only be used for geometries with an SRID of .. attribute:: GEOSGeometry.ogr Returns an :class:`~django.contrib.gis.gdal.OGRGeometry` object -correspondg to the GEOS geometry. +corresponding to the GEOS geometry. .. note:: @@ -541,7 +541,7 @@ corresponding to the SRID of the geometry or ``None``. .. method:: GEOSGeometry.transform(ct, clone=False) -Transforms the geometry according to the given coordinate transformation paramter +Transforms the geometry according to the given coordinate transformation parameter (``ct``), which may be an integer SRID, spatial reference WKT string, a PROJ.4 string, a :class:`~django.contrib.gis.gdal.SpatialReference` object, or a :class:`~django.contrib.gis.gdal.CoordTransform` object. By default, the geometry From 07711e999779eff4296d1a363c1131dbb14acae2 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Thu, 2 Jan 2014 16:28:56 -0500 Subject: [PATCH 174/208] Fixed #21722 -- Added a warning for avoiding XSS vulnerabilities when reusing built-in filters. Thanks Stephen McDonald for the suggestion. --- docs/howto/custom-template-tags.txt | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/howto/custom-template-tags.txt b/docs/howto/custom-template-tags.txt index 1f6d2d5c75..b5cbf571b7 100644 --- a/docs/howto/custom-template-tags.txt +++ b/docs/howto/custom-template-tags.txt @@ -339,6 +339,34 @@ Template filter code falls into one of two situations: handle the auto-escaping issues and return a safe string, the ``is_safe`` flag won't change anything either way. +.. warning:: Avoiding XSS vulnerabilities when reusing built-in filters + + Be careful when reusing Django's built-in filters. You'll need to pass + ``autoescape=True`` to the filter in order to get the proper autoescaping + behavior and avoid a cross-site script vulnerability. + + For example, if you wanted to write a custom filter called + ``urlize_and_linebreaks`` that combined the :tfilter:`urlize` and + :tfilter:`linebreaksbr` filters, the filter would look like:: + + from django.template.defaultfilters import linebreaksbr, urlize + + @register.filter + def urlize_and_linebreaks(text): + return linebreaksbr(urlize(text, autoescape=True), autoescape=True) + + Then: + + .. code-block:: html+django + + {{ comment|urlize_and_linebreaks }} + + would be equivalent to: + + .. code-block:: html+django + + {{ comment|urlize|linebreaksbr }} + .. _filters-timezones: Filters and time zones From 449ede03b84df7edda8fe5410481f4fa24394d4a Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 2 Jan 2014 23:06:25 +0100 Subject: [PATCH 175/208] Changed convention for modules storing AppConfigs. The app/apps dichotomy was more confusing than valuable. --- docs/ref/applications.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt index ed3f33a2cc..0713da76ed 100644 --- a/docs/ref/applications.txt +++ b/docs/ref/applications.txt @@ -59,7 +59,7 @@ For application authors If you're creating a pluggable app called "Rock ’n’ roll", here's how you would provide a proper name for the admin:: - # rock_n_roll/app.py + # rock_n_roll/apps.py from django.apps import AppConfig @@ -67,11 +67,11 @@ would provide a proper name for the admin:: name = 'rock_n_roll' verbose_name = "Rock ’n’ roll" -You would then tell your users to add ``'rock_n_roll.app.RockNRollConfig'`` to -their :setting:`INSTALLED_APPS`. +You would then tell your users to add ``'rock_n_roll.apps.RockNRollConfig'`` +to their :setting:`INSTALLED_APPS`. The recommended convention is to put the configuration class in a submodule of -the application called ``app``. However, this isn't enforced by Django. +the application called ``apps``. However, this isn't enforced by Django. You must include the :attr:`~django.apps.AppConfig.name` attribute for Django to determine which application this configuration applies to. You can define From 756a6accdbe1d717073f3d08605a123e89982713 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Thu, 2 Jan 2014 23:14:54 +0100 Subject: [PATCH 176/208] Updated my bio. --- docs/internals/committers.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/internals/committers.txt b/docs/internals/committers.txt index 0da26a31eb..58f0de4a84 100644 --- a/docs/internals/committers.txt +++ b/docs/internals/committers.txt @@ -394,10 +394,10 @@ Tim Graham a continuous integration server, and likes proving that Django is a good choice for enterprise software. - He works in a `management consulting company`_ in Paris, France. + He's the CTO of Oscaro_, an e-commerce company based in Paris, France. .. _Aymeric Augustin: https://myks.org/ - .. _management consulting company: http://www.polyconseil.fr/ + .. _Oscaro: http://www.oscaro.com/ `Claude Paroz`_ Claude is a former teacher who fell in love with free software at the From ed2828f0a0263116618e9f338f9604d7387f10f7 Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Fri, 3 Jan 2014 00:31:53 +0100 Subject: [PATCH 177/208] Fixed a few flaky selenium tests. Many thanks go to David Burns (@AutomatedTester) for helping me understand css selectors and pointing me towards the correct selenium methods. --- django/contrib/admin/tests.py | 23 ++++++++++++++++++++++- tests/admin_widgets/tests.py | 22 ++++++---------------- 2 files changed, 28 insertions(+), 17 deletions(-) diff --git a/django/contrib/admin/tests.py b/django/contrib/admin/tests.py index 248a5798dd..a146539f82 100644 --- a/django/contrib/admin/tests.py +++ b/django/contrib/admin/tests.py @@ -51,8 +51,29 @@ class AdminSeleniumWebDriverTestCase(StaticLiveServerCase): Helper function that blocks until the element with the given tag name is found on the page. """ + self.wait_for(tag_name, timeout) + + def wait_for(self, css_selector, timeout=10): + """ + Helper function that blocks until an css selector is found on the page. + """ + from selenium.common.exceptions import NoSuchElementException, WebDriverException + from selenium.webdriver.common.by import By + from selenium.webdriver.support import expected_conditions as ec self.wait_until( - lambda driver: driver.find_element_by_tag_name(tag_name), + ec.presence_of_element_located((By.CSS_SELECTOR, css_selector)), + timeout + ) + + def wait_for_text(self, css_selector, text, timeout=10): + """ + Helper function that blocks until the text is found in the css selector. + """ + from selenium.webdriver.common.by import By + from selenium.webdriver.support import expected_conditions as ec + self.wait_until( + ec.text_to_be_present_in_element_value( + (By.CSS_SELECTOR, css_selector), text), timeout ) diff --git a/tests/admin_widgets/tests.py b/tests/admin_widgets/tests.py index 33833f3eff..794cd7924c 100644 --- a/tests/admin_widgets/tests.py +++ b/tests/admin_widgets/tests.py @@ -993,9 +993,7 @@ class AdminRawIdWidgetSeleniumFirefoxTests(AdminSeleniumWebDriverTestCase): # The field now contains the selected band's id self.selenium.switch_to_window(main_window) - self.assertEqual( - self.selenium.find_element_by_id('id_main_band').get_attribute('value'), - '42') + self.wait_for_text('#id_main_band', '42') # Reopen the popup window and click on another band self.selenium.find_element_by_id('lookup_id_main_band').click() @@ -1007,9 +1005,7 @@ class AdminRawIdWidgetSeleniumFirefoxTests(AdminSeleniumWebDriverTestCase): # The field now contains the other selected band's id self.selenium.switch_to_window(main_window) - self.assertEqual( - self.selenium.find_element_by_id('id_main_band').get_attribute('value'), - '98') + self.wait_for_text('#id_main_band', '98') def test_many_to_many(self): self.admin_login(username='super', password='secret', login_url='/') @@ -1032,9 +1028,7 @@ class AdminRawIdWidgetSeleniumFirefoxTests(AdminSeleniumWebDriverTestCase): # The field now contains the selected band's id self.selenium.switch_to_window(main_window) - self.assertEqual( - self.selenium.find_element_by_id('id_supporting_bands').get_attribute('value'), - '42') + self.wait_for_text('#id_supporting_bands', '42') # Reopen the popup window and click on another band self.selenium.find_element_by_id('lookup_id_supporting_bands').click() @@ -1046,9 +1040,7 @@ class AdminRawIdWidgetSeleniumFirefoxTests(AdminSeleniumWebDriverTestCase): # The field now contains the two selected bands' ids self.selenium.switch_to_window(main_window) - self.assertEqual( - self.selenium.find_element_by_id('id_supporting_bands').get_attribute('value'), - '42,98') + self.wait_for_text('#id_supporting_bands', '42,98') class AdminRawIdWidgetSeleniumChromeTests(AdminRawIdWidgetSeleniumFirefoxTests): @@ -1087,10 +1079,8 @@ class RelatedFieldWidgetSeleniumFirefoxTests(AdminSeleniumWebDriverTestCase): save_button_css_selector = '.submit-row > input[type=submit]' self.selenium.find_element_by_css_selector(save_button_css_selector).click() self.selenium.switch_to_window(main_window) - # Wait up to 2 seconds for the new option to show up after clicking save in the popup. - self.selenium.implicitly_wait(2) - self.selenium.find_element_by_css_selector('#id_user option[value=newuser]') - self.selenium.implicitly_wait(0) + # The field now contains the new user + self.wait_for('#id_user option[value="newuser"]') # Go ahead and submit the form to make sure it works self.selenium.find_element_by_css_selector(save_button_css_selector).click() From b1a399b8644a2b705c2ceb4fabb47172c31ff6c9 Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Fri, 3 Jan 2014 00:42:03 +0100 Subject: [PATCH 178/208] Removed unneeded import. --- django/contrib/admin/tests.py | 1 - 1 file changed, 1 deletion(-) diff --git a/django/contrib/admin/tests.py b/django/contrib/admin/tests.py index a146539f82..c035392e16 100644 --- a/django/contrib/admin/tests.py +++ b/django/contrib/admin/tests.py @@ -57,7 +57,6 @@ class AdminSeleniumWebDriverTestCase(StaticLiveServerCase): """ Helper function that blocks until an css selector is found on the page. """ - from selenium.common.exceptions import NoSuchElementException, WebDriverException from selenium.webdriver.common.by import By from selenium.webdriver.support import expected_conditions as ec self.wait_until( From 7d0a5190328f277b97b1f55171e1fecb22a1e461 Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Fri, 3 Jan 2014 00:44:49 +0100 Subject: [PATCH 179/208] Revert "Fixed #21227 -- Added workaround for selenium test failures" This reverts commit 08c9ab5a0f564a3ac7803e6a97fae855f2e0524e. --- django/contrib/admin/tests.py | 1 - tests/view_tests/tests/test_i18n.py | 1 - 2 files changed, 2 deletions(-) diff --git a/django/contrib/admin/tests.py b/django/contrib/admin/tests.py index c035392e16..72cb0606f3 100644 --- a/django/contrib/admin/tests.py +++ b/django/contrib/admin/tests.py @@ -32,7 +32,6 @@ class AdminSeleniumWebDriverTestCase(StaticLiveServerCase): @classmethod def _tearDownClassInternal(cls): if hasattr(cls, 'selenium'): - cls.selenium.refresh() # see ticket #21227 cls.selenium.quit() super(AdminSeleniumWebDriverTestCase, cls)._tearDownClassInternal() diff --git a/tests/view_tests/tests/test_i18n.py b/tests/view_tests/tests/test_i18n.py index 35b37b3ea1..a939fd6fc1 100644 --- a/tests/view_tests/tests/test_i18n.py +++ b/tests/view_tests/tests/test_i18n.py @@ -192,7 +192,6 @@ class JavascriptI18nTests(LiveServerTestCase): @classmethod def tearDownClass(cls): - cls.selenium.refresh() # see ticket #21227 cls.selenium.quit() super(JavascriptI18nTests, cls).tearDownClass() From ea83102d0f0c215ae2bd16a2c8c474ce615bad9a Mon Sep 17 00:00:00 2001 From: Vajrasky Kok Date: Sat, 7 Dec 2013 15:13:20 +0800 Subject: [PATCH 180/208] Fixed #21319 -- Added documentation for the Form.fields attribute. Thanks pydanny for the report. Also, added documentation about base_fields attribute and its difference with fields attribute. --- docs/ref/forms/api.txt | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/docs/ref/forms/api.txt b/docs/ref/forms/api.txt index ef4da9479e..c8f302b924 100644 --- a/docs/ref/forms/api.txt +++ b/docs/ref/forms/api.txt @@ -205,6 +205,40 @@ precedence:: Url: Comment: +Accessing the fields from the form +---------------------------------- + +.. attribute:: Form.fields + +You can access the fields of :class:`Form` instance from its ``fields`` +attribute:: + + >>> for row in f.fields.values(): print(row) + ... + + + + >>> f.fields['name'] + + +You can alter the field of :class:`Form` instance to change the way it is +presented in the form:: + + >>> f.as_table().split('\n')[0] + 'Name:' + >>> f.fields['name'].label = "Username" + >>> f.as_table().split('\n')[0] + 'Username:' + +Beware not to alter the ``base_fields`` attribute because this modification +will influence all subsequent ``ContactForm`` instances within the same Python +process:: + + >>> f.base_fields['name'].label = "Username" + >>> another_f = CommentForm(auto_id=False) + >>> another_f.as_table().split('\n')[0] + 'Username:' + Accessing "clean" data ---------------------- From 3bc6b18cb92462ff5ae54efd0fce5340e9149b0f Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Fri, 3 Jan 2014 11:25:24 +0100 Subject: [PATCH 181/208] Fixed selenium failure. This fixes (at least according to tests on the ci itself) admin_widgets.tests.RelatedFieldWidgetSeleniumFirefoxTests.test_foreign_key_using_to_field (http://ci.djangoproject.com/job/Django/database=mysql_gis,python=python2.7/3792/testReport/junit/admin_widgets.tests/RelatedFieldWidgetSeleniumFirefoxTests/test_foreign_key_using_to_field/) The cause for this issue seems to be that wait_page_loaded was executed before click fired and as such no profile got saved (again just an educated guess, but with this fix I can no longer reproduce it -- fingers crossed). --- django/contrib/admin/tests.py | 12 ++++++++++++ tests/admin_widgets/tests.py | 10 +++++----- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/django/contrib/admin/tests.py b/django/contrib/admin/tests.py index 72cb0606f3..40fd10089b 100644 --- a/django/contrib/admin/tests.py +++ b/django/contrib/admin/tests.py @@ -69,6 +69,18 @@ class AdminSeleniumWebDriverTestCase(StaticLiveServerCase): """ from selenium.webdriver.common.by import By from selenium.webdriver.support import expected_conditions as ec + self.wait_until( + ec.text_to_be_present_in_element( + (By.CSS_SELECTOR, css_selector), text), + timeout + ) + + def wait_for_value(self, css_selector, text, timeout=10): + """ + Helper function that blocks until the value is found in the css selector. + """ + from selenium.webdriver.common.by import By + from selenium.webdriver.support import expected_conditions as ec self.wait_until( ec.text_to_be_present_in_element_value( (By.CSS_SELECTOR, css_selector), text), diff --git a/tests/admin_widgets/tests.py b/tests/admin_widgets/tests.py index 794cd7924c..29dd5750ae 100644 --- a/tests/admin_widgets/tests.py +++ b/tests/admin_widgets/tests.py @@ -993,7 +993,7 @@ class AdminRawIdWidgetSeleniumFirefoxTests(AdminSeleniumWebDriverTestCase): # The field now contains the selected band's id self.selenium.switch_to_window(main_window) - self.wait_for_text('#id_main_band', '42') + self.wait_for_value('#id_main_band', '42') # Reopen the popup window and click on another band self.selenium.find_element_by_id('lookup_id_main_band').click() @@ -1005,7 +1005,7 @@ class AdminRawIdWidgetSeleniumFirefoxTests(AdminSeleniumWebDriverTestCase): # The field now contains the other selected band's id self.selenium.switch_to_window(main_window) - self.wait_for_text('#id_main_band', '98') + self.wait_for_value('#id_main_band', '98') def test_many_to_many(self): self.admin_login(username='super', password='secret', login_url='/') @@ -1028,7 +1028,7 @@ class AdminRawIdWidgetSeleniumFirefoxTests(AdminSeleniumWebDriverTestCase): # The field now contains the selected band's id self.selenium.switch_to_window(main_window) - self.wait_for_text('#id_supporting_bands', '42') + self.wait_for_value('#id_supporting_bands', '42') # Reopen the popup window and click on another band self.selenium.find_element_by_id('lookup_id_supporting_bands').click() @@ -1040,7 +1040,7 @@ class AdminRawIdWidgetSeleniumFirefoxTests(AdminSeleniumWebDriverTestCase): # The field now contains the two selected bands' ids self.selenium.switch_to_window(main_window) - self.wait_for_text('#id_supporting_bands', '42,98') + self.wait_for_value('#id_supporting_bands', '42,98') class AdminRawIdWidgetSeleniumChromeTests(AdminRawIdWidgetSeleniumFirefoxTests): @@ -1084,7 +1084,7 @@ class RelatedFieldWidgetSeleniumFirefoxTests(AdminSeleniumWebDriverTestCase): # Go ahead and submit the form to make sure it works self.selenium.find_element_by_css_selector(save_button_css_selector).click() - self.wait_page_loaded() + self.wait_for_text('li.success', 'The profile "newuser" was added successfully.') profiles = models.Profile.objects.all() self.assertEqual(len(profiles), 1) self.assertEqual(profiles[0].user.username, username_value) From a61c4293745164d3a76e7d82d75102f1906590ff Mon Sep 17 00:00:00 2001 From: Florian Apolloner Date: Fri, 3 Jan 2014 11:32:33 +0100 Subject: [PATCH 182/208] Added build to flake8.exclude. --- setup.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.cfg b/setup.cfg index ac1e029e90..ef3fc9c873 100644 --- a/setup.cfg +++ b/setup.cfg @@ -3,7 +3,7 @@ doc_files = docs extras AUTHORS INSTALL LICENSE README.rst install-script = scripts/rpm-install.sh [flake8] -exclude=.git,./django/utils/dictconfig.py,./django/contrib/comments/*,./django/utils/unittest.py,./django/utils/lru_cache.py,./tests/comment_tests/*,./django/test/_doctest.py,./django/utils/six.py,./django/conf/app_template/* +exclude=build,.git,./django/utils/dictconfig.py,./django/contrib/comments/*,./django/utils/unittest.py,./django/utils/lru_cache.py,./tests/comment_tests/*,./django/test/_doctest.py,./django/utils/six.py,./django/conf/app_template/* ignore=E128,E501,W601 [metadata] From 196f0a356df9c5dbdc28b73cf45b57cc7c43af9a Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Thu, 2 Jan 2014 21:36:15 +0100 Subject: [PATCH 183/208] Suppressed ResourceWarning in files tests --- tests/files/tests.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/tests/files/tests.py b/tests/files/tests.py index 43138d9b57..f562b5748d 100644 --- a/tests/files/tests.py +++ b/tests/files/tests.py @@ -161,9 +161,9 @@ class InconsistentGetImageDimensionsBug(unittest.TestCase): Multiple calls of get_image_dimensions() should return the same size. """ img_path = os.path.join(os.path.dirname(upath(__file__)), "test.png") - with open(img_path, 'rb') as file: - image = images.ImageFile(file) - image_pil = Image.open(img_path) + with open(img_path, 'rb') as fh: + image = images.ImageFile(fh) + image_pil = Image.open(fh) size_1 = images.get_image_dimensions(image) size_2 = images.get_image_dimensions(image) self.assertEqual(image_pil.size, size_1) @@ -180,7 +180,8 @@ class InconsistentGetImageDimensionsBug(unittest.TestCase): size = images.get_image_dimensions(img_path) except zlib.error: self.fail("Exception raised from get_image_dimensions().") - self.assertEqual(size, Image.open(img_path).size) + with open(img_path, 'rb') as fh: + self.assertEqual(size, Image.open(fh).size) class FileMoveSafeTests(unittest.TestCase): From e6800ea136aaa882682dbb7dc54423c5f002b551 Mon Sep 17 00:00:00 2001 From: Tianyi Wang Date: Fri, 3 Jan 2014 16:04:38 +0000 Subject: [PATCH 184/208] Fixed #21728 -- Corrected an inadvertent path change in docs/intro/contributing.txt. --- docs/intro/contributing.txt | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/intro/contributing.txt b/docs/intro/contributing.txt index 7250f9e676..9c9482d20a 100644 --- a/docs/intro/contributing.txt +++ b/docs/intro/contributing.txt @@ -237,7 +237,7 @@ widget. Before we make those changes though, we're going to write a couple tests to verify that our modification functions correctly and continues to function correctly in the future. -Navigate to Django's ``tests/admin_widgets/`` folder and +Navigate to Django's ``tests/regressiontests/admin_widgets/`` folder and open the ``tests.py`` file. Add the following code on line 269 right before the ``AdminFileWidgetTest`` class:: @@ -467,10 +467,11 @@ This patch file contains all your changes and should look this: Relationship fields =================== - diff --git a/tests/admin_widgets/tests.py b/tests/admin_widgets/tests.py + diff --git a/tests/regressiontests/admin_widgets/tests.py b/tests/regressiontests/admin_widgets/tests.py index 4b11543..94acc6d 100644 - --- a/tests/admin_widgets/tests.py - +++ b/tests/admin_widgets/tests.py + --- a/tests/regressiontests/admin_widgets/tests.py + +++ b/tests/regressiontests/admin_widgets/tests.py + @@ -265,6 +265,35 @@ class AdminSplitDateTimeWidgetTest(DjangoTestCase): '

    Datum:
    Zeit:

    ', ) From 4d27d311f6d598b799ce2cb2df88a1dc54ab8166 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Fri, 3 Jan 2014 12:02:58 -0500 Subject: [PATCH 185/208] Fixed a sentence in the session security docs; thanks claudep. --- docs/topics/http/sessions.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/topics/http/sessions.txt b/docs/topics/http/sessions.txt index f7e8807945..2cf4751212 100644 --- a/docs/topics/http/sessions.txt +++ b/docs/topics/http/sessions.txt @@ -655,8 +655,8 @@ Session security ================ Subdomains within a site are able to set cookies on the client for the whole -domain. This makes session fixation possible if all subdomains are not -controlled by trusted users (or, are at least unable to set cookies). +domain. This makes session fixation possible if cookies are permitted from +subdomains not controlled by trusted users. For example, an attacker could log into ``good.example.com`` and get a valid session for their account. If the attacker has control over ``bad.example.com``, From c717ebbfecd248d1a0ffeffa6d167109936fbe3f Mon Sep 17 00:00:00 2001 From: Claude Paroz Date: Sat, 4 Jan 2014 16:11:21 +0100 Subject: [PATCH 186/208] Fixed #21730 -- Removed superfluous db_index in custom auth docs Thanks rafalp for the report. --- docs/topics/auth/customizing.txt | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/topics/auth/customizing.txt b/docs/topics/auth/customizing.txt index 7b15a2f8d3..bdb5b19894 100644 --- a/docs/topics/auth/customizing.txt +++ b/docs/topics/auth/customizing.txt @@ -477,7 +477,7 @@ password resets. You must then provide some key implementation details: as the identifying field:: class MyUser(AbstractBaseUser): - identifier = models.CharField(max_length=40, unique=True, db_index=True) + identifier = models.CharField(max_length=40, unique=True) ... USERNAME_FIELD = 'identifier' @@ -965,7 +965,6 @@ authentication app:: verbose_name='email address', max_length=255, unique=True, - db_index=True, ) date_of_birth = models.DateField() is_active = models.BooleanField(default=True) From 2692a0c6217b1b5ea2730f5861cb96c991fc8673 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sat, 4 Jan 2014 23:06:50 +0100 Subject: [PATCH 187/208] Fixed `python scripts/manage_translations.py update_catalogs`. It used to generate languages 'e' and 'n'. --- scripts/manage_translations.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/manage_translations.py b/scripts/manage_translations.py index 83d5b87c87..078cc7f9bb 100644 --- a/scripts/manage_translations.py +++ b/scripts/manage_translations.py @@ -88,7 +88,7 @@ def update_catalogs(resources=None, languages=None): os.chdir(os.path.join(os.getcwd(), 'django')) print("Updating main en catalog") - call_command('makemessages', locale='en') + call_command('makemessages', locale=['en']) _check_diff('core', os.path.join(os.getcwd(), 'conf', 'locale')) # Contrib catalogs @@ -96,9 +96,9 @@ def update_catalogs(resources=None, languages=None): os.chdir(os.path.join(dir_, '..')) print("Updating en catalog in %s" % dir_) if name.endswith('-js'): - call_command('makemessages', locale='en', domain='djangojs') + call_command('makemessages', locale=['en'], domain='djangojs') else: - call_command('makemessages', locale='en') + call_command('makemessages', locale=['en']) _check_diff(name, dir_) From a7588e2e220bab47bf18601b173d6bfd429f5931 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 5 Jan 2014 09:29:54 +0100 Subject: [PATCH 188/208] Removed useless model definitions. Surprisingly, this commit doesn't change any behavior at all. When a model is defined with the same name as another model in the same app, the definition of the first class is bound to the name of the class regardless of the definition of the second class. --- tests/admin_views/admin.py | 48 ++++++++++++----------------------- tests/defer_regress/models.py | 4 --- 2 files changed, 16 insertions(+), 36 deletions(-) diff --git a/tests/admin_views/admin.py b/tests/admin_views/admin.py index 5a895958b0..ae12764897 100644 --- a/tests/admin_views/admin.py +++ b/tests/admin_views/admin.py @@ -12,28 +12,29 @@ from django.core.files.storage import FileSystemStorage from django.core.mail import EmailMessage from django.core.servers.basehttp import FileWrapper from django.conf.urls import patterns, url -from django.db import models from django.forms.models import BaseModelFormSet from django.http import HttpResponse, StreamingHttpResponse from django.contrib.admin import BooleanFieldListFilter from django.utils.six import StringIO -from .models import (Article, Chapter, Account, Media, Child, Parent, Picture, - Widget, DooHickey, Grommet, Whatsit, FancyDoodad, Category, Link, +from .models import (Article, Chapter, Child, Parent, Picture, Widget, + DooHickey, Grommet, Whatsit, FancyDoodad, Category, Link, PrePopulatedPost, PrePopulatedSubPost, CustomArticle, Section, - ModelWithStringPrimaryKey, Color, Thing, Actor, Inquisition, Sketch, Person, - Persona, Subscriber, ExternalSubscriber, OldSubscriber, Vodcast, EmptyModel, - Fabric, Gallery, Language, Recommendation, Recommender, Collector, Post, - Gadget, Villain, SuperVillain, Plot, PlotDetails, CyclicOne, CyclicTwo, - WorkHour, Reservation, FoodDelivery, RowLevelChangePermissionModel, Paper, + ModelWithStringPrimaryKey, Color, Thing, Actor, Inquisition, Sketch, + Person, Persona, FooAccount, BarAccount, Subscriber, ExternalSubscriber, + OldSubscriber, Podcast, Vodcast, EmptyModel, Fabric, Gallery, Language, + Recommendation, Recommender, Collector, Post, Gadget, Villain, + SuperVillain, Plot, PlotDetails, CyclicOne, CyclicTwo, WorkHour, + Reservation, FoodDelivery, RowLevelChangePermissionModel, Paper, CoverLetter, Story, OtherStory, Book, Promo, ChapterXtra1, Pizza, Topping, - Album, Question, Answer, ComplexSortedPerson, PluggableSearchPerson, PrePopulatedPostLargeSlug, - AdminOrderedField, AdminOrderedModelMethod, AdminOrderedAdminMethod, - AdminOrderedCallable, Report, Color2, UnorderedObject, MainPrepopulated, - RelatedPrepopulated, UndeletableObject, UnchangeableObject, UserMessenger, Simple, Choice, - ShortMessage, Telegram, FilteredManager, EmptyModelHidden, - EmptyModelVisible, EmptyModelMixin, State, City, Restaurant, Worker, - ParentWithDependentChildren, DependentChild) + Album, Question, Answer, ComplexSortedPerson, PluggableSearchPerson, + PrePopulatedPostLargeSlug, AdminOrderedField, AdminOrderedModelMethod, + AdminOrderedAdminMethod, AdminOrderedCallable, Report, Color2, + UnorderedObject, MainPrepopulated, RelatedPrepopulated, UndeletableObject, + UnchangeableObject, UserMessenger, Simple, Choice, ShortMessage, Telegram, + FilteredManager, EmptyModelHidden, EmptyModelVisible, EmptyModelMixin, + State, City, Restaurant, Worker, ParentWithDependentChildren, + DependentChild) def callable_year(dt_value): @@ -190,16 +191,6 @@ class PersonAdmin(admin.ModelAdmin): return super(PersonAdmin, self).get_queryset(request).order_by('age') -class FooAccount(Account): - """A service-specific account of type Foo.""" - servicename = 'foo' - - -class BarAccount(Account): - """A service-specific account of type Bar.""" - servicename = 'bar' - - class FooAccountAdmin(admin.StackedInline): model = FooAccount extra = 1 @@ -261,13 +252,6 @@ class ExternalSubscriberAdmin(admin.ModelAdmin): actions = [redirect_to, external_mail, download, no_perm] -class Podcast(Media): - release_date = models.DateField() - - class Meta: - ordering = ('release_date',) # overridden in PodcastAdmin - - class PodcastAdmin(admin.ModelAdmin): list_display = ('name', 'release_date') list_editable = ('release_date',) diff --git a/tests/defer_regress/models.py b/tests/defer_regress/models.py index d858558e97..f58a10215e 100644 --- a/tests/defer_regress/models.py +++ b/tests/defer_regress/models.py @@ -82,10 +82,6 @@ class Location(models.Model): location1 = models.CharField(max_length=1000, default='location1') -class Item(models.Model): - pass - - class Request(models.Model): profile = models.ForeignKey(Profile, null=True, blank=True) location = models.ForeignKey(Location) From d4b059d3eb2850f43a06162c8316777cb1681d7b Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 5 Jan 2014 10:13:10 +0100 Subject: [PATCH 189/208] Fixed test for models in non-installed apps. Models are now attached to any application they're defined in. Since not_installed was inside app_loading, these models were mistakenly attached to app_loading. The test that used them passed accidentally when run after EggLoadingTest because that class' tearDown() method replaces apps.all_models['app_loading'] by a copy of itself, while it should remain the same as apps.app_configs['app_loading'].models. --- tests/app_loading/not_installed/models.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/tests/app_loading/not_installed/models.py b/tests/app_loading/not_installed/models.py index 1e4b59894c..09cf2ac6ed 100644 --- a/tests/app_loading/not_installed/models.py +++ b/tests/app_loading/not_installed/models.py @@ -2,12 +2,22 @@ from django.db import models class NotInstalledModel(models.Model): - pass + + class Meta: + app_label = 'not_installed' class RelatedModel(models.Model): + + class Meta: + app_label = 'not_installed' + not_installed = models.ForeignKey(NotInstalledModel) class M2MRelatedModel(models.Model): + + class Meta: + app_label = 'not_installed' + not_installed = models.ManyToManyField(NotInstalledModel) From 5d9da7597ebae302ba15c0ee85aaece80a6d4926 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 5 Jan 2014 10:12:56 +0100 Subject: [PATCH 190/208] Fixed app registry cleanup in app-loading tests. --- tests/app_loading/tests.py | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/tests/app_loading/tests.py b/tests/app_loading/tests.py index 46c5955c53..63f47fa5fa 100644 --- a/tests/app_loading/tests.py +++ b/tests/app_loading/tests.py @@ -15,14 +15,8 @@ class EggLoadingTest(TestCase): self.old_path = sys.path[:] self.egg_dir = '%s/eggs' % os.path.dirname(upath(__file__)) - # The models need to be removed after the test in order to prevent bad - # interactions with the flush operation in other tests. - self._old_models = apps.all_models['app_loading'].copy() - def tearDown(self): - apps.all_models['app_loading'] = self._old_models apps.clear_cache() - sys.path = self.old_path def test_egg1(self): @@ -32,6 +26,7 @@ class EggLoadingTest(TestCase): with self.settings(INSTALLED_APPS=['app_with_models']): models_module = apps.get_app_config('app_with_models').models_module self.assertIsNotNone(models_module) + del apps.all_models['app_with_models'] def test_egg2(self): """Loading an app from an egg that has no models returns no models (and no error)""" @@ -40,6 +35,7 @@ class EggLoadingTest(TestCase): with self.settings(INSTALLED_APPS=['app_no_models']): models_module = apps.get_app_config('app_no_models').models_module self.assertIsNone(models_module) + del apps.all_models['app_no_models'] def test_egg3(self): """Models module can be loaded from an app located under an egg's top-level package""" @@ -48,6 +44,7 @@ class EggLoadingTest(TestCase): with self.settings(INSTALLED_APPS=['omelet.app_with_models']): models_module = apps.get_app_config('app_with_models').models_module self.assertIsNotNone(models_module) + del apps.all_models['app_with_models'] def test_egg4(self): """Loading an app with no models from under the top-level egg package generates no error""" @@ -56,6 +53,7 @@ class EggLoadingTest(TestCase): with self.settings(INSTALLED_APPS=['omelet.app_no_models']): models_module = apps.get_app_config('app_no_models').models_module self.assertIsNone(models_module) + del apps.all_models['app_no_models'] def test_egg5(self): """Loading an app from an egg that has an import error in its models module raises that error""" From f5f761716731ceedaf165a068e6f88164cd87e79 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 5 Jan 2014 20:47:24 +0100 Subject: [PATCH 191/208] Renamed a couple models to prevent duplicate names. --- tests/forms_tests/tests/tests.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tests/forms_tests/tests/tests.py b/tests/forms_tests/tests/tests.py index 622b6386e9..0be1f26d81 100644 --- a/tests/forms_tests/tests/tests.py +++ b/tests/forms_tests/tests/tests.py @@ -239,14 +239,14 @@ class RelatedModelFormTests(TestCase): """ Test for issue 10405 """ - class A(models.Model): - ref = models.ForeignKey("B") + class C(models.Model): + ref = models.ForeignKey("D") - class B(models.Model): + class D(models.Model): pass class Meta: - model = A + model = C fields = '__all__' self.assertTrue(issubclass(ModelFormMetaclass(str('Form'), (ModelForm,), {'Meta': Meta}), ModelForm)) From f630373b929bc62bf4d66d60c532f7832e5fbe67 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 5 Jan 2014 09:32:22 +0100 Subject: [PATCH 192/208] Fixed #21711 -- Enforced unicity of model names. --- django/apps/registry.py | 1 - django/db/models/base.py | 13 +------------ django/db/models/query_utils.py | 27 +++++++++++++++++---------- docs/releases/1.7.txt | 6 ++++++ 4 files changed, 24 insertions(+), 23 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index db75f999c5..f88fb73dd6 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -185,7 +185,6 @@ class Apps(object): # call get_app_config(). model_name = model._meta.model_name app_models = self.all_models[app_label] - # Defensive check for extra safety. if model_name in app_models: raise RuntimeError( "Conflicting '%s' models in application '%s': %s and %s." % diff --git a/django/db/models/base.py b/django/db/models/base.py index 0de21fafc9..531dd8adcc 100644 --- a/django/db/models/base.py +++ b/django/db/models/base.py @@ -162,12 +162,6 @@ class ModelBase(type): new_class._default_manager = new_class._default_manager._copy_to_model(new_class) new_class._base_manager = new_class._base_manager._copy_to_model(new_class) - # Bail out early if we have already created this class. - try: - return new_class._meta.apps.get_registered_model(new_class._meta.app_label, name) - except LookupError: - pass - # Add all attributes to the class. for obj_name, obj in attrs.items(): new_class.add_to_class(obj_name, obj) @@ -285,13 +279,8 @@ class ModelBase(type): return new_class new_class._prepare() - new_class._meta.apps.register_model(new_class._meta.app_label, new_class) - # Because of the way imports happen (recursively), we may or may not be - # the first time this model tries to register with the framework. There - # should only be one class for each model, so we always return the - # registered version. - return new_class._meta.apps.get_registered_model(new_class._meta.app_label, name) + return new_class def copy_managers(cls, base_managers): # This is in-place sorting of an Options attribute, but that's fine. diff --git a/django/db/models/query_utils.py b/django/db/models/query_utils.py index 2aa4856cf0..b6971e9f24 100644 --- a/django/db/models/query_utils.py +++ b/django/db/models/query_utils.py @@ -7,6 +7,7 @@ circular import difficulties. """ from __future__ import unicode_literals +from django.apps import apps from django.db.backends import utils from django.utils import six from django.utils import tree @@ -185,22 +186,28 @@ def deferred_class_factory(model, attrs): being replaced with DeferredAttribute objects. The "pk_value" ties the deferred attributes to a particular instance of the model. """ - class Meta: - proxy = True - app_label = model._meta.app_label - # The app registry wants a unique name for each model, otherwise the new - # class won't be created (we get an old one back). Therefore, we generate + # class won't be created (we get an exception). Therefore, we generate # the name using the passed in attrs. It's OK to reuse an existing class # object if the attrs are identical. name = "%s_Deferred_%s" % (model.__name__, '_'.join(sorted(list(attrs)))) name = utils.truncate_name(name, 80, 32) - overrides = dict((attr, DeferredAttribute(attr, model)) for attr in attrs) - overrides["Meta"] = Meta - overrides["__module__"] = model.__module__ - overrides["_deferred"] = True - return type(str(name), (model,), overrides) + try: + return apps.get_model(model._meta.app_label, name) + + except LookupError: + + class Meta: + proxy = True + app_label = model._meta.app_label + + overrides = dict((attr, DeferredAttribute(attr, model)) for attr in attrs) + overrides["Meta"] = Meta + overrides["__module__"] = model.__module__ + overrides["_deferred"] = True + return type(str(name), (model,), overrides) + # The above function is also used to unpickle model instances with deferred # fields. diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index c684454181..a4b230510a 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -664,6 +664,12 @@ If you have two apps with the same label, you should create an :class:`~django.apps.AppConfig.label` there. You should then adjust your code wherever it references this application or its models with the old label. +It isn't possible to import the same model twice through different paths any +more. As of Django 1.6, this may happen only if you're manually putting a +directory and a subdirectory on :envvar:`PYTHONPATH`. Refer to the section on +the new project layout in the :doc:`1.4 release notes ` for +migration instructions. + You should make sure that your project doesn't import models from applications that aren't in :setting:`INSTALLED_APPS`. Relations involving such models may not be created properly. Future versions of Django may forbid this entirely. From 021b0b0029cdecc528a137a5e6913be81c901504 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sun, 5 Jan 2014 21:10:15 +0100 Subject: [PATCH 193/208] Added an app-loading feature to the release notes. --- docs/releases/1.7.txt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index a4b230510a..ab813795e9 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -76,6 +76,10 @@ Improvements thus far include: * Applications can run code at startup, before Django does anything else, with the :meth:`~django.apps.AppConfig.ready` method of their configuration. +* Application labels are assigned correctly to models even when they're + defined outside of ``models.py``. You don't have to set + :attr:`~django.db.models.Options.app_label` explicitly any more. + * It is possible to omit ``models.py`` entirely if an application doesn't have any models. From 27afd302c687528ff1dc3156961e409862c6eca2 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sat, 4 Jan 2014 22:49:35 +0100 Subject: [PATCH 194/208] Fixed #21675 -- Added app configs for contrib apps. --- django/contrib/admin/apps.py | 8 ++++++++ django/contrib/admindocs/apps.py | 8 ++++++++ django/contrib/auth/apps.py | 8 ++++++++ django/contrib/comments/apps.py | 8 ++++++++ django/contrib/contenttypes/apps.py | 8 ++++++++ django/contrib/flatpages/apps.py | 8 ++++++++ django/contrib/formtools/apps.py | 8 ++++++++ django/contrib/gis/apps.py | 8 ++++++++ django/contrib/humanize/apps.py | 8 ++++++++ django/contrib/messages/apps.py | 8 ++++++++ django/contrib/redirects/apps.py | 8 ++++++++ django/contrib/sessions/apps.py | 8 ++++++++ django/contrib/sitemaps/apps.py | 8 ++++++++ django/contrib/sites/apps.py | 8 ++++++++ django/contrib/staticfiles/apps.py | 8 ++++++++ django/contrib/syndication/apps.py | 8 ++++++++ django/contrib/webdesign/apps.py | 8 ++++++++ 17 files changed, 136 insertions(+) create mode 100644 django/contrib/admin/apps.py create mode 100644 django/contrib/admindocs/apps.py create mode 100644 django/contrib/auth/apps.py create mode 100644 django/contrib/comments/apps.py create mode 100644 django/contrib/contenttypes/apps.py create mode 100644 django/contrib/flatpages/apps.py create mode 100644 django/contrib/formtools/apps.py create mode 100644 django/contrib/gis/apps.py create mode 100644 django/contrib/humanize/apps.py create mode 100644 django/contrib/messages/apps.py create mode 100644 django/contrib/redirects/apps.py create mode 100644 django/contrib/sessions/apps.py create mode 100644 django/contrib/sitemaps/apps.py create mode 100644 django/contrib/sites/apps.py create mode 100644 django/contrib/staticfiles/apps.py create mode 100644 django/contrib/syndication/apps.py create mode 100644 django/contrib/webdesign/apps.py diff --git a/django/contrib/admin/apps.py b/django/contrib/admin/apps.py new file mode 100644 index 0000000000..980ff0c369 --- /dev/null +++ b/django/contrib/admin/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class AdminConfig(AppConfig): + name = 'django.contrib.admin' + verbose_name = _("administration") diff --git a/django/contrib/admindocs/apps.py b/django/contrib/admindocs/apps.py new file mode 100644 index 0000000000..ddc23051f4 --- /dev/null +++ b/django/contrib/admindocs/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class AdminDocsConfig(AppConfig): + name = 'django.contrib.admindocs' + verbose_name = _("administrative documentation") diff --git a/django/contrib/auth/apps.py b/django/contrib/auth/apps.py new file mode 100644 index 0000000000..e44ad1a0c7 --- /dev/null +++ b/django/contrib/auth/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class AuthConfig(AppConfig): + name = 'django.contrib.auth' + verbose_name = _("authentication and authorization") diff --git a/django/contrib/comments/apps.py b/django/contrib/comments/apps.py new file mode 100644 index 0000000000..d6164dd697 --- /dev/null +++ b/django/contrib/comments/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class CommentsConfig(AppConfig): + name = 'django.contrib.comments' + verbose_name = _("comments") diff --git a/django/contrib/contenttypes/apps.py b/django/contrib/contenttypes/apps.py new file mode 100644 index 0000000000..0e55e8d66d --- /dev/null +++ b/django/contrib/contenttypes/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class ContentTypesConfig(AppConfig): + name = 'django.contrib.contenttypes' + verbose_name = _("content types") diff --git a/django/contrib/flatpages/apps.py b/django/contrib/flatpages/apps.py new file mode 100644 index 0000000000..67be36ebc5 --- /dev/null +++ b/django/contrib/flatpages/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class FlatPagesConfig(AppConfig): + name = 'django.contrib.flatpages' + verbose_name = _("flat pages") diff --git a/django/contrib/formtools/apps.py b/django/contrib/formtools/apps.py new file mode 100644 index 0000000000..335b685bad --- /dev/null +++ b/django/contrib/formtools/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class FormToolsConfig(AppConfig): + name = 'django.contrib.formtools' + verbose_name = _("form tools") diff --git a/django/contrib/gis/apps.py b/django/contrib/gis/apps.py new file mode 100644 index 0000000000..225efb8bb5 --- /dev/null +++ b/django/contrib/gis/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class GISConfig(AppConfig): + name = 'django.contrib.gis' + verbose_name = _("GIS") diff --git a/django/contrib/humanize/apps.py b/django/contrib/humanize/apps.py new file mode 100644 index 0000000000..e52a5aa044 --- /dev/null +++ b/django/contrib/humanize/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class HumanizeConfig(AppConfig): + name = 'django.contrib.humanize' + verbose_name = _("humanize") diff --git a/django/contrib/messages/apps.py b/django/contrib/messages/apps.py new file mode 100644 index 0000000000..f8b07e9cb6 --- /dev/null +++ b/django/contrib/messages/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class MessagesConfig(AppConfig): + name = 'django.contrib.messages' + verbose_name = _("messages") diff --git a/django/contrib/redirects/apps.py b/django/contrib/redirects/apps.py new file mode 100644 index 0000000000..b4f8c168d8 --- /dev/null +++ b/django/contrib/redirects/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class RedirectsConfig(AppConfig): + name = 'django.contrib.redirects' + verbose_name = _("redirects") diff --git a/django/contrib/sessions/apps.py b/django/contrib/sessions/apps.py new file mode 100644 index 0000000000..8b5093e7c9 --- /dev/null +++ b/django/contrib/sessions/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class SessionsConfig(AppConfig): + name = 'django.contrib.sessions' + verbose_name = _("sessions") diff --git a/django/contrib/sitemaps/apps.py b/django/contrib/sitemaps/apps.py new file mode 100644 index 0000000000..8237f0f188 --- /dev/null +++ b/django/contrib/sitemaps/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class SiteMapsConfig(AppConfig): + name = 'django.contrib.sitemaps' + verbose_name = _("site maps") diff --git a/django/contrib/sites/apps.py b/django/contrib/sites/apps.py new file mode 100644 index 0000000000..ea81102da0 --- /dev/null +++ b/django/contrib/sites/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class SitesConfig(AppConfig): + name = 'django.contrib.sites' + verbose_name = _("sites") diff --git a/django/contrib/staticfiles/apps.py b/django/contrib/staticfiles/apps.py new file mode 100644 index 0000000000..abb99c3cea --- /dev/null +++ b/django/contrib/staticfiles/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class StaticFilesConfig(AppConfig): + name = 'django.contrib.staticfiles' + verbose_name = _("static files") diff --git a/django/contrib/syndication/apps.py b/django/contrib/syndication/apps.py new file mode 100644 index 0000000000..a63adb3e1b --- /dev/null +++ b/django/contrib/syndication/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class SyndicationConfig(AppConfig): + name = 'django.contrib.syndication' + verbose_name = _("syndication") diff --git a/django/contrib/webdesign/apps.py b/django/contrib/webdesign/apps.py new file mode 100644 index 0000000000..87047edaf0 --- /dev/null +++ b/django/contrib/webdesign/apps.py @@ -0,0 +1,8 @@ +from django.apps import AppConfig + +from django.utils.translation import ugettext_lazy as _ + + +class WebDesignConfig(AppConfig): + name = 'django.contrib.webdesign' + verbose_name = _("web design") From b57c48d012e300f518841fe066c85ecde2747cdf Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Sat, 4 Jan 2014 23:06:24 +0100 Subject: [PATCH 195/208] Added catalogs for apps that didn't have any translations. --- .../sitemaps/locale/en/LC_MESSAGES/django.po | 22 +++++++++++++++++++ .../locale/en/LC_MESSAGES/django.po | 22 +++++++++++++++++++ .../locale/en/LC_MESSAGES/django.po | 22 +++++++++++++++++++ .../webdesign/locale/en/LC_MESSAGES/django.po | 22 +++++++++++++++++++ 4 files changed, 88 insertions(+) create mode 100644 django/contrib/sitemaps/locale/en/LC_MESSAGES/django.po create mode 100644 django/contrib/staticfiles/locale/en/LC_MESSAGES/django.po create mode 100644 django/contrib/syndication/locale/en/LC_MESSAGES/django.po create mode 100644 django/contrib/webdesign/locale/en/LC_MESSAGES/django.po diff --git a/django/contrib/sitemaps/locale/en/LC_MESSAGES/django.po b/django/contrib/sitemaps/locale/en/LC_MESSAGES/django.po new file mode 100644 index 0000000000..fcd182f511 --- /dev/null +++ b/django/contrib/sitemaps/locale/en/LC_MESSAGES/django.po @@ -0,0 +1,22 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER +# This file is distributed under the same license as the PACKAGE package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2014-01-04 23:05+0100\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: apps.py:8 +msgid "site maps" +msgstr "" diff --git a/django/contrib/staticfiles/locale/en/LC_MESSAGES/django.po b/django/contrib/staticfiles/locale/en/LC_MESSAGES/django.po new file mode 100644 index 0000000000..7fd617c346 --- /dev/null +++ b/django/contrib/staticfiles/locale/en/LC_MESSAGES/django.po @@ -0,0 +1,22 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER +# This file is distributed under the same license as the PACKAGE package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2014-01-04 23:05+0100\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: apps.py:8 +msgid "static files" +msgstr "" diff --git a/django/contrib/syndication/locale/en/LC_MESSAGES/django.po b/django/contrib/syndication/locale/en/LC_MESSAGES/django.po new file mode 100644 index 0000000000..0bb22cbafe --- /dev/null +++ b/django/contrib/syndication/locale/en/LC_MESSAGES/django.po @@ -0,0 +1,22 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER +# This file is distributed under the same license as the PACKAGE package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2014-01-04 23:05+0100\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: apps.py:8 +msgid "syndication" +msgstr "" diff --git a/django/contrib/webdesign/locale/en/LC_MESSAGES/django.po b/django/contrib/webdesign/locale/en/LC_MESSAGES/django.po new file mode 100644 index 0000000000..2ae0ee7272 --- /dev/null +++ b/django/contrib/webdesign/locale/en/LC_MESSAGES/django.po @@ -0,0 +1,22 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER +# This file is distributed under the same license as the PACKAGE package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2014-01-04 23:05+0100\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: apps.py:8 +msgid "web design" +msgstr "" From 6a320cc14ae6cd2606cc10a5ba8b1c09f737bab4 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 6 Jan 2014 22:48:41 +0100 Subject: [PATCH 196/208] Fixed #21718 -- Renamed has_app to is_installed. --- django/apps/registry.py | 2 +- django/contrib/admin/sites.py | 4 ++-- django/contrib/admin/templatetags/admin_static.py | 2 +- django/contrib/messages/tests/base.py | 2 +- django/contrib/redirects/middleware.py | 2 +- django/contrib/sitemaps/tests/test_flatpages.py | 2 +- django/contrib/sitemaps/tests/test_http.py | 2 +- django/test/client.py | 4 ++-- docs/ref/applications.txt | 2 +- tests/apps/tests.py | 8 ++++---- 10 files changed, 15 insertions(+), 15 deletions(-) diff --git a/django/apps/registry.py b/django/apps/registry.py index f88fb73dd6..a0cd5e0abf 100644 --- a/django/apps/registry.py +++ b/django/apps/registry.py @@ -192,7 +192,7 @@ class Apps(object): app_models[model_name] = model self.clear_cache() - def has_app(self, app_name): + def is_installed(self, app_name): """ Checks whether an application with this name exists in the registry. diff --git a/django/contrib/admin/sites.py b/django/contrib/admin/sites.py index 0626c5aa45..8b81f6c68e 100644 --- a/django/contrib/admin/sites.py +++ b/django/contrib/admin/sites.py @@ -160,10 +160,10 @@ class AdminSite(object): The default implementation checks that admin and contenttypes apps are installed, as well as the auth context processor. """ - if not apps.has_app('django.contrib.admin'): + if not apps.is_installed('django.contrib.admin'): raise ImproperlyConfigured("Put 'django.contrib.admin' in your " "INSTALLED_APPS setting in order to use the admin application.") - if not apps.has_app('django.contrib.contenttypes'): + if not apps.is_installed('django.contrib.contenttypes'): raise ImproperlyConfigured("Put 'django.contrib.contenttypes' in " "your INSTALLED_APPS setting in order to use the admin application.") if 'django.contrib.auth.context_processors.auth' not in settings.TEMPLATE_CONTEXT_PROCESSORS: diff --git a/django/contrib/admin/templatetags/admin_static.py b/django/contrib/admin/templatetags/admin_static.py index 446ab4cab5..77473c2e00 100644 --- a/django/contrib/admin/templatetags/admin_static.py +++ b/django/contrib/admin/templatetags/admin_static.py @@ -3,7 +3,7 @@ from django.template import Library register = Library() -if apps.has_app('django.contrib.staticfiles'): +if apps.is_installed('django.contrib.staticfiles'): from django.contrib.staticfiles.templatetags.staticfiles import static else: from django.templatetags.static import static diff --git a/django/contrib/messages/tests/base.py b/django/contrib/messages/tests/base.py index 7244a6d34e..b0c35b9d06 100644 --- a/django/contrib/messages/tests/base.py +++ b/django/contrib/messages/tests/base.py @@ -15,7 +15,7 @@ from django.utils.translation import ugettext_lazy def skipUnlessAuthIsInstalled(func): return skipUnless( - apps.has_app('django.contrib.auth'), + apps.is_installed('django.contrib.auth'), "django.contrib.auth isn't installed")(func) diff --git a/django/contrib/redirects/middleware.py b/django/contrib/redirects/middleware.py index 52c9a49a8f..4894e30216 100644 --- a/django/contrib/redirects/middleware.py +++ b/django/contrib/redirects/middleware.py @@ -15,7 +15,7 @@ class RedirectFallbackMiddleware(object): response_redirect_class = http.HttpResponsePermanentRedirect def __init__(self): - if not apps.has_app('django.contrib.sites'): + if not apps.is_installed('django.contrib.sites'): raise ImproperlyConfigured( "You cannot use RedirectFallbackMiddleware when " "django.contrib.sites is not installed." diff --git a/django/contrib/sitemaps/tests/test_flatpages.py b/django/contrib/sitemaps/tests/test_flatpages.py index 4e9deb8de4..c284c66c0d 100644 --- a/django/contrib/sitemaps/tests/test_flatpages.py +++ b/django/contrib/sitemaps/tests/test_flatpages.py @@ -10,7 +10,7 @@ from .base import SitemapTestsBase class FlatpagesSitemapTests(SitemapTestsBase): - @skipUnless(apps.has_app('django.contrib.flatpages'), + @skipUnless(apps.is_installed('django.contrib.flatpages'), "django.contrib.flatpages app not installed.") def test_flatpage_sitemap(self): "Basic FlatPage sitemap test" diff --git a/django/contrib/sitemaps/tests/test_http.py b/django/contrib/sitemaps/tests/test_http.py index e8c3409c74..2f9ebd8fad 100644 --- a/django/contrib/sitemaps/tests/test_http.py +++ b/django/contrib/sitemaps/tests/test_http.py @@ -118,7 +118,7 @@ class HTTPSitemapTests(SitemapTestsBase): """ % date.today() self.assertXMLEqual(response.content.decode('utf-8'), expected_content) - @skipUnless(apps.has_app('django.contrib.sites'), + @skipUnless(apps.is_installed('django.contrib.sites'), "django.contrib.sites app not installed.") def test_sitemap_get_urls_no_site_1(self): """ diff --git a/django/test/client.py b/django/test/client.py index a2da8bcd38..9197a5ab1b 100644 --- a/django/test/client.py +++ b/django/test/client.py @@ -390,7 +390,7 @@ class Client(RequestFactory): """ Obtains the current session variables. """ - if apps.has_app('django.contrib.sessions'): + if apps.is_installed('django.contrib.sessions'): engine = import_module(settings.SESSION_ENGINE) cookie = self.cookies.get(settings.SESSION_COOKIE_NAME, None) if cookie: @@ -551,7 +551,7 @@ class Client(RequestFactory): """ user = authenticate(**credentials) if (user and user.is_active and - apps.has_app('django.contrib.sessions')): + apps.is_installed('django.contrib.sessions')): engine = import_module(settings.SESSION_ENGINE) # Create a fake request that goes through request middleware diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt index 0713da76ed..a44062808e 100644 --- a/docs/ref/applications.txt +++ b/docs/ref/applications.txt @@ -203,7 +203,7 @@ Application registry given ``app_label``. Raises :exc:`~exceptions.LookupError` if no such application exists. -.. method:: apps.has_app(app_name) +.. method:: apps.is_installed(app_name) Checks whether an application with the given name exists in the registry. ``app_name`` is the full name of the app, e.g. 'django.contrib.admin'. diff --git a/tests/apps/tests.py b/tests/apps/tests.py index c31174a1f1..ad5fd0d609 100644 --- a/tests/apps/tests.py +++ b/tests/apps/tests.py @@ -107,10 +107,10 @@ class AppsTests(TestCase): apps.get_app_config('webdesign') @override_settings(INSTALLED_APPS=SOME_INSTALLED_APPS) - def test_has_app(self): - self.assertTrue(apps.has_app('django.contrib.admin')) - self.assertTrue(apps.has_app('django.contrib.staticfiles')) - self.assertFalse(apps.has_app('django.contrib.webdesign')) + def test_is_installed(self): + self.assertTrue(apps.is_installed('django.contrib.admin')) + self.assertTrue(apps.is_installed('django.contrib.staticfiles')) + self.assertFalse(apps.is_installed('django.contrib.webdesign')) @override_settings(INSTALLED_APPS=['apps.apps.RelabeledAppsConfig']) def test_relabeling(self): From 2dcde523abe6dca42d9b2d46a47c402979974c77 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Mon, 6 Jan 2014 22:57:56 +0100 Subject: [PATCH 197/208] Avoided catching ImproperlyConfigured on django.setup(). Fixed #21737. Thanks Florian for the report. Also removed redundant imports in that file. --- django/core/management/__init__.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/django/core/management/__init__.py b/django/core/management/__init__.py index 34597bfa5f..6d0cb7ea3d 100644 --- a/django/core/management/__init__.py +++ b/django/core/management/__init__.py @@ -261,7 +261,6 @@ class ManagementUtility(object): usage.append(" %s" % name) # Output an extra note if settings are not properly configured try: - from django.conf import settings settings.INSTALLED_APPS except ImproperlyConfigured as e: usage.append(style.NOTICE( @@ -343,7 +342,6 @@ class ManagementUtility(object): elif cwords[0] in ('dumpdata', 'sql', 'sqlall', 'sqlclear', 'sqlcustom', 'sqlindexes', 'sqlsequencereset', 'test'): try: - from django.apps import apps app_configs = apps.get_app_configs() # Get the last part of the dotted path as the app name. options += [(app_config.label, 0) for app_config in app_configs] @@ -386,10 +384,12 @@ class ManagementUtility(object): pass # Ignore any option errors at this point. try: - django.setup() + settings.INSTALLED_APPS except ImproperlyConfigured: # Some commands are supposed to work without configured settings pass + else: + django.setup() try: subcommand = self.argv[1] From 0423e0796a75db8226e2032083ce6c674da337dc Mon Sep 17 00:00:00 2001 From: maurycyp Date: Fri, 3 Jan 2014 21:26:11 -0500 Subject: [PATCH 198/208] Changed parent class calls to super in Field subclasses --- django/db/models/fields/__init__.py | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/django/db/models/fields/__init__.py b/django/db/models/fields/__init__.py index 6dcfd9ca70..bc5c48da01 100644 --- a/django/db/models/fields/__init__.py +++ b/django/db/models/fields/__init__.py @@ -728,7 +728,7 @@ class AutoField(Field): assert kwargs.get('primary_key', False) is True, \ "%ss must have primary_key=True." % self.__class__.__name__ kwargs['blank'] = True - Field.__init__(self, *args, **kwargs) + super(AutoField, self).__init__(*args, **kwargs) def deconstruct(self): name, path, args, kwargs = super(AutoField, self).deconstruct() @@ -786,7 +786,7 @@ class BooleanField(Field): def __init__(self, *args, **kwargs): kwargs['blank'] = True - Field.__init__(self, *args, **kwargs) + super(BooleanField, self).__init__(*args, **kwargs) def deconstruct(self): name, path, args, kwargs = super(BooleanField, self).deconstruct() @@ -898,7 +898,7 @@ class DateField(Field): if auto_now or auto_now_add: kwargs['editable'] = False kwargs['blank'] = True - Field.__init__(self, verbose_name, name, **kwargs) + super(DateField, self).__init__(verbose_name, name, **kwargs) def deconstruct(self): name, path, args, kwargs = super(DateField, self).deconstruct() @@ -1110,7 +1110,7 @@ class DecimalField(Field): def __init__(self, verbose_name=None, name=None, max_digits=None, decimal_places=None, **kwargs): self.max_digits, self.decimal_places = max_digits, decimal_places - Field.__init__(self, verbose_name, name, **kwargs) + super(DecimalField, self).__init__(verbose_name, name, **kwargs) def deconstruct(self): name, path, args, kwargs = super(DecimalField, self).deconstruct() @@ -1182,7 +1182,7 @@ class EmailField(CharField): # compliant with RFCs 3696 and 5321 kwargs['max_length'] = kwargs.get('max_length', 75) - CharField.__init__(self, *args, **kwargs) + super(EmailField, self).__init__(*args, **kwargs) def deconstruct(self): name, path, args, kwargs = super(EmailField, self).deconstruct() @@ -1208,7 +1208,7 @@ class FilePathField(Field): self.path, self.match, self.recursive = path, match, recursive self.allow_files, self.allow_folders = allow_files, allow_folders kwargs['max_length'] = kwargs.get('max_length', 100) - Field.__init__(self, verbose_name, name, **kwargs) + super(FilePathField, self).__init__(verbose_name, name, **kwargs) def deconstruct(self): name, path, args, kwargs = super(FilePathField, self).deconstruct() @@ -1339,7 +1339,7 @@ class IPAddressField(Field): warnings.warn("IPAddressField has been deprecated. Use GenericIPAddressField instead.", PendingDeprecationWarning) kwargs['max_length'] = 15 - Field.__init__(self, *args, **kwargs) + super(IPAddressField, self).__init__(*args, **kwargs) def deconstruct(self): name, path, args, kwargs = super(IPAddressField, self).deconstruct() @@ -1368,7 +1368,8 @@ class GenericIPAddressField(Field): validators.ip_address_validators(protocol, unpack_ipv4) self.default_error_messages['invalid'] = invalid_error_message kwargs['max_length'] = 39 - Field.__init__(self, verbose_name, name, *args, **kwargs) + super(GenericIPAddressField, self).__init__(verbose_name, name, *args, + **kwargs) def deconstruct(self): name, path, args, kwargs = super(GenericIPAddressField, self).deconstruct() @@ -1422,7 +1423,7 @@ class NullBooleanField(Field): def __init__(self, *args, **kwargs): kwargs['null'] = True kwargs['blank'] = True - Field.__init__(self, *args, **kwargs) + super(NullBooleanField, self).__init__(*args, **kwargs) def deconstruct(self): name, path, args, kwargs = super(NullBooleanField, self).deconstruct() @@ -1571,7 +1572,7 @@ class TimeField(Field): if auto_now or auto_now_add: kwargs['editable'] = False kwargs['blank'] = True - Field.__init__(self, verbose_name, name, **kwargs) + super(TimeField, self).__init__(verbose_name, name, **kwargs) def deconstruct(self): name, path, args, kwargs = super(TimeField, self).deconstruct() @@ -1646,7 +1647,7 @@ class URLField(CharField): def __init__(self, verbose_name=None, name=None, **kwargs): kwargs['max_length'] = kwargs.get('max_length', 200) - CharField.__init__(self, verbose_name, name, **kwargs) + super(URLField, self).__init__(verbose_name, name, **kwargs) def deconstruct(self): name, path, args, kwargs = super(URLField, self).deconstruct() From 64887c644a8fe1004a15e27087d4e27c95c90fcd Mon Sep 17 00:00:00 2001 From: Andrew Godwin Date: Wed, 8 Jan 2014 13:00:12 +0000 Subject: [PATCH 199/208] Fixed #21142: Dependency failures on unmigrated apps. --- django/db/migrations/autodetector.py | 1 + django/db/migrations/graph.py | 7 ++-- django/db/migrations/loader.py | 35 +++++++++++++++++++ tests/migrations/test_loader.py | 29 ++++++++++++++- .../migrations/test_migrations/0002_second.py | 4 ++- .../test_migrations_unmigdep/0001_initial.py | 20 +++++++++++ .../test_migrations_unmigdep/__init__.py | 0 7 files changed, 92 insertions(+), 4 deletions(-) create mode 100644 tests/migrations/test_migrations_unmigdep/0001_initial.py create mode 100644 tests/migrations/test_migrations_unmigdep/__init__.py diff --git a/django/db/migrations/autodetector.py b/django/db/migrations/autodetector.py index b98aef2f9a..c7ac756b2e 100644 --- a/django/db/migrations/autodetector.py +++ b/django/db/migrations/autodetector.py @@ -299,6 +299,7 @@ class MigrationAutodetector(object): for migration in migrations: name_map[(app_label, migration.name)] = (app_label, "__first__") del changes[app_label] + continue # Work out the next number in the sequence if app_leaf is None: next_number = 1 diff --git a/django/db/migrations/graph.py b/django/db/migrations/graph.py index 4f89fa2909..eddabbd434 100644 --- a/django/db/migrations/graph.py +++ b/django/db/migrations/graph.py @@ -63,14 +63,14 @@ class MigrationGraph(object): raise ValueError("Node %r not a valid node" % (node, )) return self.dfs(node, lambda x: self.dependents.get(x, set())) - def root_nodes(self): + def root_nodes(self, app=None): """ Returns all root nodes - that is, nodes with no dependencies inside their app. These are the starting point for an app. """ roots = set() for node in self.nodes: - if not any(key[0] == node[0] for key in self.dependencies.get(node, set())): + if not any(key[0] == node[0] for key in self.dependencies.get(node, set())) and (not app or app == node[0]): roots.add(node) return roots @@ -145,6 +145,9 @@ class MigrationGraph(object): project_state = self.nodes[node].mutate_state(project_state) return project_state + def __contains__(self, node): + return node in self.nodes + class CircularDependencyError(Exception): """ diff --git a/django/db/migrations/loader.py b/django/db/migrations/loader.py index 66d2259b79..73f9d2a71e 100644 --- a/django/db/migrations/loader.py +++ b/django/db/migrations/loader.py @@ -5,6 +5,9 @@ import sys from django.apps import apps from django.db.migrations.recorder import MigrationRecorder from django.db.migrations.graph import MigrationGraph +from django.db.migrations.migration import Migration +from django.db.migrations.state import ModelState +from django.db.migrations import operations from django.utils import six from django.conf import settings @@ -191,6 +194,38 @@ class MigrationLoader(object): self.graph.add_node(key, migration) for key, migration in normal.items(): for parent in migration.dependencies: + # Special-case __first__, which means "the first migration" for + # migrated apps, and is ignored for unmigrated apps. It allows + # makemigrations to declare dependencies on apps before they + # even have migrations. + if parent[1] == "__first__" and parent not in self.graph: + if parent[0] in self.unmigrated_apps: + # This app isn't migrated, but something depends on it. + # We'll add a fake initial migration for it into the + # graph. + app_config = apps.get_app_config(parent[0]) + ops = [] + for model in app_config.get_models(): + model_state = ModelState.from_model(model) + ops.append( + operations.CreateModel( + name=model_state.name, + fields=model_state.fields, + options=model_state.options, + bases=model_state.bases, + ) + ) + new_migration = type( + "FakeInitialMigration", + (Migration, ), + {"operations": ops}, + )(parent[1], parent[0]) + self.graph.add_node(parent, new_migration) + self.applied_migrations.add(parent) + elif parent[0] in self.migrated_apps: + parent = (parent[0], list(self.graph.root_nodes(parent[0]))[0]) + else: + raise ValueError("Dependency on unknown app %s" % parent[0]) self.graph.add_dependency(key, parent) def detect_conflicts(self): diff --git a/tests/migrations/test_loader.py b/tests/migrations/test_loader.py index 7b9ce72aab..564e5207b8 100644 --- a/tests/migrations/test_loader.py +++ b/tests/migrations/test_loader.py @@ -49,7 +49,10 @@ class LoaderTests(TestCase): migration_loader = MigrationLoader(connection) self.assertEqual( migration_loader.graph.forwards_plan(("migrations", "0002_second")), - [("migrations", "0001_initial"), ("migrations", "0002_second")], + [ + ("migrations", "0001_initial"), + ("migrations", "0002_second"), + ], ) # Now render it out! project_state = migration_loader.graph.project_state(("migrations", "0002_second")) @@ -67,6 +70,30 @@ class LoaderTests(TestCase): ["id", "author"] ) + @override_settings(MIGRATION_MODULES={"migrations": "migrations.test_migrations_unmigdep"}) + def test_load_unmigrated_dependency(self): + """ + Makes sure the loader can load migrations with a dependency on an unmigrated app. + """ + # Load and test the plan + migration_loader = MigrationLoader(connection) + self.assertEqual( + migration_loader.graph.forwards_plan(("migrations", "0001_initial")), + [ + ("auth", "__first__"), + ("migrations", "0001_initial"), + ], + ) + # Now render it out! + project_state = migration_loader.graph.project_state(("migrations", "0001_initial")) + self.assertEqual(len(project_state.models), 4) + + book_state = project_state.models["migrations", "book"] + self.assertEqual( + [x for x, y in book_state.fields], + ["id", "user"] + ) + @override_settings(MIGRATION_MODULES={"migrations": "migrations.test_migrations"}) def test_name_match(self): "Tests prefix name matching" diff --git a/tests/migrations/test_migrations/0002_second.py b/tests/migrations/test_migrations/0002_second.py index ace9a83347..736e844825 100644 --- a/tests/migrations/test_migrations/0002_second.py +++ b/tests/migrations/test_migrations/0002_second.py @@ -3,7 +3,9 @@ from django.db import migrations, models class Migration(migrations.Migration): - dependencies = [("migrations", "0001_initial")] + dependencies = [ + ("migrations", "0001_initial"), + ] operations = [ diff --git a/tests/migrations/test_migrations_unmigdep/0001_initial.py b/tests/migrations/test_migrations_unmigdep/0001_initial.py new file mode 100644 index 0000000000..f4c11b4657 --- /dev/null +++ b/tests/migrations/test_migrations_unmigdep/0001_initial.py @@ -0,0 +1,20 @@ +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ("auth", "__first__"), + ] + + operations = [ + + migrations.CreateModel( + "Book", + [ + ("id", models.AutoField(primary_key=True)), + ("user", models.ForeignKey("auth.User", null=True)), + ], + ) + + ] diff --git a/tests/migrations/test_migrations_unmigdep/__init__.py b/tests/migrations/test_migrations_unmigdep/__init__.py new file mode 100644 index 0000000000..e69de29bb2 From f343f5e5389738cf06ddeef5ca961508f2f8c881 Mon Sep 17 00:00:00 2001 From: Andrew Godwin Date: Wed, 8 Jan 2014 13:06:41 +0000 Subject: [PATCH 200/208] Fix wording of auth superuser post-migrate handler --- django/contrib/auth/management/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/django/contrib/auth/management/__init__.py b/django/contrib/auth/management/__init__.py index 212946ac54..e801b15eb1 100644 --- a/django/contrib/auth/management/__init__.py +++ b/django/contrib/auth/management/__init__.py @@ -130,7 +130,7 @@ def create_superuser(app_config, verbosity=2, interactive=True, db=DEFAULT_DB_AL from django.core.management import call_command if not UserModel.objects.exists() and interactive: - msg = ("\nYou just installed Django's auth system, which means you " + msg = ("\nYou have installed Django's auth system, and " "don't have any superusers defined.\nWould you like to create one " "now? (yes/no): ") confirm = input(msg) From 8845ab62f553f29561decdbabd6eb0ea96c3c1d6 Mon Sep 17 00:00:00 2001 From: Michael Manfre Date: Wed, 8 Jan 2014 09:53:40 -0500 Subject: [PATCH 201/208] Fixed #21745 - Feature check UniqueTest.test_unique_null --- tests/model_forms/tests.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tests/model_forms/tests.py b/tests/model_forms/tests.py index bf7b3d296a..c5e16a2c14 100644 --- a/tests/model_forms/tests.py +++ b/tests/model_forms/tests.py @@ -14,7 +14,7 @@ from django.db import connection from django.db.models.query import EmptyQuerySet from django.forms.models import model_to_dict from django.utils._os import upath -from django.test import TestCase +from django.test import TestCase, skipUnlessDBFeature from django.utils import six from .models import (Article, ArticleStatus, BetterWriter, BigInt, Book, @@ -637,6 +637,7 @@ class UniqueTest(TestCase): self.assertEqual(len(form.errors), 1) self.assertEqual(form.errors['__all__'], ['Price with this Price and Quantity already exists.']) + @skipUnlessDBFeature('ignores_nulls_in_unique_constraints') def test_unique_null(self): title = 'I May Be Wrong But I Doubt It' form = BookForm({'title': title, 'author': self.writer.pk}) From 1dbbdb29a040106f072a4a0315a066a251cc4939 Mon Sep 17 00:00:00 2001 From: Michael Manfre Date: Wed, 8 Jan 2014 10:52:13 -0500 Subject: [PATCH 202/208] Fixed #21746 - Fixed test_get_reverse_on_unsaved_object test. Test will no longer attempt to insert multiple NULL rows in to a unique field if the database doesn't support it. --- tests/one_to_one_regress/tests.py | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/tests/one_to_one_regress/tests.py b/tests/one_to_one_regress/tests.py index da4309e821..17528de311 100644 --- a/tests/one_to_one_regress/tests.py +++ b/tests/one_to_one_regress/tests.py @@ -1,5 +1,6 @@ from __future__ import unicode_literals +from django.db import connection from django.test import TestCase from .models import (Bar, Favorites, HiddenPointer, Place, Restaurant, Target, @@ -226,12 +227,15 @@ class OneToOneRegressionTests(TestCase): with self.assertRaises(UndergroundBar.DoesNotExist): p.undergroundbar - UndergroundBar.objects.create() + # Several instances of the origin are only possible if database allows + # inserting multiple NULL rows for a unique constraint + if connection.features.ignores_nulls_in_unique_constraints: + UndergroundBar.objects.create() - # When there are several instances of the origin - with self.assertNumQueries(0): - with self.assertRaises(UndergroundBar.DoesNotExist): - p.undergroundbar + # When there are several instances of the origin + with self.assertNumQueries(0): + with self.assertRaises(UndergroundBar.DoesNotExist): + p.undergroundbar def test_set_reverse_on_unsaved_object(self): """ From 9ae17d994b1b0dee952c2e64f3727ce7a6ffb398 Mon Sep 17 00:00:00 2001 From: Andrew Godwin Date: Wed, 8 Jan 2014 21:20:29 +0000 Subject: [PATCH 203/208] Make test stronger to hopefully fix odd Jenkins failure --- tests/migrations/test_loader.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/migrations/test_loader.py b/tests/migrations/test_loader.py index 564e5207b8..f661a03b02 100644 --- a/tests/migrations/test_loader.py +++ b/tests/migrations/test_loader.py @@ -86,7 +86,7 @@ class LoaderTests(TestCase): ) # Now render it out! project_state = migration_loader.graph.project_state(("migrations", "0001_initial")) - self.assertEqual(len(project_state.models), 4) + self.assertEqual(len([m for a, m in project_state.models if a == "migrations"]), 1) book_state = project_state.models["migrations", "book"] self.assertEqual( From 9eb16031ca837624433c49646289b50f9566a25d Mon Sep 17 00:00:00 2001 From: Unai Zalakain Date: Tue, 19 Nov 2013 09:44:30 +0100 Subject: [PATCH 204/208] Fixed #12571 -- Attached originating WSGIRequest to test client responses. Originating WSGIRequests are now attached to the ``wsgi_request`` attribute of the ``HttpResponse`` returned by the testing client. Thanks rvdrijst for the suggestion. --- django/test/client.py | 13 ++++++------- docs/releases/1.7.txt | 3 +++ docs/topics/testing/tools.txt | 7 +++++++ tests/test_client/tests.py | 14 ++++++++++++++ 4 files changed, 30 insertions(+), 7 deletions(-) diff --git a/django/test/client.py b/django/test/client.py index 9197a5ab1b..5dbc3e3568 100644 --- a/django/test/client.py +++ b/django/test/client.py @@ -83,10 +83,9 @@ def closing_iterator_wrapper(iterable, close): class ClientHandler(BaseHandler): """ - A HTTP Handler that can be used for testing purposes. - Uses the WSGI interface to compose requests, but returns the raw - HttpResponse object with the originating WSGIRequest attached to its - ``request_instance`` attribute. + A HTTP Handler that can be used for testing purposes. Uses the WSGI + interface to compose requests, but returns the raw HttpResponse object with + the originating WSGIRequest attached to its ``wsgi_request`` attribute. """ def __init__(self, enforce_csrf_checks=True, *args, **kwargs): self.enforce_csrf_checks = enforce_csrf_checks @@ -112,7 +111,7 @@ class ClientHandler(BaseHandler): response = self.get_response(request) # Attach the originating request to the response so that it could be # later retrieved. - response.request_instance = request + response.wsgi_request = request # We're emulating a WSGI server; we must call the close method # on completion. @@ -555,7 +554,7 @@ class Client(RequestFactory): engine = import_module(settings.SESSION_ENGINE) # Create a fake request that goes through request middleware - request = self.request().request_instance + request = self.request().wsgi_request if self.session: request.session = self.session @@ -589,7 +588,7 @@ class Client(RequestFactory): Causes the authenticated user to be logged out. """ # Create a fake request that goes through request middleware - request = self.request().request_instance + request = self.request().wsgi_request engine = import_module(settings.SESSION_ENGINE) UserModel = get_user_model() diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index ab813795e9..a8becf1bab 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -579,6 +579,9 @@ Tests * :meth:`~django.test.TransactionTestCase.assertNumQueries` now prints out the list of executed queries if the assertion fails. +* The ``WSGIRequest`` instance generated by the test handler is now attached to + the :attr:`django.test.Response.wsgi_request` attribute. + Validators ^^^^^^^^^^ diff --git a/docs/topics/testing/tools.txt b/docs/topics/testing/tools.txt index d97644fb72..680c1dd17c 100644 --- a/docs/topics/testing/tools.txt +++ b/docs/topics/testing/tools.txt @@ -427,6 +427,13 @@ Specifically, a ``Response`` object has the following attributes: The request data that stimulated the response. + .. attribute:: wsgi_request + + .. versionadded:: 1.7 + + The ``WSGIRequest`` instance generated by the test handler that + generated the response. + .. attribute:: status_code The HTTP status of the response, as an integer. See diff --git a/tests/test_client/tests.py b/tests/test_client/tests.py index 3693b33752..5fa6360eda 100644 --- a/tests/test_client/tests.py +++ b/tests/test_client/tests.py @@ -84,6 +84,20 @@ class ClientTest(TestCase): self.assertEqual(response['X-DJANGO-TEST'], 'Slartibartfast') + def test_response_attached_request(self): + """ + Check that the returned response has a ``request`` attribute with the + originating environ dict and a ``wsgi_request`` with the originating + ``WSGIRequest`` instance. + """ + response = self.client.get("/test_client/header_view/") + + self.assertTrue(hasattr(response, 'request')) + self.assertTrue(hasattr(response, 'wsgi_request')) + for key, value in response.request.items(): + self.assertIn(key, response.wsgi_request.environ) + self.assertEqual(response.wsgi_request.environ[key], value) + def test_raw_post(self): "POST raw data (with a content type) to a view" test_doc = """BlinkMalcolm Gladwell""" From 270c9fe48883deaacbc15014ceebef6f895559ab Mon Sep 17 00:00:00 2001 From: Michael Blatherwick Date: Fri, 10 Jan 2014 01:44:07 +0000 Subject: [PATCH 205/208] Fixed typo in docstrings of MonthArchiveViews. --- django/views/generic/dates.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/django/views/generic/dates.py b/django/views/generic/dates.py index d221c2c087..2011c6f4be 100644 --- a/django/views/generic/dates.py +++ b/django/views/generic/dates.py @@ -482,7 +482,7 @@ class YearArchiveView(MultipleObjectTemplateResponseMixin, BaseYearArchiveView): class BaseMonthArchiveView(YearMixin, MonthMixin, BaseDateListView): """ - List of objects published in a given year. + List of objects published in a given month. """ date_list_period = 'day' @@ -516,7 +516,7 @@ class BaseMonthArchiveView(YearMixin, MonthMixin, BaseDateListView): class MonthArchiveView(MultipleObjectTemplateResponseMixin, BaseMonthArchiveView): """ - List of objects published in a given year. + List of objects published in a given month. """ template_name_suffix = '_archive_month' From 81bb8d12209a419142b1bf6961fbf9fc44419dcd Mon Sep 17 00:00:00 2001 From: Marc Sibson Date: Thu, 9 Jan 2014 20:31:22 -0800 Subject: [PATCH 206/208] Fixed docstring typo in django/forms/forms.py. --- django/forms/forms.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/django/forms/forms.py b/django/forms/forms.py index 880a74f49e..bcc0d6dfa4 100644 --- a/django/forms/forms.py +++ b/django/forms/forms.py @@ -661,7 +661,7 @@ class BoundField(object): """ Wrapper around the field widget's `id_for_label` method. Useful, for example, for focusing on this field regardless of whether - it has a single widget or a MutiWidget. + it has a single widget or a MultiWidget. """ widget = self.field.widget id_ = widget.attrs.get('id') or self.auto_id From 3326a412ccde9f72e22a070a0b4d922048ed2286 Mon Sep 17 00:00:00 2001 From: Aymeric Augustin Date: Fri, 10 Jan 2014 23:06:19 +0100 Subject: [PATCH 207/208] Deprecated importing a model before loading its application. Refs #21719, #21680. --- django/db/models/base.py | 10 +++++++++- docs/internals/deprecation.txt | 6 ++++++ docs/ref/applications.txt | 7 +++++++ docs/releases/1.7.txt | 15 ++++++++++++--- tests/runtests.py | 7 ++++++- 5 files changed, 40 insertions(+), 5 deletions(-) diff --git a/django/db/models/base.py b/django/db/models/base.py index 531dd8adcc..d7b54b9268 100644 --- a/django/db/models/base.py +++ b/django/db/models/base.py @@ -3,7 +3,7 @@ from __future__ import unicode_literals import copy import sys from functools import update_wrapper -from django.utils.six.moves import zip +import warnings from django.apps import apps from django.apps.base import MODELS_MODULE_NAME @@ -25,6 +25,7 @@ from django.utils.translation import ugettext_lazy as _ from django.utils.functional import curry from django.utils.encoding import force_str, force_text from django.utils import six +from django.utils.six.moves import zip from django.utils.text import get_text_list, capfirst @@ -103,6 +104,13 @@ class ModelBase(type): # For 'django.contrib.sites.models', this would be 'sites'. # For 'geo.models.places' this would be 'geo'. + warnings.warn( + "Model class %s.%s doesn't declare an explicit app_label " + "and either isn't in an application in INSTALLED_APPS " + "or else was imported before its application was loaded. " + "This will no longer be supported in Django 1.9." + % (module, name), PendingDeprecationWarning, stacklevel=2) + model_module = sys.modules[new_class.__module__] package_components = model_module.__name__.split('.') package_components.reverse() # find the last occurrence of 'models' diff --git a/docs/internals/deprecation.txt b/docs/internals/deprecation.txt index 1b8b45a520..514561e1ff 100644 --- a/docs/internals/deprecation.txt +++ b/docs/internals/deprecation.txt @@ -170,6 +170,12 @@ these changes. * ``allow_syncdb`` on database routers will no longer automatically become ``allow_migrate``. +* All models will need to be defined inside an installed application or + declare an explicit :attr:`~django.db.models.Options.app_label`. + Furthermore, it won't be possible to import them before their application + is loaded. In particular, it won't be possible to import models inside + the root package of their application. + * If models are organized in a package, Django will no longer look for :ref:`initial SQL data` in ``myapp/models/sql/``. Move your custom SQL files to ``myapp/sql/``. diff --git a/docs/ref/applications.txt b/docs/ref/applications.txt index a44062808e..e496f24487 100644 --- a/docs/ref/applications.txt +++ b/docs/ref/applications.txt @@ -181,6 +181,13 @@ Methods as registering signals. It is called as soon as the registry is fully populated. + You cannot import models in modules that define application configuration + classes, but you can use :meth:`get_model` to access a model class by + name, like this:: + + def ready(self): + MyModel = self.get_model('MyModel') + Application registry ==================== diff --git a/docs/releases/1.7.txt b/docs/releases/1.7.txt index a8becf1bab..9fcad38931 100644 --- a/docs/releases/1.7.txt +++ b/docs/releases/1.7.txt @@ -677,9 +677,18 @@ directory and a subdirectory on :envvar:`PYTHONPATH`. Refer to the section on the new project layout in the :doc:`1.4 release notes ` for migration instructions. -You should make sure that your project doesn't import models from applications -that aren't in :setting:`INSTALLED_APPS`. Relations involving such models may -not be created properly. Future versions of Django may forbid this entirely. +You should make sure that: + +* All models are defined in applications that are listed in + :setting:`INSTALLED_APPS` or have an explicit + :attr:`~django.db.models.Options.app_label`. + +* Models aren't imported as a side-effect of loading their application. + Specifically, you shouldn't import models in the root module of an + application nor in the module that define its configuration class. + +Django will enforce these requirements as of version 1.9, after a deprecation +period. Subclassing AppCommand ^^^^^^^^^^^^^^^^^^^^^^ diff --git a/tests/runtests.py b/tests/runtests.py index bb14a27fd6..dcd9c885bd 100755 --- a/tests/runtests.py +++ b/tests/runtests.py @@ -130,6 +130,11 @@ def setup(verbosity, test_labels): 'django.contrib.comments is deprecated and will be removed before Django 1.8.', DeprecationWarning ) + warnings.filterwarnings( + 'ignore', + 'Model class django.contrib.comments.models.*supported in Django 1.9.', + PendingDeprecationWarning + ) # Load all the ALWAYS_INSTALLED_APPS. django.setup() @@ -169,8 +174,8 @@ def setup(verbosity, test_labels): if module_label not in settings.INSTALLED_APPS: settings.INSTALLED_APPS.append(module_label) app_config = AppConfig.create(module_label) - app_config.import_models(apps.all_models[app_config.label]) apps.app_configs[app_config.label] = app_config + app_config.import_models(apps.all_models[app_config.label]) apps.clear_cache() return state From f7c2c0a3be84d1dbd64d49676fbd4110bc009b31 Mon Sep 17 00:00:00 2001 From: Alex Gaynor Date: Fri, 10 Jan 2014 15:22:55 -0800 Subject: [PATCH 208/208] Removed a man page for a command that was removed --- docs/man/daily_cleanup.1 | 34 ---------------------------------- 1 file changed, 34 deletions(-) delete mode 100644 docs/man/daily_cleanup.1 diff --git a/docs/man/daily_cleanup.1 b/docs/man/daily_cleanup.1 deleted file mode 100644 index dfcde1dff7..0000000000 --- a/docs/man/daily_cleanup.1 +++ /dev/null @@ -1,34 +0,0 @@ -.TH "daily_cleanup.py" "1" "August 2007" "Django Project" "" -.SH "NAME" -daily_cleanup.py \- Database clean-up for the Django Web framework -.SH "SYNOPSIS" -.B daily_cleanup.py - -.SH "DESCRIPTION" -Removes stale session data from a Django database. This means, any session data -which has an expiry date prior to the date the script is run. -.sp -The script can be run manually or can be scheduled to run at regular -intervals as a -.BI cron -job. - -.SH "ENVIRONMENT" -.TP -.I DJANGO_SETTINGS_MODULE -This environment variable defines the settings module to be read. -It should be in Python-import form, e.g. "myproject.settings". - -.SH "SEE ALSO" -The sessions documentation: -.sp -.I http://docs.djangoproject.com/en/dev/topics/http/sessions/ - -.SH "AUTHORS/CREDITS" -Originally developed at World Online in Lawrence, Kansas, USA. Refer to the -AUTHORS file in the Django distribution for contributors. - -.SH "LICENSE" -New BSD license. For the full license text refer to the LICENSE file in the -Django distribution. -