据一项调查统计，近半数的程序员认为“命名”是让他们最为头疼的事情。作为程序员，每天自然是少不了要给各种变量命名。好的变量名，通常具有自解释性，能让我们迅速的理解代码的行为。因此，与其将时间浪费在写注释来解释代码，不如多花点时间想个好的变量名。接下来，本文和大家分享一些关于变量命名的技巧。
命名风格统一
在Python中，有包、模块、类、方法、函数、常量、变量等多种对象，为了在混合了这些对象的代码中区分它们，不至于引起混乱，我们可以对变量命名的格式做一些约定，从而保持整个项目中的命名风格的统一，提供代码的可读性。这里推荐参考Python之父Guido推荐的命名约定。
有意义的命名
变量命名在简洁精炼的条件下，要尽可能的提供对代码行为精确的语义描述。所以，尽量不要用那些过于宽泛的词来作为你的变量名：
# BAD:
day, value, items, cards, temp
# GOOD:
day_of_week, hosts_to_reboot, expired_cards
让人猜出数据类型
因为Python 是一门动态类型语言，没有变量类型声明。所以当你看到一个变量时，除了通过上下文猜测，没法轻易知道它是什么类型。即使像VSCode这样的代码编辑器，对变量类型的提示也是极为有限的。
不过，我们可以通过一些变量命名上约定俗成的技巧来揭示其类型。
bool类型
布尔类型变量，的最大特点是：它只存在两个可能的值『是』 或 『不是』。所以，用 is、has 等非黑即白的词修饰的变量名，会是个不错的选择。原则就是：让读到变量名的人觉得这个变量只会有『是』或『不是』两种值。
下面是几个不错的示例：
•is_superuser：『是否超级用户』，只会有两种值：是/不是
•has_error：『有没有错误』，只会有两种值：有/没有
•flag_found：『标志位变量』，只会有两种值：找到/没找到
•allow_vip：『是否允许 VIP』，只会有两种值：允许/不允许
•debug：『是否开启调试模式』，被当做 bool 主要是因为约定俗成
int/float类型
人们看到和数字相关的名字，都会默认他们是 int/float 类型，下面这些是比较常见的：
•释义为数字的所有单词，比如：income（收入）、age（年龄）、length（长度） 等等
•使用 _id 结尾的单词，比如：user_id、product_id
•使用 length/count 开头或者结尾的单词，比如：length_of_username、name_length、users_count
注意：不要使用普通的复数来表示一个 int 类型变量，比如 apples、trips，最好用 number_of_apples、trips_count 来替代。
复杂类型
对于 list、dict、set 这些内置的复杂数据类型，最好使用复数来表示，很难有一个统一的规则让我们可以通过名字去猜测变量类型。比如 headers，既可能是一个头信息列表，也可能是包含头信息的 dict。当然，我们也可以通过添加类型后缀来指明变量类型，如：
•使用一个复数单词来表明是一个可迭代对象，如：ips
•使用_list后缀来表明一个list对象，如：user_list
•使用_dict后缀来表明一个dict对象，如：header_dict
另外，对于复杂的数据类型，特别是那些业务代码中自己定义的数据类型，最好使用Python类型注解，或者编写DocString来提高其可读性。
# Python类型注解
def add(x:int, y:int) -> int:
return x + y变量命名神器-CODEIF
最后，再和大家分享一个开源的变量命名神器: Codelf。Codelf通过搜索在线开源平台Github, Bitbucket, Google Code, Sourceforge等平台上的项目源码，帮开发者从中找出已有的匹配关键字的变量名。这个搜索服务还支持直接搜索中文，帮我们省去了翻译的过程。codelf支持中文查询，输入中文意思，codelf可以根据需要查询尽可能满足需要的结果，并展示与查询结果相关的支持各种编程语言的代码片段以及代码库。
参考链接：https://github.com/piglei/one-python-craftsman
欢迎关注我的公众号“数据科学杂谈”，原创技术文章第一时间推送。
