Skip to content

mkdocs_demo.lib.factory

This module contains factory functions.

command_factory 

command_factory(cmd: str) -> Callable[..., int | None]

The factory function takes a command as input and returns a function that, when called, executes the command and returns the exit code or None if the execution is interrupted.

Parameters

cmd : str The cmd parameter is a string that represents a command to be executed.

Returns

Callable[..., int | None] The factory function returns a callable object, which is a function. The function takes no arguments and returns either an integer or None.

Source code in src/mkdocs_demo/lib/factory.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
def command_factory(cmd: str) -> Callable[..., int | None]:
    """
    The `factory` function takes a command as input and returns a function that, when called, executes
    the command and returns the exit code or None if the execution is interrupted.

    Parameters
    ----------
    `cmd` : `str`
        The `cmd` parameter is a string that represents a command to be executed.

    Returns
    -------
    `Callable`[`...`, `int` | `None`]
        The factory function returns a callable object, which is a function. The function takes no
        arguments and returns either an integer or None.
    """

    def _func(_cmd: str = cmd) -> int | None:
        try:
            return subprocess.call(_cmd.split(" "), shell=False)
        except KeyboardInterrupt:
            pass

        return None

    return _func