Skip to content

service

dev_tool.services.scripting.service

log = logging.getLogger(__name__) module-attribute

ScriptingService

Bases: BaseService

A service class for Python script discovery and execution.

This class provides methods for discovering and executing Python scripts.

The constructor for the ScriptingService class.

It initializes the scripting service by calling the parent constructor.

Source code in dev_tool/services/scripting/service.py 
33
34
35
36
37
38
39
40
def __init__(self) -> None:
    """
    The constructor for the ScriptingService class.

    It initializes the scripting service by calling the parent constructor.
    """

    super().__init__()

discover staticmethod

A method that discovers Python scripts in configured directories.

Returns:

  • dict[str, list[Path]] –

    A dictionary mapping directory names to lists of Python script files.

Source code in dev_tool/services/scripting/service.py 
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
@staticmethod
def discover() -> dict[str, list[Path]]:
    """
    A method that discovers Python scripts in configured directories.

    :return: A dictionary mapping directory names to lists of Python script files.
    """

    config = CONTEXT.configuration.get_scripting_config()

    if not config:
        message = '[tool.scripting] is missing from pyproject.toml'
        CONTEXT.notification.warning_text(message)

        log.debug(message)
        return {}

    try:
        directories = [
            BASE / directory
            for directory in config.get('include', [])
            if (BASE / directory).is_dir()
        ]

        exclude = ['__init__.py']

        return {
            directory.stem: [
                file for file in directory.rglob('*.py')
                if not any(
                    file.match(pattern)
                    for pattern in exclude
                )
            ]
            for directory in directories
        }
    except Exception:
        message = 'Failed to discover Python scripts'
        log.exception(message)

        raise ScriptDiscoveryError(message) from None

run_python_script staticmethod

A method that runs a Python script in the virtual environment.

Parameters:

  • script (Path) –

    The path to the Python script to run.

Source code in dev_tool/services/scripting/service.py 
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
@staticmethod
@is_virtual_environment
def run_python_script(script: Path) -> None:
    """
    A method that runs a Python script in the virtual environment.

    :param script: The path to the Python script to run.
    """

    message = f'Running Python script: {script}'
    CONTEXT.notification.normal_text(message)

    log.debug(message)

    if not script.exists():
        message = f'Script not found: {script}'
        log.exception(message)

        raise ScriptNotFoundError(message)

    command = [
        VENV_PYTHON,
        str(script)
    ]

    message = f'Running {command}...'
    CONTEXT.notification.normal_text(message)

    log.debug(message)

    try:
        subprocess.run(command, check=True)
    except subprocess.CalledProcessError:
        message = f'Failed to execute script: {script}'
        log.exception(message)

        raise ScriptExecutionError(message) from None
    except Exception:
        message = f'Unexpected error executing script: {script}'
        log.exception(message)

        raise ScriptExecutionError(message) from None