Phenquestions
Esempio 1: accesso alla docstring di una funzione usando __doc__ attributo
Il modo di dichiarare e accedere alla docstring di una funzione personalizzata è mostrato nel seguente script. Il seguente script calcola la xn dove x e n saranno presi dall'utente. Energia () la funzione ha definito nello script per eseguire l'attività. Qui, la docstring è stata definita per questa funzione. __doc__ l'attributo è stato utilizzato nello script per stampare la docstring con l'output.
def potenza (x, n):"Calcola x alla potenza n
Leggi i valori di x e n dagli argomenti della funzione
e Calcola e restituisci il valore di x alla potenza n."
restituire x**n
# Prendi il valore di x
x = int(input('Inserisci il valore di x:'))
# Prendi il valore di n
n = int(input('Inserisci il valore di n:'))
# Stampa il valore di ritorno della funzione
print("Il %d alla potenza %d = %d" %(x, n, power(x, n)))
# Stampa il valore della docstring
print("Il contenuto della docstring:\n" + power.__doc__)
Produzione:
Il seguente output verrà visualizzato dopo aver eseguito lo script sopra.
Esempio 2: accesso alla docstring di classe e metodo utilizzando Aiuto() metodo
Il modo di dichiarare e accedere alla docstring del documento e ai metodi di quella classe è mostrato nel seguente script. La funzione principale dello script è ordinare un elenco numerico e invertire i dati dell'elenco. Nella classe è stata dichiarata una lista numerica di 8 elementi e la docstring è stata definita all'inizio della classe utilizzando triple virgolette singole. Il metodo sort_list() è stato definito nella classe per stampare i dati ordinati della lista, e il documento lo ha definito per questo metodo. lista_inversa() il metodo è definito per stampare i dati invertiti dell'elenco e anche la docstring è stata definita per questo metodo. Aiuto() il metodo ha chiamato tre volte alla fine dello script per stampare la docstring del list_operazioni classe, sort_list() metodo e il lista_inversa() metodo.
lista_operazioni di classe:
lista_operazioni di classe:"
Ordinamento e inversione dei dati dell'elenco
La classe contiene due metodi,
Il metodo sort_list() ordinerà e stamperà l'elenco,
Il metodo sort_reverse() invertirà e stamperà l'elenco.
"
# Definire un elenco di dati numerici
listdata = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list(self):
"
Stampa i valori dell'elenco dopo l'ordinamento
La funzione prenderà un oggetto elenco di dati numerici dall'argomento,
ordina i valori della lista usando il metodo sort()
e stampa i valori della lista ordinata.
"
# Ordina l'elenco
se stesso.listdata.ordinare()
# Stampa l'elenco ordinato usando il ciclo
print("I valori della lista ordinata:\n")
per il valore in sé.dati lista:
print(valore, " ", fine=")
def reverse_list(self):
"
Stampa i valori dell'elenco dopo l'inversione
La funzione prenderà un oggetto elenco di dati numerici dall'argomento,
invertire i valori della lista usando il metodo reverse()
e stampa i valori della lista invertita.
"
# Inverti la lista
se stesso.listdata.inversione()
# Stampa la lista invertita usando loop
print("I valori della lista ordinata:\n")
per il valore in sé.dati lista:
print(valore, " ", fine=")
# Stampa il valore docstring della classe
help(list_operations)
# Crea l'oggetto della classe
obj = lista_operazioni()
# Stampa il valore docstring del particolare metodo
aiuto (obj.sort_list)
# Chiama il metodo per stampare l'elenco ordinato
obj.sort_list()
Produzione:
Il seguente output apparirà dopo aver eseguito lo script. Tutta la docstring dello script è stata stampata per la prima Aiuto() funzione. La docstring del sort_list() il metodo è stato stampato per il secondo Aiuto() funzione.
Esempio 3: accesso alla docstring del modulo Python integrato
Negli esempi precedenti, la docstring è stata utilizzata in classi e funzioni definite dall'utente. Ogni modulo e classe Python incorporati ha la sua docstring che spiega lo scopo dell'uso di quel particolare modulo o funzione. Il codificatore del modulo o della funzione definisce la docstring per rendere il codice comprensibile per gli utenti. Il seguente script stamperà la docstring predefinita del modulo datetime utilizzando il pulsante Aiuto() funzione.
# Importa modulo datetimedata e ora di importazione
# Visualizza la docstring di datetime
aiuto (data e ora)
Produzione:
Il seguente output verrà visualizzato dopo l'esecuzione dello script. La docstring del modulo datetime ne mostra la documentazione dettagliata per aiutare gli altri a conoscere correttamente le funzioni delle classi e dei metodi definiti in questo modulo.
Conclusione:
La documentazione adeguata è essenziale quando qualsiasi modulo o funzione viene implementato per lo scopo specifico per aiutare l'altro programmatore a utilizzare il modulo nel proprio codice per svolgere il compito particolare. Se la documentazione non è definita correttamente per il modulo o la funzione, gli altri utenti incontreranno problemi nell'usarla. Quindi, ogni programmatore deve utilizzare la docstring del documento per fornire informazioni dettagliate affinché gli altri possano comprendere il codice.
