Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

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

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

""" 

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 __future__ import unicode_literals 

 

from django.conf import settings 

from django.utils import importlib 

 

from rest_framework import ISO_8601 

from rest_framework.compat import six 

 

 

USER_SETTINGS = getattr(settings, 'REST_FRAMEWORK', None) 

 

DEFAULTS = { 

    # Base API policies 

    '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', 

 

    # Genric view behavior 

    'DEFAULT_MODEL_SERIALIZER_CLASS': 

        'rest_framework.serializers.ModelSerializer', 

    'DEFAULT_PAGINATION_SERIALIZER_CLASS': 

        'rest_framework.pagination.PaginationSerializer', 

    'DEFAULT_FILTER_BACKENDS': (), 

 

    # Throttling 

    'DEFAULT_THROTTLE_RATES': { 

        'user': None, 

        'anon': None, 

    }, 

 

    # Pagination 

    'PAGINATE_BY': None, 

    'PAGINATE_BY_PARAM': None, 

 

    # Authentication 

    'UNAUTHENTICATED_USER': 'django.contrib.auth.models.AnonymousUser', 

    'UNAUTHENTICATED_TOKEN': None, 

 

    # Browser enhancements 

    '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', 

 

    # Input and output formats 

    'DATE_INPUT_FORMATS': ( 

        ISO_8601, 

    ), 

    'DATE_FORMAT': None, 

 

    'DATETIME_INPUT_FORMATS': ( 

        ISO_8601, 

    ), 

    'DATETIME_FORMAT': None, 

 

    'TIME_INPUT_FORMATS': ( 

        ISO_8601, 

    ), 

    'TIME_FORMAT': None, 

 

    # Pending deprecation 

    'FILTER_BACKEND': None, 

} 

 

 

# 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', 

    'DEFAULT_FILTER_BACKENDS', 

    'FILTER_BACKEND', 

    '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, six.string_types): 

        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 ImportError as e: 

        msg = "Could not import '%s' for API setting '%s'. %s: %s." % (val, setting_name, e.__class__.__name__, e) 

        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) 

 

        self.validate_setting(attr, val) 

 

        # Cache the result 

        setattr(self, attr, val) 

        return val 

 

    def validate_setting(self, attr, val): 

        if attr == 'FILTER_BACKEND' and val is not None: 

            # Make sure we can initialize the class 

            val() 

 

api_settings = APISettings(USER_SETTINGS, DEFAULTS, IMPORT_STRINGS)