Merge pull request #170 from ChrisNeedham24/switchToUserSitePackages

Adjusted pip installs to install to the user site.

Author: ChrisNeedham24

README.md

@@ -42,11 +42,10 @@ Additionally, only x86 architectures are supported.
 
 ## Play from package
 
-1. Run `pip install microcosm-4x`
+1. Run `pip install --user microcosm-4x`
 2. Run `microcosm`
-    1. Note: if this doesn't work, make sure Python's scripts directory is on your PATH.
-       See [here](https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-to-the-user-site) for instructions for Windows
-       (this is not usually a problems on other operating systems).
+    1. Note: if this doesn't work, make sure Python's user scripts directory is on your PATH.
+       See [here](https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-to-the-user-site) for instructions.
 
 ## Play from source
 

source/networking/event_listener.py

@@ -7,7 +7,7 @@
 import socketserver
 import time
 from itertools import chain
-from site import getsitepackages
+from site import getusersitepackages
 from threading import Thread
 from typing import Dict, List, Optional, Set, Tuple, Callable
 
@@ -22,8 +22,7 @@
     # However, clients playing via a pip install or from source will need to load the DLL manually.
     except FileNotFoundError:
         if "microcosm" in sys.modules:
-            site_packages_path: str = next(path for path in getsitepackages() if path.endswith("site-packages"))
-            cdll.LoadLibrary(f"{site_packages_path}/microcosm/source/resources/dll/miniupnpc.dll")
+            cdll.LoadLibrary(f"{getusersitepackages()}/microcosm/source/resources/dll/miniupnpc.dll")
         else:
             cdll.LoadLibrary("source/resources/dll/miniupnpc.dll")
 # We need to disable a lint rule for the miniupnpc import because it doesn't actually declare UPnP in its module. This

source/tests/test_event_listener.py

@@ -101,15 +101,15 @@ def setUp(self, _: MagicMock):
         self.request_handler: RequestHandler = RequestHandler((self.TEST_EVENT_BYTES, self.mock_socket),
                                                               (self.TEST_HOST, self.TEST_PORT), self.mock_server)
 
-    @patch("site.getsitepackages")
+    @patch("site.getusersitepackages")
     @patch("ctypes.cdll.LoadLibrary")
     @patch("ctypes.CDLL")
     @patch("platform.system", return_value="Windows")
     def test_windows_dll_verification(self,
                                       _: MagicMock,
                                       cdll_construction_mock: MagicMock,
                                       cdll_load_mock: MagicMock,
-                                      site_packages_mock: MagicMock):
+                                      user_site_packages_mock: MagicMock):
         """
         Ensure that the miniupnpc DLL is correctly manually loaded or not manually loaded, depending on whether it has
         already been automatically loaded.
@@ -129,16 +129,16 @@ def test_windows_dll_verification(self,
         # manually loaded from source.
         cdll_construction_mock.assert_called_with("miniupnpc.dll")
         cdll_load_mock.assert_called_with("source/resources/dll/miniupnpc.dll")
-        # Simulate the package case by mocking out the site-packages path and sys.modules.
-        site_packages_path: str = "/tmp/site-packages"
-        site_packages_mock.return_value = [site_packages_path]
+        # Simulate the package case by mocking out the user site-packages path and sys.modules.
+        user_site_packages_path: str = "/tmp/site-packages"
+        user_site_packages_mock.return_value = user_site_packages_path
         # This mock is definitely not normal, but it does serve our purpose by defining the key against a real module.
         sys.modules["microcosm"] = event_listener
         importlib.reload(event_listener)
         # In this case, we also expect an attempt to be made to construct the DLL object, but this time we expect the
-        # DLL to be manually loaded from site-packages.
+        # DLL to be manually loaded from user site-packages.
         cdll_construction_mock.assert_called_with("miniupnpc.dll")
-        cdll_load_mock.assert_called_with(f"{site_packages_path}/microcosm/source/resources/dll/miniupnpc.dll")
+        cdll_load_mock.assert_called_with(f"{user_site_packages_path}/microcosm/source/resources/dll/miniupnpc.dll")
 
     def test_handle(self):
         """