Skip to content

Fixes for render functions chunk_size parameter and negative skipped linesin error message #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 2, 2024
Merged

Fixes for render functions chunk_size parameter and negative skipped linesin error message #5

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d251bdc
Fix: TypeError with chunk_size=None in rendering iter functions
michalpokusa Oct 29, 2024
f6ce97b
Renamed _CACHE to CACHED_TEMPLATES
michalpokusa Oct 29, 2024
6c8d558
Fix: Negative number of skipped lines were displayed
michalpokusa Oct 30, 2024
b8782a2
Minor refactor and rename of variables to pass pylint
michalpokusa Oct 30, 2024
94a54c7
Refactored variable names to be consistent
michalpokusa Nov 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 38 additions & 32 deletions adafruit_templateengine.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,19 +93,33 @@ def _underline_token_in_template(
"""

template_before_token = token.template[: token.start_position]
if skipped_lines := template_before_token.count("\n") - lines_around:
template_before_token = (
f"{cls._skipped_lines_message(skipped_lines)}\n"
+ "\n".join(template_before_token.split("\n")[-(lines_around + 1) :])
if top_skipped_lines := template_before_token.count("\n") - lines_around:
template_before_token = "\n".join(
template_before_token.split("\n")[-(lines_around + 1) :]
)

if 0 < top_skipped_lines:
top_skipped_lines_message = cls._skipped_lines_message(
top_skipped_lines
)
template_before_token = (
f"{top_skipped_lines_message}\n{template_before_token}"
)

template_after_token = token.template[token.end_position :]
if skipped_lines := template_after_token.count("\n") - lines_around:
template_after_token = (
"\n".join(template_after_token.split("\n")[: (lines_around + 1)])
+ f"\n{cls._skipped_lines_message(skipped_lines)}"
if bottom_skipped_lines := template_after_token.count("\n") - lines_around:
template_after_token = "\n".join(
template_after_token.split("\n")[: (lines_around + 1)]
)

if 0 < bottom_skipped_lines:
bottom_skipped_lines_message = cls._skipped_lines_message(
bottom_skipped_lines
)
template_after_token = (
f"{template_after_token}\n{bottom_skipped_lines_message}"
)

lines_before_line_with_token = template_before_token.rsplit("\n", 1)[0]

line_with_token = (
Expand All @@ -122,7 +136,7 @@ def _underline_token_in_template(

lines_after_line_with_token = template_after_token.split("\n", 1)[-1]

return "\n".join(
return "\n" + "\n".join(
[
lines_before_line_with_token,
line_with_token,
Expand Down Expand Up @@ -771,7 +785,7 @@ def __init__(self, template_path: str) -> None:
super().__init__(template_string)


_CACHE: "dict[int, Template| FileTemplate]" = {}
CACHED_TEMPLATES: "dict[int, Template| FileTemplate]" = {}


def render_string_iter(
Expand Down Expand Up @@ -803,19 +817,15 @@ def render_string_iter(
"""
key = hash(template_string)

if cache and key in _CACHE:
return _yield_as_sized_chunks(
_CACHE[key].render_iter(context or {}, chunk_size), chunk_size
)
if cache and key in CACHED_TEMPLATES:
return CACHED_TEMPLATES[key].render_iter(context or {}, chunk_size=chunk_size)

template = Template(template_string)

if cache:
_CACHE[key] = template
CACHED_TEMPLATES[key] = template

return _yield_as_sized_chunks(
template.render_iter(context or {}), chunk_size=chunk_size
)
return template.render_iter(context or {}, chunk_size=chunk_size)


def render_string(
Expand All @@ -841,13 +851,13 @@ def render_string(
"""
key = hash(template_string)

if cache and key in _CACHE:
return _CACHE[key].render(context or {})
if cache and key in CACHED_TEMPLATES:
return CACHED_TEMPLATES[key].render(context or {})

template = Template(template_string)

if cache:
_CACHE[key] = template
CACHED_TEMPLATES[key] = template

return template.render(context or {})

Expand Down Expand Up @@ -881,19 +891,15 @@ def render_template_iter(
"""
key = hash(template_path)

if cache and key in _CACHE:
return _yield_as_sized_chunks(
_CACHE[key].render_iter(context or {}, chunk_size), chunk_size
)
if cache and key in CACHED_TEMPLATES:
return CACHED_TEMPLATES[key].render_iter(context or {}, chunk_size=chunk_size)

template = FileTemplate(template_path)

if cache:
_CACHE[key] = template
CACHED_TEMPLATES[key] = template

return _yield_as_sized_chunks(
template.render_iter(context or {}, chunk_size=chunk_size), chunk_size
)
return template.render_iter(context or {}, chunk_size=chunk_size)


def render_template(
Expand All @@ -920,12 +926,12 @@ def render_template(

key = hash(template_path)

if cache and key in _CACHE:
return _CACHE[key].render(context or {})
if cache and key in CACHED_TEMPLATES:
return CACHED_TEMPLATES[key].render(context or {})

template = FileTemplate(template_path)

if cache:
_CACHE[key] = template
CACHED_TEMPLATES[key] = template

return template.render(context or {})