1、命名规范

文件名命名规则:

在Python中,自定义py文件名规则需要遵循以下几个原则:

  1. 使用有意义的文件名:命名应该能够清晰地描述文件的目的或内容。
  2. 使用下划线(_)或小驼峰命名法(即首字母小写,单词之间用大写字母或下划线分隔),以提高可读性。例如,my_script.py或myScript.py。
  3. 避免与Python内置模块名相同:为了避免与Python内置模块名冲突,尽量不要使用与内置模块相同的文件名。
  4. 保持简洁:尽量保持文件名简洁,避免过长的文件名,以便于记忆和书写。

包名:小写英文单词,尽量不要用下划线(除非多个单词,且数量不多的情况)

mypackage
my_package

模块名:小写英文单词,尽量不要用下划线(除非多个单词,且数量不多的情况)

import decoder
import html_parser

类名:遵循驼峰命名法

一个单词的时候首字母大写(大驼峰命名法)。

多个单词的时候,第一个首字母小写,其他单词首字母大写(小驼峰命名法)。

类的命名通常与其所在的文件名一致。当只有一个类的时候,类名要跟文件名一致。

class Car:
    # 类的定义

class myCar:
    # 类的定义

函数名:小写英文单词,如有多个单词,用下划线隔开

def run():
        pass
     
def run_with_env():
        pass

变量名:

Python语言中变量命名规则如下:

  1. 变量名只能包含字母、数字和下划线(_),不能包含这 3 种字符之外的其他字符(如空格、%、-、*、/ 等)。
  2. 变量名不能以数字开头,第一个字符必须是英文字母或下划线。
  3. 变量名区分大小写。
  4. 变量名不能是 Python 关键字(又称关键词)。
  5. 变量名应该具有描述性,以便代码可读性。

常量名:

大写英文单词,如有多个单词,用下划线隔开,如MAX_NUM、PI等。

另外,还有一些需要注意的点:

  • 尽量用有意义的英文单词或缩写来命名,而不要使用拼音、中文或其他语言的单词。
  • 避免使用Python关键字和内置函数名作为命名,如if、for、print等。
  • 尽量遵守一致性原则,在代码中命名时保持风格统一,使程序规范易读易维护。

总之,良好的命名规范对于编写高质量的Python代码是非常重要的。

2、缩进

在Python中,缩进是一种语法规则。它用于定义代码块的范围,缩进通常用4个空格来表示。正确的缩进方式可以让你的代码更易读和清晰。编写代码的时候要严格遵守缩进,如果缩进不正确,则代码可能会导致语法错误。

好的,以下是一个简单的例子来介绍Python缩进的使用:

x = 10
y = 20

if x > y:
    print("x is greater than y")
else:
    print("y is greater than or equal to x")

print("End of program")

在上面的代码中,第4行和第6行的语句都是if语句的一部分,因此它们必须缩进以便于Python解释器理解代码。如果在第4行或者第6行之后忘记缩进,则会产生语法错误。

特别需要注意的是,在 Python 中空格和制表符(\t)并不等价,建议使用四个空格代替制表符进行缩进,这样可以更容易地避免混淆。

需要记住的是,在Python中缩进既是程序结构、逻辑的表现,也可以认为是Python语言独有的特色。因此,正确的缩进对程序结构的清晰和代码阅读体验至关重要。

3、换行

Python 提供了多种方式来实现代码的换行操作。以下是几个常见的方法:

(1)使用反斜杠(\)进行换行

反斜杠可以用于在一行中编写较长的语句或字符串,从而使代码更加易读。例如:

message = "Hello, World! " \
          "This is a long message that continues on the next line."

print(message)

在上面的代码中,使用了反斜杠实现了 message 字符串的换行,以便于在一行中编写较长的字符串。注意,两行字符串之间没有空格。

(2)用圆括号、方括号或花括号包裹代码,Python 会隐式地将其视为多行语句。

例如,在列表或字典中写入多项时可以如下编写:

my_list = [
    "item1",
    "item2",
    "item3"
]

my_dict = {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
}

