matplotlib.docstring

Attenzione

Questo modulo è considerato interno.

Il suo utilizzo è deprecato e verrà rimosso in una versione futura.

classe matplotlib._docstring. Sostituzione ( * args , ** kwargs )

Basi:object

Un decoratore che esegue %-sostituzione sulla docstring di un oggetto.

Questo decoratore dovrebbe essere robusto anche se obj.__doc__è None (per esempio, se -OO è stato passato all'interprete).

Utilizzo: costruisce una docstring.Substitution con una sequenza o un dizionario adatto per eseguire la sostituzione; quindi decorare una funzione adatta con l'oggetto costruito, ad esempio:

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"

Si possono anche usare argomenti posizionali:

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

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

aggiornamento ( * args , ** kwargs )

Aggiornamento self.params(che deve essere un dict) con gli argomenti forniti.

matplotlib._docstring. copia ( fonte )

Copia una docstring da un'altra funzione sorgente (se presente).