Skip to content

startup

Program startup helper functions.

check_for_updates(console)

Check for updates to the Ephys Link.

Parameters:

Name Type Description Default
console Console

Console instance for printing messages.

 required
Source code in src/ephys_link/utils/startup.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def check_for_updates(console: Console) -> None:
    """Check for updates to the Ephys Link.

    Args:
        console: Console instance for printing messages.
    """
    try:
        response = get("https://api.github.com/repos/VirtualBrainLab/ephys-link/tags", timeout=10)
        latest_version = str(response.json()[0]["name"])  # pyright: ignore [reportAny]
        if parse(latest_version) > parse(__version__):
            console.critical_print(f"Update available: {latest_version} (current: {__version__})")
            console.critical_print("Download at: https://github.com/VirtualBrainLab/ephys-link/releases/latest")
    except (ConnectionError, ConnectTimeout):
        console.error_print(
            "UPDATE", "Unable to check for updates. Ignore updates or use the the -i flag to disable checks.\n"
        )

get_binding_display_to_cli_name()

Get mapping of display to CLI option names of the available platform bindings.

Returns:

Type Description
dict[str, str]

Dictionary of platform binding display name to CLI option name.
Source code in src/ephys_link/utils/startup.py 
101
102
103
104
105
106
107
def get_binding_display_to_cli_name() -> dict[str, str]:
    """Get mapping of display to CLI option names of the available platform bindings.

    Returns:
        Dictionary of platform binding display name to CLI option name.
    """
    return {binding_type.get_display_name(): binding_type.get_cli_name() for binding_type in get_bindings()}

get_binding_instance(options, console)

Get an instance of the requested binding class.

Parameters:

Name Type Description Default
options EphysLinkOptions

Ephys Link options.

 required
console Console

Console instance for printing messages.

 required

Raises:

Type Description
ValueError

If the platform type is not recognized.

Returns:

Type Description
BaseBinding

Instance of a platform binding class.
Source code in src/ephys_link/utils/startup.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
def get_binding_instance(options: EphysLinkOptions, console: Console) -> BaseBinding:
    """Get an instance of the requested binding class.

    Args:
        options: Ephys Link options.
        console: Console instance for printing messages.

    Raises:
        ValueError: If the platform type is not recognized.

    Returns:
        Instance of a platform binding class.
    """
    selected_type = options.type

    for binding_type in get_bindings():
        binding_cli_name = binding_type.get_cli_name()

        # Notify deprecation of "ump-4" and "ump-3" CLI options and fix.
        if selected_type in ("ump-4", "ump-3"):
            console.error_print(
                "DEPRECATION",
                f"CLI option '{selected_type}' is deprecated and will be removed in v3.0.0. Use 'ump' instead.",
            )
            selected_type = "ump"

        if binding_cli_name == selected_type:
            # Pass in HTTP port for Pathfinder MPM.
            if binding_cli_name == "pathfinder-mpm":
                return MPMBinding(options.mpm_port)

            # Otherwise just return the binding.
            return binding_type()

    # Raise an error if the platform type is not recognized.
    error_message = f'Platform type "{options.type}" not recognized.'
    console.critical_print(error_message)
    raise ValueError(error_message)

get_bindings()

Get all binding classes from the bindings directory.

Returns:

Type Description
list[type[BaseBinding]]

List of binding classes.
Source code in src/ephys_link/utils/startup.py 
47
48
49
50
51
52
53
54
55
56
57
58
def get_bindings() -> list[type[BaseBinding]]:
    """Get all binding classes from the bindings directory.

    Returns:
        List of binding classes.
    """
    return [
        binding_type
        for module in iter_modules([BINDINGS_DIRECTORY])
        for _, binding_type in getmembers(import_module(f"ephys_link.bindings.{module.name}"), isclass)
        if issubclass(binding_type, BaseBinding) and binding_type != BaseBinding
    ]

preamble()

Print the server startup preamble.

Source code in src/ephys_link/utils/startup.py 
18
19
20
21
22
23
24
25
26
def preamble() -> None:
    """Print the server startup preamble."""
    print(ASCII)  # noqa: T201
    print(__version__)  # noqa: T201
    print()  # noqa: T201
    print("This is the Ephys Link server window.")  # noqa: T201
    print("You may safely leave it running in the background.")  # noqa: T201
    print("To stop it, close this window or press CTRL + Pause/Break.")  # noqa: T201
    print()  # noqa: T201