xml-fmt 1.0.0__tar.gz

xml_fmt-1.0.0/.gitignore

@@ -0,0 +1,3 @@
+.tox/
+.*_cache
+__pycache__

xml_fmt-1.0.0/LICENSE.txt

@@ -0,0 +1,18 @@
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

xml_fmt-1.0.0/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.4
+Name: xml-fmt
+Version: 1.0.0
+Summary: Run pre-commit with uv
+Project-URL: Bug Tracker, https://github.com/tox-dev/xml-fmt/issues
+Project-URL: Changelog, https://github.com/tox-dev/xml-fmt/releases
+Project-URL: Documentation, https://github.com/tox-dev/xml-fmt/
+Project-URL: Source Code, https://github.com/tox-dev/xml-fmt
+Author-email: Bernat Gabor <gaborjbernat@gmail.com>
+License: Permission is hereby granted, free of charge, to any person obtaining a
+        copy of this software and associated documentation files (the
+        "Software"), to deal in the Software without restriction, including
+        without limitation the rights to use, copy, modify, merge, publish,
+        distribute, sublicense, and/or sell copies of the Software, and to
+        permit persons to whom the Software is furnished to do so, subject to
+        the following conditions:
+        
+        The above copyright notice and this permission notice shall be included
+        in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+        OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+        IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+        CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+        TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+        SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+License-File: LICENSE.txt
+Keywords: XML,format
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# xml-fmt
+
+[![PyPI](https://img.shields.io/pypi/v/xml-fmt?style=flat-square)](https://pypi.org/project/xml-fmt)
+[![PyPI - Implementation](https://img.shields.io/pypi/implementation/xml-fmt?style=flat-square)](https://pypi.org/project/xml-fmt)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/xml-fmt?style=flat-square)](https://pypi.org/project/xml-fmt)
+[![Downloads](https://static.pepy.tech/badge/xml-fmt/month)](https://pepy.tech/project/xml-fmt)
+[![PyPI - License](https://img.shields.io/pypi/l/xml-fmt?style=flat-square)](https://opensource.org/licenses/MIT)
+[![check](https://github.com/tox-dev/xml-fmt/actions/workflows/check.yaml/badge.svg)](https://github.com/tox-dev/xml-fmt/actions/workflows/check.yaml)
+
+### Using `xml-fmt` with pre-commit
+
+Add it to your `.pre-commit-config.yaml`:
+
+```yaml
+- repo: https://github.com/tox-dev/xml-fmt
+  rev: "" # Use the sha / tag you want to point at
+  hooks:
+    - id: pyproject-fmt
+```

xml_fmt-1.0.0/README.md

@@ -0,0 +1,19 @@
+# xml-fmt
+
+[![PyPI](https://img.shields.io/pypi/v/xml-fmt?style=flat-square)](https://pypi.org/project/xml-fmt)
+[![PyPI - Implementation](https://img.shields.io/pypi/implementation/xml-fmt?style=flat-square)](https://pypi.org/project/xml-fmt)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/xml-fmt?style=flat-square)](https://pypi.org/project/xml-fmt)
+[![Downloads](https://static.pepy.tech/badge/xml-fmt/month)](https://pepy.tech/project/xml-fmt)
+[![PyPI - License](https://img.shields.io/pypi/l/xml-fmt?style=flat-square)](https://opensource.org/licenses/MIT)
+[![check](https://github.com/tox-dev/xml-fmt/actions/workflows/check.yaml/badge.svg)](https://github.com/tox-dev/xml-fmt/actions/workflows/check.yaml)
+
+### Using `xml-fmt` with pre-commit
+
+Add it to your `.pre-commit-config.yaml`:
+
+```yaml
+- repo: https://github.com/tox-dev/xml-fmt
+  rev: "" # Use the sha / tag you want to point at
+  hooks:
+    - id: pyproject-fmt
+```

xml_fmt-1.0.0/pyproject.toml

@@ -0,0 +1,148 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = [
+  "hatch-vcs>=0.4",
+  "hatchling>=1.27",
+]
+
+[project]
+name = "xml-fmt"
+description = "Run pre-commit with uv"
+readme = "README.md"
+keywords = [
+  "format",
+  "XML",
+]
+license.file = "LICENSE.txt"
+authors = [
+  { name = "Bernat Gabor", email = "gaborjbernat@gmail.com" },
+]
+requires-python = ">=3.9"
+classifiers = [
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+]
+dynamic = [
+  "version",
+]
+urls."Bug Tracker" = "https://github.com/tox-dev/xml-fmt/issues"
+urls."Changelog" = "https://github.com/tox-dev/xml-fmt/releases"
+urls.Documentation = "https://github.com/tox-dev/xml-fmt/"
+urls."Source Code" = "https://github.com/tox-dev/xml-fmt"
+scripts.xml-fmt = "xml_fmt.__main__:run"
+
+[dependency-groups]
+dev = [
+  { include-group = "test" },
+  { include-group = "type" },
+]
+test = [
+  "covdefaults>=2.3",
+  "pytest>=8.3.4",
+  "pytest-cov>=6",
+  "pytest-mock>=3.14",
+]
+type = [
+  "mypy==1.14.1",
+  { include-group = "test" },
+]
+fix = [
+  "pre-commit-uv>=4.1.4",
+]
+pkg-meta = [
+  "check-wheel-contents>=0.6.1",
+  "twine>=6.1",
+  "uv>=0.5.26",
+]
+
+[tool.hatch]
+build.dev-mode-dirs = [
+  "src",
+]
+build.targets.sdist.include = [
+  "/src",
+  "/tests",
+  "tox.ini",
+]
+build.targets.wheel.only-include = [ "src" ]
+build.targets.wheel.sources = [ "src" ]
+version.source = "vcs"
+
+[tool.ruff]
+target-version = "py39"
+line-length = 120
+format.preview = true
+format.docstring-code-line-length = 100
+format.docstring-code-format = true
+lint.select = [
+  "ALL",
+]
+lint.ignore = [
+  "COM812", # Conflict with formatter
+  "CPY",    # No copyright statements
+  "D203",   # `one-blank-line-before-class` (D203) and `no-blank-line-before-class` (D211) are incompatible.
+  "D212",   # `multi-line-summary-first-line` (D212) and `multi-line-summary-second-line` (D213) are incompatible.
+  "DOC501", # not working with Sphinx
+  "ISC001", # Conflict with formatter
+  "S104",   # Possible binding to all interfaces
+]
+lint.per-file-ignores."tests/**/*.py" = [
+  "D",       # don't care about documentation in tests
+  "FBT",     # don't care about booleans as positional arguments in tests
+  "INP001",  # no implicit namespace
+  "PLC2701", # private import
+  "PLR0913", # any number of arguments in tests
+  "PLR0917", # any number of arguments in tests
+  "PLR2004", # Magic value used in comparison, consider replacing with a constant variable.
+  "S",       # `subprocess` call: check for execution of untrusted input
+  "S101",    # asserts allowed in tests.
+]
+lint.isort = { known-first-party = [
+  "xml_fmt",
+], required-imports = [
+  "from __future__ import annotations",
+] }
+lint.preview = true
+
+[tool.codespell]
+builtin = "clear,usage,en-GB_to_en-US"
+count = true
+
+[tool.pyproject-fmt]
+max_supported_python = "3.13"
+
+[tool.pytest.ini_options]
+filterwarnings = [ "error" ]
+verbosity_assertions = 2
+testpaths = [
+  "tests",
+]
+
+[tool.coverage]
+html.show_contexts = true
+html.skip_covered = false
+paths.source = [
+  "src",
+  ".tox/*/.venv/lib/*/site-packages",
+  ".tox\\*\\.venv\\Lib\\site-packages",
+  ".tox/*/lib/*/site-packages",
+  ".tox\\*\\Lib\\site-packages",
+  "**/src",
+  "**\\src",
+]
+report.fail_under = 63
+run.parallel = true
+run.plugins = [
+  "covdefaults",
+]
+
+[tool.mypy]
+show_error_codes = true
+strict = true

xml_fmt-1.0.0/src/xml_fmt/__init__.py

@@ -0,0 +1 @@
+"""XML formatter."""

xml_fmt-1.0.0/src/xml_fmt/__main__.py

@@ -0,0 +1,160 @@
+"""Format XMLs."""
+
+from __future__ import annotations
+
+import os
+import sys
+from argparse import ArgumentDefaultsHelpFormatter, ArgumentParser, ArgumentTypeError, Namespace
+from difflib import unified_diff
+from importlib.metadata import version
+from pathlib import Path
+from typing import TYPE_CHECKING
+from xml.etree.ElementTree import XML, indent, tostring  # noqa: S405
+
+if TYPE_CHECKING:
+    from collections.abc import Iterable, Sequence
+
+
+class Options(Namespace):
+    """Options for pyproject-fmt tool."""
+
+    inputs: list[Path | None]
+    stdout: bool
+    check: bool
+    no_print_diff: bool
+
+    indent: str
+    expand_empty_elements: bool
+
+
+def run(args: Sequence[str] | None = None) -> int:
+    """
+    Run the formatter.
+
+    :param args: command line arguments, by default use sys.argv[1:]
+    :return: exit code - 0 means already formatted correctly, otherwise 1
+    """  # noqa: DOC201
+    parser = _build_cli()
+    opts = Options()
+    parser.parse_args(args=args, namespace=opts)
+    results = [_handle_one(filename, opts) for filename in opts.inputs]
+    return 1 if any(results) else 0  # exit with non success on change
+
+
+class _Formatter(ArgumentDefaultsHelpFormatter):
+    def __init__(self, prog: str) -> None:
+        super().__init__(prog, max_help_position=29, width=240)
+
+
+def _build_cli() -> ArgumentParser:
+    parser = ArgumentParser(formatter_class=_Formatter, prog="xml-fmt")
+    parser.add_argument(
+        "-V",
+        "--version",
+        action="version",
+        help="version of the project",
+        version=f"%(prog)s ({version('xml-fmt')})",
+    )
+
+    mode_group = parser.add_argument_group("run mode")
+    mode = mode_group.add_mutually_exclusive_group()
+    msg = "print the formatted XML to the stdout, implied if reading from stdin"
+    mode.add_argument("-s", "--stdout", action="store_true", help=msg)
+    msg = "check and fail if any input would be formatted, printing any diffs"
+    mode.add_argument("--check", action="store_true", help=msg)
+    mode_group.add_argument(
+        "-n",
+        "--no-print-diff",
+        action="store_true",
+        help="controls if to print diff - when running in check mode",
+    )
+
+    format_group = parser.add_argument_group("formatting behavior")
+    format_group.add_argument("--indent", default="  ", help="indentation characters to use - two space by default")
+    format_group.add_argument(
+        "--expand-empty-elements",
+        action="store_true",
+        help="controls if empty XML elements should be collapsed into a self closing element or expanded",
+    )
+
+    msg = "XML (XSD) file(s) to format, use '-' to read from stdin"
+    parser.add_argument("inputs", nargs="+", type=_path_creator, help=msg)
+    return parser
+
+
+def _path_creator(argument: str) -> Path | None:
+    if argument == "-":
+        return None  # stdin, no further validation needed
+    path = Path(argument).absolute()
+    if not path.exists():
+        msg = "path does not exist"
+        raise ArgumentTypeError(msg)
+    if not path.is_file():
+        msg = "path is not a file"
+        raise ArgumentTypeError(msg)
+    if not os.access(path, os.R_OK):
+        msg = "cannot read path"
+        raise ArgumentTypeError(msg)
+    if not os.access(path, os.W_OK):
+        msg = "cannot write path"
+        raise ArgumentTypeError(msg)
+    return path
+
+
+def _handle_one(filename: Path | None, opts: Options) -> bool:
+    before = sys.stdin.read() if filename is None else filename.read_text(encoding="utf-8")
+    formatted = _format(before, opts)
+
+    changed = before != formatted
+    if filename is None or opts.stdout:  # when reading from stdin or writing to stdout, print new format
+        print(formatted, end="")  # noqa: T201
+        return changed
+
+    if before != formatted and not opts.check:
+        filename.write_text(formatted, encoding="utf-8")
+    if opts.no_print_diff:
+        return changed
+    try:
+        name = str(filename.relative_to(Path.cwd()))
+    except ValueError:
+        name = str(filename)
+    diff: Iterable[str] = []
+    if changed:
+        diff = unified_diff(before.splitlines(), formatted.splitlines(), fromfile=name, tofile=name)
+
+    if diff:
+        diff = _color_diff(diff)
+        print("\n".join(diff))  # print diff on change  # noqa: T201
+    else:
+        print(f"no change for {name}")  # noqa: T201
+    return changed
+
+
+def _format(raw: str, opts: Options) -> str:
+    element = XML(raw)
+    indent(element, opts.indent)
+    return tostring(
+        element,
+        encoding="unicode",
+        xml_declaration=True,
+        short_empty_elements=not opts.expand_empty_elements,
+    )
+
+
+GREEN = "\u001b[32m"
+RED = "\u001b[31m"
+RESET = "\u001b[0m"
+
+
+def _color_diff(diff: Iterable[str]) -> Iterable[str]:
+    for line in diff:
+        if line.startswith("+"):
+            yield f"{GREEN}{line}{RESET}"
+        elif line.startswith("-"):
+            yield f"{RED}{line}{RESET}"
+        else:
+            yield line
+
+
+if __name__ == "__main__":
+    raise SystemExit(run(sys.argv[1:]))

xml_fmt-1.0.0/tests/test_main.py

@@ -0,0 +1,130 @@
+from __future__ import annotations
+
+import os
+from io import StringIO
+from typing import TYPE_CHECKING
+
+import pytest
+
+from xml_fmt.__main__ import run
+
+if TYPE_CHECKING:
+    from pathlib import Path
+
+    from pytest_mock import MockerFixture
+
+
+@pytest.fixture
+def min_xml_str() -> str:
+    return "<?xml version='1.0' encoding='utf-8'?>\n<root />"
+
+
+@pytest.fixture
+def min_xml(tmp_path: Path, min_xml_str: str) -> Path:
+    path = tmp_path / "name.xml"
+    path.write_text(min_xml_str)
+    return path
+
+
+def test_xml_help(capsys: pytest.CaptureFixture[str]) -> None:
+    with pytest.raises(SystemExit) as exc:
+        run(["--help"])
+
+    assert exc.value.code == 0
+
+    out, err = capsys.readouterr()
+    assert not err
+    assert "XML (XSD)" in out
+
+
+def test_xml_format_no_print_diff(capsys: pytest.CaptureFixture[str], tmp_path: Path, min_xml_str: str) -> None:
+    xml = tmp_path / "name.xml"
+    xml.write_text("<?xml version='1.0' encoding='utf-8'?>\n<root></root>\n")
+
+    exit_code = run([str(xml), "--no-print-diff"])
+
+    assert xml.read_text() == min_xml_str
+    assert exit_code == 1
+
+    out, err = capsys.readouterr()
+    assert not err
+    assert out.splitlines() == []
+
+
+def test_xml_format_already_good(
+    capsys: pytest.CaptureFixture[str], min_xml: Path, monkeypatch: pytest.MonkeyPatch, min_xml_str: str
+) -> None:
+    monkeypatch.setenv("NO_FMT", "1")
+
+    exit_code = run([str(min_xml)])
+    assert exit_code == 0
+
+    assert min_xml.read_text() == min_xml_str
+
+    out, err = capsys.readouterr()
+    assert not err
+    assert out.splitlines() == [f"no change for {min_xml}"]
+
+
+def test_xml_stdin(capsys: pytest.CaptureFixture[str], mocker: MockerFixture, min_xml_str: str) -> None:
+    mocker.patch("sys.stdin", StringIO("<?xml version='1.0' encoding='utf-8'?>\n<root></root>\n"))
+
+    exit_code = run(["-"])
+    assert exit_code == 1
+
+    out, err = capsys.readouterr()
+    assert not err
+    assert out == min_xml_str
+
+
+def test_xml_path_missing(capsys: pytest.CaptureFixture[str], tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> None:
+    monkeypatch.chdir(tmp_path)
+
+    with pytest.raises(SystemExit):
+        run(["demo.xml"])
+
+    out, err = capsys.readouterr()
+    assert "\nxml-fmt: error: argument inputs: path does not exist\n" in err
+    assert not out
+
+
+def test_xml_path_is_folder(capsys: pytest.CaptureFixture[str], tmp_path: Path) -> None:
+    path = tmp_path / "demo.xml"
+    os.mkfifo(path)
+
+    with pytest.raises(SystemExit):
+        run([str(path)])
+
+    out, err = capsys.readouterr()
+    assert "\nxml-fmt: error: argument inputs: path is not a file\n" in err
+    assert not out
+
+
+def test_xml_path_no_read(capsys: pytest.CaptureFixture[str], min_xml: Path) -> None:
+    start = min_xml.stat().st_mode
+    min_xml.chmod(0o000)
+
+    try:
+        with pytest.raises(SystemExit):
+            run([str(min_xml)])
+    finally:
+        min_xml.chmod(start)
+
+    out, err = capsys.readouterr()
+    assert "\nxml-fmt: error: argument inputs: cannot read path\n" in err
+    assert not out
+
+
+def test_xml_path_no_write(capsys: pytest.CaptureFixture[str], min_xml: Path) -> None:
+    start = min_xml.stat().st_mode
+    min_xml.chmod(0o400)
+
+    try:
+        with pytest.raises(SystemExit):
+            run([str(min_xml)])
+    finally:
+        min_xml.chmod(start)
+
+    out, err = capsys.readouterr()
+    assert "\nxml-fmt: error: argument inputs: cannot write path\n" in err
+    assert not out