我的编程空间,编程开发者的网络收藏夹
学习永远不晚

Google实践中总结的Python规范

短信预约 -IT技能 免费直播动态提醒
省份

北京

  • 北京
  • 上海
  • 天津
  • 重庆
  • 河北
  • 山东
  • 辽宁
  • 黑龙江
  • 吉林
  • 甘肃
  • 青海
  • 河南
  • 江苏
  • 湖北
  • 湖南
  • 江西
  • 浙江
  • 广东
  • 云南
  • 福建
  • 海南
  • 山西
  • 四川
  • 陕西
  • 贵州
  • 安徽
  • 广西
  • 内蒙
  • 西藏
  • 新疆
  • 宁夏
  • 兵团
手机号立即预约

请填写图片验证码后获取短信验证码

看不清楚,换张图片

免费获取短信验证码

Google实践中总结的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__ 。

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

Google实践中总结的Python规范

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

下载Word文档

猜你喜欢

Google实践中总结的Python规范

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

【Python实践-6】将不规范的英文名

1 #利用map()函数,把用户输入的不规范的英文名字,变为首字母大写,其他小写的规范名字。2 def f1(s):3 s=s.capitalize()4 return s5 list1= ['adam', 'LISA',
2023-01-31

PSR2和PSR4规范在Symfony框架中的应用实践

引言:Symfony是一个受欢迎且广泛应用的PHP框架,它提供了许多方便的功能和工具来加速开发过程。为了保持代码的可读性和一致性,Symfony框架鼓励开发者遵循规范。本文将着重介绍PSR2和PSR4规范在Symfony框架中的应用实践,并
2023-10-21

PSR2和PSR4规范在CodeIgniter开发中的推广与实践

引言:在CodeIgniter开发过程中,遵循编码规范是一个重要的方面。其中,PSR2和PSR4规范是PHP社区中广泛采用的标准,有助于统一代码风格、提高团队协作效率。本文将介绍如何在CodeIgniter项目中推广和实践这两个规范,并提供
2023-10-21

PSR2和PSR4规范在CakePHP框架中的应用实践与推广

引言:现如今,大多数开发者在开发PHP应用程序时都希望能够遵循一定的编码规范,以提高代码的可读性和可维护性。而PHP-FIG(PHP Framework Interop Group)提出的PSR2和PSR4便是PHP开发者们广泛采用的编码规
2023-10-21

MongoDB在大规模数据存储与索引优化方面的实践总结

MongoDB是一款流行的NoSQL数据库,适用于大规模数据存储和处理。本文将总结在大规模数据存储和索引优化方面的MongoDB实践经验。首先,大规模数据存储方面,MongoDB提供了可扩展性和高性能的解决方案。在存储方面,我们可以采用分片
MongoDB在大规模数据存储与索引优化方面的实践总结
2023-11-02

分布式系统中 Golang 函数的优化实践总结

优化 go 函数以提高分布式系统应用程序的性能,最佳实践包括:利用 go 协程、使用 channels 进行通信、区分并发性和串行性、进行内存优化、进行基准测试和性能分析。分布式系统中 Go 函数的优化实践Golang 函数的优化对于分布
分布式系统中 Golang 函数的优化实践总结
2024-04-19

C++技术中的内存管理:内存管理最佳实践总结

内存管理在 c++++ 中至关重要,遵循最佳实践可避免内存泄漏和数据损坏等问题。这些实践包括:使用智能指针(如 unique_ptr 和 shared_ptr)自动化内存分配和释放。避免使用 new 和 delete,而是使用智能指针替代。
C++技术中的内存管理:内存管理最佳实践总结
2024-05-07

Python实现嵌套列表的7中方法总结

这篇文章主要来给大家讲解一个Python的进阶知识点:如何将一个嵌套的大列表展开形成一个列表。小编提供了7种方法供大家学习参考,希望大家能喜欢
2023-03-03

PHP中灵活配置路由规则的实现方法和经验总结

引言:在Web开发中,路由规则是非常重要的一部分,它决定了URL与具体的PHP脚本的对应关系。在传统的开发方式中,我们通常会在路由文件中配置各种URL规则,然后将URL与对应的脚本路径进行映射。但是,随着项目的复杂度增加和业务需求的变化,如
2023-10-21

Python开发经验总结:提高代码可维护性和可扩展性的实践

Python开发经验总结:提高代码可维护性和可扩展性的实践在软件开发过程中,我们经常会遇到需求变更、功能迭代等情况,因此代码的可维护性和可扩展性成为了开发过程中必须重视的问题。特别是在Python开发中,如何提高代码的可维护性和可扩展性成为
Python开发经验总结:提高代码可维护性和可扩展性的实践
2023-11-22

中小企业对Spring Cloud微服务架构实践经验总结的一些思考

Spring Cloud 在国内中小型公司能用起来吗?从 2016 年初一直到现在,我们在这条路上已经走了一年多。在使用 Spring Cloud 之前,我们对微服务实践是没有太多的体会和经验的。从最初的开源软件云收藏来熟悉 Spring
2023-06-02

2019实用的Python运用技法总结:在两个字典中寻找相同点

2019实用的Python运用技法总结:在两个字典中寻找相同点前言:现在有两个字典,我们想找出它们中间可能相同的地方(相同的键、相同的值)
2023-06-02

数据库压力测试最佳实践:从业界经验中总结的宝贵经验,优化数据库性能

数据库压力测试是确保数据库系统能够承受高负载的必要手段。通过实践经验总结出的最佳实践,可以帮助您优化数据库性能,提高系统稳定性。
数据库压力测试最佳实践:从业界经验中总结的宝贵经验,优化数据库性能
2024-02-22

编程热搜

  • Python 学习之路 - Python
    一、安装Python34Windows在Python官网(https://www.python.org/downloads/)下载安装包并安装。Python的默认安装路径是:C:\Python34配置环境变量:【右键计算机】--》【属性】-
    Python 学习之路 - Python
  • chatgpt的中文全称是什么
    chatgpt的中文全称是生成型预训练变换模型。ChatGPT是什么ChatGPT是美国人工智能研究实验室OpenAI开发的一种全新聊天机器人模型,它能够通过学习和理解人类的语言来进行对话,还能根据聊天的上下文进行互动,并协助人类完成一系列
    chatgpt的中文全称是什么
  • C/C++中extern函数使用详解
  • C/C++可变参数的使用
    可变参数的使用方法远远不止以下几种,不过在C,C++中使用可变参数时要小心,在使用printf()等函数时传入的参数个数一定不能比前面的格式化字符串中的’%’符号个数少,否则会产生访问越界,运气不好的话还会导致程序崩溃
    C/C++可变参数的使用
  • css样式文件该放在哪里
  • php中数组下标必须是连续的吗
  • Python 3 教程
    Python 3 教程 Python 的 3.0 版本,常被称为 Python 3000,或简称 Py3k。相对于 Python 的早期版本,这是一个较大的升级。为了不带入过多的累赘,Python 3.0 在设计的时候没有考虑向下兼容。 Python
    Python 3 教程
  • Python pip包管理
    一、前言    在Python中, 安装第三方模块是通过 setuptools 这个工具完成的。 Python有两个封装了 setuptools的包管理工具: easy_install  和  pip , 目前官方推荐使用 pip。    
    Python pip包管理
  • ubuntu如何重新编译内核
  • 改善Java代码之慎用java动态编译

目录