copier-pydantic 0.1.3__tar.gz

copier_pydantic-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Christopher Brown
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

copier_pydantic-0.1.3/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: copier-pydantic
+Version: 0.1.3
+Summary: Adds support for Pydantic Models in Copier templates
+Author: Chris Brown
+Author-email: Chris Brown <cbrown1234@hotmail.co.uk>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Dist: copier>=3.6
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+
+# Copier Pydantic
+
+[![pypi version](https://img.shields.io/pypi/v/copier-pydantic.svg)](https://pypi.org/project/copier-pydantic/)
+
+Jinja2 extensions for Copier that enable using Pydantic Models for validation and within templates
+
+## Installation
+
+With pip:
+
+```bash
+pip install copier-pydantic
+```
+
+With uv:
+
+```bash
+uv tool install copier --with copier-pydantic
+```
+
+With pipx:
+
+```bash
+pipx install copier
+pipx inject copier copier-pydantic
+```
+
+## Usage with Copier
+
+In your copier template configuration:
+
+```yaml
+# Add the jinja extensions
+_jinja_extensions:
+  - copier_pydantic.MultilineValidation
+  - copier_pydantic.PydanticExtension
+
+# and exclude the model.py file from your template
+_exclude:
+  - models.py
+# or use the best practice of having the template in a sub directory
+_subdirectory: template
+```
+
+So your template will look something like this
+
+```
+📁 template_root
+├── 📄 models.py
+├── 📄 copier.yml
+└── 📁 template
+    ├── 📄 {{_copier_conf.answers_file}}.jinja
+    └── 📄 ...
+```
+
+With `models.py` containing your Pydantic `BaseModel`'s like this
+
+```python
+from pydantic import BaseModel
+
+class DatabaseConfig(BaseModel):
+    db_host: str
+    db_port: int
+```
+
+you can then use your model to validate the question input like this
+
+```yaml
+validated_example:
+  type: yaml
+  multiline: true
+  default: |
+    db_host: 'localhost'
+    db_port: 5432
+  validator: "{{ validated_example | validate_as(DatabaseConfig) }}"
+```

copier_pydantic-0.1.3/README.md

@@ -0,0 +1,76 @@
+# Copier Pydantic
+
+[![pypi version](https://img.shields.io/pypi/v/copier-pydantic.svg)](https://pypi.org/project/copier-pydantic/)
+
+Jinja2 extensions for Copier that enable using Pydantic Models for validation and within templates
+
+## Installation
+
+With pip:
+
+```bash
+pip install copier-pydantic
+```
+
+With uv:
+
+```bash
+uv tool install copier --with copier-pydantic
+```
+
+With pipx:
+
+```bash
+pipx install copier
+pipx inject copier copier-pydantic
+```
+
+## Usage with Copier
+
+In your copier template configuration:
+
+```yaml
+# Add the jinja extensions
+_jinja_extensions:
+  - copier_pydantic.MultilineValidation
+  - copier_pydantic.PydanticExtension
+
+# and exclude the model.py file from your template
+_exclude:
+  - models.py
+# or use the best practice of having the template in a sub directory
+_subdirectory: template
+```
+
+So your template will look something like this
+
+```
+📁 template_root
+├── 📄 models.py
+├── 📄 copier.yml
+└── 📁 template
+    ├── 📄 {{_copier_conf.answers_file}}.jinja
+    └── 📄 ...
+```
+
+With `models.py` containing your Pydantic `BaseModel`'s like this
+
+```python
+from pydantic import BaseModel
+
+class DatabaseConfig(BaseModel):
+    db_host: str
+    db_port: int
+```
+
+you can then use your model to validate the question input like this
+
+```yaml
+validated_example:
+  type: yaml
+  multiline: true
+  default: |
+    db_host: 'localhost'
+    db_port: 5432
+  validator: "{{ validated_example | validate_as(DatabaseConfig) }}"
+```

copier_pydantic-0.1.3/pyproject.toml

@@ -0,0 +1,46 @@
+[project]
+name = "copier-pydantic"
+version = "0.1.3"
+description = "Adds support for Pydantic Models in Copier templates"
+readme = "README.md"
+authors = [
+    { name = "Chris Brown", email = "cbrown1234@hotmail.co.uk" }
+]
+requires-python = ">=3.13"
+dependencies = [
+    "copier>=3.6",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[build-system]
+requires = ["uv_build>=0.9.16,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.ruff]
+line-length = 88
+target-version = "py313"
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "D203",
+    "D213",
+    "Q000",
+    "Q003",
+    "COM812",
+]
+
+[tool.ruff.lint.extend-per-file-ignores]
+"src/copier_pydantic/validators.py" = [
+    "ANN401",
+]
+
+[tool.ruff.format]
+quote-style = "single"
+
+[[tool.uv.index]]
+name = "testpypi"
+url = "https://test.pypi.org/simple/"
+publish-url = "https://test.pypi.org/legacy/"
+explicit = true

copier_pydantic-0.1.3/src/copier_pydantic/__init__.py

@@ -0,0 +1,9 @@
+"""Jinja Extensions for Copier templates."""
+
+from .multiline_validation import MultilineValidation
+from .validators import PydanticExtension
+
+__all__ = [
+    'MultilineValidation',
+    'PydanticExtension',
+]

copier_pydantic-0.1.3/src/copier_pydantic/multiline_validation.py

@@ -0,0 +1,31 @@
+"""Enable multiline validation messages with Copier."""
+
+import prompt_toolkit
+from jinja2 import Environment
+from jinja2.ext import Extension
+
+_validation_toolbar_init = prompt_toolkit.widgets.ValidationToolbar.__init__
+
+
+def _validation_toolbar_init_patched(
+    self: prompt_toolkit.widgets.ValidationToolbar,
+    *args: tuple,
+    **kwargs: dict,
+) -> None:
+    """Wrap ValidationToolbar __init__ for patching."""
+    _validation_toolbar_init(self, *args, **kwargs)
+
+    # Uncap validation message length to enable multiline error messages
+    self.container.content.height = None
+
+
+class MultilineValidation(Extension):
+    """Enable multiline error messages for Copier by loading."""
+
+    def __init__(self, environment: Environment) -> None:
+        """Implement extension logic."""
+        super().__init__(environment)
+
+        prompt_toolkit.widgets.ValidationToolbar.__init__ = (
+            _validation_toolbar_init_patched
+        )

copier_pydantic-0.1.3/src/copier_pydantic/validators.py

@@ -0,0 +1,132 @@
+"""Pydantic model integration helpers."""
+
+import importlib.util
+import inspect
+import sys
+from typing import Any
+
+from jinja2 import Environment
+from jinja2.ext import Extension
+from pydantic import BaseModel, RootModel, ValidationError
+
+
+def _to_model(value: Any, model: type[BaseModel], **kwargs: dict) -> BaseModel:
+    """Jinja filter for instantiating model instance.
+
+    `{{ value | to_model(Example) }}`
+    """
+    return model.model_validate(value, strict=True, **kwargs)
+
+
+def _to_model_dict(value: Any, model: type[BaseModel], **kwargs: dict) -> dict:
+    """Jinja filter for instantiating model instance as dictionary.
+
+    `{{ value | to_model_dict(Example) }}`
+
+    Useful if you want simpler usage in jinja, but supports default values etc
+    """
+    return model.model_validate(value, strict=True, **kwargs).model_dump()
+
+
+def _validate_as(value: Any, model: type[BaseModel]) -> str:
+    """Jinja filter for model validation string in copier.yml.
+
+    ```
+    input:
+      type: yaml
+      multiline: true
+      validator: {{ input | validate_as(Example) }}
+    ```
+    """
+    try:
+        model.model_validate(value, strict=True)
+    except ValidationError as err:
+        return str(err)
+    return ''
+
+
+def _is_valid_as(model: type[BaseModel]) -> callable:
+    """Construct jinja test for compatibility with model."""
+
+    def test(value: dict) -> bool:
+        try:
+            model.model_validate(value, strict=True)
+        except ValidationError:
+            return False
+        return True
+
+    return test
+
+
+def _is_model_instance_test(model: type[BaseModel]) -> callable:
+    """Construct jinja test for model instance."""
+
+    def test(value: Any) -> bool:
+        return isinstance(value, model)
+
+    return test
+
+
+# Source: https://stackoverflow.com/questions/5362771/how-to-load-a-module-from-code-in-a-string
+def _import_module_from_string(name: str, source: str) -> None:
+    """Import module from source string.
+
+    Example use:
+    import_module_from_string("m", "f = lambda: print('hello')")
+    m.f()
+    """
+    spec = importlib.util.spec_from_loader(name, loader=None)
+    module = importlib.util.module_from_spec(spec)
+    exec(source, module.__dict__)  # noqa: S102
+    sys.modules[name] = module
+    globals()[name] = module
+
+
+def _is_pydantic_model(obj: Any) -> bool:
+    """Check if pydantic model itself (not instance)."""
+    return (
+        inspect.isclass(obj)
+        and issubclass(obj, BaseModel)
+        and obj not in (BaseModel, RootModel)
+    )
+
+
+class PydanticExtension(Extension):
+    """Adds Pydantic models and helpers."""
+
+    def __init__(self, environment: Environment) -> None:
+        """Implement extension logic."""
+        super().__init__(environment)
+
+        self._load_models()
+
+        # Enable lookup via alias
+        environment.globals['models'] = self.models
+
+        for model in self.models.values():
+            # Add models to namespace for use with generic functions
+            environment.globals[model.__name__] = model
+
+            # Add generic functions
+            # `{{ input | to_model(Example) }}` e.g. for default values
+            environment.filters['to_model'] = _to_model
+            # `{{ input | to_model_dict(Example) }}` e.g. for default values
+            environment.filters['to_model_dict'] = _to_model_dict
+            # `validator: {{ input | validate_as(Example) }}`
+            environment.filters['validate_as'] = _validate_as
+
+            # Pre-create other helpers
+            # `{% if input is Example %}`
+            environment.tests[f'{model.__name__}'] = _is_valid_as(model)
+            # `{% if input is Example_Model %}`
+            environment.tests[f'{model.__name__}_Model'] = _is_model_instance_test(
+                model,
+            )
+
+    def _load_models(self) -> None:
+        models_code, *_ = self.environment.loader.get_source(
+            self.environment,
+            'models.py',
+        )
+        _import_module_from_string('models_module', models_code)
+        self.models = dict(inspect.getmembers(models_module, _is_pydantic_model))  # noqa: F821