学习内容:Python基础入门知识-代码编写规范
学习专栏:① - 零基础入门篇_不渴望力量的哈士奇的博客-优快云博客
声明:本文内容大部分为引用,是在学习过程中复制的大佬的文章,仅供学习使用,仅作为笔记参考。
笔记目录
目录
📣 Python学习笔记
首先我们要知道 Python 采用的是 PEP 8
作为编码规范,其中PEP 是Python Enhancement Proposal (Python 增强建议书) 的缩写,8 代表的是 Python 代码的样式指南。
🧭 头部注释
-
头部注释(声明编码格式)几乎在主流的编程语言脚本中是必需的。
-
在 Python 中如果没有头部注释,Python解释默认会使用 ASCII 编码格式。这就会造成一个问题,比如我们国内使用的是中文,一旦出现中文字符(中文字符属于 UTF-8 编码格式)Python 解释器就会报错。
一般情况下,我们会在Python文件的开头写上以下这两行:
# !/usr/bin/env python
# -*- coding:utf-8 -*-
第一行注释是为了提醒Linux/os X 系统这是一个Python文件,根据usr/bin/env路径去找python的运行程序来运行。如果Windows系统看到这个注释会主动忽略。
第二行注释是为了告诉Python解释器,按照UTF-8编码读取源代码,否则,你在源代码中写的中文输出可能会有乱码。
现在一般情况下会直接写一行:
# coding:utf-8
Python头部注释主要是为了告诉运行系统或者解释器一些内容,和接下来的代码主体没有关系。
- 国内常用
# coding:utf-8
:定义coding
规则告诉系统脚本是何种编码格式 - 目前很少使用
# !/usr/bin/env python
:定义python
解释器的指定执行路径 [WIN系统不生效]
🧭 缩进规则
if 2 > 1:
print('2 > 1 is true')
# 该两行代码的意思为 "如果 2 大于 1 ,则打印输出 '2 > 1 is true' "
在 Python 中,可以使用 TAB 或者空格作为缩进,大部分代码规范建议使用 4 个空格作为缩进。
如果不使用缩进:
if 2 > 1:
print('2 > 1 is true')
else:
print('2 > 1 is false')
print('End')
看起来代码乱糟糟的,并且梳理代码逻辑时也会很不方便,脑瓜子嗡嗡的
如果使用缩进:
if 2 > 1:
print('2 > 1 is true')
else:
print('2 > 1 is false')
print('End')
层次分明,结构比较清晰。代码读起来也更舒服(可读性比较高)。
⭐ 💡必须使用缩进的场景
Python 语言要求在需要表达代码层次关系的场景中,必须使用缩进。如果不使用缩进,程序运行时则会报告错误。包括再是有pycharm时,如果缩进不规范也会有警告。
(学习Python之前就听说过有人用尺子量Python的缩进,我还以为是个段子)
if 2 > 1:
print('2 > 1 is true')
# 执行结果如下
# >>> print('2 > 1 is true')
^
# >>> IndentationError: expected an indented block
🧭 注释
💡 最烦两种人,一种是写代码不写注释的人,一种是让我写注释的人。(doge)
写注释的好处有两个:①、记录自己的思路,防止后续看不懂。好记性不如烂笔头;②、记录自己的思路,如果是多人协同项目,让别人能看懂自己写的啥。
⭐ 单行注释
# 首先定义变量 name
name = 'Neo'
# 将变量 name 修改为 'Jack'
name = 'Jack'
第一行和第四行中的"#"是注释的开始,表示这一行的后面的内容都是注释内容。
在执行该程序的时候,会自动忽略注释和空行。
⭐ 多行注释
多行注释用三个单引号 ' ' ' 或者三个双引号 “ ” " 将注释括起来。
'''
# 首先定义变量 name
# 将变量 name 修改为 'Jack'
name = 'Neo'
name = 'Jack'
'''
"""
# 首先定义变量 name
# 将变量 name 修改为 'Jack'
name = 'Neo'
name = 'Jack'
"""
'''
————————————————
版权声明:本文为优快云博主「不渴望力量的哈士奇」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.youkuaiyun.com/weixin_42250835/article/details/123031042
'''
⭐ 注释可以帮助调试程序
这事儿我经常干,如果想要知道这句代码是否有问题,只需要将这句代码注释掉,再运行程序,看看是否有问题。如果程序可以正常执行,则可以说明错误就是由这段代码引起的;反之,如果依然出现相同的错误,则可以说明错误不是由这段代码引起的。
这种做法可以缩小排错范围。提升写代码效率。
🧭 空格的使用
空格的使用原则如下:
①、在二元运算符的两边各一个格,算术操作符两边的空格可灵活使用,但两侧要保持一致
②、不在逗号、分号、冒号的前面加空格,但可以在它们的后面加空格(行尾的特殊情况除外)
③、函数的参数列表中,逗号后面要有空格
④、函数的参数列表中,默认值等于号左右两边不要添加空格
⑤、左括号之后,右括号之前不要加添加空格
⑥、参数列表, 索引或切片的左括号之前不能加空格通常情况下,在运算符两侧、函数参数之间以及逗号两侧,都建议使用空格进行分隔。
版权声明:本文为优快云博主「不渴望力量的哈士奇」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.youkuaiyun.com/weixin_42250835/article/details/123031042
🧭 空行规则
①、编码格式声明、模块导入、常量和全局变量声明、顶级定义和执行代码之间空两行
②、类和顶层函数定义之间空两行;类中的方法定义之间空一行;
③、函数内逻辑无关段落之间空一行;
④、在函数或方法内部,可以在必要的地方空一行以增强节奏感,但应避免连续空行
⑤、其他地方尽量不要再空行。
————————————————
版权声明:本文为优快云博主「不渴望力量的哈士奇」的原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.youkuaiyun.com/weixin_42250835/article/details/123031042
合理的使用空行可以增加代码的可读性和美观性。在后期排除bug或者修改代码逻辑时也会很方便。
🧭 模块导入规则
导入语句放到整个Python文件的顶部,这是很多语言通用的规则,如:Node.js、TypeScript等。
同时应当注意导入语句应当放到模块注释和文档字符串之后。模块、全局变量、常量之前。
应该按照从最通用到最不通用的顺序进行排序,分组之间应该空出一行
标准库导入
第三方库导入
应用程序指定导入
💡 注意:每个import语句只导入一个模块,尽量避免同时导入多个模块。
🧭 变量命名规范
变量是Python用来存储某些运算的结果。变量的存取通过变量名对变量所占用的内存空间进行访问与操作。
Python命名建议遵循的命名规范:
①、变量名尽量小写, 如有多个单词,用下划线隔开
②、常量采用全大写,如有多个单词,使用下划线隔开
③、函数名一律小写,如有多个单词,用下划线隔开
④、私有函数可用一个下划线开头
⑤、类名使用驼峰命名法,首字母大写,私有类可用一个下划线开头
⑥、模块尽量使用小写命名,首字母保持小写,能不使用下划线尽量不要用下划线
# 合法变量名举例
name = 'zs'
age_now = 18
money = 1800.03
SEX = '男'
NATION_CHINA = '汉族'
_last_name = 'ls'
# 不合法变量名
# last$name 变量名中含有$符
# 00name 数字开头的变量名不符合规范
# ab\c 含有特殊符号\,并且该变量名毫无意义
🌞长风破浪会有时,直挂云帆济沧海。🌞