monkeytoolbox 0.1.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

CHANGELOG.md

@@ -7,9 +7,16 @@ Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to
 the [PEP 440 version scheme](https://peps.python.org/pep-0440/#version-scheme).
 
 
-## [Unreleased]
+## [v0.3.0 - 2024-01-16]
+### Fixed
+- The location of the `py.typed` file so that type checking is now properly
+  supported
+
+## [v0.2.0 - 2024-01-04]
 ### Added
+- `get_os_version()`
+- `get_hostname()`
+- Support for type checking (py.typed marker file)
+
 ### Changed
-### Fixed
-### Removed
-### Security
+- `get_os()` raises `RuntimeError` if the operating system is not supported

monkeytoolbox/__init__.py

@@ -1,4 +1,4 @@
-from .environment import get_os, get_hardware_id
+from .environment import get_hardware_id, get_hostname, get_os, get_os_version
 from .decorators import request_cache
 from .code_utils import (
     apply_filters,
@@ -6,7 +6,7 @@ from .code_utils import (
     del_key,
     insecure_generate_random_string,
     secure_generate_random_string,
-    PeriodicCaller
+    PeriodicCaller,
 )
 from .file_utils import (
     append_bytes,
@@ -15,20 +15,16 @@ from .file_utils import (
     expand_path,
     get_text_file_contents,
     get_all_regular_files_in_directory,
-    get_binary_io_sha256_hash
+    get_binary_io_sha256_hash,
 )
 from .secure_directory import create_secure_directory
 from .secure_file import open_new_securely_permissioned_file
 from .threading import (
-    ThreadSafeIterator, 
-    InterruptableThreadMixin, 
-    interruptible_function, 
+    ThreadSafeIterator,
+    InterruptableThreadMixin,
+    interruptible_function,
     interruptible_iter,
     create_daemon_thread,
-    run_worker_threads
-)
-from .network_utils import (
-    port_is_used, 
-    get_network_interfaces, 
-    get_my_ip_addresses
+    run_worker_threads,
 )
+from .network_utils import port_is_used, get_network_interfaces, get_my_ip_addresses

monkeytoolbox/decorators.py

@@ -2,7 +2,7 @@ import threading
 from functools import wraps
 from typing import Any, Callable
 
-from egg_timer import EggTimer
+from eggtimer import EggTimer
 
 
 def request_cache(ttl: float):

monkeytoolbox/environment.py

@@ -1,4 +1,5 @@
 import platform
+import socket
 import uuid
 from contextlib import suppress
 
@@ -6,10 +7,21 @@ from monkeytypes import HardwareID, OperatingSystem
 
 
 def get_os() -> OperatingSystem:
-    if platform.system() == "Windows":
+    """
+    Get the OperatingSystem of the current execution environment.
+
+    :return: The OperatingSystem of the current execution environment
+    :raises: RuntimeError if the current OperatingSystem is not supported
+    """
+    system = platform.system()
+
+    if system == "Windows":
         return OperatingSystem.WINDOWS
 
-    return OperatingSystem.LINUX
+    if system == "Linux":
+        return OperatingSystem.LINUX
+
+    raise RuntimeError(f"'{system}' is not a supported operating system")
 
 
 def get_hardware_id() -> HardwareID:
@@ -36,3 +48,11 @@ def _get_hardware_id_linux() -> HardwareID:
         machine_id = uuid.getnode()
 
     return machine_id
+
+
+def get_os_version() -> str:
+    return platform.platform()
+
+
+def get_hostname():
+    return socket.gethostname()

monkeytoolbox/secure_directory.py

@@ -3,10 +3,10 @@ import stat
 from pathlib import Path
 from typing import Callable
 
-from . import get_os
-
 from monkeytypes import OperatingSystem
 
+from . import get_os
+
 if get_os() == OperatingSystem.WINDOWS:
     import win32file
     import win32security
@@ -74,9 +74,7 @@ def _make_existing_directory_secure_windows(path: Path):
 
 def _create_secure_directory_windows(path: Path):
     security_attributes = win32security.SECURITY_ATTRIBUTES()
-    security_attributes.SECURITY_DESCRIPTOR = (
-        get_security_descriptor_for_owner_only_permissions()
-    )
+    security_attributes.SECURITY_DESCRIPTOR = get_security_descriptor_for_owner_only_permissions()
     win32file.CreateDirectory(str(path), security_attributes)
 
 

monkeytoolbox/secure_file.py

@@ -4,9 +4,10 @@ import stat
 from contextlib import contextmanager
 from typing import Generator
 
-from . import get_os
 from monkeytypes import OperatingSystem
 
+from . import get_os
+
 if get_os() == OperatingSystem.WINDOWS:
     import win32file
     import win32job

monkeytoolbox/threading.py

@@ -10,25 +10,30 @@ from monkeytypes import Event
 logger = logging.getLogger(__name__)
 
 
-def run_worker_threads(
-    target: Callable[..., None],
-    name_prefix: str,
-    args: Tuple = (),
-    num_workers: int = 2,
-):
-    worker_threads = []
-    counter = run_worker_threads.counters.setdefault(name_prefix, count(start=1))
-    for i in range(0, num_workers):
-        name = f"{name_prefix}-{next(counter):02d}"
-        t = create_daemon_thread(target=target, name=name, args=args)
-        t.start()
-        worker_threads.append(t)
-
-    for t in worker_threads:
-        t.join()
-
-
-run_worker_threads.counters = {}
+class RunWorkerThreads:
+    def __init__(self):
+        self._counters = {}
+
+    def __call__(
+        self,
+        target: Callable[..., None],
+        name_prefix: str,
+        args: Tuple = (),
+        num_workers: int = 2,
+    ):
+        worker_threads = []
+        counter = self._counters.setdefault(name_prefix, count(start=1))
+        for i in range(0, num_workers):
+            name = f"{name_prefix}-{next(counter):02d}"
+            t = create_daemon_thread(target=target, name=name, args=args)
+            t.start()
+            worker_threads.append(t)
+
+        for t in worker_threads:
+            t.join()
+
+
+run_worker_threads = RunWorkerThreads()
 
 
 def create_daemon_thread(target: Callable[..., None], name: str, args: Tuple = ()) -> Thread:

{monkeytoolbox-0.1.0.dist-info → monkeytoolbox-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: monkeytoolbox
-Version: 0.1.0
+Version: 0.3.0
 Summary: Miscellaneous convenience utilities for Python programs
 Home-page: https://github.com/guardicode/monkeytoolbox
 License: GPLv3

monkeytoolbox-0.3.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+CHANGELOG.md,sha256=DiqJ_RNfNl6h1Aqfc-PpuYOcpfv8tzuq36eGruZC0cQ,612
+README.md,sha256=ZOercnjzgT1CcA3bR_6Pg-i-p-xCUYsj7ShRZi_pfg0,309
+monkeytoolbox/__init__.py,sha256=-m9QOksTBVV53-G7_E4Ykyw0QCVwntmKHV0m62P1JqE,873
+monkeytoolbox/code_utils.py,sha256=3JefNrkhMJnxsfFBtKN9Ki9Qa-t_cXeBi7Pu-RfmfOs,5261
+monkeytoolbox/decorators.py,sha256=baXV_UuH-a-3j3RJ3NhFLq0MoVcu6efSblBvEKSilCA,2213
+monkeytoolbox/environment.py,sha256=PozYy9gpHKghQnSStWM0ryFtcsmf02WPXmooelYDHDQ,1550
+monkeytoolbox/file_utils.py,sha256=6fUtFd9k0Eb-5e38fDQAPPGMHqALcpvu8vezhWvH7R0,1868
+monkeytoolbox/network_utils.py,sha256=grdmj8l5hBmTh1Fy9UO1j2j6gIBqsN4i09Zao0785E0,1664
+monkeytoolbox/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+monkeytoolbox/secure_directory.py,sha256=h0gWiho_xSuNZrUp0Bxt_8uzdWkNo3sFMiN-0TFM5o4,2679
+monkeytoolbox/secure_file.py,sha256=b1SVsjC7H6rJNn7eUU2bgeG-5ru0duaaiM1vv7py314,2678
+monkeytoolbox/threading.py,sha256=QYmWERGsRRrFEAcM2pdlNzw3Z-9rTnevTf6LFDOLo8U,4713
+monkeytoolbox/windows_permissions.py,sha256=jym55x5-fvH2t6_BsixUIGAbkk6ovKkHsGkHkjsqWFM,1845
+monkeytoolbox-0.3.0.dist-info/LICENSE,sha256=8vSVUSGQNLw3jNk-6LogMp9dkBcAS103yGyzS78mIjs,35255
+monkeytoolbox-0.3.0.dist-info/METADATA,sha256=dbA9m_djyx3av_liwNxcShiFSqltpXSMydQpKr-YqXA,1078
+monkeytoolbox-0.3.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+monkeytoolbox-0.3.0.dist-info/RECORD,,

monkeytoolbox-0.1.0.dist-info/RECORD

@@ -1,16 +0,0 @@
-CHANGELOG.md,sha256=j-PoKpkEAxKG2Yc69glm5esCQojGbz2FtWjc1840z98,346
-README.md,sha256=ZOercnjzgT1CcA3bR_6Pg-i-p-xCUYsj7ShRZi_pfg0,309
-monkeytoolbox/__init__.py,sha256=tuvDfZx3XsucGnsoLjFaIW7O_iRjRb2L5-NvuuQDPYU,861
-monkeytoolbox/code_utils.py,sha256=3JefNrkhMJnxsfFBtKN9Ki9Qa-t_cXeBi7Pu-RfmfOs,5261
-monkeytoolbox/decorators.py,sha256=qsQZzeugiSJv5nmgVgx4TEfgO1DDgHFUbMopcEv9GgI,2214
-monkeytoolbox/environment.py,sha256=p3IYsFYqlcGj3rVF-Tp4-qaXqD_fQ-MOQw48P460fYo,1067
-monkeytoolbox/file_utils.py,sha256=6fUtFd9k0Eb-5e38fDQAPPGMHqALcpvu8vezhWvH7R0,1868
-monkeytoolbox/network_utils.py,sha256=grdmj8l5hBmTh1Fy9UO1j2j6gIBqsN4i09Zao0785E0,1664
-monkeytoolbox/secure_directory.py,sha256=FMtriWLY04m8YXGHEe_gEZfeCBJ0IpLhmyH8HvN7BCc,2695
-monkeytoolbox/secure_file.py,sha256=aAXwoqtIdhlkykajNqMLmafTt5HeN14f5zrFgbPKcHU,2677
-monkeytoolbox/threading.py,sha256=6Z2PHhLigOXxLOhE3WniabQ5HgNlqQNTTBPM6xi66e4,4578
-monkeytoolbox/windows_permissions.py,sha256=jym55x5-fvH2t6_BsixUIGAbkk6ovKkHsGkHkjsqWFM,1845
-monkeytoolbox-0.1.0.dist-info/LICENSE,sha256=8vSVUSGQNLw3jNk-6LogMp9dkBcAS103yGyzS78mIjs,35255
-monkeytoolbox-0.1.0.dist-info/METADATA,sha256=raF0lxDlgkOIlySAS6GYK9511JEwNe5ODexJtyWKAng,1078
-monkeytoolbox-0.1.0.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-monkeytoolbox-0.1.0.dist-info/RECORD,,