Formatierung python docstrings für dicts

Was ist die empfohlene Methode für das hinzufügen eines docstring für einen dictionary-parameter? Ich kann sehen, mehrere line-docstring Beispiele hier.

Brauche ich zur Dokumentation der Eingabe-Argumente einer Funktion den docstring. Wenn es eine einfache variable, die ich verwenden kann, so etwas wie:

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

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

Wenn wir dict übergeben, die als input-argument der Funktion:

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

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

      <or simply>
      key1 -- takes value1
      """
  • Könnten Sie bitte erklären, was genau du meinst? Meinst du, wie Dokument ein parameter, sollte ein Wörterbuch?
  • Ja, wie zu dokumentieren, ein parameter, der ein Wörterbuch.
InformationsquelleAutor webminal.org | 2014-11-03
  1. 16

    Ich in der Regel verwenden die Google docstring Stil, also ein dictionary-parameter würde wie folgt Aussehen:

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

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

    """
    ...

    Eine Funktion, die nimmt **kwargs (Hinweis: dies ist nicht ziemlich das gleiche wie mit einem dictionary-parameter), würde wie folgt Aussehen:

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

    Args:
      **kwargs: Arbitrary keyword arguments.

    """
    ...

    Wenn es bestimmte Parameter, die vorhanden sein sollten (z.B. key1), Sie sollten getrennt werden, nicht gerollt in **kwargs.

    In Python 3.x, können Sie auch Funktion Anmerkungen:

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

    Vom Python-3.5, Sie können sogar noch mehr explizite Verwendung Eingabe:

    from typing import Mapping

def func(a_dict: Mapping[str, int]):
    """Some function to do something to a dictionary."""
    ...
    • danke, hab es jetzt.
    • Was, wenn Sie wollte explizit geben die dictionary-keys und Werte? Das Wörterbuch hat class_ids was hat ein Typ, der masks hat eine Art... etc.
    • Ich bin mir nicht bewusst, irgendeine Konvention für die, dass, wenn das ist, was Sie wollen, Sie wäre besser, mit so etwas wie ein namedtuple mit denen als Eigenschaften.
    InformationsquelleAutor jonrsharpe
Schreibe einen Kommentar