[Python 渡劫飞升学习] 之《配置文件》：配置文件的学习及应用《搬砖乞讨期》

大头底层技术小趴菜

已于 2024-02-20 08:33:27 修改

阅读量1k

点赞数 12

文章标签： python 学习开发语言

于 2024-02-19 23:14:42 首次发布

本文链接：https://blog.csdn.net/weixin_43917995/article/details/136179681

版权

文章目录

前言
一、什么是配置文件？
- 1.详细版本
- 2.简单版本
二、Python使用配置文件的原因
三、配置文件种类
四、.ini文件格式
五、Python 脚本的ini示例
六、总结

前言

在搬砖讨饭的过程中接触到了《配置文件》，记录一下搬砖快乐时光。

一、什么是配置文件？

1.详细版本

配置文件是在计算机程序中用于存储应用程序或系统设置的文件。它通常包含了各种参数和选项，用于控制软件的运行方式，以及如何与用户的环境进行交互。配置文件使得用户可以根据自己的需要调整程序的设置，而不必更改程序的代码。

配置文件可以有不同的格式，如ini、json、yaml、xml等。这些文件可以由程序读取，以确定如何处理数据、连接数据库、设置网络选项、定义用户界面行为等。

例如，在操作系统层面，Windows使用注册表（registry）作为配置文件，存储系统和应用程序的设置。而在应用程序层面，许多软件都会使用特定的配置文件来保存用户的偏好设置或者程序运行所需的一些参数。

配置文件通常被设计为易于编辑，有时候用户可以直接通过文本编辑器打开并修改它们，有时候则需要通过专门的图形用户界面来进行设置。良好的配置文件设计对于提升用户体验、增强软件灵活性至关重要。

2.简单版本

配置文件是为程序配置参数和初始设置的文件。一般为文本文件，以ini,conf,cnf,cfg,yaml等作为后缀名。

二、Python使用配置文件的原因

Python使用配置文件主要有以下几个原因：

可配置性：配置文件允许程序根据不同的环境或用户需求进行配置，而不需要修改程序的代码。这使得程序灵活且易于适应不同的设置。
可维护性：通过分离配置信息与程序代码，可以提高代码的可读性和可维护性。配置文件通常更容易理解和修改，特别是对于非技术人员。
可重用性：同一套程序代码可以在不同的配置文件下运行于多个环境，如开发、测试和生产环境，而不需要为每个环境编写特定的代码。
安全性：对于敏感信息，如数据库密码或API密钥，可以使用配置文件来存储，并通过环境变量或加密等方式安全地提供给程序。
灵活性：配置文件可以使用不同的格式，如INI、JSON、YAML等，以适应不同的数据结构和需求。
外部化：配置文件可以将设置外部化，使得程序的运行不依赖于硬编码在代码中的值，这样可以减少代码审查和版本控制时的复杂性。
快速部署：在部署程序到不同的环境时，只需更改相应的配置文件，而不需要重新编译或修改源代码。
集中管理：对于大型项目，配置文件可以集中管理所有相关的设置，使得管理更加方便。
版本控制：配置文件可以独立于代码进行版本控制，这样就可以在不改变代码的情况下，追踪和管理不同版本的配置。

总之，配置文件是管理程序设置的强大工具，它们提高了程序的灵活性、可维护性和可部署性。在实际开发中，根据程序的具体需求和应用场景，可以选择合适的配置文件格式和存储方式。

三、配置文件种类

Python支持多种配置文件格式，每种格式都有其特点和用途。以下是一些常见的Python配置文件格式：

INI Configuration Files (.ini):
- 通常用于Windows系统。
- 使用分段（[Section]）和键值对（Key=Value）。
- 支持注释（以分号或井号开始）。
- 示例：config.ini。
JSON Configuration Files (.json):
- 基于JavaScript对象表示法。
- 使用键值对和数组。
- 支持复杂的数据结构。
- 示例：config.json。
YAML Configuration Files (.yaml or .yml):
- 易于阅读和编辑。
- 使用缩进来表示层级关系。
- 支持注释。
- 示例：config.yaml 或 config.yml。
XML Configuration Files (.xml):
- 使用XML标签和属性来表示配置信息。
- 适用于跨平台应用，但不如JSON和YAML流行。
- 示例：config.xml。
Environment Variables:
- 通过环境变量传递配置信息。
- 适用于快速设置和不同环境的配置。
- 示例：MY_CONFIG_VAR=value。
Command-line Arguments:
- 通过命令行参数传递配置信息。
- 适合简单或临时性的配置。
- 示例：python myscript.py --config-file="path/to/config.ini"。
SQLite Database (.db):
- 使用SQLite数据库存储配置。
- 适用于需要数据库功能的复杂配置。
- 示例：config.db。
Properties Files (.properties):
- 通常用于Java应用程序，但在Python中也有支持。
- 使用键值对，以字符串形式存储。
- 示例：config.properties。
  每种配置文件格式都有其优势和适用场景。在选择配置文件格式时，应考虑易于维护、阅读性、数据结构需求以及跨平台兼容性等因素。在Python中，configparser模块支持INI格式，而json和yaml模块分别用于JSON和YAML格式。

