Fix #301: Make all command settings classes private

Author: sdruskat

src/hermes/commands/base.py

@@ -16,7 +16,7 @@
 from pydantic_settings import BaseSettings, SettingsConfigDict
 
 
-class HermesSettings(BaseSettings):
+class _HermesSettings(BaseSettings):
     """Root class for HERMES configuration model."""
 
     model_config = SettingsConfigDict(env_file_encoding='utf-8')
@@ -31,7 +31,7 @@ class HermesCommand(abc.ABC):
     """
 
     command_name: str = ""
-    settings_class: Type = HermesSettings
+    settings_class: Type = _HermesSettings
 
     def __init__(self, parser: argparse.ArgumentParser):
         """Initialize a new instance of any HERMES command.

src/hermes/commands/clean/base.py

@@ -12,7 +12,7 @@
 from hermes.commands.base import HermesCommand
 
 
-class HermesCleanSettings(BaseModel):
+class _HermesCleanSettings(BaseModel):
     """Configuration of the ``clean`` command."""
     pass
 
@@ -21,7 +21,7 @@ class HermesCleanCommand(HermesCommand):
     """ Clean up caches from previous HERMES runs. """
 
     command_name = "clean"
-    settings_class = HermesCleanSettings
+    settings_class = _HermesCleanSettings
 
     def __call__(self, args: argparse.Namespace) -> None:
         self.log.info("Removing HERMES caches...")

src/hermes/commands/curate/base.py

@@ -15,7 +15,7 @@
 from hermes.model.context import CodeMetaContext
 
 
-class CurateSettings(BaseModel):
+class _CurateSettings(BaseModel):
     """Generic deposition settings."""
 
     pass
@@ -25,7 +25,7 @@ class HermesCurateCommand(HermesCommand):
     """ Curate the unified metadata before deposition. """
 
     command_name = "curate"
-    settings_class = CurateSettings
+    settings_class = _CurateSettings
 
     def init_command_parser(self, command_parser: argparse.ArgumentParser) -> None:
         pass

src/hermes/commands/deposit/base.py

@@ -106,7 +106,7 @@ def publish(self) -> None:
         pass
 
 
-class DepositSettings(BaseModel):
+class _DepositSettings(BaseModel):
     """Generic deposition settings."""
 
     target: str = ""
@@ -116,7 +116,7 @@ class HermesDepositCommand(HermesCommand):
     """ Deposit the curated metadata to repositories. """
 
     command_name = "deposit"
-    settings_class = DepositSettings
+    settings_class = _DepositSettings
 
     def init_command_parser(self, command_parser: argparse.ArgumentParser) -> None:
         command_parser.add_argument('--file', '-f', nargs=1, action='append',

src/hermes/commands/harvest/base.py

@@ -25,7 +25,7 @@ def __call__(self, command: HermesCommand) -> t.Tuple[t.Dict, t.Dict]:
         pass
 
 
-class HarvestSettings(BaseModel):
+class _HarvestSettings(BaseModel):
     """Generic harvesting settings."""
 
     sources: list[str] = []
@@ -35,7 +35,7 @@ class HermesHarvestCommand(HermesCommand):
     """ Harvest metadata from configured sources. """
 
     command_name = "harvest"
-    settings_class = HarvestSettings
+    settings_class = _HarvestSettings
 
     def __call__(self, args: argparse.Namespace) -> None:
         self.args = args

src/hermes/commands/init/base.py

@@ -139,15 +139,15 @@ def convert_remote_url(url: str) -> str:
     return url
 
 
-class HermesInitSettings(BaseModel):
+class _HermesInitSettings(BaseModel):
     """Configuration of the ``init`` command."""
     pass
 
 
 class HermesInitCommand(HermesCommand):
     """ Install HERMES onto a project. """
     command_name = "init"
-    settings_class = HermesInitSettings
+    settings_class = _HermesInitSettings
 
     def __init__(self, parser: argparse.ArgumentParser):
         super().__init__(parser)

src/hermes/commands/postprocess/base.py

@@ -15,7 +15,7 @@ class HermesPostprocessPlugin(HermesPlugin):
     pass
 
 
-class PostprocessSettings(BaseModel):
+class _PostprocessSettings(BaseModel):
     """Generic post-processing settings."""
 
     execute: list = []
@@ -25,7 +25,7 @@ class HermesPostprocessCommand(HermesCommand):
     """Post-process the published metadata after deposition."""
 
     command_name = "postprocess"
-    settings_class = PostprocessSettings
+    settings_class = _PostprocessSettings
 
     def __call__(self, args: argparse.Namespace) -> None:
         pass