Source code for pacman.config_setup

# Copyright (c) 2017 The University of Manchester
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import os
from typing import Set

from spinn_utilities.config_holder import (
    add_default_cfg, clear_cfg_files, get_config_bool)
from spinn_utilities.configs.camel_case_config_parser import optionxform
from spinn_machine.config_setup import add_spinn_machine_cfg
from pacman.data.pacman_data_writer import PacmanDataWriter

BASE_CONFIG_FILE = "pacman.cfg"



[docs]
def unittest_setup() -> None:
    """
    Resets the configurations so only the local default configuration is
    included.

    .. note::
        This file should only be called from `PACMAN/unittests`
    """
    clear_cfg_files(True)
    add_pacman_cfg()
    PacmanDataWriter.mock()




[docs]
def add_pacman_cfg() -> None:
    """
    Add the local configuration and all dependent configuration files.
    """
    add_spinn_machine_cfg()  # This add its dependencies too
    add_default_cfg(os.path.join(os.path.dirname(__file__), BASE_CONFIG_FILE))




[docs]
def packman_cfg_paths_skipped() -> Set[str]:
    """
    Set of cfg path that may not be found based on other cfg settings

    Assuming mode = Debug

    Used in function that check reports exists at the end of a debug node run.

    :returns:
       Set of cfg path that may not be found based on other cfg settings
    """
    skipped = set()
    # Code will not error if SpiNNaker-spinner missing but tests should
    if not get_config_bool("Reports", "draw_placements"):
        skipped.add(optionxform("path_placements"))
    if not get_config_bool("Reports", "draw_placements_on_error"):
        skipped.add(optionxform("path_placements_on_error"))
    # only written if there is an error
    skipped.add(optionxform("path_placement_errors_report"))
    return skipped