Python编写Strict Com -- 提高代码规范和可维护性

一、Stric Com的介绍

Strict Com是一个用于检查Python代码规范性的工具。它可以检查变量名的命名是否规范、函数的参数以及返回值是否符合预期、注释是否完整等等。使用Stric Com可以大大提高代码的可读性和可维护性。

二、安装与使用

1、安装

pip install strict-com

2、使用

在终端中输入以下命令：

strict-com 检查的目标文件夹或文件

例如：

strict-com src/

将检查src文件夹下的所有Python文件。

三、检查项目

1、变量名

变量名应该有意义，能够表明变量存储的内容。

好的变量名：

total_price = 10.0

不好的变量名：

a = 10.0

2、函数参数和返回值

对于函数，参数和返回值应该有明确的定义。

好的定义：

def calculate_total_price(price_list: List[float]) -> float:
    total_price = sum(price_list)
    return total_price

不好的定义：

def calculate(tp: List[float]) -> float:
    tp = sum(tp)
    return tp

3、注释

注释应该是完整的，并且清晰地解释代码的意图。

好的注释：

if total_price > max_price:
    # 如果总价超出了最大价格，则进行打折
    discount_price = total_price * 0.8
else:
    discount_price = total_price

不好的注释：

if total_price > max_price:
    discount_price = total_price * 0.8 # 打折
else:
    discount_price = total_price

四、实战使用举例

假设有以下代码：

from typing import List

def calculate_price(price_list: List[float]) -> float:
    total_price = sum(price_list)
    if total_price > 100.0:
        discount_price = total_price * 0.8
    else:
        discount_price = total_price
    return discount_price

print(calculate_price([10.0, 20.0, 30.0]))

使用Stric Com检查该代码：

strict-com example.py

检查结果：

example.py:1 - variable name "price_list" should be snake_case
example.py:3 - function argument "price_list" should be snake_case
example.py:3 - function return value should have a type hint
example.py:6 - variable name "discount_price" should be snake_case
example.py:9 - there should be a blank line before this line (comment)
example.py:11 - there should be a blank line before this line (comment)

通过检查结果可以看出，变量名和函数参数应该使用snake_case，函数返回值应该有类型提示，注释的前面应该有空行。修改代码后再次检查，可以确保代码具有良好的规范性。

五、总结

使用Strict Com可以帮助我们更好地遵循规范，提高代码可读性和可维护性。在开发过程中，推荐将Strict Com作为一个规范性检查的工具，纳入工作流程中。

from typing import List

def calculate_total_price(price_list: List[float]) -> float:
    """
    Calculate the total price of a list of prices.

    Args:
        price_list: A list of float type.

    Returns:
        A float indicates the total price.
    """
    total_price = sum(price_list)
    if total_price > 100.0:
        discount_price = total_price * 0.8
    else:
        discount_price = total_price
    return discount_price

print(calculate_total_price([10.0, 20.0, 30.0]))