Documentazione
Sviluppare pacchetti Python
James Fulton
Climate informatics researcher
Perché includere la documentazione?
- Aiuta gli utenti a usare il tuo codice
- Documenta ogni
- Funzione
- Classe
- Metodo di classe
import numpy as np
help(np.sum)
...
sum(a, axis=None, dtype=None, out=None)
Sum of array elements over a given axis.
Parameters
----------
a : array_like
Elements to sum.
axis : None or int or tuple of ints, optional
Axis or axes along which a sum is performed.
The default, axis=None, will sum all of the
elements of the input array.
...
Perché includere la documentazione?
- Aiuta gli utenti a usare il tuo codice
- Documenta ogni
- Funzione
- Classe
- Metodo di classe
import numpy as np
help(np.array)
...
array(object, dtype=None, copy=True)
Create an array.
Parameters
----------
object : array_like
An array, any object exposing the array
interface ...
dtype : data-type, optional
The desired data-type for the array.
copy : bool, optional
If true (default), then the object is copied.
...
Perché includere la documentazione?
- Aiuta gli utenti a usare il tuo codice
- Documenta ogni
- Funzione
- Classe
- Metodo di classe
import numpy as np
x = np.array([1,2,3,4])
help(x.mean)
...
mean(...) method of numpy.ndarray instance
a.mean(axis=None, dtype=None, out=None)
Returns the average of the array elements
along given axis.
Refer to `numpy.mean` for full documentation.
...
Documentazione delle funzioni
def count_words(filepath, words_list):""" ... """
Documentazione delle funzioni
def count_words(filepath, words_list):"""Conta il numero totale di occorrenze di queste parole."""
Documentazione delle funzioni
def count_words(filepath, words_list):"""Conta il numero totale di occorrenze di queste parole. Il conteggio è eseguito su un file di testo nel percorso indicato. """
Documentazione delle funzioni
def count_words(filepath, words_list):"""Conta il numero totale di occorrenze di queste parole. Il conteggio è eseguito su un file di testo nel percorso indicato. [spiega cosa sono filepath e words_list] [cosa viene restituito] """
Stili di documentazione
Stile Google
"""Riga riassuntiva.
Descrizione estesa della funzione.
Args:
arg1 (int): Descrizione di arg1
arg2 (str): Descrizione di arg2
Stile NumPy
"""Riga riassuntiva.
Descrizione estesa della funzione.
Parameters
----------
arg1 : int
Descrizione di arg1 ...
Returns
----------
numpy.ndarray
Stile reStructuredText
"""Riga riassuntiva.
Descrizione estesa della funzione.
:param arg1: Descrizione di arg1
:type arg1: int
:param arg2: Descrizione di arg2
:type arg2: str
Stile Epytext
"""Riga riassuntiva.
Descrizione estesa della funzione.
@type arg1: int
@param arg1: Descrizione di arg1
@type arg2: str
@param arg2: Descrizione di arg2
Stile di documentazione NumPy
Diffuso nei pacchetti scientifici Python come
numpyscipypandassklearnmatplotlibdask- ecc.
Stile di documentazione NumPy
import scipy
help(scipy.percentile)
percentile(a, q, axis=None, out=None, overwrite_input=False, interpolation='linear') Compute the q-th percentile of the data along the specified axis. Returns the q-th percentile(s) of the array elements.Parameters ----------a : array_likeInput array or object that can be converted to an array.
Other types include - int, float, bool, str, dict, numpy.array, etc.
Stile di documentazione NumPy
import scipy
help(scipy.percentile)
percentile(a, q, axis=None, out=None, overwrite_input=False, interpolation='linear')
...
Parameters
----------
...
axis : {int, tuple of int, None}
...
interpolation : {'linear', 'lower', 'higher', 'midpoint', 'nearest'}
- Elenca più tipi per un parametro se opportuno
- Elenca i valori accettati se ci sono poche opzioni valide
Stile di documentazione NumPy
import scipy
help(scipy.percentile)
percentile(a, q, axis=None, out=None, overwrite_input=False, interpolation='linear')
...
Returns
-------
percentile : scalar or ndarray
If `q` is a single percentile and `axis=None`, then the result
is a scalar. If multiple percentiles are given, first axis of
the result corresponds to the percentiles...
...
Stile di documentazione NumPy
Altre sezioni
RaisesSee AlsoNotesReferencesExamples
1 https://numpydoc.readthedocs.io/en/latest/format.html
Template e conversione degli stili di documentazione
pymentpuò generare docstring- Eseguilo dal terminale
- Qualsiasi stile di documentazione tra
- Numpydoc
- reST (reStructuredText)
- Javadoc (epytext)
- Converti la documentazione da uno stile a un altro
Template e conversione degli stili di documentazione
pyment -w -o numpydoc textanalysis.py
def count_words(filepath, words_list):
# Open the text file
...
return n
-w- sovrascrive il file-o numpydoc- output in stile NumPy
Template e conversione degli stili di documentazione
pyment -w -o numpydoc textanalysis.py
def count_words(filepath, words_list):
"""
Parameters
----------
filepath :
words_list :
Returns
-------
type
"""
Converti in stile Google
pyment -w -o google textanalysis.py
def count_words(filepath, words_list):
"""Conta il numero totale di occorrenze di queste parole.
Il conteggio è eseguito su un file di testo nel percorso indicato.
Parameters
----------
filepath : str
Path to text file.
words_list : list of str
Count the total number of appearances of these words.
Returns
-------
"""
Converti in stile Google
pyment -w -o google textanalysis.py
def count_words(filepath, words_list):
"""Conta il numero totale di occorrenze di queste parole.
Il conteggio è eseguito su un file di testo nel percorso indicato.
Args:
filepath(str): Path to text file.
words_list(list of str): Count the total number of appearances of these words.
Returns:
"""
Documentazione di package, sottopackage e moduli
mysklearn/__init__.py
"""
Linear regression for Python
============================
mysklearn is a complete package for implmenting
linear regression in python.
"""
mysklearn/preprocessing/__init__.py
"""
Un sottopacchetto per le comuni operazioni di preprocessing.
"""
mysklearn/preprocessing/normalize.py
"""
Un modulo per normalizzare i dati.
"""
Esercitiamoci!
Sviluppare pacchetti Python
