json2xml 6.0.6__tar.gz → 6.0.7__tar.gz

{json2xml-6.0.6 → json2xml-6.0.7}/HISTORY.rst

@@ -1,4 +1,11 @@
 
+6.0.7 / 2026-04-26
+==================
+
+  * fix: handle JSON conversion edge cases and improve URL reader robustness (#284)
+  * chore(deps-dev): bump pytest from 9.0.1 to 9.0.3 (#282)
+
+
 6.0.6 / 2026-04-08
 ==================
 

{json2xml-6.0.6 → json2xml-6.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: json2xml
-Version: 6.0.6
+Version: 6.0.7
 Summary: Simple Python Library to convert JSON to XML
 Author-email: Vinit Kumar <mail@vinitkumar.me>
 License: Apache Software License 2.0
@@ -79,7 +79,7 @@ Installation
 
     pip install json2xml
 
-**With Native Rust Acceleration (up to 149x faster)**
+**With Native Rust Acceleration (up to 129x faster)**
 
 For maximum performance, install the optional Rust extension:
 
@@ -91,7 +91,7 @@ For maximum performance, install the optional Rust extension:
     # Or install the Rust extension separately
     pip install json2xml-rs
 
-The Rust extension provides **75-149x faster** conversion compared to pure Python. It's automatically used when available, with seamless fallback to pure Python.
+The Rust extension provides **57-129x faster** conversion compared to pure Python in the latest benchmark. It's automatically used when available, with seamless fallback to pure Python.
 
 **As a CLI Tool**
 
@@ -337,7 +337,7 @@ Using tools directly:
 
 **Rust Extension Development**
 
-The optional Rust extension (``json2xml-rs``) provides up to 149x faster performance. To develop or build the Rust extension:
+The optional Rust extension (``json2xml-rs``) provides up to 129x faster performance in the latest benchmark. To develop or build the Rust extension:
 
 Prerequisites:
 
@@ -464,21 +464,21 @@ For users who need maximum performance within Python, json2xml includes an optio
      - Rust Extension
      - Speedup
    * - **Small JSON** (47 bytes)
-     - 78µs
-     - 1.05µs
-     - **75x**
+     - 31.49µs
+     - 0.55µs
+     - **56.8x**
    * - **Medium JSON** (3.2 KB)
-     - 2.15ms
-     - 15µs
-     - **139x**
+     - 1.69ms
+     - 16.15µs
+     - **105.0x**
    * - **Large JSON** (32 KB)
-     - 22ms
-     - 151µs
-     - **146x**
+     - 17.97ms
+     - 168.21µs
+     - **106.8x**
    * - **Very Large JSON** (323 KB)
-     - 219ms
-     - 1.47ms
-     - **149x**
+     - 183.33ms
+     - 1.42ms
+     - **129.0x**
 
 **Usage with Rust Extension:**
 
@@ -508,7 +508,7 @@ For other platforms, the pure Python version is used automatically.
 Performance Benchmarks
 ^^^^^^^^^^^^^^^^^^^^^^
 
-Comprehensive benchmarks comparing all implementations (Apple Silicon, January 2026):
+Comprehensive benchmarks comparing all implementations (Apple Silicon, macOS 26.4.1, Python 3.14.4, April 2026):
 
 .. list-table::
    :header-rows: 1
@@ -521,40 +521,40 @@ Comprehensive benchmarks comparing all implementations (Apple Silicon, January 2
      - Zig
      - Best
    * - **Small** (47B)
-     - 40µs
-     - 1.5µs
-     - 4.6ms
-     - 3.7ms
-     - Rust (28x)
+     - 31.49µs
+     - 0.55µs
+     - 4.09ms
+     - 2.02ms
+     - Rust (56.8x)
    * - **Medium** (3.2KB)
-     - 2.1ms
-     - 71µs
-     - 4.1ms
-     - 3.3ms
-     - Rust (30x)
+     - 1.69ms
+     - 16.15µs
+     - 4.07ms
+     - 2.09ms
+     - Rust (105.0x)
    * - **Large** (32KB)
-     - 21ms
-     - 740µs
-     - 4ms
-     - 6.1ms
-     - Rust (28x)
+     - 17.97ms
+     - 168.21µs
+     - 4.10ms
+     - 2.42ms
+     - Rust (106.8x)
    * - **Very Large** (323KB)
-     - 213ms
-     - 7.5ms
-     - 4.4ms
-     - 33ms
-     - Go (48x)
+     - 183.33ms
+     - 1.42ms
+     - 4.20ms
+     - 5.12ms
+     - Rust (129.0x)
 
 **Key Findings:**
 
-- **Rust extension**: ~28x faster than Python, zero overhead (best for Python users)
-- **Go CLI**: 48x faster for large files (300KB+), but has ~4ms startup overhead
-- **Zig CLI**: 3-6x faster for medium-large files
+- **Rust extension**: 57-129x faster than Python, zero process overhead (best for Python users)
+- **Go CLI**: 43.6x faster for very large files (300KB+), but has ~4ms startup overhead
+- **Zig CLI**: 7.4x faster for large files and 35.8x faster for very large files, with ~2ms startup overhead
 
 **Recommendation by Use Case:**
 
-- **Python library calls**: Use ``pip install json2xml[fast]`` (Rust, 28x faster)
-- **Large file CLI processing**: Use `json2xml-go <https://github.com/vinitkumar/json2xml-go>`_ (Go, 48x for 300KB+)
+- **Python library calls**: Use ``pip install json2xml[fast]`` (Rust, up to 129x faster)
+- **Large file CLI processing**: Use `json2xml-go <https://github.com/vinitkumar/json2xml-go>`_ or `json2xml-zig <https://github.com/vinitkumar/json2xml-zig>`_ depending on your workload
 - **Pure Python required**: Use ``pip install json2xml``
 
 For detailed benchmarks, see `BENCHMARKS.md <https://github.com/vinitkumar/json2xml/blob/master/BENCHMARKS.md>`_.
@@ -565,9 +565,9 @@ Other Implementations
 
 This library is also available in other languages:
 
-- **Rust**: `json2xml-rs <https://pypi.org/project/json2xml-rs/>`_ - 28x faster, Python extension via PyO3
-- **Go**: `json2xml-go <https://github.com/vinitkumar/json2xml-go>`_ - 48x faster for large files, native CLI
-- **Zig**: `json2xml-zig <https://github.com/vinitkumar/json2xml-zig>`_ - 6x faster, native CLI
+- **Rust**: `json2xml-rs <https://pypi.org/project/json2xml-rs/>`_ - up to 129x faster, Python extension via PyO3
+- **Go**: `json2xml-go <https://github.com/vinitkumar/json2xml-go>`_ - 43.6x faster for very large files, native CLI
+- **Zig**: `json2xml-zig <https://github.com/vinitkumar/json2xml-zig>`_ - 35.8x faster for very large files, native CLI
 
 
 Help and Support to maintain this project

{json2xml-6.0.6 → json2xml-6.0.7}/README.rst

@@ -43,7 +43,7 @@ Installation
 
     pip install json2xml
 
-**With Native Rust Acceleration (up to 149x faster)**
+**With Native Rust Acceleration (up to 129x faster)**
 
 For maximum performance, install the optional Rust extension:
 
@@ -55,7 +55,7 @@ For maximum performance, install the optional Rust extension:
     # Or install the Rust extension separately
     pip install json2xml-rs
 
-The Rust extension provides **75-149x faster** conversion compared to pure Python. It's automatically used when available, with seamless fallback to pure Python.
+The Rust extension provides **57-129x faster** conversion compared to pure Python in the latest benchmark. It's automatically used when available, with seamless fallback to pure Python.
 
 **As a CLI Tool**
 
@@ -301,7 +301,7 @@ Using tools directly:
 
 **Rust Extension Development**
 
-The optional Rust extension (``json2xml-rs``) provides up to 149x faster performance. To develop or build the Rust extension:
+The optional Rust extension (``json2xml-rs``) provides up to 129x faster performance in the latest benchmark. To develop or build the Rust extension:
 
 Prerequisites:
 
@@ -428,21 +428,21 @@ For users who need maximum performance within Python, json2xml includes an optio
      - Rust Extension
      - Speedup
    * - **Small JSON** (47 bytes)
-     - 78µs
-     - 1.05µs
-     - **75x**
+     - 31.49µs
+     - 0.55µs
+     - **56.8x**
    * - **Medium JSON** (3.2 KB)
-     - 2.15ms
-     - 15µs
-     - **139x**
+     - 1.69ms
+     - 16.15µs
+     - **105.0x**
    * - **Large JSON** (32 KB)
-     - 22ms
-     - 151µs
-     - **146x**
+     - 17.97ms
+     - 168.21µs
+     - **106.8x**
    * - **Very Large JSON** (323 KB)
-     - 219ms
-     - 1.47ms
-     - **149x**
+     - 183.33ms
+     - 1.42ms
+     - **129.0x**
 
 **Usage with Rust Extension:**
 
@@ -472,7 +472,7 @@ For other platforms, the pure Python version is used automatically.
 Performance Benchmarks
 ^^^^^^^^^^^^^^^^^^^^^^
 
-Comprehensive benchmarks comparing all implementations (Apple Silicon, January 2026):
+Comprehensive benchmarks comparing all implementations (Apple Silicon, macOS 26.4.1, Python 3.14.4, April 2026):
 
 .. list-table::
    :header-rows: 1
@@ -485,40 +485,40 @@ Comprehensive benchmarks comparing all implementations (Apple Silicon, January 2
      - Zig
      - Best
    * - **Small** (47B)
-     - 40µs
-     - 1.5µs
-     - 4.6ms
-     - 3.7ms
-     - Rust (28x)
+     - 31.49µs
+     - 0.55µs
+     - 4.09ms
+     - 2.02ms
+     - Rust (56.8x)
    * - **Medium** (3.2KB)
-     - 2.1ms
-     - 71µs
-     - 4.1ms
-     - 3.3ms
-     - Rust (30x)
+     - 1.69ms
+     - 16.15µs
+     - 4.07ms
+     - 2.09ms
+     - Rust (105.0x)
    * - **Large** (32KB)
-     - 21ms
-     - 740µs
-     - 4ms
-     - 6.1ms
-     - Rust (28x)
+     - 17.97ms
+     - 168.21µs
+     - 4.10ms
+     - 2.42ms
+     - Rust (106.8x)
    * - **Very Large** (323KB)
-     - 213ms
-     - 7.5ms
-     - 4.4ms
-     - 33ms
-     - Go (48x)
+     - 183.33ms
+     - 1.42ms
+     - 4.20ms
+     - 5.12ms
+     - Rust (129.0x)
 
 **Key Findings:**
 
-- **Rust extension**: ~28x faster than Python, zero overhead (best for Python users)
-- **Go CLI**: 48x faster for large files (300KB+), but has ~4ms startup overhead
-- **Zig CLI**: 3-6x faster for medium-large files
+- **Rust extension**: 57-129x faster than Python, zero process overhead (best for Python users)
+- **Go CLI**: 43.6x faster for very large files (300KB+), but has ~4ms startup overhead
+- **Zig CLI**: 7.4x faster for large files and 35.8x faster for very large files, with ~2ms startup overhead
 
 **Recommendation by Use Case:**
 
-- **Python library calls**: Use ``pip install json2xml[fast]`` (Rust, 28x faster)
-- **Large file CLI processing**: Use `json2xml-go <https://github.com/vinitkumar/json2xml-go>`_ (Go, 48x for 300KB+)
+- **Python library calls**: Use ``pip install json2xml[fast]`` (Rust, up to 129x faster)
+- **Large file CLI processing**: Use `json2xml-go <https://github.com/vinitkumar/json2xml-go>`_ or `json2xml-zig <https://github.com/vinitkumar/json2xml-zig>`_ depending on your workload
 - **Pure Python required**: Use ``pip install json2xml``
 
 For detailed benchmarks, see `BENCHMARKS.md <https://github.com/vinitkumar/json2xml/blob/master/BENCHMARKS.md>`_.
@@ -529,9 +529,9 @@ Other Implementations
 
 This library is also available in other languages:
 
-- **Rust**: `json2xml-rs <https://pypi.org/project/json2xml-rs/>`_ - 28x faster, Python extension via PyO3
-- **Go**: `json2xml-go <https://github.com/vinitkumar/json2xml-go>`_ - 48x faster for large files, native CLI
-- **Zig**: `json2xml-zig <https://github.com/vinitkumar/json2xml-zig>`_ - 6x faster, native CLI
+- **Rust**: `json2xml-rs <https://pypi.org/project/json2xml-rs/>`_ - up to 129x faster, Python extension via PyO3
+- **Go**: `json2xml-go <https://github.com/vinitkumar/json2xml-go>`_ - 43.6x faster for very large files, native CLI
+- **Zig**: `json2xml-zig <https://github.com/vinitkumar/json2xml-zig>`_ - 35.8x faster for very large files, native CLI
 
 
 Help and Support to maintain this project

{json2xml-6.0.6 → json2xml-6.0.7}/json2xml/__init__.py

@@ -2,4 +2,4 @@
 
 __author__ = """Vinit Kumar"""
 __email__ = "mail@vinitkumar.me"
-__version__ = "6.0.6"
+__version__ = "6.0.7"

{json2xml-6.0.6 → json2xml-6.0.7}/json2xml/cli.py

@@ -43,10 +43,11 @@ from __future__ import annotations
 
 import argparse
 import sys
-from typing import Any
+from typing import NoReturn
 
 from json2xml import __version__
 from json2xml.json2xml import Json2xml
+from json2xml.types import JSONValue
 from json2xml.utils import (
     JSONReadError,
     StringReadError,
@@ -60,6 +61,12 @@ AUTHOR = "Vinit Kumar"
 EMAIL = "mail@vinitkumar.me"
 
 
+def exit_with_error(message: str) -> NoReturn:
+    """Print an error message and terminate CLI processing."""
+    print(message, file=sys.stderr)
+    raise SystemExit(1)
+
+
 # @lat: [[architecture#CLI entrypoint]]
 def create_parser() -> argparse.ArgumentParser:
     """Create and configure the argument parser."""
@@ -230,7 +237,7 @@ Examples:
 
 
 # @lat: [[behavior#Input readers]]
-def read_input(args: argparse.Namespace) -> dict[str, Any] | list[Any]:
+def read_input(args: argparse.Namespace) -> JSONValue:
     """
     Read JSON input from the specified source.
 
@@ -250,15 +257,13 @@ def read_input(args: argparse.Namespace) -> dict[str, Any] | list[Any]:
         try:
             return readfromurl(args.url)
         except URLReadError as e:
-            print(f"Error reading from URL: {e}", file=sys.stderr)
-            sys.exit(1)
+            exit_with_error(f"Error reading from URL: {e}")
 
     if args.string:
         try:
             return readfromstring(args.string)
         except StringReadError as e:
-            print(f"Error parsing JSON string: {e}", file=sys.stderr)
-            sys.exit(1)
+            exit_with_error(f"Error parsing JSON string: {e}")
 
     if args.input_file:
         if args.input_file == "-":
@@ -267,18 +272,16 @@ def read_input(args: argparse.Namespace) -> dict[str, Any] | list[Any]:
         try:
             return readfromjson(args.input_file)
         except JSONReadError as e:
-            print(f"Error reading JSON file: {e}", file=sys.stderr)
-            sys.exit(1)
+            exit_with_error(f"Error reading JSON file: {e}")
 
     # Check if there's data on stdin
     if not sys.stdin.isatty():
         return read_from_stdin()
 
-    print("Error: No input provided. Use -h for help.", file=sys.stderr)
-    sys.exit(1)
+    exit_with_error("Error: No input provided. Use -h for help.")
 
 
-def read_from_stdin() -> dict[str, Any] | list[Any]:
+def read_from_stdin() -> JSONValue:
     """
     Read JSON from standard input.
 
@@ -291,12 +294,10 @@ def read_from_stdin() -> dict[str, Any] | list[Any]:
     try:
         json_str = sys.stdin.read().strip()
         if not json_str:
-            print("Error: Empty input", file=sys.stderr)
-            sys.exit(1)
+            exit_with_error("Error: Empty input")
         return readfromstring(json_str)
     except StringReadError as e:
-        print(f"Error parsing JSON from stdin: {e}", file=sys.stderr)
-        sys.exit(1)
+        exit_with_error(f"Error parsing JSON from stdin: {e}")
 
 
 def write_output(output: str | bytes, output_file: str | None) -> None:

{json2xml-6.0.6 → json2xml-6.0.7}/json2xml/dicttoxml.py

@@ -102,7 +102,7 @@ def get_xml_type(val: Any) -> str:
     return type(val).__name__
 
 
-def escape_xml(s: str | int | float | numbers.Number) -> str:
+def escape_xml(s: str | int | float | numbers.Number | None) -> str:
     """
     Escape a string for use in XML.
 
@@ -155,32 +155,24 @@ def key_is_valid_xml(key: str) -> bool:
 
 
 def make_valid_xml_name(key: str, attr: dict[str, Any]) -> tuple[str, dict[str, Any]]:
-    """Tests an XML name and fixes it if invalid"""
-    key = escape_xml(key)
-    # nothing happens at escape_xml if attr is not a string, we don't
-    # need to pass it to the method at all.
-    # attr = escape_xml(attr)
+    """Return a valid XML element name and carry the original key as metadata when needed."""
+    key = str(key)
 
-    # pass through if key is already valid
     if key_is_valid_xml(key):
         return key, attr
 
-    # prepend a lowercase n if the key is numeric
-    if isinstance(key, int) or key.isdigit():
+    if key.isdigit():
         return f"n{key}", attr
 
-    # replace spaces with underscores if that fixes the problem
-    if key_is_valid_xml(key.replace(" ", "_")):
-        return key.replace(" ", "_"), attr
+    key_with_underscores = key.replace(" ", "_")
+    if key_is_valid_xml(key_with_underscores):
+        return key_with_underscores, attr
 
-    # allow namespace prefixes + ignore @flat in key
-    if key_is_valid_xml(key.replace(":", "").replace("@flat", "")):
+    if ":" in key and key_is_valid_xml(key.replace(":", "")):
         return key, attr
 
-    # key is still invalid - move it into a name attribute
     attr["name"] = key
-    key = "key"
-    return key, attr
+    return "key", attr
 
 
 def wrap_cdata(s: str | int | float | numbers.Number) -> str:
@@ -345,13 +337,20 @@ def dict2xml_str(
 
     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
+    val_attr = dict(item["@attrs"]) if "@attrs" in item else dict(attr)
+    if "@val" in item:
+        rawitem = item["@val"]
+    elif "@attrs" in item:
+        rawitem = {key: value for key, value in item.items() if key != "@attrs"}
+    else:
+        rawitem = item
     if is_primitive_type(rawitem):
-        if isinstance(rawitem, dict):
+        if rawitem is None:
+            subtree = ""
+        elif isinstance(rawitem, bool):
+            subtree = str(rawitem).lower()
+        else:
             subtree = escape_xml(str(rawitem))
-        if isinstance(rawitem, str):
-            subtree = escape_xml(rawitem)
     else:
         # we can not use convert_dict, because rawitem could be non-dict
         subtree = convert(
@@ -423,8 +422,10 @@ def convert_dict(
 
     for key, val in obj.items():
         attr = {} if not ids else {"id": f"{get_unique_id(parent)}"}
+        key_is_flat = isinstance(key, str) and key.endswith("@flat")
+        xml_key = key[:-5] if key_is_flat else key
 
-        key, attr = make_valid_xml_name(key, attr)
+        key, attr = make_valid_xml_name(xml_key, attr)
 
         # since bool is also a subtype of number.Number and int, the check for bool
         # never comes and hence we get wrong value for the xml type bool
@@ -468,7 +469,7 @@ def convert_dict(
                     item=val,
                     item_func=item_func,
                     cdata=cdata,
-                    item_name=key,
+                    item_name=f"{key}@flat" if key_is_flat else key,
                     item_wrap=item_wrap,
                     list_headers=list_headers
                 )

{json2xml-6.0.6 → json2xml-6.0.7}/json2xml/json2xml.py

@@ -5,6 +5,7 @@ from defusedxml.minidom import parseString
 
 from json2xml import dicttoxml
 
+from .types import JSONValue
 from .utils import InvalidDataError
 
 
@@ -15,7 +16,7 @@ class Json2xml:
     """
     def __init__(
         self,
-        data: dict[str, Any] | list[Any] | None = None,
+        data: JSONValue = None,
         wrapper: str = "all",
         root: bool = True,
         pretty: bool = True,
@@ -41,7 +42,7 @@ class Json2xml:
         """
         Convert to xml using dicttoxml.dicttoxml and then pretty print it.
         """
-        if self.data:
+        if self.data is not None:
             xml_data = dicttoxml.dicttoxml(
                 self.data,
                 root=self.root,

json2xml-6.0.7/json2xml/types.py

@@ -0,0 +1,8 @@
+"""Shared JSON type aliases used by reader and converter APIs."""
+from __future__ import annotations
+
+from typing import TypeAlias
+
+JSONValue: TypeAlias = None | bool | int | float | str | list["JSONValue"] | dict[str, "JSONValue"]
+
+__all__ = ["JSONValue"]

json2xml-6.0.7/json2xml/utils.py

@@ -0,0 +1,73 @@
+"""Utility methods for reading JSON data from various sources."""
+from __future__ import annotations
+
+import json
+
+import urllib3
+
+from .types import JSONValue
+
+DEFAULT_URL_TIMEOUT = urllib3.Timeout(connect=5.0, read=30.0)
+_HTTP = urllib3.PoolManager()
+
+
+class JSONReadError(Exception):
+    """Raised when there is an error reading JSON data."""
+    pass
+
+
+class InvalidDataError(Exception):
+    """Raised when the data is invalid."""
+    pass
+
+
+class URLReadError(Exception):
+    """Raised when there is an error reading from a URL."""
+    pass
+
+
+class StringReadError(Exception):
+    """Raised when there is an error reading from a string."""
+    pass
+
+
+# @lat: [[behavior#Input readers]]
+def readfromjson(filename: str) -> JSONValue:
+    """Read JSON data from a file."""
+    try:
+        with open(filename, encoding="utf-8") as jsondata:
+            return json.load(jsondata)
+    except (ValueError, OSError) as error:
+        raise JSONReadError("Invalid JSON File") from error
+
+
+def readfromurl(url: str, params: dict[str, str] | None = None) -> JSONValue:
+    """Load JSON data from a URL."""
+    try:
+        response = _HTTP.request(
+            "GET",
+            url,
+            fields=params,
+            timeout=DEFAULT_URL_TIMEOUT,
+            retries=False,
+        )
+    except urllib3.exceptions.HTTPError as error:
+        raise URLReadError("URL could not be read") from error
+
+    if response.status != 200:
+        raise URLReadError("URL is not returning correct response")
+
+    try:
+        return json.loads(response.data.decode("utf-8"))
+    except (UnicodeDecodeError, json.JSONDecodeError) as error:
+        raise URLReadError("URL did not return valid JSON") from error
+
+
+def readfromstring(jsondata: object) -> JSONValue:
+    """Load JSON data from a string."""
+    if not isinstance(jsondata, str):
+        raise StringReadError("Input is not a proper JSON string")
+    try:
+        return json.loads(jsondata)
+    except ValueError as error:
+        raise StringReadError("Input is not a proper JSON string") from error