Dokumentation
Att utveckla Python-paket
James Fulton
Climate informatics researcher
Varför inkludera dokumentation?
- Hjälper användare att använda din kod
- Dokumentera varje
- Funktion
- Klass
- Klassmetod
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.
...
Varför inkludera dokumentation?
- Hjälper användare att använda din kod
- Dokumentera varje
- Funktion
- Klass
- Klassmetod
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.
...
Varför inkludera dokumentation?
- Hjälper användare att använda din kod
- Dokumentera varje
- Funktion
- Klass
- Klassmetod
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.
...
Funktionsdokumentation
def count_words(filepath, words_list):""" ... """
Funktionsdokumentation
def count_words(filepath, words_list):"""Count the total number of times these words appear."""
Funktionsdokumentation
def count_words(filepath, words_list):"""Count the total number of times these words appear. The count is performed on a text file at the given location. """
Funktionsdokumentation
def count_words(filepath, words_list):"""Count the total number of times these words appear. The count is performed on a text file at the given location. [explain what filepath and words_list are] [what is returned] """
Dokumentationsstil
Google-dokumentationsstil
"""Summary line.
Extended description of function.
Args:
arg1 (int): Description of arg1
arg2 (str): Description of arg2
NumPy-stil
"""Summary line.
Extended description of function.
Parameters
----------
arg1 : int
Description of arg1 ...
Returns
----------
numpy.ndarray
reStructured text-stil
"""Summary line.
Extended description of function.
:param arg1: Description of arg1
:type arg1: int
:param arg2: Description of arg2
:type arg2: str
Epytext-stil
"""Summary line.
Extended description of function.
@type arg1: int
@param arg1: Description of arg1
@type arg2: str
@param arg2: Description of arg2
NumPy-dokumentationsstil
Populär i vetenskapliga Python-paket som
numpyscipypandassklearnmatplotlibdask- m.fl.
NumPy-dokumentationsstil
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.
Andra typer inkluderar – int, float, bool, str, dict, numpy.array, m.fl.
NumPy-dokumentationsstil
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'}
- Ange flera typer för parametern om det är relevant
- Lista godkända värden om bara ett fåtal alternativ är giltiga
NumPy-dokumentationsstil
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...
...
NumPy-dokumentationsstil
Övriga avsnitt
RaisesSee AlsoNotesReferencesExamples
1 https://numpydoc.readthedocs.io/en/latest/format.html
Dokumentationsmallar och stilkonvertering
pymentkan användas för att generera docstrings- Kör från terminalen
- Valfri dokumentationsstil från
- Numpydoc
- reST (dvs. reStructured-text)
- Javadoc (dvs. epytext)
- Konvertera dokumentation från en stil till en annan
Dokumentationsmallar och stilkonvertering
pyment -w -o numpydoc textanalysis.py
def count_words(filepath, words_list):
# Open the text file
...
return n
-w– skriv över filen-o numpydoc– utdata i NumPy-stil
Dokumentationsmallar och stilkonvertering
pyment -w -o numpydoc textanalysis.py
def count_words(filepath, words_list):
"""
Parameters
----------
filepath :
words_list :
Returns
-------
type
"""
Konvertera till Google-stil
pyment -w -o google textanalysis.py
def count_words(filepath, words_list):
"""Count the total number of times these words appear.
The count is performed on a text file at the given location.
Parameters
----------
filepath : str
Path to text file.
words_list : list of str
Count the total number of appearances of these words.
Returns
-------
"""
Konvertera till Google-stil
pyment -w -o google textanalysis.py
def count_words(filepath, words_list):
"""Count the total number of times these words appear.
The count is performed on a text file at the given location.
Args:
filepath(str): Path to text file.
words_list(list of str): Count the total number of appearances of these words.
Returns:
"""
Dokumentation för paket, underpaket och moduler
mysklearn/__init__.py
"""
Linear regression for Python
============================
mysklearn is a complete package for implmenting
linear regression in python.
"""
mysklearn/preprocessing/__init__.py
"""
A subpackage for standard preprocessing operations.
"""
mysklearn/preprocessing/normalize.py
"""
A module for normalizing data.
"""
Nu kör vi en övning!
Att utveckla Python-paket
