一、python 基本操作
1、常见pep8规范:
PEP 8是Python社区普遍采用的一份编码规范,包括代码风格、命名规范、代码布局等方面的约定。遵守PEP 8可以让你的代码更加易读易懂、易于维护,提高代码质量。以下是PEP 8的一些重要规范:
函数和方法的命名
函数和方法的命名应该使用小写字母,单词之间用下划线分隔,以便于阅读和理解。
函数和方法的名称应该是动词或动词短语,以描述函数执行的操作。
类方法的第一个参数应该命名为self,表示实例对象本身。
模块级函数应该使用简洁的、描述性的名字,避免使用单个字符的名称。
示例:
pythonCopy code# 函数名使用小写字母,单词之间用下划线分隔
def calculate_average(numbers_list):
total = sum(numbers_list)
return total / len(numbers_list)
方法名也遵循相同的规则
class Circle:
def calculate_area(self, radius):
return 3.14 * radius ** 2
类的命名
类的命名应该使用驼峰命名法,即每个单词的首字母大写,单词之间无下划线。
类的名称应该是名词或名词短语,以描述类的含义。
示例:
pythonCopy code# 使用驼峰命名法命名类
class BankAccount:
def init(self, balance):
self.balance = balance
def deposit(self, amount):
self.balance += amount
def withdraw(self, amount):
self.balance -= amount
变量的命名
变量的命名应该使用小写字母,单词之间用下划线分隔。大小写敏感。
变量的名称应该是名词或名词短语,以描述变量的含义。
常量应该全部大写,单词之间用下划线分隔。
示例:
pythonCopy code# 使用小写字母和下划线命名变量
total_price = 0
tax_rate = 0.05
常量全部大写,单词之间用下划线分隔
MAX_RETRY_COUNT = 5
空格的使用
在二元操作符两侧应该留出一个空格。
在逗号、冒号、分号前不要加空格,而在它们后面应该加一个空格。
在函数的参数列表、索引和切片的左括号前不应有空格。
示例:
pythonCopy code# 二元操作符两侧应该留出一个空格
x = 10 + 2
在逗号、冒号、分号前不要加空格,而在它们后面应该加一个空格
def calculate_sum(x, y):
return x + y
for i in range(10):
print(i)
在函数的参数列表、索引和切片的左括号前不应有空格
result = calculate_sum(10, 20)
message = "hello world"[0:
代码缩进
缩进应该使用四个空格,而不是制表符。
所有代码块应该缩进,包括if语句、while语句、for循环等。
示例:
pythonCopy code# 使用四个空格进行缩进
def print_names(names_list):
for name in names_list:
if len(name) > 5:
print(name)
else:
print("Name is too short.")
# 所有代码块应该缩进
while True:
print("This is an infinite loop.")
文档字符串
Python中的docstring是用来描述函数、类或模块的文档字符串。PEP 257规范了Python docstring的语义和约定。docstring应该包含以下内容:
- 函数、类或模块的简要描述。
- 函数、类或模块的详细描述。
- 函数、类或模块的参数列表,以及返回值的类型和含义。
docstring应该使用三个双引号"""
或三个单引号'''
括起来,放在函数、类或模块的第一行。如果docstring需要多行,可以在第一行后面使用一个空行,然后在下一行开始写详细描述。如果docstring中包含了代码示例,可以使用代码块来展示,如下所示:
每个函数、方法和类应该包含文档字符串,以解释它们的用途和行为。
文档字符串应该在函数、方法或类的定义行之后紧跟着。
文档字符串应该使用三个引号(""")括起来,而不是两个单引号或双引号。
示例:
pythonCopy codedef calculate_sum(numbers_list):
"""
计算列表中所有数字的总和。
参数:
numbers_list:数字列表
返回值:
总和
Usage:
>>> my_function()
'Hello, World!'
"""
return sum(numbers_list)
导入
导入语句应该在文件顶部,位于模块注释和全局变量之后,函数和类定义之前。
每个导入应该独占一行。
导入语句应该按照标准顺序进行分组,每组之间应该用一个空行分隔。
示例:
pythonCopy code"""
这是一个演示模块
"""
import os
import sys
import numpy as np
import pandas as pd
from my_module import MyClass
这些是PEP 8中的一些重要规范和示例,但并不是全部。遵循这些规范可以使代码更易于阅读、理解和维护
2、pycharm中一键格式化代码:
根据Problems逐一修复