Source code for spinnman.utilities.appid_tracker
# 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.
from typing import Iterable, Optional
_MIN_APP_ID = 17
_MAX_APP_ID = 254
[docs]
class AppIdTracker(object):
"""
A tracker of application IDs to make it easier to allocate new IDs.
"""
__slots__ = (
"_free_ids",
"_max_app_id",
"_min_app_id")
# Keep a class-global reference to the free ID range, so IDs are
# allocated globally
def __init__(
self, app_ids_in_use: Optional[Iterable[int]] = None,
min_app_id: int = _MIN_APP_ID,
max_app_id: int = _MAX_APP_ID):
"""
:param app_ids_in_use: The IDs that are already in use
:type app_ids_in_use: list(int) or None
:param int min_app_id: The smallest application ID to use
:param int max_app_id: The largest application ID to use
"""
self._free_ids = set(range(min_app_id, max_app_id))
if app_ids_in_use is not None:
self._free_ids.difference_update(app_ids_in_use)
self._min_app_id = min_app_id
self._max_app_id = max_app_id
[docs]
def get_new_id(self) -> int:
"""
Get a new unallocated ID
:rtype: int
"""
return self._free_ids.pop()
[docs]
def allocate_id(self, allocated_id: int) -> None:
"""
Allocate a given ID.
:param int allocated_id: The ID to allocate
:raises KeyError: If the ID is not present
"""
self._free_ids.remove(allocated_id)
[docs]
def free_id(self, id_to_free: int) -> None:
"""
Free a given ID.
:param int id_to_free: The ID to free
:raises KeyError: If the ID is out of range
"""
if id_to_free < self._min_app_id or id_to_free > self._max_app_id:
raise KeyError(
f"ID {id_to_free} out of allowed range of {self._min_app_id} "
f"to {self._max_app_id}")
self._free_ids.add(id_to_free)