Code cleanups.

Author: karel26

core/data/dataobject.py

@@ -4,7 +4,7 @@
 
 from configparser import ConfigParser
 from dataclasses import dataclass, field
-from typing import TYPE_CHECKING, Callable, Type, Optional, TypeVar, Generic
+from typing import TYPE_CHECKING, Callable, Type, Optional, TypeVar, Generic, ClassVar, Any
 
 if TYPE_CHECKING:
     from core import Node
@@ -41,23 +41,73 @@ def __hash__(self):
 
 
 class DataObjectFactory(Generic[T]):
-    _instance: Optional[DataObjectFactory] = None
-    _registry: dict[Type[T], Type[T]] = {}
-
-    def __new__(cls) -> DataObjectFactory:
+    """
+    A singleton factory for creating data objects with registration support.
+
+    This class provides a central registry for data object types and a factory
+    method for instantiating them. It uses a singleton pattern to ensure a single
+    instance is shared across the application.
+
+    Type Parameters:
+        T: The base type for objects created by this factory
+
+    Attributes:
+        _instance: The singleton instance of this class
+        _registry: Dictionary mapping object types to their implementation classes
+    """
+    _instance: Optional['DataObjectFactory[T]'] = None
+    # Using class variable storage that's independent of the generic type parameter
+    _registry: ClassVar[dict[Any, Any]] = {}
+
+    def __new__(cls) -> 'DataObjectFactory[T]':
+        """
+        Creates a singleton instance of the factory.
+
+        Returns:
+            The singleton instance of DataObjectFactory
+        """
         if cls._instance is None:
             cls._instance = super(DataObjectFactory, cls).__new__(cls)
         return cls._instance
 
     @classmethod
     def register(cls, t: Optional[Type[T]] = None) -> Callable[[Type[T]], Type[T]]:
+        """
+        Decorator for registering implementation classes with the factory.
+
+        Args:
+            t: Optional type to use as the registration key. If not provided,
+               the implementation class itself is used as the key.
+
+        Returns:
+            A decorator function that registers the decorated class
+
+        Example:
+            @DataObjectFactory.register(BaseClass)
+            class Implementation(BaseClass):
+                pass
+        """
+
         def inner_wrapper(wrapped_class: Type[T]) -> Type[T]:
-            cls._registry[t or wrapped_class] = wrapped_class
+            DataObjectFactory._registry[t or wrapped_class] = wrapped_class
             return wrapped_class
 
         return inner_wrapper
 
     @classmethod
     def new(cls, t: Type[T], **kwargs) -> T:
+        """
+        Creates a new instance of the registered implementation class.
+
+        Args:
+            t: The type to instantiate (must be registered)
+            **kwargs: Arguments to pass to the constructor
+
+        Returns:
+            A new instance of the requested type
+
+        Raises:
+            KeyError: If the requested type is not registered
+        """
         # noinspection PyArgumentList
-        return cls._registry[t](**kwargs)
+        return DataObjectFactory._registry[t](**kwargs)

core/data/impl/nodeimpl.py

@@ -159,7 +159,7 @@ async def post_init(self):
             self._master = await self.heartbeat()
             self.log.info("- Starting as {} ...".format("Single / Master" if self._master else "Agent"))
         except (UndefinedTable, InFailedSqlTransaction):
-            # some master tables have changed, so do the update first
+            # some master tables have changed, do the update first
             self._master = True
         if self._master:
             try:
@@ -511,7 +511,7 @@ async def upgrade_pending(self) -> bool:
         return rc
 
     async def _upgrade(self, conn: psycopg.AsyncConnection):
-        # We do not want to run an upgrade, if we are on a cloud drive, so just restart in this case
+        # We do not want to run an upgrade if we are on a cloud drive. Just restart in this case.
         if not self.master and self.locals.get('cloud_drive', True):
             await self.restart()
         elif await self.upgrade_pending():
@@ -1041,7 +1041,7 @@ async def rename_server(self, server: Server, new_name: str):
             await ServiceRegistry.get(BotService).rename_server(server, new_name)
         # update the ServiceBus
         ServiceRegistry.get(ServiceBus).rename_server(server, new_name)
-        # change the proxy name for remote servers (local ones will be renamed by ServerImpl)
+        # change the proxy name for remote servers (ServerImpl will rename local ones)
         if server.is_remote:
             server.name = new_name
 
@@ -1197,7 +1197,7 @@ async def add_instance(self, name: str, *, template: str = "") -> "Instance":
                 shutil.copy2(os.path.expandvars(_template.extensions['SRS']['config']),
                              os.path.join(instance.home, 'Config', 'SRS.cfg'))
         else:
-            # copy default files, if they exist
+            # copy default files if they exist
             if os.path.exists(os.path.join(self.config_dir, 'autoexec.cfg')):
                 shutil.copy2(os.path.join(self.config_dir, 'autoexec.cfg'),
                              os.path.join(instance.home, 'Config'))
