首页 > 其他分享 >PEP8代码要求规范

PEP8代码要求规范

时间:2023-04-01 21:23:09浏览次数:39  
标签:__ 分隔 函数 代码 规范 空格 PEP8 字符串 下划线

PEP8代码要求规范:

  1. 缩进:使用4个空格缩进,而不是制表符,以保证缩进的一致性。

  2. 行长限制:每行不超过79个字符。

  3. 空行:需要用两个空行分隔函数和类定义,而函数内可以利用一个空行分隔不同的逻辑代码块。

  4. 函数及注释:在定义函数和类的文档字符串之前留一个空行,注释句子之间使用一个空格分隔。

  5. 命名规范:遵循下划线命名法,即单词全小写,以下划线分隔。

  6. 代码块:if、while、for、try等关键字之后必须跟着一个空格,并保持一致。

  7. 导入顺序及格式:按照从官方库到第三方库再到本地库的顺序编写,组内的库名称按字母顺序排列。

  8. 字符串表达式:采用单引号而非双引号,除非字符串中本身包含单引号,应考虑使用双引号。

  9. 异常的捕获:在定义时应该先加一个空格,而不是连着中括号写。

  10. 类的命名:采用骆驼命名法(CamelCase)风格,其中每个单词的首字母都大写,实例方法第一个参数为(self),类方法第一个参数为(cls)。

  11. 上下文管理器:当一个类可以作为上下文管理器时,应该明确定义__enter__()和__exit__()方法。

  12. 每个文件应该清晰明确地声明版权和许可证。

  13. 变量命名:使用小写字母组成,单词之间以下划线分隔。

  14. 常量命名:使用大写字母组成,单词之间以下划线分隔。

  15. 函数定义:函数名应紧接左括号之后,而参数列表中则应该使用逗号分隔每个参数。

  16. 模块导入:应该在文件头部进行,放在模块注释和文档字符串之后,而任何先于这两者的行则应该是标准的Python注释。

  17. 换行符:Python默认使用\r\n,UNIX/Linux用/n,Mac OS X则用\r。

  18. 注释排版:在分隔符号后,特别是在函数签名中,逗号之前,应该使用空格。

  19. 函数上下文:文档字符串,函数输入的解释,逻辑处理流程,最后才是函数本身的逻辑。

标签:__,分隔,函数,代码,规范,空格,PEP8,字符串,下划线
From: https://www.cnblogs.com/zouzhibin/p/17279405.html

相关文章

  • Eclipse中代码无异常缺编译报红
    Eclipse中代码无异常缺编译报红背景:在Eclipse中,明明代码没有问题,之前编写好的类,重启Eclipse之后就出现编译期间爆红,注释也爆红。解决Window→Preferences→Java→Compiler→Building把Buildpathproblems中的IncompletebuildpathCirculardependencies两个属性从默认......
  • 将本地代码上传至Gitee
    1、将代码和README.md文件放在同一个文件夹下 2、在该文件夹下打开git窗口,并创建本地仓库//初始化本地仓库gitinit//查看本地仓库状态gitstatus 3、将项目提交到仓库gitadd--allgitcommit-m“SwaggerDemo” 4、将代码上传至Gitee//将Gitee上的仓库和......
  • 代码随想录Day17-Leetcode110.平衡二叉树,257. 二叉树的所有路径,404.左叶子之和
    110.平衡二叉树题目链接:https://leetcode.cn/problems/balanced-binary-tree/一个显然但似乎不太高效的方法是:通过递归获取左右子树高度,判断差;然后递归判断左右结点;那么一个显然的改进就是后序遍历/***Definitionforabinarytreenode.*functionTreeNode(val......
  • 代码
    importtimeimportxlrdfrom seleniumimportwebdriverfromselenium.webdriver.common.keysimportKeysimportosimportrequestsimportjsonimportexcelSaveassaveimportrefromselenium.webdriver.common.byimportByfromselenium.webdriver.support.u......
  • AI写代码 GitHub Copilot + Idea 安装和使用教程
    GitHubCopilot是微软与OpenAI共同推出的一款AI编程工具,基于GitHub及其他网站的源代码,根据上文提示为程序员自动编写下文代码,可以极大地提高编写代码的效率。根据已有上下文补全代码根据函数名和参数,生成方法体根据注释自动生成代码代码优化生成测试代码一、GitHubCopil......
  • 3.实现代码提示
    笔记软件在2023/4/112:20:32推送该笔记定义命令(package.json)"activationEvents":[ "onLanguage:soildity" ], "main":"./extension.js","contributes":{"languages":[{"id"......
  • 代码随想录day 32● 122.买卖股票的最佳时机II ● 55. 跳跃游戏 ● 45.跳跃游戏II
    122.买卖股票的最佳时机II给定一个数组,它的第 i个元素是一支给定股票第i天的价格。设计一个算法来计算你所能获取的最大利润。你可以尽可能地完成更多的交易(多次买卖一支股票)。注意:你不能同时参与多笔交易(你必须在再次购买前出售掉之前的股票)。示例1:输入:[7,1,5,3,6......
  • Go语言规范汇总
    统一规范篇合理规划目录本篇主要描述了公司内部同事都必须遵守的一些开发规矩,如统一开发空间,既使用统一的开发工具来保证代码最后的格式的统一,开发中对文件和代码长度的控制,必须经过go语言自带的检测机制等。【原则1.1】合理规划目录,一个目录中只包含一个包(实现一个模块的功能),......
  • PHP 实现 PHP在线代码运行工具
    转载来源https://www.cnblogs.com/XiaoMingBlingBling/p/14651830.html demo源码下载:点击下载  HTML代码(index.html):注:代码编撰区域使用开源项目ACE(Ajax.orgCloud9Editor)实现<!DOCTYPEhtml><htmllang="zh"><head><metacharset="UTF-8......
  • 代码大全 阅读笔记03
    复杂数据类型恰当地对数据进行结构化,可以使程序更简单、更容易理解也更容易维护。可以用表来代替复杂的逻辑结构。当你被程序的复杂逻辑迷惑时,应考虑是否可用查寻表来简化程序。抽象数据类型是降低复杂性的有力武器。它使你可以分层编写程序,而且是从问题域,而不是程序语言细节来编......