Coverage for src / puzzletree / cli / register.py: 84.85%

1"""Command registration module for dynamically discovering and registering CLI commands.""" 

2 

3import importlib (empty)

4from pathlib import Path (empty)

5 

6from typer import Typer (empty)

7 

8from puzzletree.utils.logging import get_logger_console (empty)

9 

10 

11def _register_commands(app: Typer, path: Path | None = None) -> None: (empty)

12 """Dynamically discover and register CLI commands from submodules in the commands directory. 

13 

14 Scans all subdirectories in the commands directory and registers any that have an 'app' 

15 attribute defined in their __init__.py file. 

16 """ 

17 logger, _ = get_logger_console() (empty)

18 

19 # Get the cli directory path 

20 cli_dir = Path(__file__).parent / "commands" if path is None else path (empty)

21 

22 # Find all subdirectories in the commands directory that have __init__.py 

23 command_modules = [ (empty)

24 d.name for d in cli_dir.iterdir() if d.is_dir() and (d / "__init__.py").exists() and d.name != "__pycache__" 

25 ] 

26 

27 registered_commands = set() (empty)

28 

29 # Import and register commands from each submodule 

30 for module_name in command_modules: (empty)

31 logger.debug(f"Importing submodule: {module_name}") (empty)

32 

33 try: (empty)

34 # Dynamically import the submodule (its __init__.py will be loaded) 

35 module = importlib.import_module(f"puzzletree.cli.commands.{module_name}") (empty)

36 

37 # Check if the module has an 'app' attribute 

38 if not hasattr(module, "app"): (empty)

39 logger.debug(f"Submodule '{module_name}' does not have an 'app' attribute. Skipping.") (empty)

40 

41 continue (empty)

42 

43 # Get the app from the module 

44 sub_command = module.app (empty)

45 

46 if module_name in registered_commands: 46 ↛ 47line 46 didn't jump to line 47 because the condition on line 46 was never true(empty)

47 logger.warning( 

48 f"Duplicate command name '{module_name}' found in submodule '{module_name}'. Skipping registration.", 

49 ) 

50 continue 

51 

52 app.add_typer(sub_command, name=module_name) (empty)

53 registered_commands.add(module_name) (empty)

54 logger.debug(f"Registered command '{module_name}' from submodule '{module_name}'") (empty)

55 

56 except ImportError as e: (empty)

57 logger.warning(f"Failed to import submodule '{module_name}': {e}. Skipping.") (empty)

58 except (AttributeError, TypeError, ValueError) as e: 

59 logger.warning(f"Error processing submodule '{module_name}': {e}. Skipping.")