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

.. py:module:: aiida_vasp.parsers.content_parsers.win

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

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

Classes
~~~~~~~

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

   * - :py:obj:`BaseKeyValueParser <aiida_vasp.parsers.content_parsers.win.BaseKeyValueParser>`
     - .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.BaseKeyValueParser
          :summary:
   * - :py:obj:`KeyValueParser <aiida_vasp.parsers.content_parsers.win.KeyValueParser>`
     - .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser
          :summary:
   * - :py:obj:`WinParser <aiida_vasp.parsers.content_parsers.win.WinParser>`
     - .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.WinParser
          :summary:

API
~~~

.. py:class:: BaseKeyValueParser
   :canonical: aiida_vasp.parsers.content_parsers.win.BaseKeyValueParser

   .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.BaseKeyValueParser

   .. py:attribute:: empty_line
      :canonical: aiida_vasp.parsers.content_parsers.win.BaseKeyValueParser.empty_line
      :value: 'compile(...)'

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.BaseKeyValueParser.empty_line

   .. py:method:: line(fobj_or_str: str | typing.Any, d_type: type = str) -> typing.Any
      :canonical: aiida_vasp.parsers.content_parsers.win.BaseKeyValueParser.line
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.BaseKeyValueParser.line

   .. py:method:: splitlines(fobj_or_str: str | typing.Any, d_type: type = float) -> list[typing.Any]
      :canonical: aiida_vasp.parsers.content_parsers.win.BaseKeyValueParser.splitlines
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.BaseKeyValueParser.splitlines

.. py:class:: KeyValueParser
   :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser

   Bases: :py:obj:`aiida_vasp.parsers.content_parsers.win.BaseKeyValueParser`

   .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser

   .. py:attribute:: assignment
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.assignment
      :value: 'compile(...)'

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.assignment

   .. py:attribute:: bool_true
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.bool_true
      :value: 'compile(...)'

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.bool_true

   .. py:attribute:: bool_false
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.bool_false
      :value: 'compile(...)'

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.bool_false

   .. py:attribute:: comment
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.comment
      :value: True

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.comment

   .. py:method:: get_lines(filename: str) -> list[str]
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.get_lines
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.get_lines

   .. py:method:: retval(*args: typing.Any, **kwargs: typing.Any) -> dict[str, typing.Any]
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.retval
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.retval

   .. py:method:: flatten(lst: list[list[typing.Any]]) -> list[typing.Any]
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.flatten
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.flatten

   .. py:method:: find_kv(line: str) -> list[tuple[str, str]]
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.find_kv
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.find_kv

   .. py:method:: float(string_: str) -> dict[str, typing.Any]
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.float
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.float

   .. py:method:: float_unit(string_: str) -> dict[str, typing.Any]
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.float_unit
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.float_unit

   .. py:method:: int(string_: str) -> dict[str, typing.Any]
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.int
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.int

   .. py:method:: int_unit(string_: str) -> dict[str, typing.Any]
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.int_unit
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.int_unit

   .. py:method:: string(string_: str) -> dict[str, typing.Any]
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.string
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.string

   .. py:method:: bool(string_: str) -> dict[str, typing.Any]
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.bool
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.bool

   .. py:method:: kv_list(filename: str) -> list[typing.Any]
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.kv_list
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.kv_list

   .. py:method:: kv_dict(kv_list: list[typing.Any]) -> dict[str, typing.Any]
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.kv_dict
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.kv_dict

   .. py:method:: clean_value(str_value: str) -> dict[str, typing.Any]
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.clean_value
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.clean_value

   .. py:method:: get_converter_iter() -> typing.Any
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.get_converter_iter
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.get_converter_iter

   .. py:method:: try_convert(input_value: str, converter: typing.Callable[[str], dict[str, typing.Any]]) -> dict[str, typing.Any] | None
      :canonical: aiida_vasp.parsers.content_parsers.win.KeyValueParser.try_convert
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.KeyValueParser.try_convert

.. py:class:: WinParser(path: str)
   :canonical: aiida_vasp.parsers.content_parsers.win.WinParser

   Bases: :py:obj:`aiida_vasp.parsers.content_parsers.win.KeyValueParser`

   .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.WinParser

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.WinParser.__init__

   .. py:attribute:: block
      :canonical: aiida_vasp.parsers.content_parsers.win.WinParser.block
      :value: 'compile(...)'

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.WinParser.block

   .. py:attribute:: comment
      :canonical: aiida_vasp.parsers.content_parsers.win.WinParser.comment
      :value: 'compile(...)'

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.WinParser.comment

   .. py:method:: parse_win(fobj_or_str: str | typing.Any) -> tuple[dict[str, typing.Any], dict[str, list[str]], list[str]]
      :canonical: aiida_vasp.parsers.content_parsers.win.WinParser.parse_win
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.parsers.content_parsers.win.WinParser.parse_win