返回顶部
首页 > 资讯 > 后端开发 > Python >Python编码规范有哪些
  • 720
分享到

Python编码规范有哪些

2023-06-17 15:06:21 720人浏览 八月长安

Python 官方文档:入门教程 => 点击学习

摘要

python编码规范有哪些,针对这个问题,这篇文章详细介绍了相对应的分析和解答,希望可以帮助更多想解决这个问题的小伙伴找到更简单易行的方法。编码在Python编码规范中,所有的 Python 脚本文件都应在文件头标上 # -*- codin

python编码规范有哪些,针对这个问题,这篇文章详细介绍了相对应的分析和解答,希望可以帮助更多想解决这个问题的小伙伴找到更简单易行的方法。

编码

Python编码规范中,所有的 Python 脚本文件都应在文件头标上 # -*- coding:utf-8 -*- 。设置编辑器,默认保存为 utf-8 格式。

注释

业界普遍认同 Python 的注释分为两种的概念,一种是由 # 开头的“真正的”注释,另一种是 docstrings。前者表明为何选择当前实现以及这种实现的原理和难点,后者表明如何使用这个包、模块、类、函数(方法),甚至包括使用示例和单元测试

坚持适当注释原则。对不存在技术难点的代码坚持不注释,对存在技术难点的代码必须注释。但与注释不同,推荐对每一个包、模块、类、函数(方法)写 docstrings,除非代码一目了然,非常简单。

缩进

Python 依赖缩进来确定代码块的层次,行首空白符主要有两种:tab 和空格,但严禁两者混用。如果使用 tab 缩进,设定 tab 为 4 个空格。
公司内部推荐使用 4 个空格的 tab 进行缩进。

空格

空格在 Python 代码中是有意义的,因为 Python 的语法依赖于缩进,在行首的空格称为前导空格。在这一节不讨论前导空格相关的内容,只讨论非前导空格。非前导空格在 Python 代码中没有意义,但适当地加入非前导空格可以增进代码的可读性。

1) 在二元算术、逻辑运算符前后加空格:如 a = b + c;

2) 在一元前缀运算符后不加空格,如 if !flg: pass;

3) “:”用在行尾时前后皆不加空格,如分枝、循环、函数和类定义语言;用在非行尾时两端加空格,如 dict 对象的定义 d = {‘key’ : ’value’}。

4) 括号(含圆括号、方括号和花括号)前后不加空格,如 do_something(arg1, arg2),而不是 do_something( arg1, arg2 );

5) 逗号后面加一个空格,前面不加空格;s

空行

适当的空行有利于增加代码的可读性,加空行可以参考如下几个Python编码规范准则:

1) 在类、函数的定义间加空行;

2) 在 import 不同种类的模块间加工行;

3) 在函数中的逻辑段落间加空行,即把相关的代码紧凑写在一起,作为一个逻辑段落,段落间以空行分隔;

断行

尽管现在的宽屏显示器已经可以单屏显示超过 256 列字符,但本规范仍然坚持行的***长度不得超过 78 个字符的标准。折叠长行的方法有以下几种方法:

1) 为长变量名换一个短名,如:

this.is.a.very.long.variable_name = this.is.another.long.variable_name

应改为:

variable_name1 = this.is.a.very.long.variable_name  variable_name2 = this.is.another.variable_name  variable_name1 = variable_name2s

2) 在括号(包括圆括号、方括号和花括号)内换行,如:

class Edit(CBase):  def __init__(self, parent, width,   font = FONT, color = BLACK, pos = POS, style = 0):

或:

very_very_very_long_variable_name = Edit(parent, \  width, \  font, \  color, \  pos)

如果行长到连***个括号内的参数都放不下,则每个元素都单独占一行:

very_very_very_long_variable_name = ui.widgets.Edit( \  panrent, \  width, \  font, \  color, \  pos)

3) 在长行加入续行符强行断行,断行的位置应在操作符前,且换行后多一个缩进,以使维护人员看代码的时候看到代码行首即可判定这里存在换行,如:

if color == WHITE or color == BLACK \  or color == BLUE: # 注意 or 操作符在新行的行首而不是旧行的行尾  do_something(color);

命名

一致的命名可以给开发人员减少许多麻烦,而恰如其分的命名则可以大幅提高代码的可读性,降低维护成本。

关于Python编码规范有哪些问题的解答就分享到这里了,希望以上内容可以对大家有一定的帮助,如果你还有很多疑惑没有解开,可以关注编程网Python频道了解更多相关知识。

--结束END--

本文标题: Python编码规范有哪些

本文链接: https://lsjlt.com/news/290663.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

