black

Author: Eric Lapouyade

.github/workflows/codestyle.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10']
+        python-version: ['3.9', '3.10', '3.11','3.12','3.13']
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}

Pipfile.lock

@@ -26,33 +26,33 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
+    "sphinx.ext.autodoc",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'python-docx-template'
-copyright = u'2015, Eric Lapouyade'
+project = "python-docx-template"
+copyright = "2015, Eric Lapouyade"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.9'
+version = "0.9"
 # The full version, including alpha/beta/rc tags.
-release = '0.9.x'
+release = "0.9.x"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -66,7 +66,7 @@
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ["_build"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -84,7 +84,7 @@
 # show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
@@ -97,7 +97,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = "default"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -126,7 +126,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -175,7 +175,7 @@
 # html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'python-docx-templatedoc'
+htmlhelp_basename = "python-docx-templatedoc"
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -193,8 +193,13 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'python-docx-template.tex', u'python-docx-template Documentation',
-   u'Eric Lapouyade', 'manual'),
+    (
+        "index",
+        "python-docx-template.tex",
+        "python-docx-template Documentation",
+        "Eric Lapouyade",
+        "manual",
+    ),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -223,8 +228,13 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'python-docx-template', u'python-docx-template Documentation',
-     [u'Eric Lapouyade'], 1)
+    (
+        "index",
+        "python-docx-template",
+        "python-docx-template Documentation",
+        ["Eric Lapouyade"],
+        1,
+    )
 ]
 
 # If true, show URL addresses after external links.
@@ -237,9 +247,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'python-docx-template', u'python-docx-template Documentation',
-   u'Eric Lapouyade', 'python-docx-template', 'One line description of project.',
-   'Miscellaneous'),
+    (
+        "index",
+        "python-docx-template",
+        "python-docx-template Documentation",
+        "Eric Lapouyade",
+        "python-docx-template",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.

docs/conf.py

@@ -78,8 +78,8 @@ def check_exists_ask_overwrite(arg_value, overwrite):
     if os.path.exists(arg_value) and not overwrite:
         try:
             msg = (
-                "File %s already exists, would you like to overwrite the existing file? (y/n)"
-                % arg_value
+                "File %s already exists, would you like to overwrite the existing file? "
+                "(y/n)" % arg_value
             )
             if input(msg).lower() == "y":
                 return True
@@ -115,9 +115,8 @@ def get_json_data(json_path):
             return json_data
         except json.JSONDecodeError as e:
             print(
-                "There was an error on line {e.lineno}, column {e.colno} while trying to parse file {json_path}".format(
-                    e=e, json_path=json_path
-                )
+                "There was an error on line {e.lineno}, column {e.colno} while trying "
+                "to parse file {json_path}".format(e=e, json_path=json_path)
             )
             raise RuntimeError("Failed to get json data.")
 

docxtpl/__main__.py

@@ -195,7 +195,8 @@ def cellbg(m):
             src_xml = re.sub(pat, r"\1 \2", src_xml, flags=re.DOTALL)
 
         # add vMerge
-        # use {% vm %} to make this table cell and its copies be vertically merged within a {% for %}
+        # use {% vm %} to make this table cell and its copies
+        # be vertically merged within a {% for %}
         def v_merge_tc(m):
             def v_merge(m1):
                 return (
@@ -864,7 +865,8 @@ def _replace_docx_part_pics(self, doc_part, replaced_pics):
                         replaced_pics[img_id] = True
                         break
 
-            # FIXME: figure out what exceptions are thrown here and catch more specific exceptions
+            # FIXME: figure out what exceptions are thrown here
+            # and catch more specific exceptions
             except Exception:
                 continue
 

docxtpl/template.py

@@ -10,13 +10,13 @@
 def read(*names):
     values = dict()
     for name in names:
-        filename = name + '.rst'
+        filename = name + ".rst"
         if os.path.isfile(filename):
             fd = open(filename)
             value = fd.read()
             fd.close()
         else:
-            value = ''
+            value = ""
         values[name] = value
     return values
 
@@ -27,13 +27,15 @@ def read(*names):
 News
 ====
 %(CHANGES)s
-""" % read('README', 'CHANGES')
+""" % read(
+    "README", "CHANGES"
+)
 
 
 def get_version(pkg):
-    path = os.path.join(os.path.dirname(__file__), pkg, '__init__.py')
+    path = os.path.join(os.path.dirname(__file__), pkg, "__init__.py")
     if sys.version_info >= (3, 0):
-        fh = open(path, encoding='utf-8')   # required to read utf-8 file on windows
+        fh = open(path, encoding="utf-8")  # required to read utf-8 file on windows
     else:
         fh = open(path)  # encoding parameter does not exist in python 2
     with fh:
@@ -43,30 +45,29 @@ def get_version(pkg):
     raise RuntimeError("Unable to find __version__ string in %s." % path)
 
 
-setup(name='docxtpl',
-      version=get_version('docxtpl'),
-      description='Python docx template engine',
-      long_description=long_description,
-      classifiers=[
-          "Intended Audience :: Developers",
-          "Development Status :: 4 - Beta",
-          "Programming Language :: Python :: 3",
-          "Programming Language :: Python :: 3.7",
-          "Programming Language :: Python :: 3.8",
-          "Programming Language :: Python :: 3.9",
-          "Programming Language :: Python :: 3.10",
-          "Programming Language :: Python :: 3.11",
-          "Programming Language :: Python :: 3.12",
-      ],
-      keywords='jinja2',
-      url='https://github.com/elapouya/python-docx-template',
-      author='Eric Lapouyade',
-      license='LGPL 2.1',
-      packages=['docxtpl'],
-      install_requires=['python-docx>=1.1.1',
-                        'docxcompose',
-                        'jinja2',
-                        'lxml'],
-      extras_require={'docs': ['Sphinx', 'sphinxcontrib-napoleon']},
-      eager_resources=['docs'],
-      zip_safe=False)
+setup(
+    name="docxtpl",
+    version=get_version("docxtpl"),
+    description="Python docx template engine",
+    long_description=long_description,
+    classifiers=[
+        "Intended Audience :: Developers",
+        "Development Status :: 4 - Beta",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+    ],
+    keywords="jinja2",
+    url="https://github.com/elapouya/python-docx-template",
+    author="Eric Lapouyade",
+    license="LGPL 2.1",
+    packages=["docxtpl"],
+    install_requires=["python-docx>=1.1.1", "docxcompose", "jinja2", "lxml"],
+    extras_require={"docs": ["Sphinx", "sphinxcontrib-napoleon"]},
+    eager_resources=["docs"],
+    zip_safe=False,
+)

setup.py

@@ -11,9 +11,7 @@
 
 tpl = DocxTemplate("templates/footnotes_tpl.docx")
 
-context = {
-    "a_jinja_variable": "A Jinja variable!"
-}
+context = {"a_jinja_variable": "A Jinja variable!"}
 
 tpl.render(context)
 tpl.save(DEST_FILE)

tests/footnotes.py

@@ -25,19 +25,23 @@
         },
         {
             "image": InlineImage(tpl, "templates/zope.png", height=Mm(10)),
-            "desc": "Zope is a leading Open Source Application Server and Content Management Framework",
+            "desc": "Zope is a leading Open Source Application Server "
+            "and Content Management Framework",
         },
         {
             "image": InlineImage(tpl, "templates/pyramid.png", height=Mm(10)),
-            "desc": "Pyramid is a lightweight Python web framework aimed at taking small web apps into big web apps.",
+            "desc": "Pyramid is a lightweight Python web framework aimed at taking "
+            "small web apps into big web apps.",
         },
         {
             "image": InlineImage(tpl, "templates/bottle.png", height=Mm(10)),
-            "desc": "Bottle is a fast, simple and lightweight WSGI micro web-framework for Python",
+            "desc": "Bottle is a fast, simple and lightweight WSGI micro web-framework "
+            "for Python",
         },
         {
             "image": InlineImage(tpl, "templates/tornado.png", height=Mm(10)),
-            "desc": "Tornado is a Python web framework and asynchronous networking library.",
+            "desc": "Tornado is a Python web framework and asynchronous networking "
+            "library.",
         },
     ],
 }

