python - 如何记录采用多种类型的参数

Question

在 Python 2 中，是否有一种规范的方式来记录一个方法可能不止一种类型？

这是我的做法:

def __init__(self, work_order_number):
    """This message communicates that a job is being rerun.  Olio will
    forget everything it knows about the job.

    Args:
        work_order_number (int or str): Work order number
    """
    payload = {
        'work_order_number': str(work_order_number),
    }
    self.content = json.dumps(payload)

我在这里使用符号 (int or str) 来指示参数可以是整数或字符串。

Python 2 程序通常如何记录方法参数可以是多种类型？是否有标准或最佳做法？

由于我无法控制的力量，我无法使用 Python 3，因此无法使用注释

Answer 1

你做的很好。没有必要的确切格式；您只需要使用逗号或“或”来明确意图。例如，参见 matplotlib 中的各种函数或 pandas它采用记录为“str or None”、“float、sequence or None”、“list-like or integer”等的参数。