summaryrefslogtreecommitdiff
path: root/frozendict/__init__.py
diff options
context:
space:
mode:
authorSantiago Lezica <slezica89@gmail.com>2016-07-22 15:03:32 -0300
committerSantiago Lezica <slezica89@gmail.com>2016-07-22 15:03:32 -0300
commit07e5b4653509d78350ce6dcb5529a6ae1e67d738 (patch)
tree0e552c312d241ecc40bd4ffdd26903b5c4636c1a /frozendict/__init__.py
parent70834371671575d0f60f1ab1f9b5bec5894db058 (diff)
Version 1.0
Diffstat (limited to 'frozendict/__init__.py')
-rw-r--r--frozendict/__init__.py9
1 files changed, 7 insertions, 2 deletions
diff --git a/frozendict/__init__.py b/frozendict/__init__.py
index 289baf7..9a63a65 100644
--- a/frozendict/__init__.py
+++ b/frozendict/__init__.py
@@ -4,6 +4,11 @@ import functools
class frozendict(collections.Mapping):
+ """
+ An immutable wrapper around dictionaries that implements the complete :py:class:`collections.Mapping`
+ interface. It can be used as a drop-in replacement for dictionaries where immutability and ordering are desired.
+ """
+
dict_cls = dict
def __init__(self, *args, **kwargs):
@@ -38,7 +43,7 @@ class frozendict(collections.Mapping):
class FrozenOrderedDict(frozendict):
"""
- It is an immutable wrapper around ordered dictionaries that implements the complete :py:class:`collections.Mapping`
- interface. It can be used as a drop-in replacement for dictionaries where immutability and ordering are desired.
+ A FrozenDict subclass that maintains key order
"""
+
dict_cls = collections.OrderedDict