2015-03-25 15 views
6

Python 2'de, bir yöntemin birden çok türde olabileceğini belgelemek için kanonik bir yol var mıdır? İşteBirden çok türü alan bağımsız değişken nasıl belgelenir?

bunu yaptık edebilirsiniz:

Ben argüman bir tamsayı ya da bir dize olabileceğini göstermek için gösterim (int or str) kullanılan
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) 

.

Python 2 programları genellikle bir yöntem argümanının birden fazla türde olabileceğini nasıl gösterir? Standart veya en iyi uygulama var mı?

nedeniyle Elimde olmayan kuvvetlere, ben ek açıklamalar

+0

Bana sorun yok gibi görünüyor. Projenizde tutarlı olduğunuz sürece (PEP-257) (PEP-257) (https://www.python.org/dev/peps/pep-0257/) - ve herhangi bir şeyin darlığı onlardan belge üreterek) iyisin. – jonrsharpe

cevap

3

bunu gayet yaptığı gibi kullanamaz dolayısıyla Python 3 kullanın ve olamaz. Gerekli olan kesin bir format yoktur; Sadece niyetleri virgül veya "veya" kullanarak netleştirmeniz gerekir. Örneğin, "str veya None", "float, sequence veya None", "list-like veya integer" gibi belgelenen argümanları ele alan matplotlib veya pandas çeşitli işlevlerine bakın.