dp_wizard_templates 0.3.0__py2.py3-none-any.whl → 0.4.0__py2.py3-none-any.whl

dp_wizard_templates/VERSION

@@ -1 +1 @@
-0.3.0
+0.4.0

dp_wizard_templates/code_template.py

@@ -1,8 +1,13 @@
-from typing import Optional, Callable
+from typing import Optional, Callable, Iterable
 from pathlib import Path
 import inspect
 import re
 import black
+import json
+
+
+class TemplateException(Exception):
+    pass
 
 
 def _get_body(func):
@@ -12,46 +17,71 @@ def _get_body(func):
     if not re.match(r"def \w+\((\w+(, \w+)*)?\):", first_line.strip()):
         # Parsing to AST and unparsing is a more robust option,
         # but more complicated.
-        raise Exception(f"def and parameters should fit on one line: {first_line}")
+        raise TemplateException(
+            f"def and parameters should fit on one line: {first_line}"
+        )
 
     # The "def" should not be in the output,
     # and cleandoc handles the first line differently.
     source_lines[0] = ""
     body = inspect.cleandoc("\n".join(source_lines))
-    body = re.sub(
-        r"\s*#\s+type:\s+ignore\s*",
-        "\n",
-        body,
-    )
-    body = re.sub(
-        r"\s*#\s+noqa:.+",
-        "",
-        body,
-    )
+    comments_to_strip = [
+        r"\s+#\s+type:\s+ignore\s*",
+        r"\s+#\s+noqa:.+\s*",
+        r"\s+#\s+pragma:\s+no cover\s*",
+    ]
+    for comment_re in comments_to_strip:
+        body = re.sub(
+            comment_re,
+            "\n",
+            body,
+        )
+
     return body
 
 
+def _check_repr(value):
+    """
+    Confirms that the string returned by repr()
+    can be evaluated to recreate the original value.
+    Takes a conservative approach by checking
+    if the value can be serialized to JSON.
+    """
+    try:
+        json.dumps(value)
+    except TypeError as e:
+        raise TemplateException(e)
+    return repr(value)
+
+
 class Template:
     def __init__(
         self,
         template: str | Callable,
         root: Optional[Path] = None,
+        ignore: Iterable[str] = ("TODO",),
     ):
-        if root is not None:
-            template_name = f"_{template}.py"
-            template_path = root / template_name
-            self._source = f"'{template_name}'"
-            self._template = template_path.read_text()
-        else:
+        if root is None:
             if callable(template):
                 self._source = "function template"
                 self._template = _get_body(template)
             else:
                 self._source = "string template"
                 self._template = template
+        else:
+            if callable(template):
+                raise TemplateException(
+                    "If template is function, root kwarg not allowed"
+                )
+            else:
+                template_name = f"_{template}.py"
+                template_path = root / template_name
+                self._source = f"'{template_name}'"
+                self._template = template_path.read_text()
         # We want a list of the initial slots, because substitutions
         # can produce sequences of upper case letters that could be mistaken for slots.
         self._initial_slots = self._find_slots()
+        self._ignore = ignore
 
     def _find_slots(self) -> set[str]:
         # Slots:
@@ -75,7 +105,7 @@ class Template:
         for k, v in kwargs.items():
             function(k, v, errors)
         if errors:
-            raise Exception(self._make_message(errors))
+            raise TemplateException(self._make_message(errors))
 
     def _fill_inline_slots(
         self,
@@ -141,7 +171,7 @@ class Template:
         """
         Fill in string or numeric values. `repr` is called before filling.
         """
-        self._fill_inline_slots(stringifier=repr, **kwargs)
+        self._fill_inline_slots(stringifier=_check_repr, **kwargs)
         return self
 
     def fill_code_blocks(self, **kwargs) -> "Template":
@@ -168,10 +198,10 @@ class Template:
         return self
 
     def finish(self, reformat: bool = False) -> str:
-        unfilled_slots = self._initial_slots & self._find_slots()
+        unfilled_slots = (self._initial_slots & self._find_slots()) - set(self._ignore)
         if unfilled_slots:
             errors = [f"'{slot}' slot not filled" for slot in unfilled_slots]
-            raise Exception(self._make_message(errors))
+            raise TemplateException(self._make_message(errors))
 
         if reformat:
             self._template = black.format_str(self._template, mode=black.Mode())

{dp_wizard_templates-0.3.0.dist-info → dp_wizard_templates-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dp_wizard_templates
-Version: 0.3.0
+Version: 0.4.0
 Summary: Code templating tools
 Author-email: The OpenDP Project <info@opendp.org>
 Description-Content-Type: text/markdown

dp_wizard_templates-0.4.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+dp_wizard_templates/VERSION,sha256=zXhTTtFa1GkStxM50UF9DQQ9gwnCuUQV8-0bnR_frtA,5
+dp_wizard_templates/__init__.py,sha256=E2xrnvZGY24pU3PCryH4TmvhNYsLmxXCtfvIcYNbTYw,126
+dp_wizard_templates/code_template.py,sha256=mHJKN0pzPHIGSF3K_ffwM1m1VPAjQ-zdwQawzPgKoQk,6606
+dp_wizard_templates/converters.py,sha256=0Ml_V71Z6zce2SaxDQMzYXg-5jQw2-NWChrY_9SCGIo,4359
+dp_wizard_templates/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dp_wizard_templates-0.4.0.dist-info/licenses/LICENSE,sha256=FDrIMeZPiT4g_4w0i1Ec4Bc8h9wfNytroheQN4508yU,1063
+dp_wizard_templates-0.4.0.dist-info/WHEEL,sha256=Dyt6SBfaasWElUrURkknVFAZDHSTwxg3PaTza7RSbkY,100
+dp_wizard_templates-0.4.0.dist-info/METADATA,sha256=zXPD9TDjoYP-T3kIO_yJMARkU3L50Qte8zyEVLwbQYs,1881
+dp_wizard_templates-0.4.0.dist-info/RECORD,,

dp_wizard_templates-0.3.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-dp_wizard_templates/VERSION,sha256=VQYTU3_EiPOzcq90pAAYefASyEZbgW8bhcbTRGss-0k,5
-dp_wizard_templates/__init__.py,sha256=E2xrnvZGY24pU3PCryH4TmvhNYsLmxXCtfvIcYNbTYw,126
-dp_wizard_templates/code_template.py,sha256=BAt9vsvrusqR3mETsUE4HfsPgF3D0yPHgL8Q0no01h4,5735
-dp_wizard_templates/converters.py,sha256=0Ml_V71Z6zce2SaxDQMzYXg-5jQw2-NWChrY_9SCGIo,4359
-dp_wizard_templates/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-dp_wizard_templates-0.3.0.dist-info/licenses/LICENSE,sha256=FDrIMeZPiT4g_4w0i1Ec4Bc8h9wfNytroheQN4508yU,1063
-dp_wizard_templates-0.3.0.dist-info/WHEEL,sha256=Dyt6SBfaasWElUrURkknVFAZDHSTwxg3PaTza7RSbkY,100
-dp_wizard_templates-0.3.0.dist-info/METADATA,sha256=uBCyEVM3KWsLChzbFCYT8nxjwdxvQeWMsGAKSKCiEYA,1881
-dp_wizard_templates-0.3.0.dist-info/RECORD,,