.. _l-functions:

Functions
=========

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


Summary
+++++++

+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| function                                                                                    | class parent | truncated documentation                                                                                                 |
+=============================================================================================+==============+=========================================================================================================================+
| :func:`_setup_hook <pyenbc._setup_hook>`                                                    |              | if this function is added to the module, the help automation and unit tests call it first before anything goes on ...   |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`check <pyenbc.check>`                                                                |              | Checks the library is working. It raises an exception.                                                                  |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`download_jar_from_maven <pyenbc.filehelper.maven_helper.download_jar_from_maven>`    |              | download a jar file from maven                                                                                          |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`download_java_standalone <pyenbc.filehelper.jython_helper.download_java_standalone>` |              | download the standalone jython if it does not exists, we should version ``JYTHON_VERSION`` by default in order to ...   |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`download_pig_standalone <pyenbc.filehelper.pig_helper.download_pig_standalone>`      |              | Downloads the standalone :epkg:`jython`. If it does not exists, we should version ``HADOOP_VERSION`` by default ...     |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`get_hadoop_jars <pyenbc.filehelper.pig_helper.get_hadoop_jars>`                      |              | Returns the list of jars to include into the command line in order to run :epkg:`HADOOP`.                               |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`get_hadoop_path <pyenbc.filehelper.pig_helper.get_hadoop_path>`                      |              | This function assumes a folder pig ``hadoopjar`` is present in this directory, the function returns the folder.         |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`get_java_cmd <pyenbc.filehelper.jython_helper.get_java_cmd>`                         |              | return the java path                                                                                                    |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`get_java_path <pyenbc.filehelper.jython_helper.get_java_path>`                       |              | returns the java path :raises FileNotFoundError: if java is not found                                                   |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`get_jython_jar <pyenbc.filehelper.jython_helper.get_jython_jar>`                     |              | This function assumes a file ``jython-standalone-x.x.x.jar`` is present in this directory, the function returns the ... |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`get_pig_jars <pyenbc.filehelper.pig_helper.get_pig_jars>`                            |              | Returns the list of jars to include into the command line in order to run :epkg:`PIG`.                                  |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`get_pig_path <pyenbc.filehelper.pig_helper.get_pig_path>`                            |              | This function assumes a folder pig ``pigjar`` is present in this directory, the function returns the folder             |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`is_java_installed <pyenbc.filehelper.jython_helper.is_java_installed>`               |              | Checks if :epkg:`java` is installed.                                                                                    |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`load_ipython_extension <pyenbc.load_ipython_extension>`                              |              | to allow the call ``%load_ext pyenbc``                                                                                  |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`register_azure_magics <pyenbc.remote.magic_azure.register_azure_magics>`             |              | register magics function, can be called from a notebook                                                                 |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`register_magics_ssh <pyenbc.remote.magic_remote_ssh.register_magics_ssh>`            |              | register magics function, can be called from a notebook                                                                 |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`run_jython <pyenbc.filehelper.jython_helper.run_jython>`                             |              | runs a jython script and returns the standard output and error                                                          |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+
| :func:`run_pig <pyenbc.filehelper.pig_helper.run_pig>`                                      |              | Runs a :epkg:`pig` script and returns the standard output and error.                                                    |
+---------------------------------------------------------------------------------------------+--------------+-------------------------------------------------------------------------------------------------------------------------+