Skip to content

Commit

Permalink
🐛 Wrap Jinja exceptions.
Browse files Browse the repository at this point in the history
  • Loading branch information
Raphael Krupinski committed Feb 2, 2024
1 parent 996bbaf commit 2b1586d
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 5 deletions.
4 changes: 4 additions & 0 deletions src/rybak/_types.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,7 @@
Item = TypeVar('Item')
LoopOverFn: TypeAlias = Callable[[Iterable[Item]], Item]
RenderFn: TypeAlias = Callable[[str, str, TemplateData], None]


class RenderError(Exception):
pass
15 changes: 12 additions & 3 deletions src/rybak/jinja.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

import jinja2

from ._types import LoopOverFn, TemplateData
from ._types import LoopOverFn, RenderError, TemplateData
from .adapter import RendererAdapter
from .pycompat import Traversable

Expand All @@ -23,7 +23,16 @@ def render_str(self, template: str, data: TemplateData, loop_over: Optional[Loop
env = self._env.overlay()
env.globals['loop_over'] = loop_over

return env.from_string(template).render(**data)
template_obj = env.from_string(template)
try:
return template_obj.render(**data)
except jinja2.TemplateError as e:
raise RenderError from e

def render_file(self, template_file: Traversable, target_file: Path, data: TemplateData) -> None:
target_file.write_text(self._env.get_template(str(template_file)).render(**data))
template_obj = self._env.get_template(str(template_file))
try:
text = template_obj.render(**data)
except jinja2.TemplateError as e:
raise RenderError from e
target_file.write_text(text)
2 changes: 1 addition & 1 deletion src/rybak/pycompat.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
if sys.version_info >= (3, 12):
from importlib.resources.abc import Traversable
else:
from importlib_resources.abc import Traversable
from importlib_resources.abc import Traversable # type: ignore[import-not-found]

if sys.version_info >= (3, 10):
from typing import TypeAlias
Expand Down
3 changes: 2 additions & 1 deletion tests/test_jinja_loop_nested/test_jinja_loop_nested.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import jinja2.loaders
from compare import cmp_dirs
from rybak import render
from rybak._types import RenderError
from rybak.jinja import JinjaAdapter


Expand Down Expand Up @@ -34,7 +35,7 @@ def test_gen(self):
cmp_dirs(test_root / 'output', target_root)

def test_error_missing_value(self):
with tempfile.TemporaryDirectory() as tmp, self.assertRaises(jinja2.UndefinedError):
with tempfile.TemporaryDirectory() as tmp, self.assertRaises(RenderError):
test_root = Path(__file__).parent
target_root = Path(tmp)
render(
Expand Down

0 comments on commit 2b1586d

Please sign in to comment.