Changed __dict__ in dictable to be a property so as not to interfere with vars(). Updated other files and fixed wrong version numbers.

domdfcoding · domdfcoding · commit 38805dba1fb7 · 2020-05-21T19:10:36.000+01:00
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.3.1
+current_version = 0.3.2
 commit = True
 tag = True
 
diff --git a/.gitignore b/.gitignore
@@ -25,6 +25,8 @@ wheels/
 *.egg-info/
 .installed.cfg
 *.egg
+*.egg*
+
 MANIFEST
 
 # PyInstaller
@@ -48,6 +50,8 @@ coverage.xml
 *.cover
 .hypothesis/
 .pytest_cache/
+cover/
+.coverage*
 
 # Translations
 *.mo
@@ -67,6 +71,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+doc/build
 
 # PyBuilder
 target/
diff --git a/README.rst b/README.rst
@@ -36,7 +36,7 @@ domdf_python_tools
     :target: https://github.com/domdfcoding/domdf_python_tools/blob/master/LICENSE
 .. image:: https://img.shields.io/github/languages/top/domdfcoding/domdf_python_tools
     :alt: GitHub top language
-.. image:: https://img.shields.io/github/commits-since/domdfcoding/domdf_python_tools/v0.3.1
+.. image:: https://img.shields.io/github/commits-since/domdfcoding/domdf_python_tools/v0.3.2
     :target: https://github.com/domdfcoding/domdf_python_tools/pulse
     :alt: GitHub commits since tagged version
 .. image:: https://img.shields.io/github/last-commit/domdfcoding/domdf_python_tools
diff --git a/__pkginfo__.py b/__pkginfo__.py
@@ -46,7 +46,7 @@
 2019-2020 Dominic Davis-Foster <dominic@davis-foster.co.uk>
 """
 
-__version__ = "0.3.1"
+__version__ = "0.3.2"
 
 modname = "domdf_python_tools"
 pypi_name = "domdf_python_tools"
@@ -73,7 +73,7 @@
 repo_root = pathlib.Path(__file__).parent
 
 # Get info from files; set: long_description
-long_description = (repo_root / "README.rst").read_text().replace("0.3.1", __version__) + '\n'
+long_description = (repo_root / "README.rst").read_text().replace("0.3.2", __version__) + '\n'
 conda_description = """Helpful functions for Python
 
 
diff --git a/doc-source/_static/style.css b/doc-source/_static/style.css
@@ -1,3 +1,5 @@
 .wy-nav-content {
     max-width: 900px !important;
-}
+}
+
+li p:last-child { margin-bottom: 12px !important;}
diff --git a/doc-source/conf.py b/doc-source/conf.py
@@ -29,16 +29,23 @@
 release = version = __version__
 copyright = "Copyright 2019-2020 Dominic Davis-Foster"
 language = 'en'
+package_root = "domdf_python_tools"
 
 extensions = [
 		'sphinx.ext.intersphinx',
 		'sphinx.ext.autodoc',
 		'sphinx.ext.mathjax',
 		'sphinx.ext.viewcode',
 		'sphinxcontrib.httpdomain',
+		"sphinxcontrib.extras_require",
+		"sphinx.ext.todo",
+		"sphinxemoji.sphinxemojii",
 
 		]
 
+sphinxemoji_style = 'twemoji'
+todo_include_todos = bool(os.environ.get("SHOW_TODOS", False))
+
 templates_path = ['_templates']
 html_static_path = ['_static']
 source_suffix = '.rst'
diff --git a/doc-source/dates.rst b/doc-source/dates.rst
@@ -4,6 +4,7 @@
 
 .. contents:: Table of Contents
 
+
 .. warning:: This module has not been fully tested. Use with caution.
 
 .. note:: This module requires the `pytz <https://pypi.org/project/pytz/>`_ package to be installed.
diff --git a/doc-source/requirements.txt b/doc-source/requirements.txt
@@ -1,4 +1,6 @@
+extras_require
 pytz >=2019.1
 sphinx
 sphinx_rtd_theme
 sphinxcontrib-httpdomain
+sphinxemoji
diff --git a/domdf_python_tools/__init__.py b/domdf_python_tools/__init__.py
@@ -57,5 +57,5 @@
 __copyright__ = "2014-2020 Dominic Davis-Foster"
 
 __license__ = "LGPLv3+"
-__version__ = "0.3.1"
+__version__ = "0.3.2"
 __email__ = "dominic@davis-foster.co.uk"
diff --git a/domdf_python_tools/bases.py b/domdf_python_tools/bases.py
@@ -47,28 +47,29 @@ def __str__(self):
 		return self.__repr__()
 
 	def __iter__(self):
-		for key, value in self.__dict__().items():
+		for key, value in self.__dict__.items():
 			yield key, value
 
 	def __getstate__(self):
-		return self.__dict__()
+		return self.__dict__
 
 	def __setstate__(self, state):
 		self.__init__(**state)
 
 	def __copy__(self):
-		return self.__class__(**self.__dict__())
+		return self.__class__(**self.__dict__)
 
 	def __deepcopy__(self, memodict={}):
 		return self.__copy__()
 
+	@property
 	@abstractmethod
 	def __dict__(self):
 		return dict()
 
 	def __eq__(self, other):
 		if isinstance(other, self.__class__):
-			return pydash.predicates.is_match(other.__dict__(), self.__dict__())
+			return pydash.predicates.is_match(other.__dict__, self.__dict__)
 
 		return NotImplemented
 
diff --git a/git_helper.yml b/git_helper.yml
@@ -49,7 +49,7 @@ tests_dir: "tests"
 copyright_years: "2019-2020"
 author: "Dominic Davis-Foster"
 email: "dominic@davis-foster.co.uk"
-version: "0.3.1"
+version: "0.3.2"
 username: "domdfcoding"
 license: 'LGPLv3+'
 short_desc: 'Helpful functions for Python'
diff --git a/tests/test_bases.py b/tests/test_bases.py
@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+"""
+test_bases
+~~~~~~~~~~~~~~~
+
+Test functions in bases.py
+
+"""
+
+import copy
+import pickle
+
+import pytest
+
+from domdf_python_tools.bases import Dictable
+
+
+class Person(Dictable):
+	def __init__(self, name, age, occupation=None):
+		super().__init__()
+
+		self.name = str(name)
+		self.age = int(age)
+		self.occupation = occupation
+
+	@property
+	def __dict__(self):
+		return dict(
+				name=self.name,
+				age=self.age,
+				occupation=self.occupation,
+				)
+
+
+class Child(Person):
+	def __init__(self, name, age, school):
+		super().__init__(name, age, "Student")
+
+		self.school = "school"
+
+	@property
+	def __dict__(self):
+		class_dict = super().__dict__
+		class_dict["School"] = self.school
+		return class_dict
+
+@pytest.fixture(scope="function")
+def alice():
+	return Person("Alice", 20, "IRC Lurker")
+
+
+class TestDictable:
+	def test_creation(self, alice):
+		assert alice.name == "Alice"
+		assert alice.age == 20
+		assert alice.occupation == "IRC Lurker"
+
+	def test_str(self, alice):
+		assert str(alice).startswith("<tests.test_bases.Person")
+
+	def test_equality(self):
+		dolly = Person("Dolly", 6, "Sheep")
+		clone = Person("Dolly", 6, "Sheep")
+
+		assert dolly == clone
+
+	def test_iter(self, alice):
+		for key, value in alice:
+			assert key == "name"
+			assert value == "Alice"
+			return
+
+	def test_copy(self, alice):
+		assert copy.copy(alice) == alice
+		assert copy.deepcopy(alice) == alice
+		assert copy.copy(alice) == copy.copy(alice)
+
+	def test_pickle(self, alice):
+		assert pickle.loads(pickle.dumps(alice)) == alice
+
+	def test_vars(self, alice):
+		assert vars(alice) == dict(alice)
+
+	def test_subclass(self):
+		person = Person("Bob", 12, "Student")
+		child = Child("Bob", 12, "Big School")
+		assert person == child
+		assert "School" not in person.__dict__
+
+
+
