首頁  >  文章  >  後端開發  >  正確讀取和寫入Python專案中的配置的方法是什麼?

正確讀取和寫入Python專案中的配置的方法是什麼?

PHPz
PHPz轉載
2023-05-09 19:16:061590瀏覽

正確讀取和寫入Python專案中的配置的方法是什麼?

1、將組態寫在Python檔中

#這種方法非常簡單,但它有嚴重的安全性問題,我們都知道不應該把配置寫在程式碼中,如果有人把我們的原始碼上傳到了github中,那麼資料庫的配置就相當於向全世界公開了,當然,當設定檔不包含敏感資訊時,也可以才有這種簡單的方法。

2、利用外部設定檔

讓設定檔和程式碼獨立開來,通常使用 json、yaml或ini的檔案格式來儲存設定。

結合環境變數和python 庫讀取外部文件,首先開發通常不會接觸到生成環境,因此生成環境的配置文件由運維來寫,維運將應用所所需的配置寫好後,放到生產伺服器的指定位置,程式碼從指定位置讀取配置。

為了方便程式的統一偵錯,可以事先約定好一個系統環境變數(XXX_CONFIG_PATH)來指定設定檔的存放路徑。

例如:export XXX_CONFIG_PATH =
/home/test/configs/config.ini
 此為設定臨時環境變數

linux、ubuntu 環境變數

查看环境变量:
 env
 设置永久环境变量
 1.在/etc/profile 的文件下编辑,所改变的环境变量是面向所有用户的
 export CLASSPATH = /../...该路径为绝对路径
 2.在当前用户目录下./barsh_profile文件中修改 进行修改的话,仅对当前的用户生效
 vim /home/wens/.barshc
 export CLASSPATH = /../...该路径为绝对路径
 最后使用source命令 可以直接使环境变量生效
 source/home/wens/.barshc //直接跟环境变量的文件

windows 環境變數

查看环境变量:
 set
 查看某个环境变量:
 set path
 修改环境变量
 输入 “set 变量名=变量内容”即可。比如将path设置为“d:nmake.exe”,只要输入set path="d:nmake.exe"
 注意:所有的在cmd命令行下对环境变量的修改只对当前窗口有效,不是永久性的修改。也就是说当关闭此cmd命令行窗口后,将不再起作用。
 永久性修改环境变量的方法有两种:
 一种是直接修改注册表
 另一种是通过我的电脑-〉属性-〉高级,来设置系统的环境变量(查看详细) 
 设置了环境变量后,需要重启 pycharm 生效

3、直接使用系統環境變數讀取組態

此方法不使用檔案來儲存設定訊息,將所有的設定資訊儲存到環境變數中,在實務上比較常見,運維透過ansible 部署腳本,在程式運作前將需要設定的資訊匯入到環境變數中。

不利用文件存儲,在一定程度上加強了對密碼等配置資訊的保護,但也增加了維運的工作量,尤其是當需要修改配置時。

4、微服務架構

在一些微服務架構中,會專門開發配置中心,程式直接從線上讀取配置,配置的管理也會開發一套GUI,方便開發與維運。

5、一般專案中建議的設定方式

-app
-__init.py
-app.py
-settings
 -__init__.py
 -base.py
 -dev.py
 -prod.py

其中 __init__.py 中,新增判斷邏輯,判斷目前環境使用開發環境還是生產環境,從而載入不同的配置參數。

# settings/__init__.py
 import os
 # os.environ.get() 用于获取系统中的环境变量,因为在生产环境中,一般都会把一些关键性的参数写到系统的环境中。
 # 所以PROFILE的值其实就是我们配置的环境变量的值。如果没有配这个值,默认走dev的配置。
 # PYTHON_PRO_PROFILE = os.environ.get("PYTHON_PRO_PROFILE", "dev")
 PYTHON_PRO_PROFILE = os.environ.get("PYTHON_PRO_PROFILE")
 print("是开发环境还是生产环境: ", PYTHON_PRO_PROFILE) 
 if PYTHON_PRO_PROFILE == "dev":
 from .dev import *
 elif PYTHON_PRO_PROFILE == "prod":
 from .prod import *
 else:
 raise Exception("Not supported runtime profile {}".format(PYTHON_PRO_PROFILE))

其中 base.py 儲存一些公用的配置,然後在開發環境 dev.py 與生產環境 prod. py 中導入 base.py 的變數。

# settings/base.py
 import os
 import time
 # os.path.abspath: 获取完整路径(包含文件名)
 current_exec_abspath = os.path.abspath(__file__)
 current_exec_dir_name, _ = os.path.split(current_exec_abspath)
 current_up_dir, _ = os.path.split(current_exec_dir_name)
 current_up2_dir, _ = os.path.split(current_up_dir)
 print('------log dir=------', current_up2_dir)
 # 日志文件路径设置
 log_path = f"{current_up2_dir}/logs"
 if not os.path.exists(log_path):
 os.makedirs(log_path)
 t = time.strftime("%Y_%m_%d")
 log_path_file = f"{log_path}/interface_log_{t}.log"

其中 dev.py:

#
# 导入了base下所有参数
 from .base import *
 database = {
 "protocol": "mysql+mysqlconnector",
 "username": "xxxxxx",
 "password": "hash string",
 "port": 3306,
 "database": "repo"
 }

其中 prod.py:

# 导入了base下所有参数
 from .base import *
 database = {
 "protocol": "xxxxxxxxxxx",
 "username": "xxxxxxxxxxx",
 "password": "xxxxxxxxxxx",
 "port": 3344,
 "database": "xxxx"
 }
 对于一些敏感信息可在环境变量里设置,通过如下方法获取,例如:
 MAIL_SERVER = os.environ.get('MAIL_SERVER', 'smtp.163.com') 
 MAIL_USERNAME = os.environ.get('MAIL_USERNAME') or 'test'
 MAIL_PASSWORD = os.environ.get('MAIL_PASSWORD') or '12345678'

以上是正確讀取和寫入Python專案中的配置的方法是什麼?的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文轉載於:51cto.com。如有侵權,請聯絡admin@php.cn刪除