:py:mod:`aiida_vasp.commands.option_parser`
===========================================

.. py:module:: aiida_vasp.commands.option_parser

.. autodoc2-docstring:: aiida_vasp.commands.option_parser
   :allowtitles:

Module Contents
---------------

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`OptionParser <aiida_vasp.commands.option_parser.OptionParser>`
     - .. autodoc2-docstring:: aiida_vasp.commands.option_parser.OptionParser
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`process_dict_option <aiida_vasp.commands.option_parser.process_dict_option>`
     - .. autodoc2-docstring:: aiida_vasp.commands.option_parser.process_dict_option
          :summary:
   * - :py:obj:`parse_hierarchical_dict <aiida_vasp.commands.option_parser.parse_hierarchical_dict>`
     - .. autodoc2-docstring:: aiida_vasp.commands.option_parser.parse_hierarchical_dict
          :summary:
   * - :py:obj:`convert_value <aiida_vasp.commands.option_parser.convert_value>`
     - .. autodoc2-docstring:: aiida_vasp.commands.option_parser.convert_value
          :summary:

API
~~~

.. py:class:: OptionParser
   :canonical: aiida_vasp.commands.option_parser.OptionParser

   .. autodoc2-docstring:: aiida_vasp.commands.option_parser.OptionParser

   .. py:method:: nested_dict()
      :canonical: aiida_vasp.commands.option_parser.OptionParser.nested_dict
      :staticmethod:

      .. autodoc2-docstring:: aiida_vasp.commands.option_parser.OptionParser.nested_dict

   .. py:method:: process_dict_option(value: str | None) -> dict
      :canonical: aiida_vasp.commands.option_parser.OptionParser.process_dict_option
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.commands.option_parser.OptionParser.process_dict_option

   .. py:method:: parse_hierarchical_dict(settings_str: str) -> dict
      :canonical: aiida_vasp.commands.option_parser.OptionParser.parse_hierarchical_dict
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.commands.option_parser.OptionParser.parse_hierarchical_dict

   .. py:method:: convert_value(value: str)
      :canonical: aiida_vasp.commands.option_parser.OptionParser.convert_value
      :staticmethod:

      .. autodoc2-docstring:: aiida_vasp.commands.option_parser.OptionParser.convert_value

   .. py:method:: _defaultdict_to_dict(d)
      :canonical: aiida_vasp.commands.option_parser.OptionParser._defaultdict_to_dict
      :staticmethod:

      .. autodoc2-docstring:: aiida_vasp.commands.option_parser.OptionParser._defaultdict_to_dict

   .. py:method:: _parse_text_as_dict(resources_str: str) -> dict
      :canonical: aiida_vasp.commands.option_parser.OptionParser._parse_text_as_dict
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.commands.option_parser.OptionParser._parse_text_as_dict

   .. py:method:: _load_dict_from_file(overrides_path: pathlib.Path | str) -> dict
      :canonical: aiida_vasp.commands.option_parser.OptionParser._load_dict_from_file
      :staticmethod:

      .. autodoc2-docstring:: aiida_vasp.commands.option_parser.OptionParser._load_dict_from_file

.. py:function:: process_dict_option(value: str | None) -> dict
   :canonical: aiida_vasp.commands.option_parser.process_dict_option

   .. autodoc2-docstring:: aiida_vasp.commands.option_parser.process_dict_option

.. py:function:: parse_hierarchical_dict(settings_str: str) -> dict
   :canonical: aiida_vasp.commands.option_parser.parse_hierarchical_dict

   .. autodoc2-docstring:: aiida_vasp.commands.option_parser.parse_hierarchical_dict

.. py:function:: convert_value(value: str)
   :canonical: aiida_vasp.commands.option_parser.convert_value

   .. autodoc2-docstring:: aiida_vasp.commands.option_parser.convert_value