Python 多环境配置管理

2020-02-24

一、概述

实际工程开发中常常会对开发、测试和生产等不同环境配置不同的数据库环境，传统方式可以通过添加不同环境的配置文件达到部署时的动态切换的效果。这种方式还不错，不过不同环境间往往会共享相同的配置而造成一些重复工作。

项目代码

  1. ./
  2. ├── conf.py
  3. └── test.py

别看只有2个文件，实际情况是有十几个文件，这里只是举例而已！

conf.py 这个是配置文件，其他py文件都依赖于它

  1. #!/usr/bin/env python3
  2. # coding: utf-8
  3. # 配置文件
  5. # k8s信息#########################################
  6. # 开发环境####################
  7. K8S_MASTER = "192.168.0.162"
  8. K8S_USERNAME = "root"
  9. K8S_PASSWD = "root"
  11. # # 生产环境####################
  12. # K8S_MASTER = "10.0.0.167"
  13. # K8S_USERNAME = "root"
  14. # K8S_PASSWD = "abcd@1234"

test.py 测试文件，下面的代码时伪代码，仅供演示！

  1. #!/usr/bin/env python3
  2. # coding: utf-8
  4. import conf
  6. def ssh2(ip,username,password,cmd):  # 远程执行命令
  7.     print(ip,username,password,cmd)
  8.     return True
  10. res = ssh2(conf.K8S_MASTER,conf.K8S_USERNAME,conf.K8S_PASSWD,"uptime")
  11. print(res)

需求

目前情况是，执行test.py，是这样的

  1. python3 test.py

如果需要切换环境，要修改conf.py，将对应的变量注释掉即可！

但是如果变量过多，注释就太麻烦了！需要有一个变量，能够一键切换环境

二、改造配置文件

一键切换

conf.py

  1. #!/usr/bin/env python3
  2. # coding: utf-8
  3. # 配置文件
  4. import os
  6. class Config(object):  # 默认配置
  7.     DEBUG = False
  8.     # get attribute
  9.     def __getitem__(self, key):
  10.         return self.__getattribute__(key)
  12. class ProductionConfig(Config):  # 生产环境
  13.     K8S_MASTER = "10.0.0.167"
  14.     K8S_USERNAME = "root"
  15.     K8S_PASSWD = "abcd@1234"
  17. class DevelopmentConfig(Config):  # 开发环境
  18.     K8S_MASTER = "192.168.0.162"
  19.     K8S_USERNAME = "root"
  20.     K8S_PASSWD = "root"
  22. # 环境映射关系
  23. mapping = {
  24.     'development': DevelopmentConfig,
  25.     'production': ProductionConfig,
  26.     'default': DevelopmentConfig
  27. }
  29. # 一键切换环境
  30. APP_ENV = os.environ.get('APP_ENV', 'default').lower()  # 设置环境变量为default
  31. config = mapping[APP_ENV]()  # 获取指定的环境

test.py 需要修改导入的模块

  1. #!/usr/bin/env python3
  2. # coding: utf-8
  4. # import conf
  5. from conf import config as conf
  8. def ssh2(ip,username,password,cmd):  # 远程执行命令
  9.     print(ip,username,password,cmd)
  10.     return True
  12. res = ssh2(conf.K8S_MASTER,conf.K8S_USERNAME,conf.K8S_PASSWD,"uptime")
  13. print(res)

执行test.py，输出：

  1. 192.168.0.162 root root uptime
  2. True

现在需要切换环境，直接修改 conf.py 的倒数第二行

  1. APP_ENV = os.environ.get('APP_ENV', 'production').lower()  # 设置环境变量为default
  2. config = mapping[APP_ENV]()  # 获取指定的环境

再次执行test.py，输出：

  1. 10.0.0.167 root abcd@1234 uptime
  2. True

脚本执行切换

改conf.py切换环境，不够灵活，需要执行脚本时，带一个参数，由这个参数来决定环境，比如：

  1. python test.py dev

这样，就可以切换到开发环境！怎么做呢？

很简单，只需要修改conf.py即可！因为其他文件，都依赖于它

conf.py

  1. #!/usr/bin/env python3
  2. # coding: utf-8
  3. # 配置文件
  4. import os
  6. class Config(object):  # 默认配置
  7.     DEBUG = False
  8.     # get attribute
  9.     def __getitem__(self, key):
  10.         return self.__getattribute__(key)
  12. class ProductionConfig(Config):  # 生产环境
  13.     K8S_MASTER = "10.0.0.167"
  14.     K8S_USERNAME = "root"
  15.     K8S_PASSWD = "abcd@1234"
  17. class DevelopmentConfig(Config):  # 开发环境
  18.     K8S_MASTER = "192.168.0.162"
  19.     K8S_USERNAME = "root"
  20.     K8S_PASSWD = "root"
  22. # 环境映射关系
  23. mapping = {
  24.     'dev': DevelopmentConfig,
  25.     'pro': ProductionConfig,
  26.     'default': DevelopmentConfig
  27. }
  29. # # 一键切换环境
  30. # APP_ENV = os.environ.get('APP_ENV', 'production').lower()  # 设置环境变量为default
  31. # config = mapping[APP_ENV]()  # 获取指定的环境
  33. # 根据脚本参数，来决定用那个环境配置
  34. import sys
  35. # print(sys.argv)
  36. num = len(sys.argv) - 1  #参数个数
  37. if num < 1 or num > 1:
  38.     exit("参数错误,必须传环境变量!比如: python xx.py dev|pro|default")
  40. env = sys.argv[1]  # 环境
  41. # print(env)
  42. APP_ENV = os.environ.get('APP_ENV', env).lower()
  43. config = mapping[APP_ENV]()  # 实例化对应的环境

再次执行test.py

  1. python test.py

输出：

  1. 参数错误,必须传环境变量!比如: python xx.py dev|pro|default

切换到开发环境

  1. python test.py dev

输出：

  1. 192.168.0.162 root root uptime
  2. True

切换到生产环境

输出：

  1. 10.0.0.167 root abcd@1234 uptime
  2. True

本文参考链接：

https://blog.yuanbin.me/posts/2018-02/2018-02-24_16-30-16/