.. _f-yamlhelper:

module ``jenkinshelper.yaml_helper``
====================================







Short summary
+++++++++++++

module ``pyquickhelper.jenkinshelper.yaml_helper``

Parse a file *.yml* and convert it into a set of actions.


:githublink:`%|py|5`






Functions
+++++++++

+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| function                                                                                                                            | truncated documentation                                                                 |
+=====================================================================================================================================+=========================================================================================+
| :func:`convert_sequence_into_batch_file <pyquickhelper.jenkinshelper.yaml_helper.convert_sequence_into_batch_file>`                 | Converts a sequence of instructions into a batch file.                                  |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :func:`enumerate_convert_yaml_into_instructions <pyquickhelper.jenkinshelper.yaml_helper.enumerate_convert_yaml_into_instructions>` | Converts a :epkg:`yml` file into sequences of instructions, conditions are interpreted. |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :func:`enumerate_processed_yml <pyquickhelper.jenkinshelper.yaml_helper.enumerate_processed_yml>`                                   | Submits or enumerates jobs based on the content of a :epkg:`yml` file.                  |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :func:`evaluate_condition <pyquickhelper.jenkinshelper.yaml_helper.evaluate_condition>`                                             | Evaluates a condition inserted in a :epkg:`yml` file.                                   |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :func:`infer_project_name <pyquickhelper.jenkinshelper.yaml_helper.infer_project_name>`                                             | Infers a project name based on :epkg:`yml` file.                                        |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :func:`interpret_instruction <pyquickhelper.jenkinshelper.yaml_helper.interpret_instruction>`                                       | Interprets an instruction with if statement.                                            |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :func:`load_yaml <pyquickhelper.jenkinshelper.yaml_helper.load_yaml>`                                                               | Loads a :epkg:`yml` file (*.yml*).                                                      |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :func:`ospathdirname <pyquickhelper.jenkinshelper.yaml_helper.ospathdirname>`                                                       | Simple ``o.path.dirname`` for a specific platform.                                      |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :func:`ospathjoin <pyquickhelper.jenkinshelper.yaml_helper.ospathjoin>`                                                             | Simple ``o.path.join`` for a specific platform.                                         |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :func:`pickname <pyquickhelper.jenkinshelper.yaml_helper.pickname>`                                                                 | Picks the first string non null in the list.                                            |
+-------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+








Documentation
+++++++++++++

.. automodule:: pyquickhelper.jenkinshelper.yaml_helper
    :members:
    :special-members: __init__
    :show-inheritance: