适合纯文科生的 python 100个知识点实践三Python高级语法 35 代码分析 36 性能优化 37 代码风

本文源自白璽，创自白璽。转载请标注出处。本文参与掘金日新计划【博客搬家】

Python高级语法

35 代码分析

35.1 代码分析的定义

代码分析是指通过工具或方法对代码进行静态或动态的分析，以便发现代码中的问题并优化代码质量和性能。下面是代码分析的一些常用工具和技术以及相应的代码案例：

35.2 代码静态分析工具：Pylint

Pylint是一个开源的Python代码静态分析工具，可以检查代码的语法、语义、规范和风格等方面，发现潜在的问题和错误，并提供相应的建议和修复方案。以下是一个使用Pylint分析代码的示例：

import pylint

def my_func():
    my_var = 1
    return my_var

print(my_func())

使用Pylint进行分析：

$ pylint example.py

************* Module example
example.py:1:0: C0103: Module name "example" doesn't conform to snake_case naming style (invalid-name)
example.py:3:0: C0111: Missing module docstring (missing-docstring)
example.py:3:0: C0103: Constant name "my_var" doesn't conform to UPPER_CASE naming style (invalid-name)
example.py:5:0: C0111: Missing function docstring (missing-docstring)
example.py:5:0: R1705: Unnecessary "else" after "return" (no-else-return)
example.py:5:0: C0103: Function name "my_func" doesn't conform to snake_case naming style (invalid-name)

-----------------------------------
Your code has been rated at -3.33/10

Pylint检测到了代码中的一些问题，并给出了相应的警告和建议。例如，警告C0103指出模块名和函数名的命名不符合Python的命名规范；警告C0111指出缺少了模块和函数的文档字符串；警告R1705指出函数中不需要使用else语句。

35.3 代码性能分析工具：cProfile

cProfile是Python内置的代码性能分析工具，可以帮助开发者找出代码中的性能瓶颈和优化方案。以下是一个使用cProfile分析代码性能的示例：

import cProfile

def fibonacci(n):
    if n <= 2:
        return 1
    else:
        return fibonacci(n-1) + fibonacci(n-2)

cProfile.run('fibonacci(35)')

运行结果如下：

1134903170 function calls (4 primitive calls) in 6.962 seconds

   Ordered by: standard name

   ncalls  tottime  percall  cumtime  percall filename:lineno(function)
1134903168    6.957    0.000    6.957    0.000 example.py:4(fibonacci)
        1    0.005    0.005    6.962    6.962 <string>:1(<module>)
        1    0.000    0.000    6.962    6.962 {built-in method builtins.exec}
        1    0.000    0.000    0.000    0

代码分析是指通过对代码进行静态或动态分析来检查代码中潜在的问题、漏洞或性能瓶颈。常用的代码分析工具包括PyLint、Pyflakes、Flake8、Bandit等。

# example.py

def calculate_sum(a, b):
    """Calculate the sum of two numbers"""
    result = a + b
    return result

if __name__ == '__main__':
    x = 1
    y = 2
    print(calculate_sum(x, y))

使用PyLint对该代码进行分析：

$ pylint example.py
************* Module example
example.py:1:0: C0114: Missing module docstring (missing-module-docstring)
example.py:3:0: C0116: Missing function or method docstring (missing-function-docstring)
example.py:3:0: C0103: Function name "calculate_sum" doesn't conform to snake_case naming style (invalid-name)
example.py:7:4: R1710: Either all return statements in a function should return an expression, or none of them should. (inconsistent-return-statements)
example.py:1:0: C0103: Module name "example" doesn't conform to snake_case naming style (invalid-name)
example.py:10:0: W0612: Unused variable 'x' (unused-variable)
example.py:11:0: W0612: Unused variable 'y' (unused-variable)

------------------------------------
Your code has been rated at 4.29/10

PyLint根据一系列默认的规则对代码进行了分析，并输出了一系列警告和错误信息。其中包括：

缺少模块和函数文档字符串
函数名不符合snake_case命名规范
返回语句不一致
模块名不符合snake_case命名规范
未使用的变量

35.3 代码性能分析工具：Flake8

代码分析工具是Flake8，它可以检查代码风格、语法错误和一些潜在问题。下面是一个使用Flake8进行代码分析的例子：

# example.py

def calculate_sum(a, b):
    result = a + b
    return result

if __name__ == '__main__':
    x = 1
    y = 2
    print(calculate_sum(x, y))

使用Flake8对该代码进行分析：

$ flake8 example.py
example.py:5:14: E225 missing whitespace around operator
example.py:7:1: E302 expected 2 blank lines, found 1
example.py:1:1: E265 block comment should start with '# '
example.py:1:1: E266 too many leading '#' for block comment

Flake8检测到代码中存在缺少空格、错误的注释格式和缩进问题等。同样，开发者可以根据输出的信息来进行代码优化和改进。值得注意的是，代码分析工具并不能完全取代开发者的代码审查和测试工作，它只能作为辅助工具来提高代码的质量和可靠性。开发者需要结合自己的经验和业务需求来进行代码审查和测试。

除了静态代码分析工具，还有一些动态代码分析工具可以帮助开发者对代码进行性能分析和调试。

除了cProfile，还有一些其他的Python性能分析工具，例如py-spy、Pyflame等。这些工具可以帮助开发者找出程序中的瓶颈和性能问题，并进行针对性的优化。

