关于Python编程规范的一些个人建议

主要是个人在编程规范中的一些见解建议,欢迎指正

1. 代码书写要便于阅读。

例如:每行仅书写一条语句(尤其注意 if/for/while 语句)

2. 编码一致性

a. 在同一个项目中的代码要保持一致
b. 在同一个模块中的代码要保持一致

3. 关于缩进:

建议为 4 个空格。若使用 Tab 键,建议将其定义为 4 个空格。

缩进在 python 中是语法相关的,python 解释器通过缩进来判断代码块的从属关系,请谨慎使用

4. 建议代码行最大长度限定为 80 个字符。

当前行未输入完毕,如果继续输入将超过限定长度,此时在当前行尾输入‘\’后再回
车换行(这样 python 解释器认为另起的新行与当前行是同一逻辑行)

5. 代码中输入‘^L’,表示此处分页

6. 编码尽量用 ASCII 码,有特殊需要时可使用 UTF-8 码

7. “import”语句使用规范:

  • 多条“import “语句要分行书写,不建议使用“import A, B”形式。
  • 特殊地,可以使用”from X import A, B” 形式
  • 导入各模块的书写顺序(自上而下):
    a. “import 标准内建模块”
    b. “import 第三方模块”
    c. “import 自建模块”

8. 工程文件目录建在 python 安装目录下

使用”import”语句导入模块时建议使用绝对路径

9. 空行的使用:

  • 类外函数之间: 空 2 行
  • 类内 methods 之间: 空 1 行
  • 各类之间: 空 2 行

10. 空格的使用:

  • 避免在[], (), {}内与括号相接触的位置使用空格,类似[ ‘a’], (‘b’ ), { ‘c’ }等形
    式都要避免
  • 双目操作符前后各加一个空格(建议有且仅有一个空格,不建议使用多个或无空格)
  • 特殊地,function 或 method 参数初始化时,‘=’前后都不加空格

11. 关于注释:

  • 注释语言统一为英语
  • 注释用‘# ’开头。(提醒:‘#’后要跟一个空格)
  • 同一注释行中,句子间用两个空格
  • 各注释行间若有空白行,同样以‘#’作行首
  • 若代码本身简单易懂,或命名本身实现了自注释,勿加多余注释
  • 代码修改的同时要修改对应注释,否则危害很大
  • 注释是完整句子时,首单词的首字母大写; 注释较短时可省去末尾的句号

12. 命名规则

  • 保持一致性,至少保持自建代码的一致性
  • 避免使用单个字母做变量,尤其避免’l’, ’o’用作变量
  • 命名字符串不要太长。注:本次会议中,该指标没有量化
  • 类名采用首字母大写的各单词直接相连方式命名。例: “StudentBoy”
  • 非类名采用字母均小写的各单词以下划线相连的方式命名。例:”student_boy”
  • 属内部的 function, class, method 命名要以下划线开。:”_local_time”,“_LocalTime”
  • 异常相关的命名用”Error”或”error”开头
  • 全局变量与 function 命名规则一样
  • 类内默认参数定义为’self’
  • 当对参数命名可能发生重名时,在原名后加下划线作新名。例:”print_”
  • 常量命名采用大写的各单词以下划线相连方式命名。例:”MAX_NAME_LENGTH”
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,651评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,468评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,931评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,218评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,234评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,198评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,084评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,926评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,341评论 1 311
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,563评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,731评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,430评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,036评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,676评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,829评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,743评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,629评论 2 354

推荐阅读更多精彩内容

  • 最近写python对于一些代码规范问题感觉有些地方自己还需要加强,翻阅很多文章,特此奉上官方中文翻译版以便日后查看...
    PeterPZ阅读 3,486评论 0 15
  • 介绍 愚蠢的使用一致性是无知的怪物(A Foolish Consistency is the Hobgoblin ...
    slords阅读 1,973评论 0 2
  • python编写规范 一、说明二、内容1. 代码布局1.1 缩进1.2 表达式和语句中的空格1.3 行的最大长度1...
    V7hinc阅读 988评论 0 0
  • 更新时间:2016/5/13 介绍 本文档所提供的编码规范,适用于主要的Python发行版中组成标准库的Pytho...
    超net阅读 5,859评论 0 15
  • --< > 令人讨厌的小人物身上有着愚蠢的一致性 --(A Foolish Consistency is the ...
    LittleWizard阅读 3,226评论 0 4