Python 之ConfigParser模块

Love The Way You Lie 2022-09-13 05:17 199阅读 0赞

## 辅助视频教程：[Python基础教程|xin3721自学网ul li id=itemtitlePython3 从入门到精通视频教程/li /ul ul li class=description Python是一种跨平台的计算机程序设计语言。是一种面向对象的动态类型语言，最初被设计用于编写自动化脚本(shell)，![icon-default.png?t=L892][icon-default.png_t_L892]/images/20220828/957516561af449829d5dcb7c5891fb7f.png][Python_xin3721_ul li id_itemtitlePython3 _li _ul ul li class_description Python_shell_icon-default.png_t_L892_icon-default.png_t_L892_https_www.xin3721.com_eschool_pythonxin3721] ##

## 前言 ##

在做项目的时候一些配置文件都会写在settings配置文件中,今天在研究"州的先生"开源文档写作系统-MrDoc的时候,发现部分配置文件写在config.ini中,并利用configparser进行相关配置文件的读取及修改。

## 一、ConfigParser模块简介 ##

该模块适用于配置文件的格式与windows ini文件类似，是用来读取配置文件的包。配置文件的格式如下：中括号“\[ \]”内包含的为section。section 下面为类似于key-value 的配置内容。格式如下：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> <code>[DEFAULT]</code> <code>ServerAliveInterval&nbsp;</code><code>=</code>&nbsp;<code>45</code> <code>Compression&nbsp;</code><code>=</code>&nbsp;<code>yes</code> <code>CompressionLevel&nbsp;</code><code>=</code>&nbsp;<code>9</code> <code>ForwardX11&nbsp;</code><code>=</code>&nbsp;<code>yes</code> <code>[bitbucket.org]</code> <code>User&nbsp;</code><code>=</code>&nbsp;<code>Atlan</code> <code>[topsecret.server.com]</code> <code>Port&nbsp;</code><code>=</code>&nbsp;<code>50022</code> <code>ForwardX11&nbsp;</code><code>=</code>&nbsp;<code>no</code> </td> 
 </tr> 
 </tbody> 
</table>

括号“\[ \]”内包含的为section。紧接着section 为类似于key-value 的options 的配置内容。

## 二、ConfigParser模块使用 ##

**1.写入操作**

代码如下：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 </td> 
 <td> <code>import</code>&nbsp;<code>configparser&nbsp;</code><code>#引入模块</code> <code></code> <code>config&nbsp;</code><code>=</code>&nbsp;<code>configparser.ConfigParser()&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#类中一个方法 #实例化一个对象</code> <code></code> <code>config[</code><code>"DEFAULT"</code><code>]&nbsp;</code><code>=</code>&nbsp;<code>{ </code><code>'ServerAliveInterval'</code><code>:&nbsp;</code><code>'45'</code><code>,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'Compression'</code><code>:&nbsp;</code><code>'yes'</code><code>,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'CompressionLevel'</code><code>:&nbsp;</code><code>'9'</code><code>,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'ForwardX11'</code><code>:</code><code>'yes'</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}&nbsp;&nbsp;</code><code>#类似于操作字典的形式</code> <code></code> <code>config[</code><code>'bitbucket.org'</code><code>]&nbsp;</code><code>=</code>&nbsp;<code>{ </code><code>'User'</code><code>:</code><code>'Atlan'</code><code>}&nbsp;</code><code>#类似于操作字典的形式</code> <code></code> <code>config[</code><code>'topsecret.server.com'</code><code>]&nbsp;</code><code>=</code>&nbsp;<code>{ </code><code>'Host Port'</code><code>:</code><code>'50022'</code><code>,</code><code>'ForwardX11'</code><code>:</code><code>'no'</code><code>}</code> <code></code> <code>with&nbsp;</code><code>open</code><code>(</code><code>'example.ini'</code><code>,&nbsp;</code><code>'w'</code><code>) as configfile:</code> <code></code> <code>&nbsp;&nbsp;&nbsp;</code><code>config.write(configfile)&nbsp;&nbsp;</code><code>#将对象写入文件</code> <code>以上代码做个简单的解释，和字典的操作方式相比，configparser模块的操作方式，无非是在实例化的对象后面，跟一个section，在紧跟着设置section的属性（类似字典的形式）</code> <code>config[</code><code>"DEFAULT"</code><code>]&nbsp;</code><code>=</code>&nbsp;<code>{ </code><code>'ServerAliveInterval'</code><code>:&nbsp;</code><code>'45'</code><code>,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'Compression'</code><code>:&nbsp;</code><code>'yes'</code><code>,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'CompressionLevel'</code><code>:&nbsp;</code><code>'9'</code><code>,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>'ForwardX11'</code><code>:</code><code>'yes'</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}&nbsp;&nbsp;</code><code>#类似于操作字典的形式</code> <code>#config后面跟的是一个section的名字，section的段的内容的创建类似于创建字典。类似与字典当然还有别的操作方式啦！</code> <code>config[</code><code>'bitbucket.org'</code><code>]&nbsp;</code><code>=</code>&nbsp;<code>{ </code><code>'User'</code><code>:</code><code>'Atlan'</code><code>}&nbsp;&nbsp;</code><code>#类似于最经典的字典操作方式</code> </td> 
 </tr> 
 </tbody> 
</table>

