Updated docs and refactoring to avoid name clashes.

Author: domdfcoding

cawdrey/__init__.py

@@ -29,8 +29,8 @@
 # this package
 from .alphadict import AlphaDict, alphabetical_dict
 from .base import FrozenBase, MutableBase
-from .bdict import bdict
-from .frozendict import frozendict
+from ._bdict import bdict
+from ._frozendict import frozendict
 from .frozenordereddict import FrozenOrderedDict
 from .nonelessdict import NonelessDict, NonelessOrderedDict
 

cawdrey/bdict.py cawdrey/_bdict.pycawdrey/bdict.py renamed to cawdrey/_bdict.py

@@ -58,7 +58,7 @@ class bdict(UserDict):
 
 	Based on https://stackoverflow.com/a/1063393 by https://stackoverflow.com/users/9493/brian
 
-	Improved May 2020 suggestions from
+	Improved May 2020 with suggestions from
 	https://treyhunner.com/2019/04/why-you-shouldnt-inherit-from-list-and-dict-in-python/
 	"""
 

cawdrey/bdict.pyi cawdrey/_bdict.pyicawdrey/bdict.pyi renamed to cawdrey/_bdict.pyi

@@ -60,7 +60,7 @@ def __hash__(self) -> int:
 
 	def sorted(self, *args, by: str = "keys", **kwargs):
 		"""
-		Return a new :class:`~cawdrey.frozendict.frozendict`, with the element
+		Return a new :class:`~cawdrey.frozendict`, with the element
 		insertion sorted. The signature is the same as the builtin
 		:class:`python:sorted` function, except for the additional parameter
 		``by``, that is ``"keys"`` by default and can also be ``"values"`` and

cawdrey/frozendict.py cawdrey/_frozendict.pycawdrey/frozendict.py renamed to cawdrey/_frozendict.py

@@ -49,7 +49,7 @@ def __init__(self, *args, **kwargs):
 
 	def copy(self, *args, **kwargs):
 		"""
-		Return a copy of the :class:`~cawdrey.frozenordereddict.FrozenOrderedDict`.
+		Return a copy of the :class:`~cawdrey.FrozenOrderedDict`.
 
 		:param args:
 		:type args:

cawdrey/frozenordereddict.py

@@ -5,8 +5,8 @@ Base Class
 About
 ========
 
-``FrozenBase`` is the base class for :class:`~cawdrey.frozendict.frozendict`
-and :class:`~cawdrey.frozenordereddict.FrozenOrderedDict`. If you wish to
+``FrozenBase`` is the base class for :class:`~cawdrey.frozendict`
+and :class:`~cawdrey.FrozenOrderedDict`. If you wish to
 construct your own frozen dictionary classes, you may wish to inherit from
 this class.
 
@@ -17,9 +17,10 @@ Usage
 API Reference
 ===========================
 
-.. autoclass:: cawdrey.base.FrozenBase
+.. automodule:: cawdrey.base
 	:members:
 	:inherited-members:
 	:special-members:
 	:private-members:
 	:undoc-members:
+	:exclude-members: __dict__

doc-source/base.rst

@@ -12,6 +12,9 @@ Usage
 API Reference
 ===========================
 
-.. automodule:: cawdrey.alphadict
-    :members:
-    :undoc-members:
+.. autoclass:: cawdrey.AlphaDict
+	:members:
+	:undoc-members:
+	:special-members:
+	:inherited-members:
+	:exclude-members: __dict__

doc-source/classes/alphadict.rst

@@ -15,3 +15,6 @@ API Reference
 .. autoclass:: cawdrey.bdict
 	:members:
 	:undoc-members:
+	:special-members:
+	:inherited-members:
+	:exclude-members: __dict__

doc-source/classes/bdict.rst

@@ -5,19 +5,19 @@ frozendict
 About
 ========
 
-:class:`~cawdrey.frozendict.frozendict` is an immutable wrapper around dictionaries that implements the
+:class:`~cawdrey.frozendict` is an immutable wrapper around dictionaries that implements the
 complete mapping interface. It can be used as a drop-in replacement for
 dictionaries where immutability is desired.
 
 Of course, this is ``python``, and you can still poke around the object's
 internals if you want.
 
-The :class:`~cawdrey.frozendict.frozendict` constructor mimics ``dict``, and all of the expected
+The :class:`~cawdrey.frozendict` constructor mimics :class:`dict`, and all of the expected
 interfaces (``iter``, ``len``, ``repr``, ``hash``, ``getitem``) are provided.
-Note that a :class:`~cawdrey.frozendict.frozendict` does not guarantee the immutability of its values, so
-the utility of ``hash`` method is restricted by usage.
+Note that a :class:`~cawdrey.frozendict` does not guarantee the immutability of its values, so
+the utility of the ``hash`` method is restricted by usage.
 
-The only difference is that the ``copy()`` method of :class:`~cawdrey.frozendict.frozendict` takes
+The only difference is that the ``copy()`` method of :class:`~cawdrey.frozendict` takes
 variable keyword arguments, which will be present as key/value pairs in the new,
 immutable copy.
 
@@ -26,7 +26,7 @@ Usage
 
 .. code-block:: python
 
-	>>> from frozendict import frozendict
+	>>> from cawdrey import frozendict
 	>>>
 	>>> fd = frozendict({ 'hello': 'World' })
 	>>>
@@ -40,17 +40,17 @@ Usage
 	<frozendict {'hello': 'World', 'another': 'key/value'}>
 	>>>
 
-In addition, :class:`~cawdrey.frozendict.frozendict` supports the `+` and `-` operands. If you add a
-`dict`-like object, a new :class:`~cawdrey.frozendict.frozendict` will be returned, equal to the old
-:class:`~cawdrey.frozendict.frozendict` updated with the other object. Example:
+In addition, :class:`~cawdrey.frozendict` supports the `+` and `-` operands. If you add a
+`dict`-like object, a new :class:`~cawdrey.frozendict` will be returned, equal to the old
+:class:`~cawdrey.frozendict` updated with the other object. Example:
 
 .. code-block:: python
 
 	>>> frozendict({"Sulla": "Marco", 2: 3}) + {"Sulla": "Marò", 4: 7}
 	<frozendict {'Sulla': 'Marò', 2: 3, 4: 7}>
 	>>>
 
-You can also subtract an iterable from a :class:`~cawdrey.frozendict.frozendict`. A new :class:`~cawdrey.frozendict.frozendict`
+You can also subtract an iterable from a :class:`~cawdrey.frozendict`. A new :class:`~cawdrey.frozendict`
 will be returned, without the keys that are in the iterable. Examples:
 
 .. code-block::
@@ -66,7 +66,7 @@ Some other examples:
 
 .. code-block:: python
 
-	>>> from frozendict import frozendict
+	>>> from cawdrey import frozendict
 	>>> fd = frozendict({"Sulla": "Marco", "Hicks": "Bill"})
 	>>> print(fd)
 	<frozendict {'Sulla': 'Marco', 'Hicks': 'Bill'}>
@@ -137,26 +137,23 @@ API Reference
 .. autoclass:: cawdrey.frozendict
 	:members:
 	:undoc-members:
+	:special-members:
+	:inherited-members:
+	:exclude-members: __dict__
 
 Copyright
 =========
 
-Based on https://github.com/slezica/python-frozendict and https://github.com/mredolatti/python-frozendict .
-
-Copyright (c) 2012 Santiago Lezica
-
-Licensed under the MIT License:
+| Based on https://github.com/slezica/python-frozendict and https://github.com/mredolatti/python-frozendict .
+| Copyright (c) 2012 Santiago Lezica
+| Licensed under the MIT License:
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-|
-
-Also based on https://github.com/Marco-Sulla/python-frozendict
-
-Copyright (c) Marco Sulla
-
-Licensed under the `GNU Lesser General Public License Version 3 <https://www.gnu.org/licenses/lgpl-3.0.en.html>`_
+| Also based on https://github.com/Marco-Sulla/python-frozendict
+| Copyright (c) Marco Sulla
+| Licensed under the `GNU Lesser General Public License Version 3 <https://www.gnu.org/licenses/lgpl-3.0.en.html>`_

doc-source/classes/frozendict.rst

@@ -5,67 +5,61 @@ FrozenOrderedDict
 About
 ========
 
-:class:`~cawdrey.frozenordereddict.FrozenOrderedDict` is a immutable wrapper around an OrderedDict.
+:class:`~cawdrey.FrozenOrderedDict` is a immutable wrapper around an OrderedDict.
 
-:class:`~cawdrey.frozenordereddict.FrozenOrderedDict` is similar to ``frozendict``, and with regards to immutability it
+:class:`~cawdrey.FrozenOrderedDict` is similar to :class:`~cawdrey.frozendict`, and with regards to immutability it
 solves the same problems:
 
 	- Because dictionaries are mutable, they are not hashable and cannot be used in sets or as dictionary keys.
 	- Nasty bugs can and do occur when mutable data structures are passed around.
 
 It can be initialized just like a :class:`~python:dict` or :class:`~python:collections.OrderedDict`.
-Once instantiated, an instance of :class:`~cawdrey.frozenordereddict.FrozenOrderedDict` cannot be altered,
-since it does not implement the ``MutableMapping`` interface.
+Once instantiated, an instance of :class:`~cawdrey.FrozenOrderedDict` cannot be altered,
+since it does not implement the :class:`~collections.abc.MutableMapping` interface.
 
-It does implement the ``Mapping`` interface, so can be used just like a
+It does implement the :class:`~collections.abc.Mapping` interface, so can be used just like a
 normal dictionary in most cases.
 
-In order to modify the contents of a :class:`~cawdrey.frozenordereddict.FrozenOrderedDict`, a new
+In order to modify the contents of a :class:`~cawdrey.FrozenOrderedDict`, a new
 instance must be created. The easiest way to do that is by
 calling the `.copy()` method. It will return a new instance of
-:class:`~cawdrey.frozenordereddict.FrozenOrderedDict` initialized using the following steps:
+:class:`~cawdrey.FrozenOrderedDict` initialized using the following steps:
 
-	1. A copy of the wrapped OrderedDict instance will be created.
-	2. If any arguments or keyword arguments are passed to the `.copy()` method, they will be used to create another OrderedDict instance, which will then be used to update the copy made in step #1.
+	1. A copy of the wrapped :class:`~python:collections.OrderedDict` instance will be created.
+	2. If any arguments or keyword arguments are passed to the `.copy()` method, they will be used to create another :class:`~python:collections.OrderedDict` instance, which will then be used to update the copy made in step #1.
 	3. Finally, `self.__class__()` will be called, passing the copy as the only argument.
 
 API Reference
 ===========================
 
-.. autoclass:: cawdrey.frozenordereddict.FrozenOrderedDict
+.. autoclass:: cawdrey.FrozenOrderedDict
 	:members:
 	:undoc-members:
+	:special-members:
+	:inherited-members:
+	:exclude-members: __dict__
 
 
 Copyright
 =========
 
-Based on https://github.com/slezica/python-frozendict and https://github.com/mredolatti/python-frozendict .
-
-Copyright (c) 2012 Santiago Lezica
-
-Licensed under the MIT License:
+| Based on https://github.com/slezica/python-frozendict and https://github.com/mredolatti/python-frozendict .
+| Copyright (c) 2012 Santiago Lezica
+| Licensed under the MIT License:
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-|
-
-Also based on
-https://github.com/Marco-Sulla/python-frozendict
-Copyright (c) Marco Sulla
-Licensed under the `GNU Lesser General Public License Version 3 <https://www.gnu.org/licenses/lgpl-3.0.en.html>`_
-
-|
-
-Also based on https://github.com/wsmith323/frozenordereddict
-
-Copyright (c) 2015 Warren Smith
+| Also based on https://github.com/Marco-Sulla/python-frozendict
+| Copyright (c) Marco Sulla
+| Licensed under the `GNU Lesser General Public License Version 3 <https://www.gnu.org/licenses/lgpl-3.0.en.html>`_
 
-Licensed under the MIT License:
+| Also based on https://github.com/wsmith323/frozenordereddict
+| Copyright (c) 2015 Warren Smith
+| Licensed under the MIT License:
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: