diff --git a/.coverage b/.coverage
index cad90cb..77c430a 100644
Binary files a/.coverage and b/.coverage differ
diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml
index c202860..0272a24 100644
--- a/.github/workflows/pythonpackage.yml
+++ b/.github/workflows/pythonpackage.yml
@@ -152,4 +152,3 @@ jobs:
- name: Run mypy
run: mypy json2xml tests
-
diff --git a/HISTORY.rst b/HISTORY.rst
index 3f689cb..48ff349 100644
--- a/HISTORY.rst
+++ b/HISTORY.rst
@@ -450,4 +450,3 @@ v3.0.0 / 2019-02-26
* Cleanup Readme.md
* Update issue templates
* fix vulnerabilities in requests
-
diff --git a/Makefile b/Makefile
index 2834c67..106bd43 100644
--- a/Makefile
+++ b/Makefile
@@ -95,4 +95,3 @@ dist: clean ## builds source and wheel package
install: clean ## install the package to the active Python's site-packages
python setup.py install
-
diff --git a/README.rst b/README.rst
index f2bcc0e..ebe87d7 100644
--- a/README.rst
+++ b/README.rst
@@ -139,7 +139,9 @@ However, you can change this behavior using the item_wrap property like this:
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"]}')
+ 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:
@@ -201,7 +203,7 @@ This project uses modern Python development practices. Here's how to set up a de
# 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 .
@@ -241,4 +243,3 @@ Help and Support to maintain this project
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- You can sponsor my work for this plugin here: https://github.com/sponsors/vinitkumar/
-
diff --git a/dev.py b/dev.py
index cf89b93..0744f49 100644
--- a/dev.py
+++ b/dev.py
@@ -31,10 +31,18 @@ def main() -> None:
success &= run_command(["ruff", "check", "json2xml", "tests"], "Linting")
if command in ("test", "all"):
- success &= run_command([
- "pytest", "--cov=json2xml", "--cov-report=term",
- "-xvs", "tests", "-n", "auto"
- ], "Tests")
+ success &= run_command(
+ [
+ "pytest",
+ "--cov=json2xml",
+ "--cov-report=term",
+ "-xvs",
+ "tests",
+ "-n",
+ "auto",
+ ],
+ "Tests",
+ )
if command in ("typecheck", "all"):
success &= run_command(["mypy", "json2xml", "tests"], "Type checking")
diff --git a/docs/conf.py b/docs/conf.py
index 139fc40..b87e9f7 100755
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -21,7 +21,7 @@
import os
import sys
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
import json2xml
@@ -35,23 +35,23 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"]
# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
# The master toctree document.
-master_doc = 'index'
+master_doc = "index"
# General information about the project.
-project = 'json2xml'
-copyright = f'{year}, Vinit Kumar'
+project = "json2xml"
+copyright = f"{year}, Vinit Kumar"
author = "Vinit Kumar"
# The version info for the project you're documenting, acts as replacement
@@ -73,10 +73,10 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
@@ -87,7 +87,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
-html_theme = 'furo'
+html_theme = "furo"
# Theme options are theme-specific and customize the look and feel of a
# theme further. For a list of options available for each theme, see the
@@ -98,13 +98,13 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
# -- Options for HTMLHelp output ---------------------------------------
# Output file base name for HTML help builder.
-htmlhelp_basename = 'json2xmldoc'
+htmlhelp_basename = "json2xmldoc"
# -- Options for LaTeX output ------------------------------------------
@@ -113,15 +113,12 @@
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
-
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
-
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
-
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
@@ -131,9 +128,7 @@
# (source start file, target name, title, author, documentclass
# [howto, manual, or own class]).
latex_documents = [
- (master_doc, 'json2xml.tex',
- 'json2xml Documentation',
- 'Vinit Kumar', 'manual'),
+ (master_doc, "json2xml.tex", "json2xml Documentation", "Vinit Kumar", "manual"),
]
@@ -141,11 +136,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
-man_pages = [
- (master_doc, 'json2xml',
- 'json2xml Documentation',
- [author], 1)
-]
+man_pages = [(master_doc, "json2xml", "json2xml Documentation", [author], 1)]
# -- Options for Texinfo output ----------------------------------------
@@ -154,13 +145,13 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
- (master_doc, 'json2xml',
- 'json2xml Documentation',
- author,
- 'json2xml',
- 'One line description of project.',
- 'Miscellaneous'),
+ (
+ master_doc,
+ "json2xml",
+ "json2xml Documentation",
+ author,
+ "json2xml",
+ "One line description of project.",
+ "Miscellaneous",
+ ),
]
-
-
-
diff --git a/examples/bigexample.json b/examples/bigexample.json
index 2f39e9d..f05bbf3 100644
--- a/examples/bigexample.json
+++ b/examples/bigexample.json
@@ -102,4 +102,4 @@
"entity_status": "",
"art_unit": ""
}
-]
\ No newline at end of file
+]
diff --git a/examples/wrongjson.json b/examples/wrongjson.json
index 8ac8cf5..87035ea 100644
--- a/examples/wrongjson.json
+++ b/examples/wrongjson.json
@@ -368,5 +368,5 @@
}
}
]
-
-
\ No newline at end of file
+
+
diff --git a/json2xml/__init__.py b/json2xml/__init__.py
index 53e5f5b..edf8979 100644
--- a/json2xml/__init__.py
+++ b/json2xml/__init__.py
@@ -3,4 +3,3 @@
__author__ = """Vinit Kumar"""
__email__ = "mail@vinitkumar.me"
__version__ = "5.2.1"
-
diff --git a/json2xml/dicttoxml.py b/json2xml/dicttoxml.py
index af32da4..2078d7c 100644
--- a/json2xml/dicttoxml.py
+++ b/json2xml/dicttoxml.py
@@ -5,7 +5,8 @@
import numbers
from collections.abc import Callable, Sequence
from random import SystemRandom
-from typing import Any, Union
+from typing import Any, SupportsFloat, Union
+from xml.parsers.expat import ExpatError
from defusedxml.minidom import parseString
@@ -14,6 +15,9 @@
# Set up logging
LOG = logging.getLogger("dicttoxml")
+# Module-level set for true uniqueness tracking
+_used_ids: set[str] = set()
+
def make_id(element: str, start: int = 100000, end: int = 999999) -> str:
"""
@@ -41,16 +45,11 @@ def get_unique_id(element: str) -> str:
Returns:
str: The unique ID.
"""
- ids: list[str] = [] # initialize list of unique ids
this_id = make_id(element)
- dup = True
- while dup:
- if this_id not in ids:
- dup = False
- ids.append(this_id)
- else:
- this_id = make_id(element)
- return ids[-1]
+ while this_id in _used_ids:
+ this_id = make_id(element)
+ _used_ids.add(this_id)
+ return this_id
ELEMENT = Union[
@@ -58,7 +57,7 @@ def get_unique_id(element: str) -> str:
int,
float,
bool,
- numbers.Number,
+ SupportsFloat,
Sequence[Any],
datetime.datetime,
datetime.date,
@@ -77,44 +76,43 @@ def get_xml_type(val: ELEMENT) -> str:
Returns:
str: The XML type.
"""
- if val is not None:
- if type(val).__name__ in ("str", "unicode"):
- return "str"
- if type(val).__name__ in ("int", "long"):
- return "int"
- if type(val).__name__ == "float":
- return "float"
- if type(val).__name__ == "bool":
- return "bool"
- if isinstance(val, numbers.Number):
- return "number"
- if isinstance(val, dict):
- return "dict"
- if isinstance(val, Sequence):
- return "list"
- else:
+ if val is None:
return "null"
+ if isinstance(val, bool): # Check bool before int (bool is subclass of int)
+ return "bool"
+ if isinstance(val, int):
+ return "int"
+ if isinstance(val, float):
+ return "float"
+ if isinstance(val, str):
+ return "str"
+ if isinstance(val, SupportsFloat):
+ return "number"
+ if isinstance(val, dict):
+ return "dict"
+ if isinstance(val, Sequence):
+ return "list"
return type(val).__name__
-def escape_xml(s: str | int | float | numbers.Number) -> str:
+def escape_xml(s: str | int | float | SupportsFloat) -> str:
"""
Escape a string for use in XML.
Args:
- s (str | numbers.Number): The string to escape.
+ s (str | int | float | SupportsFloat): The string to escape.
Returns:
str: The escaped string.
"""
+ s_str = str(s) # Convert to string once
if isinstance(s, str):
- s = str(s) # avoid UnicodeDecodeError
- s = s.replace("&", "&")
- s = s.replace('"', """)
- s = s.replace("'", "'")
- s = s.replace("<", "<")
- s = s.replace(">", ">")
- return str(s)
+ s_str = s_str.replace("&", "&")
+ s_str = s_str.replace('"', """)
+ s_str = s_str.replace("'", "'")
+ s_str = s_str.replace("<", "<")
+ s_str = s_str.replace(">", ">")
+ return s_str
def make_attrstring(attr: dict[str, Any]) -> str:
@@ -145,40 +143,44 @@ def key_is_valid_xml(key: str) -> bool:
try:
parseString(test_xml)
return True
- except Exception: # minidom does not implement exceptions well
+ except (ExpatError, ValueError) as e:
+ LOG.debug(f"Invalid XML name '{key}': {e}")
return False
-def make_valid_xml_name(key: str, attr: dict[str, Any]) -> tuple[str, dict[str, Any]]:
+def make_valid_xml_name(
+ key: str | int, attr: dict[str, Any]
+) -> tuple[str, dict[str, Any]]:
"""Tests an XML name and fixes it if invalid"""
- key = escape_xml(key)
+ key_str = str(key) # Ensure we're working with strings
+ key_str = escape_xml(key_str)
# 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)
# pass through if key is already valid
- if key_is_valid_xml(key):
- return key, attr
+ if key_is_valid_xml(key_str):
+ return key_str, attr
# prepend a lowercase n if the key is numeric
- if isinstance(key, int) or key.isdigit():
- return f"n{key}", attr
+ if key_str.isdigit():
+ return f"n{key_str}", attr
# replace spaces with underscores if that fixes the problem
- if key_is_valid_xml(key.replace(" ", "_")):
- return key.replace(" ", "_"), attr
+ if key_is_valid_xml(key_str.replace(" ", "_")):
+ return key_str.replace(" ", "_"), attr
# allow namespace prefixes + ignore @flat in key
- if key_is_valid_xml(key.replace(":", "").replace("@flat", "")):
- return key, attr
+ if key_is_valid_xml(key_str.replace(":", "").replace("@flat", "")):
+ return key_str, attr
# key is still invalid - move it into a name attribute
- attr["name"] = key
- key = "key"
- return key, attr
+ attr["name"] = key_str
+ key_str = "key"
+ return key_str, attr
-def wrap_cdata(s: str | int | float | numbers.Number) -> str:
+def wrap_cdata(s: str | int | float | SupportsFloat) -> str:
"""Wraps a string into CDATA sections"""
s = str(s).replace("]]>", "]]]]>")
return ""
@@ -188,6 +190,25 @@ def default_item_func(parent: str) -> str:
return "item"
+def _build_namespace_string(xml_namespaces: dict[str, Any]) -> str:
+ """Build XML namespace string from namespace dictionary."""
+ parts = []
+
+ for prefix, value in xml_namespaces.items():
+ if prefix == "xsi" and isinstance(value, dict):
+ for schema_att, ns in value.items():
+ if schema_att == "schemaInstance":
+ parts.append(f'xmlns:{prefix}="{ns}"')
+ elif schema_att == "schemaLocation":
+ parts.append(f'xsi:{schema_att}="{ns}"')
+ elif prefix == "xmlns":
+ parts.append(f'xmlns="{value}"')
+ else:
+ parts.append(f'xmlns:{prefix}="{value}"')
+
+ return " " + " ".join(parts) if parts else ""
+
+
def convert(
obj: ELEMENT,
ids: Any,
@@ -208,7 +229,7 @@ def convert(
if isinstance(obj, bool):
return convert_bool(key=item_name, val=obj, attr_type=attr_type, cdata=cdata)
- if isinstance(obj, numbers.Number):
+ if isinstance(obj, SupportsFloat):
return convert_kv(
key=item_name, val=obj, attr_type=attr_type, attr={}, cdata=cdata
)
@@ -233,10 +254,28 @@ def convert(
return convert_none(key=item_name, attr_type=attr_type, cdata=cdata)
if isinstance(obj, dict):
- return convert_dict(obj, ids, parent, attr_type, item_func, cdata, item_wrap, list_headers=list_headers)
+ return convert_dict(
+ obj,
+ ids,
+ parent,
+ attr_type,
+ item_func,
+ cdata,
+ item_wrap,
+ list_headers=list_headers,
+ )
if isinstance(obj, Sequence):
- return convert_list(obj, ids, parent, attr_type, item_func, cdata, item_wrap, list_headers=list_headers)
+ return convert_list(
+ obj,
+ ids,
+ parent,
+ attr_type,
+ item_func,
+ cdata,
+ item_wrap,
+ list_headers=list_headers,
+ )
raise TypeError(f"Unsupported data type: {obj} ({type(obj).__name__})")
@@ -262,12 +301,13 @@ def dict2xml_str(
parse dict2xml
"""
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
+ 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):
@@ -277,7 +317,14 @@ def dict2xml_str(
else:
# we can not use convert_dict, because rawitem could be non-dict
subtree = convert(
- rawitem, ids, attr_type, item_func, cdata, item_wrap, item_name, list_headers=list_headers
+ rawitem,
+ ids,
+ attr_type,
+ item_func,
+ cdata,
+ item_wrap,
+ item_name,
+ list_headers=list_headers,
)
if parentIsList and list_headers:
@@ -319,7 +366,7 @@ def list2xml_str(
item_func=item_func,
cdata=cdata,
item_wrap=item_wrap,
- list_headers=list_headers
+ list_headers=list_headers,
)
if flat or (len(item) > 0 and is_primitive_type(item[0]) and not item_wrap):
return subtree
@@ -337,7 +384,7 @@ def convert_dict(
item_func: Callable[[str], str],
cdata: bool,
item_wrap: bool,
- list_headers: bool = False
+ list_headers: bool = False,
) -> str:
"""Converts a dict into an XML string."""
output: list[str] = []
@@ -355,7 +402,7 @@ def convert_dict(
if isinstance(val, bool):
addline(convert_bool(key, val, attr_type, attr, cdata))
- elif isinstance(val, (numbers.Number, str)):
+ elif isinstance(val, (SupportsFloat, str)):
addline(
convert_kv(
key=key, val=val, attr_type=attr_type, attr=attr, cdata=cdata
@@ -376,9 +423,15 @@ def convert_dict(
elif isinstance(val, dict):
addline(
dict2xml_str(
- attr_type, attr, val, item_func, cdata, key, item_wrap,
+ attr_type,
+ attr,
+ val,
+ item_func,
+ cdata,
+ key,
+ item_wrap,
False,
- list_headers=list_headers
+ list_headers=list_headers,
)
)
@@ -392,7 +445,7 @@ def convert_dict(
cdata=cdata,
item_name=key,
item_wrap=item_wrap,
- list_headers=list_headers
+ list_headers=list_headers,
)
)
@@ -432,7 +485,7 @@ def convert_list(
if isinstance(item, bool):
addline(convert_bool(item_name, item, attr_type, attr, cdata))
- elif isinstance(item, (numbers.Number, str)):
+ elif isinstance(item, (SupportsFloat, str)):
if item_wrap:
addline(
convert_kv(
@@ -477,7 +530,7 @@ def convert_list(
item_wrap=item_wrap,
parentIsList=True,
parent=parent,
- list_headers=list_headers
+ list_headers=list_headers,
)
)
@@ -491,7 +544,7 @@ def convert_list(
cdata=cdata,
item_name=item_name,
item_wrap=item_wrap,
- list_headers=list_headers
+ list_headers=list_headers,
)
)
@@ -505,7 +558,7 @@ def convert_list(
def convert_kv(
key: str,
- val: str | int | float | numbers.Number | datetime.datetime | datetime.date,
+ val: str | int | float | SupportsFloat | datetime.datetime | datetime.date,
attr_type: bool,
attr: dict[str, Any] | None = None,
cdata: bool = False,
@@ -516,17 +569,25 @@ def convert_kv(
key, attr = make_valid_xml_name(key, attr)
# Convert datetime to isoformat string
- if hasattr(val, "isoformat") and isinstance(val, (datetime.datetime, datetime.date)):
+ 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)
- return f"<{key}{attr_string}>{wrap_cdata(val) if cdata else escape_xml(val)}"
+ return (
+ f"<{key}{attr_string}>{wrap_cdata(val) if cdata else escape_xml(val)}"
+ )
def convert_bool(
- key: str, val: bool, attr_type: bool, attr: dict[str, Any] | None = None, 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:
@@ -562,8 +623,8 @@ def dicttoxml(
item_wrap: bool = True,
item_func: Callable[[str], str] = default_item_func,
cdata: bool = False,
- xml_namespaces: dict[str, Any] = {},
- list_headers: bool = False
+ xml_namespaces: dict[str, Any] | None = None,
+ list_headers: bool = False,
) -> bytes:
"""
Converts a python object into XML.
@@ -681,35 +742,36 @@ def dicttoxml(
- 4
- 5
- 6
"""
- output = []
- namespace_str = ""
- for prefix in xml_namespaces:
- if prefix == 'xsi':
- for schema_att in xml_namespaces[prefix]:
- if schema_att == 'schemaInstance':
- ns = xml_namespaces[prefix]['schemaInstance']
- namespace_str += f' xmlns:{prefix}="{ns}"'
- elif schema_att == 'schemaLocation':
- ns = xml_namespaces[prefix][schema_att]
- namespace_str += f' xsi:{schema_att}="{ns}"'
-
- elif prefix == 'xmlns':
- # xmns needs no prefix
- ns = xml_namespaces[prefix]
- namespace_str += f' xmlns="{ns}"'
+ if xml_namespaces is None:
+ xml_namespaces = {}
- else:
- ns = xml_namespaces[prefix]
- namespace_str += f' xmlns:{prefix}="{ns}"'
+ output = []
+ namespace_str = _build_namespace_string(xml_namespaces)
if root:
output.append('')
output_elem = convert(
- obj, ids, attr_type, item_func, cdata, item_wrap, parent=custom_root, list_headers=list_headers
+ obj,
+ ids,
+ attr_type,
+ item_func,
+ cdata,
+ item_wrap,
+ parent=custom_root,
+ list_headers=list_headers,
)
output.append(f"<{custom_root}{namespace_str}>{output_elem}")
else:
output.append(
- convert(obj, ids, attr_type, item_func, cdata, item_wrap, parent="", list_headers=list_headers)
+ convert(
+ obj,
+ ids,
+ attr_type,
+ item_func,
+ cdata,
+ item_wrap,
+ parent="",
+ list_headers=list_headers,
+ )
)
return "".join(output).encode("utf-8")
diff --git a/json2xml/json2xml.py b/json2xml/json2xml.py
index f3c7401..aa61486 100644
--- a/json2xml/json2xml.py
+++ b/json2xml/json2xml.py
@@ -1,7 +1,7 @@
-from pyexpat import ExpatError
from typing import Any
from defusedxml.minidom import parseString
+from pyexpat import ExpatError
from json2xml import dicttoxml
@@ -12,6 +12,7 @@ class Json2xml:
"""
Wrapper class to convert the data to xml
"""
+
def __init__(
self,
data: dict[str, Any] | None = None,
@@ -42,7 +43,9 @@ def to_xml(self) -> Any | None:
)
if self.pretty:
try:
- result = parseString(xml_data).toprettyxml(encoding="UTF-8").decode()
+ result = (
+ parseString(xml_data).toprettyxml(encoding="UTF-8").decode()
+ )
except ExpatError:
raise InvalidDataError
return result
diff --git a/json2xml/utils.py b/json2xml/utils.py
index 85954a4..a953f74 100644
--- a/json2xml/utils.py
+++ b/json2xml/utils.py
@@ -1,4 +1,5 @@
"""Utility methods for converting XML data to dictionary from various sources."""
+
import json
import urllib3
@@ -6,21 +7,25 @@
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
@@ -40,7 +45,7 @@ def readfromurl(url: str, params: dict[str, str] | None = None) -> dict[str, str
http = urllib3.PoolManager()
response = http.request("GET", url, fields=params)
if response.status == 200:
- return json.loads(response.data.decode('utf-8'))
+ return json.loads(response.data.decode("utf-8"))
raise URLReadError("URL is not returning correct response")
diff --git a/pyproject.toml b/pyproject.toml
index 19ab880..d8d1627 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -1,74 +1,79 @@
[build-system]
-requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"
+requires = [ "setuptools>=42", "wheel" ]
+
[project]
name = "json2xml"
-version = "5.2.1" # Replace with the dynamic version if needed
+version = "5.2.1" # Replace with the dynamic version if needed
description = "Simple Python Library to convert JSON to XML"
readme = "README.rst"
-requires-python = ">=3.10"
+keywords = [ "json2xml" ]
license = { text = "Apache Software License 2.0" }
-keywords = ["json2xml"]
authors = [
- { name = "Vinit Kumar", email = "mail@vinitkumar.me" }
+ { name = "Vinit Kumar", email = "mail@vinitkumar.me" },
]
+requires-python = ">=3.10"
classifiers = [
- "Development Status :: 6 - Mature",
- "Intended Audience :: Developers",
- "License :: OSI Approved :: Apache Software License",
- "Natural Language :: English",
- "Programming Language :: Python :: 3.10",
- "Programming Language :: Python :: 3.11",
- "Programming Language :: Python :: 3.12",
- "Programming Language :: Python :: 3.13",
- "Programming Language :: Python :: 3.14",
- "Programming Language :: Python :: Implementation :: CPython",
- "Programming Language :: Python :: Implementation :: PyPy",
- "Topic :: Software Development :: Libraries :: Python Modules"
+ "Development Status :: 6 - Mature",
+ "Intended Audience :: Developers",
+ "License :: OSI Approved :: Apache Software License",
+ "Natural Language :: English",
+ "Programming Language :: Python :: 3 :: Only",
+ "Programming Language :: Python :: 3.10",
+ "Programming Language :: Python :: 3.11",
+ "Programming Language :: Python :: 3.12",
+ "Programming Language :: Python :: 3.13",
+ "Programming Language :: Python :: Implementation :: CPython",
+ "Programming Language :: Python :: Implementation :: PyPy",
+ "Topic :: Software Development :: Libraries :: Python Modules",
]
dependencies = [
- "defusedxml",
- "urllib3",
- "xmltodict>=0.12.0",
- "pytest",
- "pytest-cov",
- "coverage",
- "setuptools",
+ "coverage",
+ "defusedxml",
+ "pytest",
+ "pytest-cov",
+ "setuptools",
+ "urllib3",
+ "xmltodict>=0.12",
]
-[project.urls]
-Homepage = "https://github.com/vinitkumar/json2xml"
-
-[tool.setuptools.packages.find]
-include = ["json2xml"]
+optional-dependencies.test = [
+ "pytest==7.0.1",
+]
+urls.Homepage = "https://github.com/vinitkumar/json2xml"
-[project.optional-dependencies]
-test = [
- "pytest==7.0.1",
+[dependency-groups]
+dev = [
+ "mypy>=1.17.1",
+ "pre-commit>=4.3",
]
-[tool.pytest.ini_options]
-testpaths = ["tests"]
-python_files = ["test_*.py"]
-xvs = true
-addopts = "--cov=json2xml --cov-report=xml:coverage/reports/coverage.xml --cov-report=term"
+[tool.setuptools.packages.find]
+include = [ "json2xml" ]
+
[tool.ruff]
+line-length = 119
+
exclude = [
- ".env",
- ".venv",
- "**/migrations/**",
-]
-lint.ignore = [
- "E501", # line too long
- "F403", # 'from module import *' used; unable to detect undefined names
- "E701", # multiple statements on one line (colon)
- "F401", # module imported but unused
+ "**/migrations/**",
+ ".env",
+ ".venv",
]
-line-length = 119
lint.select = [
- "I",
- "E",
- "F",
- "W",
+ "E",
+ "F",
+ "I",
+ "W",
]
+lint.ignore = [
+ "E501", # line too long
+ "E701", # multiple statements on one line (colon)
+ "F403", # 'from module import *' used; unable to detect undefined names
+]
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+python_files = [ "test_*.py" ]
+xvs = true
+addopts = "--cov=json2xml --cov-report=xml:coverage/reports/coverage.xml --cov-report=term"
diff --git a/pytest.ini b/pytest.ini
index 48a7eda..cd6079b 100644
--- a/pytest.ini
+++ b/pytest.ini
@@ -1,4 +1,3 @@
[pytest]
log_cli=True
log_cli_level=INFO
-
diff --git a/requirements.in b/requirements.in
index 9ed5639..eb52d54 100644
--- a/requirements.in
+++ b/requirements.in
@@ -1,3 +1,2 @@
defusedxml==0.7.1
urllib3==2.5.0
-
diff --git a/setup.py b/setup.py
index 58464f5..f00661b 100644
--- a/setup.py
+++ b/setup.py
@@ -5,4 +5,3 @@
from setuptools import setup
setup()
-
diff --git a/tests/conftest.py b/tests/conftest.py
index eedcc47..54b9c7b 100644
--- a/tests/conftest.py
+++ b/tests/conftest.py
@@ -1,4 +1,5 @@
"""Pytest configuration for json2xml tests."""
+
from __future__ import annotations
import json
@@ -22,7 +23,7 @@ def sample_json_string() -> str:
@pytest.fixture
-def sample_json_dict() -> Dict[str, Any]:
+def sample_json_dict() -> dict[str, Any]:
"""Return a sample JSON dictionary for testing.
Returns:
@@ -36,7 +37,7 @@ def sample_json_dict() -> Dict[str, Any]:
@pytest.fixture
-def sample_json_list() -> List[Dict[str, Any]]:
+def sample_json_list() -> list[dict[str, Any]]:
"""Return a sample JSON list for testing.
Returns:
diff --git a/tests/test_dict2xml.py b/tests/test_dict2xml.py
index df770a9..ef2588c 100644
--- a/tests/test_dict2xml.py
+++ b/tests/test_dict2xml.py
@@ -1,18 +1,10 @@
import datetime
-import numbers
-from typing import TYPE_CHECKING, Any
+from typing import Any
import pytest
from json2xml import dicttoxml
-if TYPE_CHECKING:
- from _pytest.capture import CaptureFixture
- from _pytest.fixtures import FixtureRequest
- from _pytest.logging import LogCaptureFixture
- from _pytest.monkeypatch import MonkeyPatch
- from pytest_mock.plugin import MockerFixture
-
class TestDict2xml:
"""Test class for dicttoxml functionality."""
@@ -173,36 +165,32 @@ def test_dict2xml_with_ampsersand_and_attrs(self) -> None:
def dict_with_attrs(self) -> dict[str, Any]:
"""Fixture providing a dictionary with attributes for testing."""
return {
- 'transportation-mode': [
- {
- '@attrs': {'xml:lang': 'nl'},
- '@val': 'Fiets'
- },
- {
- '@attrs': {'xml:lang': 'nl'},
- '@val': 'Bus'
- },
- {
- '@attrs': {'xml:lang': 'en'},
- '@val': 'Bike'
- }
+ "transportation-mode": [
+ {"@attrs": {"xml:lang": "nl"}, "@val": "Fiets"},
+ {"@attrs": {"xml:lang": "nl"}, "@val": "Bus"},
+ {"@attrs": {"xml:lang": "en"}, "@val": "Bike"},
]
}
- def test_dict2xml_list_items_with_attrs(self, dict_with_attrs: dict[str, Any]) -> None:
+ def test_dict2xml_list_items_with_attrs(
+ self, dict_with_attrs: dict[str, Any]
+ ) -> None:
"""Test dicttoxml with list items containing attributes."""
- '''With list headers = True
- '''
+ """With list headers = True
+ """
- wanted_xml_result = b'Fiets' \
- b'Bus' \
- b'Bike'
+ wanted_xml_result = (
+ b'Fiets'
+ b'Bus'
+ b'Bike'
+ )
xml_result = dicttoxml.dicttoxml(
dict_with_attrs,
root=False,
attr_type=False,
item_wrap=False,
- list_headers=True)
+ list_headers=True,
+ )
assert xml_result == wanted_xml_result
@@ -409,34 +397,33 @@ def test_convert_datetime(self) -> None:
expected = '2023-02-15T12:30:45'
- assert dicttoxml.convert_kv(
- key='item_name',
- val=dt,
- attr_type=True,
- attr={},
- cdata=False
- ) == expected
+ assert (
+ dicttoxml.convert_kv(
+ key="item_name", val=dt, attr_type=True, attr={}, cdata=False
+ )
+ == expected
+ )
# write test for bool test
def test_basic_conversion(self) -> None:
"""Test basic boolean conversion."""
- xml = dicttoxml.convert_bool('key', True, False)
- assert xml == 'true'
+ xml = dicttoxml.convert_bool("key", True, False)
+ assert xml == "true"
def test_with_type_attribute(self) -> None:
"""Test boolean conversion with type attribute."""
- xml = dicttoxml.convert_bool('key', False, True)
+ xml = dicttoxml.convert_bool("key", False, True)
assert xml == 'false'
def test_with_custom_attributes(self) -> None:
"""Test boolean conversion with custom attributes."""
- xml = dicttoxml.convert_bool('key', True, False, {'id': '1'})
+ xml = dicttoxml.convert_bool("key", True, False, {"id": "1"})
assert xml == 'true'
def test_valid_key(self) -> None:
"""Test convert_bool with valid key."""
- xml = dicttoxml.convert_bool('valid_key', False, attr_type=False)
- assert xml == 'false'
+ xml = dicttoxml.convert_bool("valid_key", False, attr_type=False)
+ assert xml == "false"
def test_convert_kv_with_cdata(self) -> None:
"""Test convert_kv with CDATA wrapping."""
@@ -465,7 +452,6 @@ def test_convert_none_with_attr_type(self) -> None:
result = dicttoxml.convert_none("key", attr_type=True)
assert result == ''
-
def test_make_valid_xml_name_with_numeric_key(self) -> None:
"""Test make_valid_xml_name with numeric key."""
key, attr = dicttoxml.make_valid_xml_name("123", {})
@@ -474,8 +460,13 @@ def test_make_valid_xml_name_with_numeric_key(self) -> None:
def test_escape_xml_with_special_chars(self) -> None:
"""Test escape_xml with special characters."""
- result = dicttoxml.escape_xml('This & that < those > these "quotes" \'single quotes\'')
- assert result == "This & that < those > these "quotes" 'single quotes'"
+ result = dicttoxml.escape_xml(
+ "This & that < those > these \"quotes\" 'single quotes'"
+ )
+ assert (
+ result
+ == "This & that < those > these "quotes" 'single quotes'"
+ )
def test_get_xml_type_with_sequence(self) -> None:
"""Test get_xml_type with sequence."""
@@ -516,13 +507,19 @@ def test_list_to_xml_with_dict_items(self) -> None:
"""Test list to XML with dictionary items."""
data = {"items": [{"key1": "value1"}, {"key2": "value2"}]}
result = dicttoxml.dicttoxml(data, root=False, attr_type=False, item_wrap=True)
- assert result == b"- value1
- value2
"
+ assert (
+ result
+ == b"- value1
- value2
"
+ )
def test_list_to_xml_with_mixed_items(self) -> None:
"""Test list to XML with mixed item types."""
data = {"items": [1, "string", {"key": "value"}]}
result = dicttoxml.dicttoxml(data, root=False, attr_type=False, item_wrap=True)
- assert result == b"- 1
- string
- value
"
+ assert (
+ result
+ == b"- 1
- string
- value
"
+ )
def test_list_to_xml_with_empty_list(self) -> None:
"""Test list to XML with empty list."""
@@ -534,7 +531,10 @@ def test_list_to_xml_with_special_characters(self) -> None:
"""Test list to XML with special characters."""
data = {"items": ["", "&", '"quote"', "'single quote'"]}
result = dicttoxml.dicttoxml(data, root=False, attr_type=False, item_wrap=True)
- assert result == b"- <tag>
- &
- "quote"
- 'single quote'
"
+ assert (
+ result
+ == b"- <tag>
- &
- "quote"
- 'single quote'
"
+ )
def test_datetime_conversion_with_isoformat(self) -> None:
"""Test datetime conversion with isoformat."""
@@ -574,6 +574,7 @@ def test_date_conversion_with_custom_attributes(self) -> None:
def test_get_xml_type_unsupported(self) -> None:
"""Test get_xml_type with unsupported type."""
+
class CustomClass:
pass
@@ -592,6 +593,7 @@ def test_make_valid_xml_name_invalid_chars(self) -> None:
def test_dict2xml_str_invalid_type(self) -> None:
"""Test dict2xml_str with invalid type."""
+
class CustomClass:
pass
@@ -605,11 +607,12 @@ class CustomClass:
cdata=False,
item_name="test",
item_wrap=False,
- parentIsList=False
+ parentIsList=False,
)
def test_convert_dict_invalid_type(self) -> None:
"""Test convert_dict with invalid type."""
+
class CustomClass:
pass
@@ -622,11 +625,12 @@ class CustomClass:
attr_type=False,
item_func=lambda x: "item",
cdata=False,
- item_wrap=False
+ item_wrap=False,
)
def test_convert_list_invalid_type(self) -> None:
"""Test convert_list with invalid type."""
+
class CustomClass:
pass
@@ -639,7 +643,7 @@ class CustomClass:
attr_type=False,
item_func=lambda x: "item",
cdata=False,
- item_wrap=False
+ item_wrap=False,
)
def test_convert_list_with_none(self) -> None:
@@ -652,7 +656,7 @@ def test_convert_list_with_none(self) -> None:
attr_type=True,
item_func=lambda x: "item",
cdata=False,
- item_wrap=True
+ item_wrap=True,
)
assert result == '- 1
- 2
- 3
" == result
@@ -757,7 +762,7 @@ def test_convert_with_float(self) -> None:
attr_type=True,
item_func=lambda x: "item",
cdata=False,
- item_wrap=True
+ item_wrap=True,
)
assert result == '- 3.14
'
@@ -827,7 +832,7 @@ def test_convert_with_bool_direct(self) -> None:
attr_type=False,
item_func=lambda x: "item",
cdata=False,
- item_wrap=True
+ item_wrap=True,
)
assert result == "- true
"
@@ -839,7 +844,7 @@ def test_convert_with_string_direct(self) -> None:
attr_type=False,
item_func=lambda x: "item",
cdata=False,
- item_wrap=True
+ item_wrap=True,
)
assert result == "- test_string
"
@@ -852,7 +857,7 @@ def test_convert_with_datetime_direct(self) -> None:
attr_type=False,
item_func=lambda x: "item",
cdata=False,
- item_wrap=True
+ item_wrap=True,
)
assert result == "- 2023-02-15T12:30:45
"
@@ -864,12 +869,13 @@ def test_convert_with_none_direct(self) -> None:
attr_type=False,
item_func=lambda x: "item",
cdata=False,
- item_wrap=True
+ item_wrap=True,
)
assert result == "- true
" == result
@@ -994,7 +1000,7 @@ def test_convert_list_with_datetime_item(self) -> None:
attr_type=False,
item_func=lambda x: "item",
cdata=False,
- item_wrap=True
+ item_wrap=True,
)
assert "- 2023-02-15T12:30:45
" == result
@@ -1008,7 +1014,7 @@ def test_convert_list_with_sequence_item(self) -> None:
attr_type=False,
item_func=lambda x: "item",
cdata=False,
- item_wrap=True
+ item_wrap=True,
)
assert "- nested
- list