Python-Wörterbücher Kommentare

Question

Wie können Kommentare für Wörterbuchelemente, die als Argumente an Funktionen übergeben werden, richtig angegeben werden? Hier ist ein Beispiel unten mit Styling, das ich aus (basierend auf Google-Dokument Stil für Sphinx):

def class_function_w_dict_argument(self, T_in, c_temps): 
    """ This calculates things with temperatures 

    Notes: 
     All temperatures should be given in Kelvin 

    Args: 
     T_in (float): Known temperature (K) 
     c_temps (dict): Dictionary of component temperatures 
      {T1 (float): temperature (K) 
      T2 (float): temperature (K) 
      T3 (float): temperature (K) 
      T4 (float): temperature (K) 
      T5 (float): temperature (K)} 

    Returns: 
     T_out (float): Calculated temperature 
    """ 

Answer 1

Sie nur das Wörterbuch-Format in der def Zeile mit der Eingabe-Modul Dict Klasse angeben mag. (Wenn Sie sind in der Lage, eine neuere Python 3-Version verwenden)

from typing import Dict 

class Foo: 
def class_function_w_dict_argument(self, T_in: float, c_temps: Dict[float,float]): 
    """" 
    Notes: 
     All temperatures should be given in Kelvin 

    Args: 
     T_in (float): Known temperature (K) 
     c_temps (Dict[float, float]): Dictionary of component temperatures 

    Returns: 
     T_out (float): Calculated temperature 
    """ 
    pass 

Sie zusätzlich einen Blick auf Typ-Aliasnamen zu übernehmen möchten:

Temperature = float 
TempDict = Dict[Temperature, Temperature] 

und TypeVar:

from typing import TypeVar 
Temperature = TypeVar('Temperature', float) 
some_temperature = Temperature(1.56)