arkitekt-next 0.9.4__py3-none-any.whl → 0.10.1__py3-none-any.whl

arkitekt_next/init_registry.py

@@ -1,22 +1,7 @@
 import contextvars
 from functools import wraps
-from pydantic import BaseModel, Field
-from herre_next import Herre
-from fakts_next import Fakts
-from .base_models import Manifest, Requirement
-from typing import Callable, Dict, Optional, Protocol, TypeVar, overload
-import importlib
-import sys
-import os
-import traceback
-import logging
-import pkgutil
-from typing import runtime_checkable, TYPE_CHECKING, Any
-
-if TYPE_CHECKING:
-    from arkitekt_next.apps import App
-else:
-    App = Any
+from typing import Callable, Dict, Optional, TypeVar, overload, cast
+from arkitekt_next.apps.protocols import App
 
 Params = Dict[str, str]
 
@@ -38,68 +23,10 @@ def get_current_init_hook_registry(allow_global=True):
     return current_init_hook_registry.get(get_default_init_hook_registry())
 
 
-class Registration(BaseModel):
-    name: str
-    requirement: Requirement
-    builder: Callable[[Herre, Fakts, Params], object]
-    schema_loader: Callable[[str], object]
-
-
-@runtime_checkable
-class ArkitektService(Protocol):
-
-    def get_service_name(self):
-        pass
-
-    def build_service(
-        self, fakts: Fakts, herre: Herre, params: Params, manifest: Manifest
-    ):
-        pass
-
-    def get_requirements(self):
-        pass
-
-    def get_graphql_schema(self):
-        pass
-
-    def get_turms_project(self):
-        pass
-
-
-class BaseArkitektService:
-
-    def get_service_name(self):
-        raise NotImplementedError("get_service_name not implemented")
-
-    def build_service(
-        self, fakts: Fakts, herre: Herre, params: Params, manifest: Manifest
-    ):
-        raise NotImplementedError("build_service not implemented")
-
-    def get_requirements(self):
-        raise NotImplementedError("get_requirements not implemented")
-
-    def get_graphql_schema(self):
-        return None
-
-    def get_turms_project(self):
-        return None
-
-
-basic_requirements = [
-    Requirement(
-        key="lok",
-        service="live.arkitekt.lok",
-        description="An instance of ArkitektNext Lok to authenticate the user",
-    )
-]
-
-
 InitHook = Callable[[App], None]
 
 
 class InitHookRegisty:
-
     def __init__(self):
         self.init_hooks: Dict[str, InitHook] = {}
 
@@ -109,7 +36,6 @@ class InitHookRegisty:
         name: Optional[str] = None,
         only_cli: bool = False,
     ):
-
         if name is None:
             name = function.__name__
 
@@ -123,43 +49,41 @@ class InitHookRegisty:
             hook(app)
 
 
-T = TypeVar("T")
+T = TypeVar("T", bound=InitHook)
 
 
 @overload
 def init(
-    function_or_actor: T,
+    *func: T,
 ) -> T: ...
 
 
 @overload
 def init(
-    function_or_actor: None = None,
+    *,
+    only_cli: bool = False,
+    init_hook_registry: InitHookRegisty | None = None,
 ) -> Callable[[T], T]: ...
 
 
 def init(
-    *func,
+    *func: T,
     only_cli: bool = False,
-    init_hook_registry: InitHookRegisty = None,
-):
+    init_hook_registry: InitHookRegisty | None = None,
+) -> T | Callable[[T], T]:
     """Register a function as an init hook. This function will be called when the app is initialized."""
-    init_hook_registry = init_hook_registry or get_current_init_hook_registry()
+    init_hook_registry = init_hook_registry or get_default_init_hook_registry()
 
     if len(func) > 1:
         raise ValueError("You can only register one function or actor at a time.")
     if len(func) == 1:
         function_or_actor = func[0]
 
-        @wraps(function_or_actor)
-        def wrapped_function(*args, **kwargs):
-            return function_or_actor(*args, **kwargs)
-
-        init_hook_registry.register(wrapped_function)
+        init_hook_registry.register(function_or_actor)
 
