Skip to main content

A python library and command-line tool to “prettify” and colorize XML. It also provides a unittest.TestCase mixin that adds the assertXmlEqual method and, on difference, shows a “pretty” diff.

Installation

$ pip install pxml

On the Command-Line

$ echo '<root><node attr="value">foo</node></root>' | pxml
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <node attr="value">foo</node>
</root>

And add some color:

pxml with color

As a Python Module

import pxml, six

src = six.StringIO('<root><node attr="value">foo</node></root>')
out = six.StringIO()

pxml.prettify(src, out)

assert(out.getvalue() == '''\
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <node attr="value">foo</node>
</root>
''')

Unit Testing

The pxml.XmlTestMixin class adds the assertXmlEqual method to the subclass which allows easy semantic comparison that two XML structures are equivalent. It does so by ignoring ignorable whitespace, attribute order, quote types, and other differences that are byte-level differences when serialized, but don’t actually represent semantic differences. When differences are detected, displays the XML differences in “prettified” XML for easier comparison.

import unittest, pxml

class MyTestCase(unittest.TestCase, pxml.XmlTestMixin):

  def test_equivalent_xml(self):
    src = '<root  ><node a="1" b="0"/></root>'
    chk = '<root><node   b="0" a="1"  /></root  >'
    self.assertXmlEqual(src, chk)

  def test_different_xml(self):
    src = '<root  ><node a="1" b="0"/></root>'
    chk = '<root><node   b="1" a="0"  /></root  >'
    self.assertXmlEqual(src, chk)

    # this fails the test and produces the following error message:
    #   AssertionError: [truncated]... != [truncated]...
    #     <?xml version="1.0" encoding="UTF-8"?>
    #     <root>
    #   -   <node a="1" b="0"/>
    #   +   <node a="0" b="1"/>
    #     </root>

Metadata

Release files for pxml 0.2.13

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pxml 0.2.13
File Size Uploaded Provenance
pxml-0.2.13.tar.gz 21.3 kB Without provenance Details

Release files / pxml-0.2.13.tar.gz

Download URL pxml-0.2.13.tar.gz
Size 21.3 kB
Tags Source
SHA-256 checksum
How to use checksums
e4752816e3353e8456b83a22c9c29bfef55e088ddc94722a4ece4766b6fb3f31
BLAKE2b-256 checksum
How to use checksums
d0b7fbb739a8c43089289250b77125eaf858d8bdb085b234a26de987bee30931
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for pxml 0.2.13

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page