refactor @OVERRIDES decorator

Author: LostInDarkMath

CHANGELOG.md

@@ -1,4 +1,7 @@
 # Changelog
+## Pedantic 2.1.6
+- Remove `inspect.getsource()` call from `@overrides`
+
 ## Pedantic 2.1.5
 - Close `multiprocess.connection.Connection` correctly in `@in_subprocess` decorator
 - Updated dependencies

docs/pedantic/decorators/fn_deco_overrides.html

@@ -30,7 +30,6 @@ <h1 class="title">Module <code>pedantic.decorators.fn_deco_overrides</code></h1>
 
 from pedantic.constants import F
 from pedantic.exceptions import PedanticOverrideException
-from pedantic.models.decorated_function import DecoratedFunction
 
 
 def overrides(base_class: Type) -&gt; F:
@@ -50,16 +49,12 @@ <h1 class="title">Module <code>pedantic.decorators.fn_deco_overrides</code></h1>
     &#34;&#34;&#34;
 
     def decorator(func: F) -&gt; F:
-        deco_func = DecoratedFunction(func=func)
-        uses_multiple_decorators = deco_func.num_of_decorators &gt; 1
+        name = func.__name__
 
-        if not deco_func.is_instance_method and not uses_multiple_decorators:
+        if name not in dir(base_class):
             raise PedanticOverrideException(
-                f&#39;{deco_func.err} Function &#34;{deco_func.name}&#34; should be an instance method of a class!&#39;)
-
-        if deco_func.name not in dir(base_class):
-            raise PedanticOverrideException(
-                f&#39;{deco_func.err} Base class &#34;{base_class.__name__}&#34; does not have such a method &#34;{deco_func.name}&#34;.&#39;)
+                f&#39;In function {func.__qualname__}:\n &#39;
+                f&#39;Base class &#34;{base_class.__name__}&#34; does not have such a method &#34;{name}&#34;.&#39;)
         return func
     return decorator
 
@@ -112,16 +107,12 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     &#34;&#34;&#34;
 
     def decorator(func: F) -&gt; F:
-        deco_func = DecoratedFunction(func=func)
-        uses_multiple_decorators = deco_func.num_of_decorators &gt; 1
-
-        if not deco_func.is_instance_method and not uses_multiple_decorators:
-            raise PedanticOverrideException(
-                f&#39;{deco_func.err} Function &#34;{deco_func.name}&#34; should be an instance method of a class!&#39;)
+        name = func.__name__
 
-        if deco_func.name not in dir(base_class):
+        if name not in dir(base_class):
             raise PedanticOverrideException(
-                f&#39;{deco_func.err} Base class &#34;{base_class.__name__}&#34; does not have such a method &#34;{deco_func.name}&#34;.&#39;)
+                f&#39;In function {func.__qualname__}:\n &#39;
+                f&#39;Base class &#34;{base_class.__name__}&#34; does not have such a method &#34;{name}&#34;.&#39;)
         return func
     return decorator</code></pre>
 </details>

docs/pedantic/decorators/fn_deco_retry.html

@@ -31,16 +31,17 @@ <h1 class="title">Module <code>pedantic.decorators.fn_deco_retry</code></h1>
 from datetime import timedelta
 from functools import wraps
 from logging import Logger
-from typing import Callable, TypeVar, TypeVarTuple, Any
+from typing import Callable, TypeVar, Any, ParamSpec
 
 C = TypeVar(&#39;C&#39;, bound=Callable)
-Ts = TypeVarTuple(&#39;Ts&#39;)
+P = ParamSpec(&#39;P&#39;)
+R = TypeVar(&#39;R&#39;)
 
 
 def retry(
     *,
     attempts: int,
-    exceptions: type[Exception] | tuple[type[Exception], ...] = None,
+    exceptions: type[Exception] | tuple[type[Exception], ...] = Exception,
     sleep_time: timedelta = timedelta(seconds=0),
     logger: Logger = None,
 ) -&gt; Callable[[C], C]:
@@ -61,28 +62,46 @@ <h1 class="title">Module <code>pedantic.decorators.fn_deco_retry</code></h1>
         &gt;&gt;&gt; foo()
     &#34;&#34;&#34;
 
-    if exceptions is None:
-        exceptions = Exception
+    def decorator(func: C) -&gt; C:
+        @wraps(func)
+        def wrapper(*args, **kwargs) -&gt; Any:
+            return retry_func(
+                func,
+                *args,
+                attempts=attempts,
+                exceptions=exceptions,
+                sleep_time=sleep_time,
+                logger=logger,
+                **kwargs,
+            )
+        return wrapper
+    return decorator
+
+
+def retry_func(
+    func: Callable[P, R],
+    *args: P.args,
+    attempts: int,
+    exceptions: type[Exception] | tuple[type[Exception], ...] = Exception,
+    sleep_time: timedelta = timedelta(seconds=0),
+    logger: Logger = None,
+    **kwargs: P.kwargs,
+) -&gt; R:
+    attempt = 1
 
     if logger is None:
         logger = logging.getLogger()
 
-    def decorator(func: C) -&gt; C:
-        @wraps(func)
-        def wrapper(*args, **kwargs) -&gt; Any:
-            attempt = 1
-
-            while attempt &lt; attempts:
-                try:
-                    return func(*args, **kwargs)
-                except exceptions:
-                    logger.warning(f&#39;Exception thrown when attempting to run {func.__name__}, &#39;
-                                   f&#39;attempt {attempt} of {attempts}&#39;)
-                    attempt += 1
-                    time.sleep(sleep_time.total_seconds())
+    while attempt &lt; attempts:
+        try:
             return func(*args, **kwargs)
-        return wrapper
-    return decorator</code></pre>
+        except exceptions:
+            logger.warning(f&#39;Exception thrown when attempting to run {func.__name__}, &#39;
+                           f&#39;attempt {attempt} of {attempts}&#39;)
+            attempt += 1
+            time.sleep(sleep_time.total_seconds())
+
+    return func(*args, **kwargs)</code></pre>
 </details>
 </section>
 <section>
@@ -93,7 +112,7 @@ <h1 class="title">Module <code>pedantic.decorators.fn_deco_retry</code></h1>
 <h2 class="section-title" id="header-functions">Functions</h2>
 <dl>
 <dt id="pedantic.decorators.fn_deco_retry.retry"><code class="name flex">
-<span>def <span class="ident">retry</span></span>(<span>*, attempts: int, exceptions: type[Exception] | tuple[type[Exception], ...] = None, sleep_time: datetime.timedelta = datetime.timedelta(0), logger: logging.Logger = None) ‑> Callable[[~C], ~C]</span>
+<span>def <span class="ident">retry</span></span>(<span>*, attempts: int, exceptions: type[Exception] | tuple[type[Exception], ...] = builtins.Exception, sleep_time: datetime.timedelta = datetime.timedelta(0), logger: logging.Logger = None) ‑> Callable[[~C], ~C]</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Retries the wrapped function/method <code>attempts</code> times if the exceptions listed
@@ -116,7 +135,7 @@ <h2 id="example">Example</h2>
 <pre><code class="python">def retry(
     *,
     attempts: int,
-    exceptions: type[Exception] | tuple[type[Exception], ...] = None,
+    exceptions: type[Exception] | tuple[type[Exception], ...] = Exception,
     sleep_time: timedelta = timedelta(seconds=0),
     logger: Logger = None,
 ) -&gt; Callable[[C], C]:
@@ -137,30 +156,57 @@ <h2 id="example">Example</h2>
         &gt;&gt;&gt; foo()
     &#34;&#34;&#34;
 
-    if exceptions is None:
-        exceptions = Exception
-
-    if logger is None:
-        logger = logging.getLogger()
-
     def decorator(func: C) -&gt; C:
         @wraps(func)
         def wrapper(*args, **kwargs) -&gt; Any:
-            attempt = 1
-
-            while attempt &lt; attempts:
-                try:
-                    return func(*args, **kwargs)
-                except exceptions:
-                    logger.warning(f&#39;Exception thrown when attempting to run {func.__name__}, &#39;
-                                   f&#39;attempt {attempt} of {attempts}&#39;)
-                    attempt += 1
-                    time.sleep(sleep_time.total_seconds())
-            return func(*args, **kwargs)
+            return retry_func(
+                func,
+                *args,
+                attempts=attempts,
+                exceptions=exceptions,
+                sleep_time=sleep_time,
+                logger=logger,
+                **kwargs,
+            )
         return wrapper
     return decorator</code></pre>
 </details>
 </dd>
+<dt id="pedantic.decorators.fn_deco_retry.retry_func"><code class="name flex">
+<span>def <span class="ident">retry_func</span></span>(<span>func: Callable[~P, ~R], *args: P.args, attempts: int, exceptions: type[Exception] | tuple[type[Exception], ...] = builtins.Exception, sleep_time: datetime.timedelta = datetime.timedelta(0), logger: logging.Logger = None, **kwargs: P.kwargs) ‑> ~R</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">def retry_func(
+    func: Callable[P, R],
+    *args: P.args,
+    attempts: int,
+    exceptions: type[Exception] | tuple[type[Exception], ...] = Exception,
+    sleep_time: timedelta = timedelta(seconds=0),
+    logger: Logger = None,
+    **kwargs: P.kwargs,
+) -&gt; R:
+    attempt = 1
+
+    if logger is None:
+        logger = logging.getLogger()
+
+    while attempt &lt; attempts:
+        try:
+            return func(*args, **kwargs)
+        except exceptions:
+            logger.warning(f&#39;Exception thrown when attempting to run {func.__name__}, &#39;
+                           f&#39;attempt {attempt} of {attempts}&#39;)
+            attempt += 1
+            time.sleep(sleep_time.total_seconds())
+
+    return func(*args, **kwargs)</code></pre>
+</details>
+</dd>
 </dl>
 </section>
 <section>
@@ -180,6 +226,7 @@ <h1>Index</h1>
 <li><h3><a href="#header-functions">Functions</a></h3>
 <ul class="">
 <li><code><a title="pedantic.decorators.fn_deco_retry.retry" href="#pedantic.decorators.fn_deco_retry.retry">retry</a></code></li>
+<li><code><a title="pedantic.decorators.fn_deco_retry.retry_func" href="#pedantic.decorators.fn_deco_retry.retry_func">retry_func</a></code></li>
 </ul>
 </li>
 </ul>

docs/pedantic/decorators/fn_deco_validate/fn_deco_validate.html

@@ -398,23 +398,38 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 </code></pre>
 <p>Access them by:</p>
 <ul>
-<li>attribute access::</li>
+<li>attribute access:</li>
 </ul>
-<pre><code class="language-python-repl">&gt;&gt;&gt; Color.RED
-&lt;Color.RED: 1&gt;
-</code></pre>
+<blockquote>
+<blockquote>
+<blockquote>
+<p>Color.RED
+<Color.RED: 1></p>
+</blockquote>
+</blockquote>
+</blockquote>
 <ul>
 <li>value lookup:</li>
 </ul>
-<pre><code class="language-python-repl">&gt;&gt;&gt; Color(1)
-&lt;Color.RED: 1&gt;
-</code></pre>
+<blockquote>
+<blockquote>
+<blockquote>
+<p>Color(1)
+<Color.RED: 1></p>
+</blockquote>
+</blockquote>
+</blockquote>
 <ul>
 <li>name lookup:</li>
 </ul>
-<pre><code class="language-python-repl">&gt;&gt;&gt; Color['RED']
-&lt;Color.RED: 1&gt;
-</code></pre>
+<blockquote>
+<blockquote>
+<blockquote>
+<p>Color['RED']
+<Color.RED: 1></p>
+</blockquote>
+</blockquote>
+</blockquote>
 <p>Enumerations can be iterated over, and know how many members they have:</p>
 <pre><code class="language-python-repl">&gt;&gt;&gt; len(Color)
 3

docs/pedantic/decorators/index.html

@@ -36,7 +36,7 @@ <h1 class="title">Module <code>pedantic.decorators</code></h1>
 from .fn_deco_pedantic import pedantic, pedantic_require_docstring
 from .fn_deco_rename_kwargs import rename_kwargs, Rename
 from .fn_deco_require_kwargs import require_kwargs
-from .fn_deco_retry import retry
+from .fn_deco_retry import retry, retry_func
 from .fn_deco_timer import timer
 from .fn_deco_trace import trace
 from .fn_deco_trace_if_returns import trace_if_returns

docs/pedantic/models/decorated_function.html

@@ -56,7 +56,7 @@ <h1 class="title">Module <code>pedantic.models.decorated_function</code></h1>
 
         self._full_arg_spec = inspect.getfullargspec(func)
         self._signature = inspect.signature(func)
-        self._err = f&#39;In function {func.__qualname__}:&#39; + &#39;\n&#39;
+        self._err = f&#39;In function {func.__qualname__}:\n&#39;
         self._source: str = inspect.getsource(object=func)
 
         if IS_DOCSTRING_PARSER_INSTALLED:
@@ -185,7 +185,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
         self._full_arg_spec = inspect.getfullargspec(func)
         self._signature = inspect.signature(func)
-        self._err = f&#39;In function {func.__qualname__}:&#39; + &#39;\n&#39;
+        self._err = f&#39;In function {func.__qualname__}:\n&#39;
         self._source: str = inspect.getsource(object=func)
 
         if IS_DOCSTRING_PARSER_INSTALLED: