Python项目中正确读取写入配置的方式

发表于:2022-9-08 10:09

字体: | 上一篇 | 下一篇 | 我要投稿

 作者:魔法小木瓜    来源:今日头条

  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'
   本文内容不用于商业目的,如涉及知识产权问题,请权利人联系51Testing小编(021-64471599-8017),我们将立即处理
《2023软件测试行业现状调查报告》独家发布~

关注51Testing

联系我们

快捷面板 站点地图 联系我们 广告服务 关于我们 站长统计 发展历程

法律顾问:上海兰迪律师事务所 项棋律师
版权所有 上海博为峰软件技术股份有限公司 Copyright©51testing.com 2003-2024
投诉及意见反馈:webmaster@51testing.com; 业务联系:service@51testing.com 021-64471599-8017

沪ICP备05003035号

沪公网安备 31010102002173号