:py:mod:`aiida_vasp.utils.extended_dicts`
=========================================

.. py:module:: aiida_vasp.utils.extended_dicts

.. autodoc2-docstring:: aiida_vasp.utils.extended_dicts
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`DictWithAttributes <aiida_vasp.utils.extended_dicts.DictWithAttributes>`
     - .. autodoc2-docstring:: aiida_vasp.utils.extended_dicts.DictWithAttributes
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`delete_keys_from_dict <aiida_vasp.utils.extended_dicts.delete_keys_from_dict>`
     - .. autodoc2-docstring:: aiida_vasp.utils.extended_dicts.delete_keys_from_dict
          :summary:
   * - :py:obj:`delete_nested_key <aiida_vasp.utils.extended_dicts.delete_nested_key>`
     - .. autodoc2-docstring:: aiida_vasp.utils.extended_dicts.delete_nested_key
          :summary:
   * - :py:obj:`update_nested_dict <aiida_vasp.utils.extended_dicts.update_nested_dict>`
     - .. autodoc2-docstring:: aiida_vasp.utils.extended_dicts.update_nested_dict
          :summary:
   * - :py:obj:`update_nested_dict_node <aiida_vasp.utils.extended_dicts.update_nested_dict_node>`
     - .. autodoc2-docstring:: aiida_vasp.utils.extended_dicts.update_nested_dict_node
          :summary:

API
~~~

.. py:class:: DictWithAttributes(dictionary: collections.abc.Mapping[str, typing.Any] | None = None)
   :canonical: aiida_vasp.utils.extended_dicts.DictWithAttributes

   Bases: :py:obj:`aiida.common.extendeddicts.AttributeDict`

   .. autodoc2-docstring:: aiida_vasp.utils.extended_dicts.DictWithAttributes

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.utils.extended_dicts.DictWithAttributes.__init__

   .. py:method:: __getattr__(attr: str) -> typing.Any
      :canonical: aiida_vasp.utils.extended_dicts.DictWithAttributes.__getattr__

      .. autodoc2-docstring:: aiida_vasp.utils.extended_dicts.DictWithAttributes.__getattr__

   .. py:method:: __setattr__(attr: str, value: typing.Any) -> None
      :canonical: aiida_vasp.utils.extended_dicts.DictWithAttributes.__setattr__

      .. autodoc2-docstring:: aiida_vasp.utils.extended_dicts.DictWithAttributes.__setattr__

.. py:function:: delete_keys_from_dict(dictionary: dict[str, typing.Any], keys: str | list[str]) -> None
   :canonical: aiida_vasp.utils.extended_dicts.delete_keys_from_dict

   .. autodoc2-docstring:: aiida_vasp.utils.extended_dicts.delete_keys_from_dict

.. py:function:: delete_nested_key(dictionary: dict[str, typing.Any], keys: list[str]) -> None
   :canonical: aiida_vasp.utils.extended_dicts.delete_nested_key

   .. autodoc2-docstring:: aiida_vasp.utils.extended_dicts.delete_nested_key

.. py:function:: update_nested_dict(dict1: dict[str, typing.Any], dict2: dict[str, typing.Any], extend_list: bool = False) -> dict[str, typing.Any]
   :canonical: aiida_vasp.utils.extended_dicts.update_nested_dict

   .. autodoc2-docstring:: aiida_vasp.utils.extended_dicts.update_nested_dict

.. py:function:: update_nested_dict_node(dict_node: aiida.orm.Dict, update_dict: dict[str, typing.Any], extend_list: bool = False) -> aiida.orm.Dict
   :canonical: aiida_vasp.utils.extended_dicts.update_nested_dict_node

   .. autodoc2-docstring:: aiida_vasp.utils.extended_dicts.update_nested_dict_node