【Python干货】如何写出优雅的Python代码？搬砖规范&常规约定

新手常见问题

• 新手在使用PyCharm开发的时候会经常看到一大堆的下划线，例如下图：
  
• 这是因为代码编写不够规范的原因。 或者说不够优雅

规范编码样本

• 优雅的代码编码是不会出现下划线的，以“csv读写代码”片段为例：
  

代码规范&常规约定

• 如何做到代码规范呢？我们可以遵循几点规则，或者应该说是“约定”

空行

• 正式写代码前要与顶部空出2行
• 类中函数之间空1行
• 类外函数之间空2行
• 普通函数与类之间空2行
• "#"注释后有一个空格

命名

个人将命名约定归纳总结为以下几条，如有补充，日后完善。

• 类命名：大驼峰（单词首字母大写。如：HfCsv，ConfigUtil）
• 包名、模块、文件名命名：小写字母，单词之间用_分割 如：ad_stats.py；也可全小写
• 普通变量：小写字母，单词之间用_分割 如：csv_list；(函数外的变量)可用小驼峰命名，如csvList
• 实例变量：以_开头，其他和普通变量一样 _instance_var；(一般使用self.xxx)
• 私有实例变量（外部访问会报错）： 以__开头（2个下划线）如：__private_var
• 普通函数：全小写加"_",如： get_name()；或全小写
• 私有函数：以__开头（2个下划线），如：__get_name()
• 常量：全大写加“_”
• 异常:以“Error”作为后缀。
• 缩写:
  例如: function 缩写为 fn
  text 缩写为 txt
  object 缩写为 obj
  count 缩写为 cnt
  number 缩写为 num