猜你喜欢
  • Python编码规范有哪些
    Python编码规范有哪些,针对这个问题,这篇文章详细介绍了相对应的分析和解答,希望可以帮助更多想解决这个问题的小伙伴找到更简单易行的方法。编码在Python编码规范中,所有的 Python 脚本文件都应在文件头标上 # -*- codin...
    99+
    2023-06-17
  • Python基本编码规范有哪些
    这篇“Python基本编码规范有哪些”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“Python基本编码规范有哪些”文章吧。P...
    99+
    2023-06-29
  • Python中的编码规范有哪些
    这篇“Python中的编码规范有哪些”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“Python中的编码规范有哪些”文章吧。编...
    99+
    2023-07-06
  • VB.NET编码规范有哪些
    今天就跟大家聊聊有关VB.NET编码规范有哪些,可能很多人都不太了解,为了让大家更加了解,小编给大家总结了以下内容,希望大家根据这篇文章可以有所收获。一、类型级单位的命名 类。 以Class声明的类,都必须以名词或名词短语命名,体现类的作用...
    99+
    2023-06-17
  • VB.NET有哪些编码规范
    本篇文章为大家展示了VB.NET有哪些编码规范,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。一、类型级单位的命名类。以Class声明的类,都必须以名词或名词短语命名,体现类的作用。如:Class I...
    99+
    2023-06-17
  • Go编码规范有哪些
    本文小编为大家详细介绍“Go编码规范有哪些”,内容详细,步骤清晰,细节处理妥当,希望这篇“Go编码规范有哪些”文章能帮助大家解决疑惑,下面跟着小编的思路慢慢深入,一起来学习新知识吧。1. 代码风格1.1 代码格式代码必须用 gofmt 进行...
    99+
    2023-07-04
  • python编程规范有哪些
    本篇文章为大家展示了python编程规范有哪些,内容简明扼要并且容易理解,绝对能使你眼前一亮,通过这篇文章的详细介绍希望你能有所收获。每个缩进层级使用4个空格。每行最多79个字符。顶层的函数或类的定义之间空两行。采用ASCII或UTF-8编...
    99+
    2023-06-04
  • JavaScript的编码规范有哪些
    本篇文章给大家分享的是有关JavaScript的编码规范有哪些,小编觉得挺实用的,因此分享给大家学习,希望大家阅读完这篇文章后可以有所收获,话不多说,跟着小编一起来看看吧。JavaScript 文件引用Ja...
    99+
    2024-04-02
  • .Net Framework编码规范有哪些
    .Net Framework编码规范有哪些,针对这个问题,这篇文章详细介绍了相对应的分析和解答,希望可以帮助更多想解决这个问题的小伙伴找到更简单易行的方法。.Net Framework编码规范:·委托类型的名称都应该以EventHandle...
    99+
    2023-06-17
  • Kitty-Cloud编码规范有哪些
    本篇文章给大家分享的是有关Kitty-Cloud编码规范有哪些,小编觉得挺实用的,因此分享给大家学习,希望大家阅读完这篇文章后可以有所收获,话不多说,跟着小编一起来看看吧。API 层autoconfigure:自动配置包名,类名以 Auto...
    99+
    2023-06-03
  • XHTML编码基本规范有哪些
    这篇文章主要介绍了XHTML编码基本规范有哪些,具有一定借鉴价值,感兴趣的朋友可以参考下,希望大家阅读完这篇文章之后大有收获,下面让小编带着大家一起了解一下。一、所有的标记都必须要有一个相应的结束标记 &n...
    99+
    2024-04-02
  • HTML/CSS/JS编码规范有哪些
    这篇文章主要讲解了“HTML/CSS/JS编码规范有哪些”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“HTML/CSS/JS编码规范有哪些”吧!一、HTML...
    99+
    2024-04-02
  • C#中有哪些.NetFramework编码规范
    本篇文章给大家分享的是有关C#中有哪些.NetFramework编码规范,小编觉得挺实用的,因此分享给大家学习,希望大家阅读完这篇文章后可以有所收获,话不多说,跟着小编一起来看看吧。.Net Framework中的委托与事件尽管很多范例都能...
    99+
    2023-06-17
  • Java 程序编码规范有哪些
    这篇文章给大家介绍Java 程序编码规范有哪些,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。Java 程序编码的规范(转)[@more@]所有的程序开发手册都包含了各种规则。一些习惯自由程序人员可能对这些规则很不适 应...
    99+
    2023-06-03
  • JavaScript编码规范知识点有哪些
    这篇文章主要介绍“JavaScript编码规范知识点有哪些”,在日常操作中,相信很多人在JavaScript编码规范知识点有哪些问题上存在疑惑,小编查阅了各式资料,整理出简单好用的操作方法,希望对大家解答”...
    99+
    2024-04-02
  • Bootstrap CSS语法编码规范有哪些
    这篇文章主要讲解了“Bootstrap CSS语法编码规范有哪些”,文中的讲解内容简单清晰,易于学习与理解,下面请大家跟着小编的思路慢慢深入,一起来研究和学习“Bootstrap CSS语法编码规范有哪些”...
    99+
    2024-04-02
  • 有哪些前端安全编码规范
    本篇内容主要讲解“有哪些前端安全编码规范”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“有哪些前端安全编码规范”吧!1. 跨站脚本攻击(Cross Sites S...
    99+
    2024-04-02
  • Python 编码规范
    一 代码编排 1 缩进。4个空格的缩进(编辑器都可以完成此功能),不使用Tap,更不能混合使用Tap和空格。 2 每行最大长度79,换行可以使用反斜杠,最好使用圆括号。换行点要在操作符的后边敲回车。 3 类和top-level函数定义之间...
    99+
    2023-01-30
    Python
  • Python编码规范
    标准头部 #!/usr/bin/python 编码 所有的 Python 脚本文件都应在文件头标上 #-*- coding:utf8 -*- 。设置编辑器,默认保存为 utf8 格式。 main函数 应用程序要定义main函数而不要直接写脚...
    99+
    2023-01-31
    Python
  • JavaScript编程语言的编码规范有哪些
    小编给大家分享一下JavaScript编程语言的编码规范有哪些,相信大部分人都还不怎么了解,因此分享这篇文章给大家参考一下,希望大家阅读完这篇文章后大有收获,下面让我们一起去了解一下吧!JavaScript 编码规范建议本文就 JavaSc...
    99+
    2023-06-27
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作