PythonでXMLをきれいに印刷する

PythonでXMLをきれいに印刷するための最良の方法（またはさまざまな方法）は何ですか？

import xml.dom.minidom

dom = xml.dom.minidom.parse(xml_fname) # or xml.dom.minidom.parseString(xml_string)
pretty_xml_as_string = dom.toprettyxml()

lxmlは最近更新され、かなりの印刷機能が含まれています

import lxml.etree as etree

x = etree.parse("filename")
print etree.tostring(x, pretty_print=True)

lxmlチュートリアルを確認してください：http ://lxml.de/tutorial.html

別の解決策は、このindent関数を借用して、2.5以降にPythonに組み込まれているElementTreeライブラリで使用することです。これは次のようになります。

from xml.etree import ElementTree

def indent(elem, level=0):
    i = "\n" + level*"  "
    j = "\n" + (level-1)*"  "
    if len(elem):
        if not elem.text or not elem.text.strip():
            elem.text = i + "  "
        if not elem.tail or not elem.tail.strip():
            elem.tail = i
        for subelem in elem:
            indent(subelem, level+1)
        if not elem.tail or not elem.tail.strip():
            elem.tail = j
    else:
        if level and (not elem.tail or not elem.tail.strip()):
            elem.tail = j
    return elem        

root = ElementTree.parse('/tmp/xmlfile').getroot()
indent(root)
ElementTree.dump(root)

これが、醜いテキストノードの問題を回避するための（ハッキー？）解決策です。

uglyXml = doc.toprettyxml(indent='  ')

text_re = re.compile('>\n\s+([^<>\s].*?)\n\s+</', re.DOTALL)    
prettyXml = text_re.sub('>\g<1></', uglyXml)

print prettyXml

上記のコードは以下を生成します：

<?xml version="1.0" ?>
<issues>
  <issue>
    <id>1</id>
    <title>Add Visual Studio 2005 and 2008 solution files</title>
    <details>We need Visual Studio 2005/2008 project files for Windows.</details>
  </issue>
</issues>

これの代わりに：

<?xml version="1.0" ?>
<issues>
  <issue>
    <id>
      1
    </id>
    <title>
      Add Visual Studio 2005 and 2008 solution files
    </title>
    <details>
      We need Visual Studio 2005/2008 project files for Windows.
    </details>
  </issue>
</issues>

免責事項：おそらくいくつかの制限があります。

他の人が指摘したように、lxmlにはかなりのプリンターが組み込まれています。

ただし、デフォルトではCDATAセクションが通常のテキストに変更されるため、厄介な結果になる可能性があることに注意してください。

入力ファイルを保持し、インデントのみを変更するPython関数を次に示します（に注意してくださいstrip_cdata=False）。さらに、デフォルトのASCIIではなく、エンコーディングとしてUTF-8が使用されることを確認します（に注意してくださいencoding='utf-8'）。

from lxml import etree

def prettyPrintXml(xmlFilePathToPrettyPrint):
    assert xmlFilePathToPrettyPrint is not None
    parser = etree.XMLParser(resolve_entities=False, strip_cdata=False)
    document = etree.parse(xmlFilePathToPrettyPrint, parser)
    document.write(xmlFilePathToPrettyPrint, pretty_print=True, encoding='utf-8')

使用例：

prettyPrintXml('some_folder/some_file.xml')

BeautifulSoupには使いやすいprettify()メソッドがあります。

インデントレベルごとに1つのスペースをインデントします。lxmlのpretty_printよりも優れており、短くて甘いです。

from bs4 import BeautifulSoup

bs = BeautifulSoup(open(xml_file), 'xml')
print bs.prettify()

持っているxmllint場合は、サブプロセスを生成して使用できます。xmllint --format <file>入力XMLを標準出力にプリティプリントします。

このメソッドはpythonの外部プログラムを使用しているため、一種のハックになっていることに注意してください。

def pretty_print_xml(xml):
    proc = subprocess.Popen(
        ['xmllint', '--format', '/dev/stdin'],
        stdin=subprocess.PIPE,
        stdout=subprocess.PIPE,
    )
    (output, error_output) = proc.communicate(xml);
    return output

print(pretty_print_xml(data))

上記の「ade」の回答を編集しようとしましたが、最初に匿名でフィードバックを提供した後、Stack Overflowで編集できませんでした。これは、ElementTreeをきれいに出力する関数のバグの少ないバージョンです。

def indent(elem, level=0, more_sibs=False):
    i = "\n"
    if level:
        i += (level-1) * '  '
    num_kids = len(elem)
    if num_kids:
        if not elem.text or not elem.text.strip():
            elem.text = i + "  "
            if level:
                elem.text += '  '
        count = 0
        for kid in elem:
            indent(kid, level+1, count < num_kids - 1)
            count += 1
        if not elem.tail or not elem.tail.strip():
            elem.tail = i
            if more_sibs:
                elem.tail += '  '
    else:
        if level and (not elem.tail or not elem.tail.strip()):
            elem.tail = i
            if more_sibs:
                elem.tail += '  '

DOM実装を使用している場合、それぞれに独自の形式のプリティプリントが組み込まれています。

# minidom
#
document.toprettyxml()

# 4DOM
#
xml.dom.ext.PrettyPrint(document, stream)

# pxdom (or other DOM Level 3 LS-compliant imp)
#
serializer.domConfig.setParameter('format-pretty-print', True)
serializer.writeToString(document)

独自のプリティプリンターなしで何か他のものを使用している場合、またはそれらのプリティプリンターが望みどおりに機能しない場合は、おそらく独自のシリアライザーを作成またはサブクラス化する必要があります。

minidomのきれいなプリントに問題がありました。たとえば、ドキュメントにβが含まれている場合に、指定されたエンコーディング以外の文字でドキュメントをプリティプリントしようとすると、UnicodeErrorが発生しdoc.toprettyxml(encoding='latin-1')ます。これに対する私の回避策は次のとおりです。

def toprettyxml(doc, encoding):
    """Return a pretty-printed XML document in a given encoding."""
    unistr = doc.toprettyxml().replace(u'<?xml version="1.0" ?>',
                          u'<?xml version="1.0" encoding="%s"?>' % encoding)
    return unistr.encode(encoding, 'xmlcharrefreplace')

from yattag import indent

pretty_string = indent(ugly_string)

次のように要求しない限り、テキストノード内にスペースや改行は追加されません。

indent(mystring, indent_text = True)

インデント単位と改行の外観を指定できます。

pretty_xml_string = indent(
    ugly_xml_string,
    indentation = '    ',
    newline = '\r\n'
)

ドキュメントはhttp://www.yattag.orgホームページにあります。

私は、既存のElementTreeをウォークスルーし、text / tailを使用して、通常どおりにインデントするソリューションを作成しました。

def prettify(element, indent='  '):
    queue = [(0, element)]  # (level, element)
    while queue:
        level, element = queue.pop(0)
        children = [(level + 1, child) for child in list(element)]
        if children:
            element.text = '\n' + indent * (level+1)  # for child open
        if queue:
            element.tail = '\n' + indent * queue[0][0]  # for sibling open
        else:
            element.tail = '\n' + indent * (level-1)  # for parent close
        queue[0:0] = children  # prepend so children come before siblings

PythonのXMLのプリティプリントは、このタスクにかなり適しています。（適切な名前も付けられています。）

別の方法は、PrettyPrint 関数を持つpyXMLを使用することです。

あなたは人気のある外部のライブラリを使用することができますxmltodictをして、unparseそしてpretty=True、あなたは最良の結果を得るでしょう。

xmltodict.unparse(
    xmltodict.parse(my_xml), full_document=False, pretty=True)

full_document=False上で反対<?xml version="1.0" encoding="UTF-8"?>。

ここに、醜い改行の問題（トンの空白）を取り除くPython3ソリューションがあり、他のほとんどの実装とは異なり、標準ライブラリのみを使用しています。

import xml.etree.ElementTree as ET
import xml.dom.minidom
import os

def pretty_print_xml_given_root(root, output_xml):
    """
    Useful for when you are editing xml data on the fly
    """
    xml_string = xml.dom.minidom.parseString(ET.tostring(root)).toprettyxml()
    xml_string = os.linesep.join([s for s in xml_string.splitlines() if s.strip()]) # remove the weird newline issue
    with open(output_xml, "w") as file_out:
        file_out.write(xml_string)

def pretty_print_xml_given_file(input_xml, output_xml):
    """
    Useful for when you want to reformat an already existing xml file
    """
    tree = ET.parse(input_xml)
    root = tree.getroot()
    pretty_print_xml_given_root(root, output_xml)

ここで、一般的な改行の問題を修正する方法を見つけました。

vkbeautifyモジュールを見てください。

これは、私の非常に人気のある同じ名前のjavascript / nodejsプラグインのpythonバージョンです。XML、JSON、CSSテキストをきれいに印刷/縮小できます。入力と出力は、任意の組み合わせの文字列/ファイルにすることができます。非常にコンパクトで依存関係はありません。

例：

import vkbeautify as vkb

vkb.xml(text)                       
vkb.xml(text, 'path/to/dest/file')  
vkb.xml('path/to/src/file')        
vkb.xml('path/to/src/file', 'path/to/dest/file') 

