.. _l-classes:

Classes
=======

.. contents::
    :local:
    :depth: 1


Summary
+++++++

+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| class                                                                                                                           | class parent | truncated documentation                                                                                                                     |
+=================================================================================================================================+==============+=============================================================================================================================================+
| :class:`AutoCompletionSQLObject <pyensae.sql.sql_interface.AutoCompletionSQLObject>`                                            |              | a simple class which allows auto completion for tables, columns...                                                                          |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CSharpClass <pyensae.sphinxext.csharp_parser.CSharpClass>`                                                              |              | :epkg:`C#` class.                                                                                                                           |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CSharpDomain <pyensae.sphinxext.csharp_parser.CSharpDomain>`                                                            |              | Base class of a :epkg:`C#` domaon.                                                                                                          |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CSharpElement <pyensae.sphinxext.csharp_parser.CSharpElement>`                                                          |              | Base class of a :epkg:`C#` element.                                                                                                         |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CSharpLexer <pyensae.languages.CSharpLexer.CSharpLexer>`                                                                |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CSharpLexerBase <pyensae.languages.CSharpLexerBase.CSharpLexerBase>`                                                    |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CSharpMethod <pyensae.sphinxext.csharp_parser.CSharpMethod>`                                                            |              | :epkg:`C#` function.                                                                                                                        |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CSharpParser <pyensae.languages.CSharpParser.CSharpParser>`                                                             |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CSharpParser <pyensae.sphinxext.csharp_parser.CSharpParser>`                                                            |              | Parses :epkg:`C#`.                                                                                                                          |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CSharpParserBase <pyensae.languages.CSharpParserBase.CSharpParserBase>`                                                 |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CSharpParserListener <pyensae.languages.CSharpParserListener.CSharpParserListener>`                                     |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CSharpParserListenerSignatures <pyensae.sphinxext.csharp_parser.CSharpParserListenerSignatures>`                        |              | :epkg:`C#` Listener                                                                                                                         |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CSharpPreprocessorParser <pyensae.languages.CSharpPreprocessorParser.CSharpPreprocessorParser>`                         |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CSharpPreprocessorParserListener <pyensae.languages.CSharpPreprocessorParserListener.CSharpPreprocessorParserListener>` |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CSharpType <pyensae.sphinxext.csharp_parser.CSharpType>`                                                                |              | :epkg:`C#` type                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`CSharpVariable <pyensae.sphinxext.csharp_parser.CSharpVariable>`                                                        |              | :epkg:`C#` variables                                                                                                                        |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Color <pyensae.graphhelper._colormap.Color>`                                                                            |              | Lists of known colors.                                                                                                                      |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Colormap <pyensae.graphhelper._colormap.Colormap>`                                                                      |              | Snippets of code from `colormap/colors.py <https://github.com/cokelaer/colormap/blob/master/src/colormap/colors.py>`_, ...                  |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Corrplot <pyensae.graphhelper.corrplot.Corrplot>`                                                                       |              | An implementation of correlation plotting tools (corrplot). the class requires `scipy <http://www.scipy.org/>`_. ...                        |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`DBException <pyensae.sql.database_exception.DBException>`                                                               |              | custom exception                                                                                                                            |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`DOTLexer <pyensae.languages.DOTLexer.DOTLexer>`                                                                         |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`DOTListener <pyensae.languages.DOTListener.DOTListener>`                                                                |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`DOTParser <pyensae.languages.DOTParser.DOTParser>`                                                                      |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Database <pyensae.sql.database_main.Database>`                                                                          |              | This class allows the user to load table from text files and store them into a SQL file which can be empty or not, ...                      |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`DatabaseCore <pyensae.sql.database_core.DatabaseCore>`                                                                  |              | Core methods for class :class:`Database`.                                                                                                   |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`DatabaseCore2 <pyensae.sql.database_core2.DatabaseCore2>`                                                               |              | Complementary methods for class :class:`Database`.                                                                                          |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`DatabaseImportExport <pyensae.sql.database_import_export.DatabaseImportExport>`                                         |              | This class is not meant to be working alone. It contains import, export function for a database, in various formats. ...                    |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`DatabaseJoinGroup <pyensae.sql.database_join_group.DatabaseJoinGroup>`                                                  |              | This class is not neant to be working alone. It contains functions for a database able to build SQL requests for ...                        |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`DatabaseObject <pyensae.sql.database_object.DatabaseObject>`                                                            |              | Methods for database related to object, see :class:`Database`.                                                                              |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`DownloadDataException <pyensae.datasource.http_retrieve.DownloadDataException>`                                         |              | raised when data cannot be downloaded                                                                                                       |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`ExceptionSQL <pyensae.sql.database_exception.ExceptionSQL>`                                                             |              | exception related to SQL instructions and only them                                                                                         |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`InterfaceSQL <pyensae.sql.sql_interface.InterfaceSQL>`                                                                  |              | Abstract class to connect to a SQL server using various way. It will be used to implement magic functions                                   |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`InterfaceSQLDatabase <pyensae.sql.sql_interface_database.InterfaceSQLDatabase>`                                         |              | Abstract class to connect to a SQL server using various way. It will be used to implement magic functions                                   |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`InterfaceSQLException <pyensae.sql.sql_interface.InterfaceSQLException>`                                                |              | a specific exception                                                                                                                        |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Linkage <pyensae.graphhelper.linkage.Linkage>`                                                                          |              | Linkage used in other tools such as Heatmap, the class requires `scipy <http://www.scipy.org/>`_.                                           |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`MagicFile <pyensae.filehelper.magic_file.MagicFile>`                                                                    |              | Defines magic commands to help with files                                                                                                   |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`MagicGraph <pyensae.graphhelper.magic_graph.MagicGraph>`                                                                |              | Defines magic commands about graphs                                                                                                         |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`MagicNotebook <pyensae.notebookhelper.magic_notebook.MagicNotebook>`                                                    |              | Defines magic commands to help with notebooks                                                                                               |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`MagicSQL <pyensae.sql.magic_sql.MagicSQL>`                                                                              |              | Defines SQL commands to play with `sqlite3 <https://docs.python.org/3.4/library/sqlite3.html>`_ See notebook :ref:`pyensaesqlmagicrst`. ... |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`NoHeaderException <pyensae.sql.database_core2.NoHeaderException>`                                                       |              | just to be meant to be caucht later by a unit test                                                                                          |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Python3Lexer <pyensae.languages.Python3Lexer.Python3Lexer>`                                                             |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Python3Listener <pyensae.languages.Python3Listener.Python3Listener>`                                                    |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`Python3Parser <pyensae.languages.Python3Parser.Python3Parser>`                                                          |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`R2PyConversionError <pyensae.languages.rconverterListener.R2PyConversionError>`                                         |              | Raised when conversion cannot be done.                                                                                                      |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`RFilter <pyensae.languages.RFilter.RFilter>`                                                                            |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`RFilterListener <pyensae.languages.RFilterListener.RFilterListener>`                                                    |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`RLexer <pyensae.languages.RLexer.RLexer>`                                                                               |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`RListener <pyensae.languages.RListener.RListener>`                                                                      |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`RParser <pyensae.languages.RParser.RParser>`                                                                            |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`RetrieveDataException <pyensae.datasource.http_retrieve.RetrieveDataException>`                                         |              | raised when data cannot be downloaded                                                                                                       |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`SQLiteLexer <pyensae.languages.SQLiteLexer.SQLiteLexer>`                                                                |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`SQLiteListener <pyensae.languages.SQLiteListener.SQLiteListener>`                                                       |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`SQLiteParser <pyensae.languages.SQLiteParser.SQLiteParser>`                                                             |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`SQLiteParserListener <pyensae.languages.SQLiteParserListener.SQLiteParserListener>`                                     |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`SimpleWorkflowLexer <pyensae.languages.SimpleWorkflowLexer.SimpleWorkflowLexer>`                                        |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`SimpleWorkflowListener <pyensae.languages.SimpleWorkflowListener.SimpleWorkflowListener>`                               |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`SimpleWorkflowParser <pyensae.languages.SimpleWorkflowParser.SimpleWorkflowParser>`                                     |              |                                                                                                                                             |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`StockPrices <pyensae.finance.astock.StockPrices>`                                                                       |              | Defines a class containing stock prices, provides basic functions, the class uses :epkg:`pandas` to load the data.                          |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`StockPricesException <pyensae.finance.astock.StockPricesException>`                                                     |              | Raised by StockPrices classes.                                                                                                              |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`StockPricesHTTPException <pyensae.finance.astock.StockPricesHTTPException>`                                             |              | Raised by StockPrices classes.                                                                                                              |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`TableFormula <pyensae.mlhelper.table_formula.TableFormula>`                                                             |              | Extends class :epkg:`pandas:DataFrame` or proposes extensions to existing functions using lambda functions. See ...                         |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`TextFile <pyensae.sql.file_text_binary.TextFile>`                                                                       |              | This class opens a text file as if it were a binary file. It can deal with null characters which are missed by open ...                     |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`TextFileColumns <pyensae.sql.file_text_binary_columns.TextFileColumns>`                                                 |              | This class opens a text file as if it were a binary file. It can deal with null characters. The file is interpreted ...                     |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`TreeGraphListener <pyensae.languages.tree_graph_listener.TreeGraphListener>`                                            |              | This class is an attempt to run through the tree and to convert into a graph.                                                               |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`TreeStringListener <pyensae.languages.rconverterListener.TreeStringListener>`                                           |              | This class is an attempt to run through the tree and convert it into a string.                                                              |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| :class:`TreeStringListener <pyensae.languages.tree_string_listener.TreeStringListener>`                                         |              | This class is an attempt to run through the tree and convert it into a string.                                                              |
+---------------------------------------------------------------------------------------------------------------------------------+--------------+---------------------------------------------------------------------------------------------------------------------------------------------+