Refactors, Renaming, & Format Changes

---

- Renamed multiple vars/classes across entire project.
- Placed `_get_stable_assets` & `_get_dev_assets` into `_PatcherAssets` class.
- Improvements to method docstrings.
- Changed default log msg format.
- Improved consistency of console/log strings.
- Added patch version to download message.
- Removed unnecessary exception vars from error handling.
- Changes to "./README.md".

Signed-off-by: schlopp96 <[email protected]>

Author: schlopp96

README.md

@@ -67,12 +67,12 @@
 
 2. Once the script is run, you will be presented with an option menu, allowing you to choose from the following commands:
 
-   - Patch BepInEx to the latest stable release.
-   - Patch BepInEx to the latest developmental/experimental "bleeding-edge" build.
-   - Patch BepInEx first with the latest stable release, and **then** with the latest experimental build to ensure a safe installation.
-   - Check for and download new releases/builds of BepInEx.
-   - Start Valheim.
-   - Exit the application.
+   - **[1].** Patch BepInEx to the latest stable release.
+   - **[2].** Patch BepInEx to the latest developmental/experimental "bleeding-edge" build.
+   - **[3].** Patch BepInEx first with the latest stable release, and **then** with the latest experimental build to ensure a safe installation.
+   - **[4].** Check for and download new releases/builds of BepInEx.
+   - **[5].** Start Valheim.
+   - **[6].** Exit the application.
 
 3. Once an option is chosen, you will then be asked to confirm that the correct option/location is chosen.
 
@@ -84,13 +84,7 @@
 
 6. If you choose to **NOT** run the game, the patcher will return to the main menu.
 
