Skip to content

command_entry_point

Defines the abstract base class for Merlin CLI commands.

This module provides the CommandEntryPoint abstract base class that all Merlin command implementations must inherit from. It standardizes the interface for adding command-specific argument parsers and processing CLI command logic.

CommandEntryPoint

Bases: ABC

Abstract base class for a Merlin CLI command entry point.

Methods:

Name Description
add_parser

Adds the parser for a specific command to the main ArgumentParser.
process_command

Executes the logic for this CLI command.
Source code in merlin/cli/commands/command_entry_point.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class CommandEntryPoint(ABC):
    """
    Abstract base class for a Merlin CLI command entry point.

    Methods:
        add_parser: Adds the parser for a specific command to the main `ArgumentParser`.
        process_command: Executes the logic for this CLI command.
    """

    @abstractmethod
    def add_parser(self, subparsers: ArgumentParser):
        """Add the parser for this command to the main `ArgumentParser`."""
        raise NotImplementedError("Subclasses of `CommandEntryPoint` must implement an `add_parser` method.")

    @abstractmethod
    def process_command(self, args: Namespace):
        """Execute the logic for this CLI command."""
        raise NotImplementedError("Subclasses of `CommandEntryPoint` must implement an `process_command` method.")

add_parser(subparsers) abstractmethod

Add the parser for this command to the main ArgumentParser.

Source code in merlin/cli/commands/command_entry_point.py 
28
29
30
31
@abstractmethod
def add_parser(self, subparsers: ArgumentParser):
    """Add the parser for this command to the main `ArgumentParser`."""
    raise NotImplementedError("Subclasses of `CommandEntryPoint` must implement an `add_parser` method.")

process_command(args) abstractmethod

Execute the logic for this CLI command.

Source code in merlin/cli/commands/command_entry_point.py 
33
34
35
36
@abstractmethod
def process_command(self, args: Namespace):
    """Execute the logic for this CLI command."""
    raise NotImplementedError("Subclasses of `CommandEntryPoint` must implement an `process_command` method.")