Merge pull request #56 from connor-makowski/2.1.0

2.1.0: Add support for Typing.Any and check subclasses by default

Author: connor-makowski

README.md

@@ -99,6 +99,7 @@ The main changes in version 2.0.0 revolve around migrating towards the standard
         - `Tuple`
     - `Union`
     - `Optional`
+    - `Any`
     - `Sized`
         - Essentially creates a union of:
             - `list`, `tuple`, `dict`, `set`, `str`, `bytes`, `bytearray`, `memoryview`, `range`
@@ -335,15 +336,12 @@ y=my_class(Foo) # Works great!
 x=my_class(Foo()) # Fails
 ```
 
-## Validate classes with inheritance
+By default, type_enforced will check for subclasses of a class when validating types. This means that if you pass a subclass of the expected class, it will pass the type check.
 
-A special helper utility is provided to get all the subclasses of a class (with delayed evaluation - so you can validate subclasses even if they were defined later or in other files).
-
-See: [WithSubclasses](https://connor-makowski.github.io/type_enforced/type_enforced/utils.html#WithSubclasses) for more information.
+Note: Uninitialized class objects that are passed are not checked for subclasses.
 
 ```py
 import type_enforced
-from type_enforced.utils import WithSubclasses
 
 class Foo:
     pass
@@ -355,7 +353,7 @@ class Baz:
     pass
 
 @type_enforced.Enforcer
-def my_fn(custom_class: WithSubclasses(Foo)):
+def my_fn(custom_class: Foo):
     pass
 
 my_fn(Foo()) # Passes as expected

dist/type_enforced-2.1.0-py3-none-any.whl

@@ -31,6 +31,7 @@ <h2>Submodules</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

dist/type_enforced-2.1.0.tar.gz

@@ -48,6 +48,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/0.0.16/type_enforced.html

@@ -31,6 +31,7 @@ <h2>Submodules</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/0.0.16/type_enforced/enforcer.html

@@ -48,6 +48,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.1.1/type_enforced.html

@@ -55,6 +55,7 @@ <h2>Submodules</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.1.1/type_enforced/enforcer.html

@@ -48,6 +48,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.10.2/type_enforced.html

@@ -84,6 +84,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.10.2/type_enforced/enforcer.html

@@ -31,6 +31,7 @@ <h2>Submodules</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.10.2/type_enforced/utils.html

@@ -48,6 +48,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.2.0/type_enforced.html

@@ -32,6 +32,7 @@ <h2>Submodules</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.2.0/type_enforced/enforcer.html

@@ -48,6 +48,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.3.0/type_enforced.html

@@ -39,6 +39,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.3.0/type_enforced/enforcer.html

@@ -32,6 +32,7 @@ <h2>Submodules</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.3.0/type_enforced/utils.html

@@ -48,6 +48,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.4.0/type_enforced.html

@@ -48,6 +48,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.4.0/type_enforced/enforcer.html

@@ -32,6 +32,7 @@ <h2>Submodules</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.4.0/type_enforced/utils.html

@@ -48,6 +48,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.5.0/type_enforced.html

@@ -66,6 +66,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.5.0/type_enforced/enforcer.html

@@ -32,6 +32,7 @@ <h2>Submodules</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.5.0/type_enforced/utils.html

@@ -48,6 +48,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.6.0/type_enforced.html

@@ -69,6 +69,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.6.0/type_enforced/enforcer.html

@@ -32,6 +32,7 @@ <h2>Submodules</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.6.0/type_enforced/utils.html

@@ -48,6 +48,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.7.0/type_enforced.html

@@ -84,6 +84,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.7.0/type_enforced/enforcer.html

@@ -32,6 +32,7 @@ <h2>Submodules</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.7.0/type_enforced/utils.html

@@ -48,6 +48,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.8.1/type_enforced.html

@@ -84,6 +84,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.8.1/type_enforced/enforcer.html

@@ -32,6 +32,7 @@ <h2>Submodules</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.8.1/type_enforced/utils.html

@@ -48,6 +48,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.9.0/type_enforced.html

@@ -84,6 +84,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/1.9.0/type_enforced/enforcer.html

@@ -54,6 +54,7 @@ <h2>Submodules</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>
@@ -170,7 +171,7 @@ <h2 id="what-changed-in-200">What changed in 2.0.0?</h2>
 <li>Support for python3.10 has been dropped.</li>
 <li>List based union types are no longer supported.
 <ul>
-<li>For example <code>[int, float]</code> is no longer a supported type hint. </li>
+<li>For example <code>[int, float]</code> is no longer a supported type hint.</li>
 <li>Use <code>int|float</code> or <code>typing.Union[int, float]</code> instead.</li>
 </ul></li>
 <li>Dict types now require two types to be specified.
@@ -282,12 +283,12 @@ <h2 id="supported-type-checking-features">Supported Type Checking Features:</h2>
 </ul></li>
 <li>Note: If type is a <code>str | Literal['a', 'b']</code>
 <ul>
-<li>The check will validate that the type is a string or the value is equal to <code>'a'</code> or <code>'b'</code>. </li>
+<li>The check will validate that the type is a string or the value is equal to <code>'a'</code> or <code>'b'</code>.</li>
 <li>This means that an input of <code>'c'</code> will pass the check since it matches the string type, but an input of <code>1</code> will fail.</li>
 </ul></li>
 <li>Note: If type is a <code>int | Literal['a', 'b']</code>
 <ul>
-<li>The check will validate that the type is an int or the value is equal to <code>'a'</code> or <code>'b'</code>. </li>
+<li>The check will validate that the type is an int or the value is equal to <code>'a'</code> or <code>'b'</code>.</li>
 <li>This means that an input of <code>'c'</code> will fail the check, but an input of <code>1</code> will pass.</li>
 </ul></li>
 <li>Note: Literals stack when used with unions.
@@ -658,7 +659,7 @@ <h2 id="running-tests-prettifying-code-and-updating-docs">Running Tests, Prettif
 </span><span id="L-48"><a href="#L-48"><span class="linenos"> 48</span></a><span class="sd">The main changes in version 2.0.0 revolve around migrating towards the standard python typing hint process and away from the original type_enfoced type hints (as type enforced was originally created before the `|` operator was added to python).</span>
 </span><span id="L-49"><a href="#L-49"><span class="linenos"> 49</span></a><span class="sd">- Support for python3.10 has been dropped.</span>
 </span><span id="L-50"><a href="#L-50"><span class="linenos"> 50</span></a><span class="sd">- List based union types are no longer supported.</span>
-</span><span id="L-51"><a href="#L-51"><span class="linenos"> 51</span></a><span class="sd">    - For example `[int, float]` is no longer a supported type hint. </span>
+</span><span id="L-51"><a href="#L-51"><span class="linenos"> 51</span></a><span class="sd">    - For example `[int, float]` is no longer a supported type hint.</span>
 </span><span id="L-52"><a href="#L-52"><span class="linenos"> 52</span></a><span class="sd">    - Use `int|float` or `typing.Union[int, float]` instead.</span>
 </span><span id="L-53"><a href="#L-53"><span class="linenos"> 53</span></a><span class="sd">- Dict types now require two types to be specified.</span>
 </span><span id="L-54"><a href="#L-54"><span class="linenos"> 54</span></a><span class="sd">    - The first type is the key type and the second type is the value type.</span>
