9349741890

Committed 03 Jun 2024 12:02PM UTC coverage: 92.705% (+0.4%) from 92.327%

Build # 9349741890

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #263 from SpiNNakerManchester/better_error

Better error on bad cfg

Run Details

1351 of 1480 branches covered (91.28%)

Branch coverage included in aggregate %.

2 of 2 new or added lines in 1 file covered. (100.0%)

1 existing line in 1 file now uncovered.

2436 of 2605 relevant lines covered (93.51%)

0.94 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

75.64

/spinn_machine/version/version_factory.py

# Copyright (c) 2023 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.

from __future__ import annotations
import logging
import sys
from typing import TYPE_CHECKING
from spinn_utilities.config_holder import (
    get_config_int_or_none, get_config_str_or_none)
from spinn_utilities.log import FormatAdapter
from spinn_machine.exceptions import SpinnMachineException
from .version_strings import VersionStrings
if TYPE_CHECKING:
    from .abstract_version import AbstractVersion

logger = FormatAdapter(logging.getLogger(__name__))

# Constant when wanting a specific version
THREE = 3
FIVE = 5
# New value subject to change
SPIN2_1CHIP = 201
SPIN2_48CHIP = 248


def version_factory() -> AbstractVersion:
    """
    Creates a Machine Version class based on cfg settings.

    :return: A subclass of AbstractVersion
    :raises SpinnMachineException: If the cfg version is not set correctly
    """
    # Delayed import to avoid circular imports
    # pylint: disable=import-outside-toplevel
    from .version_3 import Version3
    from .version_5 import Version5
    from .version_201 import Version201
    from .version_248 import Version248

    version = get_config_int_or_none("Machine", "version")
    versions = get_config_str_or_none("Machine", "versions")
    if versions is not None:
        if version is not None:
            raise SpinnMachineException(
                f"Both {version=} and {versions=} found in cfg")
        vs = VersionStrings.from_string(versions)
        options = vs.options
        # Use the fact that we run actions against different python versions
        minor = sys.version_info.minor
        version = options[minor % len(options)]

    if version in [2, 3]:
        return Version3()

    if version in [4, 5]:
        return Version5()

    if version == SPIN2_1CHIP:
        return Version201()

    if version == SPIN2_48CHIP:
        return Version248()

    spalloc_server = get_config_str_or_none("Machine", "spalloc_server")
    if spalloc_server is not None:
        return Version5()

    remote_spinnaker_url = get_config_str_or_none(
        "Machine", "remote_spinnaker_url")
    if remote_spinnaker_url is not None:
        return Version5()

    height = get_config_int_or_none("Machine", "height")
    width = get_config_int_or_none("Machine", "width")
    if height is not None and width is not None:
        logger.info("Your cfg file does not have a version")
        if height == width == 2:
            return Version3()
        elif height == width == 1:
            return Version201()
        return Version5()

    if version is None:
        machine_name = get_config_str_or_none("Machine", "machineName")
        raise SpinnMachineException(
            "cfg [Machine]version {version} is None. "
            f"Other cfg settings are {machine_name=} {spalloc_server=}, "
            f"{remote_spinnaker_url=} {width=} {height=}")
    raise SpinnMachineException(f"Unexpected cfg [Machine]version {version}")

1	# Copyright (c) 2023 The University of Manchester
2	#
3	# Licensed under the Apache License, Version 2.0 (the "License");
4	# you may not use this file except in compliance with the License.
5	# You may obtain a copy of the License at
6	#
7	# https://www.apache.org/licenses/LICENSE-2.0
8	#
9	# Unless required by applicable law or agreed to in writing, software
10	# distributed under the License is distributed on an "AS IS" BASIS,
11	# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12	# See the License for the specific language governing permissions and
13	# limitations under the License.
14
15	from __future__ import annotations	1✔
16	import logging	1✔
17	import sys	1✔
18	from typing import TYPE_CHECKING	1✔
19	from spinn_utilities.config_holder import (	1✔
20	get_config_int_or_none, get_config_str_or_none)
21	from spinn_utilities.log import FormatAdapter	1✔
22	from spinn_machine.exceptions import SpinnMachineException	1✔
23	from .version_strings import VersionStrings	1✔
24	if TYPE_CHECKING:
25	from .abstract_version import AbstractVersion
26
27	logger = FormatAdapter(logging.getLogger(__name__))	1✔
28
29	# Constant when wanting a specific version
30	THREE = 3	1✔
31	FIVE = 5	1✔
32	# New value subject to change
33	SPIN2_1CHIP = 201	1✔
34	SPIN2_48CHIP = 248	1✔
35
36
37	def version_factory() -> AbstractVersion:	1✔
38	"""
39	Creates a Machine Version class based on cfg settings.
40
41	:return: A subclass of AbstractVersion
42	:raises SpinnMachineException: If the cfg version is not set correctly
43	"""
44	# Delayed import to avoid circular imports
45	# pylint: disable=import-outside-toplevel
46	from .version_3 import Version3	1✔
47	from .version_5 import Version5	1✔
48	from .version_201 import Version201	1✔
49	from .version_248 import Version248	1✔
50
51	version = get_config_int_or_none("Machine", "version")	1✔
52	versions = get_config_str_or_none("Machine", "versions")	1✔
53	if versions is not None:	1✔
54	if version is not None:	1!
55	raise SpinnMachineException(	×
56	f"Both {version=} and {versions=} found in cfg")
57	vs = VersionStrings.from_string(versions)	1✔
58	options = vs.options	1✔
59	# Use the fact that we run actions against different python versions
60	minor = sys.version_info.minor	1✔
61	version = options[minor % len(options)]	1✔
62
63	if version in [2, 3]:	1✔
64	return Version3()	1✔
65
66	if version in [4, 5]:	1✔
67	return Version5()	1✔
68
69	if version == SPIN2_1CHIP:	1✔
70	return Version201()	1✔
71
72	if version == SPIN2_48CHIP:	1✔
73	return Version248()	1✔
74
75	spalloc_server = get_config_str_or_none("Machine", "spalloc_server")	1✔
76	if spalloc_server is not None:	1!
77	return Version5()	×
78
79	remote_spinnaker_url = get_config_str_or_none(	1✔
80	"Machine", "remote_spinnaker_url")
81	if remote_spinnaker_url is not None:	1!
82	return Version5()	×
83
84	height = get_config_int_or_none("Machine", "height")	1✔
85	width = get_config_int_or_none("Machine", "width")	1✔
86	if height is not None and width is not None:	1!
87	logger.info("Your cfg file does not have a version")	×
88	if height == width == 2:	×
89	return Version3()	×
90	elif height == width == 1:	×
91	return Version201()	×
92	return Version5()	×
93
94	if version is None:	1!
95	machine_name = get_config_str_or_none("Machine", "machineName")	1✔
96	raise SpinnMachineException(	1✔
97	"cfg [Machine]version {version} is None. "
98	f"Other cfg settings are {machine_name=} {spalloc_server=}, "
99	f"{remote_spinnaker_url=} {width=} {height=}")
UNCOV 100	raise SpinnMachineException(f"Unexpected cfg [Machine]version {version}")	×

SpiNNakerManchester / SpiNNMachine / 9349741890

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous