python代码编写规范及注意事项

目录

• 1. 注意

• • 1.1 变量与常量
  • • 解释：
    • 建议的修复：

• 1.2 过多的参数和过多的局部变量

  • • 解决方案
    • • 1. 减少参数的数量
  • 2. 减少局部变量的数量
  • 3. 修改 Pylint 的配置设置
    • 总结

1. 注意

1.1 变量与常量

分析当前遇到的PyLint提示信息。
其中一条提示指出：
在常量名称"file_path5"中发现不符合UPPERCASE命名规范的无效命名问题。

变量：小写 ，如num1 。
常量：大写 ，如MAX_VALUE、FILE_PATH_5等 。

Pylint 警告 C0103: 常量名 "file_path5" 不符合 无效名称 命名风格 (invalid-name) 表示变量 file_path5 不遵循 Python 中常量的命名约定

解释：

命名约定遵循以下原则：在Python中，默认情况下常量采用大写字母命名法，并且各单词间以下划线分隔；这源自于PEP 8的一个通用规范；举例来说，“FILE_PATH”或“MAX_VALUE”这样的名称都是常见的选择。

您的变量：名称为file_path5的变量采用了小写字母以及字母与数字的组合。这可能违反了预期的UPPER_CASE风格，并容易引起混淆难以立刻识别出file_path5作为一个常量。

建议的修复：

为了消除此提示信息（警告），建议将常量命名为满足UPPER_CASE约定的要求。举个例子来说，请您将变量名从 file_path5 修改为 FILE_PATH_5；或者如果不需要数字的话，则可以直接采用 FILE_PATH。

以下是你可以更新代码的方式：

    FILE_PATH_5 = "/path/to/file"
    
    
    python

按照这一约定,你的代码不仅更具可读性和可维护性,并且完全符合Python社区的标准.

1.2 Too many arguments 和 Too many local variables

    def main(df_loc: pd.DataFrame, df_ti: pd.DataFrame, df_ti_matrix: pd.DataFrame, ws_frequency_matrix: pd.DataFrame,
         df_list: List[str], v50_list: List[float], v50_limit: float = 37.5) -> Dict[
    str, Union[str, float, List[float], bool]]:
    
    
    python

在执行pylint代码格式检查的时候，出现了下面的错误：

    terrain_adaptation_cal_ewm.py:638:0: R0913: Too many arguments (7/5) (too-many-arguments)
    terrain_adaptation_cal_ewm.py:638:0: R0914: Too many local variables (17/15) (too-many-locals)
    
    
    python

分析如下：

在上述的代码中，Pylint 报告了两个错误：

R0913: Too many arguments (7/5) (too-many-arguments) ：

• 这个警告表明函数 main 的参数数量超出了Pylint默认设置（5个参数）。这可能导致Python程序中的函数变得难以理解和使用，并且复杂性显著增加。

R0914: Too many local variables (17/15) (too-many-locals) ：

该警告表明函数 main 中定义的局部变量数目超出了 Pylint 的默认设置（15 个局部变量）。由于使用过多的局部变量可能导致代码质量下降。

解决方案

为了修复这些警告，可以采用以下几种方法：

1. 减少参数数量

• 整合为一个DataClass实例 ：当函数参数较多时建议将其相关参数整合为一个DataClass实例（dataclass）。例如：可以把 df_loc、df_ti 和 df_ti_matrix 整合成一个DataClass对象进行处理。

    from dataclasses import dataclass
    import pandas as pd
    from typing import List, Dict, Union
    
    @dataclass
    class DataFrames:
    df_loc: pd.DataFrame
    df_ti: pd.DataFrame
    df_ti_matrix: pd.DataFrame
    ws_frequency_matrix: pd.DataFrame
    
    def main(dataframes: DataFrames, df_list: List[str], v50_list: List[float], v50_limit: float = 37.5) -> Dict[str, Union[str, float, List[float], bool]]:
    # 函数内部逻辑
    
    
    python
    
    
![](https://ad.itadn.com/c/weblog/blog-img/images/2025-07-13/ImvY2VlSDkFgxiyKNo8OZWAPu3HC.png)

2. 减少局部变量数量

• 模块化重构 ：当某个函数中的局部变量数量较多时，在不影响功能的前提下，便于提高代码可读性的情况下可以考虑将一些逻辑移至单独的辅助函数中使用。这不仅有助于减少局部变量的数量，并且能提升代码的整体可读性程度。

    def helper_function(...):
    # 处理某个特定的逻辑
    return result
    
    def main(...):
    # 使用 helper_function 处理某些逻辑
    
    
    python

3. 调整 Pylint 配置

如果你觉得你的函数参数和局部变量数量是合理的，并且改变这些布局会影响代码的可读性，则可以考虑优化Pylint的配置文件设置，并适当提高这些限制指标。

在 .pylintrc 文件中，你可以修改以下设置：

    [FORMAT]
    # 最大参数数量
    max-args=10
    
    # 最大局部变量数量
    max-locals=20
    
    
    ini

总结

通过重构代码的方式、利用数据结构来整合参数、或对 Pylint 进行配置调整，能够有效消除这些提示，并从而提升代码的整体易读性和维护效率。