XML Structure and Syntax

Readable XML in Python

XML data is structured across multiple lines, but representing that structure with an ordinary Python string can make the code difficult to read because line breaks must be written with escape sequences such as \n. Triple-quoted strings provide a more readable alternative: you can write the multi-line XML layout directly in your Python code.

The Delimiter Choice

Python supports two equivalent forms for creating a multi-line string. Triple single quotes use three single-quote characters, and triple double quotes use three double-quote characters. Both forms create multi-line strings and serve the same purpose. The choice is mainly a matter of style and convenience.

xml_single = '''
<catalog>
  <item>Book</item>
</catalog>
'''

xml_double = """
<catalog>
  <item>Book</item>
</catalog>
"""

In both generated examples, the XML-shaped text is stored as a multi-line Python string. Changing the delimiter from triple single quotes to triple double quotes does not change the basic purpose of the string. The important content is the text enclosed by the delimiters, including its line breaks and spaces.

From Source Layout to String Value

Triple-quoted strings have a direct relationship between how the code looks and what the string contains. Pressing Enter inside the triple-quoted region places a line break in the string value. Adding spaces before text places those spaces in the string value as well. Indentation is therefore not merely visual formatting when it appears between the opening and closing triple quotes.

XML Representation Uses

Triple-quoted strings are especially useful when XML must be stored or represented as text in Python. The XML can remain visibly multi-line and indented in the code instead of being compressed into one line or written with explicit line-break escape sequences. This makes the XML structure easier to see and helps avoid missing or incorrect escape sequences.

• Representing XML data for testing
• Embedding configuration data
• Preparing payloads to send across the web

configuration_xml = """
<configuration>
  <setting>enabled</setting>
</configuration>
"""

The generated example keeps the XML-shaped structure visible in the Python source. The line arrangement and indentation inside the delimiters are part of the resulting string value, which is the main reason this representation is convenient for multi-line XML data.

Mistakes with Triple Quotes

• Assuming indentation inside the delimiters is ignored

  Spaces inside the opening and closing triple quotes become part of the string value.

  Fix: Place indentation deliberately, because it is preserved in the multi-line string.

• Assuming line breaks are only visual

  The line break becomes a line break in the string value.

  Fix: Review the layout inside the delimiters as part of the actual text you are creating.

• Thinking triple single quotes and triple double quotes have different multi-line behavior

  Both delimiter styles create multi-line strings and serve the same purpose.

  Fix: Choose between them according to style and convenience.

• Using ordinary quoted strings without considering readability

  The XML structure can become difficult to read and less visible in the code.

  Fix: Use a triple-quoted string when preserving a readable multi-line XML layout is useful.

Practice the Mapping

Essential Takeaways

1. Triple single quotes and triple double quotes both create multi-line Python strings.
2. The choice between the two delimiter styles is a matter of style and convenience.
3. Line breaks, indentation, and spaces inside the delimiters become part of the string value.
4. Triple-quoted strings make multi-line XML data easier to read because the XML structure can be written directly in the code.
5. Use triple-quoted strings when representing XML for purposes such as testing, embedding configuration data, or preparing web payloads.