Python3.用json作为配置文件

本文介绍如何利用JSON文件作为配置文件,优化Python自动化脚本的参数管理。通过将配置参数与程序分离,实现更高效、灵活的参数调整,并提供读取和更新配置的函数示例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

最近有些自动化脚本要反复使用,但是每次使用都有一些参数要改:路径啊、时间间隔等等。每次打开源文件改这些参数时免不了看到大片的代码,令人头秃,而且将参数和程序写死在一起也不是好习惯。

最终我决定用json文件作为配置文件来保存这些可能要人工修改的参数,主要技巧在于将字典内容转为变量。


首先从我的另一次尝试开始讲:

py文件作为配置文件

另外建一个config.py源文件保存到主程序main.py所在路径下,将需要的配置参数用正常赋值语句保存下来像这样:

# config.py
target_dir = r"E:\data"
interval_mins = 5
time_record = "201904011230"
# ......

在主程序开头加上

# main.py
from config import *

就实现了配置和程序的分离,非常方便。

但是有两个问题:

  1. 若是程序要修改配置文件中从某些参数就比较麻烦。比如主程序要在每次启动时读取到配置文件中的time_record变量,并在结束时将其保存为新的值以便下次使用。
  2. 若是将main.py打包成.exe可执行文件,config.py也会被一起打包进去,就无法再修改配置了。

关于问题1,可以通过将配置文件当做文本文件通过"r+"方式读取,修改最后一行time_record后的文本值,再全部写入进配置文件。这样算一下其实配置文件会被读取两次(一次被import,一次被当做文本),假如有多个配置变量要修改、在一次执行中要多次修改,那代码就比较难写了,而且执行效率也不高。

接下来就是我最终的解决方案:

json文件作为配置文件

和上文相同的例子,config.py改写成config.json是这样:

{
    "target_dir" : "E:/data",
    "interval_mins" : 5,
    "time_record" : "201904011230"
}

main.py中增加两个函数分别用于读取和更新配置:

# main.py
def read_config():
    """"读取配置"""
    with open("config.json") as json_file:
        config = json.load(json_file)
    return config


def update_config(config):
    """"更新配置"""
    with open("config.json", 'w') as json_file:
        json.dump(config, json_file, indent=4)
    return None

当通过config = read_config()获得的配置config是一个字典,不能直接使用如target_dir等键值当做变量使用,可以间接用如config["target_dir"]来当变量,但并不方便。通常做法是每个变量执行一次类似target_dir = config["target_dir"]的操作,如果配置变量较多就比较累了。

那么,重点来了:

globals().update(config)  # 知识点啊

globals()获得(模块级)全局变量所组成的字典,修改该字典等同修改全局变量,所以通过.update(config)可以将config字典内容转为变量。举个例子:

# example
a_dict = {"key": "value"}
globals().update(a_dict)
print(key)

虽然没有显式定义变量key,但依然可以正确输出:value

重点结束。

接着说更新配置文件的事:

修改字典config后,只要update_config(config),就实现了配置文件config.json的更新,可以说是非常简单了。


都用过好久Python了,学的时候也见过globals(),但查到它的.update()方法将字典内容转为变量这一用法时还是觉得:哇!还能这么搞,有点儿意思!

### 如何在 VS Code 中为 Python 正确配置 `settings.json` 文件 为了确保在 Visual Studio Code (VS Code) 中高效开发 Python 项目,正确配置 `settings.json` 是至关重要的。以下是详细的配置方法和一些常见的设置选项。 #### 配置方式 可以通过以下两种方式访问并编辑 `settings.json` 文件: 1. **通过图形界面修改**:打开菜单栏中的 `File > Preferences > Settings` 或者按下快捷键 `Ctrl+,` 进入设置页面。点击右上角的 `{}` 图标切换至 JSON 编辑模式。 2. **直接编辑文件**:进入 `.vscode/settings.json` 文件(如果不存在,则可以手动创建),位于当前项目的根目录下。 #### 常见配置项及其功能 ##### 1. 指定 Python 解释器路径 指定 Python 解释器对于运行脚本至关重要。可以在 `settings.json` 中定义如下字段来选择解释器路径[^1]: ```json { "python.pythonPath": "/path/to/python" } ``` > 如果有多个版本的 Python 安装在同一台计算机上,建议明确指明所需的解释器位置。 ##### 2. 启用 Linting 工具支持 Linting 能够帮助开发者发现代码中的潜在错误或不符合编码标准的部分。启用 linting 功能需添加类似下面的内容到 `settings.json`[^3]: ```json { "python.linting.enabled": true, "python.linting.pylintEnabled": true, "python.linting.flake8Enabled": false, "python.linting.pydocstyleEnabled": false } ``` 上述例子启用了 Pylint 并禁用了其他两个工具 Flake8 和 PyDocStyle。可以根据个人需求调整这些参数。 ##### 3. 自动化格式化工具集成 自动格式化可以使团队成员之间的代码风格保持一致。推荐使用的格式化工具有 Black、YAPF 等。例如,使用 Black 格式化的配置应像这样写入 `settings.json`: ```json { "[python]": { "editor.formatOnSave": true }, "python.formatting.provider": "black", "python.formatting.blackArgs": ["--line-length", "88"] } ``` 此片段设置了保存时自动格式化,并选择了 Black 作为格式提供方,同时还传递了一个额外参数控制每行最大长度为 88 字符。 ##### 4. 单元测试框架的支持 如果你计划利用 unittest、pytest 或 nose 来执行单元测试的话,那么也需要相应地更新配置信息。比如针对 pytest 可做如下设定: ```json { "python.testing.pyTestEnabled": true, "python.testing.unittestEnabled": false, "python.testing.nosetestsEnabled": false } ``` 这里仅激活了 pytest 支持而关闭了另外两者。 #### 示例完整的 `settings.json` 综合以上各部分内容,最终可能得到这样一个较为全面的 `settings.json` 文件实例: ```json { "python.pythonPath": "/usr/bin/python3", "python.linting.enabled": true, "python.linting.pylintEnabled": true, "python.formatting.provider": "black", "python.testing.pyTestEnabled": true, "[python]": { "editor.tabSize": 4, "editor.insertSpaces": true, "editor.formatOnSave": true } } ```
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值