there have tow docx files,named A.docx and B.docx,and now,I want to add A.docx to the B.docx,not the content of the A.docx, it just like a link,a attachemnt inside in B.docx,but question is how can i do it? please help me, thanks!!

I installed docxtpl on a clean machine today. I ran some code that used to work but couldn't generate any document.

The exact same exception is raised when running the basic usage code from the documentation.

from docxtpl import DocxTemplate

doc = DocxTemplate("my_word_template.docx")
context = { 'company_name' : "World company" }
doc.render(context)
doc.save("generated_doc.docx")

Using Python 3.7.1

Traceback:

---------------------------------------------------------------------------
ValueError                                Traceback (most recent call last)
<ipython-input-4-70cd50864075> in <module>
----> 1 doc.render(context)
      2 doc.save("generated_doc_.docx")

/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/docxtpl/__init__.py in render(self, context, jinja_env, autoescape)
    297         headers = self.build_headers_footers_xml(context, self.HEADER_URI,
    298                                                  jinja_env)
--> 299         for relKey, xml in headers:
    300             self.map_headers_footers_xml(relKey, xml)
    301 

/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/docxtpl/__init__.py in build_headers_footers_xml(self, context, uri, jinja_env)
    245 
    246     def build_headers_footers_xml(self,context, uri,jinja_env=None):
--> 247         for relKey, xml in self.get_headers_footers_xml(uri):
    248             encoding = self.get_headers_footers_encoding(xml)
    249             xml = self.patch_xml(xml)

/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/docxtpl/__init__.py in get_headers_footers_xml(self, uri)
    236         for relKey, val in self.docx._part._rels.items():
    237             if val.reltype == uri:
--> 238                 yield relKey, self.xml_to_string(parse_xml(val._target._blob))
    239 
    240     def get_headers_footers_encoding(self,xml):

