Merge branch 'type-hints' into feat-uv-pdm

Author: waketzheng

.github/workflows/codestyle.yml

@@ -9,18 +9,39 @@ jobs:
       matrix:
         python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
     steps:
+<<<<<<< HEAD
     - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
         allow-prereleases: true
     - uses: astral-sh/setup-uv@v6
+=======
+    - uses: actions/checkout@v5
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+        allow-prereleases: true
+>>>>>>> type-hints
     - name: Install dependencies
       run: uv sync --all-extras --all-groups
     - name: Lint with flake8
       run: |
         # stop the build if there are code styling problems. The GitHub editor is 127 chars wide.
+<<<<<<< HEAD
         uv run flake8 . --count --max-line-length=127 --show-source --statistics --exclude .venv,__pycache__
     - name: Check type hints
       run: uv run mypy .
+=======
+        flake8 . --count --max-line-length=127 --show-source --statistics
+    - name: Check type hints
+      run: |
+        pip install mypy lxml-stubs
+        mypy .
+    - name: Ensure library work without docxcompose
+      run: |
+        pip uninstall -y docxcompose
+        python -c "from docxtpl import *"
+>>>>>>> type-hints

.gitignore

@@ -63,4 +63,10 @@ target/
 
 #Pycharm
 .idea
+<<<<<<< HEAD
 .pdm-python
+=======
+
+# In Project Virtual Environment
+.venv/
+>>>>>>> type-hints

CHANGES.rst

@@ -1,3 +1,7 @@
+0.20.2 *(Unreleased)*
+-------------------
+- Move docxcompose to optional dependency (Thanks to Waket Zheng)
+
 0.20.1 (2025-07-15)
 -------------------
 - Fix and improve get_undeclared_template_variables() method (Thanks to Pablo Esteban)

docxtpl/__init__.py

@@ -12,3 +12,7 @@
 from .listing import Listing
 from .richtext import RichText, R, RichTextParagraph, RP
 from .template import DocxTemplate
+try:
+    from .subdoc import Subdoc
+except ImportError:
+    pass

docxtpl/__main__.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import argparse
 import json
 import os
@@ -11,7 +13,7 @@
 QUIET_ARG = "quiet"
 
 
-def make_arg_parser():
+def make_arg_parser() -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(
         usage="python -m docxtpl [-h] [-o] [-q] {} {} {}".format(
             TEMPLATE_ARG, JSON_ARG, OUTPUT_ARG
@@ -42,7 +44,7 @@ def make_arg_parser():
     return parser
 
 
-def get_args(parser):
+def get_args(parser) -> dict:
     try:
         parsed_args = vars(parser.parse_args())
         return parsed_args
@@ -57,7 +59,7 @@ def get_args(parser):
             )
 
 
-def is_argument_valid(arg_name, arg_value, overwrite):
+def is_argument_valid(arg_name: str, arg_value: str, overwrite: bool) -> bool | None:
     # Basic checks for the arguments
     if arg_name == TEMPLATE_ARG:
         return os.path.isfile(arg_value) and arg_value.endswith(".docx")
@@ -69,9 +71,10 @@ def is_argument_valid(arg_name, arg_value, overwrite):
         )
     elif arg_name in [OVERWRITE_ARG, QUIET_ARG]:
         return arg_value in [True, False]
+    return None
 
 
-def check_exists_ask_overwrite(arg_value, overwrite):
+def check_exists_ask_overwrite(arg_value: str, overwrite: bool) -> bool:
     # If output file does not exist or command was run with overwrite option,
     # returns True, else asks for overwrite confirmation. If overwrite is
     # confirmed returns True, else raises OSError.
@@ -93,7 +96,7 @@ def check_exists_ask_overwrite(arg_value, overwrite):
         return True
 
 
-def validate_all_args(parsed_args):
+def validate_all_args(parsed_args: dict) -> None:
     overwrite = parsed_args[OVERWRITE_ARG]
     # Raises AssertionError if any of the arguments is not validated
     try:
@@ -108,7 +111,7 @@ def validate_all_args(parsed_args):
         )
 
 
-def get_json_data(json_path):
+def get_json_data(json_path) -> dict:
     with open(json_path) as file:
         try:
             json_data = json.load(file)
@@ -121,22 +124,22 @@ def get_json_data(json_path):
             raise RuntimeError("Failed to get json data.")
 
 
-def make_docxtemplate(template_path):
+def make_docxtemplate(template_path: str) -> DocxTemplate:
     try:
         return DocxTemplate(template_path)
     except TemplateError:
         raise RuntimeError("Could not create docx template.")
 
 
-def render_docx(doc, json_data):
+def render_docx(doc: DocxTemplate, json_data: dict) -> DocxTemplate:
     try:
         doc.render(json_data)
         return doc
     except TemplateError:
         raise RuntimeError("An error ocurred while trying to render the docx")
 
 
-def save_file(doc, parsed_args):
+def save_file(doc: DocxTemplate, parsed_args: dict) -> None:
     try:
         output_path = parsed_args[OUTPUT_ARG]
         doc.save(output_path)
@@ -151,7 +154,7 @@ def save_file(doc, parsed_args):
         raise RuntimeError("Failed to save file.")
 
 
-def main():
+def main() -> None:
     parser = make_arg_parser()
     # Everything is in a try-except block that catches a RuntimeError that is
     # raised if any of the individual functions called cause an error

docxtpl/_compat.py

@@ -0,0 +1,9 @@
+# -*- coding: utf-8 -*-
+try:
+    from html import escape
+except ImportError:
+    # cgi.escape is deprecated in python 3.7
+    from cgi import escape  # type:ignore[attr-defined,no-redef]
+
+
+__all__ = ("escape",)

docxtpl/inline_image.py

@@ -7,14 +7,22 @@
 
 from __future__ import annotations
 
+<<<<<<< HEAD
 from typing import IO
+=======
+from typing import IO, TYPE_CHECKING
+>>>>>>> type-hints
 
 from docx.oxml import OxmlElement, parse_xml
 from docx.oxml.ns import qn
 from docx.shared import Length
 
 from .template import DocxTemplate
 
+if TYPE_CHECKING:
+    from docx.shared import Length
+    from .template import DocxTemplate
+
 
 class InlineImage(object):
     """Class to generate an inline image

docxtpl/listing.py

@@ -5,11 +5,15 @@
 @author: Eric Lapouyade
 """
 
+<<<<<<< HEAD
 try:
     from html import escape
 except ImportError:
     # cgi.escape is deprecated in python 3.7
     from cgi import escape  # type:ignore[attr-defined,no-redef]
+=======
+from ._compat import escape
+>>>>>>> type-hints
 
 
 class Listing(object):

docxtpl/richtext.py

@@ -5,11 +5,15 @@
 @author: Eric Lapouyade
 """
 
+<<<<<<< HEAD
 try:
     from html import escape
 except ImportError:
     # cgi.escape is deprecated in python 3.7
     from cgi import escape  # type:ignore[attr-defined,no-redef]
+=======
+from ._compat import escape
+>>>>>>> type-hints
 
 
 class RichText(object):