iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > Python >Google实践中总结的Python规范
  • 787
分享到

Google实践中总结的Python规范

实践中GooglePython 2023-01-31 00:01:18 787人浏览 薄情痞子

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

摘要

好的代码风格,给人舒服的感觉,今天介绍一下谷歌的python风格规范 1 分号 不要在行尾加分号, 也不要用分号将两条命令放在同一行。 2 行长度 每行不超过80个字符;不要使用反斜杠连接行。Python会将圆括号、中括号和花括号的行隐式

好的代码风格,给人舒服的感觉,今天介绍一下谷歌的python风格规范

1 分号

不要在行尾加分号, 也不要用分号将两条命令放在同一行。

2 行长度

每行不超过80个字符;不要使用反斜杠连接行。Python会将圆括号、中括号和花括号的行隐式的连接起来,可以利用这个特点。如果需要,可以在表达式外围增加一堆额外的圆括号。

3 括号

宁缺毋滥得使用括号。除非是用于实现行连接,否则不要在返回语句或条件语句中使用括号。不过在元组两遍使用括号是可以的。

4 缩进

用四个空格来缩进代码。绝对不要用tab,也不要tab和空格混用。对于行连接的情况,应该垂直对其换行的元素,或者使用4空格的悬挂式缩进:

5 空行

顶级定义(比如函数或者类定义)之间空两行,方法定义之间空一行。

6 空格

按照标准的排版规范来使用标点两边的空格。

括号内不要有空格。

不要在逗号,分号,冒号前面加空格,但应该在它们后面加(除了在行尾)。

参数列表, 索引或切片的左括号前不应加空格。

