首页 > 编程语言 >python 工匠规范

python 工匠规范

时间:2023-01-19 17:34:52浏览次数:46  
标签:变量 python 工匠 规范 注释 使用 尽量 变量名

最近看了《python工匠》这本关于python的书,虽然只看了第一章关于变量与注释的内容,也有些突如其来的想法。
一直学习如何使用python 去做一些功能,忽略了它本身的一些特性和习惯。
读完了第一章,写下笔记记录下,方便日后也好查阅。

变量名

对于变量的定义从使用角度很简单,但不方便其他人,自己看可能很容,别人阅读会一脸茫然。
所以需要统一规范,方便大家都理解规则,知道这是什么。
1、变量使用小写字母,多个单词使用下划线_隔开:user_id
2、变量名尽量使用英文单词拼接,可方便阅读内容
3、内部使用变量需要在变量名前使用使用下划线:_user
4、全局变量使用全大写字母表示
5、变量名遵循PEP 8原则
6、变量名单词不宜使用太多,尽量简短

注释

注释写好看来也不是一件容易的事情,如何才能让没了解过的人,看到注释就明白呢?
不想大幅度写注释内容,言简意赅又如何做到呢?
1、写明方法的入参类型和场景
2、使用此方法的场景(不清楚这个要不要写)
3、适当的使用空行,也会达到注释或者简明的效果

命名规则

1、类名使用大驼峰命名规则
2、方法名使用蛇形命名规则

注意事项

1、方法参数尽量书写类型

from typing import List,Dict
def Numer(num: List[int])
    pass

2、定义变量尽量与使用方式结合,不需要把定义变量都写在一起
3、尽量减少变量的引用
4、代码组织结构要清晰

标签:变量,python,工匠,规范,注释,使用,尽量,变量名
From: https://www.cnblogs.com/TestingShare/p/17061864.html

相关文章

  • python __getitem__用法
    classA():def__init__(self):self.name={"key":"aaa"}def__getitem__(self,item):returnself.name.get(item)obj=A()print(obj["key"])......
  • python编码
    str类型字符串  byte类型字符串1、两者互相转换通过 str类型通过encode转换成bytes类型bytes类型通过decode转换成str类型2、两者以一种编码方式进行......
  • 多进程 multiprocessing in Python
    Simpleexampleimporttimeimportmultiprocessingstart=time.perf_counter()defdo_something(): print('sleeping1second...') time.sleep(1) print('Done......
  • python操作mysql基础
    importpymysqlconfig={'host':'127.0.0.1','port':3306,'user':'root','password':'root','database':'sys','cursorclass':......
  • Python3.9安装
    一、安装python3.9链接:https://pan.baidu.com/s/1mDkgKt2KSoMrKVxesb76Pg?pwd=ma4n提取码:ma4n--来自百度网盘超级会员V4的分享下载python3.9,然后安装到D盘都是......
  • 多线程threading in Python
    SimpleExample1importtimeimportthreadingstart=time.perf_counter()defdo_something(): print('sleeping1second...') time.sleep(1) print('Doneslee......
  • Python - requests 使用记录
    requests使用简单方法记录importrequestsfromfake_useragentimportUserAgentua=UserAgent()headers={'User-Agent':ua.random#伪装}#......
  • 我的Python程序太慢了。如何加快速度?
    如果你的Python程序太慢,你可以按照下面给出的提示和技巧-抽象化避免过度抽象,尤其是在微小函数或方法的形式下。抽象往往会产生间接性,并迫使解释器工作更多。如果间接寻......
  • (转载)Python中关键词yield怎么用?
    原文:https://stackoverflow.com/questions/231767/what-does-the-yield-keyword-do译文:https://zhuanlan.zhihu.com/p/23276711?refer=passer问题描述:Python中关......
  • Python如何运行程序
    Python如何运行程序Python解释器简介解释器是一种让其他程序运行起来的程序。Python解释器将读取程序,并按照其中的命令执行,得出结果。解释器是代码与机器的计算机硬件......