Jolie impression XML en Python

Lorsque vous travaillez avec des données XML en Python, garantir leur lisibilité et leur structure peut grandement améliorer la compréhension et la maintenabilité de votre code. L'impression esthétique du XML, c'est-à-dire son formatage avec une indentation et des sauts de ligne appropriés, est une technique précieuse pour atteindre ces objectifs.

Dans cet article, nous explorerons deux manières différentes d'imprimer joliment du XML à l'aide de Python : xml.dom.minidom et xml.etree.ElementTree. En comprenant ces méthodes, les développeurs peuvent présenter efficacement les données XML de manière organisée et visuellement attrayante, ce qui facilite leur analyse et leur manipulation.

Comment imprimer joliment du XML en Python ?

Voici les deux façons dont nous pouvons effectuer de jolies impressions en Python -

Méthode 1 : utilisez xml.dom.minidom

Voici les étapes que nous allons suivre pour réaliser une jolie impression en utilisant xml.dom.minidom -

• Importez les modules requis : nous importons d'abord le module "xml.dom.minidom", qui fournit une implémentation légère de l'API Document Object Model (DOM) pour l'analyse XML.

• Définissez la fonction `pretty_print_xml_minidom` : Cette fonction accepte une chaîne XML en entrée et est responsable de l'analyse et de l'embellissement du XML pour l'impression à l'aide de `xml.dom.minidom`.

• Analyser la chaîne XML : dans la fonction `pretty_print_xml_minidom`, nous utilisons la méthode `xml.dom.minidom.parseString()` pour analyser la chaîne XML et créer un objet DOM.

• XML joliment imprimé : Ensuite, nous utilisons la méthode « toprettyxml() » sur l'objet DOM pour générer une chaîne XML joliment imprimée. On passe le paramètre "indent" avec la valeur """ pour préciser le niveau d'indentation souhaité (deux espaces dans ce cas).

• Supprimer les lignes vides : par défaut, `toprettyxml()` ajoute des lignes vides à la sortie. Pour supprimer ces lignes vides, nous divisons la jolie chaîne XML avec un caractère de nouvelle ligne (`n`), supprimons tout espace de début ou de fin dans chaque ligne, puis concaténons les lignes non vides ensemble.

• Imprimer du joli XML : Enfin, nous imprimons la jolie chaîne XML générée.

Procédure 2 : Utilisation de xml.etree.ElementTree

Voici les étapes que nous suivrons pour effectuer une jolie impression à l'aide de xml.etree.ElementTree -

• Importez les modules requis : Nous importons d'abord le module `xml.etree.ElementTree`, qui fournit une API rapide et efficace pour analyser et manipuler XML.

• Définition `indent` Fonction : Il s'agit d'une fonction personnalisée utilisée pour ajouter de manière récursive des retraits aux éléments XML. Il accepte un paramètre `elem` (élément XML) et un paramètre facultatif `level` pour spécifier le niveau d'indentation actuel (la valeur par défaut est 0).

• Indent XML : Dans la fonction `indent`, nous ajoutons l'attribut indent > de l'élément XML en modifiant le `text` et `tail`. L'attribut `text` représente le texte immédiatement après la balise d'ouverture, et l'attribut `tail` représente le texte immédiatement avant la balise de fermeture. En ajoutant une indentation à ces propriétés, nous obtenons une jolie impression.

• Définition de la fonction `pretty_print_xml_elementtree` : Cette fonction prend une chaîne XML en entrée et est responsable de l'analyse et de la jolie impression du XML à l'aide de `xml.etree.ElementTree`.

• Analyser la chaîne XML : dans la fonction `pretty_print_xml_elementtree`, nous utilisons la méthode `ET.fromstring()` pour analyser la chaîne XML et créer un objet ElementTree.

• Indent XML : Nous appelons la fonction `indent()` sur l'élément racine du XML pour ajouter une indentation à tous les éléments de manière récursive.

• Convertir les éléments XML en chaîne : nous utilisons la méthode `ET.tostring()` pour reconvertir les éléments XML en représentation sous forme de chaîne. Nous passons le paramètre `encoding` avec la valeur `"unicode"` pour garantir le bon encodage de la chaîne résultante.

• Imprimer du joli XML : Enfin, nous imprimons la jolie chaîne XML générée.

Ces deux programmes proposent différentes manières d'obtenir une jolie impression de XML. Le premier programme utilise l'API DOM fournie par `xml.dom.minidom` pour analyser et imprimer joliment du XML, tandis que le deuxième programme utilise le module `xml.etree.ElementTree` et définit une fonction personnalisée pour ajouter une indentation. aux éléments XML de manière récursive.

Ce qui suit est un exemple de programme utilisant les deux méthodes ci-dessus -

Option 1 : Utilisez xml.dom.minidom

import xml.dom.minidom

def pretty_print_xml_minidom(xml_string):
   # Parse the XML string
   dom = xml.dom.minidom.parseString(xml_string)

   # Pretty print the XML
   pretty_xml = dom.toprettyxml(indent="  ")

   # Remove empty lines
   pretty_xml = "\n".join(line for line in pretty_xml.split("\n") if line.strip())

   # Print the pretty XML
   print(pretty_xml)

# Example usage
xml_string = '''
<root>
  <element attribute="value">
   <subelement>Text</subelement>
  </element>
</root>
'''

pretty_print_xml_minidom(xml_string)

Sortie

<?xml version="1.0" ?>
<root>
  <element attribute="value">
   <subelement>Text</subelement>
  </element>
</root>

Procédure 2 : Utilisation de xml.etree.ElementTree

import xml.etree.ElementTree as ET

def indent(elem, level=0):
   # Add indentation
   indent_size = "  "
   i = "\n" + level * indent_size
   if len(elem):
      if not elem.text or not elem.text.strip():
         elem.text = i + indent_size
      if not elem.tail or not elem.tail.strip():
         elem.tail = i
      for elem in elem:
         indent(elem, level + 1)
      if not elem.tail or not elem.tail.strip():
         elem.tail = i
   else:
      if level and (not elem.tail or not elem.tail.strip()):
         elem.tail = i

def pretty_print_xml_elementtree(xml_string):
   # Parse the XML string
   root = ET.fromstring(xml_string)

   # Indent the XML
   indent(root)

   # Convert the XML element back to a string
   pretty_xml = ET.tostring(root, encoding="unicode")

   # Print the pretty XML
   print(pretty_xml)

# Example usage
xml_string = '''
<root>
  <element attribute="value">
   <subelement>Text</subelement>
  </element>
</root>
'''

pretty_print_xml_elementtree(xml_string)

Sortie

<root>
  <element attribute="value">
   <subelement>Text</subelement>
  </element>
</root>

Conclusion

Pour résumer, la jolie impression de XML en Python est cruciale pour améliorer la lisibilité et la structure de vos données XML. Qu'ils utilisent les bibliothèques xml.dom.minidom ou xml.etree.ElementTree, les développeurs peuvent facilement formater XML avec une indentation appropriée. En employant ces techniques, les programmeurs peuvent améliorer la compréhension du code, simplifier le débogage et promouvoir une meilleure collaboration lorsqu'ils travaillent avec des données XML dans des projets Python.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!