Feature/xml generator

faker/providers/misc/__init__.py

@@ -1,4 +1,4 @@
 import csv
 import hashlib
 import io
 import json
@@ -13,6 +13,7 @@
 
 from faker.exceptions import UnsupportedFeature
 
+from ..python import TypesSpec
 from .. import BaseProvider
 
 localized = True
@@ -613,6 +614,30 @@
         data = [create_json_structure(data_columns) for _ in range(num_rows)]
         return json.dumps(data, indent=indent, cls=cls)
 
+    def xml(self,
+        nb_elements: int = 10,
+        variable_nb_elements: bool = True,
+        value_types: Optional[TypesSpec] = None,
+        allowed_types: Optional[TypesSpec] = None,
+        ) -> str:
+        """
+        Returns a xml.
+
+        :nb_elements: number of elements for dictionary
+        :variable_nb_elements: is use variable number of elements for dictionary
+        :value_types: type of dictionary values
+
+        Note: this provider required xmltodict library installed
+        """
+        try:
+            import xmltodict
+        except ImportError:
+            raise UnsupportedFeature("`xml` requires the `xmltodict` python library.", "xml")
+        _dict = self.generator.pydict(nb_elements=nb_elements, variable_nb_elements=variable_nb_elements,
+                                    value_types=value_types, allowed_types=allowed_types)
+        _dict = {self.generator.word(): _dict}
+        return xmltodict.unparse(_dict)
+
     def fixed_width(self, data_columns: Optional[list] = None, num_rows: int = 10, align: str = "left") -> str:
         """
         Generate random fixed width values.

tests/providers/test_misc.py

@@ -1,4 +1,4 @@
 import csv
 import datetime
 import io
 import itertools
@@ -8,6 +8,7 @@
 import unittest
 import uuid
 import zipfile
+import xml
 
 try:
     import PIL.Image
@@ -455,6 +456,12 @@
             for args, kwargs in mock_writer.call_args_list:
                 assert kwargs == test_kwargs
 
+    def test_xml(self, faker):
+        try:
+            xml.etree.ElementTree.fromstring(faker.xml())
+        except xml.etree.ElementTree.ParseError:
+            raise AssertionError("The xml format is invalid")
+
     def test_csv_helper_method(self, faker):
         kwargs = {
             "header": ["Column 1", "Column 2"],

tox.ini

@@ -11,6 +11,7 @@ deps =
     validators>=0.13.0
     sphinx>=2.4,<3.0
     Pillow
+    xmltodict
 commands =
     coverage run --source=faker -m pytest {posargs}
     coverage run --source=faker -a -m pytest --exclusive-faker-session tests/pytest/session_overrides {posargs}