markoftheweb 1.0.0.0__py3-none-any.whl

markoftheweb/__init__.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+
+"""
+    markoftheweb
+
+    Tools for modeling, parsing, and writing `Zone.Identifier` files and data.
+"""
+
+# (C) Copyright 2025, 2026 Markus Hammer.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License,
+# or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY;
+# without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+# See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.
+# If not, see <https://www.gnu.org/licenses/>.
+
+
+__version__ = "v1.0.0.0"
+
+from .markoftheweb import (ZoneId,  # noqa
+                           normalize_zone_stream_path,
+                           ZoneTransfer,
+                           ZoneTransferCaseSensitiveKeys
+                           )
+
+__all__ = ["ZoneId",
+           "normalize_zone_stream_path",
+           "ZoneTransfer",
+           "ZoneTransferCaseSensitiveKeys"
+           ]

markoftheweb/__main__.py

@@ -0,0 +1,130 @@
+#!/usr/bin/env python
+
+"""
+    __main__
+
+    Contains functions that implement the main entry point
+    for this module.
+    When executed, this will call those entry points.
+"""
+
+# (C) Copyright 2025, 2026 Markus Hammer.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License,
+# or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY;
+# without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+# See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.
+# If not, see <https://www.gnu.org/licenses/>.
+
+
+try:
+    from os import EX_OK
+except ImportError:
+    EX_OK: int = 0  # type:ignore
+from shutil import get_terminal_size
+from typing import NoReturn
+from sys import argv as sys_argv, exit as sys_exit
+from argparse import ArgumentParser
+from logging import getLogger, CRITICAL, WARNING
+
+from .markoftheweb import (ZONE_ID_STREAM_NAME,
+                           ZONE_TRANSFER_SECTION_NAME,
+                           ZoneTransferCaseSensitiveKeys,
+                           normalize_zone_stream_path
+                           )
+
+__all__ = ['main', 'main_entry']
+
+
+def make_line() -> str:
+    """
+    make_line
+
+    Returns a string that prints the horizontal bar (`_`)
+    character to properly fill the current size of the terminal.
+    """
+    return "_" * max(get_terminal_size()[0], 3)
+
+
+def main(*argv) -> int:
+    """
+    main
+
+    The main entry point for this module.
+    Expects for argv to be provided manually.
+
+    Returns:
+        The exit code.
+    """
+
+    parser = ArgumentParser(
+        prog = argv[0],
+        description="Process Zone Transfer data from provided paths."
+    )
+    parser.add_argument(
+        "paths",
+        nargs="+",
+        help="Paths to process"
+    )
+    parser.add_argument(
+        "-q",
+        "--quiet",
+        action="store_true",
+        help="Suppress warnings and errors"
+    )
+
+    args = parser.parse_args(argv[1:])
+
+    logger = getLogger()
+    logger.setLevel(CRITICAL if args.quiet else WARNING)
+
+    for raw_path in args.paths:
+        try:
+            path = normalize_zone_stream_path(raw_path)
+            zone_trans = ZoneTransferCaseSensitiveKeys.from_path(path)
+        except FileNotFoundError:
+            logger.warning("%s\npath %s does not exist, ignoring...", make_line(), raw_path)
+            continue
+        except Exception as e:  # pylint:disable=broad-exception-caught
+            make_line()
+            logger.error("%s\nfailed processing %s : %s", make_line(), raw_path, e)
+            continue
+
+        if zone_trans is not None:
+            print(make_line())
+            print(f"{ZONE_ID_STREAM_NAME}'s {ZONE_TRANSFER_SECTION_NAME} data found for {path}:")
+            print()
+
+            lin = zone_trans.str_dump().splitlines()
+            print(lin.pop(0).strip())
+            print(*(" " * 3 + s.strip() for s in lin if s.strip()), sep="\n")
+
+    print(make_line())
+    print("Complete")
+
+    return EX_OK
+
+
+def main_entry() -> NoReturn:
+    """
+    main_entry
+
+    Calls `main` with the arguments provided by `sys.argv`,
+    and exits with the returned exit code.
+
+    Does not return (exits).
+    """
+    sys_exit(main(*sys_argv))
+
+
+if __name__ == "__main__":
+    main_entry()

markoftheweb/_type_imports.py

@@ -0,0 +1,91 @@
+#!/usr/bin/env python
+
+"""
+    _type_imports
+
+    Various imports related to type annotations.
+    Not expected to be imported on its own.
+"""
+
+# (C) Copyright 2025, 2026 Markus Hammer.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License,
+# or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY;
+# without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+# See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.
+# If not, see <https://www.gnu.org/licenses/>.
+
+
+# pylint:disable=unused-import, ungrouped-imports
+
+__all__ = [
+    'Final',
+    'Literal',
+    'PathLike',
+    'FrozenSet',
+    'LiteralString',
+    'IO',
+    'TextIOBase',
+    'Iterable',
+    'Set',
+    'Mapping',
+    'Type',
+]
+
+try:
+    from typing_extensions import Final
+except ImportError:
+    from typing import Final  # noqa
+
+try:
+    from typing_extensions import Literal
+except ImportError:
+    from typing import Literal  # noqa
+
+try:
+    from typing_extensions import LiteralString
+except ImportError:
+    from typing import LiteralString  # noqa
+
+try:
+    from typing_extensions import Type
+except ImportError:
+    from typing import Type  # noqa
+
+try:
+    from typing_extensions import Iterable
+except ImportError:
+    from typing import Iterable  # noqa
+
+try:
+    from typing_extensions import Mapping
+except ImportError:
+    from typing import Mapping  # noqa
+
+try:
+    from typing_extensions import Set
+except ImportError:
+    from typing import Set  # noqa
+
+try:
+    from typing_extensions import FrozenSet
+except ImportError:
+    from typing import FrozenSet  # noqa
+
+from os import PathLike  # noqa
+
+try:
+    from typing_extensions import IO
+except ImportError:
+    from typing import IO  # noqa
+
+from io import TextIOBase  # noqa