Skip to content

info

CLI module for displaying configuration and environment information.

This module defines the InfoCommand class, which handles the info subcommand of the Merlin CLI. The info command is intended to display detailed information about the current Merlin configuration, Python environment, and other diagnostic data useful for debugging or verifying setup.

InfoCommand

Bases: CommandEntryPoint

Handles info CLI command for viewing information about server connections.

Methods:

Name Description
add_parser

Adds the info command to the CLI parser.
process_command

Processes the CLI input and dispatches the appropriate action.
Source code in merlin/cli/commands/info.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
class InfoCommand(CommandEntryPoint):
    """
    Handles `info` CLI command for viewing information about server connections.

    Methods:
        add_parser: Adds the `info` command to the CLI parser.
        process_command: Processes the CLI input and dispatches the appropriate action.
    """

    def add_parser(self, subparsers: ArgumentParser):
        """
        Add the `info` command parser to the CLI argument parser.

        Parameters:
            subparsers (ArgumentParser): The subparsers object to which the `info` command parser will be added.
        """
        info: ArgumentParser = subparsers.add_parser(
            "info",
            help="display info about the merlin configuration and the python configuration. Useful for debugging.",
        )
        info.set_defaults(func=self.process_command)

    def process_command(self, args: Namespace):
        """
        CLI command to print merlin configuration info.

        Args:
            args: Parsed CLI arguments.
        """
        # if this is moved to the toplevel per standard style, merlin is unable to generate the (needed) default config file
        from merlin import display  # pylint: disable=import-outside-toplevel

        display.print_info(args)

add_parser(subparsers)

Add the info command parser to the CLI argument parser.

Parameters:

Name Type Description Default
subparsers ArgumentParser

The subparsers object to which the info command parser will be added.

 required
Source code in merlin/cli/commands/info.py 
36
37
38
39
40
41
42
43
44
45
46
47
def add_parser(self, subparsers: ArgumentParser):
    """
    Add the `info` command parser to the CLI argument parser.

    Parameters:
        subparsers (ArgumentParser): The subparsers object to which the `info` command parser will be added.
    """
    info: ArgumentParser = subparsers.add_parser(
        "info",
        help="display info about the merlin configuration and the python configuration. Useful for debugging.",
    )
    info.set_defaults(func=self.process_command)

process_command(args)

CLI command to print merlin configuration info.

Parameters:

Name Type Description Default
args Namespace

Parsed CLI arguments.

 required
Source code in merlin/cli/commands/info.py 
49
50
51
52
53
54
55
56
57
58
59
def process_command(self, args: Namespace):
    """
    CLI command to print merlin configuration info.

    Args:
        args: Parsed CLI arguments.
    """
    # if this is moved to the toplevel per standard style, merlin is unable to generate the (needed) default config file
    from merlin import display  # pylint: disable=import-outside-toplevel

    display.print_info(args)