python批量命名变量_python变量命名的7条建议
前言
Quora 问答社区的一个开发者投票统计,程序员最大的难题是:如何命名(例如:给变量,类,函数等等),光是如何命名一项的选票几乎是其它八项的投票结果的总和。如何给变量命名,如何让它变得有意义成了程序员不可逾越的难题,这篇文章参考了 Clean Code ,提供7条命名建议,希望能在取名字的过程中给你带来一些帮助。
以下都是基于Python3.7语法
1、使用有意义而且可读的变量名
差
ymdstr = datetime.date.today().strftime("%y-%m-%d")
鬼知道 ymd 是什么?
好
current_date: str = datetime.date.today().strftime("%y-%m-%d")
看到 current_date,一眼就懂。
2、同类型的变量使用相同的词汇
差这三个函数都是和用户相关的信息,却使用了三个名字
get_user_info()
get_client_data()
get_customer_record()
好 如果实体相同,你应该统一名字
get_user_info()
get_user_data()
get_user_record()
极好因为 Python 是一门面向对象的语言,用一个类来实现更加合理,分别用实例属性、property 方法和实例方法来表示。
class User:
info : str
@property
def data(self) -> dict:
# ...
def get_record(self) -> Union[Record, None]:
# ...
3、使用可搜索的名字
大部分时间你都是在读代码而不是写代码,所以我们写的代码可读且可被搜索尤为重要,一个没有名字的变量无法帮助我们理解程序,也伤害了读者,记住:确保可搜索。
差
time.sleep(86400);
What the fuck, 上帝也不知道86400是个什么概念
好
# 在全局命名空间声明变量,一天有多少秒
SECONDS_IN_A_DAY = 60 * 60 * 24
time.sleep(SECONDS_IN_A_DAY)
清晰多了。
4、使用可自我描述的变量
差
address = 'One Infinite Loop, Cupertino 95014'
city_zip_code_regex = r'^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$'
matches = re.match(city_zip_code_regex, address)
save_city_zip_code(matches[1], matches[2])
matches[1] 没有自我解释自己是谁的作用
一般
address = 'One Infinite Loop, Cupertino 95014'
city_zip_code_regex = r'^[^,\\]+[,\\\s]+(.+?)\s*(\d{5})?$'
matches = re.match(city_zip_code_regex, address)
city, zip_code = matches.groups()
save_city_zip_code(city, zip_code)
你应该看懂了, matches.groups() 自动解包成两个变量,分别是 city,zip_code
好
address = 'One Infinite Loop, Cupertino 95014'
city_zip_code_regex = r'^[^,\\]+[,\\\s]+(?P.+?)\s*(?P\d{5})?$'
matches = re.match(city_zip_code_regex, address)
save_city_zip_code(matches['city'], matches['zip_code'])
5、 不要强迫读者猜测变量的意义,明了胜于晦涩
差
seq = ('Austin', 'New York', 'San Francisco')
for item in seq:
do_stuff()
do_some_other_stuff()
# ...
# Wait, what's `item` for again?
dispatch(item)
seq 是什么?序列?什么序列呢?没人知道,只能继续往下看才知道。
好
locations = ('Austin', 'New York', 'San Francisco')
for location in locations:
do_stuff()
do_some_other_stuff()
# ...
dispatch(location)
用 locations 表示,一看就知道这是几个地区组成的元组
6、不要添加无谓的上下文
如果你的类名已经可以告诉了你什么,就不要在重复对变量名进行描述
差
class Car:
car_make: str
car_model: str
car_color: str
感觉画蛇添足,如无必要,勿增实体。
好
class Car:
make: str
model: str
color: str
7、使用默认参数代替短路运算和条件运算
差
def create_micro_brewery(name):
name = "Hipster Brew Co." if name is None else name
slug = hashlib.sha1(name.encode()).hexdigest()
# etc.
好
def create_micro_brewery(name: str = "Hipster Brew Co."):
slug = hashlib.sha1(name.encode()).hexdigest()
# etc.
这个应该能理解吧,既然函数里面需要对没有参数的变量做处理,为啥不在定义的时候指定它呢?
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持我们。
本文标题: python变量命名的7条建议
本文地址: http://www.cppcns.com/jiaoben/python/264635.html
python批量命名变量_python变量命名的7条建议相关推荐
- python保存变量_python | 变量-保存与命名规则
1 变量生成 python中生成变量无须事先声明,系统会根据赋值或表达式运算结果值,自动推断变量类型.在python中,变量生成的语法如下:变量名 = 数据或表达式 x = 123 type(x) # ...
- python变量的命名方式_Python变量命名与定义方式
变量是什么?变量:把程序运行的中间结果临时的存在内存里,以便后续的代码调用.#!/usr/bin/env python # -*- coding: utf-8 -*- name = "tai ...
- python3变量命名规则_Python变量命名规则
变量名可以包括字母.数字.下划线, 但是数字不能作为变量的开头.例如,name1 是合法的变量名,而 1name 就不是,如下所示: >>> name1=5 >>> ...
- python定义一个整数变量_Python变量与常量
1.什么是变量 a=1,其中 a 就是变量名称,1 就是它的值.在程序运行过程中,变量的值一般都会发生改变,内存中会专门开辟一段空间,用来存放变量的值,而变量名将指向这个值所在的内存空间.与变量相对的 ...
- python 命名字典_python字典命名
广告关闭 回望2020,你在技术之路上,有什么收获和成长么?对于未来,你有什么期待么?云+社区年度征文,各种定制好礼等你! usrbinpython dict = {: zhang, age: 27} ...
- python定义int变量_Python变量以及常用数字类型(上)
好好学习,天天向上.又到了齐小猴写笔记的时间,今天的内容是python 变量以及常用数字类型,废话不多说,撸起袖子开始写 变量 1.说到变量,先回顾上一篇说过的标识符,自己定义,自己命名,由字母,下划 ...
- c语言调用python变量_Python变量
在编程语言中,变量是一个必不可少的词,大家也可以把变量理解成名字,也可以理解为一个标签. 举个例子来讲解一下变量,比如我们购买了一套名为"dotcpp"的房子,我们在"d ...
- python的常量和变量_python变量和常量
变量 什么是变量? 变量,是用于在内存中存放程序数据的容器 计算机的最核心功能就是"计算", 计算需要数据源,数据源要存在内存里,比如我要把小明的姓名.身高.年龄信息存下来,后面程 ...
- python保存变量_Python变量存储
参考文献1:http://makaidong.com/maikerniuniu/1280_9073599.html 参考文献2:https://www.cnblogs.com/fandx/p/1046 ...
最新文章
- Cocos2D-Android-1之源码详解:2.ActionManagerTest
- linux存储--共享内存机制shm(十三)
- linux中shell命令之间与||符号
- 1001. A+B Format (20)---------------PAT开始
- GCD Game HDU - 7061
- Linux进程全解7——父进程wait / waitip回收子进程
- js立即执行函数_《JS 函数的执行时机》
- 高通骁龙712移动平台正式发布!整体性能提升10%
- UE4C++ Http下载文件
- python 生成testbench_(Testbench用法总结)1. Testbench中文本数据的存储读取操作对比
- iPadOS、iOS13降级iOS12.3.1方法
- 有没有一种让人欲罢不能的学习方法?
- 连接局域网打印机用计算机名,如何连接局域网内共享的打印机
- 第17课:生活中的享元模式——颜料很贵必须充分利用
- 域名链接到服务器指定端口
- “十一“出行防诈骗攻略来了!看完再出去浪
- 编程软件IAR安装使用及程序下载
- 【译学】数据分析手册学习01: 导言、学习目标、指导原则
- Mindspore初学者保姆级上手
- 【数值模型系列】link_grib.csh脚本解读
热门文章
- NBT-19年2月刊4篇35分文章聚焦宏基因组研究
- 高山仰止 | “利他主义者”乔治·普莱斯的一生(全文翻译自Independent)
- 用circlize包绘制circos-plot
- 科研经验1:云笔记积累个人知识体系
- 判断三角形java代码_小猿圈Java循环嵌套语法的使用介绍
- R语言使用caret包构建随机森林模型(random forest)构建回归模型、通过method参数指定算法名称、通过ntree参数指定随机森林中树的个数
- R语言使用yardstick包的roc_curve函数评估多分类(Multiclass)模型的性能、查看模型在多分类每个分类上的ROC曲线(roc curve)
- R语言dplyr包arrage函数排序dataframe实战:单列排序、多列排序、自定义排序
- python使用fpdf生成结账发票pdf文件
- R语言获取当前R版本(version)实战