一種Python全局配置規範以及其魔改

01-25

0x01 模塊 or global

很多初學者有個誤區，就是在Python中需要配置一個全局的參數時，首先想到的是global關鍵字，而實際上global不是干這個事的，global的功能是在將局部作用域的變數聲明為全局的，這樣可以在局部修改全局的變數。

但這種用法其實非常不好，按照函數式的規範而言，純函數的輸入應該只由輸入參數確定，不應該在執行過程中引用外部變數。並且，global也不是用來進行全局配置用的。

在Python中，模塊是天然的單例，模塊會在項目初始化後執行一次，之後一般不重複執行，符合單例模式的特點。因此，利用模塊的這一特性，將整個工程文件中需要配置的選項都配置到一個模塊中，在需要用的模塊中通過import導入，才是Python中全局配置正確打開方式。

雖然這種規範已經在江苟（Django）等開源框架中展示了無數遍，但「如何在Python中設置全局變數」這個問題仍然是Python社區的月經貼。

通過模塊配置全局變數的試例如下，在configs.py中定義CONFIG_A和CONFIG_B。在user.py中用import導入。

這個其實是Python中的基本操作了，本來是沒啥好講的，不過在這篇文章最後我展示了一種根據json配置的動態模塊，供大家參考。

0x02 單例字典

在講模塊之前，我想談談我嘗試過另一種方式，就是自定義單例字典，具體做法是這樣的。

先繼承collections模塊中MutableMapping，並重寫相關介面。這是在Python中自定義數據類型的基本操作了，自定義完成後然後寫一個裝飾器將繼承的類轉化成單例的類。

單例模式的寫法可以看Stackoverflow上關於單例模式的高票回答。

我習慣採用第一種函數裝飾器的寫法：

def singleton(class_): instances = {} def getinstance(*args, **kwargs): if class_ not in instances: instances[class_] = class_(*args, **kwargs) return instances[class_] return getinstance@singletonclass MyClass(BaseClass): pass

這種寫法非常好理解，用一個類變數instances保存該類生成的實例，每次類被調用的時候判斷一下這個類是否在instances字典里，如果不在著生成一個實例並放入instances字典。

但這個寫法有個問題，裝飾後的返回的不是一個類，而是一個函數，雖然Python語法講究一切皆對象，但函數是享受不到類的諸如繼承之類的特性的。

如果需要返回一個單例類的話需要用元類的寫法，或者第四種類裝飾器的寫法。當然，具體到這裡而言，這個類是繼承了一個MutableMapping的，不能再繼承別的元類了，元類的寫法在這裡不適用。

0x03 單例字典的問題

用單例字典做全局配置看著比模塊炫酷，其實並沒那麼好用。原因是單例模式自身的一個弊病，違背了單一職責原則，這個在相關設計模式的教程里有講到。而且，字典在這一塊還有個弊病就是根本不知道需要用到的key是不是存在字典中。

單例字典是我在項目初期引入，並在項目的迭代過程中給我造成最大困擾的一個東西，在開始時幾乎將所有的配置都寫入到這個字典中，然後在程序運行中這個字典又被分散在程序各處的各個實例修改，運行到後面根本不知道字典里有什麼，字典里的某個內容是否被修改過。不過由於GIL，倒是不需要考慮鎖的問題，可能是唯一的一個幸事。

在後期將這個龐大的字典進行重構，重構的過程按照下面的方式進行：

1、將各個類中該字典的引用點，由各個方法收攏到__init__方法。

不應該

class A: def __init__(self,): pass def fun_a(self): a = Singleton()["a"] def fun_b(self): b = Singleton()["a"]

應該

class B: def __init__(self,): self.a = Singleton()["a"] self.b = Singleton()["b"] def fun_a(self): a = self.a def fun_b(self): b = self.b

2、將各個引用點的名稱統一。

不應該

class A: def __init__(self,): self.sets = Singleton() def fun_a(self): SET = Singleton() def fun_b(self): self.SET = Singleton() b = self.SET["b"]

應該

class B: def __init__(self,): self.sets = Singleton() def fun_a(self): SET = self.sets def fun_b(self): b = self.set["b"]

3、將子函數中直接引用單例字典的參數放到函數的參數列表中，由調用方獲取單例字典內容，由傳參的方法傳入被調用函數，這樣做是為了滿足函數式編程中純函數的原則。

不應該這麼用：

def b(): return Singleton()["c"]+"a"def a(): returrn b()

應該這樣用

def b(c): return c +"a"def a() c = Singleton()["c"] return b(c)

4、將單一的單例字典分成多個單例字典，並將部分單例字典轉換成模塊，這個就不舉例了。

0x04 動態模塊

模塊的用法很簡單，在一個文件里配置好，直接import就行。需要注意的是引用的入口最好在同一個地方。

不過模塊有個地方不好就是動態修改不方便，具體到項目中去就是，該項目通過工廠模式生成了一系列產品，每個產品所需的配置參數都不一樣。

這裡有個辦法就是每個產品都通過同一個模塊來配置，然後在初始化時根據以產品名稱命名的一個json文件修改模塊的參數。這樣就可以達到引用模塊的方式不變，但模塊的內容是根據json文件的內容來配置的。

詳細的代碼見github，主要用來動態修改模塊的語句如下：

[setattr(module, k.decode("utf-8"), v) for k, v in d.items()]

其實就是通過setattr這個常用的給對象動態的添加功能的函數，d.tiems()是一個從json文件中讀取的字典對象。

0x04 動態模塊的優勢

現在，一個配置模塊的方案就成了導入configs模塊，調用update_config_by_name函數，即動態修改函數，並按照相應的json文件修改模塊的值。

相對於在每個類初始化時直接調用json配置變數這種方案是有好處的，定義了configs模塊有助於代碼的靜態檢查，形成了一種像C語言中.h文件和.c文件的關係，在頭文件中定義相關的變數，在.c文件中實現或使用。這裡就成了在configs模塊中定義變數，變數的值由json文件確定，然後在其他模塊中通過import實現，並且這個東西是全局共享的。當然，這個全局的意思指的是整個解釋器。

這段代碼還是有個坑，一般出現在單元測試中，來看兩段代碼：

from configs import CONFIG_A, CONFIG_Bprint("use config:", CONFIG_A，CONFIG_B)import configsprint("use config:", configs.CONFIG_A,configs.CONFIG_B)

在單元測試中由於deepcopy的問題，根據導入的層級不一樣，CONFIG_X的值也發生了不一樣的改變，這是個還在研究的bug。

本文地址：

一種Python全局配置規範以及其魔改

專欄地址：

python雜七雜八的使用經驗