60 lines
1.7 KiB
TeX
60 lines
1.7 KiB
TeX
|
\documentclass[a4paper,10pt]{article}
|
||
|
|
\usepackage{myXsim}
|
||
|
|
\usepackage{minted}
|
||
|
|
|
||
|
|
\author{Benjamin Bertrand}
|
||
|
|
\title{Fonctions spécifications et tests - Cours}
|
||
|
|
\date{décembre 2022}
|
||
|
|
|
||
|
|
\pagestyle{empty}
|
||
|
|
|
||
|
|
\begin{document}
|
||
|
|
|
||
|
|
\maketitle
|
||
|
|
|
||
|
|
\setcounter{section}{1}
|
||
|
|
\section{Documenter}
|
||
|
|
|
||
|
|
Programmer c'est écrire du code pour que la machine le comprenne mais aussi et surtout pour que d'autres personnes le comprenne et soit en mesure de l'utiliser ou le modifier. C'est pour cela qu'il est primordiale de \textbf{documenter} les fonctions.
|
||
|
|
|
||
|
|
\begin{definition}[ Les docstrings ]
|
||
|
|
|
||
|
|
Une \textbf{docstring} (chaine de documentation) est la manière choisi pour documenter les fonctions en Python. Elles se placent en dessous de la signature de la fonction (ligne avec \mintinline{python}{def}) et sont entourés de \mintinline{python}{""" ... """}.
|
||
|
|
|
||
|
|
\begin{center}
|
||
|
|
\begin{minipage}{0.5\linewidth}
|
||
|
|
\begin{minted}[bgcolor=base3,linenos]{python}
|
||
|
|
def nom_de_la_fonction(argument1, argument2, ...):
|
||
|
|
""" Docstring """
|
||
|
|
instruction 1
|
||
|
|
instruction 2
|
||
|
|
instruction 3
|
||
|
|
...
|
||
|
|
return valeur
|
||
|
|
\end{minted}
|
||
|
|
\end{minipage}
|
||
|
|
\end{center}
|
||
|
|
|
||
|
|
Pour accéder à la docstring, on utilise l'attribut \mintinline{python}{__doc__} ou la fonction \mintinline{python}{help} en mode interactif.
|
||
|
|
\begin{center}
|
||
|
|
\begin{minipage}{0.5\linewidth}
|
||
|
|
\begin{minted}[bgcolor=base3,linenos]{python}
|
||
|
|
>>> from math import sqrt
|
||
|
|
>>> print(sqrt.__doc__)
|
||
|
|
Return the square root of x.
|
||
|
|
\end{minted}
|
||
|
|
\end{minipage}
|
||
|
|
\end{center}
|
||
|
|
\end{definition}
|
||
|
|
|
||
|
|
\section{Spécifier}
|
||
|
|
|
||
|
|
z
|
||
|
|
|
||
|
|
|
||
|
|
\section{Tester}
|
||
|
|
|
||
|
|
Écrire une fonction qui marche c'est bien mais écrire une fonction qui fait ce qu'on attend d'elle c'est mieux.
|
||
|
|
Pour cela,
|
||
|
|
\end{document}
|