Address review feedback: move aliases into type_definitions and improve error handling

Author: rfbgo

lib/ramble/ramble/cmd/edit.py

@@ -41,10 +41,7 @@ def normalize_type_name(type_name):
     if norm_type in extra_type_aliases:
         return extra_type_aliases[norm_type]
 
-    try:
-        return ramble.repository.simplify_object_type(type_name).name
-    except ramble.repository.UnknownObjectTypeError:
-        return type_name
+    return ramble.repository.simplify_object_type(type_name).name
 
 
 def find_all_matches(name, repo_path=None, namespace=None, obj_type=None):
@@ -160,11 +157,6 @@ def edit(parser, args):
     # Normalize input type if specified
     if args.type:
         args.type = normalize_type_name(args.type)
-        extra_types = ["test", "command", "docs", "module"]
-        allowed_types = ramble.repository.OBJECT_NAMES + extra_types
-        if args.type not in allowed_types:
-            # Trigger KeyError like the original code did
-            _ = ramble.repository.ObjectTypes[args.type]
 
     if name:
         matches = find_all_matches(name, args.repo, args.namespace, args.type)

lib/ramble/ramble/repository.py

@@ -101,6 +101,7 @@
         "config_section": "package_manager_repos",
         "accepted_configs": ["package_manager_repo.yaml", unified_config],
         "singular": "package manager",
+        "aliases": ["pkg", "package"],
     },
     ObjectTypes.workflow_managers: {
         "file_name": "workflow_manager.py",
@@ -109,6 +110,7 @@
         "config_section": "workflow_manager_repos",
         "accepted_configs": ["workflow_manager_repo.yaml", unified_config],
         "singular": "workflow manager",
+        "aliases": ["workflow"],
     },
     ObjectTypes.systems: {
         "file_name": "system.py",
@@ -133,6 +135,7 @@
         "config_section": "base_class_repos",
         "accepted_configs": ["base_class_repo.yaml", unified_config],
         "singular": "base class",
+        "aliases": ["base"],
     },
     ObjectTypes.base_applications: {
         "file_name": "base_application.py",
@@ -157,6 +160,7 @@
         "config_section": "base_package_manager_repos",
         "accepted_configs": ["base_package_manager_repo.yaml", unified_config],
         "singular": "base package manager",
+        "aliases": ["base_pkg"],
     },
     ObjectTypes.base_workflow_managers: {
         "file_name": "base_workflow_manager.py",
@@ -165,6 +169,7 @@
         "config_section": "base_workflow_manager_repos",
         "accepted_configs": ["base_workflow_manager_repo.yaml", unified_config],
         "singular": "base workflow manager",
+        "aliases": ["base_workflow"],
     },
     ObjectTypes.base_systems: {
         "file_name": "base_system.py",
@@ -209,19 +214,18 @@ def _normalize_type_key(key):
     return str(key).lower().replace("-", "_").replace(" ", "_")
 
 
-_TYPE_ALIASES = {
-    "pkg": ObjectTypes.package_managers,
-    "package": ObjectTypes.package_managers,
-    "packages": ObjectTypes.package_managers,
-    "base_pkg": ObjectTypes.base_package_managers,
-    "workflow": ObjectTypes.workflow_managers,
-    "workflows": ObjectTypes.workflow_managers,
-    "base": ObjectTypes.base_classes,
-}
+_TYPE_ALIASES = {}
 
 for _obj in ObjectTypes:
     _tdef = type_definitions.get(_obj, {})
-    for _val in (_obj.name, _tdef.get("singular"), _tdef.get("abbrev"), _tdef.get("dir_name")):
+    _candidates = [
+        _obj.name,
+        _tdef.get("singular"),
+        _tdef.get("abbrev"),
+        _tdef.get("dir_name"),
+        *_tdef.get("aliases", []),
+    ]
+    for _val in _candidates:
         if isinstance(_val, str):
             for _v in (_val, f"{_val}s"):
                 _norm = _normalize_type_key(_v)

lib/ramble/ramble/test/cmd/edit.py

@@ -8,6 +8,7 @@
 
 import pytest
 
+import ramble.repository
 from ramble.main import RambleCommand
 
 edit = RambleCommand("edit")
@@ -118,7 +119,7 @@ def test_edit_singular_type_with_spaces_hyphens(mock_editor):
 
 
 def test_edit_unknown_type():
-    with pytest.raises(KeyError):
+    with pytest.raises(ramble.repository.UnknownObjectTypeError):
         edit("-t", "unknown_type", "spack")
 
 
@@ -174,8 +175,8 @@ def test_normalize_type_name():
     assert normalize_type_name("TEST") == "test"
     assert normalize_type_name("Command") == "command"
     assert normalize_type_name("APP") == "applications"
-    assert normalize_type_name("MODIFIER") == "modifiers"
-    assert normalize_type_name("unknown_type") == "unknown_type"
+    with pytest.raises(ramble.repository.UnknownObjectTypeError):
+        normalize_type_name("unknown_type")
 
 
 def test_edit_abbreviated_type(mock_modifiers, mock_editor):