在二元操作符两边都加上一个空格, 比如赋值(=), 比较(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布尔(and, or, not)。至于算术操作符两边的空格该如何使用, 需要你自己好好判断。不过两侧务必要保持一致。

当’=’用于指示关键字参数或默认参数值时, 不要在其两侧使用空格。

不要用空格来垂直对齐多行间的标记, 因为这会成为维护的负担(适用于:, #, =等):

7 Shebang

大部分.py文件不必以#!作为文件的开始. 根据 PEP-394, 程序的main文件应该以 #!/usr/bin/python2或者 #!/usr/bin/python3开始。在计算机科学中,Shebang(也称为 Hashbang )是一个由井号和叹号构成的字符序列 #! ,其出现在文本文件的第一行的前两个字符。在文件中存在 Shebang 的情况下,类 Unix 操作系统的程序载入器会分析 Shebang 后的内容,将这些内容作为解释器指令,并调用该指令,并将载有 Shebang 的文件路径作为该解释器的参数。

8 注释

确保对模块, 函数, 方法和行内注释使用正确的风格。

文档字符串

Python有一种独一无二的的注释方式:使用文档字符串。文档字符串是包, 模块, 类或函数里的第一个语句。这些字符串可以通过对象的doc成员被自动提取,并且被pydoc所用。我们对文档字符串的惯例是使用三重双引号。一个文档字符串应该这样组织:首先是一行以句号、问号或惊叹号结尾的概述(或者该文档字符串单纯只有一行)、 接着是一个空行, 接着是文档字符串剩下的部分,它应该与文档字符串的第一行的第一个引号对齐。下面有更多文档字符串的格式化规范。

模块

每个文件应该包含一个许可样板。根据项目使用的许可(例如:Apache 2.0,,BSD,LGPL, GPL), 选择合适的样板。

函数和方法

一个函数必须要有文档字符串, 除非它满足以下条件:

文档字符串应该包含函数做什么,以及输入和输出的详细描述。通常, 不应该描述”怎么做”,除非是一些复杂的算法。文档字符串应该提供足够的信息, 当别人编写代码调用该函数时,他不需要看一行代码,只要看文档字符串就可以了。对于复杂的代码, 在代码旁边加注释会比使用文档字符串更有意义。

类应该在其定义下有一个用于描述该类的文档字符串。如果你的类有公共属性(Attributes),那么文档中应该有一个属性(Attributes)段。并且应该遵守和函数参数相同的格式。

块注释和行注释

最需要写注释的是代码中那些技巧性的部分。如果你在下次 代码审查的时候必须解释一下,那么你应该现在就给它写注释。对于复杂的操作, 应该在其操作开始前写上若干行注释。对于不是一目了然的代码,应在其行尾添加注释。

9 类

如果一个类不继承自其它类, 就显式的从object继承. 嵌套类也一样。继承自 object 是为了使属性(properties)正常工作, 并且这样可以保护你的代码, 使其不受 PEP-3000的一个特殊的潜在不兼容性影响。这样做也定义了一些特殊的方法, 这些方法实现了对象的默认语义, 包括 __new__, __init__, __delattr__, __getattribute__, __setattr__, __hash__, __repr__, and __str__ 。

--结束END--

本文标题: Google实践中总结的Python规范

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

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

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • Google实践中总结的Python规范
    好的代码风格,给人舒服的感觉,今天介绍一下谷歌的Python风格规范 1 分号 不要在行尾加分号, 也不要用分号将两条命令放在同一行。 2 行长度 每行不超过80个字符;不要使用反斜杠连接行。Python会将圆括号、中括号和花括号的行隐式...
    99+
    2023-01-31
    实践中 Google Python
  • python基础之编码规范总结
    目录一、PEP 8规范二、缩进三、行的最大长度四、空行五、命名约定六、字符串引号七、包八、注释一、PEP 8规范 官方文档:https://legacy.python.org/dev...
    99+
    2024-04-02
  • 基于Google的Python编码规范标准
    目录Python 风格规范(Google)分号行长度括号缩进空行空格Python 风格规范(Google) 本项目并非 Google 官方项目, 而是由国内程序员凭热情创建和维护。 ...
    99+
    2024-04-02
  • React文件名和目录规范最佳实践记录(总结篇)
    目录文件类型处理index文件规范类型文件夹特性文件夹大驼峰命名烧烤串命名React在使用时非常灵活,如果没有一个规范约束项目,在开发过程中会非常混乱,本文将介绍几个优秀的规范。 文...
    99+
    2024-04-02
  • 【Python实践-6】将不规范的英文名
    1 #利用map()函数,把用户输入的不规范的英文名字,变为首字母大写,其他小写的规范名字。 2 def f1(s): 3 s=s.capitalize() 4 return s 5 list1= ['adam', 'L...
    99+
    2023-01-31
    将不 英文名 Python
  • 自己总结的数据库设计规范
    总体方向思维1.数据架构和容量规划相关    a.总数据量的预估,一年或两年为期限,直接影响硬盘容量规划    b.是否关联其他数据库和环境,关联...
    99+
    2024-04-02
  • uniapp开发小程序的开发规范总结
    目录一、项目结构二、开发规范遵循Vue 单文件组件 (SFC) 规范组件及接口规范三、css样式规范全局样式与局部样式尺寸响应式字体的使用请使用flex布局方式总结一、项目结构 在完...
    99+
    2024-04-02
  • PSR2和PSR4规范在Symfony框架中的应用实践
    引言:Symfony是一个受欢迎且广泛应用的PHP框架,它提供了许多方便的功能和工具来加速开发过程。为了保持代码的可读性和一致性,Symfony框架鼓励开发者遵循规范。本文将着重介绍PSR2和PSR4规范在Symfony框架中的应用实践,并...
    99+
    2023-10-21
    Symfony框架 应用实践 PSR规范
  • 实践中的Go语言注释编码规范建议
    实践中的Go语言注释编码规范建议 在编写Go语言程序时,良好的注释编码规范是非常重要的。适当的注释可以帮助其他开发者更快速地理解代码逻辑,提高代码的可读性和可维护性。本文将介绍一些在实...
    99+
    2024-04-02
  • PHP方法的命名规范与最佳实践
    PHP方法的命名规范与最佳实践 作为一种流行的服务器端脚本语言,PHP被广泛用于开发网站和Web应用程序。在PHP开发中,方法(函数)是非常重要的一部分,良好的命名规范和最佳实践能够提...
    99+
    2024-02-29
    最佳实践 命名规范 php方法
  • PSR2和PSR4规范在CodeIgniter开发中的推广与实践
    引言:在CodeIgniter开发过程中,遵循编码规范是一个重要的方面。其中,PSR2和PSR4规范是PHP社区中广泛采用的标准,有助于统一代码风格、提高团队协作效率。本文将介绍如何在CodeIgniter项目中推广和实践这两个规范,并提供...
    99+
    2023-10-21
    CodeIgniter 关键词:PSR PSR
  • PHP Session 跨域的编码规范与最佳实践
    引言:跨域问题在现代 Web 开发中非常常见,特别是在使用 Ajax 技术进行前后端交互时。PHP 作为一种流行的服务器端脚本语言,在处理跨域问题上也有一套成熟的解决方案。本文将介绍 PHP 中 Session 跨域的编码规范与最佳实践,并...
    99+
    2023-10-21
    session 关键词:PHP 跨域编码
  • PSR2与PSR4规范的项目实践经验分享
    前言在现代软件开发中,遵循统一的编码规范是非常重要的,它可以提高代码的可读性和可维护性,减少团队合作中的摩擦。PHP-FIG(PHP Framework Interop Group)制定了一系列的PSR规范,其中最为广为人知的就是PSR2和...
    99+
    2023-10-21
    PSR规范 项目实践经验分享
  • TypeScript在React项目中的使用实践总结
    序言 本文会侧重于TypeScript(以下简称TS)在项目中与React的结合使用情况,而非TS的基本概念。关于TS的类型查看可以使用在线TS工具👉TypeScri...
    99+
    2024-04-02
  • 关于Python中的编码规范
    目录编码规范1、分号2、命名3、行长度4、缩进5、空行6、空格7、类8、块注释和行注释9、字符串10、导包【总结】1.命名2.空白3.语句4.注释编码规范 Python 编码规范重要...
    99+
    2023-05-15
    Python规范 Python编码规范
  • PSR2和PSR4规范在CakePHP框架中的应用实践与推广
    引言:现如今,大多数开发者在开发PHP应用程序时都希望能够遵循一定的编码规范,以提高代码的可读性和可维护性。而PHP-FIG(PHP Framework Interop Group)提出的PSR2和PSR4便是PHP开发者们广泛采用的编码规...
    99+
    2023-10-21
    应用 规范 推广
  • 【小程序专栏】总结uniapp开发小程序的开发规范
    文章目录 一、项目结构二、开发规范遵循Vue 单文件组件 (SFC) 规范组件及接口规范 三、css样式规范全局样式与局部样式尺寸响应式字体的使用请使用flex布局方式 一...
    99+
    2023-09-09
    小程序 vue.js javascript uniapp
  • Python中的编码规范有哪些
    这篇“Python中的编码规范有哪些”文章的知识点大部分人都不太理解,所以小编给大家总结了以下内容,内容详细,步骤清晰,具有一定的借鉴价值,希望大家阅读完这篇文章能有所收获,下面我们一起来看看这篇“Python中的编码规范有哪些”文章吧。编...
    99+
    2023-07-06
  • MongoDB在大规模数据存储与索引优化方面的实践总结
    MongoDB是一款流行的NoSQL数据库,适用于大规模数据存储和处理。本文将总结在大规模数据存储和索引优化方面的MongoDB实践经验。首先,大规模数据存储方面,MongoDB提供了可扩展性和高性能的解决方案。在存储方面,我们可以采用分片...
    99+
    2023-11-02
    MongoDB 索引优化 大规模数据存储
  • javascript原型链图解的总结和实践
    目录原型链我们可以基于原型链来实现一个简易的JQuery库总结 原型链 在ES6中引入了class关键字,但是JS依然是基于原型的,class实际上是语法糖。 举个例子,有一个pe...
    99+
    2024-04-02
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作