在Python中变量名这样写,就是给自己挖坑

mac2022-11-22  6

Python编程上的一些挖坑行为,你可能也犯了。

下面这样的一串代码相信很多人都写过,但可能除了你自己没有人看得懂:

for range in range(n): for j in range(m): for k in range(l): temp_value = X [i] [j] [k] * 12.5 new_array [i] [j] [k] = temp_value + 150

这并不是一段好的的代码,为了图省事,使用了简单而无实际含义的变量及数值,看起来在任何程序中都可以用,对于看的人来说就是灾难,因为要想半天或者查看上下文才知道你写的变量是什么意思,给别人修改和调试带来很大麻烦。

所以如果你的代码不仅仅是给自己看的,就尽量不要再这么写,多使用描述性变量名称和命名常量编写代码,养成一个变量命名的好习惯。

来看看用标准变量怎么写上面的代码:

''' 遇到问题没人解答?小编创建了一个Python学习交流QQ群:857662006 寻找有志同道合的小伙伴,互帮互助,群里还有不错的视频学习教程和PDF电子书! ''' PIXEL_NORMALIZATION_FACTOR = 12.5 PIXEL_OFFSET_FACTOR = 150 for row_index in range(row_count): for column_index in range(column_count): for color_channel_index in range(color_channel_count): normalized_pixel_value = ( original_pixel_array[row_index][column_index][color_channel_index] * PIXEL_NORMALIZATION_FACTOR ) transformed_pixel_array[row_index][column_index][color_channel_index] = ( normalized_pixel_value + PIXEL_OFFSET_FACTOR )

虽然代码量增大了,但是别人一看就能看懂,不管隔多久再来看很快就能明白,而第一段代码,过一阵再看你还能明白是干什么的么?

好的程序员都会遵守的代码变量命名规则:

变量名应该能够描述变量表示的信息。

优先考虑代码的易懂性,而不是编写代码的速度。

采用标准的命名约定,做出一个全局决策而不是多个本地决策。

所以命名不标准的原因主要有两个:

无益/混淆/模糊的变量名称

未命名的“魔法”常数

简单来说,不要再像下面这样命名变量:

X, y, xs, x1, x2, tp, tn, clf, reg, xi, yi

要纠正也很简单,遵守下面三条简单规则即可:

变量/函数名称:用小写字母表示,中间用下划线分割

常量:用大写字母

Class 类:首字母大写,其余小写

详细来说有这么些注意事项:

X和y:

X 和 y 你可能已经看过几百次,知道它们的功能,但对于阅读代码的其他开发人员来说,这可能并不明显。所以,不妨使用描述这些变量是代表什么的名称,例如:house_features 和 house_prices。

value:

value 值具体是什么呢?可能是一个velocity_mph,customers_served,efficiency,revenue_total。不同的 value 最后加一个详细的前缀。

temp:

临时变量虽然可以用 temp 表示,但最好还是给它一个有意义的名称。比如是需要转换单位的值,像下面这样写:

''' 遇到问题没人解答?小编创建了一个Python学习交流QQ群:857662006 寻找有志同道合的小伙伴,互帮互助,群里还有不错的视频学习教程和PDF电子书! ''' #不要这样做 temp = get_house_price_in_usd(house_sqft,house_room_count) final_value = temp * usd_to_aud_conversion_rate #这样做 house_price_in_usd = get_house_price_in_usd(house_sqft, house_room_count) house_price_in_aud = house_price_in_usd * usd_to_aud_conversion_rate 缩写:

如果使用缩写变量,最好提前申明缩写变量名的含义,比如usd, aud, mph, kwh, sqft这些。与普通缩写的团队其他成员达成一致并写下来。然后,在代码审查中,确保执行这些书面标准。

避免机器学习特定的缩写:

比如尽量不要用 tp, tn, fp, fn,这些缩写变量,而是使用完整的变量代替:true_positives,true_negatives,false_positives,和false_negatives。

导致错误变量名直接原因?

下面这两个原因是写出错误变量名的重要原因:

希望保持变量名称简短

将公式直接转换为代码 根据上面的公式,一般情况下很可能就直接写成:

temp = m1 * x1 + m2 *(x2 ** 2) final = temp + b

这是看起来像是机器编写的代码,虽然计算机最终将运行它,但人看的次数更多,最好编写适合人理解的代码:

house_price = price_per_room * rooms + price_per_floor_squared *(floor** 2) house_price = house_price + expected_mean_house_price

不要使用魔法数字

魔法数字就是不是变量名的恒定值,通常用于单位转换。但这样的转换代码是错误的:

final_value = unreverted_value * 1.61 final_quantity = quantity / 60 value_with_offset = value + 150

没人理解 1.61、60 表示什么单位,自然也就看不懂转换后的变量含义,所以最好给这个转换数值赋予变量名,比如:

USD_TO_AUD_CONVERSION_RATE = 1.61 price_in_aud = price_in_usd * USD_TO_AUD_CONVERSION_RATE REVOLUTIONS_PER_MINUTE = 60 revolution_count = minutes_elapsed * REVOLUTIONS_PER_MINUTE

以上就是在代码变量命名过程中需要注意的一些细节。

最新回复(0)