json-sorted 1.0.0__py3-none-any.whl

json_sorted/__init__.py

@@ -0,0 +1,9 @@
+from json_sorted.core.main import main
+from json_sorted.core.run import run
+from json_sorted.enum.Instruction import Instruction
+from json_sorted.enum.Selector import Selector
+
+__all__ = ["Instruction", "Selector", "main", "run"]
+
+if __name__ == "__main__":
+    main()

json_sorted/__main__.py

@@ -0,0 +1,4 @@
+from json_sorted import main
+
+if __name__ == "__main__":
+    main()

json_sorted/core/main.py

@@ -0,0 +1,67 @@
+import argparse
+import logging
+import sys
+from collections.abc import Iterable
+from typing import Any, Optional
+
+import setdoc
+
+from ..enum.Instruction import Instruction
+from ..enum.Selector import Selector
+from .run import run
+
+__all__ = ["main"]
+
+
+@setdoc.basic
+def main(args: Optional[Iterable[str]] = None, /) -> None:
+    kwargs: dict[str, Any]
+    parser: argparse.ArgumentParser
+    parser = argparse.ArgumentParser(fromfile_prefix_chars="@")
+    parser.add_argument(
+        "filepatterns",
+        nargs="*",
+        default=[],
+    )
+    parser.add_argument(
+        "--all-indices",
+        action="append_const",
+        const=Selector.ALL_INDICES,
+        dest="instructions",
+    )
+    parser.add_argument(
+        "--all-keys",
+        action="append_const",
+        const=Selector.ALL_KEYS,
+        dest="instructions",
+    )
+    parser.add_argument(
+        "--key",
+        action="append",
+        dest="instructions",
+    )
+    parser.add_argument(
+        "--index",
+        action="append",
+        dest="instructions",
+        type=int,
+    )
+    parser.add_argument(
+        "--sort",
+        action="append_const",
+        const=Instruction.SORT,
+        dest="instructions",
+    )
+    parser.add_argument(
+        "--sort-reverse",
+        action="append_const",
+        const=Instruction.SORT_REVERSE,
+        dest="instructions",
+    )
+    parser.set_defaults(instructions=[])
+    kwargs = vars(parser.parse_args(args))
+    try:
+        run(*kwargs.pop("filepatterns"), **kwargs)
+    except Exception:
+        logging.exception("json_sort failed!")
+        sys.exit(1)

json_sorted/core/run.py

@@ -0,0 +1,173 @@
+import glob
+import json
+import os
+from collections.abc import Iterable
+from typing import Any, cast
+
+import setdoc
+
+from json_sorted.enum.Instruction import Instruction
+from json_sorted.enum.Selector import Selector
+
+__all__ = ["run"]
+
+
+def get_absfiles(filepatterns: Iterable[str]) -> list[str]:
+    absfile: str
+    absfiles: list[str]
+    file: str
+    pattern: str
+    absfiles = list()
+    for pattern in filepatterns:
+        for file in glob.iglob(pattern, recursive=True):
+            absfile = os.path.abspath(file)
+            if absfile in absfiles:
+                continue
+            if os.path.isfile(absfile):
+                absfiles.append(absfile)
+    return absfiles
+
+
+def parse_instructions(
+    instructions: Iterable[Instruction | Selector | int | str] = (),
+) -> list[tuple[Instruction, list[Selector | int | str]]]:
+    ans: list[tuple[Instruction, list[Selector | int | str]]]
+    x: Instruction | Selector | int | str
+    ans = list()
+    for x in instructions:
+        if isinstance(x, Instruction):
+            ans.append((x, list()))
+        elif len(ans):
+            ans[-1][1].append(x)
+    return ans
+
+
+@setdoc.basic
+def run(
+    *filepatterns: str,
+    instructions: Iterable[Instruction | Selector | int | str] = (),
+) -> None:
+    absfiles: list[str]
+    parsed: list[tuple[Instruction, list[Selector | int | str]]]
+    parsed = parse_instructions(instructions)
+    absfiles = get_absfiles(filepatterns)
+    run_instructions_on_files(absfiles=absfiles, parsed=parsed)
+
+
+def run_instruction_on_data(
+    *,
+    instruction: Instruction,
+    keys: list[Selector | int | str],
+    data: dict[str, Any],
+) -> dict[str, Any]:
+    return cast(
+        dict[str, Any],
+        run_instruction_along_keys(
+            data,
+            instruction=instruction,
+            keys=list(keys),
+        ),
+    )
+
+
+def run_instruction_along_keys(
+    data: Any,
+    *,
+    instruction: Instruction,
+    keys: list[Selector | int | str],
+) -> Any:
+    head: Selector | int | str
+    rest: list[Selector | int | str]
+    if not len(keys):
+        return run_instruction_on_value(data, reverse=instruction.value)
+    head = keys[0]
+    rest = keys[1:]
+    if head is Selector.ALL_KEYS:
+        return run_instruction_on_all_keys(
+            data,
+            instruction=instruction,
+            keys=rest,
+        )
+    if head is Selector.ALL_INDICES:
+        return run_instruction_on_all_indices(
+            data,
+            instruction=instruction,
+            keys=rest,
+        )
+    data[head] = run_instruction_along_keys(
+        data[head],
+        instruction=instruction,
+        keys=rest,
+    )
+    return data
+
+
+def run_instruction_on_all_keys(
+    data: Any,
+    *,
+    instruction: Instruction,
+    keys: list[Selector | int | str],
+) -> Any:
+    key: Any
+    if isinstance(data, dict):
+        for key in list(data.keys()):
+            data[key] = run_instruction_along_keys(
+                data[key],
+                instruction=instruction,
+                keys=keys,
+            )
+        return data
+    raise TypeError(
+        f"Value {data!r} of type {type(data).__name__} has no keys to expand!"
+    )
+
+
+def run_instruction_on_all_indices(
+    data: Any,
+    *,
+    instruction: Instruction,
+    keys: list[Selector | int | str],
+) -> Any:
+    index: int
+    if isinstance(data, list):
+        for index in range(len(data)):
+            data[index] = run_instruction_along_keys(
+                data[index],
+                instruction=instruction,
+                keys=keys,
+            )
+        return data
+    raise TypeError(
+        f"Value {data!r} of type {type(data).__name__} has no indices to expand!"
+    )
+
+
+def run_instruction_on_value(data: Any, *, reverse: bool) -> Any:
+    if isinstance(data, dict):
+        return dict(sorted(data.items(), reverse=reverse))
+    if isinstance(data, list):
+        return list(sorted(data, reverse=reverse))
+    raise TypeError(
+        f"Value {data!r} of type {type(data).__name__} cannot be sorted!"
+    )
+
+
+def run_instructions_on_files(
+    *,
+    absfiles: list[str],
+    parsed: list[tuple[Instruction, list[Selector | int | str]]],
+) -> None:
+    absfile: str
+    data: Any
+    for absfile in absfiles:
+        with open(absfile, "r", encoding="utf-8") as stream:
+            data = json.load(stream)
+        for instruction, keys in parsed:
+            data = run_instruction_on_data(
+                data=data,
+                instruction=instruction,
+                keys=keys,
+            )
+        with open(absfile, "w", encoding="utf-8") as stream:
+            json.dump(data, stream, indent=4)
+            stream.write("\n")

