Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added strict mode to utils.setting() #176

Merged
merged 1 commit into from
Aug 2, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions storages/utils.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,22 @@
from django.conf import settings
from django.core.exceptions import ImproperlyConfigured


def setting(name, default=None):
def setting(name, default=None, strict=False):
"""
Helper function to get a Django setting by name or (optionally) return
a default (or else ``None``).
Helper function to get a Django setting by name. If setting doesn't exists
it can return a default or raise an error if in strict mode.

:param name: Name of setting
:type name: str
:param default: Value if setting is unfound
:param strict: Define if return default value or raise an error
:type strict: bool
:returns: Setting's value
:raises: django.core.exceptions.ImproperlyConfigured if setting is unfound
and strict mode
"""
if strict and not hasattr(settings, name):
msg = "You must provide settings.%s" % name
raise ImproperlyConfigured(msg)
return getattr(settings, name, default)
16 changes: 16 additions & 0 deletions tests/test_utils.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
from django.test import TestCase
from django.conf import settings
from django.core.exceptions import ImproperlyConfigured
from storages import utils


class SettingTest(TestCase):
def test_get_setting(self):
value = utils.setting('SECRET_KEY')
self.assertEqual(settings.SECRET_KEY, value)

def test_setting_unfound(self):
self.assertIsNone(utils.setting('FOO'))
self.assertEqual(utils.setting('FOO', 'bar'), 'bar')
with self.assertRaises(ImproperlyConfigured):
utils.setting('FOO', strict=True)