百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

python开发项目,不得不了解的.cfg配置文件

off999 2024-11-13 11:49 21 浏览 0 评论

安装软件时,经常会见到后缀为.cfg、.ini的文件,一般我们不用管,只要不删就行。因为这些是程序安装、运行时需要用到的配置文件。但对开发者来说,这种文件是怎么回事就必须搞清了。本文从.cfg文件的创建、编辑修改到使用等方面,进行解读,帮助大家掌握配置文件。

一、配置文件的作用

配置文件的作用是保存一些在程序运行时需用到的参数,在程序运行过程中,通过代码读取配置文件获得参数,保障程序的正常运行。如果误删了配置文件,代码取不到数据,程序也就无法正常运行了。配置文件一般保存的参数有:

1)使用数据库的程序,程序与数据库的连接参数,常常被写入配置文件读取调用;

2)有登录账号、密码的程序,登录名及账号信息一般也会写入配置文件。当程序运行到登录界面时,只需读取配置文件,就能对登录信息进行判断,而不必运行到主程序,提高运行效率。

3)桌面程序界面设置信息等

这里需要注意的是,不是所有的程序都必须有配置文件。因为配置文件的作用说白了也就是单独存储数据,如果项目很小,用到的数据很少,就没有弄配置文件的必要, 直接把数据写在代码里就可以了。

二、配置文件的后缀格式

很多人奇怪为什么配置文件的后缀格式.cfg是什么意思,而有时.ini、.xml、.dat格式文件也叫配置文件?其实,知道了配置文件的本质和项目开发习惯就明白了。首先,配置文件的本质就是文本文件,能直接用记事本打开、编辑。文件的后缀,可以是.txt,也可以根据自己的意愿随便修改,比如改为.cfg,.ini等都是没问题的。

虽然配置文件的后缀可以根据自己的喜好随意定,但也不是任何时候想改就改的。因为配置文件的后缀格式已经写入到程序代码里了,如果中途修改后缀,而代码里还是原后缀格式,就会造成找不到配置文件导致程序运行不了的后果。比如,原配置文件为cg.cfg,一般代码里会有这样的读取语句:

cp.read('source\cg.cfg')

如果将配置文件修改为cg.ini,则须修改代码语句为:

cp.read('source\cg.ini')

否则,若还是cp.read('source\cg.cfg')语句,就找不到模配置文件,报错。而我们安装软件时,是不可能改代码的。所以,面对安装包里的配置文件,正确做法就是不管,不删不改不移动就行。

为提高代码的通用性和可读性,项目开发时会提前约定好固定的后缀作为配置文件的格式,这就是项目开发习惯的结果。所以现在一般只要看到.cfg、.ini等后缀的文件,就知道这是配置文件。若突然换了个个性的后缀,就容易让人蒙圈。

所以后缀.cfg没有特殊的含义,只是约定的习惯用法而已,只不过不止约定了这一种,还约定了.ini、.dat、.xml等,所以.ini、.xml、.dat格式文件都叫配置文件

三、配置文件里内容的格式

和文件后缀格式可以随便自定义不同,配置文件里内容的格式要求很严格,内容样式为:

[section]  

option = value

...

其中:section为节点,用中括号括起来;option为键,value为键对应的值,option= value构成键值对,一个键只对应一个值,同一个section节点下option键不能重复出现

如下图,节点(section)[rew]下出现了两个相同的键(option)name:

运行python读取该文件代码:cp.read('1.txt')时,会提示报错:

configparser.DuplicateOptionError: While reading from '1.txt' [line 3]: option 'name' in section 'rew' already exists

意思是第3行的option'name'在节点section‘rew’里已存在。

四、配置文件的创建、写入数据

了解了配置文件的本质是文本文件,且后缀可随意更改的特点后,文件的创建和修改就简单了。直接用记事本创建文件,按内容格式要求写好数据后,将文件保存为后缀为.cfg或其他拟定的后缀格式文件即可。也可以直接用代码方法:用open('confg.cfg', 'w')函数可以在当前文件夹下创建名为“confg.cfg”的文件,'w'参数代表可以向文件写入数据,然后用write(f),将文件保存下来。如下面的代码

from configparser import ConfigParser
cp = ConfigParser()
cp.add_section('test1')
cp.set('test1', 'name', '张三')
cp.set('test1', 'sn', '123456')
with open('confg.cfg', 'w') as f:
    cp.write(f)

