Python代码不只是写给自己看的,如何提高代码的可读性?

程序员写代码,每一个语言都有每一个语言的特性

当然对于每一种语言都有语言的格式规范,也可以说是程序员的一种潜规则吧~

那么小编今天带大家看看Python代码应该怎么写,才能写出好看的代码~

1.Python有两种内置或用户定义的类型

可变类型是允许就地修改内容的类型。典型的可变列表是列表和词典:所有列表都有变异方法,如 list.append()或list.pop(),并且可以在适当的位置进行修改。词典也是如此。

不可变类型不提供改变其内容的方法。例如,设置为整数6的变量x没有“增量”方法。如果要计算x + 1,则必须创建另一个整数并为其指定名称。

体会一下这Best这招,选择是使用map函数,它可以将内置函数类型str映射到迭代器range。这会生成一个map对象,然后就可以像其他示例一样join。在某些情况下,map函数甚至可能比列表理解更快,更简洁!

2.一个语句只写一行

每一行一个语句,尤其在复杂的逻辑表达式的时候,这样会清晰很容易阅读。

虽然列表推导等一些复合语句因其简洁性和表达性而被允许和赞赏,但在同一行代码上有两个脱节语句是不好的做法

3.保持语言的简洁性

Python因为技巧性非常高,有的时候滥用一些黑魔法,过度的使用技巧而反而失去了代码本身的直观性。

字典的更新有几种方法,dict(**locals)本意是想生成一个新的字典返回。在上面的好代码中,显式地从调用者接收x和y,并返回显式字典。使用此函数的开发人员通过读取第一行和最后一行就能确切地知道要做什么,而不是像坏例子的那种情况,比较晦涩难懂,不直接。

4.关于返回值的处理

当函数的复杂性增加时,在函数体内使用多个return语句并不罕见。但是,为了保持清晰的意图和可持续的可读性水平,最好避免从体内的许多输出点返回有意义的值。

在函数中返回值有两种主要情况:函数在正常处理时返回的结果,以及指示错误输入参数的错误情况或函数无法完成其计算的任何其他原因或任务

def complex_function(a, b, c):

if not a:

return None # Raising an exception might be better

if not b:

return None # Raising an exception might be better

# Some complex code trying to compute x from a, b and c

# Resist temptation to return x if succeeded

if not x:

# Some Plan-B computation of x

return x # One single exit point for the returned value x will help

# when maintaining the code.

当一个函数在其正常过程中有多个主要出口时,调试返回的结果变得很困难,因此最好保留一个退出点。这也将有助于分解一些代码路径,如果函数有多个出口点,说明你的代码要进一步的重构。

5.解压缩

如果知道列表或元组的长度,则可以通过解压缩为其元素指定名称。比如enumerate()将为列表中的每个项提供两个元素的元组,一个下标一个值:

for index, item in enumerate(some_list):

# do something with index and item

也可以使用它来交换变量:

a, b = b, a

嵌套解包也适用Py3.x:

a, (b, c) = 1, (2, 3)

a, *rest = [1, 2, 3]

# a = 1, rest = [2, 3]

a, *middle, c = [1, 2, 3, 4]

# a = 1, middle = [2, 3], c = 4

6.搜索集合中的项目

有时我们需要搜索一系列的东西。让我们看看两个选项:列表和集合。

以下面的代码为例:

s = set(['s', 'p', 'a', 'm'])

l = ['s', 'p', 'a', 'm']

def lookup_set(s):

return 's' in s

def lookup_list(l):

return 's' in l

即使两个函数看起来都相同,因为lookup_set利用了Python中的集合是哈希表的事实,两者之间的查找性能是非常不同的。

要确定项目是否在列表中,Python必须遍历每个项目,直到找到匹配的项目。

这很费时,特别是对于长列表。另一方面,在集合中项目的哈希将告诉Python在集合中的哪个位置寻找匹配项目。因此,即使集合很大,也可以快速完成搜索。

7.检查变量是否等于常数

您不需要显式地将值与True或None或空进行比较 - 您只需将其添加到if语句即可。

8.访问字典元素

不要使用该dict.has_key()方法。相反使用语法或传递默认参数 比如x in dict ,dict.get(k,default_value)

9.过滤列表

好的做法是使用filter函数,从Python 3.0开始,该filter()函数返回迭代器而不是列表。如果你真的需要一个列表,前面加一个list()即可!

10.Read From a File

使用语法从文件中读取,这将自动为您关闭文件,一定要用with open

11.代码长度的持续

当我们的逻辑代码行长于可接受的限制时(PEP8规定是79个字符),需要将其拆分为多个物理行。

如果行的最后一个字符是反斜杠,Python解释器将连接连续的行。这在某些情况下很有用,但通常应该避免因为它的脆弱性。

在反斜杠之后添加到行尾的空格会破坏代码并可能产生意外结果。

Bad:

my_very_big_string = """For a long time I used to go to bed early. Sometimes, \

when I had put out my candle, my eyes would close so quickly that I had not even \

time to say “I’m going to sleep.”"""

from some.deep.module.inside.a.module import a_nice_function, another_nice_function, \

yet_another_nice_function

Good:

my_very_big_string = (

"For a long time I used to go to bed early. Sometimes, "

"when I had put out my candle, my eyes would close so quickly "

"that I had not even time to say “I’m going to sleep.”"

)

from some.deep.module.inside.a.module import (

a_nice_function, another_nice_function, yet_another_nice_function)

更好的做法是在元素周围使用括号。在行尾留下一个未闭合的括号,Python解释器将加入下一行,直到括号被关闭。对于大括号和方括号,同样的行为也适用。

文章就到这里啦!

欢迎持续关注小编哦~

文章持续推送

猜你喜欢

转载自blog.csdn.net/weixin_44099558/article/details/85777780