aboutsummaryrefslogtreecommitdiffstats
path: root/rest_framework/settings.py
diff options
context:
space:
mode:
authorTom Christie2012-10-30 14:32:31 +0000
committerTom Christie2012-10-30 14:32:31 +0000
commit9b30dab4f772f67a626e176dc4fae0a3ef9c2c81 (patch)
treeca138abf4792f58ffa28684f784f201ee1eef6d7 /rest_framework/settings.py
parent7e5b1501b5cede61a9391fb1a751d2ebcdb37031 (diff)
parent4e7805cb24d73e7f706318b5e5a27e3f9ba39d14 (diff)
downloaddjango-rest-framework-9b30dab4f772f67a626e176dc4fae0a3ef9c2c81.tar.bz2
Merge branch 'restframework2' into rest-framework-2-merge2.0.0
Conflicts: .gitignore .travis.yml AUTHORS README.rst djangorestframework/mixins.py djangorestframework/renderers.py djangorestframework/resources.py djangorestframework/serializer.py djangorestframework/templates/djangorestframework/base.html djangorestframework/templates/djangorestframework/login.html djangorestframework/templatetags/add_query_param.py djangorestframework/tests/accept.py djangorestframework/tests/authentication.py djangorestframework/tests/content.py djangorestframework/tests/reverse.py djangorestframework/tests/serializer.py djangorestframework/views.py docs/examples.rst docs/examples/blogpost.rst docs/examples/modelviews.rst docs/examples/objectstore.rst docs/examples/permissions.rst docs/examples/pygments.rst docs/examples/views.rst docs/howto/alternativeframeworks.rst docs/howto/mixin.rst docs/howto/reverse.rst docs/howto/usingurllib2.rst docs/index.rst docs/topics/release-notes.md examples/sandbox/views.py rest_framework/__init__.py rest_framework/compat.py rest_framework/utils/breadcrumbs.py setup.py
Diffstat (limited to 'rest_framework/settings.py')
-rw-r--r--rest_framework/settings.py149
1 files changed, 149 insertions, 0 deletions
diff --git a/rest_framework/settings.py b/rest_framework/settings.py
new file mode 100644
index 00000000..9c40a214
--- /dev/null
+++ b/rest_framework/settings.py
@@ -0,0 +1,149 @@
+"""
+Settings for REST framework are all namespaced in the REST_FRAMEWORK setting.
+For example your project's `settings.py` file might look like this:
+
+REST_FRAMEWORK = {
+ 'DEFAULT_RENDERER_CLASSES': (
+ 'rest_framework.renderers.JSONRenderer',
+ 'rest_framework.renderers.YAMLRenderer',
+ )
+ 'DEFAULT_PARSER_CLASSES': (
+ 'rest_framework.parsers.JSONParser',
+ 'rest_framework.parsers.YAMLParser',
+ )
+}
+
+This module provides the `api_setting` object, that is used to access
+REST framework settings, checking for user settings first, then falling
+back to the defaults.
+"""
+from django.conf import settings
+from django.utils import importlib
+
+
+USER_SETTINGS = getattr(settings, 'REST_FRAMEWORK', None)
+
+DEFAULTS = {
+ 'DEFAULT_RENDERER_CLASSES': (
+ 'rest_framework.renderers.JSONRenderer',
+ 'rest_framework.renderers.BrowsableAPIRenderer',
+ ),
+ 'DEFAULT_PARSER_CLASSES': (
+ 'rest_framework.parsers.JSONParser',
+ 'rest_framework.parsers.FormParser',
+ 'rest_framework.parsers.MultiPartParser'
+ ),
+ 'DEFAULT_AUTHENTICATION_CLASSES': (
+ 'rest_framework.authentication.SessionAuthentication',
+ 'rest_framework.authentication.BasicAuthentication'
+ ),
+ 'DEFAULT_PERMISSION_CLASSES': (
+ 'rest_framework.permissions.AllowAny',
+ ),
+ 'DEFAULT_THROTTLE_CLASSES': (
+ ),
+
+ 'DEFAULT_CONTENT_NEGOTIATION_CLASS':
+ 'rest_framework.negotiation.DefaultContentNegotiation',
+ 'DEFAULT_MODEL_SERIALIZER_CLASS':
+ 'rest_framework.serializers.ModelSerializer',
+ 'DEFAULT_PAGINATION_SERIALIZER_CLASS':
+ 'rest_framework.pagination.PaginationSerializer',
+
+ 'DEFAULT_THROTTLE_RATES': {
+ 'user': None,
+ 'anon': None,
+ },
+ 'PAGINATE_BY': None,
+
+ 'UNAUTHENTICATED_USER': 'django.contrib.auth.models.AnonymousUser',
+ 'UNAUTHENTICATED_TOKEN': None,
+
+ 'FORM_METHOD_OVERRIDE': '_method',
+ 'FORM_CONTENT_OVERRIDE': '_content',
+ 'FORM_CONTENTTYPE_OVERRIDE': '_content_type',
+ 'URL_ACCEPT_OVERRIDE': 'accept',
+ 'URL_FORMAT_OVERRIDE': 'format',
+
+ 'FORMAT_SUFFIX_KWARG': 'format'
+}
+
+
+# List of settings that may be in string import notation.
+IMPORT_STRINGS = (
+ 'DEFAULT_RENDERER_CLASSES',
+ 'DEFAULT_PARSER_CLASSES',
+ 'DEFAULT_AUTHENTICATION_CLASSES',
+ 'DEFAULT_PERMISSION_CLASSES',
+ 'DEFAULT_THROTTLE_CLASSES',
+ 'DEFAULT_CONTENT_NEGOTIATION_CLASS',
+ 'DEFAULT_MODEL_SERIALIZER_CLASS',
+ 'DEFAULT_PAGINATION_SERIALIZER_CLASS',
+ 'UNAUTHENTICATED_USER',
+ 'UNAUTHENTICATED_TOKEN',
+)
+
+
+def perform_import(val, setting_name):
+ """
+ If the given setting is a string import notation,
+ then perform the necessary import or imports.
+ """
+ if isinstance(val, basestring):
+ return import_from_string(val, setting_name)
+ elif isinstance(val, (list, tuple)):
+ return [import_from_string(item, setting_name) for item in val]
+ return val
+
+
+def import_from_string(val, setting_name):
+ """
+ Attempt to import a class from a string representation.
+ """
+ try:
+ # Nod to tastypie's use of importlib.
+ parts = val.split('.')
+ module_path, class_name = '.'.join(parts[:-1]), parts[-1]
+ module = importlib.import_module(module_path)
+ return getattr(module, class_name)
+ except:
+ msg = "Could not import '%s' for API setting '%s'" % (val, setting_name)
+ raise ImportError(msg)
+
+
+class APISettings(object):
+ """
+ A settings object, that allows API settings to be accessed as properties.
+ For example:
+
+ from rest_framework.settings import api_settings
+ print api_settings.DEFAULT_RENDERER_CLASSES
+
+ Any setting with string import paths will be automatically resolved
+ and return the class, rather than the string literal.
+ """
+ def __init__(self, user_settings=None, defaults=None, import_strings=None):
+ self.user_settings = user_settings or {}
+ self.defaults = defaults or {}
+ self.import_strings = import_strings or ()
+
+ def __getattr__(self, attr):
+ if attr not in self.defaults.keys():
+ raise AttributeError("Invalid API setting: '%s'" % attr)
+
+ try:
+ # Check if present in user settings
+ val = self.user_settings[attr]
+ except KeyError:
+ # Fall back to defaults
+ val = self.defaults[attr]
+
+ # Coerce import strings into classes
+ if val and attr in self.import_strings:
+ val = perform_import(val, attr)
+
+ # Cache the result
+ setattr(self, attr, val)
+ return val
+
+api_settings = APISettings(USER_SETTINGS, DEFAULTS, IMPORT_STRINGS)