DP-5290 python-sdk/cdn: 查询域名带宽，支持type参数

[yuansl]

• cdn/manager: add DataType class(enum), add optional parameter 'data_type' to CdnManager.get_bandwidth_data & CdnManager.get_flux_data
• see https://jira.qiniu.io/browse/DP-5290

[qiniu-x]

Missing class docstring (missing-class-docstring)

Details

lint 解释

• 该 lint 出现表示一个类（class）缺少文档字符串（docstring）。文档字符串是用于描述类、方法或函数的注释，它可以帮助其他开发者理解代码的用途和功能。在 Python 中，通常使用三引号（""" 或 '''）来定义文档字符串。

错误用法

class MyClass:
    def my_method(self):
        pass

正确用法

• 方案一：添加类文档字符串

class MyClass:
    """这是一个示例类，用于演示如何添加类文档字符串。"""

    def my_method(self):
        pass

• 方案二：如果不需要文档字符串，可以考虑是否需要该类

# 如果不需要文档字符串，可以考虑是否需要该类
class MyClass:
    def my_method(self):
        pass

• 方案三：使用类型注解（Type Annotations）

from typing import List, Dict

class MyClass:
    """这是一个示例类，用于演示如何添加类文档字符串。"""

    def __init__(self, data: List[Dict[str, int]]):
        self.data = data

    def my_method(self) -> None:
        pass

• 方案四：使用类型注解和文档字符串结合

from typing import List, Dict

class MyClass:
    """这是一个示例类，用于演示如何添加类文档字符串。"""

    def __init__(self, data: List[Dict[str, int]]):
        """
        初始化方法。

        :param data: 一个包含字典的列表
        :type data: List[Dict[str, int]]
        """
        self.data = data

    def my_method(self) -> None:
        """这是一个示例方法，用于演示如何添加方法文档字符串。"""
        pass

---

💡 以上内容由 AI 辅助生成，如有疑问欢迎反馈交流

[qiniu-x]

Missing function or method docstring (missing-function-docstring)

Details

lint 解释

• 该 lint 出现表示一个函数或方法缺少文档字符串（docstring）。文档字符串是用于描述函数或方法用途、参数和返回值的注释。它有助于其他开发者理解代码的功能，提高代码的可读性和可维护性。

错误用法

def calculate_area(width, height):
    return width * height

正确用法

• 方案一：添加文档字符串

def calculate_area(width, height):
    """
    计算矩形的面积
    
    参数:
    width (int): 矩形的宽度
    height (int): 矩形的高度
    
    返回:
    int: 矩形的面积
    """
    return width * height

• 方案二：如果函数或方法非常简单，可以不添加文档字符串，但最好在代码中留下注释说明其用途。

def calculate_area(width, height):
    # 计算矩形的面积
    return width * height

---

💡 以上内容由 AI 辅助生成，如有疑问欢迎反馈交流

[qiniu-x]

Redefining built-in 'str' (redefined-builtin)

Details

lint 解释

• 该 lint 出现表示在代码中重新定义了内置的 str 变量。这通常会导致命名冲突，因为 str 是 Go 语言中的一个内置类型，重新定义它可能会导致意外的行为或编译错误。

错误用法

package main

import "fmt"

func main() {
	str := "Hello, World!" // 正确使用内置的 str 类型
	fmt.Println(str)

	str := "Another string" // 重新定义内置的 str 变量，导致命名冲突
	fmt.Println(str)
}

正确用法

package main

import "fmt"

func main() {
	myString := "Hello, World!" // 使用自定义变量名避免命名冲突
	fmt.Println(myString)

	anotherString := "Another string" // 使用另一个自定义变量名
	fmt.Println(anotherString)
}

• 方案二：避免使用内置类型名称作为变量名，以防止命名冲突。

---

💡 以上内容由 AI 辅助生成，如有疑问欢迎反馈交流