@@ -1292,7 +1292,7 @@ def change_instance_in_path(data):
             await asyncio.to_thread(instance.server.stop_observer)
 
         try:
-            # test rename it, to make sure it works
+            # test-rename it to make sure it works
             new_home = os.path.join(os.path.dirname(instance.home), new_name)
             os.rename(instance.home, new_home)
             os.rename(new_home, instance.home)

core/data/impl/serverimpl.py

@@ -32,7 +32,7 @@
 from pathlib import Path
 from typing import Optional, TYPE_CHECKING, Union, Any
 from watchdog.events import FileSystemEventHandler, FileSystemEvent, FileSystemMovedEvent
-from watchdog.observers import Observer
+from watchdog.observers import Observer, ObserverType
 
 # ruamel YAML support
 from ruamel.yaml import YAML
@@ -86,7 +86,7 @@ def on_deleted(self, event: FileSystemEvent):
         if path in missions:
             idx = missions.index(path) + 1
             asyncio.run_coroutine_threadsafe(self.server.deleteMission(idx), self.loop)
-            # cache the index of the line to re-add the file at the correct position afterwards,
+            # cache the index of the line to re-add the file at the correct position afterward
             # if a cloud drive did a delete/add instead of a modification
             self.deleted[path] = idx
             self.log.info(f"=> Mission {os.path.basename(path)[:-4]} deleted from server {self.server.name}.")
@@ -99,7 +99,7 @@ def on_deleted(self, event: FileSystemEvent):
 class ServerImpl(Server):
     bot: Optional[DCSServerBot] = field(compare=False, init=False)
     event_handler: MissionFileSystemEventHandler = field(compare=False, default=None)
-    observer: Observer = field(compare=False, default=None)
+    observer: ObserverType = field(compare=False, default=None)
 
     def __post_init__(self):
         super().__post_init__()

core/mizfile.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import datetime
 import importlib
 import io
 import logging
@@ -13,7 +14,7 @@
 from astral import LocationInfo
 from astral.sun import sun
 from core import utils
-from datetime import datetime, timedelta, date
+from datetime import datetime, timedelta
 from packaging.version import parse, Version
 from timezonefinder import TimezoneFinder
 from typing import Union, Optional
@@ -220,12 +221,12 @@ def start_time(self, value: int) -> None:
         self.mission['start_time'] = value
 
     @property
-    def date(self) -> date:
+    def date(self) -> datetime.date:
         value = self.mission['date']
-        return date(value['Year'], value['Month'], value['Day'])
+        return datetime.date(value['Year'], value['Month'], value['Day'])
 
     @date.setter
-    def date(self, value: date) -> None:
+    def date(self, value: datetime.date) -> None:
         self.mission['date'] = {"Day": value.day, "Year": value.year, "Month": value.month}
 
     @property

core/utils/discord.py

@@ -911,26 +911,46 @@ def get_all_linked_members(interaction: discord.Interaction) -> list[discord.Mem
 
 class ServerTransformer(app_commands.Transformer):
     """
-
-    :class:`ServerTransformer` is a class that is used for transforming and autocompleting servers as a selection for application commands.
-
-    .. attribute:: status
-
-        An optional attribute that specifies the list of status values to filter the servers by.
-
-        :type: list of :class:`Status`
-        :default: None
-
-    :param status: An optional parameter that specifies the list of status values to filter the servers by.
-    :type status: list of :class:`Status`
-
+    A transformer for Discord application commands that handles server selection.
+
+    This class converts string inputs into Server objects and provides autocomplete
+    functionality for server selection in slash commands.
+
+    Attributes:
+        status (list[Status]): Optional list of status values to filter servers by.
+        maintenance (bool): Optional filter for servers in maintenance mode.
+
+    Example:
+        ```python
+        @app_commands.command(name="restart")
+        async def restart_server(
+            interaction: discord.Interaction,
+            server: app_commands.Transform[Server, ServerTransformer(status=[Status.RUNNING])]
+        ):
+            # Command will only show running servers in autocomplete
+            await server.restart()
+        ```
     """
+
     def __init__(self, *, status: list[Status] = None, maintenance: Optional[bool] = None):
         super().__init__()
         self.status: list[Status] = status
         self.maintenance = maintenance
 
     async def transform(self, interaction: discord.Interaction, value: Optional[str]) -> Server:
+        """
+        Converts a server name into a Server object.
+
+        Args:
+            interaction: The interaction context
+            value: The server name to convert
+
+        Returns:
+            The corresponding Server object
+
+        Raises:
+            app_commands.TransformerError: If server not found
+        """
         if value:
             server = interaction.client.servers.get(value)
             if not server:
@@ -940,6 +960,19 @@ async def transform(self, interaction: discord.Interaction, value: Optional[str]
         return server
 
     async def autocomplete(self, interaction: discord.Interaction, current: str) -> list[app_commands.Choice[str]]:
+        """
+        Provides server name suggestions for autocomplete.
+
+        Filters servers based on status, maintenance mode, and user input.
+        Only shows servers the user has permission to access.
+
+        Args:
+            interaction: The interaction context
+            current: Current text input by user
+
+        Returns:
+            List of server name suggestions (max 25)
+        """
         if not await interaction.command._check_can_run(interaction):
             return []
         try:

core/utils/helper.py

@@ -29,7 +29,7 @@
 from collections.abc import Mapping
 from copy import deepcopy
 from croniter import croniter
-from datetime import datetime, timedelta, timezone
+from datetime import datetime, timedelta, timezone, tzinfo
 from difflib import unified_diff
 from importlib import import_module
 from pathlib import Path
@@ -87,7 +87,7 @@
 logger = logging.getLogger(__name__)
 
 
-def parse_time(time_str: str, tz: datetime.tzinfo = None) -> datetime:
+def parse_time(time_str: str, tz: tzinfo = None) -> datetime:
     fmt, time_str = ('%H:%M', time_str.replace('24:', '00:')) \
         if time_str.find(':') > -1 else ('%H', time_str.replace('24', '00'))
     ret = datetime.strptime(time_str, fmt)
@@ -96,7 +96,7 @@ def parse_time(time_str: str, tz: datetime.tzinfo = None) -> datetime:
     return ret
 
 
-def is_in_timeframe(time: datetime, timeframe: str, tz: datetime.tzinfo = None) -> bool:
+def is_in_timeframe(time: datetime, timeframe: str, tz: tzinfo = None) -> bool:
     """
     Check if a given time falls within a specified timeframe.
 
@@ -887,7 +887,7 @@ def hash_password(password: str) -> str:
     # Generate an 11 character alphanumeric string
     key = ''.join(secrets.choice(string.ascii_letters + string.digits) for _ in range(11))
 
-    # Create a 32 byte digest using the Blake2b hash algorithm
+    # Create a 32-byte-digest using the "Blake2b" hash algorithm
     # with the password as the input and the key as the key
     password_bytes = password.encode('utf-8')
     key_bytes = key.encode('utf-8')

core/utils/os.py

@@ -328,7 +328,7 @@ def is_upnp_available() -> bool:
             # No UPnP devices detected on the network.
             return False
     except Exception:
-        # An UPnP device was found, but no IGD was found.
+        # A UPnP device was found, but no IGD was found.
         return False
 
 

extensions/lardoon/README.md

@@ -10,11 +10,11 @@ MyNode:
   # [...]
   extensions:
     Lardoon:
-      use_single_process: true      # Start one Lardoon process per node (default: true) 
       cmd: '%USERPROFILE%\Documents\GitHub\lardoon\lardoon.exe'
       bind: 0.0.0.0:3113            # IP and port the (single) Lardoon server is listening to
       url: https://myfancyhost.com  # Alternate hostname to be displayed in your status embed 
       minutes: 5                    # Number of minutes the Lardoon database is updated
+      use_single_process: true      # Start one Lardoon process instead of one per node (default: true) 
   # [...]
   instances:
     DCS.release_server:
@@ -28,7 +28,7 @@ MyNode:
           minutes: 5                    # Optional: Number of minutes the Lardoon database is updated (only needed if use_single_process is false)
           tacviewExportPath: 'G:\My Drive\Tacview Files'  # Alternative drive for tacview files (default: auto-detect from Tacview)
 ```
-Remember to add some kind of security before exposing services like that to the outside world, with for instance
+Remember to add some kind of security before exposing services like that to the outside world, with, for instance,
 an nginx reverse proxy.</br>
 If you plan to build Lardoon on your own, I'd recommend the fork of [Team LimaKilo](https://github.com/team-limakilo/lardoon).
 

extensions/loganalyser/README.md

@@ -1,7 +1,7 @@
 # Extension "LogAnalyser"
 This is a default extension that is loaded in any case. It will scan your dcs.log for errors and react in several ways
 according to what happened.
-Currently these actions are implemented:
+Currently, these actions are implemented:
 - Restart the mission on server unlisting.
 - Print script errors to the audit channel (if configured).
 

extensions/loganalyser/extension.py

@@ -203,7 +203,7 @@ async def script_error(self, idx: int, line: str, match: re.Match):
         filename, line_number, error_message = match.groups()
         basename = os.path.basename(filename)
 
-        # Get the ignore patterns from config, default to an empty list if not present
+        # Get the ignore-pattern from config. Defaults to an empty list if not present.
         ignore_patterns = self.config.get('ignore_files', [])
 
         # Check if the filename matches any of the regex patterns