@@ -722,10 +723,10 @@ <h2 id="running-tests-prettifying-code-and-updating-docs">Running Tests, Prettif
 </span><span id="L-112"><a href="#L-112"><span class="linenos">112</span></a><span class="sd">        - Note: Multiple types can be passed in the same `Literal` as acceptable values.</span>
 </span><span id="L-113"><a href="#L-113"><span class="linenos">113</span></a><span class="sd">            - e.g. Literal[&#39;a&#39;, &#39;b&#39;, 1, 2] will require any passed values that are equal (`==`) to `&#39;a&#39;`, `&#39;b&#39;`, `1` or `2`.</span>
 </span><span id="L-114"><a href="#L-114"><span class="linenos">114</span></a><span class="sd">        - Note: If type is a `str | Literal[&#39;a&#39;, &#39;b&#39;]`</span>
-</span><span id="L-115"><a href="#L-115"><span class="linenos">115</span></a><span class="sd">            - The check will validate that the type is a string or the value is equal to `&#39;a&#39;` or `&#39;b&#39;`. </span>
+</span><span id="L-115"><a href="#L-115"><span class="linenos">115</span></a><span class="sd">            - The check will validate that the type is a string or the value is equal to `&#39;a&#39;` or `&#39;b&#39;`.</span>
 </span><span id="L-116"><a href="#L-116"><span class="linenos">116</span></a><span class="sd">            - This means that an input of `&#39;c&#39;` will pass the check since it matches the string type, but an input of `1` will fail.</span>
 </span><span id="L-117"><a href="#L-117"><span class="linenos">117</span></a><span class="sd">        - Note: If type is a `int | Literal[&#39;a&#39;, &#39;b&#39;]`</span>
-</span><span id="L-118"><a href="#L-118"><span class="linenos">118</span></a><span class="sd">            - The check will validate that the type is an int or the value is equal to `&#39;a&#39;` or `&#39;b&#39;`. </span>
+</span><span id="L-118"><a href="#L-118"><span class="linenos">118</span></a><span class="sd">            - The check will validate that the type is an int or the value is equal to `&#39;a&#39;` or `&#39;b&#39;`.</span>
 </span><span id="L-119"><a href="#L-119"><span class="linenos">119</span></a><span class="sd">            - This means that an input of `&#39;c&#39;` will fail the check, but an input of `1` will pass.</span>
 </span><span id="L-120"><a href="#L-120"><span class="linenos">120</span></a><span class="sd">        - Note: Literals stack when used with unions.</span>
 </span><span id="L-121"><a href="#L-121"><span class="linenos">121</span></a><span class="sd">            - e.g. `Literal[&#39;a&#39;, &#39;b&#39;] | Literal[1, 2]` will require any passed values that are equal (`==`) to `&#39;a&#39;`, `&#39;b&#39;`, `1` or `2`.</span>
@@ -990,7 +991,8 @@ <h2 id="running-tests-prettifying-code-and-updating-docs">Running Tests, Prettif
 </span><span id="L-380"><a href="#L-380"><span class="linenos">380</span></a>
 </span><span id="L-381"><a href="#L-381"><span class="linenos">381</span></a><span class="sd">- Note: You can and should modify the `Dockerfile` to test different python versions.</span>
 </span><span id="L-382"><a href="#L-382"><span class="linenos">382</span></a><span class="sd">&quot;&quot;&quot;</span>
-</span><span id="L-383"><a href="#L-383"><span class="linenos">383</span></a><span class="kn">from</span><span class="w"> </span><span class="nn">.enforcer</span><span class="w"> </span><span class="kn">import</span> <span class="n">Enforcer</span><span class="p">,</span> <span class="n">FunctionMethodEnforcer</span>
+</span><span id="L-383"><a href="#L-383"><span class="linenos">383</span></a>
+</span><span id="L-384"><a href="#L-384"><span class="linenos">384</span></a><span class="kn">from</span><span class="w"> </span><span class="nn">.enforcer</span><span class="w"> </span><span class="kn">import</span> <span class="n">Enforcer</span><span class="p">,</span> <span class="n">FunctionMethodEnforcer</span>
 </span></pre></div>
 
 

docs/1.9.0/type_enforced/utils.html

@@ -48,6 +48,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/2.0.0/search.js

@@ -84,6 +84,7 @@ <h2>API Documentation</h2>
 <footer>
 <select id="version-selector">
     <option value="latest">latest</option>
+        <option value="2.1.0">2.1.0</option>
         <option value="2.0.0">2.0.0</option>
         <option value="1.10.2">1.10.2</option>
         <option value="1.9.0">1.9.0</option>

docs/2.0.0/type_enforced.html

@@ -0,0 +1,7 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="refresh" content="0; url=./type_enforced.html"/>
+</head>
+</html>