json_sorted/enum/Instruction.py

@@ -0,0 +1,8 @@
+import enum
+
+__all__ = ["Instruction"]
+
+
+class Instruction(enum.Enum):
+    SORT = False
+    SORT_REVERSE = True

json_sorted/enum/Selector.py

@@ -0,0 +1,8 @@
+import enum
+
+__all__ = ["Selector"]
+
+
+class Selector(enum.Enum):
+    ALL_KEYS = enum.auto()
+    ALL_INDICES = enum.auto()

json_sorted-1.0.0.dist-info/METADATA

@@ -0,0 +1,29 @@
+Metadata-Version: 2.4
+Name: json_sorted
+Version: 1.0.0
+Summary: This project sorts JSON data.
+Author-email: Johannes <johannes.programming@gmail.com>
+License-Expression: MIT
+Project-URL: Download, https://pypi.org/project/json_sorted/#files
+Project-URL: Index, https://pypi.org/project/json_sorted/
+Project-URL: Source, https://github.com/johannes-programming/json_sorted/
+Project-URL: Website, https://json-sorted.johannes-programming.online/
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.11
+Description-Content-Type: text/x-rst
+License-File: LICENSE.txt
+Requires-Dist: setdoc<3,>=1.3.14
+Dynamic: license-file
+
+===========
+json_sorted
+===========
+
+Each minor version has its own documentation.
+These docs can be found as rst-files in the ``docs/`` directory of this project.
+They can also be viewed on the website `https://json-sorted.johannes-programming.online/ <https://json-sorted.johannes-programming.online/>`_.

json_sorted-1.0.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+json_sorted/__init__.py,sha256=HR9OhTwybUGbx1IHEjsGASowYSvg9xSK7wW4Jiy67ZQ,269
+json_sorted/__main__.py,sha256=XfsEL112wTYLQ52AvxiVT-d3_zAOrgwoBNIvLlbbmag,68
+json_sorted/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+json_sorted/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+json_sorted/core/main.py,sha256=6okwYlsIvpi86-SPQgBJR75Tk3QIFDkHcKQJQhSvShA,1598
+json_sorted/core/run.py,sha256=w-OIoQ9auQaToKJw6Cy0oCHRcxncT8n0IZVuYhPDtH8,4643
+json_sorted/enum/Instruction.py,sha256=8Txp7qZmM1UIdg9s3tjv2qtZ6xg-NgCDxkFIsQUudpg,112
+json_sorted/enum/Selector.py,sha256=Ap9CVuiAtHTVM5ZCiW_0XK__ygd1Ct7TVA3WEugENT4,122
+json_sorted-1.0.0.dist-info/licenses/LICENSE.txt,sha256=gw3yPLaDFF_WChv7zU7oXjd1QJNufDmFG4J9F9fTkBQ,1075
+json_sorted-1.0.0.dist-info/METADATA,sha256=2hk5GXhJaXcw8rO7lGMtYjm6X32W-QfzbrzfeIN_V1E,1176
+json_sorted-1.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+json_sorted-1.0.0.dist-info/top_level.txt,sha256=Q7dXH0iXbDvlsJg51HodycBsepZOXZamB9llBT36kJc,12
+json_sorted-1.0.0.dist-info/RECORD,,

json_sorted-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

json_sorted-1.0.0.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Johannes
+
+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.

json_sorted-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+json_sorted