ActiveConfigProgramOptions Class Reference
==========================================

The ActiveConfigProgramOptions module is an extension of ``activeconfigparser.ActiveConfigParser``
which implements handlers for *environment variable* and *environment modules* rules in
a .ini file.

Supported .ini File Operations
------------------------------
.. csv-table:: Supported Operations
    :file: tbl_activeconfigprogramoptions_commands.csv
    :header-rows: 1
    :widths: 20,30,80


API Documentation
-----------------
.. automodule:: activeconfigprogramoptions.ActiveConfigProgramOptions
   :no-members:


Public API
++++++++++
.. autoclass:: activeconfigprogramoptions.ActiveConfigProgramOptions
   :noindex:
   :members:
   :undoc-members:
   :show-inheritance:
   :special-members: __init__
   :exclude-members:
      handler_finalize,
      handler_initialize

.. autoproperty:: activeconfigprogramoptions.ActiveConfigProgramOptions.options


Private API
+++++++++++

Properties
~~~~~~~~~~
.. autoproperty:: activeconfigprogramoptions.ActiveConfigProgramOptions._data_shared_key


Handlers
~~~~~~~~
.. automethod:: activeconfigprogramoptions.ActiveConfigProgramOptions._handler_opt_set
.. automethod:: activeconfigprogramoptions.ActiveConfigProgramOptions._handler_opt_remove
.. automethod:: activeconfigprogramoptions.ActiveConfigProgramOptions.handler_initialize
.. automethod:: activeconfigprogramoptions.ActiveConfigProgramOptions.handler_finalize
.. automethod:: activeconfigprogramoptions.ActiveConfigProgramOptions._initialize_handler_parameters


Handler Helpers
~~~~~~~~~~~~~~~
.. automethod:: activeconfigprogramoptions.ActiveConfigProgramOptions._option_handler_helper_add
.. automethod:: activeconfigprogramoptions.ActiveConfigProgramOptions._option_handler_helper_remove


Program Option Handlers
~~~~~~~~~~~~~~~~~~~~~~~
.. automethod:: activeconfigprogramoptions.ActiveConfigProgramOptions._program_option_handler_opt_set_bash
.. automethod:: activeconfigprogramoptions.ActiveConfigProgramOptions._generic_program_option_handler_bash

.. automethod:: activeconfigprogramoptions.ActiveConfigProgramOptions._gen_option_entry