`
snoopy7713
  • 浏览: 1149801 次
  • 性别: Icon_minigender_2
  • 来自: 火星郊区
博客专栏
Group-logo
OSGi
浏览量:0
社区版块
存档分类
最新评论

python 编码风格

阅读更多
Python代码  收藏代码
  1. #!/usr/bin/env python     #在文件头部 ( 第一行 ) 加上   设置 Python 解释器   
  2. # -*- coding: utf-8 -*-     #在文件头部 ( 第二行 ) 加上   在编辑器中设置以 UTF-8 默认编码保存文件   
  3. # Copyright (c) 2011 - chinakr <chinakr@gmail.com>    #版权信息放在文件头部,文件编码之后   
  4.   
  5. # docstring 是 Python 特有的注释风格,它是模 块、类或函数的第一个语句,可以通过 __doc__ 方法访问    
  6. # 用英语撰写注释,短注释可以忽略末尾的句号 (.)   
  7. # docstring 为每个模块、类或函数撰写 docstring   推荐使用三个双引号 (”””) 来定义 docsting , 不推荐使用三个单引号 (''')   
  8. # 模块的 docsting 放在文件头部,版权信息之后   
  9.   
  10. ”””This is  a one line docstring.”””  
  11. ”””The title of a multiline docstring:  
  12. After title is  the content.You can write it as long as needed.  
  13. ”””  
  14.   
  15. # 把 import 语句放在文件头部,在模块 docstring 之后,在模块全局变量或全局常量之前   
  16. # 按照从一般到特殊的原则分组 import 语句,先 import 标准库,然后 import 第三方库,最后 import 程序中的自定义库   
  17. # 在不同分组的 import 语句之间加空行    
  18. # 每个 import 语句只导入一个模块   
  19.   
  20. import  sys   
  21. import  time  
  22.   
  23. from  PyQt.QtCore  import  SIGNAL, QTimer  
  24.   
  25. #  在终端中使用中文字符  在文件头部加上   
  26. # import sys    
  27. # reload(sys)    
  28. # sys.setdefaultencoding('utf-8')   
  29.   
  30. # 一行代码的长度不能超过 79 个字符   
  31. # 在括号 ( 圆括号、方括号、花括号 ) 内部折行是 推荐使用的方式   
  32. fooBar(self , width, height, color= 'balck' , design= None , x= 'foo' ,  
  33.        emphasis=None , highlight= 0 )  
  34. # 需要时可以在表达式两侧加上额外的括号   
  35. if  (width ==  0   and  height ==  0   and    
  36.     color == 'red'   and  empasis ==  'strong' ):  
  37. # 括号内的长字符串可以直接写成两个短字符串   
  38. x = ('This will build a very long long '    
  39.      'long long long long long long string' )  
  40.   
  41. # 使用续行符号,折行的位置可以在逗号 (,) 后或 运算符前,折行后要多一个缩进   
  42. from  PyQt4.QtCore  import  QTextCodec, SIGNAL, SLOT, \  
  43.     QLibraryInfo, QTimer  
  44. veryLongVariableA = veryLongVariableB \  
  45.      + verLongVariableC  
  46. # 使用 4 个空格进行缩进 不要使用 Tab 或者混合使用空格和 Tab   
  47.   
  48. # 适当的空行可以提高代码的可读性 加空行的原则:   
  49. ## 在不同分组的 import 语句之间加空行   
  50. ## 在顶层的类或函数定义之间加两个空行   
  51. ## 在类或函数定义之间加空行   
  52. ## 相关的函数定义可以放在一起,并使用两个空行来分 隔 ( 应谨慎地使用额外的空行 )   
  53. ## 在函数或方法内部可以加空行,也就是把相关的代码 紧凑地写在一起,形成逻辑段落,段落之间用空行分 隔 ( 应谨慎地使用额外的空行 )   
  54.   
  55. # 加空格的情况:   
  56. ## 逗号 (,) 、冒号 (:) 后要加空格   
  57. ## 二元运算符前后要加空格,如赋值运算符 (=) 、比较 运算符 (==, <, >, !=, <=, >=, in, not in, is, is not) 和逻 辑运算符 (and, or, not)   
  58. ## 算数运算符前后要加空格   
  59.   
  60. # 不加空格的情况:   
  61. ## 逗号 (,) 、冒号 (:) 前不加空格 参数列表、索引 (index) 或切片 (slice) 的前括号 ( 圆   
  62. ## 括号, 方括号)前不加空格 前括号 ( 圆括号、 方括号、花括号 ) 后不加空格,后   
  63. ## 括号前不加空格 一元运算符前后不加空格   
  64. ## 函数或方法定义或调用时参数列表中的等号 (=) 前后 不加空格   
  65. ## 冒号 (:) 在行尾时不加空格,如类定义、函数定义、 分支语句、循环语句   
  66.   
  67.   
  68. # 谨慎地使用括号   
  69.   
  70. # 不要在返回语句和条件语句中使用括号,除非是 为了换行   
  71. if  foo:   
  72.     bar()  
  73. return  foo  
  74. # 可以在元组 (tuple) 两侧使用括号    
  75. for  (x, y)  in  dict.items():  
  76.   
  77.   
  78. # 恰当的命名可以提高代码的可读性 命名时只使用 ASCII 字符,并尽量使用英文单词 命名规则   
  79. # 类型    公共  内部   
  80. # 包 lower_with_under       
  81. # 模块    lower_with_under    _lower_with_under   
  82. # 类 CapWords    _CapWords   
  83. # 函数    capWords()  _capWords()   
  84. # 全局常量 / 类常量    CAPS_WITH_UNDER     _CAPS_WITH_UNDER   
  85. # 全局变量 / 类变量    capWords    _capWords   
  86. # 方法    capWrods()  _capWords() ( 保护 ) __capWords() ( 私有 )   
  87. # 函数参数 / 方法参数   capWords   
  88. # 局部变量  capWrods   
  89.   
  90. # 不要使用l(小写的L)、o(小写的O)和I(大写的 i) 作为单字符变量名,因为在某些字体下很难把 它们和数字1、0区分开   
  91.   
  92. ## 当需要使用 l( 小写的 L) 时可以使用 L 代替   
  93. ## 当需要使用保留关键字作为函数名时,可以在名 字后加一个下划线 (_) ,而不要破坏正常的拼写   
  94.   
  95. # 模块的主要功能要放在 main() 函数中   
  96. def  main():   
  97.     //do something  
  98. if  __name__ ==  '__main__' :   
  99.     main()  

 

 

 

 

分享到:
评论

相关推荐

    Python编码风格指南(中文版)

    1.2 Python 编码风格方面的准则 2. Python 语言方面的准则 2.1 pychecker 2.2 导入模块和包 2.3 完整路径导入 2.4 异常处理 2.5 全局变量 2.6 内嵌/本地/内部类和函数 2.7 List Comprehensions 2.8 默认迭代器和...

    PEP8Python 编码规范

    PEP8是关于Python编码风格的规范,而如何将英文文档转成中文应当是遵循翻译原则和文档规范的问题。所以,正确理解这部分内容应该是:PEP8指导如何书写整洁的Python代码,并且在必要时如何将文档和注释用中文书写,...

    Python程序员必备:《Python编码风格指南【PDF】》(高清.书签.中文版)

    在成为一名专业的Python程序员之前,熟悉并遵守Python编码风格指南是必不可少的。Google开源项目Python风格指南提供了这样一份指南,它详细地介绍了Python语言和风格的规范,从而帮助程序员编写出既规范又高效的代码...

    Python 编码风格指南中译版 Google SOC

    Python编码风格方面,建议避免使用分号,且每行代码的长度控制在最多80个字符以内。圆括号的使用要吝啬,不要过度依赖它们。对于缩进,建议使用两个空格,而不是Tab,这一点与PEP8编码风格指南不同。空行的使用也有...

    Google Python 编码风格指南中译版

    《Google Python 编码风格指南中译版》是Google针对Python编程制定的一套详细编码规范,旨在提升代码的可读性、可维护性和团队协作效率。...总的来说,Google的Python编码风格指南是Python开发者的一个宝贵资源。

    Python_编码风格指南中译版

    ### Python编码风格指南详解 #### 一、Python语言方面的准则 **1.1 Python语言方面的准则** ##### 1.1.1 pychecker Pychecker是一个静态分析工具,用于检查Python代码中的潜在错误。它能够检测出如未定义的变量...

    google的python编码规范.pdf

    本文档是 Google 公司的 Python 编码规范,旨在为 Python 程序员提供一个详细的编码风格指南。该指南涵盖了 Python 语言规则、 Python 风格规则、代码编写风格、注释、类、字符串、TODO 注释、导入格式、语句控制、...

    Python编码规范(Google)

    ### Python编码规范详解(基于Google风格指南) #### 一、概览 Python作为一种广泛使用的高级编程语言,其编码规范对于确保代码的可读性和一致性至关重要。Google作为业界领先的公司之一,发布了一份详细的Python...

    Python-一个高品质编码风格习惯和标准清单列表

    在Python编程领域,保持良好的编码风格和遵循标准是至关重要的,因为这直接影响到代码的可读性、可维护性和团队协作效率。"Python-一个高品质编码风格习惯和标准清单列表"是一个宝贵的资源,旨在帮助开发者形成优秀...

    Python 编码规范(Google) _ 菜鸟教程.pdf

    Python编码规范(Google)是由Google公司所提出的Python编程风格指南,旨在提高代码的可读性和一致性。这个规范并非由Google官方直接创建和维护的项目,而是由国内程序员基于对Google风格的喜爱而创建和维护。本文档...

    PEP8 Python编码规范

    在实际编程中,PEP8为开发者提供了一套标准的编码风格,有助于统一团队成员之间的代码风格,提高代码的可读性和可维护性。遵循PEP8规范,使得代码更加规范,也更容易被其他开发者理解和协作。 需要注意的是,尽管...

    python编码规范

    ### Python编码规范详解 #### 一、引言 在Python编程的世界里,遵循一定的编码规范不仅能够提升代码的可读性和可维护性,还能帮助开发者更好地融入社区,提高团队协作效率。本文旨在介绍Python官方推荐的编码规范...

    PEP8Python编码规范.pdf

    PEP8 规定新编代码必须按下面命名风格进行,现有库的编码尽量保持风格。尽量单独使用小写字母 'l',大写字母 'O' 等容易混淆的字母。模块命名尽量短小,使用全部小写的方式,可以使用下划线。包命名尽量短小,使用...

    Python常用类库.docx

    - *Python编码风格*: Python社区官方推荐的编码风格指南,有助于开发者遵循统一规范。 ### 编码风格指南 - **官方建议**: Python社区官方推荐的编码风格(可参考中文译文)。 - **Google风格指南**: Google提出的...

    Python开发编码规范

    以下是关于Python编码规范的一些关键点: 1. **命名规则**: - 变量、函数、类名应使用小写字母和下划线组合,如`my_variable`,`function_name`,` MyClass`。 - 常量应全大写,单词间用下划线分隔,如`MY_...

    python编码规范.doc

    Python编码规范是编程实践中至关重要的一个方面,它不仅关乎代码的可读性和一致性,也直接影响到团队合作的效率。以下是一些主要的Python编码规范点: 1. **行尾无分号**:Python代码行尾不需要分号来结束语句,这...

    Python Indent插件

    2. 智能对齐:如果你的代码缩进不一致,Python Indent可以帮你快速调整选中行的缩进,使其符合PEP8(Python Enhancement Proposals 8,官方推荐的Python编码风格指南)标准。 3. 代码块折叠:插件支持代码块的折叠...

    python编码规范.pdf

    ### Python编码规范详解 #### 1. 介绍 ##### 1.1 开发背景 Python作为一门高级编程语言,因其简洁、易读的语法而受到广大开发者们的喜爱。随着Python在自动化测试领域的广泛应用,制定一套统一的编码规范变得尤为...

Global site tag (gtag.js) - Google Analytics