首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

Python代码规范和命名规范

前言 Python 学习之旅,先来看看 Python 的代码规范,让自己先有个意识,而且在往后的学习中慢慢养成习惯 目录 一、简明概述 1、编码 如无特殊情况, 文件一律使用 UTF...= 1 y = 2 long_variable = 3 # 不推荐的写法 x = 1 y = 2 long_variable = 3 5、换行 Python...'blah': do_blah_thing() # 不推荐的写法 if foo == 'blah': do_blash_thing() 6、docstring docstring 的规范中最其本的两点...This module demonstrates documentation as specified by the `Google Python Style Guide`_....""" 文档注释不限于中英文, 但不要中英文混用 文档注释不是越长越好, 通常一两句话能把情况说清楚即可 模块、公有类、公有方法, 能写文档注释的, 应该尽量写文档注释 三、命名规范

1.9K20
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    python代码规范

    不同的人有不同的编程习惯和风格,对于一个团队而言,想要高效的协同开发,遵守一个统一的代码规范是非常重要且必要的。...举个例子,开发和维护数据分析的pipeline可以说的上是生信工程师的日常了,对于这样一个需要长期维护的项目而言,在开发阶段,遵循统一的代码规范,可以将任务拆分,分配给团队的不同人员进行开发,提高效率;...这一切的基础就是统一的代码规范,对于python而言,官方的PEP8规范是使用最广泛,认可度最高的代码规范,文档链接如下 https://www.python.org/dev/peps/pep-0008...在Python中,对于变量名有如下约定 单下划线开头的变量表示模块或者类的私有变量 双下划线开头的变量表示类内私有 双下划线开头,并且双下划线结尾的变量是python的保留变量,比如__all__, 自定义的变量不要采用这样的写法...除了以上几点,PEP8规范还有很多细节,具体的请查看官方文档。

    87410

    Python编程规范

    1,Python编程规范 > 编码 所有的 Python 脚本文件都应在文件头标上 # -*- coding:utf-8 -*- 用于设置编辑器,默认保存为 utf-8 格式。...> 空格 空格在 Python 代码中是有意义的,因为 Python 的语法依赖于缩进,在行首的空格称为前导空格。在这一节不讨论前导空格相关的内容,只讨论非前导空格。...非前导空格在 Python 代码中没有意义,但适当地加入非前导空格可以增进代码的可读性。...不同种类的模块间加空行; 3) 在函数中的逻辑段落间加空行,即把相关的代码紧凑写在一起,作为一个逻辑段落,段落间以空行分隔; > 断行 尽管现在的宽屏显示器已经可以单屏显示超过 256 列字符,但本规范仍然坚持行的最大长度不得超过...ThisIsAClass(object):pass >> 模块 模块名全部小写,对于包内使用的模块,可以加一个下划线前缀,如 module.py _internal_module.py >> 包 包的命名规范与模块相同

    85930

    Python编码规范

    /usr/bin/python 编码 所有的 Python 脚本文件都应在文件头标上 #-*- coding:utf8 -*- 。设置编辑器,默认保存为 utf8 格式。...空格 空格在Python 代码中是有意义的,因为Python的语法依赖于缩进,在行首的空格称为前导空格。...ThisIsAClass(object):      pass  模块 模块名全部小写,对于包内使用的模块,可以加一个下划线前缀,如: module.py  _internal_module.py  包 包的命名规范与模块相同...flg:      pass for i in xrange(10):      print i  其他建议 避免在内存中处理大对象,由于python申请的内存不一定会返还给操作系统(有时会返还给python...内存池) 本文在 《Python编码规范》http://www.cnblogs.com/BoyeeStudio/articles/382882.html的基础上进行补充

    1.1K31

    说说Python编码规范

    这么久没写了,再次拿起键盘,想想,发表些什么呢,想起上次公司的代码评审委员会下周其中一个议题是关于Python编码规范的整理,那就趁热打铁,整理一份关于Python编码规范的文章,也为那些写Python...编码规范的作用 规范故明思义,就是通过不断的总结,吸取好的点,从而形成的一份大家共同需要遵守的行为契约, 网上有很多版本的编码规范,基本上都是遵循 PEP8 的规范。...PEP是 Python Enhancement Proposal 的缩写,简单来说,是python增强建议书的意思。它描述了Python编程风格的方方面面。...在遵守这个文档的条件下,不同程序员编写的Python代码可以保持最大程度的相似风格。 这样就易于阅读,易于在程序员之间交流。 下面就说说Python编码时,应该遵守的编码规范有哪些。...编码需遵守的规范 编码 所有的 Python 脚本文件都应在文件头标上如下标识或其兼容格式的标识: # -- coding:utf-8 -- 分号 不要在行尾加分号, 也不要用分号将两条命令放在同一行。

    69730

    Python编码规范小结

    1.2 语言 基础库采用 python 开发。需要调用的相关二进制工具的地方,为降低开发成本,暂采用直接调该工具,封出 python 方法接口。...1.3 版本 Python 版本较多,为避免上下版本的兼容性问题,开发采用统一版本。 Python 2.6.2/2.7.x 1.4 规范文档 为了方便维护、他人阅读使用,整理出该编码规范文档。...请大家开发时遵循本规范进行更开发。 本文档参考自Guido 的《Python 风格指南》一文. 并从《Barry's style guide》中添加了部分内容,以及我的个人建议。 2....因此存在这样的一个问题:由于不同模块的 lib 库开发人不同,编码规范也可能不同, 整合起来会显得不够“和谐”。还是希望各模块lib 库负责人做相应的修改,尽量“和谐”。 3....代码的布局 3.1 缩进 众所周知,python 是通过缩进来进行代码布局的。使用vi 可以在~/.vimrc 中配置几个空格来代表一个tab,从而来布局 python 函数的缩进。

    32720

    python代码编写规范

    最近两年的工作都是和运维相关,有时运维人员也会写一些python程序,但基本上都没有遵循相应的代码规范,一向粗暴,能用就行,既不考虑可读性也不考虑可维护性,作为一个开发人员有时候看他们写代码就很不舒服,...今天就谈谈python写代码时的一些规范。...python的代码编写基本上都要遵循PEP8的风格。...None 而不是 if not a is None 4.注释 对某些重要的代码块的功能说明,应使用单行注释 对整个模块功能的说明应使用多行注释 对类或函数的功能及使用方法的详细说明应使用文档字符串 python...并发 I/O密集型,像web应用这样的场景应该使用多线程编程 计算密集型,像计算圆周率等场景应该使用多进程编程,尽可能利用多核CPU优势 当然在编写代码时你的某些编辑器如pycharm会帮助你检测代码规范

    71530

    扫码

    添加站长 进交流群

    领取专属 10元无门槛券

    手把手带您无忧上云

    扫码加入开发者社群

    相关资讯

    热门标签

    活动推荐

      运营活动

      活动名称
      广告关闭
      领券