「Python入门」Python代码规范（风格）_python程序通过什么来区分代码块的级别(1)

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化资料的朋友，可以戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

• 函数的参数列表中，逗号之后要有空格
• 函数的参数列表中，默认值等号两边不要添加空格
• 左括号之后，右括号之前不要加添加空格
• 参数列表， 索引或切片的左括号前不应加空格
• 当’='用于指示关键字参数或默认参数值时，不要在其两侧使用空格

# 标准范例
spam(ham[1], {eggs: 2}, [])

if x == 4:
    print x, y
x, y = y, x

dict['key'] = list[index]

def complex(real, imag=0.0): return magic(r=real, i=imag)

1
2
3
4
5
6
7
8
9
10
11

八、 Python命名规范

# 模块名命名
# 模块尽量使用小写命名，首字母保持小写，尽量不要用下划线(除非多个单词，且数量不多的情况)

import decoder
import html\_parser

# 变量命名
# 变量名尽量小写, 如有多个单词，用下划线隔开。
count = 0
this_count = 1

# 常量或者全局变量命名
# 全部大写，如有多个单词，用下划线隔开，全⼤写+下划线式驼峰
MAX\_COUNT = 99

# 函数命名
# 函数名应该小写，如有多个单词，用下划线隔开。 大小写混合仅在为了兼容原来主要以大小写混合风格的情况下使用，保持向后兼容。 私有函数在函数前加一个下划线_。
def run():
    pass
def run\_with\_env():
    pass
class Person():
    def \_private\_func():
        pass
# 类命名

# 类名使用驼峰(CamelCase)命名风格，首字母大写，私有类可用一个下划线开头。
# 在接口被文档化并且主要被用于调用的情况下，可以使用函数的命名风格代替。
# 对于内置的变量命名有一个单独的约定：大部分内置变量是单个单词（或者两个单词连接在一起），首字母大写的命名法只用于异常名或者内部的常量。
class Farm():
    pass
class AnimalFarm(Farm):
    pass
class \_PrivateFarm(Farm):
    pass

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
27
28
29
30
31
32
33
34
35
36

# python1.py 范例代码
def func(a=1):
	b = 2
	print(locals()) # 打印当前函数（方法）的局部命名空间
	'''
	locs = locals() # 只读，不可写。将报错！
	locs['c'] = 3
	print(c)
	'''
	return a+b
func()
glos = globals()
glos['d'] = 4
print(d)

print(globals()) # 打印当前模块 python1.py的全局命名空间(可写)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

注：

• 不要中英文混编
• 不要有a、b、c这种没有意义的命名
• 不要怕名字长就随便缩写，比如good_info 缩写成gi
• 不要用大小写区分变量类型，比如a是int类型，A是String类型
• 不要使用容易引起混淆的变量名
• bool变量⼀般加上前缀 is_ 如：is_success
• 变量名不要用系统关键字，如 dir type str等等
• 用下画线作前导(_simple_done)或结尾(simple_done_)的特殊形式是被公认的

九、引号用法规则

One('hello world?')
Tow("my site is vitian.vip") # 单引号和双引号字符串是相同的。
Three('"hell!" vitian.') # 在同一个文件中，保持使用字符串引号的一致性。在字符串内可以使用另外一种引号，以避免在字符串中使用。

1
2
3
4

十、Python模块导入规则

导入应该放在文件顶部，位于模块注释和文档字符串之后，模块全局变量和常量之前。导入应该按照从最通用到最不通用的顺序分组：标准库导入、第三方库导入、应用程序指定导入，分组之间空一行。尽量保持模块名简单，以无需分开单词最佳（不推荐在两个单词之间使用下划线）。

import os # 模块名称要短，使用小写，并避免使用特殊符号， 比如点和问号。
import numpy # 每个导入应该独占一行。
import sys
from types import StringType, ListType 

1
2
3
4
5

十一、 Main

def main(): 
      ... # 主功能应该放在一个main()函数中。

if __name__ == '__main__': # 代码应该在执行主程序前总是检查 if __name__ == '__main__'， 这样当模块被导入时主程序就不会被执行。
    main()

1
2
3
4
5
6

十二、Python函数设计规范

