前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >python编码规范

python编码规范

作者头像
不吃西红柿
发布2022-07-29 09:57:54
5930
发布2022-07-29 09:57:54
举报
文章被收录于专栏:信息技术智库

python的代码编写基本上都要遵循PEP8的风格。

1.命名

  • 函数、变量及属性都应该用小写单词拼写,只见用_连接,不遵循驼峰命名法
  • 类与异常应该首字母大写,不要用_连接
  • 受保护的实例属性,应以单下划线开头
  • 实例的私有属性,应以双下划线开头
  • 模块级别的变量单词都要大写,中间以单下划线隔开
  • 变量要尽可能有意义

2.空白

  • 和语法相关的每一层缩进都用4个空格表示
  • 赋值时等号两边都要有一个空格
  • 每一行所占用的字符数应不超过79,实际操作中应当尽量不让代码编辑器的行滚动条显示出来
  • 在使用函数进行函数式编程时,函数之间要空两行
  • 在类中的函数,函数之间应该空一行
  • 函数与类是同一个级别,则他们之间应该空两行
  • 对于超出每行规定的字符数的长表达式,应当敲回车缩进,通常除了首行其余各行都要在原来的基础上再次缩进4个空格

3.语句

  • 判断变量是否为None、False或True时不要用==,要用is,例如,if a is None
  • import语句应放在句首,导入时要尽量使用绝对导入不要使用相对导入,并且导入时最好指定相应的模块的某一具体功能,例如,from datetime import datetime
  • 模块导入时应根据标准库模块、第三方模块以及自用模块进行分类
  • 检测容器不为空时,应使用if 容器名,例如,lists = [] if lists
  • 采用内联形式的否定词,不要把否定词放在整个表达式的前面,例如,应该if a is not None 而不是 if not a is None

4.注释

  • 对某些重要的代码块的功能说明,应使用单行注释
  • 对整个模块功能的说明应使用多行注释
  • 对类或函数的功能及使用方法的详细说明应使用文档字符串
  • python的注释尽量使用英文

5.并发

  • I/O密集型,像web应用这样的场景应该使用多线程编程
  • 计算密集型,像计算圆周率等场景应该使用多进程编程,尽可能利用多核CPU优势

    当然在编写代码时你的某些编辑器如pycharm会帮助你检测代码规范,只要认真遵循一般不会出什么问题。我们编写代码不仅是要实现某种功能,就尽管它是核心,但是你的代码在以后极有可能会交给别人去维护,所以你写的代码应当尽可能地让人看懂,避免给别人留坑。

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2019-05-30,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 1.命名
  • 2.空白
  • 3.语句
  • 4.注释
  • 5.并发
相关产品与服务
容器服务
腾讯云容器服务(Tencent Kubernetes Engine, TKE)基于原生 kubernetes 提供以容器为核心的、高度可扩展的高性能容器管理服务,覆盖 Serverless、边缘计算、分布式云等多种业务部署场景,业内首创单个集群兼容多种计算节点的容器资源管理模式。同时产品作为云原生 Finops 领先布道者,主导开源项目Crane,全面助力客户实现资源优化、成本控制。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档