没有合适的资源?快使用搜索试试~ 我知道了~
Python编程规范1
资源详情
资源评论
资源推荐
Python编程规范.md
2022/3/22
1 / 2
Python版编程规范
命名规范
变量名采⽤⼩写蛇形⻛格,
例如 coupon_name、 user_last_name 等;
常量名采⽤⼤写蛇形⻛格,
例如 COUPON_NAME、 USER_LAST_NAME 等;
函数名采⽤⼩写蛇形⻛格,并要求以动词开头,
例如 take_last_name、 translate 等;
类名采⽤⼤驼峰命名⻛格,
例如 Storage、 ImageDownload 等;
接⼝名采⽤⼤驼峰命名⻛格,
例如 StorageInterface、 AbstractDownload 等;
包名采⽤⼩写蛇形命名⻛格,
例如 file_storage、 components 等;
⽂件名采⽤⼩写蛇形命名⻛格,
例如 utils.py、 remote_cache.conf 等;
项⽬名采⽤⼩写蛇形命名⻛格,
例如 sequence、 translation_machine 等;
类名、包名、⽂件名、项⽬名、变量名、常量名⽤名词或名词短语,如用名词短语,定语在前,名词在后;
例如:ticket_vending_machine、document_management
函数名⽤动词或者动词短语,如用动词短语,动词在前,名词在后;例如:get_index
表示数量的词统一使用“nums_单数”的形式;例如:nums_layer, nums_channel
⻓度控制在 5 个单词内,追求⻅名知意;不要占⽤语⾔或者系统保留词;不要使⽤简短的字⺟或者非标准的单
词缩写作为名称;
例如:用layer_idx表示layer的index,用layer_id表示layer的identity,不要使用lay_id表示layer的index。
项⽬名、包名、⽂件名对应的单词可以⽤复数形式表示;
接⼝名、抽象类名、基类名、异常类名、错误类名以特定的单词开头或结尾,
例如 TimeException、StorageBase、 PermissionInterface、 ParseError 等;
名称中除了字⺟和下划线外,不应包含其他字符(特殊字符和数字);
例如不要出现a2b这样的命名;
注释标准
行尾注释:EXPIRE = 3600空格空格#空格调⽤⽅指定的时间数值
单一空行注释: 1)#空格函数添加类型注释
2)"""只有 1 ⾏内容时,注释符号的开头和结尾在同⼀⾏"""
多行注释:"""消费者
当有多⾏内容时,注释符号的结尾单独⼀⾏,且第⼀⾏⽂字注释紧跟在注释符号的后⾯
"""
类型注释:
为每个变量给出类型注释name: str, number: int = 1003,
from typing import Tuple, List, Dict
扈涧盛
- 粉丝: 24
- 资源: 319
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0