fm-weck 1.4.8__py3-none-any.whl → 1.5.1__py3-none-any.whl

fm_weck/grpc_service/proto/fm_weck_service_pb2.pyi

@@ -0,0 +1,151 @@
+# This file is part of fm-weck: executing fm-tools in containerized environments.
+# https://gitlab.com/sosy-lab/software/fm-weck
+#
+# SPDX-FileCopyrightText: 2024 Dirk Beyer <https://www.sosy-lab.org>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from google.protobuf.internal import containers as _containers
+from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union
+
+DESCRIPTOR: _descriptor.FileDescriptor
+
+class ErrorCode(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
+    __slots__ = ()
+    EC_RUN_NOT_TERMINATED: _ClassVar[ErrorCode]
+    EC_RUN_NOT_FOUND: _ClassVar[ErrorCode]
+    EC_RUN_CANCELLED: _ClassVar[ErrorCode]
+    EC_RUN_FAILED: _ClassVar[ErrorCode]
+    EC_UNKNOWN_ERROR: _ClassVar[ErrorCode]
+EC_RUN_NOT_TERMINATED: ErrorCode
+EC_RUN_NOT_FOUND: ErrorCode
+EC_RUN_CANCELLED: ErrorCode
+EC_RUN_FAILED: ErrorCode
+EC_UNKNOWN_ERROR: ErrorCode
+
+class ToolType(_message.Message):
+    __slots__ = ("tool_version", "tool_file", "tool_id")
+    TOOL_VERSION_FIELD_NUMBER: _ClassVar[int]
+    TOOL_FILE_FIELD_NUMBER: _ClassVar[int]
+    TOOL_ID_FIELD_NUMBER: _ClassVar[int]
+    tool_version: str
+    tool_file: File
+    tool_id: str
+    def __init__(self, tool_version: _Optional[str] = ..., tool_file: _Optional[_Union[File, _Mapping]] = ..., tool_id: _Optional[str] = ...) -> None: ...
+
+class Property(_message.Message):
+    __slots__ = ("property_id", "property_file")
+    PROPERTY_ID_FIELD_NUMBER: _ClassVar[int]
+    PROPERTY_FILE_FIELD_NUMBER: _ClassVar[int]
+    property_id: str
+    property_file: File
+    def __init__(self, property_id: _Optional[str] = ..., property_file: _Optional[_Union[File, _Mapping]] = ...) -> None: ...
+
+class RunRequest(_message.Message):
+    __slots__ = ("tool", "property", "c_program", "data_model")
+    TOOL_FIELD_NUMBER: _ClassVar[int]
+    PROPERTY_FIELD_NUMBER: _ClassVar[int]
+    C_PROGRAM_FIELD_NUMBER: _ClassVar[int]
+    DATA_MODEL_FIELD_NUMBER: _ClassVar[int]
+    tool: ToolType
+    property: Property
+    c_program: bytes
+    data_model: str
+    def __init__(self, tool: _Optional[_Union[ToolType, _Mapping]] = ..., property: _Optional[_Union[Property, _Mapping]] = ..., c_program: _Optional[bytes] = ..., data_model: _Optional[str] = ...) -> None: ...
+
+class ExpertRunRequest(_message.Message):
+    __slots__ = ("tool", "command")
+    TOOL_FIELD_NUMBER: _ClassVar[int]
+    COMMAND_FIELD_NUMBER: _ClassVar[int]
+    tool: ToolType
+    command: _containers.RepeatedScalarFieldContainer[str]
+    def __init__(self, tool: _Optional[_Union[ToolType, _Mapping]] = ..., command: _Optional[_Iterable[str]] = ...) -> None: ...
+
+class RunResult(_message.Message):
+    __slots__ = ("run_id", "success", "output", "filenames")
+    RUN_ID_FIELD_NUMBER: _ClassVar[int]
+    SUCCESS_FIELD_NUMBER: _ClassVar[int]
+    OUTPUT_FIELD_NUMBER: _ClassVar[int]
+    FILENAMES_FIELD_NUMBER: _ClassVar[int]
+    run_id: RunID
+    success: bool
+    output: str
+    filenames: _containers.RepeatedScalarFieldContainer[str]
+    def __init__(self, run_id: _Optional[_Union[RunID, _Mapping]] = ..., success: bool = ..., output: _Optional[str] = ..., filenames: _Optional[_Iterable[str]] = ...) -> None: ...
+
+class WaitRunResult(_message.Message):
+    __slots__ = ("timeout", "error", "run_result")
+    TIMEOUT_FIELD_NUMBER: _ClassVar[int]
+    ERROR_FIELD_NUMBER: _ClassVar[int]
+    RUN_RESULT_FIELD_NUMBER: _ClassVar[int]
+    timeout: bool
+    error: ErrorCode
+    run_result: RunResult
+    def __init__(self, timeout: bool = ..., error: _Optional[_Union[ErrorCode, str]] = ..., run_result: _Optional[_Union[RunResult, _Mapping]] = ...) -> None: ...
+
+class CancelRunRequest(_message.Message):
+    __slots__ = ("run_id", "timeout", "cleanup_on_success")
+    RUN_ID_FIELD_NUMBER: _ClassVar[int]
+    TIMEOUT_FIELD_NUMBER: _ClassVar[int]
+    CLEANUP_ON_SUCCESS_FIELD_NUMBER: _ClassVar[int]
+    run_id: RunID
+    timeout: int
+    cleanup_on_success: bool
+    def __init__(self, run_id: _Optional[_Union[RunID, _Mapping]] = ..., timeout: _Optional[int] = ..., cleanup_on_success: bool = ...) -> None: ...
+
+class CancelRunResult(_message.Message):
+    __slots__ = ("timeout", "error", "run_result")
+    TIMEOUT_FIELD_NUMBER: _ClassVar[int]
+    ERROR_FIELD_NUMBER: _ClassVar[int]
+    RUN_RESULT_FIELD_NUMBER: _ClassVar[int]
+    timeout: bool
+    error: ErrorCode
+    run_result: RunResult
+    def __init__(self, timeout: bool = ..., error: _Optional[_Union[ErrorCode, str]] = ..., run_result: _Optional[_Union[RunResult, _Mapping]] = ...) -> None: ...
+
+class CleanUpResponse(_message.Message):
+    __slots__ = ("success", "error")
+    SUCCESS_FIELD_NUMBER: _ClassVar[int]
+    ERROR_FIELD_NUMBER: _ClassVar[int]
+    success: bool
+    error: ErrorCode
+    def __init__(self, success: bool = ..., error: _Optional[_Union[ErrorCode, str]] = ...) -> None: ...
+
+class RunID(_message.Message):
+    __slots__ = ("run_id",)
+    RUN_ID_FIELD_NUMBER: _ClassVar[int]
+    run_id: str
+    def __init__(self, run_id: _Optional[str] = ...) -> None: ...
+
+class WaitParameters(_message.Message):
+    __slots__ = ("timeout", "run_id")
+    TIMEOUT_FIELD_NUMBER: _ClassVar[int]
+    RUN_ID_FIELD_NUMBER: _ClassVar[int]
+    timeout: int
+    run_id: RunID
+    def __init__(self, timeout: _Optional[int] = ..., run_id: _Optional[_Union[RunID, _Mapping]] = ...) -> None: ...
+
+class FileQuery(_message.Message):
+    __slots__ = ("run_id", "filenames", "name_patterns")
+    RUN_ID_FIELD_NUMBER: _ClassVar[int]
+    FILENAMES_FIELD_NUMBER: _ClassVar[int]
+    NAME_PATTERNS_FIELD_NUMBER: _ClassVar[int]
+    run_id: RunID
+    filenames: _containers.RepeatedScalarFieldContainer[str]
+    name_patterns: _containers.RepeatedScalarFieldContainer[str]
+    def __init__(self, run_id: _Optional[_Union[RunID, _Mapping]] = ..., filenames: _Optional[_Iterable[str]] = ..., name_patterns: _Optional[_Iterable[str]] = ...) -> None: ...
+
+class File(_message.Message):
+    __slots__ = ("name", "file")
+    NAME_FIELD_NUMBER: _ClassVar[int]
+    FILE_FIELD_NUMBER: _ClassVar[int]
+    name: str
+    file: bytes
+    def __init__(self, name: _Optional[str] = ..., file: _Optional[bytes] = ...) -> None: ...
+
+class Empty(_message.Message):
+    __slots__ = ()
+    def __init__(self) -> None: ...

fm_weck/grpc_service/proto/fm_weck_service_pb2_grpc.py

@@ -0,0 +1,331 @@
+# This file is part of fm-weck: executing fm-tools in containerized environments.
+# https://gitlab.com/sosy-lab/software/fm-weck
+#
+# SPDX-FileCopyrightText: 2024 Dirk Beyer <https://www.sosy-lab.org>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+from . import fm_weck_service_pb2 as fm__weck__service__pb2
+
+GRPC_GENERATED_VERSION = '1.71.0'
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+    _version_not_supported = first_version_is_lower(GRPC_VERSION, GRPC_GENERATED_VERSION)
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f'The grpc package installed is at version {GRPC_VERSION},'
+        + f' but the generated code in fm_weck_service_pb2_grpc.py depends on'
+        + f' grpcio>={GRPC_GENERATED_VERSION}.'
+        + f' Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}'
+        + f' or downgrade your generated code using grpcio-tools<={GRPC_VERSION}.'
+    )
+
+
+class FmWeckRemoteStub(object):
+    """This service runs fm-weck remotely.
+
+    """
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.startRun = channel.unary_unary(
+                '/FmWeckRemote/startRun',
+                request_serializer=fm__weck__service__pb2.RunRequest.SerializeToString,
+                response_deserializer=fm__weck__service__pb2.RunID.FromString,
+                _registered_method=True)
+        self.startExpertRun = channel.unary_unary(
+                '/FmWeckRemote/startExpertRun',
+                request_serializer=fm__weck__service__pb2.ExpertRunRequest.SerializeToString,
+                response_deserializer=fm__weck__service__pb2.RunID.FromString,
+                _registered_method=True)
+        self.cancelRun = channel.unary_unary(
+                '/FmWeckRemote/cancelRun',
+                request_serializer=fm__weck__service__pb2.CancelRunRequest.SerializeToString,
+                response_deserializer=fm__weck__service__pb2.CancelRunResult.FromString,
+                _registered_method=True)
+        self.cleanupRun = channel.unary_unary(
+                '/FmWeckRemote/cleanupRun',
+                request_serializer=fm__weck__service__pb2.RunID.SerializeToString,
+                response_deserializer=fm__weck__service__pb2.CleanUpResponse.FromString,
+                _registered_method=True)
+        self.waitOnRun = channel.unary_unary(
+                '/FmWeckRemote/waitOnRun',
+                request_serializer=fm__weck__service__pb2.WaitParameters.SerializeToString,
+                response_deserializer=fm__weck__service__pb2.WaitRunResult.FromString,
+                _registered_method=True)
+        self.queryFiles = channel.unary_stream(
+                '/FmWeckRemote/queryFiles',
+                request_serializer=fm__weck__service__pb2.FileQuery.SerializeToString,
+                response_deserializer=fm__weck__service__pb2.File.FromString,
+                _registered_method=True)
+
+
+class FmWeckRemoteServicer(object):
+    """This service runs fm-weck remotely.
+
+    """
+
+    def startRun(self, request, context):
+        """Runs a verification task for a given C program.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def startExpertRun(self, request, context):
+        """Runs a tool in expert mode
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def cancelRun(self, request, context):
+        """Cancels a previously started run.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def cleanupRun(self, request, context):
+        """Cleans up files of a finished run.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def waitOnRun(self, request, context):
+        """Gets the result of a previously started run using its unique ID.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+    def queryFiles(self, request, context):
+        """Query for a number of result files.
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+def add_FmWeckRemoteServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'startRun': grpc.unary_unary_rpc_method_handler(
+                    servicer.startRun,
+                    request_deserializer=fm__weck__service__pb2.RunRequest.FromString,
+                    response_serializer=fm__weck__service__pb2.RunID.SerializeToString,
+            ),
+            'startExpertRun': grpc.unary_unary_rpc_method_handler(
+                    servicer.startExpertRun,
+                    request_deserializer=fm__weck__service__pb2.ExpertRunRequest.FromString,
+                    response_serializer=fm__weck__service__pb2.RunID.SerializeToString,
+            ),
+            'cancelRun': grpc.unary_unary_rpc_method_handler(
+                    servicer.cancelRun,
+                    request_deserializer=fm__weck__service__pb2.CancelRunRequest.FromString,
+                    response_serializer=fm__weck__service__pb2.CancelRunResult.SerializeToString,
+            ),
+            'cleanupRun': grpc.unary_unary_rpc_method_handler(
+                    servicer.cleanupRun,
+                    request_deserializer=fm__weck__service__pb2.RunID.FromString,
+                    response_serializer=fm__weck__service__pb2.CleanUpResponse.SerializeToString,
+            ),
+            'waitOnRun': grpc.unary_unary_rpc_method_handler(
+                    servicer.waitOnRun,
+                    request_deserializer=fm__weck__service__pb2.WaitParameters.FromString,
+                    response_serializer=fm__weck__service__pb2.WaitRunResult.SerializeToString,
+            ),
+            'queryFiles': grpc.unary_stream_rpc_method_handler(
+                    servicer.queryFiles,
+                    request_deserializer=fm__weck__service__pb2.FileQuery.FromString,
+                    response_serializer=fm__weck__service__pb2.File.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'FmWeckRemote', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+    server.add_registered_method_handlers('FmWeckRemote', rpc_method_handlers)
+
+
+ # This class is part of an EXPERIMENTAL API.
+class FmWeckRemote(object):
+    """This service runs fm-weck remotely.
+
+    """
+
+    @staticmethod
+    def startRun(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/FmWeckRemote/startRun',
+            fm__weck__service__pb2.RunRequest.SerializeToString,
+            fm__weck__service__pb2.RunID.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def startExpertRun(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/FmWeckRemote/startExpertRun',
+            fm__weck__service__pb2.ExpertRunRequest.SerializeToString,
+            fm__weck__service__pb2.RunID.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def cancelRun(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/FmWeckRemote/cancelRun',
+            fm__weck__service__pb2.CancelRunRequest.SerializeToString,
+            fm__weck__service__pb2.CancelRunResult.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def cleanupRun(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/FmWeckRemote/cleanupRun',
+            fm__weck__service__pb2.RunID.SerializeToString,
+            fm__weck__service__pb2.CleanUpResponse.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def waitOnRun(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            '/FmWeckRemote/waitOnRun',
+            fm__weck__service__pb2.WaitParameters.SerializeToString,
+            fm__weck__service__pb2.WaitRunResult.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)
+
+    @staticmethod
+    def queryFiles(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(
+            request,
+            target,
+            '/FmWeckRemote/queryFiles',
+            fm__weck__service__pb2.FileQuery.SerializeToString,
+            fm__weck__service__pb2.File.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+            _registered_method=True)

fm_weck/grpc_service/proto/generate_protocol_files.sh

@@ -0,0 +1,18 @@
+# This file is part of fm-weck: executing fm-tools in containerized environments.
+# https://gitlab.com/sosy-lab/software/fm-weck
+#
+# SPDX-FileCopyrightText: 2024 Dirk Beyer <https://www.sosy-lab.org>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+#!/bin/bash
+
+script_dir="$(dirname "$(realpath "$0")")"
+
+cd "$script_dir" || exit
+
+python -m grpc_tools.protoc -I./ --python_out=./ --pyi_out=./ --grpc_python_out=./ ./fm_weck_service.proto
+
+sed -i 's/^import fm_weck_service_pb2 as fm__weck__service__pb2/from . import fm_weck_service_pb2 as fm__weck__service__pb2/' fm_weck_service_pb2_grpc.py
+
+reuse annotate -y 2024 -l Apache-2.0 -c "Dirk Beyer <https://www.sosy-lab.org>" --template header --skip-existing --skip-unrecognised ./fm_weck_service_pb2_grpc.py ./fm_weck_service_pb2.pyi ./fm_weck_service_pb2.py