-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Implement parameter type validation in DB editor
Parameter (default) values are now validated in a parallel process in Database editor. Re #2791
- Loading branch information
Showing
20 changed files
with
798 additions
and
252 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| ###################################################################################################################### | ||
| # Copyright (C) 2017-2022 Spine project consortium | ||
| # Copyright Spine Toolbox contributors | ||
| # This file is part of Spine Toolbox. | ||
| # Spine Toolbox is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General | ||
| # Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) | ||
| # any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; | ||
| # without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General | ||
| # Public License for more details. You should have received a copy of the GNU Lesser General Public License along with | ||
| # this program. If not, see <http://www.gnu.org/licenses/>. | ||
| ###################################################################################################################### | ||
| """Contains utilities for validating parameter types.""" | ||
| from dataclasses import dataclass | ||
| from multiprocessing import Pipe, Process | ||
| from typing import Any, Iterable, Optional, Tuple | ||
| from PySide6.QtCore import QObject, QTimer, Signal, Slot | ||
| from spinedb_api.db_mapping_helpers import is_parameter_type_valid, type_check_args | ||
|
|
||
| CHUNK_SIZE = 20 | ||
|
|
||
|
|
||
| @dataclass(frozen=True) | ||
| class ValidationKey: | ||
| item_type: str | ||
| db_map_id: int | ||
| item_private_id: int | ||
|
|
||
|
|
||
| @dataclass(frozen=True) | ||
| class ValidatableValue: | ||
| key: ValidationKey | ||
| args: Tuple[Iterable[str], Optional[bytes], Optional[Any], Optional[str]] | ||
|
|
||
|
|
||
| class ParameterTypeValidator(QObject): | ||
| """Handles parameter type validation in a concurrent process.""" | ||
|
|
||
| validated = Signal(ValidationKey, bool) | ||
|
|
||
| def __init__(self, parent=None): | ||
| """ | ||
| Args: | ||
| parent (QObject, optional): parent object | ||
| """ | ||
| super().__init__(parent) | ||
| self._connection, scheduler_connection = Pipe() | ||
| self._process = Process(target=schedule, name="Type validation worker", args=(scheduler_connection,)) | ||
| self._timer = QTimer(self) | ||
| self._timer.setInterval(100) | ||
| self._timer.timeout.connect(self._communicate) | ||
| self._task_queue = [] | ||
| self._sent_task_count = 0 | ||
|
|
||
| def set_interval(self, interval): | ||
| """Sets the interval between communication attempts with the validation process. | ||
| Args: | ||
| interval (int): interval in milliseconds | ||
| """ | ||
| self._timer.setInterval(interval) | ||
|
|
||
| def start_validating(self, db_mngr, db_map, value_item_ids): | ||
| """Initiates validation of given parameter definition/value items. | ||
| Args: | ||
| db_mngr (SpineDBManager): database manager | ||
| db_map (DatabaseMapping): database mapping | ||
| value_item_ids (Iterable of TempId): item ids to validate | ||
| """ | ||
| if not self._process.is_alive(): | ||
| self._process.start() | ||
| for item_id in value_item_ids: | ||
| item = db_mngr.get_item(db_map, item_id.item_type, item_id) | ||
| args = type_check_args(item) | ||
| self._task_queue.append( | ||
| ValidatableValue(ValidationKey(item_id.item_type, id(db_map), item_id.private_id), args) | ||
| ) | ||
| self._sent_task_count += 1 | ||
| if not self._timer.isActive(): | ||
| chunk = self._task_queue[:CHUNK_SIZE] | ||
| self._task_queue = self._task_queue[CHUNK_SIZE:] | ||
| self._connection.send(chunk) | ||
| self._timer.start() | ||
|
|
||
| @Slot() | ||
| def _communicate(self): | ||
| """Communicates with the validation process.""" | ||
| self._timer.stop() | ||
| if self._connection.poll(): | ||
| results = self._connection.recv() | ||
| for key, result in results.items(): | ||
| self.validated.emit(key, result) | ||
| self._sent_task_count -= len(results) | ||
| if self._task_queue and self._sent_task_count < 3 * CHUNK_SIZE: | ||
| chunk = self._task_queue[:CHUNK_SIZE] | ||
| self._task_queue = self._task_queue[CHUNK_SIZE:] | ||
| self._connection.send(chunk) | ||
| if not self._task_queue and self._sent_task_count == 0: | ||
| return | ||
| self._timer.start() | ||
|
|
||
| def tear_down(self): | ||
| """Cleans up the validation process.""" | ||
| self._timer.stop() | ||
| if self._process.is_alive(): | ||
| self._connection.send("quit") | ||
| self._process.join() | ||
|
|
||
|
|
||
| def validate_chunk(validatable_values): | ||
| """Validates given parameter definitions/values. | ||
| Args: | ||
| validatable_values (Iterable of ValidatableValue): values to validate | ||
| Returns: | ||
| dict: mapping from ValidationKey to boolean | ||
| """ | ||
| results = {} | ||
| for validatable_value in validatable_values: | ||
| results[validatable_value.key] = is_parameter_type_valid(*validatable_value.args) | ||
| return results | ||
|
|
||
|
|
||
| def schedule(connection): | ||
| """Loops over incoming messages and sends responses back. | ||
| Args: | ||
| connection (Connection): A duplex Pipe end | ||
| """ | ||
| validatable_values = [] | ||
| while True: | ||
| if connection.poll() or not validatable_values: | ||
| while True: | ||
| task = connection.recv() | ||
| if task == "quit": | ||
| return | ||
| validatable_values += task | ||
| if not connection.poll(): | ||
| break | ||
| chunk = validatable_values[:CHUNK_SIZE] | ||
| validatable_values = validatable_values[CHUNK_SIZE:] | ||
| results = validate_chunk(chunk) | ||
| connection.send(results) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.