File: api.rst

package info (click to toggle)
dotty-dict 1.3.1-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 352 kB
  • sloc: python: 1,166; makefile: 192; sh: 5
file content (33 lines) | stat: -rw-r--r-- 647 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
==========
Public API
==========

.. seealso:: Check out :ref:`examples` derived from real and fully tested source code.

.. py:module:: dotty_dict.dotty_dict

.. autofunction:: dotty

.. autoclass:: Dotty
   :member-order: alphabetical
   :members:

   .. method:: clear()

      Removes all elements from dotty dict.

   .. method:: items()

      Returns generator of dotty dict's (key, value) tuple pairs.

   .. method:: keys()

      Returns generator of dotty dict's keys.

   .. method:: values()

      Returns generator of dotty dict's values.

   .. method:: update(dict2)

      Adds dictionary dict2's key-values pairs to dotty dict.