再解析する必要がない場合の代替手段として、関数を含むxmlpp.pyライブラリがありget_pprint()ます。これは、lxml ElementTreeオブジェクトに再解析する必要がなく、私のユースケースで問題なくスムーズに機能しました。

このバリエーションを試すことができます...

インストールBeautifulSoupとバックエンドlxml（パーサー）ライブラリ：

user$ pip3 install lxml bs4

XMLドキュメントを処理します。

from bs4 import BeautifulSoup

with open('/path/to/file.xml', 'r') as doc: 
    for line in doc: 
        print(BeautifulSoup(line, 'lxml-xml').prettify())  

私はこの問題を抱えており、次のように解決しました：

def write_xml_file (self, file, xml_root_element, xml_declaration=False, pretty_print=False, encoding='unicode', indent='\t'):
    pretty_printed_xml = etree.tostring(xml_root_element, xml_declaration=xml_declaration, pretty_print=pretty_print, encoding=encoding)
    if pretty_print: pretty_printed_xml = pretty_printed_xml.replace('  ', indent)
    file.write(pretty_printed_xml)

私のコードでは、このメソッドは次のように呼び出されます：

try:
    with open(file_path, 'w') as file:
        file.write('<?xml version="1.0" encoding="utf-8" ?>')

        # create some xml content using etree ...

        xml_parser = XMLParser()
        xml_parser.write_xml_file(file, xml_root, xml_declaration=False, pretty_print=True, encoding='unicode', indent='\t')

except IOError:
    print("Error while writing in log file!")

これが機能するのは、デフォルトでetree two spacesがインデントに使用しているためです。標準のetreeインデントを変更するために、etreeの設定や関数のパラメーターを指定することはできませんでした。私はetreeを使うのがいかに簡単か好きですが、これは本当に私を困らせました。

XMLドキュメント全体をきれいなXMLドキュメントに変換する
場合（例：LibreOffice Writerの.odtファイルまたは.odsファイルを抽出[解凍]し、醜い "content.xml"ファイルをきれいなXMLファイルに変換したい場合自動gitバージョン管理とgit difftool.odt / .odsファイルのing（ここで実装しているような）

import xml.dom.minidom

file = open("./content.xml", 'r')
xml_string = file.read()
file.close()

parsed_xml = xml.dom.minidom.parseString(xml_string)
pretty_xml_as_string = parsed_xml.toprettyxml()

file = open("./content_new.xml", 'w')
file.write(pretty_xml_as_string)
file.close()

参考資料：
- このページでのベンノーランドの回答に感謝します。

from lxml import etree
import xml.dom.minidom as mmd

xml_root = etree.parse(xml_fiel_path, etree.XMLParser())

def print_xml(xml_root):
    plain_xml = etree.tostring(xml_root).decode('utf-8')
    urgly_xml = ''.join(plain_xml .split())
    good_xml = mmd.parseString(urgly_xml)
    print(good_xml.toprettyxml(indent='    ',))

中国語のxmlでうまく機能しています。

なんらかの理由で他のユーザーが言及したPythonモジュールのいずれかを手に入れることができない場合は、Python 2.7用の次の解決策をお勧めします。

import subprocess

def makePretty(filepath):
  cmd = "xmllint --format " + filepath
  prettyXML = subprocess.check_output(cmd, shell = True)
  with open(filepath, "w") as outfile:
    outfile.write(prettyXML)

私の知る限り、このソリューションは、xmllintパッケージがインストールされているUnixベースのシステムで機能します。

私はこれをいくつかのコード行で解決し、ファイルを開き、トラフを行い、インデントを追加して、もう一度保存しました。私は小さなxmlファイルで作業していて、依存関係やユーザーのためにインストールするライブラリを追加したくありませんでした。とにかく、これが私が終わったものです：

    f = open(file_name,'r')
    xml = f.read()
    f.close()

    #Removing old indendations
    raw_xml = ''        
    for line in xml:
        raw_xml += line

    xml = raw_xml

    new_xml = ''
    indent = '    '
    deepness = 0

    for i in range((len(xml))):

        new_xml += xml[i]   
        if(i<len(xml)-3):

            simpleSplit = xml[i:(i+2)] == '><'
            advancSplit = xml[i:(i+3)] == '></'        
            end = xml[i:(i+2)] == '/>'    
            start = xml[i] == '<'

            if(advancSplit):
                deepness += -1
                new_xml += '\n' + indent*deepness
                simpleSplit = False
                deepness += -1
            if(simpleSplit):
                new_xml += '\n' + indent*deepness
            if(start):
                deepness += 1
            if(end):
                deepness += -1

    f = open(file_name,'w')
    f.write(new_xml)
    f.close()

それは私にとってはうまくいきます、おそらく誰かがそれをいくつか使うでしょう:)