(3)使用三引号(''' 或 """)来表示多行字符串

使用三引号可以在字符串中包含多行文本,例如:

long_message = '''This is a very long message
that spans across multiple lines.
It contains multiple sentences and
uses punctuation as well.'''

print(long_message)

4、注释

在 Python 中,注释是用来解释代码的功能以及提高代码可读性的。Python 有两种注释方式:

(1)单行注释

在一行代码后面添加 `#` 号表示单行注释,将 `#` 后面的内容视为注释,Python 解释器会自动忽略这些内容。例如:

# This is a single line comment

print("Hello, world!")

(2)多行注释

多行注释可以使用三个引号(''' 或 """)来创建一个跨越多行的注释块。多行注释一般用于注释模块、函数或类。例如:

'''
This is a 
multi-line 
comment
'''

def my_function():
    """
    This is also a multi-line comment.
    It explains the purpose of this function.
    """
    print("Hello, world!")

需要注意的是,在单引号和双引号中可以放入任意文本作为字符串数据类型,而三引号用于行内注释时是多行字符串字面值。所以如果在函数定义时使用三引号注释,那么该注释还有一个特殊的含义:Python 解释器会将其视为该函数的帮助文档,也称为 "docstring"。

因此,在编写代码时,注释应当详尽地描述代码的功能和目的,同时遵循良好的注释规范,以提高代码的可读性和可维护性。

5、print函数

在 Python 中,`print()` 函数用于将一个或多个值打印(输出)到终端(命令行窗口)上。`print()` 函数可以接受零个或多个参数,每个参数之间用逗号隔开。

以下是 `print()` 函数的语法:

print(*objects, sep=' ', end='\n', file=sys.stdout, flush=False)

其中,

- `objects`:要打印的对象,可以是数字、字符串、变量等。
- `sep`:要使用的分隔符,默认为一个空格。
- `end`:打印结束后要添加的字符,默认为换行符 `\n` 。
- `file`:输出目标文件流,默认为标准输出流(sys.stdout),即终端窗口。
- `flush`:是否强制刷新输出缓冲区,默认为 False。

以下是 `print()` 函数的示例使用方法:

# 输出字符串
print("hello world")               # 输出:hello world
print("hello", "world")            # 输出:hello world
print("hello", "world", sep=", ")  # 输出:hello, world

# 输出数字和计算结果
a = 3
b = 4
print(a + b)  # 输出:7

# 输出变量的值
name = "Tom"
print("My name is", name)          # 输出:My name is Tom

# 覆盖默认的行末操作
print("hello", end=" ")
print("world")                     # 输出:hello world

需要注意的是,在 Python 2.x 版本中,`print` 是一个语句而非函数,用法略有不同。在 Python 3.x 版本中,为了与其他的函数保持一致,`print()` 被定义为一个函数,并需要使用括号将参数括起来。

 6、标识符

在Python中,标识符是指用来表示变量、函数、类或其他对象的名称。标识符可以包含英文字母、数字和下划线(_),但必须遵守以下命名规则:

  • - 标识符不能以数字开头;
  • - 标识符只能包含字母、数字和下划线(_);
  • - 标识符区分大小写,即`apple`和`Apple`是两个不同的标识符;
  • - 标识符应该具有描述性,更好地反映变量、函数、类或其他对象的用途。

通常情况下,为了使代码易读易懂,我们应该尽可能使用有意义的标识符来命名变量、函数、类或其他对象,而不是使用简单的单字符或者无意义的数字组合。

7、关键字

python关键字也叫保留字,是指在Python编程语言中具有特殊用途的标识符,用于表示语言结构和保留字。这些关键字在Python解释器中已经被预定义,并在程序执行过程中有着特殊的含义和作用,不能被用作变量名、函数名或其他标识符名称。

python 关键字区分大小写, if 是关键字,但 IF 就不是关键字。

如果使用 python 中的关键字作为标识符,则解释器会提示“invalid syntax” 的错误信息。

你可以启动python交互式解释器,利用keyword模块来查看保留字:

C:\Users\057776>python
Python 3.8.8 (tags/v3.8.8:024d805, Feb 19 2021, 13:18:16) [MSC v.1928 64 bit (AMD64)] on win32
Type "help", "copyright", "credits" or "license" for more information.
>>> import keyword
>>> keyword.kwlist
['False', 'None', 'True', 'and', 'as', 'assert', 'async', 'await', 'break', 'class', 'continue', 'def', 'del', 'elif', 'else', 'except', 'finally', 'for', 'from', 'global', 'if', 'import', 'in', 'is', 'lambda', 'nonlocal', 'not', 'or', 'pass', 'raise', 'return', 'try', 'while', 'with', 'yield']
>>>

关键字列表如下: 

关键字 描述
and 逻辑运算符,表示“与”关系。两个条件都为True时返回True,否则返回False
not 逻辑运算符,表示“非”关系,将一个条件取反,True变为False,False变为True
or 逻辑运算符,表示“或”关系,两个条件有一个为True时返回True,否则返回False
for 创建 for 循环
while 创建 while 循环
if 写一个条件语句
else 用于条件语句,条件不成立的时候执行
elif 在条件语句中使用,第一个条件不满足时执行,等同于 else if
continue 用于跳过当前循环中的某次迭代,直接进入下一次迭代。
break 跳出循环,用于控制循环语句(如for和while)的执行流程,在条件满足时可以提前终止循环。当break语句被执行时,程序会直接跳出当前循环语句,不再执行循环内剩余的语句,并开始执行循环后面的代码。
try 用于创建一个异常处理块, try...except 语句
except 用于捕获和处理异常
finally 处理异常,无论是否存在异常,都将执行,finally语句通常用于释放资源或进行清理操作,例如关闭文件、数据库连接等。
raise 产生异常
TRUE 布尔值为真
FALSE 布尔值为假
import 导入模块
from 导入模块的特定部分
class 定义类
def 定义函数
return 退出函数并返回值
lambda 创建匿名函数
global 声明全局变量
nonlocal 声明非局部变量
as 起别名,用于为模块、函数或类起别名。
assert 断言,用于在程序中检查一个条件是否为真,如果条件为假,则引发AssertionError异常。
del 删除对象
in 用于检查一个值是否包含在一个序列或映射中。
is 用于检查两个对象是否是同一对象(即具有相同的内存地址)
None 表示 null 值
pass 占位符,什么也不做
with 创建一个上下文管理器,可以自动处理资源分配和释放。通常与文件操作一起使用,以确保在使用完文件后正确地关闭它。
yield 用于定义生成器函数。
async 用于定义异步函数。在异步编程中,可以使用 async 定义协程对象(coroutine),以便在事件循环中执行非阻塞的 I/O 操作。async 函数通常与 await 关键字一起使用,以等待异步操作完成后继续执行代码。
await 用于异步编程中。它用于等待一个协程执行完成并返回结果,类似于同步中的函数调用。在async/await语法中,await通常与async一起使用,将其放在需要等待结果的协程函数调用前面,以便程序可以暂停当前协程,直到该函数返回结果。

8、变量

在Python中,变量是用来存储和引用数据的名称。下面是一些Python变量的基础概念:

1. 变量命名规则:Python变量的命名必须遵循标识符的规则。变量名可以包含字母、数字和下划线(但不能以数字开头),并且区分大小写。变量名应该具有描述性,以提高代码的可读性。

2.变量的命名约定:为了增强代码的可读性,Python有一些变量的命名约定。通常推荐使用小写字母和下划线来命名变量,如 my_variable。对于常量,一般使用全大写字母,如 PI = 3.14159

3. 变量赋值:使用等号(=)将一个值赋给变量。例如:`x = 10` 将整数值10赋给变量x。这样就可以通过变量名x引用这个值。

4. 动态类型:Python是一种动态类型语言,变量的类型是根据所赋予的值来自动推断的。这意味着同一个变量可以在不同的时候引用不同类型的值。例如:`x = 10` 将x的类型推断为整数,然后 `x = "hello"` 将x的类型从整数变为字符串。

5. 变量引用:变量在程序中作为引用存储,并且和其它对象相关联。当我们使用变量时,实际上是在使用变量引用的值。

6. 变量的重新赋值:可以重复给一个变量赋值,改变变量的值。例如:`x = 10`,然后 `x = 20`,此时变量x的值变为20。

7. 变量作用域:变量的作用域指的是变量的有效范围。在不同的作用域内,变量可能有不同的定义和可见性。在函数内部定义的变量具有局部作用域,只能在函数内部访问。而在函数外部定义的变量具有全局作用域,可以在整个代码文件中访问。


reference:

2. 词法分析 — Python 3.8.16 文档

Logo

腾讯云面向开发者汇聚海量精品云计算使用和开发经验,营造开放的云计算技术生态圈。

更多推荐