-        wrapped_function.__is_init_hook__ = True
+        setattr(function_or_actor, "__is_init_hook__", True)
 
-        return wrapped_function
+        return function_or_actor
 
     else:
 
@@ -171,8 +95,8 @@ def init(
 
             init_hook_registry.register(wrapped_function, only_cli=only_cli)
 
-            wrapped_function.__is_init_hook__ = True
+            setattr(function_or_actor, "__is_init_hook__", True)
 
             return wrapped_function
 
-        return real_decorator
+        return cast(Callable[[T], T], real_decorator)

arkitekt_next/qt/builders.py

@@ -5,7 +5,7 @@ from arkitekt_next.apps.service.fakts_qt import build_arkitekt_next_qt_fakts_nex
 from arkitekt_next.apps.service.herre_qt import build_arkitekt_next_qt_herre_next
 from arkitekt_next.utils import create_arkitekt_next_folder
 from arkitekt_next.base_models import Manifest
-from arkitekt_next.apps.types import App
+from arkitekt_next.apps.protocols import App
 from arkitekt_next.service_registry import (
     ServiceBuilderRegistry,
     get_default_service_registry,
@@ -27,7 +27,7 @@ from arkitekt_next.apps.service.fakts_next import (
 from arkitekt_next.apps.service.herre import build_arkitekt_next_herre_next
 from arkitekt_next.utils import create_arkitekt_next_folder
 from arkitekt_next.base_models import Manifest
-from arkitekt_next.apps.types import App
+from arkitekt_next.apps.protocols import App
 from arkitekt_next.service_registry import (
     ServiceBuilderRegistry,
 )

arkitekt_next/qt/magic_bar.py

@@ -3,7 +3,7 @@ from qtpy import QtWidgets, QtGui, QtCore
 from arkitekt_next.qt.types import QtApp
 from koil.qt import async_to_qt
 
-from arkitekt_next.apps.types import App
+from arkitekt_next.apps.protocols import App
 from .utils import get_image_path
 from typing import Optional, Callable
 import logging

arkitekt_next/qt/types.py

@@ -1,4 +1,4 @@
-from arkitekt_next.apps.types import App, Fakts, Herre, Manifest
+from arkitekt_next.apps.protocols import App, Fakts, Herre, Manifest
 from typing import List, Callable, Dict, Any
 
 

arkitekt_next/service_registry.py

@@ -1,11 +1,11 @@
 import contextvars
-from functools import wraps
-from pydantic import BaseModel, Field
 from herre_next import Herre
 from fakts_next import Fakts
+from koil.composition.base import KoiledModel
 from .base_models import Manifest, Requirement
-from typing import Callable, Dict, Optional, Protocol, TypeVar, overload
+from typing import Any, Callable, Dict, Optional, Protocol, Set, TypeVar, overload
 from typing import runtime_checkable
+from pydantic import BaseModel
 
 Params = Dict[str, str]
 
@@ -16,17 +16,13 @@ current_service_registry = contextvars.ContextVar(
 GLOBAL_SERVICE_REGISTRY = None
 
 
-def get_default_service_registry():
+def get_default_service_registry() -> "ServiceBuilderRegistry":
     global GLOBAL_SERVICE_REGISTRY
     if GLOBAL_SERVICE_REGISTRY is None:
         GLOBAL_SERVICE_REGISTRY = ServiceBuilderRegistry()
     return GLOBAL_SERVICE_REGISTRY
 
 
-def get_current_service_registry(allow_global=True):
-    return current_service_registry.get(get_default_service_registry())
-
-
 class Registration(BaseModel):
     name: str
     requirement: Requirement
@@ -36,42 +32,68 @@ class Registration(BaseModel):
 
 @runtime_checkable
 class ArkitektService(Protocol):
-
-    def get_service_name(self):
-        pass
+    def get_service_name(self) -> str:
+        """Get the service name. This is used to identify the service in the
+        service registry. The service name should be unique across all services.
+        """
+        ...
 
     def build_service(
         self, fakts: Fakts, herre: Herre, params: Params, manifest: Manifest
-    ):
-        pass
-
-    def get_requirements(self):
-        pass
-
-    def get_graphql_schema(self):
+    ) -> Optional[KoiledModel]:
+        """Build the service. This is used to build the service and return
+        the service instance. The service instance should be a KoiledModel
+        that is used to interact with the service.
+        """
+        ...
+
+    def get_requirements(self) -> list[Requirement]:
+        """Get the requirements for the service. This is used to get the
+        requirements for the service. The requirements should be a list of
+        Requirement objects that are used to identify the service in the
+        service registry. The requirements should be unique across all
+        """
+        ...
+
+    def get_graphql_schema(self) -> Optional[str]:
+        """Get the GraphQL schema for the service. This is used to get the
+        GraphQL schema for the service. The GraphQL schema should be a
+        GraphQL schema object that is used to interact with the service.
+        """
         pass
 
-    def get_turms_project(self):
+    def get_turms_project(self) -> Optional[Dict[str, Any]]:
+        """Get the Turms project for the service. This is used to get the
+        Turms project for the service. The Turms project should be a
+        Turms project object that is used to interact with the service.
+        """
         pass
 
 
 class BaseArkitektService:
+    """Base class for Arkitekt services. This class is used to define the
+    interface for Arkitekt services. It is used to define the service name,
+    build the service, and get the requirements for the service."""
 
-    def get_service_name(self):
+    def get_service_name(self) -> str:
         raise NotImplementedError("get_service_name not implemented")
 
     def build_service(
         self, fakts: Fakts, herre: Herre, params: Params, manifest: Manifest
-    ):
+    ) -> Optional[KoiledModel]:
         raise NotImplementedError("build_service not implemented")
 
-    def get_requirements(self):
+    def get_requirements(self) -> list[Requirement]:
         raise NotImplementedError("get_requirements not implemented")
 
-    def get_graphql_schema(self):
+    def get_graphql_schema(self) -> Optional[str]:
         return None
 
-    def get_turms_project(self):
+    def get_turms_project(self) -> Optional[Dict[str, Any]]:
+        """Get the Turms project for the service. This is used to get the
+        Turms project for the service. The Turms project should be a
+        Turms project object that is used to interact with the service.
+        """
         return None
 
 
@@ -93,7 +115,6 @@ class ServiceBuilderRegistry:
         self,
         service: ArkitektService,
     ):
-
         name = service.get_service_name()
 
         if name not in self.service_builders:
@@ -106,8 +127,8 @@ class ServiceBuilderRegistry:
             raise ValueError(f"Requirement {requirement.key} already registered)")
         self.additional_requirements[requirement.key] = requirement
 
-    def get(self, name):
-        return self.services.get(name)
+    def get(self, name: str) -> Optional[ArkitektService]:
+        return self.service_builders.get(name)
 
     def build_service_map(
         self, fakts: Fakts, herre: Herre, params: Params, manifest: Manifest
@@ -124,7 +145,6 @@ class ServiceBuilderRegistry:
         }
 
     def get_requirements(self):
-
         requirements = [
             Requirement(
                 key="lok",
@@ -132,7 +152,7 @@ class ServiceBuilderRegistry:
                 description="An instance of ArkitektNext Lok to authenticate the user",
             )
         ]
-        taken_requirements = set()
+        taken_requirements: Set[str] = set()
 
         for service in self.service_builders.values():
             for requirement in service.get_requirements():
@@ -154,31 +174,17 @@ class SetupInfo:
     services: Dict[str, object]
 
 
-import os
-import importlib.util
-import pkgutil
-import traceback
-import logging
-
 T = TypeVar("T")
 
 
-@overload
-def require(
-    key: str,
-    service: str = None,
-    description: str = None,
-) -> Callable[[T], T]: ...
-
-
 def require(
     key: str,
-    service: str = None,
-    description: str = None,
+    service: str,
+    description: str | None = None,
     service_registry: Optional[ServiceBuilderRegistry] = None,
 ):
     """Register a requirement with the service registry"""
-    service_hook_registry = service_registry or get_current_service_registry()
+    service_hook_registry = service_registry or get_default_service_registry()
 
     requirement = Requirement(key=key, service=service, description=description)
     service_hook_registry.register_requirement(requirement)

arkitekt_next/tqdm.py

@@ -1,11 +1,14 @@
-""" Small extension to tqdm that reports progress to arkitekt_next through the
+"""Small extension to tqdm that reports progress to arkitekt_next through the
 assignation context"""
 
+from typing import Any, Iterable, Mapping, TypeVar
 from tqdm import tqdm as _tqdm
-from rekuest_next.actors.vars import current_assignation_helper
+from rekuest_next.actors.vars import get_current_assignation_helper
 
+T = TypeVar("T")
 
-class tqdm(_tqdm):
+
+class tqdm(_tqdm[T]):
     """A tqdm that reports progress to arkitekt_next through the
     assignation context
 
@@ -18,15 +21,70 @@ class tqdm(_tqdm):
 
     """
 
-    def __init__(self, *args, **kwargs) -> None:
+    def __init__(
+        self,
+        iterable: Iterable[T],
+        desc: str | None = None,
+        total: float | None = None,
+        leave: bool | None = True,
+        file: Any | None = None,
+        ncols: int | None = None,
+        mininterval: float = 0.1,
+        maxinterval: float = 10.0,
+        miniters: float | None = None,
+        ascii: bool | str | None = None,
+        disable: bool | None = False,
+        unit: str = "it",
+        unit_scale: bool | float = False,
+        dynamic_ncols: bool = False,
+        smoothing: float = 0.3,
+        bar_format: str | None = None,
+        initial: float = 0,
+        position: int | None = None,
+        postfix: Mapping[str, object] | str | None = None,
+        unit_divisor: float = 1000,
+        write_bytes: bool = False,
+        lock_args: tuple[bool | None, float | None] | tuple[bool | None] | None = None,
+        nrows: int | None = None,
+        colour: str | None = None,
+        delay: float | None = 0,
+        gui: bool = False,
+    ) -> None:
         """The tqdm constructor"""
-        super().__init__(*args, **kwargs)
+        super().__init__(
+            iterable,
+            desc=desc,
+            total=total,
+            leave=leave,
+            file=file,
+            ncols=ncols,
+            mininterval=mininterval,
+            maxinterval=maxinterval,
+            miniters=miniters,
+            ascii=ascii,
+            disable=disable,
+            unit=unit,
+            unit_scale=unit_scale,
+            dynamic_ncols=dynamic_ncols,
+            smoothing=smoothing,
+            bar_format=bar_format,
+            initial=initial,
+            position=position,
+            postfix=postfix,
+            unit_divisor=unit_divisor,
+            write_bytes=write_bytes,
+            lock_args=lock_args,
+            nrows=nrows,
+            colour=colour,
+            delay=delay,
+            gui=gui,
+        )
 
-        self._assignationhelper = current_assignation_helper.get(None)
+        self._assignationhelper = get_current_assignation_helper()
 
         self.last_arkitekt_next_perc = 0
 
-    def update(self, *args, **kwargs):
+    def update(self, *args: Any, **kwargs: Any):
         """An update method that reports progress to arkitekt_next through the
         assignation context and the current assignation helper
 
@@ -35,6 +93,9 @@ class tqdm(_tqdm):
         The return value of tqdm.update
         """
         z = super().update(*args, **kwargs)
+
+        self._assignationhelper = get_current_assignation_helper()
+
         if self._assignationhelper:
             if self.last_arkitekt_next_perc + 0.05 < self.last_print_n / self.total:
                 self.last_arkitekt_next_perc = self.last_print_n / self.total

arkitekt_next/utils.py

@@ -43,10 +43,11 @@ def create_arkitekt_next_folder(with_cache: bool = True) -> str:
 def create_devcontainer_file(
     manifest: Manifest,
     flavour: str,
-    docker_file_path,
-    devcontainer_path=".devcontainer",
+    docker_file_path: str,
+    devcontainer_path: str = ".devcontainer",
 ) -> None:
-    """Creates a devcontainer.json file in the flavour folder.
+    """Creates a devcontainer.json file that matches the docker file
+    inside the flavour folder.
 
     Parameters
     ----------
@@ -67,9 +68,9 @@ def create_devcontainer_file(
     devcontainer_content["build"]["dockerfile"] = os.path.relpath(
         docker_file_path, flavour_container
     )
-    devcontainer_content["build"][
-        "context"
-    ] = "../.."  # This is the root of the project
+    devcontainer_content["build"]["context"] = (
+        "../.."  # This is the root of the project
+    )
     devcontainer_content["runArgs"] = ["--network=host"]
 
     json.dump(devcontainer_content, open(devcontainer_file, "w"), indent=4)

{arkitekt_next-0.9.4.dist-info → arkitekt_next-0.10.1.dist-info}/METADATA

@@ -1,58 +1,59 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: arkitekt-next
-Version: 0.9.4
+Version: 0.10.1
 Summary: client for the arkitekt_next platform
-License: MIT
-Author: jhnnsrs
-Author-email: jhnnsrs@gmail.com
-Requires-Python: >=3.9,<4
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
+Author-email: jhnnsrs <jhnnsrs@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: <4,>=3.11
+Requires-Dist: click>=8.2.0
+Requires-Dist: dokker>=2.1.2
+Requires-Dist: fakts-next>=1.2.2
+Requires-Dist: herre-next>=1.2.0
+Requires-Dist: koil>=2.0.4
+Requires-Dist: rath>=3.4
 Provides-Extra: all
+Requires-Dist: fluss-next>=0.2.0; extra == 'all'
+Requires-Dist: kabinet>=0.2.0; extra == 'all'
+Requires-Dist: mikro-next>=0.2.0; extra == 'all'
+Requires-Dist: reaktion-next>=0.2.0; extra == 'all'
+Requires-Dist: rekuest-next>=0.3.1; extra == 'all'
+Requires-Dist: rich-click>=1.6.1; extra == 'all'
+Requires-Dist: semver>=3.0.1; extra == 'all'
+Requires-Dist: turms>=0.8.2; extra == 'all'
+Requires-Dist: unlok-next>=0.2.0; extra == 'all'
+Requires-Dist: watchfiles>=0.18.1; extra == 'all'
 Provides-Extra: alpaka
+Requires-Dist: alpaka>=0.2.0; extra == 'alpaka'
 Provides-Extra: blok
+Requires-Dist: blok>=0.1.0; extra == 'blok'
 Provides-Extra: cli
+Requires-Dist: rekuest-next>=0.3.1; extra == 'cli'
+Requires-Dist: turms>=0.8.2; extra == 'cli'
 Provides-Extra: elektro
+Requires-Dist: elektro>=0.5.0; extra == 'elektro'
 Provides-Extra: extended
+Requires-Dist: alpaka>=0.2.0; extra == 'extended'
+Requires-Dist: kraph>=0.2.0; extra == 'extended'
 Provides-Extra: fluss
+Requires-Dist: fluss-next>=0.2.0; extra == 'fluss'
 Provides-Extra: kabinet
+Requires-Dist: kabinet>=0.4.0; extra == 'kabinet'
 Provides-Extra: kraph
+Requires-Dist: kraph>=0.2.0; extra == 'kraph'
 Provides-Extra: lovekit
+Requires-Dist: lovekit>=0.2.0; extra == 'lovekit'
 Provides-Extra: mikro
+Requires-Dist: mikro-next>=0.3.1; extra == 'mikro'
 Provides-Extra: reaktion
+Requires-Dist: reaktion-next>=0.2.0; extra == 'reaktion'
 Provides-Extra: rekuest
-Provides-Extra: stream
+Requires-Dist: rekuest-next>=0.6.0; extra == 'rekuest'
 Provides-Extra: unlok
-Requires-Dist: alpaka (>=0.2.0) ; (python_version >= "3.10" and python_version < "4.0") and (extra == "alpaka" or extra == "extended")
-Requires-Dist: blok (>=0.1.0) ; (python_version >= "3.9" and python_version < "4.0") and (extra == "blok")
-Requires-Dist: cryptography (>=40.0.8) ; (python_version >= "3.9") and (extra == "blok")
-Requires-Dist: dokker (>=1.0.0)
-Requires-Dist: elektro (>=0.5.0) ; (python_version >= "3.9") and (extra == "elektro")
-Requires-Dist: fakts-next (>=1.1.0)
-Requires-Dist: fluss-next (>=0.2.0) ; (python_version >= "3.9") and (extra == "fluss" or extra == "all")
-Requires-Dist: herre-next (>=1.1.0)
-Requires-Dist: kabinet (>=0.2.0) ; (python_version >= "3.9" and python_version < "4.0") and (extra == "kabinet" or extra == "all")
-Requires-Dist: koil (>=1.0.3)
-Requires-Dist: kraph (>=0.2.0) ; (python_version >= "3.9") and (extra == "kraph" or extra == "extended")
-Requires-Dist: lovekit (>=0.2.0) ; (python_version >= "3.10") and (extra == "lovekit" or extra == "stream")
-Requires-Dist: mikro-next (>=0.2.0) ; (python_version >= "3.11" and python_version < "4.0") and (extra == "mikro" or extra == "all")
-Requires-Dist: namegenerator (>=1.0.6) ; (python_version >= "3.9") and (extra == "blok")
-Requires-Dist: netifaces (>=0.11.0) ; (python_version >= "3.9") and (extra == "blok")
-Requires-Dist: rath (>=1.1.1)
-Requires-Dist: reaktion-next (>=0.2.0) ; (python_version >= "3.9") and (extra == "reaktion" or extra == "all")
-Requires-Dist: rekuest-next (>=0.3.1) ; (python_version >= "3.9") and (extra == "cli" or extra == "rekuest" or extra == "all")
-Requires-Dist: rich-click (>=1.6.1) ; extra == "cli" or extra == "all" or extra == "blok"
-Requires-Dist: semver (>=3.0.1) ; extra == "cli" or extra == "all"
-Requires-Dist: turms (>=0.8.2) ; (python_version >= "3.9") and (extra == "cli" or extra == "all")
-Requires-Dist: unlok-next (>=0.2.0) ; (python_version >= "3.9") and (extra == "unlok" or extra == "all")
-Requires-Dist: watchfiles (>=0.18.1) ; extra == "cli" or extra == "all"
+Requires-Dist: unlok-next>=0.2.0; extra == 'unlok'
 Description-Content-Type: text/markdown
 
-# arkitekt_next
+# arkitekt-next
 
 [![codecov](https://codecov.io/gh/jhnnsrs/arkitekt_next/branch/master/graph/badge.svg?token=UGXEA2THBV)](https://codecov.io/gh/jhnnsrs/arkitekt_next)
 [![PyPI version](https://badge.fury.io/py/arkitekt_next.svg)](https://pypi.org/project/arkitekt_next/)
@@ -65,7 +66,7 @@ streaming analysis for mikroscopy
 
 ## Idea
 
-arkitekt_next is the python client for the arkitekt_next platform. It allows you to utilize the full extent of the platform from your python code.
+arkitekt-next is the python client for the arkitekt_next platform. It allows you to utilize the full extent of the platform from your python code.
 To understand the idea behind arkitekt_next, you need to understand the idea behind the arkitekt_next platform.
 (More on this in the [documentation](https://arkitekt.live))
 
@@ -169,4 +170,3 @@ def complex_call(x: ComplexStrucuture) -> int:
 ```
 
 Check out the arkitekt_next [documentation](https://arkitekt.live) for usage of this libary
-