源碼解析Flask的配置文件
在flask里，我們常在主文件中定義某些配置，比如：
app.debug = True
app.secret_key = 'helloworld!!'
實際上，flask中默認可以進行可選的配置項有很多。
如果在開發的過程中，把所有需要的配置項都定義在主文件中，就會造成整個程序的目錄結構不合理，
如果需要重寫的flask配置項很多的時候，就可以把配置項用別的方式進行定義，然后導入使用
flask的配置文件是一個 flask.config.Config 對象
導入Config對象，可以發現Config對象繼承字典，
Config默認的配置有：
default_config = ImmutableDict({
'DEBUG': get_debug_flag(default=False),
'TESTING': False,
'PROPAGATE_EXCEPTIONS': None,
'PRESERVE_CONTEXT_ON_EXCEPTION': None,
'SECRET_KEY': None,
'PERMANENT_SESSION_LIFETIME': timedelta(days=31),
'USE_X_SENDFILE': False,
'LOGGER_NAME': None,
'LOGGER_HANDLER_POLICY': 'always',
'SERVER_NAME': None,
'APPLICATION_ROOT': None,
'SESSION_COOKIE_NAME': 'session',
'SESSION_COOKIE_DOMAIN': None,
'SESSION_COOKIE_PATH': None,
'SESSION_COOKIE_HTTPONLY': True,
'SESSION_COOKIE_SECURE': False,
'SESSION_REFRESH_EACH_REQUEST': True,
'MAX_CONTENT_LENGTH': None,
'SEND_FILE_MAX_AGE_DEFAULT': timedelta(hours=12),
'TRAP_BAD_REQUEST_ERRORS': False,
'TRAP_HTTP_EXCEPTIONS': False,
'EXPLAIN_TEMPLATE_LOADING': False,
'PREFERRED_URL_SCHEME': 'http',
'JSON_AS_ASCII': True,
'JSON_SORT_KEYS': True,
'JSONIFY_PRETTYPRINT_REGULAR': True,
'JSONIFY_MIMETYPE': 'application/json',
'TEMPLATES_AUTO_RELOAD': None,
})
通過查看Config對象的源碼，可以知道flask的配置可以有以下幾種方式
1.在主文件中定義(通常使用的方式)
app.debug = True
app.secret_key = 'helloworld!!'
由于Config對象繼承了dict的方法和屬性，所以還可以使用app.config.update(配置項)的方式導入配置項
2.從環境變量中導入配置項
導入配置項的方式：
app.config.from_envvar("環境變量名稱")
from_envvar方法的源碼：
def from_envvar(self, variable_name, silent=False):
rv = os.environ.get(variable_name)
if not rv:
if silent:
return False
raise RuntimeError('The environment variable %r is not set '
'and as such configuration could not be '
'loaded. Set this variable and make it '
'point to a configuration file' %
variable_name)
return self.from_pyfile(rv, silent=silent)
可以看到,從環境變量中導入配置項的方法，就是從環境變量中找到并讀取對應的py文件名稱，然后內部調用 from_pyfile 方法處理讀取到的內容得到配置
3.從python文件中導入
從python文件中獲取配置項的方式：
app.config.from_pyfile("python文件名稱")
例如，創建一個名為setting.py的文件
setting.py文件的內容為：
DEBUG=True
然后使用 app.config.from_pyfile("setting.py") 的方式導入配置項
from_pyfile方法的源碼：
def from_pyfile(self, filename, silent=False):
filename = os.path.join(self.root_path, filename)
d = types.ModuleType('config')
d.__file__ = filename
try:
with open(filename, mode='rb') as config_file:
exec(compile(config_file.read(), filename, 'exec'), d.__dict__)
except IOError as e:
if silent and e.errno in (errno.ENOENT, errno.EISDIR):
return False
e.strerror = 'Unable to load configuration file (%s)' % e.strerror
raise
self.from_object(d)
return True
從py文件中導入配置項的過程中，讀取參數中的python文件的內容，進行編譯后exec方法執行，就得到所需要的配置項
需要注意的是：
python文件可以是絕對路徑或者相對路徑，如果是相對路徑，則py文件必須放在root_path目錄下，
4.從對象中導入配置項
from_object方法的源碼：
def from_object(self, obj):
if isinstance(obj, string_types):
obj = import_string(obj)
for key in dir(obj):
if key.isupper():
self[key] = getattr(obj, key)
從對象中導入配置項的過程中，首先判斷所傳入的對象名是否是字符串，然后調用 import_string 方法處理字符串形式的對象名
import_string方法的源碼：
def import_string(import_name, silent=False):
import_name = str(import_name).replace(':', '.')
try:
try:
__import__(import_name)
except ImportError:
if '.' not in import_name:
raise
else:
return sys.modules[import_name]
module_name, obj_name = import_name.rsplit('.', 1)
try:
module = __import__(module_name, None, None, [obj_name])
except ImportError:
module = import_string(module_name)
try:
return getattr(module, obj_name)
except AttributeError as e:
raise ImportError(e)
except ImportError as e:
if not silent:
reraise(
ImportStringError,
ImportStringError(import_name, e),
sys.exc_info()[2])
可以看到，import_string方法，實際上是對字符串形式的對象名執行rsplit方法，得到模塊名和對象名
在模塊可以被正常導入之前，不停執行import_string方法,最后執行getattr方法從模塊中獲取對象名
5.from_json：從json字符串中獲取配置項
from_json方法的源碼：
def from_json(self, filename, silent=False):
filename = os.path.join(self.root_path, filename)
try:
with open(filename) as json_file:
obj = json.loads(json_file.read())
except IOError as e:
if silent and e.errno in (errno.ENOENT, errno.EISDIR):
return False
e.strerror = 'Unable to load configuration file (%s)' % e.strerror
raise
return self.from_mapping(obj)
從json文件中獲取配置項，實際上就是對json文件執行json.loads方法，得到對象
然后內部調用 from_mapping 方法處理所得到的對象
6.from_mapping：從dict字典中獲取配置項
from_mapping方法的源碼：
def from_mapping(self, *mapping, **kwargs):
mappings = []
if len(mapping) == 1:
if hasattr(mapping[0], 'items'):
mappings.append(mapping[0].items())
else:
mappings.append(mapping[0])
elif len(mapping) > 1:
raise TypeError(
'expected at most 1 positional argument, got %d' % len(mapping)
)
mappings.append(kwargs.items())
for mapping in mappings:
for (key, value) in mapping:
if key.isupper():
self[key] = value
return True
把參數字典中的所有鍵值對添加到列表串，循環遍歷列表，讀取列表中每個元素的鍵和值
如果鍵為大寫，則key為配置選項，value為配置選項的值
7.get_namespace：從名稱空間中獲取配置選項
get_namespace源碼：
def get_namespace(self, namespace, lowercase=True, trim_namespace=True):
rv = {}
for k, v in iteritems(self):
if not k.startswith(namespace):
continue
if trim_namespace:
key = k[len(namespace):]
else:
key = k
if lowercase:
key = key.lower()
rv[key] = v
return rv
get_namespace方法，是從指定的名稱空間或前綴中進行匹配，返回包含配置項的子集的字典
迭代當前對象，獲取key和v,把key轉換為小寫格式，然后把key和v包含在一個字典中
來自：http://www.cnblogs.com/renpingsheng/p/8735107.html