classiques.py

# coding: utf-8
import datetime


def commentaire_accentues():
    """
    L'aide de cette fonction contient assuréments des accents.

    .. faqref::
        :tag: python
        :title: Python n'accepte pas les accents

        Le langage Python a été conçu en langage anglais.
        Dès qu'on on ajoute un caractère
        qui ne fait pas partie de l'alphabet anglais
        (ponctuation comprise), il déclenche une erreur :

        ::

            File "faq_cvxopt.py", line 3
            SyntaxError: Non-UTF-8 code starting with '\xe8' in
                file faq_cvxopt.py on line 4, but no encoding declared;
                see http://python.org/dev/peps/pep-0263/ for details

        Pour la résoudre, il faut dire à l'interpréteur que
        des caractères non anglais peuvent apparaître
        et écrire sur la première ligne du programme :

        ::

            # coding: latin-1

        Ou pour tout caractère y compris chinois :

        ::

            # coding: utf-8

        Si vous utilisez l'éditeur
        `SciTE <http://www.scintilla.org/SciTE.html>`_ sous Windows,
        après avoir ajouté cette ligne avec l'encoding `utf-8`,
        il est conseillé de fermer le fichier puis de le réouvrir.
        SciTE le traitera différemment.

        **L'encodage ``utf-8`` est la norme sur Internet.**
        C'est pourquoi il est préférable d'utiliser celui-ci pour
        partager son code via une page Web.
    """
    pass


def dix_entiers_carre():
    """
    fait la somme des dix premiers entiers au carré

    :returns: nombre réel

    .. faqref::
        :tag: python
        :title: Quelle est la différence entre return et print ?

        La fonction ``print`` sert à afficher un résultat sur la sortie standard.
        Elle peut être utilisée à tout moment
        mais elle n'a pas d'impact sur le déroulement programme. Le mot-clé ``return``
        n'est utilisé que dans une fonction. Lorsque le programme rencontre
        une instruction commençant par ``return``, il quitte la fonction
        et transmet le résultat à l'instruction qui a appelé la fonction.
        La fonction ``print`` ne modifie pas votre algorithme. La fonction ``return``
        spécifie le résultat de votre fonction : elle modifie l'algorithme.

    .. exref::
        :title: calcul de la somme des dix premiers entiers au carré
        :tag: Base

        Ce calcul simple peut s'écrire de diffèrentes manières.

        ::

            s = 0
            for i in range(1, 11):
                s += i**2

        D'une façon abrégée :

        ::

            s = sum ( [ i**2 for i in range(1, 11) ] )
    """
    s = 0
    for i in range(1, 11):
        s += i**2
    return s


def repetition_a_eviter(serie, a_eviter=False):
    """
    Une répétition à éviter.

    .. exref::
        :title: Eviter d'effectuer le même appel deux fois
        :tag: Base -

        Dans cette fonction on calcule la variance d'une série d'observations.

        ::

            def moyenne(serie):
                return sum(serie) / len(serie)

            def variance_a_eviter(serie):
                s = 0
                for obs in serie :
                    s += (obs-moyenne(serie))**2
                return s / len(serie)

        La fonction ``variance_a_eviter``
        appelle la fonction ``moyenne`` à chaque passage
        dans la boucle. Or, rien ne change d'un passage à l'autre.
        Il vaut mieux stocker
        le résultat dans une variable :

    ::

        def moyenne(serie):
            return sum(serie) / len(serie)

        def variance(serie):
            s = 0
            moy = moyenne(serie)
            for obs in serie :
                s += (obs-moy)**2
            return s / len(serie)

    Le coût de la variance passe alors d'un coût en :math:`O(n^2)` à :math:`O(n)`.
    Ce n'est pas le seul endroit où cette erreur survient. Dans le code suivant,
    on appelle deux fois la fonction ``major`` avec le même argument.
    C'est à éviter.

    ::

        meilleur = major(data)[0]  # retourne ("quelque chose", True)
        if major(data)[1]:
            return {"leaf":guess}
    """

    def moyenne(serie):
        "moyenne"
        return sum(serie) / len(serie)

    def variance_a_eviter(serie):
        "variance longue"
        s = 0
        for obs in serie:
            s += (obs - moyenne(serie)) ** 2
        return s / len(serie)

    def variance(serie):
        "variance courte"
        s = 0
        moy = moyenne(serie)
        for obs in serie:
            s += (obs - moy) ** 2
        return s / len(serie)

    if a_eviter:
        return variance_a_eviter(serie)
    else:
        return variance(serie)


def dictionnaire_modifie_dans_la_boucle():
    """
    Dictionnaires, listes modifiés dans la boucle qui les parcourt.

    .. exref::
        :title: Modifier un dictionnaire en le parcourant
        :tag: Base -

        Il faut éviter de modifier un container lorsqu'on le parcourt.
        Lorsqu'on supprime un élément d'un dictionnaire, la structure de celui-ci
        s'en trouve modifiée et affecte la boucle qui le parcourt. La boucle parcourt
        toujours l'ancienne structure du dictionnaire, celle qui existait au début
        au début de la boucle.

        ::

            d = { k: k for k in range(10) }
            for k, v in d.items():
                if k == 4 :
                    del d[k]

        En Python, cela produit l'erreur qui suit mais d'autres langages ne préviennent
        pas (C++) et cela aboutit à une erreur qui intervient plus tard dans le code
        (comme une valeur numérique inattendue).

        ::

            Traceback (most recent call last):
            File "session1.py", line 176, in <module>
                l = liste_modifie_dans_la_boucle()
            File "session1.py", line 169, in liste_modifie_dans_la_boucle
                for k,v in d.items():
            RuntimeError: dictionary changed size during iteration

        Il faut pour éviter cela stocker les éléments
        qu'on veut modifier pour les supprimer ensuite.

        ::

            d = { k:k for k in l }
            rem = [ ]
            for k,v in d.items():
                if k == 4 :
                    rem.append(k)
            for r in rem :
                del d[r]

        Même si Python autorise cela pour les listes,
        il est conseillé de s'en abstenir ainsi que pour tout
        type d'objets qui en contient d'autres.
        C'est une habitude qui vous servira pour la plupart des autres langages.
    """
    liste = [0, 1, 2, 3, 4, 5, 6]
    for i in liste:
        if i == 2:
            liste.remove(3)

    d = {k: k for k in liste}
    rem = []
    for k in d:
        if k == 4:
            rem.append(k)
    for r in rem:
        del d[r]

    return liste, d


def str2date(s, fmt="%d/%m/%Y"):
    """
    convertit une chaîne de caractères en datetime

    :param s: chaîne de caractères
    :param fmt: format de la conversion

    .. exref::
        :title: conversion d'une chaîne de caractère en datetime
        :tag: Base

        C'est le genre de fonction qu'on n'utilise pas souvent
        mais qu'on peine à retrouver
        lorsqu'on en a besoin.
        Il faut utiliser la fonction `strftime
        <https://docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior>`_.

        ::

            import datetime
            dt = datetime.datetime.strptime ("16/01/2014", "%d/%m/%Y")
    """
    return datetime.datetime.strptime(s, fmt)