:py:mod:`aiida_vasp.parsers.content_parsers.base`
=================================================

.. py:module:: aiida_vasp.parsers.content_parsers.base

.. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`BaseFileParser <aiida_vasp.parsers.content_parsers.base.BaseFileParser>`
     - .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base.BaseFileParser
          :summary:

API
~~~

.. py:class:: BaseFileParser(*, handler: typing.TextIO | typing.BinaryIO | None = None, data: aiida.orm.Data | None = None, settings: dict[str, typing.Any] | None = None, options: dict[str, typing.Any] | None = None, raise_errors: bool = False)
   :canonical: aiida_vasp.parsers.content_parsers.base.BaseFileParser

   .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base.BaseFileParser

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base.BaseFileParser.__init__

   .. py:attribute:: OPEN_MODE
      :canonical: aiida_vasp.parsers.content_parsers.base.BaseFileParser.OPEN_MODE
      :type: str
      :value: 'r'

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base.BaseFileParser.OPEN_MODE

   .. py:attribute:: PARSABLE_QUANTITIES
      :canonical: aiida_vasp.parsers.content_parsers.base.BaseFileParser.PARSABLE_QUANTITIES
      :type: dict[str, typing.Any]
      :value: None

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base.BaseFileParser.PARSABLE_QUANTITIES

   .. py:attribute:: DEFAULT_SETTINGS
      :canonical: aiida_vasp.parsers.content_parsers.base.BaseFileParser.DEFAULT_SETTINGS
      :type: dict[str, typing.Any]
      :value: None

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base.BaseFileParser.DEFAULT_SETTINGS

   .. py:method:: get_all_quantities() -> tuple[dict[str, typing.Any], dict[str, typing.Any]]
      :canonical: aiida_vasp.parsers.content_parsers.base.BaseFileParser.get_all_quantities

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base.BaseFileParser.get_all_quantities

   .. py:property:: parsable_quantities
      :canonical: aiida_vasp.parsers.content_parsers.base.BaseFileParser.parsable_quantities
      :type: list[str]

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base.BaseFileParser.parsable_quantities

   .. py:method:: _set_settings(settings: dict[str, typing.Any] | None) -> None
      :canonical: aiida_vasp.parsers.content_parsers.base.BaseFileParser._set_settings

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base.BaseFileParser._set_settings

   .. py:method:: get_quantity(quantity_key: str) -> typing.Any
      :canonical: aiida_vasp.parsers.content_parsers.base.BaseFileParser.get_quantity

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base.BaseFileParser.get_quantity

   .. py:method:: write(path: str) -> None
      :canonical: aiida_vasp.parsers.content_parsers.base.BaseFileParser.write

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base.BaseFileParser.write

   .. py:method:: _init_from_handler(handler: typing.TextIO | typing.BinaryIO) -> None
      :canonical: aiida_vasp.parsers.content_parsers.base.BaseFileParser._init_from_handler
      :abstractmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base.BaseFileParser._init_from_handler

   .. py:method:: _init_from_data(data: aiida.orm.Data) -> None
      :canonical: aiida_vasp.parsers.content_parsers.base.BaseFileParser._init_from_data
      :abstractmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base.BaseFileParser._init_from_data

   .. py:method:: _content_data_to_content_parser() -> typing.Any
      :canonical: aiida_vasp.parsers.content_parsers.base.BaseFileParser._content_data_to_content_parser
      :abstractmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base.BaseFileParser._content_data_to_content_parser

   .. py:method:: _parse_content() -> dict[str, typing.Any]
      :canonical: aiida_vasp.parsers.content_parsers.base.BaseFileParser._parse_content

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.base.BaseFileParser._parse_content