**2.读取操作**

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 </td> 
 <td> <code>import</code>&nbsp;<code>configparser</code> <code>config&nbsp;</code><code>=</code>&nbsp;<code>configparser.ConfigParser()</code> <code>#---------------------------查找文件内容,基于字典的形式</code> <code>print</code><code>(config.sections())&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#&nbsp; []</code> <code>config.read(</code><code>'example.ini'</code><code>,encoding</code><code>=</code><code>'utf-8'</code><code>)</code> <code>print</code><code>(config.sections())&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#&nbsp;&nbsp; ['bitbucket.org', 'topsecret.server.com']</code> <code>print</code><code>(</code><code>'bytebong.com'</code>&nbsp;<code>in</code>&nbsp;<code>config)&nbsp;</code><code># False</code> <code>print</code><code>(</code><code>'bitbucket.org'</code>&nbsp;<code>in</code>&nbsp;<code>config)&nbsp;</code><code># True</code> <code>print</code><code>(</code><code>'DEFAULT'</code>&nbsp;<code>in</code>&nbsp;<code>config)&nbsp;</code><code># True</code> <code>print</code><code>(config[</code><code>'bitbucket.org'</code><code>][</code><code>"user"</code><code>])&nbsp;&nbsp;</code><code># Atlan</code> <code></code> <code>print</code><code>(config[</code><code>'DEFAULT'</code><code>][</code><code>'Compression'</code><code>])&nbsp;</code><code>#yes</code> <code>print</code><code>(config[</code><code>'topsecret.server.com'</code><code>][</code><code>'ForwardX11'</code><code>])&nbsp;&nbsp;</code><code>#no</code> <code></code> <code>print</code><code>(config[</code><code>'bitbucket.org'</code><code>])&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#&lt;Section: bitbucket.org&gt;</code> <code>for</code>&nbsp;<code>key&nbsp;</code><code>in</code>&nbsp;<code>config[</code><code>'bitbucket.org'</code><code>]:&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code># 注意,有default会默认default的键</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>print</code><code>(key)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#user serveraliveinterval compression compressionlevel forwardx11</code> <code></code> <code># 同for循环,找到'bitbucket.org'下所有键 ['user', 'serveraliveinterval', 'compression', 'compressionlevel', 'forwardx11']</code> <code>print</code><code>(config.options(</code><code>'bitbucket.org'</code><code>))&nbsp;</code> <code></code> <code>print</code><code>(config.items(</code><code>'bitbucket.org'</code><code>))&nbsp;&nbsp;&nbsp;&nbsp;</code><code>#找到'bitbucket.org'下所有键值对 [('serveraliveinterval', '45'), ('compression', 'yes'), ('compressionlevel', '9'), ('forwardx11', 'yes'), ('user', 'Atlan')]</code> <code></code> <code>print</code><code>(config.get(</code><code>'bitbucket.org'</code><code>,</code><code>'compression'</code><code>))&nbsp;</code><code># yes&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; get方法Section下的key对应的value</code> <code>print</code><code>(config.getboolean(</code><code>'bitbucket.org'</code><code>,</code><code>'compression'</code><code>))&nbsp;</code><code># True</code> </td> 
 </tr> 
 </tbody> 
</table>

**3.修改操作**

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 </td> 
 <td> <code>import</code>&nbsp;<code>configparser</code> <code></code> <code>config&nbsp;</code><code>=</code>&nbsp;<code>configparser.ConfigParser()</code> <code></code> <code>config.read(</code><code>'example.ini'</code><code>,encoding</code><code>=</code><code>'utf-8'</code><code>)&nbsp;&nbsp;</code><code>#读文件</code> <code></code> <code>config.add_section(</code><code>'yuan'</code><code>)&nbsp;&nbsp;</code><code>#添加section</code> <code></code> <code>config.remove_section(</code><code>'bitbucket.org'</code><code>)&nbsp;</code><code>#删除section</code> <code>config.remove_option(</code><code>'topsecret.server.com'</code><code>,</code><code>"forwardx11"</code><code>)&nbsp;</code><code>#删除一个配置项</code> <code># 修改某个option的值，如果不存在该option 则会创建</code> <code>config.</code><code>set</code><code>(</code><code>'topsecret.server.com'</code><code>,</code><code>'k1'</code><code>,</code><code>'11111'</code><code>)</code> <code>config.</code><code>set</code><code>(</code><code>'yuan'</code><code>,</code><code>'k2'</code><code>,</code><code>'22222'</code><code>)</code> <code>#写回文件</code> <code>config.write(</code><code>open</code><code>(</code><code>"example.ini"</code><code>,&nbsp;</code><code>"w"</code><code>))</code> <code># 写到其他文件</code> <code>with&nbsp;</code><code>open</code><code>(</code><code>'new2.ini'</code><code>,</code><code>'w'</code><code>) as f:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>config.write(f)</code> </td> 
 </tr> 
 </tbody> 
</table>

[icon-default.png_t_L892]: https://csdnimg.cn/release/blog_editor_html/release1.9.1/ckeditor/plugins/CsdnLink/icons/icon-default.png?t=L892
[Python_xin3721_ul li id_itemtitlePython3 _li _ul ul li class_description Python_shell_icon-default.png_t_L892_icon-default.png_t_L892_https_www.xin3721.com_eschool_pythonxin3721]: /images/20220828/957516561af449829d5dcb7c5891fb7f.png