From 708fb9ac5044ea63ec37b3e92c2790830d726f5d Mon Sep 17 00:00:00 2001 From: Jannis Leidel Date: Wed, 15 May 2013 10:59:02 +0200 Subject: [PATCH] Renamed the pristine decorator to pristinemethod for consistency. --- configurations/__init__.py | 4 ++-- configurations/decorators.py | 8 ++++---- configurations/tests/settings/main.py | 6 +++--- docs/index.rst | 14 +++++++------- 4 files changed, 16 insertions(+), 16 deletions(-) diff --git a/configurations/__init__.py b/configurations/__init__.py index 3031c22..42afa9b 100644 --- a/configurations/__init__.py +++ b/configurations/__init__.py @@ -1,6 +1,6 @@ # flake8: noqa from .base import Settings -from .decorators import pristine +from .decorators import pristinemethod __version__ = '0.2.1' -__all__ = ['Settings', 'pristine'] +__all__ = ['Settings', 'pristinemethod'] diff --git a/configurations/decorators.py b/configurations/decorators.py index cb51197..d89cf7e 100644 --- a/configurations/decorators.py +++ b/configurations/decorators.py @@ -1,18 +1,18 @@ -def pristine(func): +def pristinemethod(func): """ A decorator for handling pristine settings like callables. Use it like this:: - from configurations import pristine + from configurations import pristinemethod class Develop(Settings): - @pristine + @pristinemethod USER_CHECK(user): return user.check_perms() - GROUP_CHECK = pristine(lambda user: user.has_group_access()) + GROUP_CHECK = pristinemethod(lambda user: user.has_group_access()) """ func.pristine = True diff --git a/configurations/tests/settings/main.py b/configurations/tests/settings/main.py index 4e74070..b5cc1d9 100644 --- a/configurations/tests/settings/main.py +++ b/configurations/tests/settings/main.py @@ -1,6 +1,6 @@ import os import uuid -from configurations import Settings, pristine +from configurations import Settings, pristinemethod class Test(Settings): @@ -47,9 +47,9 @@ class Test(Settings): LAMBDA_SETTING = lambda self: 3 - PRISTINE_LAMBDA_SETTING = pristine(lambda: 4) + PRISTINE_LAMBDA_SETTING = pristinemethod(lambda: 4) - @pristine + @pristinemethod def PRISTINE_FUNCTION_SETTING(): return 5 diff --git a/docs/index.rst b/docs/index.rst index af66dcf..82ede19 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -131,29 +131,29 @@ a Settings class:: DEBUG = False # ... -Pristines -^^^^^^^^^ +Pristine methods +^^^^^^^^^^^^^^^^ .. versionadded:: 0.3 In case one of your settings itself need to be a callable, you need to -tell that django-configurations by using the ``pristine`` decorator, +tell that django-configurations by using the ``pristinemethod`` decorator, e.g.:: - from configurations import Settings, pristine + from configurations import Settings, pristinemethod class Prod(Settings): - @pristine + @pristinemethod def ACCESS_FUNCTION(user): return user.is_staff Lambdas work, too:: - from configurations import Settings, pristine + from configurations import Settings, pristinemethod class Prod(Settings): - ACCESS_FUNCTION = pristine(lamda user: user.is_staff) + ACCESS_FUNCTION = pristinemethod(lamda user: user.is_staff) Setup methods ^^^^^^^^^^^^^