dict için python docstring ekleme

Question

Sözlük parametresi için bir docstring eklemenin önerilen yolu nedir? Birden çok satırdaki doc-string örneğini here görebilirim.

Giriş argümanlarını dokümanın içindeki bir işleve belgelemem gerekiyor. Basit bir değişken varsa, ben gibi bir şey kullanabilirsiniz:

def func2(a=x, b = y): 
""" fun2 takes two integers 

Keyword arguments: 
a -- refers to age (default 18) 
b -- refers to experience (default 0) 
""" 

biz dict işlevi girdisi argüman olarak geçirilen varsa:

def func3(**kwargs): 
    """ takes dictionary as input 

     <Here how to explain them - Is it like?> 
     kwargs['key1'] -- takes value1 

     <or simply> 
     key1 -- takes value1 
     """ 

Answer 1

Genellikle bu yüzden bir sözlük parametre gibi görünür, Google docstring style kullanmak :

def func(a_dict): 
    """Some function to do something to a dictionary. 

    Args: 
     a_dict (dict of str: int): Some mapping, I guess? 

    """ 
    ... 

**kwargs (not alan bir işlevi: şudur değil oldukça gibi bir sözlük parametre) sahip olarak aynı olacaktır: mevcut olmalıdır belirli parametreleri varsa

def func(**kwargs): 
    """Some function to do stuff to arbitrary keyword arguments. 

    Args: 
     **kwargs: Arbitrary keyword arguments. 

    """ 
    ... 

(ör Sizin key1), ayrı olmalıdır, **kwargs içine yuvarlanmamış.

Python 3.x ise

---

, ayrıca function annotations kullanabilirsiniz:

from typing import Mapping 

def func(a_dict: Mapping[str, int]): 
    """Some function to do something to a dictionary.""" 
    ...