四、.ini文件格式

ini（初始化）文件是一种常用的配置文件格式，主要用在Windows操作系统中。它使用简单的**键值对（key-value）**对来存储配置信息。ini文件通常用于应用程序或系统设置，以存储用户偏好、选项或其他配置设置。
以下是标准的INI文件格式规范：

文件扩展名：通常为.ini。
注释符号：使用;或#来开始一个注释行。
节（Sections）：节用于组织配置选项，每一节由一个大写字母开头的键和随后的字符串组成，节之间用[SectionName]来分隔。
键（Keys）和值（Values）：每个配置选项由一个键和一个值组成，键是一个字符串，后面跟着一个等号（=）和值。值可以是字符串、数字或布尔值（通常用Yes/No、True/False表示）。
空白字符：空格、制表符和换行符用于分隔字段，但INI文件通常不使用这些字符来分隔键和值。
转义字符：在值中，可以使用\来转义特殊字符，如换行符（\n）或制表符（\t）。

ini文件示例：

[Settings]
; 这是一个注释
ServerName=MyServer
Port=1234
EnableSSL=False

[Database]
UserName=admin
Password=secret
Host=localhost

[Logging]
LogLevel=Info
LogFile=app.log

在编写和解析INI文件时，需要确保正确处理注释和转义字符，并且按照正确的格式来读取和写入节、键和值。

ini文件由于其简单性和易用性，在许多应用程序和系统中仍然被广泛使用。

然而，对于需要跨平台支持和更复杂配置的现代应用程序，其他配置格式如JSON、YAML等可能更受欢迎。

五、Python 脚本的ini示例

下面是一个 Python 脚本的示例，它使用 configparser 模块来读取 INI 配置文件，并从中获取配置值：

假设你有一个名为 config.ini 的配置文件，内容如下：

[database]
host=localhost
port=3306
user=root
password=mypassword

[logging]
level=INFO
file=app.log

[server]
hostname=localhost
port=8000

以下是一个 Python 脚本，用于读取上述 config.ini 文件并打印出配置值：

import configparser
# 创建一个配置解析器实例
config = configparser.ConfigParser()
# 读取INI文件
config.read('config.ini')
# 获取数据库配置
db_host = config.get('database', 'host')
db_port = config.getint('database', 'port')
db_user = config.get('database', 'user')
db_password = config.get('database', 'password')
# 获取日志配置
log_level = config.get('logging', 'level')
log_file = config.get('logging', 'file')
# 获取服务器配置
server_hostname = config.get('server', 'hostname')
server_port = config.getint('server', 'port')
# 打印配置值
print(f"Database Host: {db_host}")
print(f"Database Port: {db_port}")
print(f"Database User: {db_user}")
print(f"Database Password: {db_password}")
print(f"Log Level: {log_level}")
print(f"Log File: {log_file}")
print(f"Server Hostname: {server_hostname}")
print(f"Server Port: {server_port}")

在这个脚本中，我们首先导入了 configparser 模块，并创建了一个配置解析器实例。然后，我们使用 read 方法读取了名为 config.ini 的 INI 文件。

接下来，我们使用 get 方法获取了特定节（section）和键（key）对应的值。`

getint` 方法用于获取值为整数的键。

最后，我们打印出了获取到的配置值。

要运行这段代码，你需要将上述的 config.ini 文件保存为 config.ini，并确保 Python 脚本和 INI 文件位于同一目录中。然后，运行脚本，它应该会打印出 INI 文件中的所有配置信息。

六、总结

先简单介绍了ini在Python的使用，后续在更新其他配置文件的使用。