Docstrings
Python voor gevorderde ontwikkelaars
Jasmin Ludolf
Senior Data Science Content Developer
Docstrings
Tekstblok dat een functie beschrijft
Helpt gebruikers een functie te gebruiken
Help on built-in function round in module builtins: round(number, ndigits=None)Rond een getal af op een gegeven precisie in decimalen. De geretourneerde waarde is een geheel getal als ndigits is weggelaten of None. Anders heeft de geretourneerde waarde hetzelfde type als het getal. ndigits mag negatief zijn.
Een docstring opvragen
# Informatie openen, inclusief de docstring
print(help(round))
Help on built-in function round in module builtins:
round(number, ndigits=None)
Rond een getal af op een gegeven precisie in decimalen.
De geretourneerde waarde is een geheel getal als ndigits is weggelaten of None. Anders
heeft de geretourneerde waarde hetzelfde type als het getal. ndigits mag negatief zijn.
None
Een docstring opvragen
# Alleen de docstring openen
print(round
Een docstring opvragen
# Alleen de docstring openen
print(round.
Een docstring opvragen
# Alleen de docstring openen
print(round.__
Een docstring opvragen
# Alleen de docstring openen
print(round.__doc
Een docstring opvragen
# Alleen de docstring openen
print(round.__doc__)
Rond een getal af op een gegeven precisie in decimalen.
De geretourneerde waarde is een geheel getal als ndigits is weggelaten of None. Anders
heeft de geretourneerde waarde hetzelfde type als het getal. ndigits mag negatief zijn.
$$
$$
.__doc__: attribuut “dunder-doc”
Een docstring maken
def average(values):# Eénregelige docstring """Bepaal het gemiddelde van waarden en rond af op twee decimalen."""average_value = sum(values) / len(values) rounded_average = round(average_value, 2) return rounded_average
De docstring opvragen
# Onze docstring opvragen
print(average.__doc__)
Bepaal het gemiddelde van waarden en rond af op twee decimalen.
Een docstring bijwerken
# Docstring van een functie bijwerken average.__doc__ = "Calculate the mean of values in a data structure, rounding the results to 2 digits."print(help(average))
Help on function average in module __main__:
average(values)
Calculate the mean of values in a data structure, rounding the results to 2 digits.
Meerdere regels in een docstring
def average(values): """ Bepaal het gemiddelde van waarden en rond af op twee decimalen. """average_value = sum(values) / len(values) rounded_average = round(average_value, 2) return rounded_average
Meerdere regels in een docstring
def average(values): """ Bepaal het gemiddelde van waarden en rond af op twee decimalen. Args: """average_value = sum(values) / len(values) rounded_average = round(average_value, 2) return rounded_average
Meerdere regels in een docstring
def average(values): """ Bepaal het gemiddelde van waarden en rond af op twee decimalen. Args: values (list): Een lijst met numerieke waarden. """average_value = sum(values) / len(values) rounded_average = round(average_value, 2) return rounded_average
Meerdere regels in een docstring
def average(values): """ Bepaal het gemiddelde van waarden en rond af op twee decimalen. Args: values (list): Een lijst met numerieke waarden. Returns: rounded_average (float): Het gemiddelde, afgerond op twee decimalen. """average_value = sum(values) / len(values) rounded_average = round(average_value, 2) return rounded_average
De docstring opvragen
# Help
print(help(average))
Help on function average in module __main__:
average(values)
Bepaal het gemiddelde van waarden en rond af op twee decimalen.
Args:
values (list): Een lijst met numerieke waarden.
Returns:
rounded_average (float): Het gemiddelde, afgerond op twee decimalen.
Laten we oefenen!
Python voor gevorderde ontwikkelaars
