From 1f773b932937be739af2dd14c29195ba396c9df0 Mon Sep 17 00:00:00 2001 From: Ryan P Kilby Date: Wed, 15 Jan 2020 01:15:50 -0800 Subject: [PATCH] Add note that APISettings is an internal class --- rest_framework/settings.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/rest_framework/settings.py b/rest_framework/settings.py index c4c0e7939..9eb4c5653 100644 --- a/rest_framework/settings.py +++ b/rest_framework/settings.py @@ -182,14 +182,19 @@ def import_from_string(val, setting_name): class APISettings: """ - A settings object, that allows API settings to be accessed as properties. - For example: + A settings object that allows REST Framework 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. + + Note: + This is an internal class that is only compatible with settings namespaced + under the REST_FRAMEWORK name. It is not intended to be used by 3rd-party + apps, and test helpers like `override_settings` may not work as expected. """ def __init__(self, user_settings=None, defaults=None, import_strings=None): if user_settings: