.. _magiccommandsaboutfilesrst:

==========================
Magic commands about files
==========================


.. only:: html

    **Links:** :download:`notebook <magic_commands_about_files.ipynb>`, :downloadlink:`html <magic_commands_about_files2html.html>`, :download:`PDF <magic_commands_about_files.pdf>`, :download:`python <magic_commands_about_files.py>`, :downloadlink:`slides <magic_commands_about_files.slides.html>`, :githublink:`GitHub|_doc/notebooks/magic_commands_about_files.ipynb|*`


Use of magic commands implemented by *pyensae*.

.. code:: ipython3

    %load_ext pyensae
    from pyensae.sql import Database

.. code:: ipython3

    %lsr .*[.]ipynb






.. raw:: html

    <div>
    <table border="1" class="dataframe">
      <thead>
        <tr style="text-align: right;">
          <th></th>
          <th>directory</th>
          <th>last_modified</th>
          <th>name</th>
          <th>size</th>
        </tr>
      </thead>
      <tbody>
        <tr>
          <th>0</th>
          <td>False</td>
          <td>2016-11-09 23:35:42.656229</td>
          <td>.\azure_blob_storage.ipynb</td>
          <td>33.91 Kb</td>
        </tr>
        <tr>
          <th>1</th>
          <td>False</td>
          <td>2016-11-09 23:35:42.667238</td>
          <td>.\example_corrplot.ipynb</td>
          <td>203.16 Kb</td>
        </tr>
        <tr>
          <th>2</th>
          <td>False</td>
          <td>2016-11-09 23:35:42.683248</td>
          <td>.\example_of_ssh_client_communication.ipynb</td>
          <td>199.06 Kb</td>
        </tr>
        <tr>
          <th>3</th>
          <td>False</td>
          <td>2016-11-09 23:35:42.695257</td>
          <td>.\folium_map.ipynb</td>
          <td>17.60 Kb</td>
        </tr>
        <tr>
          <th>4</th>
          <td>False</td>
          <td>2017-01-07 18:38:26.725089</td>
          <td>.\magic_commands_about_files.ipynb</td>
          <td>15.37 Kb</td>
        </tr>
        <tr>
          <th>5</th>
          <td>False</td>
          <td>2016-12-28 23:04:00.646329</td>
          <td>.\pyensae_flat2db3.ipynb</td>
          <td>72.66 Kb</td>
        </tr>
        <tr>
          <th>6</th>
          <td>False</td>
          <td>2016-12-28 23:04:00.681589</td>
          <td>.\pyensae_sql_magic.ipynb</td>
          <td>71.64 Kb</td>
        </tr>
        <tr>
          <th>7</th>
          <td>False</td>
          <td>2016-11-09 23:35:42.728279</td>
          <td>.\pyensae_StockPrices.ipynb</td>
          <td>488.76 Kb</td>
        </tr>
        <tr>
          <th>8</th>
          <td>False</td>
          <td>2016-12-28 23:04:00.747517</td>
          <td>.\pyensae_text2table.ipynb</td>
          <td>25.68 Kb</td>
        </tr>
        <tr>
          <th>9</th>
          <td>False</td>
          <td>2016-11-09 23:35:42.770842</td>
          <td>.\pyensae_velib.ipynb</td>
          <td>300.54 Kb</td>
        </tr>
        <tr>
          <th>10</th>
          <td>False</td>
          <td>2016-11-09 23:35:42.778852</td>
          <td>.\python_hadoop_pig.ipynb</td>
          <td>57.73 Kb</td>
        </tr>
        <tr>
          <th>11</th>
          <td>False</td>
          <td>2016-11-09 23:35:42.784856</td>
          <td>.\using_qgrid_with_jsdf.ipynb</td>
          <td>6.71 Kb</td>
        </tr>
        <tr>
          <th>12</th>
          <td>False</td>
          <td>2016-12-28 23:04:00.827547</td>
          <td>.\view_differences.ipynb</td>
          <td>49.39 Kb</td>
        </tr>
        <tr>
          <th>13</th>
          <td>False</td>
          <td>2016-12-28 23:04:00.838553</td>
          <td>.\.ipynb_checkpoints\magic_commands_about_file...</td>
          <td>26.17 Kb</td>
        </tr>
        <tr>
          <th>14</th>
          <td>False</td>
          <td>2016-12-28 23:04:00.915596</td>
          <td>.\.ipynb_checkpoints\pyensae_flat2db3-checkpoi...</td>
          <td>72.66 Kb</td>
        </tr>
        <tr>
          <th>15</th>
          <td>False</td>
          <td>2016-12-28 23:04:00.931221</td>
          <td>.\.ipynb_checkpoints\pyensae_sql_magic-checkpo...</td>
          <td>71.64 Kb</td>
        </tr>
        <tr>
          <th>16</th>
          <td>False</td>
          <td>2016-12-28 23:04:00.961358</td>
          <td>.\.ipynb_checkpoints\pyensae_text2table-checkp...</td>
          <td>25.68 Kb</td>
        </tr>
        <tr>
          <th>17</th>
          <td>False</td>
          <td>2016-12-28 23:04:00.984509</td>
          <td>.\.ipynb_checkpoints\view_differences-checkpoi...</td>
          <td>49.39 Kb</td>
        </tr>
      </tbody>
    </table>
    </div>



.. code:: ipython3

    %head --help


.. parsed-literal::
    usage: head [-h] [-n N] [-r] [-e ENCODING] [-s ERRORS] f
    display the first lines of a text file
    positional arguments:
      f                     filename
    optional arguments:
      -h, --help            show this help message and exit
      -n N, --n N           number of lines to display
      -r, --raw             display raw text instead of HTML
      -e ENCODING, --encoding ENCODING
                            file encoding
      -s ERRORS, --errors ERRORS
                            What about errors: "", strict, replace,
                            surrogateescape, xmlcharrefreplace, backslashreplace,
                            namereplace
    usage: head [-h] [-n N] [-r] [-e ENCODING] [-s ERRORS] f
    


.. code:: ipython3

    %hhelp Database.__init__






.. raw:: html

    <?xml version="1.0" encoding="unicode" ?>
    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    <head>
    <meta http-equiv="Content-Type" content="text/html; charset=unicode" />
    <meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
    <title></title>
    <link rel="stylesheet" href="c:/python35_x64/lib/site-packages/docutils/writers/html4css1/html4css1.css" type="text/css" />
    </head>
    <body>
    <div class="document">
    <p>constructor</p>
    <table class="docutils field-list" frame="void" rules="none">
    <col class="field-name" />
    <col class="field-body" />
    <tbody valign="top">
    <tr class="field-odd field"><th class="field-name" colspan="2">param      dbfile:</th></tr>
    <tr class="field-odd field"><td>&nbsp;</td><td class="field-body"><p class="first">database file (use <code class="docutils literal"><span class="pre">:memory:</span></code> to avoid creating a file and using only memory)
    it can also contain several files separated by ;:</p>
    <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">name_file</span> <span class="p">;</span> <span class="n">nickname</span><span class="p">,</span><span class="n">second_file</span> <span class="p">;</span> <span class="o">...</span>
    </pre></div>
    </div>
    </td>
    </tr>
    <tr class="field-even field"><th class="field-name" colspan="2">param      engine:</th></tr>
    <tr class="field-even field"><td>&nbsp;</td><td class="field-body"><p class="first">SQLite or MySQL (if it is installed)</p>
    </td>
    </tr>
    <tr class="field-odd field"><th class="field-name" colspan="2">param      user:</th></tr>
    <tr class="field-odd field"><td>&nbsp;</td><td class="field-body"><p class="first">user if needed</p>
    </td>
    </tr>
    <tr class="field-even field"><th class="field-name" colspan="2">param      password:</th></tr>
    <tr class="field-even field"><td>&nbsp;</td><td class="field-body"><p class="first">password if needed</p>
    </td>
    </tr>
    <tr class="field-odd field"><th class="field-name" colspan="2">param      host:</th></tr>
    <tr class="field-odd field"><td>&nbsp;</td><td class="field-body"><p class="first">to connect to a MSSQL database</p>
    </td>
    </tr>
    <tr class="field-even field"><th class="field-name">param      LOG:</th><td class="field-body"><p class="first">LOG function</p>
    </td>
    </tr>
    <tr class="field-odd field"><th class="field-name" colspan="2">param      attach:</th></tr>
    <tr class="field-odd field"><td>&nbsp;</td><td class="field-body"><p class="first last">dictionary: { nickname: filename }, list of database to attach</p>
    </td>
    </tr>
    </tbody>
    </table>
    <div class="warning admonition">
    <p class="first admonition-title">Warning</p>
    <p class="last">If the folder does not exist, it will be created</p>
    </div>
    <p></p>
    </div>
    </body>
    </html>




.. code:: ipython3

    %hhelp -f text Database.__init__


.. parsed-literal::

            constructor
            @param      dbfile          database file (use ``:memory:`` to avoid creating a file and using only memory)
                                        it can also contain several files separated by ;
                                            @code
                                            name_file ; nickname,second_file ; ...
                                            @endcode
            @param      engine          SQLite or MySQL (if it is installed)
            @param      user            user if needed
            @param      password        password if needed
            @param      host            to connect to a MSSQL database
            @param      LOG             LOG function
            @param      attach          dictionary: { nickname: filename }, list of database to attach
            @warning If the folder does not exist, it will be created
            


.. code:: ipython3

    %encoding pyensae_sql_magic.ipynb




.. parsed-literal::
    "{'confidence': 1.0, 'encoding': 'ascii'}"