运行后即生成的了保存有两条信息的confg.cfg文件,右键用记事本打开查看,结果为:

五、配置文件的常用操作函数

上面我们创建并写入了配置文件内容,有时,我们需要在程序运行过程中,根据用户交互信息,自动修改配置文件信息,这就只能用代码了。python的ConfigParser模块下有多个操作配置文件的函数,常用的有10个,具体如下:

1、read(file.cfg):读取配置文件

from configparser import ConfigParser
cp = ConfigParser()
cp.read('confg.cfg')

2、set(section, name, value):新增项目(name:“李四”,sn:‘123’),新增时,节点(section)下不能存在为‘李四’的项目键(name),否则就变成了修改键对应的值,如下面第3条

cp.set('test1', '李四', '123')

3、set(section, name, value):将配置文件里的“李四”对应sn修改为新sn“666”

cp.set('test1', '李四', '666')  # 将原sn:123,该为新sn:666

4、remove(section, name):删除项目

cp.remove_section('test2')  #如果文件里没有test2节点,就无法删除,会报错,所以一般要先判断是否存在该节点。

5、has_section(section):判断是否存在节点

cp.add_section('test2')

6、add_section(section):增加节点

cp.add_section('test2')

注意:不能增加已经存在的section,为了避免出错,可先判断是否存在节点(section)

7、sections():得到所有的section,返回结果为列表

from configparser import ConfigParser
cp = ConfigParser()
cp.add_section('test1')
cp.set('test1', 'name', '张三')
cp.set('test1', 'sn', '123456')
cp.add_section('test2')
cp.set('test2', 'name', '张')
cp.set('test2', 'sn', '123')
with open('confg.cfg', 'w') as f:
    cp.write(f)
cp.read('confg.cfg')
print(cp.sections())

运行结果为:['test1', 'test2']

8、options(section) :得到section下的所有option (key值),返回结果为列表

from configparser import ConfigParser
cp = ConfigParser()
cp.read('confg.cfg')
print(cp.options('test1'))

运行结果为:['name', 'sn']

9、items(section):得到section的所有键值对

from configparser import ConfigParser
cp = ConfigParser()
cp.read('confg.cfg')
print(cp.items('test1'))

运行结果为:[('name', '张三'), ('sn', '123456')]

10、get(section, option):得到section中option的值,返回为string类型

from configparser import ConfigParser
cp = ConfigParser()
cp.read('confg.cfg')
print(cp.get('test1', 'name'))

运行结果:张三

11、getint(section, option):得到section中的option值,返回为int类型

from configparser import ConfigParser
cp = ConfigParser()
cp.read('confg.cfg')
print(cp.getint('test1', 'sn'),type(cp.getint('test1', 'sn')))

运行结果:123456 <class 'int'>

6、试用

了解了这些后,我们可以试着找一些软件配置文件,打开看数据都是些什么格式。比如,下图是SQL SERVER安装包里带的一个配置文件的内容,注意该配置文件后缀是.ini,用记事本打开查看:

注意着里面的第一行是分号开头的字符串,在我们正常的python3,环境下读取时会报错,将分号改为python里的注释符即可。

异常错误处理

用ConfigParser模块的read函数读取配置文件时,偶尔会出现一种奇怪的错误,提示为

configparser.MissingSectionHeaderError:File contains no section headers,

具体是将配置文件的第一行读取为:'锘縖sql_connect]\n',而实际是'[sql_connect]'。

这种错误很无语,很让初次见到的人崩溃。其实,这种错误是因为windows读取配置文件时,额外追加了乱码信息导致。如何消除乱码,有人用字符替换,有人通过保存配置文件时修改编码方式,逐一试过后,都没起作用,看来不是特效药。最后,找到了一个最简单的办法,重建一个同名的文件,将配置文件里的内容复制粘贴过去就好。

相关推荐

u盘读取软件下载(u盘读取器下载)

手机播放U盘里的视频不用刻意的去安装什么播放器,一般手机里自带的播放器就能够直接播放U盘里的一般常见的视频。只要你要播放的视频,都是平时在电脑上或者电视上能够正常播放的视频,一般在手机里面它的系统自带...

office2020安装包百度云下载

Office2020和Office2019是微软的办公套件产品,两个版本之间有以下区别:1.发布时间:Office2020于2021年10月发布,而Office2019于2018年9月发布。...

