Added documentation

.readthedocs.yaml

@@ -20,13 +20,13 @@ sphinx:
   configuration: docs/conf.py
 
 # Optionally build your docs in additional formats such as PDF and ePub
-# formats:
-#    - pdf
-#    - epub
+formats:
+  - pdf
+  - epub
 
 # Optional but recommended, declare the Python requirements required
 # to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#    install:
-#    - requirements: docs/requirements.txt
+python:
+  install:
+    - requirements: docs/requirements.txt

docker-compose.yml

@@ -7,7 +7,7 @@ services:
       dockerfile: dockerfiles/dev.dockerfile
     volumes:
       - ./src:/src
-      - ./README.md:/src/README.md
+      - ./README.rst:/src/README.rst
       - ./LICENSE:/src/LICENSE
 
 

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/build/html/.buildinfo

@@ -0,0 +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: 0dad1f20748eaa3798eba50f606af618
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/build/html/_sources/api.rst.txt

@@ -0,0 +1,5 @@
+API
+===
+
+
+

docs/build/html/_sources/index.rst.txt

@@ -0,0 +1,29 @@
+Welcome to pyoload's documentation!
+===================================
+
+.. image:: https://github.com/ken-morel/pyoload/actions/workflows/python-publish.yml/badge.svg
+  :alt: Release status
+  :target: https://github.com/ken-morel/pyoload/releases
+.. image:: https://badge.fury.io/py/pyoload.svg
+  :alt: PyPI package
+  :target: https://pypi.org/project/pyoload
+.. image:: https://img.shields.io/pypi/pyversions/pyoload
+  :alt: Supported Python versions
+  :target: https://pypi.org/project/pyoload
+.. image:: https://github.com/ken-morel/pyoload/actions/workflows/test.yml/badge.svg?branch=main
+  :alt: Build Status
+  :target: https://github.com/ken-morel/pyoload/tree/mai
+.. image:: https://coveralls.io/repos/github/ken-morel/pyoload/badge.svg?branch=main
+  :alt: Coverage Status
+  :target: https://coveralls.io/github/ken-morel/pyoload?branch=mai
+.. image:: https://img.shields.io/badge/stackoverflow-Ask%20questions-blue.svg
+  :target: https://stackoverflow.com/questions/tagged/pyoload
+
+
+welcome to pyoloads documentation, a python module to help typechecking
+and annotaions checking in functions
+
+.. toctree::
+
+   api
+   usage

docs/build/html/_sources/usage.rst.txt