• 函数设计的主要目标就是最大化代码重用和最小化代码冗余。精心设计的函数不仅可以提高程序的健壮性，还可以增强可读性、减少维护成本。
• 函数设计要尽量短小，嵌套层次不宜过深。 所谓短小， 就是尽量避免过长函数， 因为这样不需要上下拉动滚动条就能获得整体感观， 而不是来回翻动屏幕去寻找某个变量或者某条逻辑判断等。 函数中需要用到 if、 elif、 while 、 for 等循环语句的地方，尽量不要嵌套过深，最好能控制在3层以内。不然有时候为了弄清楚哪段代码属于内部嵌套， 哪段属于中间层次的嵌套， 哪段属于更外一层的嵌套所花费的时间比读代码细节所用时间更多。
• 尽可能通过参数接受输入，以及通过return产生输出以保证函数的独立性。
• 尽量减少使用全局变量进行函数间通信。
• 不要在函数中直接修改可变类型的参数。
• 函数申明应该做到合理、 简单、 易于使用。 除了函数名能够正确反映其大体功能外， 参数的设计也应该简洁明了， 参数个数不宜太多。 参数太多带来的弊端是： 调用者需要花费更多的时间去理解每个参数的意思，测试的时候测试用例编写的难度也会加大。
• 函数参数设计应该考虑向下兼容。

十三、Python版本注记

__version__ = "$Revision: 1.4 $" 
#  $Source: E:/cvsroot/python_doc/pep8.txt,v $  将 RCS 或 CVS 的杂项包含在你的源文件中

# 对于 CVS 的服务器工作标记更应该在代码段中明确出它的使用说明，如在文档最开始的版权声明后应加入如下版本标记：
# 文件：$id$ 
# 版本：$Revision$ 

# 这样的标记在提交给配置管理服务器后，会自动适配成为相应的字符串
# 文件：$Id: ussp.py,v 1.22 2004/07/21 04:47:41 hd Exp $ 
# 版本：$Revision: 1.4 $ 

1
2
3
4
5
6
7
8
9
10
11

十四、Python模块、包

模块 module： 一般情况下，是一个以.py为后缀的文件。其他可作为module的文件类型还有".pyo"、“.pyc”、“.pyd”、“.so”、“.dll”。
module 可看作一个工具类，可共用或者隐藏代码细节，将相关代码放置在一个module以便让代码更好用、易懂，让coder重点放在高层逻辑上。
module能定义函数、类、变量，也能包含可执行的代码。
module来源有3种：①Python内置的模块（标准库）；②第三方模块；③自定义模块。

当一个文件夹下有 __init__.py时，意为该文件夹是一个包（package），其下的多个模块（module）构成一个整体，而这些模块（module）都可通过同一个包（package）导入其他代码中。

__init__.py文件用于组织包（package），方便管理各个模块之间的引用、控制着包的导入行为。在 __init__.py导入我们需要的模块，以便避免逐一导入、方便使用。

十五、 sys.modules

sys.modules 是一个 将模块名称（module_name）映射到已加载的模块（modules） 的字典。可用来强制重新加载modules。Python一启动，它将被加载在内存中。

import sys
print(sys.modules) # 打印，查看该字典具体内容。

1
2
3

十六、 Python相对与绝对导入

16.1 绝对导入

所有的模块import都从“根节点”开始。根节点的位置由sys.path中的路径决定，项目的根目录一般自动在sys.path中。

import sys,os
BASE\_DIR = os.path.dirname(os.path.abspath(__file__)) # 存放c.py所在的绝对路径

sys.path.append(BASE\_DIR)

from B.B1 import b1 # 导入B包中子包B1中的模块b1

1
2
3
4
5
6
7

16.2 Python相对导入

只关心相对自己当前目录的模块位置就好。不能在包（package）的内部直接执行（会报错）。不管根节点在哪儿，包内的模块相对位置都是正确的。

# b1.py代码
# from . import b2 # 这种导入方式会报错。
import b2 # 正确
b2.print\_b2()

# b2.py代码
def print\_b2():
	print('b2')
# 运行b1.py，打印：b2。

1
2
3
4
5
6
7
8
9
10

十七、 Python正则表达式（网络爬虫）

re 库是 Python 中处理正则表达式的标准库，本篇博客介绍 re 库的同时，简单介绍一下网络爬虫初阶正则表达式语法。

十八、 re 库基本用法

re 库主要函数如下：
基础函数：compile；
功能函数：search、match、findall、split、finditer、sub。

# 不使用原生字符串的正则表达式  "\\\\"
# 使用原生字符串的正则表达式 r"\\"

vitian_str='D:\python' # 如果希望字符串中 ' 可以正常运行，需要加上转移字符 \ 
print(vitian_str) # => 输出结果：
D:
python

vitian_str= r'D:\python' # \n 被解析成了换行，如果想要屏蔽这种现象，使用 r 
print(vitian_str) #  =>  D:\python


import re
vitian_str='你好我是vitian，欢迎来到我的博客'
pattern = r'vitian'
 # search 范例
ret = re.search(pattern,vitian_str)
if ret:
    print(ret.group(0)) # => vitian
    