/Library/Frameworks/Python.framework/Versions/3.7/lib/python3.7/site-packages/docx/opc/oxml.py in parse_xml(text)
     35     ``etree.fromstring()`` replacement that uses oxml parser
     36     """
---> 37     return etree.fromstring(text, oxml_parser)
     38 
     39 

src/lxml/etree.pyx in lxml.etree.fromstring()

src/lxml/parser.pxi in lxml.etree._parseMemoryDocument()

ValueError: can only parse strings

I tried to investigate, maybe it's related to this URI being unreachable, but I'm not sure at all https://github.com/elapouya/python-docx-template/blob/2fad92046e580b6e9a212647f274d5efaae82648/docxtpl/init.py#L41

Hi, just wanted to say that your lib is fantastic, but i appear to be having an issue. It appears that if the style contains a space or certain characters, the style isnt applied in the output file. I was just wondering if there was a work around for this? Many Thanks. Example below: rt.add(tag.text , style='Subtle Reference')

Hi,

I am having a problem where while this works inside a template file:

{{ '\t\t\t\t\t\t\t\t\t\t' }} Test

This doesn't:

{{ 10*'\t' }} Test

I get only just Test, with no space from the left margin at all.

Does anyone know why? Thanks!

Template fragment:

已知输入功率{{\ \mathrm{who\ }}}3=3.16kw，小齿轮转速310r/min，

Word automatically recognizes braces as its built-in properties, and cannot place braces correctly

code snippet

from docxtpl import DocxTemplate
import os

class Documentcreater:
    def __init__(self,tem_name="test.docx"):
        self.father_path = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
        self.file_name = tem_name
        self.temp = DocxTemplate(self.father_path + f"\\temp\\{self.file_name}")
    def reader(self,context={'who': '默认'}):
        self.temp.render(context)
    def output(self,file_name=""):
        if file_name=="":
            file_name=f"output_{self.file_name}"
        self.temp.save(self.father_path + f"\\output\\doc\\{file_name}")


if (__name__ == "__main__"):
    Doc=Documentcreater("圆柱斜齿轮设计.docx")
    context = {
        'who': 'test'
    }
    Doc.reader(context)
    Doc.output()

An error occurred

Traceback (most recent call last):
  File "F:/CurriculumDesign/doc/Document.py", line 22, in <module>
    Doc.reader(context)
  File "F:/CurriculumDesign/doc/Document.py", line 10, in reader
    self.temp.render(context)
  File "F:\CurriculumDesign\venv\lib\site-packages\docxtpl\__init__.py", line 310, in render
    xml_src = self.build_xml(context, jinja_env)
  File "F:\CurriculumDesign\venv\lib\site-packages\docxtpl\__init__.py", line 269, in build_xml
    xml = self.render_xml(xml, context, jinja_env)
  File "F:\CurriculumDesign\venv\lib\site-packages\docxtpl\__init__.py", line 224, in render_xml
    raise exc
  File "F:\CurriculumDesign\venv\lib\site-packages\docxtpl\__init__.py", line 217, in render_xml
    template = Template(src_xml)
  File "F:\CurriculumDesign\venv\lib\site-packages\jinja2\environment.py", line 1031, in __new__
    return env.from_string(source, template_class=cls)
  File "F:\CurriculumDesign\venv\lib\site-packages\jinja2\environment.py", line 941, in from_string
    return cls.from_code(self, self.compile(source), globals, None)
  File "F:\CurriculumDesign\venv\lib\site-packages\jinja2\environment.py", line 638, in compile
    self.handle_exception(source=source_hint)
  File "F:\CurriculumDesign\venv\lib\site-packages\jinja2\environment.py", line 832, in handle_exception
    reraise(*rewrite_traceback_stack(source=source))
  File "F:\CurriculumDesign\venv\lib\site-packages\jinja2\_compat.py", line 28, in reraise
    raise value.with_traceback(tb)
  File "<unknown>", line 1, in template
jinja2.exceptions.TemplateSyntaxError: unexpected '<'

Hi,

Is it possible to use base64 encoded images with InlineImage?

I have tried this kind of implementation (and many others) but It raises me a UnrecognizedImageError exception:

img = io.StringIO(base64_str_image)
image = InlineImage(doc, img)

Thanks a lot! :)

When i try to use a custom filter with a string argument like this {{ myvalue|myfilter('myargument') }} i get an error

jinja2.exceptions.TemplateSyntaxError:unexpected char '''.

Please help with an example of custom filter which shows how to pass a string argument. Integer arguments are passed without issues.

I have later discovered while going through other reported issues, that this is due to the fact that the straight quotes ' are automatically converted to curly quotes ‘ which are not identified by jinja as valid character. While pasting the quote from another editor like atom works but this does not look like a good solution. One has to modify the autoreplace default setting of word which automatically changes straight quotes to curly quotes.

Has any body tried the patch_xml() fix as reported in this thread https://github.com/elapouya/python-docx-template/issues/85

Pasting the code at line 47 does not help me.

Loop iterating over list of dicts, insert only first one item, and breaks the generation (part after loop not inserted)

Using russian, if it's matter

Using this template: template.docx, i got this: report3.docx

Hello all,

I've got defined this table in my template that inserts two signatures:

(First row if inserting signature images with InlineImage).

When rendering this template, final word opens correctly.

Now, depending on a code condition, I need to insert an extra column to have three signatures. So I try:

If I render the template with the three columns (this one with empty values), I can also open the final word correctly.

But when I render the template with the three columns properly filled, I get:

I tried to delete de table and just define the variables normally. I tried to insert three independent tables. I tried to define each signature in different lines. But nothing.

I also tried to use always the same image (just to check that the new one was corrupted or not). But the same image works fine for two columns and bad when generating three). But nothing.

Images are same-sized and same-formatted (png).

Could you help me?? I am going crazy.

Thank you all in advance!

I used docxtpl v0.6.3 in order to generate 3 docx based on 3 templates. One template contains headers and footers

Since the update to v0.8.0 (where you use python-docx (0.8.10)), generating that third template gives the following error:

File "C:\Users\xxx\Desktop\xxx.py", line 476, in <module>
    doc.render(context)
  File "C:\Program Files\Python37\lib\site-packages\docxtpl\__init__.py", line 294, in render
    self.map_headers_footers_xml(relKey, xml)
  File "C:\Program Files\Python37\lib\site-packages\docxtpl\__init__.py", line 266, in map_headers_footers_xml
    new_part.load_rel(rel.reltype, rel.target_part, rel.rId, rel.is_external)
  File "C:\Program Files\Python37\lib\site-packages\docx\opc\rel.py", line 161, in target_part
    raise ValueError("target_part property on _Relationship is undef"
ValueError: target_part property on _Relationship is undefined when target mode is External

Can this be solved here, or is it a python-docx issue ?

In some cases a single or even double space is lost before a cross reference to a table. In the template document it is there, in the exported document it is gone.

Describe the bug

I have a template that is supposed to render an inline image and a sub template containing an image but it fails (rendering only with a sub template or an inline image works great, rendering an inline image and a sub template NOT containing an image is also working)

To Reproduce

template1.docx template2.docx

from docxtpl import DocxTemplate, InlineImage

doc = DocxTemplate("template2.docx")
subdoc = doc.new_subdoc('template1.docx')
photo = InlineImage(doc, image_descriptor='index.jpeg')
doc.render({"template": subdoc, "photo": photo}, autoescape=True)

Current behavior

The following error happens

Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "xxx/site-packages/docxtpl/template.py", line 343, in render
    xml_src = self.build_xml(context, jinja_env)
  File "xxx/site-packages/docxtpl/template.py", line 290, in build_xml
    xml = self.render_xml_part(xml, self.docx._part, context, jinja_env)
  File "xxx/site-packages/docxtpl/template.py", line 239, in render_xml_part
    dst_xml = template.render(context)
  File "xxx/site-packages/jinja2/environment.py", line 1301, in render
    self.environment.handle_exception()
  File "/xxx/site-packages/jinja2/environment.py", line 936, in handle_exception
    raise rewrite_traceback_stack(source=source)
  File "<template>", line 4, in top-level template code
  File "xxx/site-packages/docxtpl/inline_image.py", line 39, in __html__
    return self._insert_image()
  File "xxx/site-packages/docxtpl/inline_image.py", line 24, in _insert_image
    pic = self.tpl.current_rendering_part.new_pic_inline(
  File "xxx/site-packages/docx/parts/story.py", line 57, in new_pic_inline
    cx, cy = image.scaled_dimensions(width, height)
AttributeError: 'ImageWrapper' object has no attribute 'scaled_dimensions'

Expected behavior

Template is rendered

I'm trying to iterate through an excel file, populate a docxtemplate from each row and save the docs. The excel file and the template are in Bulgarian language. I don't believe that's causing the error but I'm new to python, so I appreciate any help.

Reading the excel file is fine. I can display the results.

Below is my code and the error I get:

import pandas as pd import jinja2 from docxtpl import DocxTemplate

word_template_path = r"C:\Users\mdjat\Documents\ZdrDosieta\ZDRPrilojenieTemplate.docx" excel_path = r"C:\Users\mdjat\Documents\ZdrDosieta\ВИА ЛОГИСТИК_информация за ЗД_за тест.xlsm" doc = DocxTemplate (word_template_path) df = pd.read_excel (excel_path,sheet_name="Sheet1")

for index, row in df.iterrows (): context = {'Трите имена': row['Трите имена'], 'ЕГН': row['ЕГН'], 'Постоянен адрес': row['Постоянен адрес'], 'Населено място': row['Населено място'], 'Лекар': row['Лекар'], 'Длъжност': row['Длъжност'], 'Стаж': row['Стаж']} doc.render (context) output_path = r"C:\Users\mdjat\Documents\ZdrDosieta{row['Трите имена']}.docx" doc.save (output_path)

Traceback (most recent call last): File "c:\Users\mdjat\Documents\ZdrDosieta\zdr dosie python code.py", line 26, in doc.render (context) File "C:\Users\mdjat\anaconda3\envs\Streamlit\lib\site-packages\docxtpl\template.py", line 343, in render xml_src = self.build_xml(context, jinja_env) File "C:\Users\mdjat\anaconda3\envs\Streamlit\lib\site-packages\docxtpl\template.py", line 290, in build_xml xml = self.render_xml_part(xml, self.docx._part, context, jinja_env) File "C:\Users\mdjat\anaconda3\envs\Streamlit\lib\site-packages\docxtpl\template.py", line 245, in render_xml_part raise exc File "C:\Users\mdjat\anaconda3\envs\Streamlit\lib\site-packages\docxtpl\template.py", line 238, in render_xml_part template = Template(src_xml) File "C:\Users\mdjat\anaconda3\envs\Streamlit\lib\site-packages\jinja2\environment.py", line 1208, in new return env.from_string(source, template_class=cls) File "C:\Users\mdjat\anaconda3\envs\Streamlit\lib\site-packages\jinja2\environment.py", line 1105, in from_string return cls.from_code(self, self.compile(source), gs, None) File "C:\Users\mdjat\anaconda3\envs\Streamlit\lib\site-packages\jinja2\environment.py", line 768, in compile self.handle_exception(source=source_hint) File "C:\Users\mdjat\anaconda3\envs\Streamlit\lib\site-packages\jinja2\environment.py", line 936, in handle_exception raise rewrite_traceback_stack(source=source) File "", line 8, in template jinja2.exceptions.TemplateSyntaxError: expected token 'end of print statement', got 'имена'

I've read posts with similar errors but still don't get how to fix it.

Any help or direction would be greatly appreciated.

Describe the bug

docxtpl generates broken docx if some core_properties was changed before save. If open in Microsoft Office Word 2010-2019 - error occures. it is not error in python-docx - with it works and generates normal documents.

it works fine with docxtpl version 0.11.5, but in 0.12.0 and newer generated document is broken.

To Reproduce

installing python-docx and creating empty test document

python -m pip install python-docx

from docx import Document
doc = Document()
doc.core_properties.keywords = "keywords; works; fine"
doc.save("empty.docx")

empty.docx is opened fine and without fails or errors in Microsoft Office Word.

success

Installing properly working docxtpl 0.11.5

python -m pip install docxtpl==0.11.5

from docxtpl import DocxTemplate
tpl = DocxTemplate("empty.docx")
tpl.render({})
tpl.docx.core_properties.keywords = "keywords; still; works"
tpl.save("success.docx")

error

Bug occures in docxtpl from 0.12 to 0.16.4 and current development.

python -m pip install docxtpl

from docxtpl import DocxTemplate
tpl = DocxTemplate("empty.docx")
tpl.render({})
tpl.docx.core_properties.keywords = "keywords; still; works"
tpl.save("error.docx")

Problem occured if open in Microsoft Office Word 2010-2019. When open error.docx in Microsoft Office Word you see error message. When i try to show extra properties tab in file properties I don't see keywords were set. In libreoffice error.docx is opened without fails. Exiftools shows properly set keywords.

i compared empty.docx, success.docx and error.docx. they difference only in docProps/core.xml file.

Here i attach difference with beautified xml

1. empty.docx

<cp:coreProperties
	xmlns:cp="http://schemas.openxmlformats.org/package/2006/metadata/core-properties"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:dcterms="http://purl.org/dc/terms/"
	xmlns:dcmitype="http://purl.org/dc/dcmitype/"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<dc:title/>
	<dc:subject/>
	<dc:creator>python-docx</dc:creator>
	<cp:keywords>success; fine</cp:keywords>
	<dc:description>generated by python-docx</dc:description>
	<cp:lastModifiedBy/>
	<cp:revision>1</cp:revision>
	<dcterms:created xsi:type="dcterms:W3CDTF">2013-12-23T23:15:00Z</dcterms:created>
	<dcterms:modified xsi:type="dcterms:W3CDTF">2013-12-23T23:15:00Z</dcterms:modified>
	<cp:category/>
</cp:coreProperties>

2. success.docx

<cp:coreProperties
	xmlns:cp="http://schemas.openxmlformats.org/package/2006/metadata/core-properties"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:dcterms="http://purl.org/dc/terms/"
	xmlns:dcmitype="http://purl.org/dc/dcmitype/"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<dc:title/>
	<dc:subject/>
	<dc:creator>python-docx</dc:creator>
	<cp:keywords>error</cp:keywords>
	<dc:description>generated by python-docx</dc:description>
	<cp:lastModifiedBy/>
	<cp:revision>1</cp:revision>
	<dcterms:created xsi:type="dcterms:W3CDTF">2013-12-23T23:15:00Z</dcterms:created>
	<dcterms:modified xsi:type="dcterms:W3CDTF">2013-12-23T23:15:00Z</dcterms:modified>
	<cp:category/>
</cp:coreProperties>

3. error.docx

<cp:coreProperties
	xmlns:cp="http://schemas.openxmlformats.org/package/2006/metadata/core-properties"
	xmlns:dc="http://purl.org/dc/elements/1.1/"
	xmlns:dcterms="http://purl.org/dc/terms/"
	xmlns:dcmitype="http://purl.org/dc/dcmitype/"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<dc:title/>
	<dc:subject/>
	<dc:creator>python-docx</dc:creator>
	<cp:keywords>success; fine</cp:keywords>
	<dc:description>generated by python-docx</dc:description>
	<cp:lastModifiedBy/>
	<cp:revision>1</cp:revision>
	<dcterms:created xsi:type="dcterms:W3CDTF">2013-12-23T23:15:00Z</dcterms:created>
	<dcterms:modified xsi:type="dcterms:W3CDTF">2013-12-23T23:15:00Z</dcterms:modified>
	<cp:category/>
	<cp:keywords
		xmlns:cp="http://schemas.openxmlformats.org/officeDocument/2006/custom-properties">error
	</cp:keywords>
</cp:coreProperties>

As you can see in error.docx <cp:keywords> dublicated and has additional xmlns:cp="http://schemas.openxmlformats.org/officeDocument/2006/custom-properties

Expected behavior

Script above must create docx document without consistency errors.

Screenshots

Error in Microsoft Office 2010

Additional context

Python 3.10

Describe your problem

When inserting text into a {{ content }} variable with a return to line, this will happen (with the content inserted being Some text that will be weirdly spaced\r\nSome more text) How can I fix this behavior ? This weird spacing probably has a name and is a feature rather then a bug, I jsut don't know what it is and how to disable it...

Is your feature request related to a problem? Please describe.

I would like to use List Bullets or List Numbers with the RichText feature of docxtpl. Setting the style alone does not bring the desired result in the docx. Some changes need to be applied to the paragraph to let it look the right way.

Describe the solution you'd like

I would like to have some RichText features similar to the add URL feature to add List Bullets or List Numbers.

Describe alternatives you've considered

The only workaround is to prepare the docx to have a switch, to display text or List Bullets. If I don't the structure of the text, it's simply not an option.

Additional context

An python-docx example can be found at StackOverflow https://stackoverflow.com/a/51830413