When working with Python and the python-docx library, you may come across the need to add image captions to your documents. In this article, we will explore three different ways to achieve this task.

Option 1: Using Inline Shapes

The first option involves using the inline shapes feature provided by the python-docx library. This allows us to add captions directly to the images in our document.

from docx import Document
from docx.shared import Pt

# Load the document
doc = Document('document.docx')

# Get the first image in the document
image = doc.inline_shapes[0]

# Add a caption to the image
caption = 'This is the caption for the image'
image.text = caption

# Set the caption font size
caption_font = image.text_frame.paragraphs[0].runs[0].font
caption_font.size = Pt(10)

# Save the modified document
doc.save('document_with_caption.docx')

This code snippet demonstrates how to add a caption to the first image in a document. You can modify it to suit your specific requirements, such as adding captions to multiple images or customizing the caption font.

Option 2: Using Text Boxes

If you prefer a more flexible approach, you can use text boxes to add captions to your images. This allows you to position the captions anywhere on the document and style them as desired.

from docx import Document
from docx.shared import Pt
from docx.enum.text import WD_PARAGRAPH_ALIGNMENT

# Load the document
doc = Document('document.docx')

# Get the first image in the document
image = doc.inline_shapes[0]

# Add a text box
text_box = doc.add_textbox()

# Set the text box position
text_box.left = image.left
text_box.top = image.top + image.height

# Add a paragraph to the text box
paragraph = text_box.text_frame.add_paragraph()

# Add the caption to the paragraph
caption = 'This is the caption for the image'
paragraph.text = caption

# Set the caption font size
caption_font = paragraph.runs[0].font
caption_font.size = Pt(10)

# Set the caption alignment
paragraph.alignment = WD_PARAGRAPH_ALIGNMENT.CENTER

# Save the modified document
doc.save('document_with_caption.docx')

This code snippet demonstrates how to add a caption to the first image in a document using a text box. You can customize the position, alignment, and styling of the caption to suit your needs.

Option 3: Using Tables

Another option is to use tables to add captions to your images. This provides a structured way to organize your captions and allows for easy customization.

from docx import Document
from docx.shared import Pt

# Load the document
doc = Document('document.docx')

# Get the first image in the document
image = doc.inline_shapes[0]

# Add a table with one row and one column
table = doc.add_table(rows=1, cols=1)

# Set the table position
table.left = image.left
table.top = image.top + image.height

# Add a caption to the table cell
caption = 'This is the caption for the image'
cell = table.cell(0, 0)
cell.text = caption

# Set the caption font size
caption_font = cell.paragraphs[0].runs[0].font
caption_font.size = Pt(10)

# Save the modified document
doc.save('document_with_caption.docx')

This code snippet demonstrates how to add a caption to the first image in a document using a table. You can customize the table position, number of rows and columns, and the styling of the caption to fit your requirements.

After exploring these three options, it is clear that the best approach depends on your specific needs and preferences. If you require a simple and straightforward solution, Option 1 using inline shapes may be the most suitable. However, if you need more flexibility and control over the caption’s position and styling, Options 2 and 3 using text boxes or tables respectively would be better choices. Consider your document’s structure and design requirements to determine the most appropriate solution for your use case.