rename context_manager and its classes

Author: notactuallyfinn

docs/source/conf.py

@@ -194,7 +194,7 @@ def read_version_from_pyproject():
 def autoapi_skip_member(app, obj_type, name, obj, skip, options):
     if obj_type == "attribute":
         if any(documented_type in obj.id for documented_type in [
-            "Collect", "HermesCache", "HermesContext", "HermesMergeError", "ld_container", "ld_context", "ld_dict",
+            "Collect", "HermesCache", "HermesCacheManager", "HermesMergeError", "ld_container", "ld_context", "ld_dict",
             "ld_list", "ld_merge_dict", "ld_merge_list", "MergeSet"
         ]):
             return True

docs/source/tutorials/writing-a-plugin-for-hermes.md

@@ -252,14 +252,14 @@ class YourPostprocessPlugin(HermesPostprocessPlugin):
 The metadata from a deposit plugin can be loaded via
 
 ```python
-ctx = HermesContext()
+ctx = HermesCacheManager()
 ctx.prepare_step("deposit")
 with ctx[deposit_plugin_name] as manager:
     deposition = manager["result"]
 ctx.finalize_step("deposit")
 ```
 
-where `deposit_plugin_name` is the name of the deposit plugin the data is loaded from and {py:class}`~hermes.model.context_manager.HermesContext` is imported from {py:mod}`hermes.model.context_manager`.
+where `deposit_plugin_name` is the name of the deposit plugin the data is loaded from and {py:class}`~hermes.model.hermes_cache.HermesCacheManager` is imported from {py:mod}`hermes.model.hermes_cache`.
 The loaded data is some valid JSON data and has no fixed format.
 
 ## Implement and use plugin specific settings

src/hermes/commands/curate/base.py

@@ -11,7 +11,7 @@
 from hermes.commands.base import HermesCommand, HermesPlugin
 from hermes.error import HermesPluginRunError, MisconfigurationError
 from hermes.model import SoftwareMetadata
-from hermes.model.context_manager import HermesContext
+from hermes.model.hermes_cache import HermesCacheManager
 from hermes.model.error import HermesValidationError
 
 
@@ -38,7 +38,7 @@ def __call__(self, args: argparse.Namespace) -> None:
         self.log.info("# Metadata curation")
         plugin_name = self.settings.plugin
 
-        ctx = HermesContext()
+        ctx = HermesCacheManager()
         ctx.prepare_step("curate")
 
         self.log.info("## Load processed metadata")

src/hermes/commands/deposit/base.py

@@ -12,7 +12,7 @@
 
 from hermes.commands.base import HermesCommand, HermesPlugin
 from hermes.error import HermesPluginRunError, MisconfigurationError
-from hermes.model.context_manager import HermesContext
+from hermes.model.hermes_cache import HermesCacheManager
 from hermes.model import SoftwareMetadata
 from hermes.model.error import HermesValidationError
 
@@ -29,7 +29,7 @@ def __call__(self, command: HermesCommand) -> None:
         This calls a list of additional methods on the class, none of which need to be implemented.
         """
         self.command = command
-        self.ctx = HermesContext()
+        self.ctx = HermesCacheManager()
         self.ctx.prepare_step("deposit")
 
         self.ctx.prepare_step("curate")

src/hermes/commands/harvest/base.py

@@ -10,7 +10,7 @@
 
 from hermes.commands.base import HermesCommand, HermesPlugin
 from hermes.error import HermesPluginRunError, MisconfigurationError
-from hermes.model.context_manager import HermesContext
+from hermes.model.hermes_cache import HermesCacheManager
 from hermes.model import SoftwareMetadata
 
 
@@ -45,7 +45,7 @@ def __call__(self, args: argparse.Namespace) -> None:
             raise MisconfigurationError("No harvest plugin was configured to be run and loaded.")
 
         # Initialize the harvest cache directory here to indicate the step ran
-        ctx = HermesContext()
+        ctx = HermesCacheManager()
         ctx.prepare_step('harvest')
 
         self.log.info("## Load and run the plugins")

src/hermes/commands/postprocess/invenio.py

@@ -13,7 +13,7 @@
 import tomlkit
 
 from hermes.error import MisconfigurationError
-from hermes.model.context_manager import HermesContext
+from hermes.model.hermes_cache import HermesCacheManager
 from ..base import HermesCommand
 from .base import HermesPostprocessPlugin
 
@@ -23,7 +23,7 @@
 
 class config_record_id(HermesPostprocessPlugin):
     def __call__(self, command: HermesCommand):
-        ctx = HermesContext()
+        ctx = HermesCacheManager()
         ctx.prepare_step("deposit")
         with ctx["invenio"] as manager:
             deposition = manager["result"]
@@ -47,7 +47,7 @@ def __call__(self, command: HermesCommand):
 
 class cff_doi(HermesPostprocessPlugin):
     def __call__(self, command: HermesCommand):
-        ctx = HermesContext()
+        ctx = HermesCacheManager()
         ctx.prepare_step("deposit")
         with ctx["invenio"] as manager:
             deposition = manager["result"]
@@ -78,7 +78,7 @@ def __call__(self, command: HermesCommand):
 
 class codemeta_doi(HermesPostprocessPlugin):
     def __call__(self, command: HermesCommand):
-        ctx = HermesContext()
+        ctx = HermesCacheManager()
         ctx.prepare_step("deposit")
         with ctx["invenio"] as manager:
             deposition = manager["result"]

src/hermes/commands/postprocess/invenio_rdm.py

@@ -11,7 +11,7 @@
 import tomlkit
 
 from hermes.error import MisconfigurationError
-from hermes.model.context_manager import HermesContext
+from hermes.model.hermes_cache import HermesCacheManager
 from ..base import HermesCommand
 from .base import HermesPostprocessPlugin
 
@@ -21,7 +21,7 @@
 
 class config_record_id(HermesPostprocessPlugin):
     def __call__(self, command: HermesCommand):
-        ctx = HermesContext()
+        ctx = HermesCacheManager()
         ctx.prepare_step("deposit")
         with ctx["invenio_rdm"] as manager:
             deposition = manager["result"]

src/hermes/commands/process/base.py

@@ -12,7 +12,7 @@
 from hermes.commands.base import HermesCommand, HermesPlugin
 from hermes.error import HermesPluginRunError, MisconfigurationError
 from hermes.model.api import SoftwareMetadata
-from hermes.model.context_manager import HermesContext
+from hermes.model.hermes_cache import HermesCacheManager
 from hermes.model.merge.action import MergeAction
 from hermes.model.merge.container import ld_merge_dict
 
@@ -83,7 +83,7 @@ def __call__(self, args: argparse.Namespace) -> None:
             self.log.critical("## No process plugin was ran successfully.")
             raise HermesPluginRunError("No process plugin was ran successfully.")
 
-        ctx = HermesContext()
+        ctx = HermesCacheManager()
         ctx.prepare_step('harvest')
 
         # merge data from harvesters

src/hermes/model/api.py

@@ -13,8 +13,8 @@
 from hermes.model.types.ld_context import ALL_CONTEXTS
 from hermes.model.types.pyld_util import bundled_loader
 
-from .context_manager import HermesContext
-from .error import HermesContextError
+from .hermes_cache import HermesCacheManager
+from .error import HermesCacheError
 
 
 class SoftwareMetadata(ld_dict):
@@ -44,21 +44,21 @@ def __init__(
         super().__init__([ld_dict.from_dict(data, context=ctx).data_dict if data else {}], context=ctx)
 
     @classmethod
-    def load_from_cache(cls: type[Self], ctx: HermesContext, source: str) -> "SoftwareMetadata":
+    def load_from_cache(cls: type[Self], ctx: HermesCacheManager, source: str) -> "SoftwareMetadata":
         """
-        Loads the JSON_LD data from the given HermesContext object at the given source.\n
+        Loads the JSON_LD data from the given HermesCacheManager object at the given source.\n
         Note that only data from "codemeta.json" or ("context.json" and "expanded.json") is loaded where "codemeta.json"
         is preferred.
 
         Args:
-            ctx (HermesContext): The HERMES cache the data is loaded from.
+            ctx (HermesCacheManager): The HERMES cache the data is loaded from.
             source (str): The directory the inside the cache the data is loaded from.
 
         Returns:
             SoftwareMetadata: The SoftwareMetadata loaded from the cache.
 
         Raises:
-            HermesContextError: If neither of the listed files contains valid data for a SoftwareMetadata object.
+            HermesCacheError: If neither of the listed files contains valid data for a SoftwareMetadata object.
         """
         # open the directory in the context
         with ctx[source] as cache:
@@ -80,16 +80,16 @@ def load_from_cache(cls: type[Self], ctx: HermesContext, source: str) -> "Softwa
                 return data
             except Exception as e:
                 # No data could be loaded, raise an error instead.
-                raise HermesContextError("There is no (valid) data stored in the cache.") from e
+                raise HermesCacheError("There is no (valid) data stored in the cache.") from e
 
-    def write_to_cache(self: Self, ctx: HermesContext, target_dir: str) -> None:
+    def write_to_cache(self: Self, ctx: HermesCacheManager, target_dir: str) -> None:
         """
-        Writes the JSON_LD data of `self` to the given HermesContext object at the given target.\n
+        Writes the JSON_LD data of `self` to the given HermesCacheManager object at the given target.\n
         Note that data is written into "codemeta.json" (compacted value), "context.json" (context value) and
         "expanded.json" (expanded value).
 
         Args:
-            ctx (HermesContext): The HERMES cache the data is written to.
+            ctx (HermesCacheManager): The HERMES cache the data is written to.
             target_dir (str): The directory the inside the cache the data is written to.
 
         Returns:

src/hermes/model/error.py

@@ -24,7 +24,7 @@ class HermesValidationError(Exception):
     pass
 
 
-class HermesContextError(Exception):
+class HermesCacheError(Exception):
     """
     This exception should be raised when interacting with the model context.
     # TODO Change class name and docstring if we decide to call it differently
@@ -37,7 +37,7 @@ class HermesContextError(Exception):
         try:
              context[term]
         except ValueError as e:
-            raise HermesContextError(term) from e
+            raise HermesCacheError(term) from e
     """
     pass