jinja2-indent 0.1.0__tar.gz

jinja2_indent-0.1.0/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.1
+Name: jinja2-indent
+Version: 0.1.0
+Summary: A Jinja2 extension for managing indentation in templates.
+License: MIT
+Author: Mihail Mishakin
+Author-email: x896321475@gmail.com
+Maintainer: Mihail Mishakin
+Maintainer-email: x896321475@gmail.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Dist: jinja2 (>=3.0.0,<4.0.0)
+Requires-Dist: jinja2-simple-tags (>=0.6.1,<0.7.0)
+Project-URL: repository, https://github.com/dldevinc/jinja2-indent
+Description-Content-Type: text/markdown
+
+# jinja2-indent
+
+This Jinja2 extension adjusts the indentation of block content to a specified width.
+
+[![PyPI](https://img.shields.io/pypi/v/jinja2-indent.svg)](https://pypi.org/project/jinja2-indent/)
+[![Build Status](https://github.com/dldevinc/jinja2-indent/actions/workflows/tests.yml/badge.svg)](https://github.com/dldevinc/jinja2-indent)
+[![Software license](https://img.shields.io/pypi/l/jinja2-indent.svg)](https://pypi.org/project/jinja2-indent/)
+
+## Compatibility
+
+-   `python` >= 3.9
+
+## Installation
+
+Install the latest release with pip:
+
+```shell
+pip install jinja2-indent
+```
+
+## Usage
+
+The `{% indent %}` tag provided by this extension allows you to adjust the indentation level of the content inside the tag block. You can specify the desired width (in spaces), and the extension will reformat the content accordingly. This is particularly useful for aligning nested or indented structures in templates.
+
+### Example
+
+The following example demonstrates how to increase the indentation of a block of text:
+
+```python
+from jinja2 import Environment
+from jinja2_indent import IndentExtension
+
+env = Environment(extensions=[IndentExtension])
+
+template = env.from_string("""
+root:
+{% indent 4 %}
+- name: a
+  value: 1
+
+- name: b
+  value: 2
+
+- name: c
+  value: 3
+{% endindent %}
+""")
+
+output = template.render()
+print(output)
+```
+
+```
+root:
+    - name: a
+      value: 1
+
+    - name: b
+      value: 2
+
+    - name: c
+      value: 3
+```
+
+The following example demonstrates how to remove unnecessary indentation from a block of text:
+
+```python
+from jinja2 import Environment
+from jinja2_indent import IndentExtension
+
+env = Environment(extensions=[IndentExtension])
+
+template = env.from_string("""
+- name: a
+  value: 1
+
+{% indent 0 %}
+  - name: b
+    value: 2
+{% endindent %}
+
+- name: c
+  value: 3
+""")
+
+output = template.render()
+print(output)
+```
+
+```
+- name: a
+  value: 1
+
+- name: b
+  value: 2
+
+- name: c
+  value: 3
+```
+

jinja2_indent-0.1.0/README.md

@@ -0,0 +1,99 @@
+# jinja2-indent
+
+This Jinja2 extension adjusts the indentation of block content to a specified width.
+
+[![PyPI](https://img.shields.io/pypi/v/jinja2-indent.svg)](https://pypi.org/project/jinja2-indent/)
+[![Build Status](https://github.com/dldevinc/jinja2-indent/actions/workflows/tests.yml/badge.svg)](https://github.com/dldevinc/jinja2-indent)
+[![Software license](https://img.shields.io/pypi/l/jinja2-indent.svg)](https://pypi.org/project/jinja2-indent/)
+
+## Compatibility
+
+-   `python` >= 3.9
+
+## Installation
+
+Install the latest release with pip:
+
+```shell
+pip install jinja2-indent
+```
+
+## Usage
+
+The `{% indent %}` tag provided by this extension allows you to adjust the indentation level of the content inside the tag block. You can specify the desired width (in spaces), and the extension will reformat the content accordingly. This is particularly useful for aligning nested or indented structures in templates.
+
+### Example
+
+The following example demonstrates how to increase the indentation of a block of text:
+
+```python
+from jinja2 import Environment
+from jinja2_indent import IndentExtension
+
+env = Environment(extensions=[IndentExtension])
+
+template = env.from_string("""
+root:
+{% indent 4 %}
+- name: a
+  value: 1
+
+- name: b
+  value: 2
+
+- name: c
+  value: 3
+{% endindent %}
+""")
+
+output = template.render()
+print(output)
+```
+
+```
+root:
+    - name: a
+      value: 1
+
+    - name: b
+      value: 2
+
+    - name: c
+      value: 3
+```
+
+The following example demonstrates how to remove unnecessary indentation from a block of text:
+
+```python
+from jinja2 import Environment
+from jinja2_indent import IndentExtension
+
+env = Environment(extensions=[IndentExtension])
+
+template = env.from_string("""
+- name: a
+  value: 1
+
+{% indent 0 %}
+  - name: b
+    value: 2
+{% endindent %}
+
+- name: c
+  value: 3
+""")
+
+output = template.render()
+print(output)
+```
+
+```
+- name: a
+  value: 1
+
+- name: b
+  value: 2
+
+- name: c
+  value: 3
+```

jinja2_indent-0.1.0/jinja2_indent/__init__.py

@@ -0,0 +1 @@
+from .extension import IndentExtension

jinja2_indent-0.1.0/jinja2_indent/extension.py

@@ -0,0 +1,132 @@
+import itertools
+import re
+from typing import Generator
+
+from jinja2_simple_tags import ContainerTag
+
+re_initial_newline = re.compile(r"^\r?\n")
+re_leading_spaces = re.compile(r"^([\s\t]*)(.*)")
+
+
+class IndentExtension(ContainerTag):
+    """
+    A Jinja2 extension for managing indentation in templates.
+    """
+
+    tags = {"indent"}
+
+    def render(self, width: int, caller=None):
+        """
+        Render the content with adjusted indentation.
+
+        Parameters:
+        - width (int): Target indentation width.
+        - caller (callable): A callable that provides the content to process.
+
+        Returns:
+        - str: The content with adjusted indentation.
+        """
+        content = caller()
+
+        # Strip
+        content = re_initial_newline.sub("", content)
+
+        # Split lines and expand tabs to spaces
+        lines = split_and_expand_tabs(content)
+
+        # Get current indentation level
+        current_indentation = get_indentation(lines)
+
+        # Calculate the shift needed for the desired indentation
+        shift = max(-current_indentation, width - current_indentation)
+
+        # Adjust lines and join them back together
+        adjusted_lines = adjust_lines(lines, shift)
+        return "\n".join(adjusted_lines)
+
+
+def split_and_expand_tabs(text: str, tabsize: int = 4) -> list[str]:
+    """
+    Splits the given text into lines, preserving leading whitespace
+    and replacing tabs with spaces.
+
+    Parameters:
+    - text (str): The input text to be split into lines.
+    - tabsize (int, optional): The number of spaces to replace
+        each tab character with. Default is 4.
+
+    Returns:
+    - list[str]: A list of lines with tabs replaced by the specified number
+        of spaces, while maintaining the leading whitespace of each line.
+    """
+    lines = []
+    for line in text.splitlines():
+        match = re_leading_spaces.match(line)
+
+        # Extract the leading whitespace characters (spaces and tabs)
+        leading_spaces = match.group(1)
+
+        # Extract the remaining content of the line
+        content = match.group(2)
+
+        # Replace all tabs with spaces, according to the specified tabsize
+        lines.append(leading_spaces.expandtabs(tabsize) + content)
+
+    return lines
+
+
+def get_indentation(lines: list[str]) -> int:
+    """
+    Calculate the minimum indentation (number of leading spaces)
+    of non-whitespace lines in a list of strings.
+
+    Args:
+        lines (list[str]): A list of strings to analyze for indentation.
+
+    Returns:
+        int: The minimum indentation of the non-whitespace lines.
+             Returns 0 if all lines are empty or contain only whitespace.
+    """
+    if not lines:
+        return 0
+
+    indentation = float("inf")
+
+    for line in lines:
+        # Calculate the number of leading spaces in the current line
+        line_indentation = sum(1 for _ in itertools.takewhile(str.isspace, line))
+
+        # Skip whitespace-only lines
+        if line_indentation == len(line):
+            continue
+
+        indentation = min(indentation, line_indentation)
+
+    return indentation if indentation != float("inf") else 0
+
+
+def adjust_lines(lines: list[str], shift: int) -> Generator[str, None, None]:
+    """
+    Adjust the indentation of each line by adding or removing spaces.
+
+    Parameters:
+    - lines (list[str]): A list of strings to adjust.
+    - shift (int): The number of spaces to add (if positive) or remove (if negative).
+
+    Yields:
+    - str: The adjusted lines with modified indentation.
+    """
+    if not lines:
+        return
+
+    if not shift:
+        yield from lines
+        return
+
+    for line in lines:
+        if not line:
+            yield line
+        elif shift > 0:
+            yield " " * shift + line
+        else:
+            yield line[-shift:]

jinja2_indent-0.1.0/pyproject.toml

@@ -0,0 +1,88 @@
+[tool.poetry]
+name = "jinja2-indent"
+version = "0.1.0"
+description = "A Jinja2 extension for managing indentation in templates."
+authors = ["Mihail Mishakin <x896321475@gmail.com>"]
+maintainers = ["Mihail Mishakin <x896321475@gmail.com>"]
+readme = "README.md"
+license = "MIT"
+classifiers = [
+    "Operating System :: OS Independent",
+    "Development Status :: 3 - Alpha",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+packages = [
+    { include = "jinja2_indent" },
+]
+
+[tool.poetry.urls]
+repository = "https://github.com/dldevinc/jinja2-indent"
+
+[tool.poetry.dependencies]
+python = "^3.9"
+jinja2 = "^3.0.0"
+jinja2-simple-tags = "^0.6.1"
+
+[tool.poetry.group.pytest]
+optional = true
+
+[tool.poetry.group.pytest.dependencies]
+pytest = "^8.3.4"
+pytest-xdist = "^3.6.1"
+pytest-cov = "*"
+
+[tool.isort]
+extend_skip = [".md", ".json"]
+line_length = 90
+known_first_party = ["jinja2_indent"]
+multi_line_output = 5
+
+[tool.flake8]
+max-line-length = 90
+extend-exclude = [
+    "tests",
+]
+per-file-ignores = [
+    "__init__.py: F401",    # imported but unused
+    "apps.py: F401",        # imported but unused
+]
+extend-ignore = [
+    # "E501",               # line too long
+    "E128",                 # continuation line under-indented for visual indent
+]
+
+[tool.pytest.ini_options]
+addopts = "--showlocals -rf -s"
+norecursedirs = [
+    "*.egg",
+    ".*",
+    "_darcs",
+    "build",
+    "CVS",
+    "dist",
+    "node_modules",
+    "venv",
+    ".venv",
+    "{arch}",
+    "__pycache__",
+]
+
+[tool.coverage.run]
+source = [
+    "jinja2_indent/",
+]
+omit = [
+    "*/tests/*",
+]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"