---

ken-morel · Jun 8, 2024 · 230da23 · 230da23
1 parent b1d0603
commit 230da23
Show file tree

Hide file tree

Showing 19 changed files with 3,995 additions and 8,503 deletions.
diff --git a/docs/build/doctrees/api.doctree b/docs/build/doctrees/api.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/usage.doctree b/docs/build/doctrees/usage.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 228a682d7073b1adc860314c5d4dd987
+config: 36e8dc9dac2db911651334c5543d871a
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
@@ -1,5 +1,5 @@
 
-Welcome to pyoload's documentation!
+Welcome to pyoload v|version| documentation!
 ===================================
 
 .. image:: https://github.com/ken-morel/pyoload/actions/workflows/python-publish.yml/badge.svg
@@ -20,9 +20,12 @@ Welcome to pyoload's documentation!
 .. image:: https://readthedocs.org/projects/pyoload/badge/?version=latest
   :target: https://pyoload.readthedocs.io
   :alt: Documentation Status
-.. image::https://img.shields.io/pypi/dd/pyoload
+.. image:: https://img.shields.io/pypi/dd/pyoload
   :target: https://pypi.org/project/pyoload
   :alt: Pypi downloads
+.. image:: https://ken-morel-api.up.railway.app/counters/pyoload-docs/add.svg
+  :target: https://portfolio-ken-morel-projects.vercel.app/
+  :alt: Hit count
 
 
 welcome to pyoloads documentation, a python module for typechecking and

diff --git a/docs/build/html/_sources/usage.rst.txt b/docs/build/html/_sources/usage.rst.txt
@@ -61,14 +61,8 @@ The dictionary key under which the overloads was registered.
 It receives a type as argument, it is the type
 in which the object will cast.
 
