renaming option override-path -> overrides-path

ecmwf-projects · Feb 21, 2024 · abbe1cc · abbe1cc
1 parent 5e36605
commit abbe1cc
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 14 deletions.
diff --git a/cads_catalogue/entry_points.py b/cads_catalogue/entry_points.py
@@ -167,7 +167,7 @@ def init_db(connection_string: Optional[str] = None, force: bool = False) -> Non
 
 @app.command()
 def update_catalogue(
-    override_path: Optional[str] = None,
+    overrides_path: Optional[str] = None,
     resources_folder_path: str = os.path.join(PACKAGE_DIR, "cads-forms-json"),
     messages_folder_path: str = os.path.join(PACKAGE_DIR, "cads-messages"),
     licences_folder_path: str = os.path.join(PACKAGE_DIR, "cads-licences"),
@@ -185,7 +185,7 @@ def update_catalogue(
 
     Parameters
     ----------
-    override_path: path of the file override.yaml
+    overrides_path: path of the file yaml containing overriding metadata
     resources_folder_path: folder containing metadata files for resources (i.e. cads-forms-json)
     messages_folder_path: folder containing metadata files for system messages (i.e. cads-messages)
     licences_folder_path: folder containing metadata files for licences (i.e. cads-licences)
@@ -243,9 +243,9 @@ def update_catalogue(
     involved_licences = []
     involved_resource_uids = []
     try:
-        current_override_md = manager.parse_override_md(override_path)
+        current_override_md = manager.parse_override_md(overrides_path)
     except Exception:
-        logger.exception(f"not parsable {override_path}")
+        logger.exception(f"not parsable {overrides_path}")
         current_override_md = dict()
     with session_obj.begin() as session:  # type: ignore
         logger.info("comparing current input files with the ones of the last run")

diff --git a/tests/test_40_manager.py b/tests/test_40_manager.py
@@ -31,13 +31,13 @@ def test_parse_override_md() -> None:
     # override file is not set
     assert manager.parse_override_md(None) == dict()
     # override file not exist
-    override_path = os.path.join(TESTDATA_PATH, "notexist.yaml")
-    assert manager.parse_override_md(override_path) == dict()
+    overrides_path = os.path.join(TESTDATA_PATH, "notexist.yaml")
+    assert manager.parse_override_md(overrides_path) == dict()
     # override file not valid
-    override_path = os.path.join(TESTDATA_PATH, "override1.yaml")
-    assert manager.parse_override_md(override_path) == dict()
+    overrides_path = os.path.join(TESTDATA_PATH, "override1.yaml")
+    assert manager.parse_override_md(overrides_path) == dict()
     # consistent override info
-    override_path = os.path.join(TESTDATA_PATH, "override2.yaml")
+    overrides_path = os.path.join(TESTDATA_PATH, "override2.yaml")
     expected = {
         "reanalysis-era5-pressure-levels": {},
         "reanalysis-era5-land": {
@@ -52,7 +52,7 @@ def test_parse_override_md() -> None:
             "qa_flag": True,
         },
     }
-    assert manager.parse_override_md(override_path) == expected
+    assert manager.parse_override_md(overrides_path) == expected
 
 
 def test_load_resource_from_folder() -> None:
@@ -1603,8 +1603,8 @@ def test_load_resource_from_folder() -> None:
     }
     assert resource == expected_resource
 
-    override_path = os.path.join(TESTDATA_PATH, "override2.yaml")
-    override_md = manager.parse_override_md(override_path)["reanalysis-era5-land"]
+    overrides_path = os.path.join(TESTDATA_PATH, "override2.yaml")
+    override_md = manager.parse_override_md(overrides_path)["reanalysis-era5-land"]
     expected_resource2 = expected_resource.copy()
     expected_resource2.update(override_md)
     resource = manager.load_resource_from_folder(resource_folder_path, override_md)

diff --git a/tests/test_90_entry_points.py b/tests/test_90_entry_points.py
@@ -1189,7 +1189,7 @@ def test_update_catalogue(
             TEST_LICENCES_DATA_PATH,
             "--cim-folder-path",
             TEST_CIM_DATA_PATH,
-            "--override-path",
+            "--overrides-path",
             os.path.join(TESTDATA_PATH, "override2.yaml"),
         ],
         env={
@@ -1259,7 +1259,7 @@ def test_update_catalogue(
             TEST_LICENCES_DATA_PATH,
             "--cim-folder-path",
             TEST_CIM_DATA_PATH,
-            "--override-path",
+            "--overrides-path",
             os.path.join(TESTDATA_PATH, "override2.yaml"),
         ],
         env={