值得收藏!编写干净的 Python 代码的 5 个技巧!

平时是否思考过如何编写干净的 Python 代码吗?

今天我将给大家分享五个技巧,确保你的代码正常工作、易于阅读并充分利用 Python 提供的功能模块。喜欢本文记得关注、点赞。

使用易于记忆的变量名

通常在编程时,我们不会停下来考虑一个易于阅读、发音和记忆的描述性变量名称。这是一个不好的做法,因为我们将在不考虑描述性变量名称时节省的时间,我们将在未来花费它来尝试理解该变量应该做什么。

❌Bad way

from datetime import date
ymdstr = date.now().isoformat()

✅Good way

from datetime import date
currentDate = date.now().isoformat()

哪个更好地描述了变量的功能?ymdstr 还是 currentDate?

在声明变量并为它选择一个好名字时,最好多花几秒钟,而不是在未来浪费两倍(或三倍)的时间试图理解它的功能是什么。

创建易于搜索的变量名称

每个程序员都应该知道的一件事是,在我们的编程生涯中,我们将花费更多的时间阅读代码并尝试理解它,而不是编写它。

❌Bad way

# What the h*ck is 420 for?
result = serializer.serialize(data, 420)

✅Good way

json = serializer.serialize(data, sort_keys=True, indent=4)
如果我们停下来阅读两个代码摘录(好的和坏的),我们会意识到在坏代码摘录之前快速理解好的代码摘录要容易得多。

使用具有高度描述性的名称

当你将函数作为参数送给另一个函数时,它导致的唯一原因是我们无法正确遵循代码并且我们很难理解它的作用。

❌Bad way

import re

address = 'S Grand Ave, LA 90013'

city_zip_code_regex = re.compile("^[^,]+,\s*(.+?)\s*(\d{5})$")

matches = city_zip_code_regex.match(address)

save_city_zip_code(matches.group(1), matches.group(2))

✅Good way

address = 'S Grand Ave, LA 90013'

city_zip_code_regex = re.compile("^[^,]+,\s*(?P<city>.+?)\s*(?P<zipcode>\d{5})$")

matches = city_zip_code_regex.match(address)

save_city_zip_code(matches.group('city'), matches.group('zipcode'))

通过这个例子,我们可以看到如何通过命名子模式来减少正则表达式的依赖。这使得代码更容易阅读和理解。

不要过度使用 if-else

很多时候,我们并没有过多考虑未来,在某些时候我们可能不得不修改代码,所以我们尽量不要滥用 if-else。if-else嵌套越多,代码就越难理解。

❌Bad way

def is_shop_open(day: str):
 if day:
  day = day.lower()
  if day == 'friday':
   return True
  elif day == 'saturday':
   return True
  elif day == 'sunday':
   return True
  else:
   return False
 else:
  return False

✅Good way

def is_shop_open(day: str):
 
 for open_day in ['friday','saturday','sunday']:
  if day == open_day:
   return True

 return False

看看这个例子有多干净。行数更少,更容易理解。记住:显式优于隐式。

不要添加不必要的上下文

这个小的技巧是基于"不要重复自己"。如果你拥有的任何类或对象的名称已经描述了某些内容或提供了有关其功能的明确信息,那么在变量名称中重复自己是不好的。

❌Bad way

class Car:

 carMake = ''
 carModle = ''
 carColor = ''
    #...
}

✅Good way

class Car:
 make = ''
 modle = ''
 color = ''
    #...

通过这种方式,我们不会重复汽车,因为它过于重复,并没有真正为我们增加价值。记住,越简单越好。

总结

如何编写更简洁、更高效的 Python 代码不仅考验一个人的编码内功,更能让阅读代码的人容易理解,提升工作效率。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 163,987评论 4 381
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 69,374评论 2 309
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 113,513评论 0 259
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 45,021评论 0 228
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 53,538评论 3 304
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 41,207评论 1 227
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,343评论 2 325
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 31,108评论 0 215
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,833评论 1 252
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,970评论 2 255
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,428评论 1 269
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,766评论 3 266
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,514评论 3 250
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,241评论 0 9
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 27,075评论 0 207
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 36,385评论 2 291
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 36,185评论 2 286

推荐阅读更多精彩内容