tests/inline_image.py

@@ -11,21 +11,41 @@
 rtp = RichTextParagraph()
 rt = RichText()
 
-rtp.add("The rich text paragraph function allows paragraph styles to be added to text",parastyle="myrichparastyle")
+rtp.add(
+    "The rich text paragraph function allows paragraph styles to be added to text",
+    parastyle="myrichparastyle",
+)
 rtp.add("Any built in paragraph style can be used", parastyle="IntenseQuote")
-rtp.add("or you can add your own, unlocking all style options", parastyle="createdStyle")
-rtp.add("To use, just create a style in your template word doc with the formatting you want and call it in the code.", parastyle="normal")
-
-rtp.add("This allows for the use of") 
+rtp.add(
+    "or you can add your own, unlocking all style options", parastyle="createdStyle"
+)
+rtp.add(
+    "To use, just create a style in your template word doc with the formatting you want "
+    "and call it in the code.",
+    parastyle="normal",
+)
+
+rtp.add("This allows for the use of")
 rtp.add("custom bullet\apoints", parastyle="SquareBullet")
 rtp.add("Numbered Bullet Points", parastyle="BasicNumbered")
 rtp.add("and Alpha Bullet Points.", parastyle="alphaBracketNumbering")
 rtp.add("You can", parastyle="normal")
 rtp.add("set the", parastyle="centerAlign")
 rtp.add("text alignment", parastyle="rightAlign")
-rtp.add("as well as the spacing between lines of text. Like this for example, this text has very tight spacing between the lines.\aIt also has no space between paragraphs of the same style.", parastyle="TightLineSpacing")
-rtp.add("Unlike this one, which has extra large spacing between lines for when you want to space things out a bit or just write a little less.", parastyle="WideLineSpacing")
-rtp.add("You can also set the background colour of a line.", parastyle="LineShadingGreen")
+rtp.add(
+    "as well as the spacing between lines of text. Like this for example, "
+    "this text has very tight spacing between the lines.\aIt also has no space between "
+    "paragraphs of the same style.",
+    parastyle="TightLineSpacing",
+)
+rtp.add(
+    "Unlike this one, which has extra large spacing between lines for when you want to "
+    "space things out a bit or just write a little less.",
+    parastyle="WideLineSpacing",
+)
+rtp.add(
+    "You can also set the background colour of a line.", parastyle="LineShadingGreen"
+)
 
 rt.add("This works with ")
 rt.add("Rich ", bold=True)
@@ -40,4 +60,4 @@
 }
 
 tpl.render(context)
-tpl.save("output/richtext_paragraph.docx")
+tpl.save("output/richtext_paragraph.docx")