xml-fmt 1.0.0__py3-none-any.whl

xml_fmt/__init__.py

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

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.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,8 @@
+xml_fmt/__init__.py,sha256=SmqF7Gms74MVptctdxAxgIIIeHdldmGICJacIX1w-rA,21
+xml_fmt/__main__.py,sha256=GvPv4-ucoVzvZ_37MtFx89fyfC92CaHZgMu-sU5hpag,5011
+xml_fmt/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+xml_fmt-1.0.0.dist-info/METADATA,sha256=fP7rUhPai7trj-wQJ1gbjP8ByfEeWFZiS6krEztuO04,3077
+xml_fmt-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+xml_fmt-1.0.0.dist-info/entry_points.txt,sha256=Uq24L5CeU3mvfWGN77E_I97n_Vwurmh5uTsGXDrJH4c,49
+xml_fmt-1.0.0.dist-info/licenses/LICENSE.txt,sha256=kOJeH68qSq6o2V7o5_VziwUqGswMnFgGgQH5Mahr1Yg,1023
+xml_fmt-1.0.0.dist-info/RECORD,,

xml_fmt-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

xml_fmt-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+xml-fmt = xml_fmt.__main__:run

xml_fmt-1.0.0.dist-info/licenses/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.