Python代码规范

川长思鸟来 2022-01-29 09:23 273阅读 0赞

『动态类型一时爽，代码重构火葬场』，说的是：动态语言在初期开发比较爽，但是到后期维护起来比较困难。Python 作为动态语言之一，自然也会有这样的缺点。其实说『火葬场』，也没有那么严重，只要严格的遵守一组规范，也能做到『重构的时候，也一样爽』。 hehehehe-------

### 1.命名规范 ###

*  模块尽量使用小写命名，首字母保持小写，尽量不要用下划线(除非多个单词，且数量不多的情况) import my\_modul
 *  类名使用驼峰(CamelCase)命名风格，首字母大写，私有类可用一个下划线开头
    
        class AnimalFarm(Farm):

*  函数名一律小写，如有多个单词，用下划线隔开

def run_with_env():

*  私有函数在函数前加一个下划线\_
 *  变量名尽量小写, 如有多个单词，用下划线隔开 animal\_names
 *  常量使用以下划线分隔的大写命名
    
        MAX_CLIENT = 100

<table> 
 <thead> 
  <tr> 
   <th>Type</th> 
   <th>Public</th> 
   <th>Internal</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>Modules</td> 
   <td>lower_with_under</td> 
   <td>_lower_with_under</td> 
  </tr> 
  <tr> 
   <td>Packages</td> 
   <td>lower_with_under</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>Classes</td> 
   <td>CapWords</td> 
   <td>_CapWords</td> 
  </tr> 
  <tr> 
   <td>Exceptions</td> 
   <td>CapWords</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>Functions</td> 
   <td>lower_with_under()</td> 
   <td>_lower_with_under()</td> 
  </tr> 
  <tr> 
   <td>Global/Class Constants</td> 
   <td>CAPS_WITH_UNDER</td> 
   <td>_CAPS_WITH_UNDER</td> 
  </tr> 
  <tr> 
   <td>Global/Class Variables</td> 
   <td>lower_with_under</td> 
   <td>_lower_with_under</td> 
  </tr> 
  <tr> 
   <td>Instance Variables</td> 
   <td>lower_with_under</td> 
   <td>_lower_with_under (protected) or __lower_with_under (private)</td> 
  </tr> 
  <tr> 
   <td>Method Names</td> 
   <td>lower_with_under()</td> 
   <td>_lower_with_under() (protected) or __lower_with_under() (private)</td> 
  </tr> 
  <tr> 
   <td>Function/Method Parameters</td> 
   <td>lower_with_under</td> 
   <td>&nbsp;</td> 
  </tr> 
  <tr> 
   <td>Local Variables</td> 
   <td>lower_with_under</td> 
   <td>&nbsp;</td> 
  </tr> 
 </tbody> 
</table>

### 2. 代码规范 ###

1.如无特殊情况, 文件一律使用 UTF-8 编码

如无特殊情况, 文件头部必须加入`#-*-coding:utf-8-*-`标识

#!/usr/bin/env python
    # -*- coding: utf-8 -*-
    #

2.强化private

1. 实例属性，一般定义成private的
    2. class，对外提供的方法越少越好
    3. module，对外提供的接口越少越好
    4. package，对外提供的 module 越少越好
    
    翻译成代码就是：
    1. 项目布局
    package/
        __init__.py
        _private_mod.py
        public_mod.py    
        
    2. 某模块内容
    public_mod.py
    PUBLIC_GLOBAL = 'G1'
    _PRIVATE_GLOBAL = 'G2'
    class _Class:
        pass
    class PublicClass:
        _PRIVATE_GLOBAL = 'G3'
        
        def __init__(self, name,age):
            self._name = name
            self._age = age
        def public_method(self):
            pass
        def _private(self):
            pass
            
    
    所有东西，一开始就要定义成私有的，等到确实需要开放访问了，才开放出去。

3.import 语句应该分行书写

# 正确的写法
    import os
    import sys
    
    # 不推荐的写法
    import sys,os

4.函数参数注释

def func(arg1, arg2):
        """在这里写函数的一句话总结(如: 计算平均值).
    
        这里是具体描述.
    
        参数
        ----------
        arg1 : int
            arg1的具体描述
        arg2 : int
            arg2的具体描述
    
        返回值
        -------
        int
            返回值的具体描述
    
        参看
        --------
        otherfunc : 其它关联函数等...
    
        示例
        --------
        示例使用doctest格式, 在`>>>`后的代码可以被文档测试工具作为测试用例自动运行
    
        >>> a=[1,2,3]
        >>> print [x + 3 for x in a]
        [4, 5, 6]
        """

5.括号内不要有空行

