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

CHANGELOG.md

@@ -7,12 +7,17 @@ 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).
 
 
-## [v0.3.0 - 2024-01-16]
+## [0.4.0]
+### Fixed
+- Error that prevents monkeytoolbox from being imported on Darwin. #6
+- Import error in `open_new_securely_permissioned_file()` on Windows. #6
+
+## [0.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]
+## [0.2.0] - 2024-01-04
 ### Added
 - `get_os_version()`
 - `get_hostname()`

monkeytoolbox/code_utils.py

@@ -4,7 +4,8 @@ import random
 import secrets
 import string
 from threading import Event, Thread
-from typing import Any, Callable, Iterable, List, MutableMapping, Optional, TypeVar
+from typing import Any, MutableMapping, Optional, TypeVar
+from collections.abc import Iterable, Callable
 
 T = TypeVar("T")
 
@@ -26,7 +27,7 @@ def apply_filters(filters: Iterable[Callable[[T], bool]], iterable: Iterable[T])
     return filtered_iterable
 
 
-def queue_to_list(q: queue.Queue) -> List[Any]:
+def queue_to_list(q: queue.Queue) -> list[Any]:
     list_ = []
     try:
         while True:

monkeytoolbox/decorators.py

@@ -1,6 +1,7 @@
 import threading
 from functools import wraps
-from typing import Any, Callable
+from typing import Any
+from collections.abc import Callable
 
 from eggtimer import EggTimer
 

monkeytoolbox/file_utils.py

@@ -4,7 +4,8 @@ import logging
 import os
 import shutil
 from pathlib import Path
-from typing import BinaryIO, Iterable
+from typing import BinaryIO
+from collections.abc import Iterable
 
 logger = logging.getLogger(__name__)
 

monkeytoolbox/network_utils.py

@@ -1,6 +1,7 @@
 import ipaddress
 from ipaddress import IPv4Address, IPv4Interface
-from typing import Iterable, List, Optional, Sequence
+from typing import Optional
+from collections.abc import Iterable, Sequence
 
 import ifaddr
 import psutil
@@ -10,7 +11,7 @@ def get_my_ip_addresses() -> Sequence[IPv4Address]:
     return [interface.ip for interface in get_network_interfaces()]
 
 
-def get_network_interfaces() -> List[IPv4Interface]:
+def get_network_interfaces() -> list[IPv4Interface]:
     local_interfaces = []
     for adapter in ifaddr.get_adapters():
         for ip in _select_ipv4_ips(adapter.ips):
@@ -41,7 +42,7 @@ def port_is_used(
 def get_connections(
     ports: Optional[Sequence[int]] = None,
     ip_addresses: Optional[Sequence[IPv4Address]] = None,
-) -> List[psutil._common.sconn]:
+) -> list[psutil._common.sconn]:
     connections = psutil.net_connections()
     if ports:
         connections = [connection for connection in connections if connection.laddr.port in ports]

monkeytoolbox/secure_directory.py

@@ -1,17 +1,29 @@
 import logging
 import stat
+import warnings
+from collections.abc import Callable
 from pathlib import Path
-from typing import Callable
 
 from monkeytypes import OperatingSystem
 
 from . import get_os
 
-if get_os() == OperatingSystem.WINDOWS:
-    import win32file
-    import win32security
-
-    from .windows_permissions import get_security_descriptor_for_owner_only_permissions
+try:
+    if get_os() == OperatingSystem.WINDOWS:
+        import win32file
+        import win32security
+
+        from .windows_permissions import get_security_descriptor_for_owner_only_permissions
+except RuntimeError:
+    # The most likely cause of this error is that this module has been imported
+    # on MacOS (Darwin). While the code in this module may or may not function
+    # properly on Darwin, there is code within this package That is platform
+    # agnostic. This error, if not caught, will prevent this entire package
+    # from being imported, which is not the desired behavior.
+    warnings.warn(
+        "OS compatibility check failed: This package may not work properly on this OS.",
+        ImportWarning,
+    )
 
 logger = logging.getLogger(__name__)
 

monkeytoolbox/secure_file.py

@@ -1,20 +1,31 @@
 import logging
 import os
 import stat
+import warnings
+from collections.abc import Generator
 from contextlib import contextmanager
-from typing import Generator
 
 from monkeytypes import OperatingSystem
 
 from . import get_os
 
-if get_os() == OperatingSystem.WINDOWS:
-    import win32file
-    import win32job
-    import win32security
-
-    from .windows_permissions import get_security_descriptor_for_owner_only_permissions
-
+try:
+    if get_os() == OperatingSystem.WINDOWS:
+        import win32file
+        import win32job
+        import win32security
+
+        from .windows_permissions import get_security_descriptor_for_owner_only_permissions
+except RuntimeError:
+    # The most likely cause of this error is that this module has been imported
+    # on MacOS (Darwin). While the code in this module may or may not function
+    # properly on Darwin, there is code within this package That is platform
+    # agnostic. This error, if not caught, will prevent this entire package
+    # from being imported, which is not the desired behavior.
+    warnings.warn(
+        "OS compatibility check failed: This package may not work properly on this OS.",
+        ImportWarning,
+    )
 
 logger = logging.getLogger(__name__)
 

monkeytoolbox/threading.py

@@ -3,7 +3,8 @@ import threading
 from functools import wraps
 from itertools import count
 from threading import Lock, Thread
-from typing import Any, Callable, Iterable, Iterator, Optional, Tuple, TypeVar
+from typing import Any, Iterator, Optional, Tuple, TypeVar
+from collections.abc import Iterable, Callable
 
 from monkeytypes import Event
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: monkeytoolbox
-Version: 0.3.0
+Version: 0.4.0
 Summary: Miscellaneous convenience utilities for Python programs
 Home-page: https://github.com/guardicode/monkeytoolbox
 License: GPLv3
@@ -11,6 +11,7 @@ Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: License :: Other/Proprietary License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: egg-timer
 Requires-Dist: ifaddr
 Requires-Dist: monkey-types

monkeytoolbox-0.4.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+CHANGELOG.md,sha256=Tqt2Ef7bml5W7K8oJUMpX1IRmFUWVWEwpUNgzpjxsTk,775
+README.md,sha256=ZOercnjzgT1CcA3bR_6Pg-i-p-xCUYsj7ShRZi_pfg0,309
+monkeytoolbox/__init__.py,sha256=-m9QOksTBVV53-G7_E4Ykyw0QCVwntmKHV0m62P1JqE,873
+monkeytoolbox/code_utils.py,sha256=ckVLP3LlQKRfq1gvgQiZorcyAENg7_i6tv9eDfK-Au0,5282
+monkeytoolbox/decorators.py,sha256=SfdYY9FTDYEUsb4clOaWzIwetljnL-imRaGTgPLVHuY,2240
+monkeytoolbox/environment.py,sha256=PozYy9gpHKghQnSStWM0ryFtcsmf02WPXmooelYDHDQ,1550
+monkeytoolbox/file_utils.py,sha256=k1142R9FP94Hr193qYBlRZLzJXd_wEWSOR1uJXnDpOI,1895
+monkeytoolbox/network_utils.py,sha256=QtskItC0E-CmhCmFBDBSLsCLbXxaHP8UvczyLK2-rCY,1685
+monkeytoolbox/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+monkeytoolbox/secure_directory.py,sha256=_6CQyUrPXdftt8NY-XIoN7iIoCL4oLxK_6IOR6fqZek,3257
+monkeytoolbox/secure_file.py,sha256=u7g_MQbl9Et3ok-sfHxy07IZXMFfOPHZ7h_sBMIHEGk,3259
+monkeytoolbox/threading.py,sha256=M8gIFZQVdHhQBqzaTCWBdDLiyvXqtJ2LXpEzOYuwjiI,4740
+monkeytoolbox/windows_permissions.py,sha256=jym55x5-fvH2t6_BsixUIGAbkk6ovKkHsGkHkjsqWFM,1845
+monkeytoolbox-0.4.0.dist-info/LICENSE,sha256=8vSVUSGQNLw3jNk-6LogMp9dkBcAS103yGyzS78mIjs,35255
+monkeytoolbox-0.4.0.dist-info/METADATA,sha256=9ZOnsdywR8FFidVAc1kcsvceeuNZd6v_VrtPCyFCUK4,1129
+monkeytoolbox-0.4.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+monkeytoolbox-0.4.0.dist-info/RECORD,,

{monkeytoolbox-0.3.0.dist-info → monkeytoolbox-0.4.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.6.1
+Generator: poetry-core 1.9.0
 Root-Is-Purelib: true
 Tag: py3-none-any

monkeytoolbox-0.3.0.dist-info/RECORD

@@ -1,17 +0,0 @@
-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,,