matplotlib._docstring

class matplotlib._docstring.Substitution(*args, **kwargs)

Bases: object

Ein Decorator, der %-Substitutionen im Docstring eines Objekts durchführt.

Dieser Decorator sollte auch dann robust sein, wenn obj.__doc__ None ist (z. B. wenn -OO an den Interpreter übergeben wurde).

Verwendung: Erstellen Sie ein docstring.Substitution mit einer Sequenz oder einem Wörterbuch, das für die Durchführung von Substitutionen geeignet ist; dekorieren Sie dann eine geeignete Funktion mit dem erstellten Objekt, z. B.

sub_author_name = Substitution(author='Jason')

@sub_author_name
def some_function(x):
    "%(author)s wrote this function"

# note that some_function.__doc__ is now "Jason wrote this function"

Man kann auch Positionsargumente verwenden

sub_first_last_names = Substitution('Edgar Allen', 'Poe')

@sub_first_last_names
def some_function(x):
    "%s %s wrote the Raven"

matplotlib._docstring.copy(source)

Kopiert einen Docstring von einer anderen Quellfunktion (falls vorhanden).

matplotlib._docstring.kwarg_doc(text)

Decorator zum Definieren der kwdoc-Dokumentation von Artist-Eigenschaften.

Dieser Decorator kann auf Setter-Methoden von Artist-Eigenschaften angewendet werden. Der angegebene Text wird in einem privaten Attribut _kwarg_doc auf der Methode gespeichert. Er wird verwendet, um automatisch generierte Dokumentation in der kwdoc-Liste für Artists zu überschreiben. Die kwdoc-Liste wird verwendet, um **kwargs zu dokumentieren, wenn sie Eigenschaften eines Artists sind. Sehen Sie z.B. den Abschnitt **kwargs in Axes.text.

Der Text sollte die unterstützten Typen sowie den Standardwert, falls zutreffend, enthalten, z. B.

@_docstring.kwarg_doc("bool, default: rcParams["text.usetex"] (default: False)") def set_usetex(self, usetex)

Siehe auch

matplotlib.artist.kwdoc