add str method to JinjaTemplateError

[ajtmccarty]

add __str__ to Jinja templates so that they can be correctly displayed when passed into str()

one of these errors was raised during a migration and passed into str, which resulted in an empty string and made troubleshooting harder than it needed to be

Summary by CodeRabbit

• Bug Fixes
  • Template error messages now present correctly when converted to strings, improving readability in logs and user-facing messages.

[coderabbitai]

Walkthrough

A __str__ method was added to the JinjaTemplateError class in infrahub_sdk/template/exceptions.py. The method returns the instance's message attribute, providing a string representation for the exception. The change adds three lines of code.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The pull request title 'add str method to JinjaTemplateError' directly and clearly describes the main change: adding a str method to the JinjaTemplateError class.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

infrahub_sdk/template/exceptions.py (1)

11-16: ⚠️ Potential issue | 🟡 Minor

Add class-level type annotation for message to fix the pipeline failure.

The CI pipeline reports a type error because the type checker cannot infer that self.message is always str. Adding a class-level type annotation will resolve this.

🔧 Proposed fix

 class JinjaTemplateError(Error):
+    message: str
+
     def __init__(self, message: str) -> None:
         self.message = message

     def __str__(self) -> str:
         return self.message

[cloudflare-workers-and-pages]

Deploying infrahub-sdk-python with    Cloudflare Pages

Latest commit:	dd1103e
Status:	✅  Deploy successful!
Preview URL:	https://57055048.infrahub-sdk-python.pages.dev
Branch Preview URL:	https://ajtm-0203206-str-jinja-err.infrahub-sdk-python.pages.dev

View logs

[codecov]

Codecov Report

❌ Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
infrahub_sdk/template/exceptions.py	50.00%	1 Missing ⚠️

@@            Coverage Diff             @@
##           stable     #795      +/-   ##
==========================================
- Coverage   80.36%   80.35%   -0.01%     
==========================================
  Files         115      115              
  Lines        9865     9867       +2     
  Branches     1504     1504              
==========================================
+ Hits         7928     7929       +1     
- Misses       1415     1416       +1     
  Partials      522      522              

Flag	Coverage Δ
integration-tests	41.41% <0.00%> (-0.01%)	⬇️
python-3.10	51.37% <0.00%> (+<0.01%)	⬆️
python-3.11	51.35% <0.00%> (-0.02%)	⬇️
python-3.12	51.37% <0.00%> (-0.02%)	⬇️
python-3.13	51.35% <0.00%> (-0.04%)	⬇️
python-3.14	53.02% <0.00%> (-0.02%)	⬇️
python-filler-3.12	24.08% <50.00%> (+<0.01%)	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
infrahub_sdk/template/exceptions.py	96.00% <50.00%> (-4.00%)	⬇️

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.