@@ -0,0 +1,87 @@
+=======
+pyoload
+=======
+
+pyoload has two main functions
+
+----------------
+pyoload.annotate
+----------------
+
+Is used as a decorator on the function.
+
+.. code-block:: python
+
+  from pyoload import annotate
+  @annotate
+  def twice(a:int) -> int:
+      return a * 2
+  b = twice(4)
+
+The annotate creates a wrapper over the decorated function which checks in for argument types over each function call using :python:`pyoload.matchType(val, spec)`.
+The original function is kept in the :python:`.__pyod_annotate__` attribute.
+
+----------------
+pyoload.overload
+----------------
+
+Implements function overloading in python via a simple decorator
+
+.. code-block:: python
+
+  from pyoload import overload
+  import math
+  cache = {}
+
+  tan_is_real = lambda v: not (v + 90) % 180 == 0
+
+  @overload
+  def tan(num:Validator(tan_is_real, opposite=True)):
+      raise ValueError(num)
+
+  @overload
+  def tan(num:int|float) -> float:
+      return math.tan(num(
+
+  tan(6)
+
+
+When an overload is registerred, the function name in the form :python:`functionModuleName.functionQualName` is goten using `pyoload.get_name(funcOrClass)` an annotate is gotten using `pyoload.annotate(func, True)`
+and a new list of overloads is created and stored in :python:`pyoload.__overloads__` dictionarry under it's name. A reference to the list of annotated overloads is stored in the functions `.__pyod_overloads__`.
+
+When the function is called, the wrapper tries all the functions registerred to that name to catch a `pyoload.InternalAnnotationError`. If none ran succesfully, it raises an `pyoload.OverloadError`.
+
+-------
+Casting
+-------
+
+All `pyoload.annotate` and `pyoload.overload` both support Cast objects
+instances of `pyoloas.Cast`.
+It uses recursive casting with integrated support for dictionaries, e.g:
+:python:`dict[int,tuple[list[float] | float]]`
+for a dictionarry mapping of integers to list of floats or floats.
+
+.. note::
+  When a union, e.g `int | str` is passed to Cast, it tries to cast in each of
+  the specified types in the listed order, that is
+
+.. code-block:: python
+
+  cast = pyoload.Cast(int|str)
+  print(repr(cast(3i)))  # Will print `'3i'` as `3i` can not be converted to a complex
+
+
+--------------------
+Accepted annotations
+--------------------
+
+In addition to supporting normal plain types,
+pyoload includes support for generic aliasses of iterable types and some other classes:
+
+- :python:`pyoload.Values(iterable)`
+  e.g `Values("+-*/")` or `Values(range(6))`
+- :python:`pyoload.Cast(type)`
+  Instructs pyoload to cast to the specified type
+- A string
+  The string contents will be evaluated as soon as first function call.
+

docs/build/html/_static/_sphinx_javascript_frameworks_compat.js

@@ -0,0 +1,123 @@
+/* Compatability shim for jQuery and underscores.js.
+ *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
+ */
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+    if (!x) {
+        return x
+    }
+    return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+    if (typeof s === 'undefined')
+        s = document.location.search;
+    var parts = s.substr(s.indexOf('?') + 1).split('&');
+    var result = {};
+    for (var i = 0; i < parts.length; i++) {
+        var tmp = parts[i].split('=', 2);
+        var key = jQuery.urldecode(tmp[0]);
+        var value = jQuery.urldecode(tmp[1]);
+        if (key in result)
+            result[key].push(value);
+        else
+            result[key] = [value];
+    }
+    return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+    function highlight(node, addItems) {
+        if (node.nodeType === 3) {
+            var val = node.nodeValue;
+            var pos = val.toLowerCase().indexOf(text);
+            if (pos >= 0 &&
+                !jQuery(node.parentNode).hasClass(className) &&
+                !jQuery(node.parentNode).hasClass("nohighlight")) {
+                var span;
+                var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+                if (isInSVG) {
+                    span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+                } else {
+                    span = document.createElement("span");
+                    span.className = className;
+                }
+                span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+                node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+                    document.createTextNode(val.substr(pos + text.length)),
+                    node.nextSibling));
+                node.nodeValue = val.substr(0, pos);
+                if (isInSVG) {
+                    var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+                    var bbox = node.parentElement.getBBox();
+                    rect.x.baseVal.value = bbox.x;
+                    rect.y.baseVal.value = bbox.y;
+                    rect.width.baseVal.value = bbox.width;
+                    rect.height.baseVal.value = bbox.height;
+                    rect.setAttribute('class', className);
+                    addItems.push({
+                        "parent": node.parentNode,
+                        "target": rect});
+                }
+            }
+        }
+        else if (!jQuery(node).is("button, select, textarea")) {
+            jQuery.each(node.childNodes, function() {
+                highlight(this, addItems);
+            });
+        }
+    }
+    var addItems = [];
+    var result = this.each(function() {
+        highlight(this, addItems);
+    });
+    for (var i = 0; i < addItems.length; ++i) {
+        jQuery(addItems[i].parent).before(addItems[i].target);
+    }
+    return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+    jQuery.uaMatch = function(ua) {
+        ua = ua.toLowerCase();
+
+        var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+            /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+            /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+            /(msie) ([\w.]+)/.exec(ua) ||
+            ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+            [];
+
+        return {
+            browser: match[ 1 ] || "",
+            version: match[ 2 ] || "0"
+        };
+    };
+    jQuery.browser = {};
+    jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}