-- **_NOTE:_**
-
-  - BepInEx will list its current version as the last stable build number, even if a bleeding-edge build is installed. It will still work all the same.
-
-  - If you wish to verify, you can either compare the files contained in the patch to the ones you have on your machine using a diff tool, or simply side-to-side by eye.
-
-  - **_Note that you can also find the latest bleeding-edge-builds of BepInEx [here](https://builds.bepis.io/projects/bepinex_be)._**
+- **_Note that you can also find the latest bleeding-edge-builds of BepInEx [here](https://builds.bepis.io/projects/bepinex_be)._**
 
 ---
 

VBPatcher/appglobals/globals.py

@@ -5,76 +5,99 @@
 from requests import Response
 
 
-def _get_stable_assets(url: str, mode: int) -> str:
-    """Send GET request to retrieve BepInEx stable release assets, depending on value passed to :param:`mode`.
-
-    - If :param:`mode` == `1`, get patch archive download link.
-    - If :param:`mode` != `1`, get patch release version number as string.
+class _PatcherAssets:
+    """Wrapper for retrieving necessary patcher assets.
 
     ---
 
-    :param url: URL for the new :class:`Request` object.
-    :type url: :class:`str` | :class:`PathLike`
-    :param mode: specifies values to retrieve from response.
-    :type mode: :class:`int`
-    :return: response content from GET request.
-    :rtype: :class:`str`
+    Contained Methods:
+
+        - :func:`_get_stable_assets(url, mode) -> str`
+            - Send GET request to retrieve BepInEx stable build assets, depending on value passed to :param:`mode`.
+            - Static method.
+
+        - :func:`_get_dev_assets(url, mode) -> str`
+            - Send GET request to retrieve BepInEx dev/bleeding-edge build assets, depending on value passed to :param:`mode`.
+            - Static method.
     """
 
-    r: Response = req.get(url, 'html.parser')  # Send GET request.
-    r.raise_for_status()  # Raise exception if response is not 200.
+    @staticmethod
+    def _get_stable_assets(url: str, mode: int) -> str:
+        """Send GET request to retrieve BepInEx stable build assets, depending on value passed to :param:`mode`.
 
-    dl_link: str = r.json()['assets'][1][
-        'browser_download_url']  # Get download link.
-    patch_ver: str = r.json()['assets'][1]['name'][12:20]  # Get patch version.
+        - If :param:`mode` == `1`, get patch archive download link.
+        - If :param:`mode` != `1`, get patch version number as string.
 
-    return dl_link if mode == 1 else patch_ver
+        ---
 
+        :param url: URL for the new :class:`Request` object.
+        :type url: :class:`str` | :class:`PathLike`
+        :param mode: specifies which values to retrieve from response.
+        :type mode: :class:`int`
+        :return: response content from GET request.
+        :rtype: :class:`str`
+        """
 
-def _get_dev_assets(url: str, mode: int) -> str:
-    """Send GET request to retrieve BepInEx dev/bleeding-edge release assets, depending on value passed to :param:`mode`.
+        r: Response = req.get(url, 'html.parser')  # Send GET request.
+        r.raise_for_status()  # Raise exception if response is not 200.
 
-    - If :param:`mode` == `1`, get patch archive download link.
-    - If :param:`mode` != `1`, get patch version number as string.
+        dl_link: str = r.json()['assets'][1][
+            'browser_download_url']  # Get download link.
+        patch_ver: str = r.json()['assets'][1]['name'][
+            12:20]  # Get patch version.
 
-    ---
+        return dl_link if mode == 1 else patch_ver
 
-    :param url: URL for the new :class:`Request` object.
-    :type url: :class:`str` | :class:`PathLike`
-    :param mode: specifies values to retrieve from response.
-    :type mode: :class:`int`
-    :return: response content from GET request.
-    :rtype: :class:`str`
-    """
+    @staticmethod
+    def _get_dev_assets(url: str, mode: int) -> str:
+        """Send GET request to retrieve BepInEx dev/bleeding-edge build assets, depending on value passed to :param:`mode`.
 
-    retrieved: int = 0
+        - If :param:`mode` == `1`, get patch archive download link.
+        - If :param:`mode` != `1`, get patch version number as string.
 
-    r: Response = req.get(url)  # Send GET request.
-    r.raise_for_status()  # Raise exception if error code is returned.
+        ---
 
-    soup = bs4.BeautifulSoup(r.content, 'html.parser')  # Parse response HTML.
-    results = soup.find_all(
-        'div', class_="artifacts-list"
-    )  # Get all <div> tags with class="artifacts-list".
+        :param url: URL for the new :class:`Request` object.
+        :type url: :class:`str` | :class:`PathLike`
+        :param mode: specifies values to retrieve from response.
+        :type mode: :class:`int`
+        :return: response content from GET request.
+        :rtype: :class:`str`
+        """
 
-    for result in results:
-        if retrieved < 1:  # Only get 2nd <div> tag.
-            link = result.find_all('a')[1]['href']  # Get download link.
-            retrieved += 1
+        retrieved: int = 0
 
-    dl_link = (f'{url[:26]}{link}')  # Combine URL and download link.
+        r: Response = req.get(url)  # Send GET request.
+        r.raise_for_status()  # Raise exception if error code is returned.
 
-    return dl_link if mode == 1 else dl_link[93:100]
+        soup = bs4.BeautifulSoup(r.content,
+                                 'html.parser')  # Parse response HTML.
+        results = soup.find_all(
+            'div', class_="artifacts-list"
+        )  # Get all <div> tags with class="artifacts-list".
+
+        for result in results:
+            if retrieved < 1:  # Only get 2nd <div> tag.
+                link = result.find_all('a')[1]['href']  # Get download link.
+                retrieved += 1
+
+        dl_link = (f'{url[:26]}{link}')  # Combine URL and download link.
+
+        return dl_link if mode == 1 else dl_link[93:100]
 
 
 class _Getch:
-    """Gets a single character from standard input.  Does not echo to the screen."""
+    """Retrieve single character from standard input. Does not echo to the screen.
+
+    - If system is running on Windows-based OS, initialize :class:`_GetchWindows` class.
+    - If system is running on UNIX-based OS, initialize :class:`_GetchUnix` class.
+    """
 
     def __init__(self):
         try:
-            self.impl = _GetchWindows()
+            self.impl = _GetchWindows()  # Windows compatible.
         except ImportError:
-            self.impl = _GetchUnix()
+            self.impl = _GetchUnix()  # UNIX compatible
 
     def __call__(self):
         char = self.impl()
@@ -86,11 +109,7 @@ def __call__(self):
 
 
 class _GetchUnix:
-    """UNIX-compatible `getch` method for reading single character from standard input. Does not echo to screen."""
-
-    def __init__(self):
-        import sys
-        import tty
+    """UNIX-compatible `getch()` method for reading single character from standard input. Does not echo to screen."""
 
     def __call__(self):
         import sys
@@ -107,42 +126,40 @@ def __call__(self):
 
 
 class _GetchWindows:
-    """Windows-compatible `getch` method for reading single character from standard input.  Does not echo to screen."""
-
-    def __init__(self):
-        import msvcrt
+    """Windows-compatible `getch()` method for reading single character from standard input.  Does not echo to screen."""
 
     def __call__(self):
         import msvcrt
         return msvcrt.getch()
 
 
-getch = _Getch()
+__version__: str = '0.9.0'  # Current program version number
 
-__version__: str = '0.9.0'
+getch: _Getch = _Getch()  # Initialized `_Getch` instance.
 
-p_stable: str = r'.\patch-files\stable'  # Stable patch file location
+patch_stable: str = r'.\patch-files\stable'  # Stable patch file location
 
-url_stable: str = _get_stable_assets(
+url_stable: str = _PatcherAssets._get_stable_assets(
     'http://api.github.com/repos/BepInEx/BepInEx/releases/latest',
     1)  # stable release download link
 
-b_stable: str = _get_stable_assets(
+ver_stable: str = _PatcherAssets._get_stable_assets(
     'http://api.github.com/repos/BepInEx/BepInEx/releases/latest',
     2)  # stable release version
 
-p_dev: str = r'.\patch-files\development'  # Development patch file location
+patch_dev: str = r'.\patch-files\development'  # Development patch file location
 
-url_dev: str = _get_dev_assets(
+url_dev: str = _PatcherAssets._get_dev_assets(
     'https://builds.bepinex.dev/projects/bepinex_be',
     1)  # dev/bleeding-edge build download link
 
-b_dev: str = _get_dev_assets('https://builds.bepinex.dev/projects/bepinex_be',
-                             2)  # dev/bleeding-edge build number
+ver_dev: str = _PatcherAssets._get_dev_assets(
+    'https://builds.bepinex.dev/projects/bepinex_be',
+    2)  # dev/bleeding-edge build number
 
-p_targetDir: str = r'C:\Program Files (x86)\Steam\steamapps\common\Valheim'  # target directory to patch
+patch_targetDir: str = r'C:\Program Files (x86)\Steam\steamapps\common\Valheim'  # target directory to patch
 
-logFile: str = r'.\logs\VBPatcherLog.log'  # Log file path
+log_fh: str = r'.\logs\VBPatcherLog.log'  # Log file path
 
 datefmt: str = datetime.now().strftime(
     "%Y-%m-%d %H:%M:%S"

VBPatcher/apploggers/loggers.py

@@ -1,6 +1,6 @@
 import logging
 
-from VBPatcher.appglobals.globals import logFile
+from VBPatcher.appglobals.globals import log_fh
 
 
 class _LogGenerator():
@@ -37,15 +37,13 @@ class _LogGenerator():
     DEBUG = 10
     NOTSET = 0
 
-    def __init__(
-            self,
-            name: str,
-            log_file: str,
-            log_format:
-        str = '[ %(levelname)s - %(asctime)s - %(name)s ] : %(message)s',
-            datefmt: str = "%Y-%m-%d %H:%M:%S",
-            level: int = INFO,
-            stream: bool = False):
+    def __init__(self,
+                 name: str,
+                 log_file: str,
+                 log_format: str = '[ %(asctime)s - %(name)s ] : %(message)s',
+                 datefmt: str = "%Y-%m-%d %H:%M:%S",
+                 level: int = INFO,
+                 stream: bool = False):
         """Initialize logger instance.
 
         - For the :param:`log_lvl` parameter, the level of logging can be any of the following:
@@ -138,7 +136,7 @@ def error(self, msg) -> None:
         :return: creates log entry.
         :rtype: `None`
         """
-        return self.logger.error(msg)
+        return self.logger.error(msg, exc_info=True)
 
     def critical(self, msg) -> None:
         """Logs a message with level `CRITICAL`.
@@ -153,7 +151,7 @@ def critical(self, msg) -> None:
         return self.logger.critical(msg)
 
 
-logger: _LogGenerator = _LogGenerator('MAIN', logFile)  # Main logging instance
+logger: _LogGenerator = _LogGenerator('MAIN', log_fh)  # Main logging instance
 
 logger_stream: _LogGenerator = _LogGenerator(
-    'STDOUT', logFile, stream=True)  # Stdout streaming logging instance
+    'STDOUT', log_fh, stream=True)  # Stdout streaming logging instance