Configuration
=============

.. currentmodule:: sofia_redux.scan.configuration.configuration

.. autoclass:: Configuration
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~Configuration.blacklisted
      ~Configuration.command_keys
      ~Configuration.command_order
      ~Configuration.current_iteration
      ~Configuration.expected_path
      ~Configuration.handler_keys
      ~Configuration.max_iteration
      ~Configuration.preserved_cards
      ~Configuration.section_keys
      ~Configuration.user_path

   .. rubric:: Methods Summary

   .. autosummary::

      ~Configuration.add_new_branch
      ~Configuration.add_preserved_header_keys
      ~Configuration.apply_commands
      ~Configuration.apply_configuration_options
      ~Configuration.blacklist
      ~Configuration.check_trigger
      ~Configuration.clear
      ~Configuration.configuration_difference
      ~Configuration.copy
      ~Configuration.dot_key_in_set
      ~Configuration.edit_header
      ~Configuration.exists
      ~Configuration.expand_options
      ~Configuration.find_configuration_files
      ~Configuration.flatten
      ~Configuration.forget
      ~Configuration.get
      ~Configuration.get_active_options
      ~Configuration.get_branch
      ~Configuration.get_configuration_filepath
      ~Configuration.get_filepath
      ~Configuration.get_flat_alphabetical
      ~Configuration.get_keys
      ~Configuration.get_options
      ~Configuration.get_preserved_header_keys
      ~Configuration.get_section_handler
      ~Configuration.has_option
      ~Configuration.is_blacklisted
      ~Configuration.is_configured
      ~Configuration.is_disabled
      ~Configuration.is_locked
      ~Configuration.key_value_to_dict
      ~Configuration.lock
      ~Configuration.lock_rounds
      ~Configuration.matching_set_dot_key
      ~Configuration.matching_wildcard
      ~Configuration.matching_wildcard_keys
      ~Configuration.merge_fits_options
      ~Configuration.merge_options
      ~Configuration.normalize_options
      ~Configuration.order_options
      ~Configuration.parse_configuration_body
      ~Configuration.parse_key_value
      ~Configuration.parse_to_section
      ~Configuration.preserve_header_keys
      ~Configuration.priority_file
      ~Configuration.purge
      ~Configuration.put
      ~Configuration.read_configuration
      ~Configuration.read_configuration_file
      ~Configuration.read_configurations
      ~Configuration.read_fits
      ~Configuration.recall
      ~Configuration.remove_disabled_key
      ~Configuration.resolve_filepath
      ~Configuration.set_date
      ~Configuration.set_error_handling
      ~Configuration.set_instrument
      ~Configuration.set_iteration
      ~Configuration.set_object
      ~Configuration.set_option
      ~Configuration.set_outpath
      ~Configuration.set_serial
      ~Configuration.set_verbosity
      ~Configuration.unlock
      ~Configuration.update
      ~Configuration.update_sections
      ~Configuration.validate
      ~Configuration.whitelist

   .. rubric:: Attributes Documentation

   .. autoattribute:: blacklisted
   .. autoattribute:: command_keys
   .. autoattribute:: command_order
   .. autoattribute:: current_iteration
   .. autoattribute:: expected_path
   .. autoattribute:: handler_keys
   .. autoattribute:: max_iteration
   .. autoattribute:: preserved_cards
   .. autoattribute:: section_keys
   .. autoattribute:: user_path

   .. rubric:: Methods Documentation

   .. automethod:: add_new_branch
   .. automethod:: add_preserved_header_keys
   .. automethod:: apply_commands
   .. automethod:: apply_configuration_options
   .. automethod:: blacklist
   .. automethod:: check_trigger
   .. automethod:: clear
   .. automethod:: configuration_difference
   .. automethod:: copy
   .. automethod:: dot_key_in_set
   .. automethod:: edit_header
   .. automethod:: exists
   .. automethod:: expand_options
   .. automethod:: find_configuration_files
   .. automethod:: flatten
   .. automethod:: forget
   .. automethod:: get
   .. automethod:: get_active_options
   .. automethod:: get_branch
   .. automethod:: get_configuration_filepath
   .. automethod:: get_filepath
   .. automethod:: get_flat_alphabetical
   .. automethod:: get_keys
   .. automethod:: get_options
   .. automethod:: get_preserved_header_keys
   .. automethod:: get_section_handler
   .. automethod:: has_option
   .. automethod:: is_blacklisted
   .. automethod:: is_configured
   .. automethod:: is_disabled
   .. automethod:: is_locked
   .. automethod:: key_value_to_dict
   .. automethod:: lock
   .. automethod:: lock_rounds
   .. automethod:: matching_set_dot_key
   .. automethod:: matching_wildcard
   .. automethod:: matching_wildcard_keys
   .. automethod:: merge_fits_options
   .. automethod:: merge_options
   .. automethod:: normalize_options
   .. automethod:: order_options
   .. automethod:: parse_configuration_body
   .. automethod:: parse_key_value
   .. automethod:: parse_to_section
   .. automethod:: preserve_header_keys
   .. automethod:: priority_file
   .. automethod:: purge
   .. automethod:: put
   .. automethod:: read_configuration
   .. automethod:: read_configuration_file
   .. automethod:: read_configurations
   .. automethod:: read_fits
   .. automethod:: recall
   .. automethod:: remove_disabled_key
   .. automethod:: resolve_filepath
   .. automethod:: set_date
   .. automethod:: set_error_handling
   .. automethod:: set_instrument
   .. automethod:: set_iteration
   .. automethod:: set_object
   .. automethod:: set_option
   .. automethod:: set_outpath
   .. automethod:: set_serial
   .. automethod:: set_verbosity
   .. automethod:: unlock
   .. automethod:: update
   .. automethod:: update_sections
   .. automethod:: validate
   .. automethod:: whitelist