json2xml 5.0.4__tar.gz → 5.1.0__tar.gz

{json2xml-5.0.4 → json2xml-5.1.0}/HISTORY.rst

@@ -1,6 +1,13 @@
 History
 =======
 
+5.0.5 / 2024-08-31
+==================
+
+  * tests (json2xml): add test for encoding
+  * fix missing encoding indication on pretty mode (#213)
+  * chore(deps): bump webob from 1.8.7 to 1.8.8 in /docs (#212)
+
 5.0.4 / 2024-08-08
 ==================
 

json2xml-5.1.0/PKG-INFO

@@ -0,0 +1,281 @@
+Metadata-Version: 2.4
+Name: json2xml
+Version: 5.1.0
+Summary: Simple Python Library to convert JSON to XML
+Author-email: Vinit Kumar <mail@vinitkumar.me>
+License: Apache Software License 2.0
+Project-URL: Homepage, https://github.com/vinitkumar/json2xml
+Keywords: json2xml
+Classifier: Development Status :: 6 - Mature
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: defusedxml
+Requires-Dist: urllib3
+Requires-Dist: xmltodict>=0.12.0
+Requires-Dist: pytest
+Requires-Dist: pytest-cov
+Requires-Dist: coverage
+Requires-Dist: py
+Requires-Dist: setuptools
+Provides-Extra: test
+Requires-Dist: pytest==7.0.1; extra == "test"
+Requires-Dist: py==1.11.0; extra == "test"
+Dynamic: license-file
+
+========
+json2xml
+========
+
+.. image:: https://badge.fury.io/py/json2xml.svg
+.. image:: https://static.pepy.tech/personalized-badge/json2xml?period=total&units=international_system&left_color=blue&right_color=orange&left_text=Downloads
+        :target: https://pepy.tech/project/json2xml
+
+.. image:: https://github.com/vinitkumar/json2xml/actions/workflows/pythonpackage.yml/badge.svg
+.. image:: https://img.shields.io/pypi/pyversions/json2xml.svg
+.. image:: https://readthedocs.org/projects/json2xml/badge/?version=latest
+        :target: https://json2xml.readthedocs.io/en/latest/?badge=latest
+        :alt: Documentation Status
+.. image:: https://codecov.io/gh/vinitkumar/json2xml/branch/master/graph/badge.svg?token=Yt2h55eTL2
+      :target: https://codecov.io/gh/vinitkumar/json2xml
+
+json2xml is a Python library that allows you to convert JSON data into XML format. It's simple, efficient, and easy to use.
+
+Documentation: https://json2xml.readthedocs.io.
+
+The library was initially dependent on the `dict2xml` project, but it has now been integrated into json2xml itself. This has led to cleaner code, the addition of types and tests, and overall improved performance.
+
+
+
+Architecture Diagram
+^^^^^^^^^^^^^^^^^^^^
+
+.. image:: ./diagram.png
+
+
+Features
+^^^^^^^^
+
+json2xml supports the following features:
+
+* Conversion from a `json` string to XML
+* Conversion from a `json` file to XML
+* Conversion from an API that emits `json` data to XML
+
+Usage
+^^^^^
+
+You can use the json2xml library in the following ways:
+
+
+.. code-block:: python
+
+    from json2xml import json2xml
+    from json2xml.utils import readfromurl, readfromstring, readfromjson
+
+    # Convert JSON data from a URL to XML
+    data = readfromurl("https://api.publicapis.org/entries")
+    print(json2xml.Json2xml(data).to_xml())
+
+    # Convert a JSON string to XML
+    data = readfromstring(
+        '{"login":"mojombo","id":1,"avatar_url":"https://avatars0.githubusercontent.com/u/1?v=4"}'
+    )
+    print(json2xml.Json2xml(data).to_xml())
+
+    # Convert a JSON file to XML
+    data = readfromjson("examples/licht.json")
+    print(json2xml.Json2xml(data).to_xml())
+
+
+Custom Wrappers and Indentation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+By default, a wrapper `all` and pretty `True` is set. However, you can easily change this in your code like this:
+
+.. code-block:: python
+
+    from json2xml import json2xml
+    from json2xml.utils import readfromurl, readfromstring, readfromjson
+
+    data = readfromstring(
+        '{"login":"mojombo","id":1,"avatar_url":"https://avatars0.githubusercontent.com/u/1?v=4"}'
+    )
+    print(json2xml.Json2xml(data, wrapper="all", pretty=True).to_xml())
+
+
+Outputs this:
+
+.. code-block:: xml
+
+    <?xml version="1.0" encoding="UTF-8"?>
+    <all>
+      <login type="str">mojombo</login>
+      <id type="int">1</id>
+      <avatar_url type="str">https://avatars0.githubusercontent.com/u/1?v=4</avatar_url>
+    </all>
+
+Omit List item
+^^^^^^^^^^^^^^
+
+Assume the following json input
+
+.. code-block:: json
+
+    {
+      "my_items": [
+        { "my_item": { "id": 1 } },
+        { "my_item": { "id": 2 } }
+      ],
+      "my_str_items": ["a", "b"]
+    }
+
+By default, items in an array are wrapped in <item></item>.
+
+Default output:
+
+.. code-block:: xml
+
+    <?xml version="1.0" ?>
+    <all>
+      <my_items type="list">
+        <item type="dict">
+          <my_item type="dict">
+            <id type="int">1</id>
+          </my_item>
+        </item>
+        <item type="dict">
+          <my_item type="dict">
+            <id type="int">2</id>
+          </my_item>
+        </item>
+      </my_items>
+      <my_str_items type="list">
+        <item type="str">a</item>
+        <item type="str">b</item>
+      </my_str_items>
+      <empty type="list"/>
+    </all>
+
+However, you can change this behavior using the item_wrap property like this:
+
+.. code-block:: python
+
+    from json2xml import json2xml
+    from json2xml.utils import readfromurl, readfromstring, readfromjson
+
+    data = readfromstring('{"my_items":[{"my_item":{"id":1} },{"my_item":{"id":2} }],"my_str_items":["a","b"]}')
+    print(json2xml.Json2xml(data, item_wrap=False).to_xml())
+
+Outputs this:
+
+.. code-block:: xml
+
+    <?xml version="1.0" ?>
+    <all>
+      <my_items type="list">
+        <my_item type="dict">
+          <id type="int">1</id>
+        </my_item>
+        <my_item type="dict">
+          <id type="int">2</id>
+        </my_item>
+      </my_items>
+      <my_str_items type="str">a</my_str_items>
+      <my_str_items type="str">b</my_str_items>
+    </all>
+
+Optional Attribute Type Support
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You can also specify if the output XML needs to have type specified or not. Here is the usage:
+
+ .. code-block:: python
+
+    from json2xml import json2xml
+    from json2xml.utils import readfromurl, readfromstring, readfromjson
+
+    data = readfromstring(
+        '{"login":"mojombo","id":1,"avatar_url":"https://avatars0.githubusercontent.com/u/1?v=4"}'
+    )
+    print(json2xml.Json2xml(data, wrapper="all", pretty=True, attr_type=False).to_xml())
+
+
+Outputs this:
+
+.. code-block:: xml
+
+    <?xml version="1.0" ?>
+    <all>
+      <login>mojombo</login>
+      <id>1</id>
+      <avatar_url>https://avatars0.githubusercontent.com/u/1?v=4</avatar_url>
+    </all>
+
+
+The methods are simple and easy to use and there are also checks inside of code to exit cleanly
+in case any of the input(file, string or API URL) returns invalid JSON.
+
+Development
+^^^^^^^^^^^
+
+This project uses modern Python development practices. Here's how to set up a development environment:
+
+ .. code-block:: console
+
+    # Create and activate virtual environment (using uv - recommended)
+    uv venv
+    source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+    
+    # Install dependencies
+    uv pip install -r requirements-dev.txt
+    uv pip install -e .
+
+**Running Tests and Checks**
+
+We provide several ways to run tests and quality checks:
+
+Using Make (recommended):
+
+ .. code-block:: console
+
+    make test          # Run tests with coverage
+    make lint          # Run linting with ruff
+    make typecheck     # Run type checking with mypy
+    make check-all     # Run all checks (lint, typecheck, test)
+
+Using the development script:
+
+ .. code-block:: console
+
+    python dev.py          # Run all checks
+    python dev.py test     # Run tests only
+    python dev.py lint     # Run linting only
+    python dev.py typecheck # Run type checking only
+
+Using tools directly:
+
+ .. code-block:: console
+
+    pytest --cov=json2xml --cov-report=term -xvs tests -n auto
+    ruff check json2xml tests
+    mypy json2xml tests
+
+
+Help and Support to maintain this project
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- You can sponsor my work for this plugin here: https://github.com/sponsors/vinitkumar/
+

{json2xml-5.0.4 → json2xml-5.1.0}/README.rst

@@ -20,6 +20,14 @@ Documentation: https://json2xml.readthedocs.io.
 
 The library was initially dependent on the `dict2xml` project, but it has now been integrated into json2xml itself. This has led to cleaner code, the addition of types and tests, and overall improved performance.
 
+
+
+Architecture Diagram
+^^^^^^^^^^^^^^^^^^^^
+
+.. image:: ./diagram.png
+
+
 Features
 ^^^^^^^^
 
@@ -75,7 +83,7 @@ Outputs this:
 
 .. code-block:: xml
 
-    <?xml version="1.0" ?>
+    <?xml version="1.0" encoding="UTF-8"?>
     <all>
       <login type="str">mojombo</login>
       <id type="int">1</id>
@@ -183,17 +191,50 @@ Outputs this:
 The methods are simple and easy to use and there are also checks inside of code to exit cleanly
 in case any of the input(file, string or API URL) returns invalid JSON.
 
-How to run tests
-^^^^^^^^^^^^^^^^
+Development
+^^^^^^^^^^^
+
+This project uses modern Python development practices. Here's how to set up a development environment:
+
+ .. code-block:: console
+
+    # Create and activate virtual environment (using uv - recommended)
+    uv venv
+    source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+    
+    # Install dependencies
+    uv pip install -r requirements-dev.txt
+    uv pip install -e .
+
+**Running Tests and Checks**
+
+We provide several ways to run tests and quality checks:
+
+Using Make (recommended):
+
+ .. code-block:: console
+
+    make test          # Run tests with coverage
+    make lint          # Run linting with ruff
+    make typecheck     # Run type checking with mypy
+    make check-all     # Run all checks (lint, typecheck, test)
+
+Using the development script:
+
+ .. code-block:: console
+
+    python dev.py          # Run all checks
+    python dev.py test     # Run tests only
+    python dev.py lint     # Run linting only
+    python dev.py typecheck # Run type checking only
 
-This is provided by pytest, which is straight forward.
+Using tools directly:
 
  .. code-block:: console
 
-    virtualenv venv -p $(which python3.9)
-    pip install -r requirements-dev.txt
-    python setup.py install
-    pytest -vv
+    pytest --cov=json2xml --cov-report=term -xvs tests -n auto
+    ruff check json2xml tests
+    mypy json2xml tests
 
 
 Help and Support to maintain this project

{json2xml-5.0.4 → json2xml-5.1.0}/json2xml/__init__.py

@@ -2,5 +2,5 @@
 
 __author__ = """Vinit Kumar"""
 __email__ = "mail@vinitkumar.me"
-__version__ = "5.0.4"
+__version__ = "5.1.0"
 

{json2xml-5.0.4 → json2xml-5.1.0}/json2xml/dicttoxml.py

@@ -5,12 +5,11 @@ import logging
 import numbers
 from collections.abc import Callable, Sequence
 from random import SystemRandom
-from typing import Any, Dict, Union
+from typing import Any, Union
 
 from defusedxml.minidom import parseString
 
 # Create a safe random number generator
-safe_random = SystemRandom()
 
 # Set up logging
 LOG = logging.getLogger("dicttoxml")
@@ -28,6 +27,7 @@ def make_id(element: str, start: int = 100000, end: int = 999999) -> str:
     Returns:
         str: The generated ID.
     """
+    safe_random = SystemRandom()
     return f"{element}_{safe_random.randint(start, end)}"
 
 
@@ -59,7 +59,7 @@ ELEMENT = Union[
     float,
     bool,
     numbers.Number,
-    Sequence[str],
+    Sequence[Any],
     datetime.datetime,
     datetime.date,
     None,
@@ -97,7 +97,7 @@ def get_xml_type(val: ELEMENT) -> str:
     return type(val).__name__
 
 
-def escape_xml(s: str | numbers.Number) -> str:
+def escape_xml(s: str | int | float | numbers.Number) -> str:
     """
     Escape a string for use in XML.
 
@@ -127,7 +127,7 @@ def make_attrstring(attr: dict[str, Any]) -> str:
     Returns:
         str: The string of XML attributes.
     """
-    attrstring = " ".join([f'{k}="{v}"' for k, v in attr.items()])
+    attrstring = " ".join([f'{k}="{escape_xml(v)}"' for k, v in attr.items()])
     return f'{" " if attrstring != "" else ""}{attrstring}'
 
 
@@ -178,7 +178,7 @@ def make_valid_xml_name(key: str, attr: dict[str, Any]) -> tuple[str, dict[str,
     return key, attr
 
 
-def wrap_cdata(s: str | numbers.Number) -> str:
+def wrap_cdata(s: str | int | float | numbers.Number) -> str:
     """Wraps a string into CDATA sections"""
     s = str(s).replace("]]>", "]]]]><![CDATA[>")
     return "<![CDATA[" + s + "]]>"
@@ -263,16 +263,17 @@ def dict2xml_str(
     """
     ids: list[str] = []  # initialize list of unique ids
     ", ".join(str(key) for key in item)
+    subtree = ""  # Initialize subtree with default empty string
 
     if attr_type:
         attr["type"] = get_xml_type(item)
     val_attr: dict[str, str] = item.pop("@attrs", attr)  # update attr with custom @attr if exists
     rawitem = item["@val"] if "@val" in item else item
     if is_primitive_type(rawitem):
+        if isinstance(rawitem, dict):
+            subtree = escape_xml(str(rawitem))
         if isinstance(rawitem, str):
             subtree = escape_xml(rawitem)
-        else:
-            subtree = rawitem
     else:
         # we can not use convert_dict, because rawitem could be non-dict
         subtree = convert(
@@ -306,6 +307,7 @@ def list2xml_str(
     if attr_type:
         attr["type"] = get_xml_type(item)
     flat = False
+    subtree = ""  # Initialize subtree with default empty string
     if item_name.endswith("@flat"):
         item_name = item_name[0:-5]
         flat = True
@@ -503,14 +505,20 @@ def convert_list(
 
 def convert_kv(
     key: str,
-    val: str | numbers.Number,
+    val: str | int | float | numbers.Number | datetime.datetime | datetime.date,
     attr_type: bool,
-    attr: dict[str, Any] = {},
+    attr: dict[str, Any] | None = None,
     cdata: bool = False,
 ) -> str:
-    """Converts a number or string into an XML element"""
+    """Converts a number, string, or datetime into an XML element"""
+    if attr is None:
+        attr = {}
     key, attr = make_valid_xml_name(key, attr)
 
+    # Convert datetime to isoformat string
+    if hasattr(val, "isoformat") and isinstance(val, (datetime.datetime, datetime.date)):
+        val = val.isoformat()
+
     if attr_type:
         attr["type"] = get_xml_type(val)
     attr_string = make_attrstring(attr)
@@ -518,9 +526,11 @@ def convert_kv(
 
 
 def convert_bool(
-    key: str, val: bool, attr_type: bool, attr: dict[str, Any] = {}, cdata: bool = False
+    key: str, val: bool, attr_type: bool, attr: dict[str, Any] | None = None, cdata: bool = False
 ) -> str:
     """Converts a boolean into an XML element"""
+    if attr is None:
+        attr = {}
     key, attr = make_valid_xml_name(key, attr)
 
     if attr_type:
@@ -530,9 +540,11 @@ def convert_bool(
 
 
 def convert_none(
-    key: str, attr_type: bool, attr: dict[str, Any] = {}, cdata: bool = False
+    key: str, attr_type: bool, attr: dict[str, Any] | None = None, cdata: bool = False
 ) -> str:
     """Converts a null value into an XML element"""
+    if attr is None:
+        attr = {}
     key, attr = make_valid_xml_name(key, attr)
 
     if attr_type:
@@ -542,7 +554,7 @@ def convert_none(
 
 
 def dicttoxml(
-    obj: dict[str, Any],
+    obj: ELEMENT,
     root: bool = True,
     custom_root: str = "root",
     ids: list[int] | None = None,

{json2xml-5.0.4 → json2xml-5.1.0}/json2xml/json2xml.py

@@ -1,5 +1,5 @@
 from pyexpat import ExpatError
-from typing import Any, Dict, Optional
+from typing import Any
 
 from defusedxml.minidom import parseString
 
@@ -42,7 +42,7 @@ class Json2xml:
             )
             if self.pretty:
                 try:
-                    result = parseString(xml_data).toprettyxml()
+                    result = parseString(xml_data).toprettyxml(encoding="UTF-8").decode()
                 except ExpatError:
                     raise InvalidDataError
                 return result

{json2xml-5.0.4 → json2xml-5.1.0}/json2xml/utils.py

@@ -1,6 +1,5 @@
 """Utility methods for converting XML data to dictionary from various sources."""
 import json
-from typing import Dict, Optional
 
 import urllib3