硬盘恢复分区(硬盘恢复分区怎么删除)

1、在电脑上下载DiskGenius软件。2、双击运行该软件,软件会自动识别硬盘。当软件自动识别硬盘之后,右键单击硬盘的盘符,出现下拉菜单栏,选择搜索已丢失分区(重建分区表)选项。3、右键单击硬盘盘符...

edge 浏览器(edge浏览器官网下载)
edge 浏览器(edge浏览器官网下载)

目前没有,如果是平板安装了WIN10是会内置MicrosoftEdge浏览器的。edge是由微软开发的基于Chromium开源项目及其他开源软件的网页浏览器。Edge浏览器主要特点是能够支持目前主流的Web技术,作为Windows10自带...

2025-11-18 06:51 off999

网易163邮箱免费注册(163网易免费邮件注册)
网易163邮箱免费注册(163网易免费邮件注册)

163邮箱登录入口页面官方地址:https://mail.163.com/163邮箱登录注册方法1、进入邮箱登入首页,我们点击右下角“去注册”按钮,进入注册界面;2、这里直接填写账号和密码内容,点一下同意那里呈蓝色圆点;再点下一步。3、再填...

2025-11-18 06:03 off999

苹果商城app下载安装(苹果商店app免费下载)

一、苹果手机下载软件显示APP内购买的意思是APP可以免费下载使用,但是该APP内有付费内容,也就是通常所说的收费道具。二、不是所有应用都会提供App内购买项目。如果某个应用提供App内购买...

惠普电脑中国官网(惠普手提电脑官网)

https://support.hp.com/cn是惠普笔记本售后服务官网。惠普维修服务中心通过整合线上线下相关资源,向国内用户提供方便快捷、安全可靠的优质电子产品维修服务。目前拥有北京6家、全国30...

windows2003密钥序列号(win2003 密钥)

没有密钥就无法完成程序安装。使用或者购买密钥才能安装

电脑产品密钥在哪里找win10(电脑产品密钥在哪里找新机)

要查看电脑上Windows10的产品密钥,你可以按照以下步骤进行操作:打开“开始”菜单,然后点击“设置”图标(齿轮状图标)。在“设置”窗口中,点击“更新和安全”选项。在左侧导航栏中,选择“激活”选项...

电脑有网络但上不到网(电脑有网但是上不了网)

如果电脑显示有网但无法上网,可能是网络连接出现问题。这种情况可能是由于以下几个原因导致的:1.路由器或者调制解调器出现故障;2.电脑的网络设置有误;3.网络供应商的服务中断或者限制了你的网络访问...

笔记本突然开不了机了是什么情况

1.检查笔记本是否有电,当内置电池用完而又没有充电的情况下,会导致笔记本无法开机,插上电源充电即可。2.内置电池损坏维修更换即可。3.开机时按F8,在高级选项中选择最后一次正确的配置即可。4.中病毒可...

windows11办公软件(windows11的office)

1、首先点击电脑底部的Windows图标2、进入开始页面点击office套件中的任意应用,如Word3、页面弹出登录按钮,和创建按钮,如已有账号,点击登录4、接着进入激活office页面,输入offi...

7z文件怎么打开(7z文件改什么后缀才能打开)
7z文件怎么打开(7z文件改什么后缀才能打开)

  7z是一种压缩格式,和我们在Windows平台上看到的rar类似;7z原本是7-zip开源的压缩文件所支持的压缩格式,目前大多数压缩软件也支持打开,如若安装了第三方压缩软件双击即可打开7z。7z文件的打开方式介绍如下:  1、扩展名为...

2025-11-18 02:03 off999

重装系统后连不上网(重装系统后无法连网)

1、首先,在安装系统完成之后,界面右下角网络连接显示不可用?我们需要通过,系统本身自带的诊断系统进行诊断,以避免是否是物理原因造成的网络不能正常链接。2、其次,检测结果如果是显示的未能安装网络适配器,...

破解wifi密码有什么办法(破解wifi密码有什么办法幻影)

破解路由器admin管理员密码方法:只能间接的破解。 方法一、1、打开浏览器---输入192.168.1.1(一般路由器地址是这个或者查看路由器背面的登录信息)进路由---输入用户名,密码...

取消回复欢迎 发表评论: