2.4.0 - Extras module with attrs, attrs unit tests

Someguy123 · Someguy123 · commit a2b1244a55fe · 2019-12-01T04:48:58.000Z
- Created `extras` module for miscellaneous package dependent code
 - Created `extras.attrs` module for `attrs` dependent code
 - Added `tests.test_extras` with unit tests for `AttribDictable`
 - Added `extras/extras.txt` which contains all packages required for full functionality of `helpers.extras`
 - Added docs for `extras` module
 - Added docs for `collections.make_dict_tuple`
diff --git a/docs/source/helpers/collections/privex.helpers.collections.make_dict_tuple.rst b/docs/source/helpers/collections/privex.helpers.collections.make_dict_tuple.rst
@@ -0,0 +1,6 @@
+make\_dict\_tuple
+=================
+
+.. currentmodule:: privex.helpers.collections
+
+.. autofunction:: make_dict_tuple
diff --git a/docs/source/helpers/index.rst b/docs/source/helpers/index.rst
@@ -10,6 +10,7 @@
     privex.helpers.decorators
     privex.helpers.django
     privex.helpers.exceptions
+    privex.helpers.extras
     privex.helpers.net
     privex.helpers.plugin
     privex.helpers.settings
diff --git a/docs/source/helpers/privex.helpers.collections.rst b/docs/source/helpers/privex.helpers.collections.rst
@@ -19,6 +19,7 @@ Module Contents
       convert_dictable_namedtuple
       dictable_namedtuple
       is_namedtuple
+      make_dict_tuple
       subclass_dictable_namedtuple
    
    
@@ -38,4 +39,3 @@ Module Contents
 
    
    
-   
diff --git a/docs/source/helpers/privex.helpers.extras.rst b/docs/source/helpers/privex.helpers.extras.rst
@@ -0,0 +1,20 @@
+privex.helpers.extras
+=====================
+
+.. automodule:: privex.helpers.extras
+
+
+   
+   
+   
+   
+   
+   
+
+   
+   
+   
+
+   
+   
+   
diff --git a/docs/source/helpers/tests.rst b/docs/source/helpers/tests.rst
@@ -14,6 +14,7 @@ Unit Test List / Overview
     tests.test_cache
     tests.test_collections
     tests.test_crypto
+    tests.test_extras
     tests.test_general
     tests.test_parse
     tests.test_rdns
diff --git a/docs/source/helpers/tests/test_extras/example/tests.test_extras.Example.__init__.rst b/docs/source/helpers/tests/test_extras/example/tests.test_extras.Example.__init__.rst
@@ -0,0 +1,6 @@
+\_\_init\_\_
+============
+
+.. currentmodule:: tests.test_extras
+
+.. automethod:: Example.__init__
diff --git a/docs/source/helpers/tests/test_extras/testattrs/tests.test_extras.TestAttrs.pytestmark.rst b/docs/source/helpers/tests/test_extras/testattrs/tests.test_extras.TestAttrs.pytestmark.rst
@@ -0,0 +1,6 @@
+pytestmark
+==========
+
+.. currentmodule:: tests.test_extras
+
+.. autoattribute:: TestAttrs.pytestmark
diff --git a/docs/source/helpers/tests/test_extras/testattrs/tests.test_extras.TestAttrs.test_dictable_cast_dict.rst b/docs/source/helpers/tests/test_extras/testattrs/tests.test_extras.TestAttrs.test_dictable_cast_dict.rst
@@ -0,0 +1,6 @@
+test\_dictable\_cast\_dict
+==========================
+
+.. currentmodule:: tests.test_extras
+
+.. automethod:: TestAttrs.test_dictable_cast_dict
diff --git a/docs/source/helpers/tests/test_extras/testattrs/tests.test_extras.TestAttrs.test_dictable_set_get.rst b/docs/source/helpers/tests/test_extras/testattrs/tests.test_extras.TestAttrs.test_dictable_set_get.rst
@@ -0,0 +1,6 @@
+test\_dictable\_set\_get
+========================
+
+.. currentmodule:: tests.test_extras
+
+.. automethod:: TestAttrs.test_dictable_set_get
diff --git a/docs/source/helpers/tests/test_extras/tests.test_extras.Example.rst b/docs/source/helpers/tests/test_extras/tests.test_extras.Example.rst
@@ -0,0 +1,26 @@
+Example
+=======
+
+.. currentmodule:: tests.test_extras
+
+.. autoclass:: Example
+
+
+   .. automethod:: __init__
+      :noindex:
+
+
+Methods
+^^^^^^^
+
+.. rubric:: Methods
+
+.. autosummary::
+   :toctree: example
+
+    ~Example.__init__
+
+
+
+
+
diff --git a/docs/source/helpers/tests/test_extras/tests.test_extras.TestAttrs.rst b/docs/source/helpers/tests/test_extras/tests.test_extras.TestAttrs.rst
@@ -0,0 +1,37 @@
+TestAttrs
+=========
+
+.. currentmodule:: tests.test_extras
+
+.. autoclass:: TestAttrs
+
+
+   .. automethod:: __init__
+      :noindex:
+
+
+Methods
+^^^^^^^
+
+.. rubric:: Methods
+
+.. autosummary::
+   :toctree: testattrs
+
+    ~TestAttrs.test_dictable_cast_dict
+    ~TestAttrs.test_dictable_set_get
+
+
+
+
+
+Attributes
+^^^^^^^^^^
+
+.. rubric:: Attributes
+
+.. autosummary::
+   :toctree: testattrs
+
+    ~TestAttrs.pytestmark
+
diff --git a/docs/source/helpers/tests/tests.test_extras.rst b/docs/source/helpers/tests/tests.test_extras.rst
@@ -0,0 +1,28 @@
+tests.test\_extras
+==================
+
+.. automodule:: tests.test_extras
+
+
+   
+   
+   
+   
+   
+   
+
+   
+   
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree: test_extras
+   
+      Example
+      TestAttrs
+   
+   
+
+   
+   
+   
diff --git a/extras/extras.txt b/extras/extras.txt
@@ -0,0 +1,2 @@
+# All packages required for the `extras` module.
+attrs
diff --git a/privex/helpers/__init__.py b/privex/helpers/__init__.py
@@ -128,7 +128,7 @@ def _setup_logging(level=logging.WARNING):
 log = _setup_logging()
 name = 'helpers'
 
-VERSION = '2.3.1'
+VERSION = '2.4.0'
 
 
 
diff --git a/setup.py b/setup.py
@@ -44,7 +44,7 @@
 with open(join(BASE_DIR, "README.md"), "r") as fh:
     long_description = fh.read()
 
-extensions = ['full', 'cache', 'crypto', 'django', 'docs', 'dev', 'net', 'tests', 'setuppy']
+extensions = ['full', 'cache', 'crypto', 'django', 'docs', 'dev', 'extras', 'net', 'tests', 'setuppy']
 
 extra_commands = {}
 
diff --git a/tests/__init__.py b/tests/__init__.py
@@ -180,6 +180,7 @@
 from tests.test_parse import TestParseHelpers
 from tests.test_net import TestNet
 from tests.test_collections import TestIsNamedTuple, TestDictableNamedtuple, TestDictObject
+from tests.test_extras import TestAttrs
 
 if env_bool('DEBUG', False) is True:
     LogHelper('privex.helpers', level=logging.DEBUG).add_console_handler(logging.DEBUG)
diff --git a/tests/test_extras.py b/tests/test_extras.py
@@ -0,0 +1,87 @@
+"""
+Test cases for :py:mod:`privex.helpers.extras`
+
+**Copyright**::
+
+        +===================================================+
+        |                 © 2019 Privex Inc.                |
+        |               https://www.privex.io               |
+        +===================================================+
+        |                                                   |
+        |        Originally Developed by Privex Inc.        |
+        |                                                   |
+        |        Core Developer(s):                         |
+        |                                                   |
+        |          (+)  Chris (@someguy123) [Privex]        |
+        |          (+)  Kale (@kryogenic) [Privex]          |
+        |                                                   |
+        +===================================================+
+
+    Copyright 2019     Privex Inc.   ( https://www.privex.io )
+
+    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.
+
+
+"""
+import pytest
+import logging
+from privex.helpers import extras
+from tests.base import PrivexBaseCase
+
+log = logging.getLogger(__name__)
+
+# Fallback objects to avoid undeclared variables despite pytest skip
+attr, AttribDictable, Example = object, object, object
+
+# We only import `attr` and `AttribDictable` if `attrs` is installed.
+# We also create the `Example` class for use in test cases.
+if extras.HAS_ATTRS:
+    import attr
+    from privex.helpers.extras import AttribDictable
+    
+    @attr.s
+    class Example(AttribDictable):
+        hello = attr.ib(type=str)
+        testing = attr.ib(type=bool, default=True)
+
+
+@pytest.mark.skipif(extras.HAS_ATTRS is False, reason='extras.HAS_ATTRS is False (is `attrs` installed?)')
+class TestAttrs(PrivexBaseCase):
+    
+    def test_dictable_set_get(self):
+        """Test setting and getting attributes on a :class:`.AttribDictable` attrs instance"""
+        x = Example(hello='world')
+        self.assertEqual(x.hello, 'world')
+        self.assertEqual(x['hello'], 'world')
+        
+        x.hello = 'lorem'
+        self.assertEqual(x.hello, 'lorem')
+        self.assertEqual(x['hello'], 'lorem')
+        
+        x['hello'] = 'ipsum'
+        self.assertEqual(x.hello, 'ipsum')
+        self.assertEqual(x['hello'], 'ipsum')
+
+    def test_dictable_cast_dict(self):
+        """Test casting an :class:`.AttribDictable` attrs instance to a dict"""
+        x = Example(hello='world')
+        d = dict(x)
+        self.assertIsInstance(d, dict)
+        self.assertEqual(d, dict(hello='world', testing=True))
+
+
