Python 与 bash 脚本共享配置文件的最佳实践
Python 与 bash 脚本共享配置文件的最佳实践
目录
Python 与 bash 脚本共享配置文件的最佳实践
同一个工程的代码中可能会同时包含 python 代码和 bash 脚本， 不可避免的会用到配置文件。一些场景下，这两种语言需要共享相同的配置。 怎么实现呢？ 有两种方案：
- 使用不同格式的配置文件，如 Bash 使用 .env 作为配置，Python 则用 json 格式作为配置。
- 使用相同格式的配置文件，如都使用 .env 或 json 格式作为配置。
显然能用第二种方式肯定是最好的， 因为第一种方式需要两份不同格式配置文件，转换过程中可能导致不一致问题。
那么用什么格式的配置文件让 bash 和 python 不用第三方库都能很方便的读取呢？
经过我的实践，发现其实只要用 Env 文件即可， 假设配置文件名为 env.list 格式如下：
# 项目源码根目录
SOURCE_PROJECT_DIR=/data/home/xx/code-coverage
# 每个文件最低代码覆盖率
MIN_COVERAGE_RATE=0.6
# lcov max remove count
LCOV_MAX_REMOVE_COUNT=10bash
在bash中通过如下方式读取配置
#!/bin/bash
source conf/cov.env
...Python
python, 通过如下方式启动将配置以环境变量方式导出到python进程：
#!/bin/bash
env $(grep -v '^#' conf/cov.env | xargs) python3 src/main.pymain.py 中按照常规方式读取环境变量即可。
...
source_project_dir = os.environ.get("SOURCE_PROJECT_DIR", "/xxx")
...除此之外，python 也提供了类库:pydantic 对读取环境变量也提供了更好的支持：
from pydantic import BaseSettings, Field
class Settings(BaseSettings):
api_key: str = Field(..., description="API访问密钥")
timeout: float = 5.0
debug: bool = False
class Config:
env_file = ".env" # 1. 从.env文件加载
env_file_encoding = "utf-8"
# 加载顺序：
# 1. 显式传入的参数 (Settings(api_key="abc"))
# 2. 环境变量
# 3. .env文件中的变量
# 4. 字段默认值BaseSettings 功能很强大，也支持自定义环境变量前缀：
class DatabaseSettings(BaseSettings):
db_host: str = "localhost"
db_port: int = 5432
db_user: str
db_pass: str
class Config:
env_prefix = "DB_" # 自动添加前缀
# 会查找以下环境变量：
# DB_DB_HOST, DB_DB_PORT, DB_DB_USER, DB_DB_PASS也能完全自定义环境变量名称：
class AuthSettings(BaseSettings):
secret_key: str = Field(..., env="AUTH_SECRET_KEY") # 指定特定环境变量名
token_expire: int = 3600