From 8faa6dc9a172e9e543cf4fb8dbe8f5692e28ef6d Mon Sep 17 00:00:00 2001 From: Jannis Leidel Date: Wed, 24 Aug 2011 17:17:17 +0200 Subject: [PATCH 1/8] Renamed `app_label` Meta attribute to `prefix` to better describe what it means. --- appconf.py | 18 +++++++++--------- tests/testapp/models.py | 4 ++-- tests/testapp/tests.py | 14 +++++++------- 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/appconf.py b/appconf.py index 023c617..68f00c7 100644 --- a/appconf.py +++ b/appconf.py @@ -6,13 +6,13 @@ class AppConfOptions(object): - def __init__(self, meta, app_label=None): - self.app_label = app_label + def __init__(self, meta, prefix=None): + self.prefix = prefix def prefixed_name(self, name): - if name.startswith(self.app_label.upper()): + if name.startswith(self.prefix.upper()): return name - return "%s_%s" % (self.app_label.upper(), name.upper()) + return "%s_%s" % (self.prefix.upper(), name.upper()) def contribute_to_class(self, cls, name): cls._meta = self @@ -38,14 +38,14 @@ def __new__(cls, name, bases, attrs): attr_meta = type('Meta', (object,), {}) meta = getattr(new_class, 'Meta', None) - app_label = getattr(meta, 'app_label', None) - if app_label is None: - # Figure out the app_label by looking one level up. + prefix = getattr(meta, 'prefix', getattr(meta, 'app_label', None)) + if prefix is None: + # Figure out the prefix by looking one level up. # For 'django.contrib.sites.models', this would be 'sites'. model_module = sys.modules[new_class.__module__] - app_label = model_module.__name__.split('.')[-2] + prefix = model_module.__name__.split('.')[-2] - new_class.add_to_class('_meta', AppConfOptions(meta, app_label)) + new_class.add_to_class('_meta', AppConfOptions(meta, prefix)) new_class.add_to_class('Meta', attr_meta) for parent in parents[::-1]: diff --git a/tests/testapp/models.py b/tests/testapp/models.py index 072dd6c..8285b1a 100644 --- a/tests/testapp/models.py +++ b/tests/testapp/models.py @@ -17,7 +17,7 @@ def configure(self): class PrefixConf(TestConf): class Meta: - app_label = 'prefix' + prefix = 'prefix' class YetAnotherPrefixConf(PrefixConf): @@ -25,7 +25,7 @@ class YetAnotherPrefixConf(PrefixConf): SIMPLE_VALUE = False class Meta: - app_label = 'yetanother_prefix' + prefix = 'yetanother_prefix' class SeparateConf(AppConf): diff --git a/tests/testapp/tests.py b/tests/testapp/tests.py index 6faa733..1085d39 100644 --- a/tests/testapp/tests.py +++ b/tests/testapp/tests.py @@ -8,7 +8,7 @@ class TestConfTests(TestCase): def test_basic(self): - self.assertEquals(TestConf._meta.app_label, 'testapp') + self.assertEquals(TestConf._meta.prefix, 'testapp') def test_simple(self): self.assertTrue(hasattr(settings, 'TESTAPP_SIMPLE_VALUE')) @@ -40,8 +40,8 @@ def test_dir_members(self): class PrefixConfTests(TestCase): - def test_app_label(self): - self.assertEquals(PrefixConf._meta.app_label, 'prefix') + def test_prefix(self): + self.assertEquals(PrefixConf._meta.prefix, 'prefix') def test_simple(self): self.assertTrue(hasattr(settings, 'PREFIX_SIMPLE_VALUE')) @@ -58,8 +58,8 @@ def test_configure_method(self): class YetAnotherPrefixConfTests(TestCase): - def test_app_label(self): - self.assertEquals(YetAnotherPrefixConf._meta.app_label, + def test_prefix(self): + self.assertEquals(YetAnotherPrefixConf._meta.prefix, 'yetanother_prefix') def test_simple(self): @@ -82,8 +82,8 @@ def test_configure_method(self): class SeparateConfTests(TestCase): - def test_app_label(self): - self.assertEquals(SeparateConf._meta.app_label, 'prefix') + def test_prefix(self): + self.assertEquals(SeparateConf._meta.prefix, 'prefix') def test_simple(self): self.assertTrue(hasattr(settings, 'PREFIX_SEPARATE_VALUE')) From b5ebcde517a8daf46efd057a2e3622fd1ecfcb89 Mon Sep 17 00:00:00 2001 From: Jannis Leidel Date: Wed, 24 Aug 2011 17:20:18 +0200 Subject: [PATCH 2/8] Added ability to specify a `holder` Meta attribute which by default is `'django.conf.settings'`. Also made instance attribute access **not** use the prefix to ease use. --- appconf.py | 47 +++++++++++++++++++++++++++++------------ tests/testapp/models.py | 15 +++++++++++++ tests/testapp/tests.py | 18 ++++++++++++---- 3 files changed, 63 insertions(+), 17 deletions(-) diff --git a/appconf.py b/appconf.py index 68f00c7..788a913 100644 --- a/appconf.py +++ b/appconf.py @@ -8,6 +8,8 @@ class AppConfOptions(object): def __init__(self, meta, prefix=None): self.prefix = prefix + self.holder_path = getattr(meta, 'holder', 'django.conf.settings') + self.holder = import_attribute(self.holder_path) def prefixed_name(self, name): if name.startswith(self.prefix.upper()): @@ -56,11 +58,11 @@ def __new__(cls, name, bases, attrs): for name in filter(lambda name: name == name.upper(), attrs): prefixed_name = new_class._meta.prefixed_name(name) new_class._meta.names[name] = prefixed_name - new_class._meta.defaults[prefixed_name] = attrs.pop(name) + new_class._meta.defaults[prefixed_name] = attrs.get(name) # Add all attributes to the class. - for obj_name, obj in attrs.items(): - new_class.add_to_class(obj_name, obj) + for name, value in attrs.items(): + new_class.add_to_class(name, value) return new_class._configure() @@ -71,13 +73,12 @@ def add_to_class(cls, name, value): setattr(cls, name, value) def _configure(cls): - from django.conf import settings # the ad-hoc settings class instance used to configure each value obj = cls() obj.configured_data = dict() for name, prefixed_name in obj._meta.names.iteritems(): default_value = obj._meta.defaults.get(prefixed_name) - value = getattr(settings, prefixed_name, default_value) + value = getattr(obj._meta.holder, prefixed_name, default_value) callback = getattr(obj, "configure_%s" % name.lower(), None) if callable(callback): value = callback(value) @@ -87,11 +88,31 @@ def _configure(cls): # Finally, set the setting in the global setting object for name, value in obj.configured_data.iteritems(): prefixed_name = obj._meta.prefixed_name(name) - setattr(settings, prefixed_name, value) - + setattr(obj._meta.holder, prefixed_name, value) return cls +def import_attribute(import_path, exception_handler=None): + from django.utils.importlib import import_module + module_name, object_name = import_path.rsplit('.', 1) + try: + module = import_module(module_name) + except: # pragma: no cover + if callable(exception_handler): + exctype, excvalue, tb = sys.exc_info() + return exception_handler(import_path, exctype, excvalue, tb) + else: + raise + try: + return getattr(module, object_name) + except: # pragma: no cover + if callable(exception_handler): + exctype, excvalue, tb = sys.exc_info() + return exception_handler(import_path, exctype, excvalue, tb) + else: + raise + + class AppConf(object): """ An app setting object to be used for handling app setting defaults @@ -100,13 +121,11 @@ class AppConf(object): __metaclass__ = AppConfMetaClass def __init__(self, **kwargs): - from django.conf import settings - self._holder = settings for name, value in kwargs.iteritems(): - setattr(self, self._meta.prefixed_name(name), value) + setattr(self, name, value) def __dir__(self): - return sorted(list(set(dir(self._holder)))) + return sorted(list(set(self._meta.names.keys()))) # For Python < 2.6: @property @@ -114,11 +133,13 @@ def __members__(self): return self.__dir__() def __getattr__(self, name): - return getattr(self._holder, name) + raise AttributeError("%s not found. Use '%s' instead." % + (name, self._meta.holder_path)) def __setattr__(self, name, value): if name == name.upper(): - return setattr(self._holder, name, value) + setattr(self._meta.holder, + self._meta.prefixed_name(name), value) object.__setattr__(self, name, value) def configure(self): diff --git a/tests/testapp/models.py b/tests/testapp/models.py index 8285b1a..39d49ce 100644 --- a/tests/testapp/models.py +++ b/tests/testapp/models.py @@ -1,5 +1,12 @@ from appconf import AppConf + +class CustomHolder(object): + pass + +custom_holder = CustomHolder() + + class TestConf(AppConf): SIMPLE_VALUE = True @@ -35,3 +42,11 @@ class SeparateConf(AppConf): class Meta(PrefixConf.Meta): pass + +class CustomHolderConf(AppConf): + + SIMPLE_VALUE = True + + class Meta: + holder = 'testapp.models.custom_holder' # instead of django.conf.settings + prefix = 'custom_holder' diff --git a/tests/testapp/tests.py b/tests/testapp/tests.py index 1085d39..786c3bd 100644 --- a/tests/testapp/tests.py +++ b/tests/testapp/tests.py @@ -2,7 +2,7 @@ from django.test import TestCase from testapp.models import (TestConf, PrefixConf, YetAnotherPrefixConf, - SeparateConf) + SeparateConf, CustomHolderConf, custom_holder) class TestConfTests(TestCase): @@ -24,8 +24,9 @@ def test_configure_method(self): def test_init_kwargs(self): custom_conf = TestConf(CUSTOM_VALUE='custom') - self.assertEquals(custom_conf.TESTAPP_CUSTOM_VALUE, 'custom') + self.assertEquals(custom_conf.CUSTOM_VALUE, 'custom') self.assertEquals(settings.TESTAPP_CUSTOM_VALUE, 'custom') + self.assertRaises(AttributeError, lambda: custom_conf.TESTAPP_CUSTOM_VALUE) def test_init_kwargs_with_prefix(self): custom_conf = TestConf(TESTAPP_CUSTOM_VALUE2='custom2') @@ -33,9 +34,18 @@ def test_init_kwargs_with_prefix(self): self.assertEquals(settings.TESTAPP_CUSTOM_VALUE2, 'custom2') def test_dir_members(self): - settings = TestConf() - self.assertTrue('TESTAPP_SIMPLE_VALUE' in dir(settings), dir(settings)) + custom_conf = TestConf() + self.assertTrue('TESTAPP_SIMPLE_VALUE' in dir(settings)) self.assertTrue('TESTAPP_SIMPLE_VALUE' in settings.__members__) + self.assertTrue('SIMPLE_VALUE' in dir(custom_conf)) + self.assertTrue('SIMPLE_VALUE' in custom_conf.__members__) + self.assertFalse('TESTAPP_SIMPLE_VALUE' in dir(custom_conf)) + self.assertFalse('TESTAPP_SIMPLE_VALUE' in custom_conf.__members__) + + def test_custom_holder(self): + custom_conf = CustomHolderConf() + self.assertTrue(hasattr(custom_holder, 'CUSTOM_HOLDER_SIMPLE_VALUE')) + self.assertEquals(custom_holder.CUSTOM_HOLDER_SIMPLE_VALUE, True) class PrefixConfTests(TestCase): From 81da53ed4420c68905867959decb1e97b0e312e4 Mon Sep 17 00:00:00 2001 From: Jannis Leidel Date: Wed, 24 Aug 2011 18:55:21 +0200 Subject: [PATCH 3/8] Added proxy Meta attribute to configure access to global settings. --- appconf.py | 3 +++ tests/testapp/models.py | 6 ++++++ tests/testapp/tests.py | 10 +++++++++- 3 files changed, 18 insertions(+), 1 deletion(-) diff --git a/appconf.py b/appconf.py index 788a913..eed083b 100644 --- a/appconf.py +++ b/appconf.py @@ -10,6 +10,7 @@ def __init__(self, meta, prefix=None): self.prefix = prefix self.holder_path = getattr(meta, 'holder', 'django.conf.settings') self.holder = import_attribute(self.holder_path) + self.proxy = getattr(meta, 'proxy', False) def prefixed_name(self, name): if name.startswith(self.prefix.upper()): @@ -133,6 +134,8 @@ def __members__(self): return self.__dir__() def __getattr__(self, name): + if self._meta.proxy: + return getattr(self._meta.holder, name) raise AttributeError("%s not found. Use '%s' instead." % (name, self._meta.holder_path)) diff --git a/tests/testapp/models.py b/tests/testapp/models.py index 39d49ce..a1a23b1 100644 --- a/tests/testapp/models.py +++ b/tests/testapp/models.py @@ -43,6 +43,12 @@ class Meta(PrefixConf.Meta): pass +class ProxyConf(TestConf): + + class Meta: + proxy = True + + class CustomHolderConf(AppConf): SIMPLE_VALUE = True diff --git a/tests/testapp/tests.py b/tests/testapp/tests.py index 786c3bd..73c4eae 100644 --- a/tests/testapp/tests.py +++ b/tests/testapp/tests.py @@ -2,7 +2,8 @@ from django.test import TestCase from testapp.models import (TestConf, PrefixConf, YetAnotherPrefixConf, - SeparateConf, CustomHolderConf, custom_holder) + SeparateConf, ProxyConf, CustomHolderConf, + custom_holder) class TestConfTests(TestCase): @@ -33,6 +34,13 @@ def test_init_kwargs_with_prefix(self): self.assertEquals(custom_conf.TESTAPP_CUSTOM_VALUE2, 'custom2') self.assertEquals(settings.TESTAPP_CUSTOM_VALUE2, 'custom2') + def test_proxy(self): + custom_conf = ProxyConf(CUSTOM_VALUE3='custom3') + self.assertEquals(custom_conf.CUSTOM_VALUE3, 'custom3') + self.assertEquals(settings.TESTAPP_CUSTOM_VALUE3, 'custom3') + self.assertEquals(custom_conf.TESTAPP_CUSTOM_VALUE3, 'custom3') + self.assertTrue('tests.testapp' in custom_conf.INSTALLED_APPS) + def test_dir_members(self): custom_conf = TestConf() self.assertTrue('TESTAPP_SIMPLE_VALUE' in dir(settings)) From a954a5e261af94b889c13780cd1bc0af26f4f6ac Mon Sep 17 00:00:00 2001 From: Jannis Leidel Date: Wed, 24 Aug 2011 18:57:10 +0200 Subject: [PATCH 4/8] Moved setting the configured_data dictionary outside of the _configure() method and made sure it considers the parent classes, too. --- appconf.py | 27 ++++++++++++++++----------- tests/testapp/models.py | 7 +++++++ tests/testapp/tests.py | 8 ++++++++ 3 files changed, 31 insertions(+), 11 deletions(-) diff --git a/appconf.py b/appconf.py index eed083b..18252b1 100644 --- a/appconf.py +++ b/appconf.py @@ -11,6 +11,7 @@ def __init__(self, meta, prefix=None): self.holder_path = getattr(meta, 'holder', 'django.conf.settings') self.holder = import_attribute(self.holder_path) self.proxy = getattr(meta, 'proxy', False) + self.configured_data = {} def prefixed_name(self, name): if name.startswith(self.prefix.upper()): @@ -55,17 +56,23 @@ def __new__(cls, name, bases, attrs): if hasattr(parent, '_meta'): new_class._meta.names.update(parent._meta.names) new_class._meta.defaults.update(parent._meta.defaults) + new_class._meta.configured_data.update(parent._meta.configured_data) for name in filter(lambda name: name == name.upper(), attrs): prefixed_name = new_class._meta.prefixed_name(name) new_class._meta.names[name] = prefixed_name - new_class._meta.defaults[prefixed_name] = attrs.get(name) + new_class._meta.defaults[prefixed_name] = attrs.pop(name) # Add all attributes to the class. for name, value in attrs.items(): new_class.add_to_class(name, value) - return new_class._configure() + new_class._configure() + for name, value in new_class._meta.configured_data.iteritems(): + prefixed_name = new_class._meta.prefixed_name(name) + setattr(new_class._meta.holder, prefixed_name, value) + new_class.add_to_class(name, value) + return new_class def add_to_class(cls, name, value): if hasattr(value, 'contribute_to_class'): @@ -76,21 +83,14 @@ def add_to_class(cls, name, value): def _configure(cls): # the ad-hoc settings class instance used to configure each value obj = cls() - obj.configured_data = dict() for name, prefixed_name in obj._meta.names.iteritems(): default_value = obj._meta.defaults.get(prefixed_name) value = getattr(obj._meta.holder, prefixed_name, default_value) callback = getattr(obj, "configure_%s" % name.lower(), None) if callable(callback): value = callback(value) - obj.configured_data[name] = value - obj.configured_data = obj.configure() - - # Finally, set the setting in the global setting object - for name, value in obj.configured_data.iteritems(): - prefixed_name = obj._meta.prefixed_name(name) - setattr(obj._meta.holder, prefixed_name, value) - return cls + cls._meta.configured_data[name] = value + cls._meta.configured_data = obj.configure() def import_attribute(import_path, exception_handler=None): @@ -128,6 +128,11 @@ def __init__(self, **kwargs): def __dir__(self): return sorted(list(set(self._meta.names.keys()))) + @property + # For instance access.. + def configured_data(self): + return self._meta.configured_data + # For Python < 2.6: @property def __members__(self): diff --git a/tests/testapp/models.py b/tests/testapp/models.py index a1a23b1..99dc4de 100644 --- a/tests/testapp/models.py +++ b/tests/testapp/models.py @@ -43,6 +43,13 @@ class Meta(PrefixConf.Meta): pass +class SubclassConf(TestConf): + + def configure(self): + self.configured_data['CONFIGURE_METHOD_VALUE2'] = False + return self.configured_data + + class ProxyConf(TestConf): class Meta: diff --git a/tests/testapp/tests.py b/tests/testapp/tests.py index 73c4eae..dbec07a 100644 --- a/tests/testapp/tests.py +++ b/tests/testapp/tests.py @@ -28,6 +28,10 @@ def test_init_kwargs(self): self.assertEquals(custom_conf.CUSTOM_VALUE, 'custom') self.assertEquals(settings.TESTAPP_CUSTOM_VALUE, 'custom') self.assertRaises(AttributeError, lambda: custom_conf.TESTAPP_CUSTOM_VALUE) + custom_conf.CUSTOM_VALUE_SETATTR = 'custom' + self.assertEquals(settings.TESTAPP_CUSTOM_VALUE_SETATTR, 'custom') + custom_conf.custom_value_lowercase = 'custom' + self.assertRaises(AttributeError, lambda: settings.custom_value_lowercase) def test_init_kwargs_with_prefix(self): custom_conf = TestConf(TESTAPP_CUSTOM_VALUE2='custom2') @@ -55,6 +59,10 @@ def test_custom_holder(self): self.assertTrue(hasattr(custom_holder, 'CUSTOM_HOLDER_SIMPLE_VALUE')) self.assertEquals(custom_holder.CUSTOM_HOLDER_SIMPLE_VALUE, True) + def test_subclass_configured_data(self): + self.assertTrue('TESTAPP_CONFIGURE_METHOD_VALUE2' in dir(settings)) + self.assertEquals(settings.TESTAPP_CONFIGURE_METHOD_VALUE2, False) + class PrefixConfTests(TestCase): From b43b95cce2b903848187dbae2d8488eeb168b2e8 Mon Sep 17 00:00:00 2001 From: Jannis Leidel Date: Thu, 25 Aug 2011 16:11:22 +0200 Subject: [PATCH 5/8] Added Sphinx docs and extended change log. Also added AUTHORS and LICENSE files. --- AUTHORS | 1 + LICENSE | 27 ++++++ MANIFEST.in | 4 +- README.rst | 162 +++++++++---------------------- appconf.py | 6 +- docs/Makefile | 130 +++++++++++++++++++++++++ docs/changelog.rst | 48 +++++++++ docs/conf.py | 220 ++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 12 +++ docs/installation.rst | 20 ++++ docs/make.bat | 170 ++++++++++++++++++++++++++++++++ docs/reference.rst | 76 +++++++++++++++ docs/usage.rst | 97 +++++++++++++++++++ setup.py | 5 +- 14 files changed, 854 insertions(+), 124 deletions(-) create mode 100644 AUTHORS create mode 100644 LICENSE create mode 100644 docs/Makefile create mode 100644 docs/changelog.rst create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/installation.rst create mode 100644 docs/make.bat create mode 100644 docs/reference.rst create mode 100644 docs/usage.rst diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..875031a --- /dev/null +++ b/AUTHORS @@ -0,0 +1 @@ +Jannis Leidel \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a8d4cc9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,27 @@ +Copyright (c) 2011, Jannis Leidel and individual contributors. +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + * Neither the name of django-appconf nor the + names of its contributors may be used to endorse or promote products + derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in index c4bf456..156f3ac 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1,3 @@ -include README.rst \ No newline at end of file +include README.rst +include LICENSE +include AUTHORS diff --git a/README.rst b/README.rst index a6d1315..a948a5b 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,16 @@ django-appconf ============== -An app configuration object to be used for handling configuration -defaults of packaged apps gracefully. Say you have an app called ``myapp`` -and want to define a few defaults, and refer to the defaults easily in the -apps code. Add a ``settings.py`` to your app's models.py:: +A helper class for handling configuration defaults of packaged Django +apps gracefully. + +Overview +-------- + +Say you have an app called ``myapp`` with a few defaults, which you want +to refer to in the app's code without repeating yourself all the time. +``appconf`` provides a simple class to implement those defaults. Simply add +something like the following code somewhere in your app files:: from appconf import AppConf @@ -14,132 +20,50 @@ apps code. Add a ``settings.py`` to your app's models.py:: "two", ) - class Meta: - app_label = 'myapp' - -The settings are initialized with the app label of where the setting is -located at. E.g. if your ``models.py`` is in the ``myapp`` package, -the prefix of the settings will be ``MYAPP``. - -The ``MyAppConf`` class will automatically look at Django's -global setting to determine each of the settings. E.g. adding this to -your site's ``settings.py`` will set the ``SETTING_1`` app setting -accordingly:: - - MYAPP_SETTING_1 = "uno" - -Usage ------ - -Instead of using ``from django.conf import settings`` as you would -usually do, you can **optionally** switch to using your apps own -settings module to access the settings:: - - from myapp.models import MyAppConf - - myapp_settings = MyAppConf() - - print myapp_settings.MYAPP_SETTING_1 +.. note:: -``AppConf`` class automatically work as proxies for the other -settings, which aren't related to the app. For example the following -code is perfectly valid:: + ``AppConf`` classes depend on being imported during startup of the Django + process. Even though there are multiple modules loaded automatically, + only the ``models`` modules (usually the ``models.py`` file of your + app) are guaranteed to be loaded at startup. Therefore it's recommended + to put your ``AppConf`` subclass(es) there, too. - from myapp.models import MyAppConf +The settings are initialized with the capitalized app label of where the +setting is located at. E.g. if your ``models.py`` with the ``AppConf`` class +is in the ``myapp`` package, the prefix of the settings will be ``MYAPP``. - settings = MyAppConf() +You can override the default prefix by specifying a ``prefix`` attribute of +an inner ``Meta`` class:: - if "myapp" in settings.INSTALLED_APPS: - print "yay, myapp is installed!" - -In case you want to set some settings ad-hoc, you can simply pass -the value when instanciating the ``AppConf`` class:: - - from myapp.models import MyAppConf - - settings = MyAppConf(SETTING_1='something completely different') - - if 'different' in settings.MYAPP_SETTINGS_1: - print 'yay, I'm different!' - -Custom handling ---------------- - -Each of the settings can be individually configured with callbacks. -For example, in case a value of a setting depends on other settings -or other dependencies. The following example sets one setting to a -different value depending on a global setting:: - - from django.conf import settings from appconf import AppConf - class MyCustomAppConf(AppConf): - ENABLED = True - - def configure_enabled(self, value): - return value and not self.DEBUG + class MyAppConf(AppConf): + SETTING_1 = "one" + SETTING_2 = ( + "two", + ) -The value of ``MYAPP_ENABLED`` will vary depending on the -value of the global ``DEBUG`` setting. + class Meta: + prefix = 'acme' -Each of the app settings can be customized by providing -a method ``configure_`` that takes the default -value as defined in the class attributes as the only parameter. -The method needs to return the value to be use for the setting in -question. +The ``MyAppConf`` class will automatically look at Django's global settings +to determine if you've overridden it. For example, adding this to your site's +``settings.py`` would override ``SETTING_1`` of the above ``MyAppConf``:: -After each of the ``_configure`` method have be called, the ``AppConf`` -class will additionally call a main ``configure`` method, which can -be used to do any further custom configuration handling, e.g. if multiple -settings depend on each other. For that a ``configured_data`` dictionary -is provided in the setting instance:: + MYAPP_SETTING_1 = "uno" +In case you want to use a different settings object instead of the default +``'django.conf.settings'``, set the ``holder`` attribute of the inner +``Meta`` class to a dotted import path:: - from django.conf import settings from appconf import AppConf - class MyCustomAppConf(AppConf): - ENABLED = True - MODE = 'development' - - def configure_enabled(self, value): - return value and not self.DEBUG - - def configure(self): - mode = self.configured_data['MODE'] - enabled = self.configured_data['ENABLED'] - if not enabled and mode != 'development': - print "WARNING: app not enabled in %s mode!" % mode - -Changelog ---------- - -0.3 (2011-08-23) -^^^^^^^^^^^^^^^^ - -* Added tests with 100% coverage. - -* Added ability to subclass ``Meta`` classes. - -* Fixed various bugs with subclassing and configuration in subclasses. - -0.2.2 (2011-08-22) -^^^^^^^^^^^^^^^^^^ - -* Fixed another issue in the ``configure()`` API. - -0.2.1 (2011-08-22) -^^^^^^^^^^^^^^^^^^ - -* Fixed minor issue in ``configure()`` API. - -0.2 (2011-08-22) -^^^^^^^^^^^^^^^^ - -* Added ``configure()`` API to ``AppConf`` class which is called after - configuring each setting. - -0.1 (2011-08-22) -^^^^^^^^^^^^^^^^ + class MyAppConf(AppConf): + SETTING_1 = "one" + SETTING_2 = ( + "two", + ) -* First public release. + class Meta: + prefix = 'acme' + holder = 'acme.conf.settings' diff --git a/appconf.py b/appconf.py index 18252b1..bdcf29c 100644 --- a/appconf.py +++ b/appconf.py @@ -128,8 +128,8 @@ def __init__(self, **kwargs): def __dir__(self): return sorted(list(set(self._meta.names.keys()))) - @property # For instance access.. + @property def configured_data(self): return self._meta.configured_data @@ -152,6 +152,8 @@ def __setattr__(self, name, value): def configure(self): """ - Hook for doing any extra configuration. + Hook for doing any extra configuration, returning a dictionary + containing the configured data. + """ return self.configured_data diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..a79ced0 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,130 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-appconf.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-appconf.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/django-appconf" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/django-appconf" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + make -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000..97eca4a --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,48 @@ +Changelog +========= + +0.4 (2011-08-24) +---------------- + +* Renamed ``app_label`` attribute of the inner ``Meta`` class to ``prefix``. + The old form ``app_label`` will work in the meantime. + +* Added ``holder`` attribute to the inner ``Meta`` class to be able to + specify a custom "global" setting holder. Default: "'django.conf.settings'" + +* Added ``proxy`` attribute to the inner ``Meta`` class to enable proxying + of ``AppConf`` instances to the settings holder, e.g. the global Django + settings. + +* Fixed issues with ``configured_data`` dictionary available in the + ``configure`` method of ``AppConf`` classes with regard to subclassing. + +0.3 (2011-08-23) +---------------- + +* Added tests with 100% coverage. + +* Added ability to subclass ``Meta`` classes. + +* Fixed various bugs with subclassing and configuration in subclasses. + +0.2.2 (2011-08-22) +------------------ + +* Fixed another issue in the ``configure()`` API. + +0.2.1 (2011-08-22) +------------------ + +* Fixed minor issue in ``configure()`` API. + +0.2 (2011-08-22) +---------------- + +* Added ``configure()`` API to ``AppConf`` class which is called after + configuring each setting. + +0.1 (2011-08-22) +---------------- + +* First public release. diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..3a71915 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,220 @@ +# -*- coding: utf-8 -*- +# +# django-appconf documentation build configuration file, created by +# sphinx-quickstart on Thu Aug 25 14:26:22 2011. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('..')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.coverage'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'django-appconf' +copyright = u'2011, Jannis Leidel and individual contributors' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.3' +# The full version, including alpha/beta/rc tags. +release = '0.3' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'django-appconfdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'django-appconf.tex', u'django-appconf Documentation', + u'Jannis Leidel and individual contributors', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'django-appconf', u'django-appconf Documentation', + [u'Jannis Leidel and individual contributors'], 1) +] + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..4ea4a36 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,12 @@ +.. include:: ../README.rst + +Contents +======== + +.. toctree:: + :maxdepth: 1 + + installation + usage + reference + changelog diff --git a/docs/installation.rst b/docs/installation.rst new file mode 100644 index 0000000..705404e --- /dev/null +++ b/docs/installation.rst @@ -0,0 +1,20 @@ +Installation +============ + +* Install django-appconf with your favorite Python package manager:: + + pip install django-appconf + +* Add ``'appconf'`` to your ``INSTALLED_APPS`` setting:: + + INSTALLED_APPS = ( + # other apps + "appconf", + ) + + +.. _staticfiles: http://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/ +.. _django-staticfiles: http://pypi.python.org/pypi/django-staticfiles + +.. _dependencies: + diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..e4d8a9e --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,170 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. changes to make an overview over all changed/added/deprecated items + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\django-appconf.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\django-appconf.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +:end diff --git a/docs/reference.rst b/docs/reference.rst new file mode 100644 index 0000000..fc18479 --- /dev/null +++ b/docs/reference.rst @@ -0,0 +1,76 @@ +========= +Reference +========= + +.. currentmodule:: appconf + +.. class:: AppConf + + A representation of a template tag. For example:: + + class MyAppConf(AppConf): + SETTING_1 = "one" + SETTING_2 = ( + "two", + ) + + .. method:: configure_*(value) + + Method for each of the app settings for custom configuration + which gets the value passed of the class attribute or the + appropriate override value of the :attr:`~appconf.AppConf.Meta.holder` + settings, e.g.:: + + class MyAppConf(AppConf): + DEPLOYMENT_MODE = "dev" + + def configure_deployment_mode(self, value): + if on_production(): + value = "prod" + return value + + The method **must return** the value to be use for the setting in + question. + + .. automethod:: configure + .. autoattribute:: configured_data + + The dictionary attribute which can be used to do any further custom + configuration handling in the :meth:`~appconf.AppConf.configure` + method, e.g. if multiple settings depend on each other. + +.. class:: AppConf.Meta + + An ``AppConf`` takes options via a ``Meta`` inner class:: + + class MyAppConf(AppConf): + SETTING_1 = "one" + SETTING_2 = ( + "two", + ) + + class Meta: + proxy = False + prefix = 'myapp' + holder = 'django.conf.settings' + + .. attribute:: prefix + + Explicitly choose a prefix for all settings handled by the + ``AppConf`` class. If not given, the prefix will be the capitalized + class module name. + + For example, ``acme`` would turn into settings like + ``ACME_SETTING_1``. + + .. attribute:: holder + + The global settings holder to use when looking for overrides and + when setting the configured values. + + Defaults to ``'django.conf.settings'``. + + .. attribute:: proxy + + A boolean, if set to ``True`` will enable proxying attribute access + to the :attr:`~appconf.AppConf.Meta.holder`. diff --git a/docs/usage.rst b/docs/usage.rst new file mode 100644 index 0000000..ba9031e --- /dev/null +++ b/docs/usage.rst @@ -0,0 +1,97 @@ +.. _usage:: + +Usage +===== + +It's strongly recommended to use the usual ``from django.conf import settings`` +in your own code to access the configured settings. + +But you can also **OPTIONALLY** use your app's own settings object directly, +by instantiating it in place:: + + from myapp.models import MyAppConf + + myapp_settings = MyAppConf() + + print myapp_settings.SETTING_1 + +Note that accessing the settings that way means they don't have a prefix. + +``AppConf`` instances don't automatically work as proxies for the global +settings. But you can enable this if you want by setting the ``proxy`` +attribute of the inner ``Meta`` class to ``True``:: + + from appconf import AppConf + + class MyAppConf(AppConf): + SETTING_1 = "one" + SETTING_2 = ( + "two", + ) + + class Meta: + proxy = True + + myapp_settings = MyAppConf() + + if "myapp" in myapp_settings.INSTALLED_APPS: + print "yay, myapp is installed!" + +In case you want to override some settings programmatically, you can +simply pass the value when instantiating the ``AppConf`` class:: + + from myapp.models import MyAppConf + + myapp_settings = MyAppConf(SETTING_1='something completely different') + + if 'different' in myapp_settings.SETTINGS_1: + print 'yay, I'm different!' + +Custom configuration +-------------------- + +Each of the settings can be individually configured with callbacks. +For example, in case a value of a setting depends on other settings +or other dependencies. The following example sets one setting to a +different value depending on a global setting:: + + from django.conf import settings + from appconf import AppConf + + class MyCustomAppConf(AppConf): + ENABLED = True + + def configure_enabled(self, value): + return value and not settings.DEBUG + +The value of ``MYAPP_ENABLED`` will vary depending on the +value of the global ``DEBUG`` setting. + +Each of the app settings can be customized by providing +a method ``configure_`` that takes the default +value as defined in the class attributes of the ``AppConf`` subclass +or the override value from the global settings as the only parameter. +The method **must return** the value to be use for the setting in +question. + +After each of the ``*_configure`` methods have been called, the ``AppConf`` +class will additionally call a main ``configure`` method, which can +be used to do any further custom configuration handling, e.g. if multiple +settings depend on each other. For that a ``configured_data`` dictionary +is provided in the setting instance:: + + from django.conf import settings + from appconf import AppConf + + class MyCustomAppConf(AppConf): + ENABLED = True + MODE = 'development' + + def configure_enabled(self, value): + return value and not settings.DEBUG + + def configure(self): + mode = self.configured_data['MODE'] + enabled = self.configured_data['ENABLED'] + if not enabled and mode != 'development': + print "WARNING: app not enabled in %s mode!" % mode diff --git a/setup.py b/setup.py index 15c1404..18f5863 100644 --- a/setup.py +++ b/setup.py @@ -7,11 +7,12 @@ setup( name='django-appconf', version=":versiontools:appconf:", - description='An app configuration object to be used for handling ' - 'configuration defaults of packaged apps gracefully.', + description='A helper class for handling configuration defaults ' + 'of packaged apps gracefully.', long_description=read(path.join(path.dirname(__file__), 'README.rst')), author='Jannis Leidel', author_email='jannis@leidel.info', + license = 'BSD', url='https://github.com/jezdez/django-appconf/', py_modules=['appconf'], classifiers=[ From b2f6b206f376372fccc00032a271f5dc48ccf7b0 Mon Sep 17 00:00:00 2001 From: Jannis Leidel Date: Thu, 25 Aug 2011 16:41:32 +0200 Subject: [PATCH 6/8] Updated trove classifier and project URL. --- setup.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/setup.py b/setup.py index 18f5863..764cfe8 100644 --- a/setup.py +++ b/setup.py @@ -13,10 +13,10 @@ author='Jannis Leidel', author_email='jannis@leidel.info', license = 'BSD', - url='https://github.com/jezdez/django-appconf/', + url='http://django-appconf.readthedocs.org/', py_modules=['appconf'], classifiers=[ - "Development Status :: 3 - Alpha", + "Development Status :: 4 - Beta", 'Environment :: Web Environment', 'Framework :: Django', 'Intended Audience :: Developers', @@ -29,6 +29,6 @@ 'Topic :: Utilities', ], setup_requires=[ - 'versiontools >= 1.5', + 'versiontools >= 1.6', ], ) From 669cdf36ec3fd6639bcbbdd8de243f2362d46a48 Mon Sep 17 00:00:00 2001 From: Jannis Leidel Date: Thu, 25 Aug 2011 16:47:56 +0200 Subject: [PATCH 7/8] Fixed broken link and added Sphinx build process to tox configuration. --- docs/usage.rst | 2 -- tests/tox.ini | 8 ++++++++ 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/usage.rst b/docs/usage.rst index ba9031e..b5fe460 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -1,5 +1,3 @@ -.. _usage:: - Usage ===== diff --git a/tests/tox.ini b/tests/tox.ini index bfddd78..646f10f 100644 --- a/tests/tox.ini +++ b/tests/tox.ini @@ -12,6 +12,14 @@ commands = echo "Type the following to open the coverage report: python -m webbrowser -t file://{envtmpdir}/index.html" downloadcache = {toxworkdir}/_download/ +[testenv:docs] +changedir = ../docs +deps = + Sphinx +commands = + make clean + make html + [testenv:py25-1.2.X] basepython = python2.5 deps = From 96130aef622b6d14365b333ffe2994a6f6f11e74 Mon Sep 17 00:00:00 2001 From: Jannis Leidel Date: Thu, 25 Aug 2011 16:51:04 +0200 Subject: [PATCH 8/8] Bumped up to 0.4. --- appconf.py | 2 +- docs/conf.py | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/appconf.py b/appconf.py index bdcf29c..379c623 100644 --- a/appconf.py +++ b/appconf.py @@ -1,7 +1,7 @@ import sys # following PEP 386, versiontools will pick it up -__version__ = (0, 3, 0, "final", 0) +__version__ = (0, 4, 0, "final", 0) class AppConfOptions(object): diff --git a/docs/conf.py b/docs/conf.py index 3a71915..37d2dd2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,9 +48,9 @@ # built documents. # # The short X.Y version. -version = '0.3' +version = '0.4' # The full version, including alpha/beta/rc tags. -release = '0.3' +release = '0.4' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.