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

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

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