aboutsummaryrefslogtreecommitdiffstats
path: root/djangorestframework/settings.py
blob: f25133d5239568415074b6f48fe03cb0821f217a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
"""
Settings for REST framework are all namespaced in the API_SETTINGS setting.
For example your project's `settings.py` file might look like this:

API_SETTINGS = {
    'DEFAULT_RENDERERS': (
        'djangorestframework.renderers.JSONRenderer',
        'djangorestframework.renderers.YAMLRenderer',
    )
    'DEFAULT_PARSERS': (
        'djangorestframework.parsers.JSONParser',
        'djangorestframework.parsers.YAMLParser',
    )
}

"""
from django.conf import settings
from django.utils import importlib
from djangorestframework.compat import yaml


DEFAULTS = {
    'DEFAULT_RENDERERS': (
        'djangorestframework.renderers.JSONRenderer',
        'djangorestframework.renderers.JSONPRenderer',
        'djangorestframework.renderers.DocumentingPlainTextRenderer',
    ),
    'DEFAULT_PARSERS': (
        'djangorestframework.parsers.JSONParser',
        'djangorestframework.parsers.FormParser'
    ),
    'UNAUTHENTICATED_USER': 'django.contrib.auth.models.AnonymousUser',
    'UNAUTHENTICATED_TOKEN': None
}

if yaml:
    DEFAULTS['DEFAULT_RENDERERS'] += ('djangorestframework.renderers.YAMLRenderer', )


# List of settings that may be in string import notation.
IMPORT_STRINGS = (
    'DEFAULT_RENDERERS',
    'UNAUTHENTICATED_USER',
    'UNAUTHENTICATED_TOKEN'
)


def perform_import(val, setting):
    """
    If the given setting is a string import notation,
    then perform the necessary import or imports.
    """
    if val is None or setting not in IMPORT_STRINGS:
        return val

    try:
        if isinstance(val, basestring):
            return import_from_string(val)
        elif isinstance(val, (list, tuple)):
            return [import_from_string(item) for item in val]
        return val
    except:
        msg = "Could not import '%s' for API setting '%s'" % (val, setting)
        raise ImportError(msg)


def import_from_string(val):
    """
    Attempt to import a class from a string representation.
    """
    # 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)


class APISettings(object):
    """
    A settings object, that allows API settings to be accessed as properties.
    For example:

        from djangorestframework.settings import api_settings
        print api_settings.DEFAULT_RENDERERS

    Any setting with string import paths will be resolved.
    """
    def __getattr__(self, attr):
        if attr not in DEFAULTS.keys():
            raise AttributeError("Invalid API setting: '%s'" % attr)

        try:
            # Check if present in user settings
            val = perform_import(settings.API_SETTINGS[attr], attr)
        except (AttributeError, KeyError):
            # Fall back to defaults
            val = perform_import(DEFAULTS[attr], attr)

        # Cache the result
        setattr(self, attr, val)
        return val

api_settings = APISettings()