python开发项目,不得不了解的.cfg配置文件
bigegpt 2025-01-01 18:05 5 浏览
安装软件时,经常会见到后缀为.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读取配置文件时,额外追加了乱码信息导致。如何消除乱码,有人用字符替换,有人通过保存配置文件时修改编码方式,逐一试过后,都没起作用,看来不是特效药。最后,找到了一个最简单的办法,重建一个同名的文件,将配置文件里的内容复制粘贴过去就好。
相关推荐
- 为3D手游打造, Visual Studio Unity扩展下载
-
IT之家(www.ithome.com):为3D手游打造,VisualStudioUnity扩展下载7月30日消息,微软正式发布升级版VisualStudioToolsforUnity扩...
- 由ArcMap属性字段自增引出字段计算器使用Python的技巧
-
1.前言前些日子有人问我ArcMap中要让某个字段的值实现自增有什么方法?我首先想到像SQLServer中对于数值型字段可以设置自增。所以我打开ArcCatalog查看发现只提供默认值,没办法只能看...
- 微软首次回答 HoloLens 相关问题,终于爆料了
-
fengo2015/04/2115:11注:本文作者张静是NVIDIAGPU架构师,微信公众号“黑客与画家”(HackerAndPainter),知乎专栏地址。欢迎各位童鞋与他交流探讨。...
- C#指针的应用(c#指针类型)
-
C#在有限的范围内支持指针。C#的指针只不过是一个持有另一类型内存地址的变量。但是在C#中,指针只能被声明为持有值类型和数组的内存地址。与引用类型不同,指针类型不被默认的垃圾收集机制所跟踪。出于同...
- C# 堆栈(Stack)(c# 堆栈中定位调用messagebox 的地方)
-
C#集合在C#中,堆栈(Stack)是一种后进先出(LIFO,LastInFirstOut)的数据结构。堆栈(Stack)适用于存储和按顺序处理数据,其中最新添加的元素会最先被移除。堆...
- 欢迎回来:Fortran意外重回流行编程语言20强榜单
-
TIOBE指数是用来确定一种编程语言受欢迎程度的指标之一。它并不表明哪种编程语言是最好的,也不表明哪种编程语言写的代码行数最多,而是利用在谷歌、维基百科、必应、亚马逊、YouTube等各种引擎和网站上...
- C#+NET MAUI实现跨平台/终端(linux,win,ios等)解决方案
-
简介.NETMulti-platformAppUI(.NETMAUI)是一个跨平台的框架,用于使用C#和XAML创建移动和桌面应用程序。使用.NETMAUI,您可以用一套代码库开发可以在A...
- C#代码安全红线:SQL注入防护终极方案,让你的系统固若金汤
-
在数字化时代,应用系统的安全性至关重要。而SQL注入攻击,长期盘踞在OWASP(OpenWebApplicationSecurityProject)漏洞榜单的前列,成为众多基于数据库的应用系统...
- C# (一)状态机模式(状态机代码实现)
-
最近空闲,炒炒隔夜饭,以前这些模式在自己项目种应用过不少,但一直没有像别人那样写一个系列,最近年纪大了,很多东西都忘记了,特别AI的兴起,更少写代码了,反正没什么事情,自己在重写一遍吧。创建型模式(5...
- C# 中 Predicate 详解(c#中的replace)
-
Predicate泛型委托:表示定义一组条件并确定指定对象是否符合这些条件的方法。此委托由Array和List类的几种方法使用,用于在集合中搜索元素。Predicate<T>...
- C#中$的用法?(c#中&&什么意思)
-
文章来自AI问答。在C#中,$符号用于字符串插值(StringInterpolation)。字符串插值是C#6.0引入的一种特性,它允许你在字符串中直接嵌入表达式,而不需要使用string.For...
- C#并行编程:Parallel类(c# 并行处理)
-
在Parallel类中提供了三个静态方法作为结构化并行的基本形式:Parallel.Invoke方法:并行执行一组委托。Parallel.For方法:执行与C#for循环等价的并行方法。Parall...
- 颠覆认知!用Span重构foreach循环竟让数据处理快如闪电
-
在C#编程的世界里,数据处理效率始终是开发者们关注的焦点。随着项目规模的扩大和数据量的激增,哪怕是细微的性能提升,都可能对整个应用的响应速度和用户体验产生深远影响。近年来,C#引入的Span<T...
- Unity3D手游开发实践《腾讯桌球》客户端开发经验总结
-
本次分享总结,起源于腾讯桌球项目,但是不仅仅限于项目本身。虽然基于Unity3D,很多东西同样适用于Cocos。本文从以下10大点进行阐述:1.架构设计2.原生插件/平台交互3.版本与补丁4.用脚本,...
- .NET 7 AOT 的使用以及 .NET 与 Go 互相调用
-
目录背景C#部分环境要求创建一个控制台项目体验AOT编译C#调用库函数减少体积C#导出函数C#调用C#生成的AOTGolang部分安装GCCGolang导出函数.NETC#...
- 一周热门
- 最近发表
- 标签列表
-
- mybatiscollection (79)
- mqtt服务器 (88)
- keyerror (78)
- c#map (65)
- resize函数 (64)
- xftp6 (83)
- bt搜索 (75)
- c#var (76)
- mybatis大于等于 (64)
- xcode-select (66)
- mysql授权 (74)
- 下载测试 (70)
- linuxlink (65)
- pythonwget (67)
- androidinclude (65)
- logstashinput (65)
- hadoop端口 (65)
- vue阻止冒泡 (67)
- oracle时间戳转换日期 (64)
- jquery跨域 (68)
- php写入文件 (73)
- kafkatools (66)
- mysql导出数据库 (66)
- jquery鼠标移入移出 (71)
- 取小数点后两位的函数 (73)