除了代码分析工具，还有一些其他的工具可以帮助开发者更高效地进行软件开发。下面列举一些常用的工具：

版本控制工具：例如Git、SVN等，可以帮助开发者管理代码版本，协同开发和进行代码回滚等操作。
编辑器和集成开发环境（IDE）：例如Visual Studio Code、PyCharm等，可以提供代码补全、语法高亮、自动调试等功能，提高开发效率和代码质量。
包管理工具：例如pip、conda等，可以帮助开发者安装和管理Python第三方库，方便项目开发和部署。
文档生成工具：例如Sphinx、Mkdocs等，可以帮助开发者自动生成项目文档，方便其他开发者理解和使用项目。
虚拟环境管理工具：例如virtualenv、conda等，可以帮助开发者创建和管理Python虚拟环境，避免不同项目之间的库冲突和版本问题。
测试工具：例如unittest、pytest等，可以帮助开发者编写和运行自动化测试，确保代码的质量和可靠性。
持续集成工具：例如Jenkins、Travis CI等，可以帮助开发者自动化构建、测试和部署代码，提高开发效率和项目可靠性。

总之，软件开发过程中需要用到的工具非常多，开发者需要根据自己的需求和项目特点来选择合适的工具，并不断学习和掌握新的工具和技术，以提高自己的开发效率和代码质量。

36 性能优化

36.1 性能优化的定义

性能优化的代码和案例可以有很多种，以下是一些常见的性能优化技巧和对应的示例代码：

36.2 使用生成器表达式代替列表推导式

列表推导式会一次性创建整个列表，而生成器表达式则是逐个生成元素，可以节省内存空间。例如，下面的代码使用列表推导式来生成一个包含10000个整数的列表：

numbers = [i for i in range(10000)]

可以使用生成器表达式来避免一次性创建整个列表：

numbers = (i for i in range(10000))

36.3 尽量避免使用全局变量

全局变量会占用内存空间，并且在多个函数中被频繁调用时会影响程序的性能。可以将全局变量转换为函数参数或者类属性，避免对全局变量的频繁访问。例如，下面的代码使用全局变量来保存程序的配置：

config = {'debug': True, 'log_level': 'INFO'}

def process_data(data):
    if config['debug']:
        print('Processing data...')
    # do something with data

def main():
    data = get_data()
    process_data(data)

可以将配置信息作为函数参数传递，避免使用全局变量：

def process_data(data, debug=False, log_level='INFO'):
    if debug:
        print('Processing data...')
    # do something with data

def main():
    data = get_data()
    config = {'debug': True, 'log_level': 'INFO'}
    process_data(data, **config)

36.4 使用局部变量和常量

在函数中尽量使用局部变量和常量，而不是每次访问时都从全局变量中获取。局部变量和常量会被存储在CPU寄存器或者栈中，访问速度更快。例如，下面的代码每次调用函数时都会从全局变量中获取常量：

import math

def calculate_area(radius):
    return math.pi * radius ** 2

def main():
    r = 10
    print(calculate_area(r))

可以将常量作为函数参数传递，避免从全局变量中获取：

import math

def calculate_area(radius, pi=math.pi):
    return pi * radius ** 2

def main():
    r = 10
    print(calculate_area(r))

36.5 尽量避免重复计算

在需要多次计算相同值时，可以将结果缓存起来，避免重复计算。例如，下面的代码每次调用函数时都需要重新计算阶乘：

def factorial(n):
    if n == 0:
        return 1
    else:
        return n * factorial(n-1)

def main():
    for i in range(10):
        print(factorial(i))

可以使用缓存技术来避免重复计算：

def factorial(n, cache={}):
    if n in cache:

37 代码风格检查

37.1 代码风格检查的定义

代码风格检查是指检查代码是否符合一定的编码规范，如PEP 8等。其中最常用的代码风格检查工具是flake8，它会检查代码中存在的规范性问题并给出相应的提示。

下面是一个示例代码及其对应的flak8检查结果：

# This is an example code with style issues
def calculate_tax(income, tax_rate=0.2):
    income_tax = income * tax_rate
    return income_tax

print(calculate_tax(10000, 0.18))

执行 flake8 example.py，输出：

example.py:1:1: E265 block comment should start with '# '
example.py:3:1: E302 expected 2 blank lines, found 1
example.py:3:18: E231 missing whitespace after ','
example.py:3:24: E231 missing whitespace after ','
example.py:5:1: E305 expected 2 blank lines after function definition, found 1
example.py:5:18: E231 missing whitespace after ','
example.py:5:24: E231 missing whitespace after ','
example.py:7:1: W292 no newline at end of file

以上输出表示该代码存在多项违反PEP 8规范的问题，如：

E265：块注释应该以'# '开始
E302：函数定义应该和其他代码之间有2个空行
E231：逗号后应该有空格
E305：函数定义之后应该有2个空行
W292：文件结尾应该有一个空行

修改后的代码如下：

# This is an example code with style issues fixed
def calculate_tax(income, tax_rate=0.2):
    income_tax = income * tax_rate
    return income_tax


print(calculate_tax(10000, 0.18))

重新执行 flake8 example.py，输出为空，表示该代码已经符合PEP 8规范。

本文是结合ChatGPT的答案总结的知识点，有不足之处请大佬们给出反馈。

适合纯文科生的 python 100个知识点 实践 三