->>> from pyoload import Cast
->>> caster = Cast(dict[str, list[tuple[float]])
-  File "<stdin>", line 1
-    caster = Cast(dict[str, list[tuple[float]])
-                                              ^
-SyntaxError: closing parenthesis ')' does not match opening parenthesis '['
 >>> from pyoload import Cast
 >>> caster = Cast(dict[str, list[tuple[float]]])
 >>> object = {237: (['1.0', 5], (5.0, 6.0))}
->>> caster(object)
-{'237': [(1.0, 5.0), (5.0, 6.0)]}
+>>> caster(object
+){'237': [(1.0, 5.0), (5.0, 6.0)]}
diff --git a/docs/build/html/_static/documentation_options.js b/docs/build/html/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.1.3',
+    VERSION: '2.0.0',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/build/html/api.html b/docs/build/html/api.html
diff --git a/docs/build/html/examples.html b/docs/build/html/examples.html
@@ -7,15 +7,15 @@
 <meta content="white" media="(prefers-color-scheme: light)" name="theme-color"/>
 <meta content="black" media="(prefers-color-scheme: dark)" name="theme-color"/>
 <meta content="Docutils 0.18.1: http://docutils.sourceforge.net/" name="generator"/>
-<title>examples | pyoload 1.1.3 documentation</title>
-<meta content="examples | pyoload 1.1.3 documentation" property="og:title"/>
-<meta content="examples | pyoload 1.1.3 documentation" name="twitter:title"/>
+<title>examples | pyoload 2.0.0 documentation</title>
+<meta content="examples | pyoload 2.0.0 documentation" property="og:title"/>
+<meta content="examples | pyoload 2.0.0 documentation" name="twitter:title"/>
 <link href="_static/pygments.css?v=8d216cef" rel="stylesheet" type="text/css"/>
 <link href="_static/theme.css?v=ecdfb4fc" rel="stylesheet" type="text/css"/>
 <link href="search.html" rel="search" title="Search"/>
 <link href="genindex.html" rel="index" title="Index"/>
 <link href="usage.html" rel="next" title="usage"/>
-<link href="index.html" rel="prev" title="Welcome to pyoload’s documentation!"/>
+<link href="index.html" rel="prev" title="Welcome to pyoload v|version| documentation!"/>
 <script>
     <!-- Prevent Flash of wrong theme -->
       const userPreference = localStorage.getItem('darkMode');
@@ -34,7 +34,7 @@
       Skip to content
     </a><header class="sticky top-0 z-40 w-full border-b shadow-sm border-border supports-backdrop-blur:bg-background/60 bg-background/95 backdrop-blur"><div class="container flex items-center h-14">
 <div class="hidden mr-4 md:flex">
-<a class="flex items-center mr-6" href="index.html"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">pyoload 1.1.3 documentation</span>
+<a class="flex items-center mr-6" href="index.html"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">pyoload 2.0.0 documentation</span>
 </a></div><button @click="showSidebar = true" class="inline-flex items-center justify-center h-10 px-0 py-2 mr-2 text-base font-medium transition-colors rounded-md hover:text-accent-foreground hover:bg-transparent md:hidden" type="button">
 <svg aria-hidden="true" fill="currentColor" height="24" viewbox="0 96 960 960" width="24" xmlns="http://www.w3.org/2000/svg">
 <path d="M152.587 825.087q-19.152 0-32.326-13.174t-13.174-32.326q0-19.152 13.174-32.326t32.326-13.174h440q19.152 0 32.326 13.174t13.174 32.326q0 19.152-13.174 32.326t-32.326 13.174h-440Zm0-203.587q-19.152 0-32.326-13.174T107.087 576q0-19.152 13.174-32.326t32.326-13.174h320q19.152 0 32.326 13.174T518.087 576q0 19.152-13.174 32.326T472.587 621.5h-320Zm0-203.587q-19.152 0-32.326-13.174t-13.174-32.326q0-19.152 13.174-32.326t32.326-13.174h440q19.152 0 32.326 13.174t13.174 32.326q0 19.152-13.174 32.326t-32.326 13.174h-440ZM708.913 576l112.174 112.174q12.674 12.674 12.674 31.826t-12.674 31.826Q808.413 764.5 789.261 764.5t-31.826-12.674l-144-144Q600 594.391 600 576t13.435-31.826l144-144q12.674-12.674 31.826-12.674t31.826 12.674q12.674 12.674 12.674 31.826t-12.674 31.826L708.913 576Z"></path>
@@ -64,7 +64,7 @@
 </div>
 </header>
 <div class="flex-1"><div class="container flex-1 items-start md:grid md:grid-cols-[220px_minmax(0,1fr)] md:gap-6 lg:grid-cols-[240px_minmax(0,1fr)] lg:gap-10"><aside :aria-hidden="!showSidebar" :class="{ 'translate-x-0': showSidebar }" class="fixed inset-y-0 left-0 md:top-14 z-50 md:z-30 bg-background md:bg-transparent transition-all duration-100 -translate-x-full md:translate-x-0 ml-0 p-6 md:p-0 md:-ml-2 md:h-[calc(100vh-3.5rem)] w-5/6 md:w-full shrink-0 overflow-y-auto border-r border-border md:sticky" id="left-sidebar">
-<a class="!justify-start text-sm md:!hidden bg-background" href="index.html"><span class="font-bold text-clip whitespace-nowrap">pyoload 1.1.3 documentation</span>
+<a class="!justify-start text-sm md:!hidden bg-background" href="index.html"><span class="font-bold text-clip whitespace-nowrap">pyoload 2.0.0 documentation</span>
 </a>
 <div class="relative overflow-hidden md:overflow-auto my-4 md:my-0 h-[calc(100vh-8rem)] md:h-auto">
 <div class="overflow-y-auto h-full w-full relative pr-6"><nav class="table w-full min-w-full my-6 lg:my-8">
@@ -86,7 +86,7 @@
 <div class="w-full min-w-0 mx-auto">
 <nav aria-label="breadcrumbs" class="flex items-center mb-4 space-x-1 text-sm text-muted-foreground">
 <a class="overflow-hidden text-ellipsis whitespace-nowrap hover:text-foreground" href="index.html">
-<span class="hidden md:inline">pyoload 1.1.3 documentation</span>
+<span class="hidden md:inline">pyoload 2.0.0 documentation</span>
 <svg aria-label="Home" class="md:hidden" fill="currentColor" height="18" stroke="none" viewbox="0 96 960 960" width="18" xmlns="http://www.w3.org/2000/svg">
 <path d="M240 856h120V616h240v240h120V496L480 316 240 496v360Zm-80 80V456l320-240 320 240v480H520V696h-80v240H160Zm320-350Z"></path>
 </svg>
@@ -141,7 +141,7 @@ <h2>Person address (<code class="code highlight python docutils literal highligh
 </div>
 </footer>
 </div>
-<script src="_static/documentation_options.js?v=cb7bf70b"></script>
+<script src="_static/documentation_options.js?v=51b770b3"></script>
 <script src="_static/doctools.js?v=9a2dae69"></script>
 <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
 <script defer="defer" src="_static/theme.js?v=e82a16a3"></script>

diff --git a/docs/build/html/genindex.html b/docs/build/html/genindex.html
@@ -12,9 +12,9 @@
   <meta name="theme-color" media="(prefers-color-scheme: light)" content="white" />
   <meta name="theme-color" media="(prefers-color-scheme: dark)" content="black" />
 
-    <title>Index | pyoload 1.1.3 documentation</title>
-    <meta property="og:title" content="Index | pyoload 1.1.3 documentation" />
-    <meta name="twitter:title" content="Index | pyoload 1.1.3 documentation" />
+    <title>Index | pyoload 2.0.0 documentation</title>
+    <meta property="og:title" content="Index | pyoload 2.0.0 documentation" />
+    <meta name="twitter:title" content="Index | pyoload 2.0.0 documentation" />
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8d216cef" />
       <link rel="stylesheet" type="text/css" href="_static/theme.css?v=ecdfb4fc" />
         <link rel="search" title="Search" href="search.html" />
@@ -39,7 +39,7 @@
     </a><header
   class="sticky top-0 z-40 w-full border-b shadow-sm border-border supports-backdrop-blur:bg-background/60 bg-background/95 backdrop-blur"><div class="container flex items-center h-14">
     <div class="hidden mr-4 md:flex">
-      <a href="index.html" class="flex items-center mr-6"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">pyoload 1.1.3 documentation</span>
+      <a href="index.html" class="flex items-center mr-6"><span class="hidden font-bold sm:inline-block text-clip whitespace-nowrap">pyoload 2.0.0 documentation</span>
       </a></div><button
       class="inline-flex items-center justify-center h-10 px-0 py-2 mr-2 text-base font-medium transition-colors rounded-md hover:text-accent-foreground hover:bg-transparent md:hidden"
       type="button" @click="showSidebar = true">
@@ -94,7 +94,7 @@
   class="fixed inset-y-0 left-0 md:top-14 z-50 md:z-30 bg-background md:bg-transparent transition-all duration-100 -translate-x-full md:translate-x-0 ml-0 p-6 md:p-0 md:-ml-2 md:h-[calc(100vh-3.5rem)] w-5/6 md:w-full shrink-0 overflow-y-auto border-r border-border md:sticky"
   :aria-hidden="!showSidebar" :class="{ 'translate-x-0': showSidebar }">
 
-    <a href="index.html" class="!justify-start text-sm md:!hidden bg-background"><span class="font-bold text-clip whitespace-nowrap">pyoload 1.1.3 documentation</span>
+    <a href="index.html" class="!justify-start text-sm md:!hidden bg-background"><span class="font-bold text-clip whitespace-nowrap">pyoload 2.0.0 documentation</span>
     </a>
 
     <div class="relative overflow-hidden md:overflow-auto my-4 md:my-0 h-[calc(100vh-8rem)] md:h-auto">
@@ -123,7 +123,7 @@
      class="flex items-center mb-4 space-x-1 text-sm text-muted-foreground">
   <a class="overflow-hidden text-ellipsis whitespace-nowrap hover:text-foreground"
      href="index.html">
-    <span class="hidden md:inline">pyoload 1.1.3 documentation</span>
+    <span class="hidden md:inline">pyoload 2.0.0 documentation</span>
     <svg xmlns="http://www.w3.org/2000/svg"
          height="18"
          width="18"
@@ -147,14 +147,10 @@ <h2 id="A">A</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
       <li><a href="api.html#pyoload.annotate">annotate() (in module pyoload)</a>
-</li>
-      <li><a href="api.html#pyoload.annotateClass">annotateClass() (in module pyoload)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
       <li><a href="api.html#pyoload.AnnotationError">AnnotationError</a>
-</li>
-      <li><a href="api.html#pyoload.AnnotationErrors">AnnotationErrors</a>
 </li>
       <li><a href="api.html#pyoload.AnnotationResolutionError">AnnotationResolutionError</a>
 </li>
@@ -170,15 +166,13 @@ <h2 id="C">C</h2>
       <li><a href="api.html#pyoload.Cast.cast">cast() (pyoload.Cast static method)</a>
 </li>
       <li><a href="api.html#pyoload.CastedAttr">CastedAttr (class in pyoload)</a>
-</li>
-      <li><a href="api.html#pyoload.CastingError">CastingError</a>
 </li>
       <li><a href="api.html#pyoload.Check">Check (class in pyoload)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
       <li><a href="api.html#pyoload.Check.check">check() (pyoload.Check class method)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
       <li><a href="api.html#pyoload.Check.CheckDoesNotExistError">Check.CheckDoesNotExistError</a>
 </li>
       <li><a href="api.html#pyoload.Check.CheckError">Check.CheckError</a>
@@ -193,28 +187,6 @@ <h2 id="C">C</h2>
   </tr>
       </table>
 
-  <h2 id="G">G</h2>
-  <table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
-      <li><a href="api.html#pyoload.get_module">get_module() (in module pyoload)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
-      <li><a href="api.html#pyoload.get_name">get_name() (in module pyoload)</a>
-</li>
-  </ul></td>
-  </tr>
-      </table>
-
-  <h2 id="I">I</h2>
-  <table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
-      <li><a href="api.html#pyoload.InternalAnnotationError">InternalAnnotationError</a>
-</li>
-  </ul></td>
-  </tr>
-      </table>
-
   <h2 id="M">M</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
@@ -226,17 +198,17 @@ <h2 id="M">M</h2>
 </li>
       </ul></li>
   </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
+      <li><a href="api.html#pyoload.multimethod">multimethod() (in module pyoload)</a>
+</li>
+  </ul></td>
   </tr>
       </table>
 
   <h2 id="O">O</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
       <li><a href="api.html#pyoload.overload">overload() (in module pyoload)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
-      <li><a href="api.html#pyoload.OverloadError">OverloadError</a>
 </li>
   </ul></td>
   </tr>
@@ -253,10 +225,6 @@ <h2 id="P">P</h2>
 </li>
       </ul></li>
   </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
-      <li><a href="api.html#pyoload.PyoloadAnnotation">PyoloadAnnotation (class in pyoload)</a>
-</li>
-  </ul></td>
   </tr>
       </table>
 
@@ -267,16 +235,7 @@ <h2 id="R">R</h2>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
-      <li><a href="api.html#pyoload.resolveAnnotations">resolveAnnotations() (in module pyoload)</a>
-</li>
-  </ul></td>
-  </tr>
-      </table>
-
-  <h2 id="T">T</h2>
-  <table style="width: 100%" class="indextable genindextable"><tr>
-  <td style="width: 33%; vertical-align: top;"><ul style="margin-left:0;list-style-type:none">
-      <li><a href="api.html#pyoload.typeMatch">typeMatch() (in module pyoload)</a>
+      <li><a href="api.html#pyoload.resove_annotations">resove_annotations() (in module pyoload)</a>
 </li>
   </ul></td>
   </tr>
@@ -295,7 +254,7 @@ <h2 id="V">V</h2>
 </div></div>
 <aside id="right-sidebar" class="hidden text-sm xl:block">
 <div class="sticky top-16 -mt-10 max-h-[calc(var(--vh)-4rem)] overflow-y-auto pt-6 space-y-2">
-<a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#A">A</a><a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#C">C</a><a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#G">G</a><a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#I">I</a><a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#M">M</a><a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#O">O</a><a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#P">P</a><a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#R">R</a><a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#T">T</a><a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#V">V</a>
+<a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#A">A</a><a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#C">C</a><a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#M">M</a><a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#O">O</a><a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#P">P</a><a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#R">R</a><a class="pt-2 block text-muted-foreground no-underline transition-colors hover:text-foreground focus-visible:outline-offset-[-1px]" href="#V">V</a>
 </div>
 </aside>
         </main>
@@ -311,7 +270,7 @@ <h2 id="V">V</h2>
 </footer>
   </div>
 
-    <script src="_static/documentation_options.js?v=cb7bf70b"></script>
+    <script src="_static/documentation_options.js?v=51b770b3"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script defer="defer" src="_static/theme.js?v=e82a16a3"></script>