{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Les générateurs"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Les générateurs sont très simples à utiliser et très puissants. Ils vous permettront d'optimiser votre code à moindre frais. Alors pourquoi se priver ?"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Imaginons que je veuille extraire d'une liste de mots la liste des mots comportants le caractère 'a'. Je vais écrire une fonction."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 45,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "def with_a(words):\n",
    "    \"\"\"\n",
    "    Reçoit une liste de mots et renvoie la liste des mots contenant le car. 'a'\n",
    "    \"\"\"\n",
    "    res = []\n",
    "    for word in words:\n",
    "        if 'a' in word:\n",
    "            res.append(word)\n",
    "    return res\n",
    "    "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 34,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "chat\n",
      "matin\n"
     ]
    }
   ],
   "source": [
    "mots = [\"le\", \"petit\", \"chat\", \"est\", \"mort\", \"ce\", \"matin\"]\n",
    "mots_a = with_a(mots)\n",
    "print(\"\\n\".join(mots_a))"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Jusque là rien de méchant. Comme il est question d'optimisation je vais mesurer le temps de traitement avec `timeit`.  \n",
    "ipython est plein de magie, `%time` hup hup hup barbatruc et voilà."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": false
   },
   "outputs": [],
   "source": [
    "%time mots_a = with_a(mots)\n",
    "mots_big = mots * 1000000\n",
    "%time mots_a = with_a(mots_big)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Comme on pouvait s'y attendre le temps d'exécution de la fonction augmente avec la taille de la liste initiale.  \n",
    "Voyons ce que ça donne avec un générateur. Construire un générateur c'est simple : vous remplacez `return` par `yield` dans votre fonction.  \n",
    "C'est tout ? C'est tout.  \n",
    "\n",
    "<small>Vous pouvez quand même en apprendre plus [ici](http://intermediatepythonista.com/python-generators) ou lire la [PEP 255](https://www.python.org/dev/peps/pep-0255/) si vous aimez ça.</small>"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 46,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "def gen_with_a(words):\n",
    "    \"\"\"\n",
    "    Reçoit une liste de mots et renvoie les mots contenant le car. 'a' sous forme de générateur\n",
    "    \"\"\"\n",
    "    for word in words:\n",
    "        if 'a' in word:\n",
    "            yield(word)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 47,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "CPU times: user 0 ns, sys: 0 ns, total: 0 ns\n",
      "Wall time: 76.8 µs\n",
      "CPU times: user 0 ns, sys: 0 ns, total: 0 ns\n",
      "Wall time: 8.82 µs\n"
     ]
    }
   ],
   "source": [
    "mots_big = mots * 100\n",
    "%time mots_a = with_a(mots_big)\n",
    "%time mots_a_gen = gen_with_a(mots_big)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "😲 !!!!!!!!!  \n",
    "Oui c'est de la magie. Enfin c'est plutôt de la triche, regardez :"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 48,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "mots_a is a <class 'list'>\n",
      "mots_a_gen is a <class 'generator'>\n",
      "Taille de mots_a : 1672\n",
      "Taille de mots_a_gen : 88\n"
     ]
    }
   ],
   "source": [
    "print(\"mots_a is a {}\".format(type(mots_a)))\n",
    "print(\"mots_a_gen is a {}\".format(type(mots_a_gen)))\n",
    "import sys\n",
    "print(\"Taille de mots_a : {}\".format(sys.getsizeof(mots_a)))\n",
    "print(\"Taille de mots_a_gen : {}\".format(sys.getsizeof(mots_a_gen)))"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "`mots_a_gen` n'est pas une liste, c'est un objet `generator`.  \n",
    "Il ne stocke rien ou presque en mémoire, on ne peut pas connaître sa taille (essayez `len(mots_a_gen)` pour voir.  \n",
    "Mais c'est un itérable, on peut le parcourir comme une liste. Par contre on ne peut pas les \"trancher\", on ne peut accéder à un élément d'index `i` comme pour une liste.  \n",
    "Encore une différence d'avec les listes : vous ne pouvez parcourir un générateur qu'une seule fois."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 18,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "CPU times: user 4 ms, sys: 0 ns, total: 4 ms\n",
      "Wall time: 5.68 ms\n"
     ]
    }
   ],
   "source": [
    "%time mots_a_gen = list(gen_with_a(mots_big))"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": true
   },
   "source": [
    "Mais même sans tricher les générateurs demeurent très efficaces. Vous aurez compris qu'il vous est désormais chaudement recommandé de les utiliser. "
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Vous pouvez aussi utiliser des générateurs en compréhension, à la manière des listes en compréhension : "
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 24,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "['chat', 'matin']"
      ]
     },
     "execution_count": 24,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "[mot for mot in mots if 'a' in mot]"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 25,
   "metadata": {
    "collapsed": false
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "<generator object <genexpr> at 0x7fd2a44637d8>"
      ]
     },
     "execution_count": 25,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "(mot for mot in mots if 'a' in mot)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 0
}