summaryrefslogtreecommitdiff
path: root/docs/lib/bps.basic.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/lib/bps.basic.rst')
-rw-r--r--docs/lib/bps.basic.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/lib/bps.basic.rst b/docs/lib/bps.basic.rst
new file mode 100644
index 0000000..1698f9d
--- /dev/null
+++ b/docs/lib/bps.basic.rst
@@ -0,0 +1,35 @@
+========================================================
+:mod:`bps.basic` -- Manipulation of basic Python objects
+========================================================
+
+.. module:: bps.basic
+ :synopsis: tools for manipulating basic python datatypes
+
+This module contains utilities for manipulating the basic python
+datatypes, like :class:`dict` or :class:`list`. It also
+contains functions such as would be found in :mod:`functools`
+and :mod:`itertools`, under the rationale that functions
+and generators can also be considered basic python objects.
+
+Dictionary Helpers
+==================
+.. autofunction:: invert_dict
+.. autofunction:: zip_dict
+.. autofunction:: unzip_dict
+.. autofunction:: pop_from_dict
+.. autofunction:: update_dict_defaults
+.. autofunction:: prefix_from_dict
+
+Iterator and Functional Helpers
+===============================
+.. autofunction:: iter_unique
+.. autofunction:: unique
+
+Set and Sequence Helpers
+========================
+.. autofunction:: intersects
+.. autofunction:: sameset
+
+..
+ not documented:
+ .. autofunction:: revpartial