>     Yes: spam(ham[1], {eggs: 2}, [])
> 
>     No:  spam( ham[ 1 ], { eggs: 2 }, [ ] )

6.函数参数等号左右不要加空格

>     Yes: def complex(real, imag=0.0): return magic(r=real, i=imag)
> 
>     No:  def complex(real, imag = 0.0): return magic(r = real, i = imag)

7,。使用with语句管理文件

with open("hello.txt") as hello_file:
        for line in hello_file:
            print line

8.True 和False

> 尽可能使用隐式的false, 例如: 使用 `if foo:` 而不是 `if foo != []:` . 不过还是有一些注意事项需要你铭记在心:
> 
> 1.  永远不要用==或者!=来比较单件, 比如None. 使用is或者is not.
> 2.  注意: 当你写下 `if x:` 时, 你其实表示的是 `if x is not None` . 例如: 当你要测试一个默认值是None的变量或参数是否被设为其它值. 这个值在布尔语义下可能是false!
> 3.  永远不要用==将一个布尔量与false相比较. 使用 `if not x:` 代替. 如果你需要区分false和None, 你应该用像 `if not x and x is not None:` 这样的语句.
> 4.  对于序列(字符串, 列表, 元组), 要注意空序列是false. 因此 `if not seq:` 或者 `if seq:` 比 `if len(seq):` 或 `if not len(seq):` 要更好.
> 5.  处理整数时, 使用隐式false可能会得不偿失(即不小心将None当做0来处理). 你可以将一个已知是整型(且不是len()的返回结果)的值与0比较.

Yes: if not users:
             print 'no users'
    
         if foo == 0:
             self.handle_zero()
    
         if i % 10 == 0:
             self.handle_multiple_of_ten()
    No:  if len(users) == 0:
             print 'no users'
    
         if foo is not None and not foo:
             self.handle_zero()
    
         if not i % 10:
             self.handle_multiple_of_ten()

### 项目推荐： ###

**[2000多G的计算机各行业电子资源分享（持续更新）][2000_G]**

**[2020年微信小程序全栈项目之喵喵交友【附课件和源码】][2020]**

**[Spring Boot开发小而美的个人博客【附课件和源码】][Spring Boot]**

**[Java微服务实战296集大型视频-谷粒商城【附代码和课件】][Java_296_-]**

**[Java开发微服务畅购商城实战【全357集大项目】-附代码和课件][Java_357_-]**

**[最全最详细数据结构与算法视频-【附课件和源码】][-]**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNTg3NTc1_size_16_color_FFFFFF_t_70_pic_center]

[2000_G]: https://mp.weixin.qq.com/s/sP4JgGWkCzpgwKr9sAV2_Q
[2020]: https://mp.weixin.qq.com/s?__biz=MzIyNTI3NDQ4NQ==&mid=2247487704&idx=1&sn=5f4b2127c4d49fd07ae072a0721424a2&chksm=e8036fc2df74e6d489c4aa9b06f917ef7cee6027f13e150fca53cf79d5d188d4ccc1af49e098&scene=21#wechat_redirect
[Spring Boot]: https://mp.weixin.qq.com/s?__biz=MzIyNTI3NDQ4NQ==&mid=2247487798&idx=2&sn=ac0293b996521b872a9dba5fbb3e65e6&chksm=e8036e2cdf74e73aba104a9a994a5b2e31483e8dcbe0f1d9936f6d5173b887e1560f59d2819c&scene=21#wechat_redirect
[Java_296_-]: https://mp.weixin.qq.com/s?__biz=MzIyNTI3NDQ4NQ==&mid=2247487674&idx=1&sn=7aff0bdf2bb727303f3d3618995aef21&chksm=e8036fa0df74e6b6d872c7e6ece179c524ed463a4a6b74c96875475c9a3d5ddb903427dd993b&scene=21#wechat_redirect
[Java_357_-]: https://mp.weixin.qq.com/s?__biz=MzIyNTI3NDQ4NQ==&mid=2247486376&idx=1&sn=d1fef270c463ea8ac663f6fbfedd70a0&chksm=e80374b2df74fda4d3bafba878a106a19e18c5fcda266008f4f37975847a21bc612ffcd5ff39&scene=21#wechat_redirect
[-]: https://mp.weixin.qq.com/s?__biz=MzIyNTI3NDQ4NQ==&mid=2247487750&idx=1&sn=747bccbb5f5ea6b58915198de40da777&chksm=e8036e1cdf74e70ae97a5e8e265b49d7236d904d291203309159d07ba1724033062c0e370843&scene=21#wechat_redirect
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQwNTg3NTc1_size_16_color_FFFFFF_t_70_pic_center]: /images/20220129/276eebc124d946ca899fee6503703ca6.png