# print(ret) # => <re.Match object; sapn=(4,10), match='vitian'>

# re.match 范例
ret = re.match(pattern,vitian_str) 
if ret:
    print(ret.group(0)) # => vitian

# re.match 和 re.search 方法都是一次最多返回一个匹配对象，如果希望返回多个值，可以通过在 pattern 里加括号构造匹配组返回多个字符串。

# re.findall 函数范例
# 该函数用于搜索字符串，以列表格式返回全部匹配到的字符串
ret = re.findall(pattern,vitian_str) # findall 范例
if ret:
    print(ret.group(0)) # => vitian

# re.split 函数范例
# re.split(pattern, string, maxsplit=0, flags=0)
#  函数进行分割的时候，如果正则表达式匹配到的字符恰好在字符串开头或者结尾，返回分割后的字符串列表首尾都多了空格，需要手动去除
import re
vitian_str='你好1我是vitian1，1欢迎来到我的博客1'
pattern = r'\d'
ret = re.split(pattern, vitian_str)
print(ret) # => ['','你好','我是vitian',',','欢迎来到我的博客','']

# re.finditer 函数
# re.finditer(pattern,string,flags=0)
# 搜索字符串，并返回一个匹配结果的迭代器，每个迭代元素都是 match 对象。


# re.sub 函数范例
# re.sub(pattern,repl,string,count=0,flags=0) # 在一个字符串中替换被正则表达式匹配到的字符串，返回替换后的字符串 repl 参数是替换匹配字符串的字符串，count 参数是匹配的最大替换次数。
import re
vitian_str='你好我是vitian，欢迎来到我的博客'
pattern = r'vitian'
ret = re.sub(pattern, "小王子", my_str)
print(ret) # => 你好我是小王子，欢迎来到我的博客

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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

十九、json标准库总结

JSON（全名：JavaScript Object Notation 对象表示法）是一种轻量级的文本数据交换格式，JSON的数据格式其实就是python里面的字典格式，里面可以包含方括号括起来的数组，也就是python里面的列表。

19.1 JSON是什么

• JSON独立于语言
• JSON具有自我描述性，更易理解
• JSON 比 XML 更小、更快，更易解析
• 爬虫经常经常会获取接口数据，接口数据就是JSON格式

19.2 JSON语法格式

{key1:value1, key2:value2，} # 键值对形式（用冒号分开），对间用逗号连接

1
2

19.3 json模块

作用： 使用JSON字符串生成python对象(load)；
数据类型转换： 将数据从Python转换到json格式；
使用方法：

json.dumps(obj)	# 将python数据类型转换为json格式的字符串。
json.dump(obj, fp)	# 将python数据类型转换并保存到son格式的文件内。
json.loads(s)	# 将json格式的字符串转换为python的类型。
json.load(fp)	# 从json格式的文件中读取数据并转换为python的类型。

1
2
3
4
5

区别：
不管是dump还是load，带s的都是和字符串相关的，不带s的都是和文件相关的

19.4 XML文件转为JSON文件

# 新建一个python1.xml文件：
<note date="23/04/2022">
	<to>anna</to>
	<from>vitian</from>
	<msg>love</msg>
</note>

1
2
3
4
5
6
7

# 转换代码实现
import jsonimport xmltodictdef xml\_to\_json(xml_str):
    """parse是的xml解析器，参数需要
    :param xml_str: xml字符串
    :return: json字符串
    """
    xml_parse = xmltodict.parse(xml_str)
    # json库dumps()是将dict转化成json格式,loads()是将json转化成dict格式。
    # dumps()方法的ident=1,格式化json
    json_str = json.dumps(xml_parse, indent=1)
    return json_str
XML\_PATH = './python1.xml'  # xml文件的路径with open(XML\_PATH, 'r') as f:
    xmlfile = f.read()
    with open(XML\_PATH[:-3] + 'json', 'w') as newfile:
         newfile.write(xml\_to\_json(xmlfile)) 
#  => 输出结果

{
	"note": {
		"@date": "20220801",
		"to": "anna",
		"from": "vitian",
		"msg": "love"
	}
}

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

19.5 JSON文件转换为XML文件

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化资料的朋友，可以戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

“20220801”,
“to”: “anna”,
“from”: “vitian”,
“msg”: “love”
}
}

### 19.5 JSON文件转换为XML文件





[外链图片转存中...(img-JqtuOhFL-1715344762507)]
[外链图片转存中...(img-pnFoWh5c-1715344762507)]

**网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。**

**[需要这份系统化资料的朋友，可以戳这里获取](https://bbs.csdn.net/forums/4f45ff00ff254613a03fab5e56a57acb)**


**一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！**

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17