Merge pull request #80 from OpenQuantumDesign/refactor_backend

Refactor backend

Author: yhteoh

src/oqd_core/backend.py

@@ -0,0 +1,75 @@
+# Copyright 2024-2025 Open Quantum Design
+
+# 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
+
+#     http://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 inspect
+import warnings
+from abc import ABC, abstractmethod
+from typing import Any
+
+########################################################################################
+
+__all__ = [
+    "MetaBackendRegistry",
+    "BackendRegistry",
+    "BackendBase",
+]
+
+########################################################################################
+
+
+class MetaBackendRegistry(type):
+    def __new__(cls, clsname, superclasses, attributedict):
+        attributedict["backends"] = dict()
+        return super().__new__(cls, clsname, superclasses, attributedict)
+
+    def register(cls, backend):
+        if not issubclass(backend, BackendBase):
+            raise TypeError("You may only register subclasses of BackendBase.")
+
+        if backend.__name__ in cls.backends.keys():
+            warnings.warn("Overiding previously registered backend with the same name.")
+
+        cls.backends[backend.__name__] = backend
+
+
+class BackendRegistry(metaclass=MetaBackendRegistry):
+    pass
+
+
+class BackendBase(ABC):
+    @abstractmethod
+    def run(self, program, args):
+        pass
+
+    def __init_subclass__(cls):
+        super().__init_subclass__()
+
+        args = inspect.getfullargspec(cls.run)
+
+        if "program" not in args.annotations:
+            warnings.warn(
+                f"Misisng type hint for argument `program` in run method of {cls.__name__}. Defaults to Any."
+            )
+
+            cls.run.__annotations__["program"] = Any
+
+        if "args" not in args.annotations:
+            warnings.warn(
+                f"Misisng type hint for argument `args` in run method of {cls.__name__}. Defaults to Any."
+            )
+
+            cls.run.__annotations__["args"] = Any
+
+        BackendRegistry.register(cls)