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

Question

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

这是我的做法：

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) 来表示参数可以是整数或字符串。

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

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

Answer 1

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

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

How to document argument that takes multiple types

python

comments

python-2.x