diff --git a/examples/basic.py b/examples/basic.py index 537d5c8..9a234f4 100644 --- a/examples/basic.py +++ b/examples/basic.py @@ -21,8 +21,9 @@ """, prefixes={"ex": "http://example.org/knowledge-mapper/basic#"}, ) -def example_answer_ki(): +def example_answer_ki(binding_set, info): logger.info("Handling a call to the example answer KI.") + return binding_set if __name__ == "__main__": diff --git a/examples/custom-settings/custom_settings.py b/examples/custom-settings/custom_settings.py new file mode 100644 index 0000000..aebce48 --- /dev/null +++ b/examples/custom-settings/custom_settings.py @@ -0,0 +1,84 @@ +"""Example: combining application config with KnowledgeBaseSettings. + +A good pattern is to subclass KnowledgeBaseSettings to add application-specific +settings, while still supporting the standard config sources (YAML/JSON file, env vars, +CLI args) for the KB configuration. Other setups are possible as well. +This example shows this method and how to build a KB, register KI's from settings for +each type of interaction. + +Configuration is loaded automatically from (highest priority first): + 1. CLI arguments --kb_id, --db_host, ... + 2. Environment vars KB_ID, DB_HOST, ... + 3. config.yaml / config.json + 4. Field default values + +Run: + python custom_settings.py # use config.yaml / env vars + python custom_settings.py --kb_id http://my/kb # override via CLI + KB_ID=http://my/kb python custom_settings.py # override via env var +""" + +import sys +from pathlib import Path + +sys.path.insert(0, str(Path(__file__).parent.parent)) + +from pydantic_settings import CliSettingsSource, SettingsConfigDict +from shared import get_example_logger + +from src import KnowledgeBase, KnowledgeBaseSettings +from src.ke.models import BindingSet, KnowledgeInteractionInfo + +EXAMPLE_NAME = "custom-settings" +logger = get_example_logger(EXAMPLE_NAME) + + +class AppSettings(KnowledgeBaseSettings): + model_config = SettingsConfigDict( + yaml_file="custom-settings/settings.yaml", + cli_parse_args=True, + extra="ignore", + ) + + # Application-specific fields + db_host: str = "localhost" + db_port: int = 5432 + debug: bool = False + + @classmethod + def settings_customise_sources(cls, settings_cls, **kwargs): # type: ignore + return ( + CliSettingsSource(settings_cls, cli_parse_args=True), + *super().settings_customise_sources(settings_cls, **kwargs), + ) + + +settings = AppSettings() # type: ignore +kb = KnowledgeBase.from_settings(settings) +kb.ki_from_settings_with_default_handler("ask-from-settings") +kb.ki_from_settings_with_default_handler("post-from-settings") + + +@kb.ki_from_settings("answer-from-settings") +def example_answer_from_settings( + binding_set: BindingSet, info: KnowledgeInteractionInfo +) -> BindingSet: + return binding_set + + +@kb.ki_from_settings("react-from-settings") +def example_react_from_settings( + binding_set: BindingSet, info: KnowledgeInteractionInfo +) -> BindingSet: + return binding_set + + +if __name__ == "__main__": + ask_ctx = kb.ki_registry["ask-from-settings"] + post_ctx = kb.ki_registry["post-from-settings"] + + logger.info(f"KB id: {kb.info.id}") + logger.info(f"DB host:port: {settings.db_host}:{settings.db_port}") + logger.info(f"Debug: {settings.debug}") + logger.info(f"ASK KI name: {ask_ctx.info.name}") + logger.info(f"POST KI name: {post_ctx.info.name}") diff --git a/examples/custom-settings/settings.yaml b/examples/custom-settings/settings.yaml new file mode 100644 index 0000000..254ecd0 --- /dev/null +++ b/examples/custom-settings/settings.yaml @@ -0,0 +1,43 @@ +# Application-specific settings +db_host: "localhost" +db_port: 5432 +debug: false + +# Knowledge Base settings +knowledge_base: + id: "http://example.org/knowledge-mapper/custom-settings#kb" + name: "custom-knowledge-base" + description: "A knowledge base with custom settings loaded." + +knowledge_engine_endpoint: "http://localhost:8280/rest" + +knowledge_interactions: + - name: ask-from-settings + type: AskKnowledgeInteraction + prefixes: + ex: "http://example.org/knowledge-mapper/custom-settings#" + graph_pattern: | + ?s ?p ?o . + - name: answer-from-settings + type: AnswerKnowledgeInteraction + prefixes: + ex: "http://example.org/knowledge-mapper/custom-settings#" + graph_pattern: | + ?s ?p ?o . + - name: post-from-settings + type: PostKnowledgeInteraction + prefixes: + ex: "http://example.org/knowledge-mapper/custom-settings#" + argument_graph_pattern: | + ?s ?p ?o . + result_graph_pattern: | + ?s ?p ?o . + - name: react-from-settings + type: ReactKnowledgeInteraction + prefixes: + ex: "http://example.org/knowledge-mapper/custom-settings#" + argument_graph_pattern: | + ?s ?p ?o . + result_graph_pattern: | + ?s ?p ?o . + diff --git a/pyproject.toml b/pyproject.toml index 3c0d798..fa53ee5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,7 @@ readme = "README.md" requires-python = ">=3.13" dependencies = [ "pydantic>=2.12.5", - "pydantic-settings>=2.13.1", + "pydantic-settings[yaml]>=2.13.1", "requests>=2.32.5", ] diff --git a/src/__init__.py b/src/__init__.py index ac75543..feaeee0 100644 --- a/src/__init__.py +++ b/src/__init__.py @@ -1,6 +1,7 @@ import logging from .knowledge_base import KnowledgeBase +from .settings import KnowledgeBaseSettings __version__ = "0.1.0a0" diff --git a/src/ke/client.py b/src/ke/client.py index f3dccb2..58d6dc0 100644 --- a/src/ke/client.py +++ b/src/ke/client.py @@ -118,7 +118,7 @@ def register_ki( """ ... - def poll_ki_call(self, kb_id: str) -> PollResult: + def poll_ki_call(self, kb_id: str) -> tuple[PollResult, HandleRequest | None]: """Poll the KE runtime for an incoming KI call for the given KB. Raises: @@ -129,12 +129,17 @@ def poll_ki_call(self, kb_id: str) -> PollResult: """ ... + @property + def ke_url(self) -> str: + """Return the base URL of the KE runtime this client is communicating with.""" + ... + class Client(ClientProtocol): """HTTP client for the Knowledge Engine REST API.""" def __init__(self, ke_url: str): - self.ke_url = ke_url + self._ke_url = ke_url def ke_is_available(self) -> bool: try: @@ -282,3 +287,7 @@ def post_handle_response( if not response.ok: raise UnexpectedHttpResponseError(response) + + @property + def ke_url(self) -> str: + return self._ke_url diff --git a/src/ke/models.py b/src/ke/models.py index 3e9b842..6049839 100644 --- a/src/ke/models.py +++ b/src/ke/models.py @@ -1,4 +1,5 @@ from enum import StrEnum +from typing import Annotated from pydantic import BaseModel, ConfigDict, Field from pydantic.alias_generators import to_camel @@ -13,9 +14,9 @@ class BindingModel(BaseModel): class KnowledgeBaseInfo(BaseModel): model_config = ConfigDict(extra="allow", frozen=True, populate_by_name=True) - id: str = Field(..., alias="knowledgeBaseId") - name: str = Field(..., alias="knowledgeBaseName") - description: str = Field(..., alias="knowledgeBaseDescription") + id: Annotated[str, Field(..., alias="knowledgeBaseId")] + name: Annotated[str, Field(..., alias="knowledgeBaseName")] + description: Annotated[str, Field(..., alias="knowledgeBaseDescription")] class KiTypes(StrEnum): @@ -30,10 +31,10 @@ class KnowledgeInteractionInfo(BaseModel): alias_generator=to_camel, extra="allow", frozen=True, populate_by_name=True ) - type: KiTypes = Field(..., alias="knowledgeInteractionType") - id: str | None = Field(default=None, alias="knowledgeInteractionId") - name: str = Field(..., alias="knowledgeInteractionName") - prefixes: dict[str, str] = Field(default_factory=dict) + type: Annotated[KiTypes, Field(..., alias="knowledgeInteractionType")] + id: Annotated[str | None, Field(..., alias="knowledgeInteractionId")] = None + name: Annotated[str, Field(..., alias="knowledgeInteractionName")] + prefixes: Annotated[dict[str, str], Field(default_factory=dict)] class AskAnswerInteractionInfo(KnowledgeInteractionInfo): diff --git a/src/knowledge_base.py b/src/knowledge_base.py index 1cd8767..e079315 100644 --- a/src/knowledge_base.py +++ b/src/knowledge_base.py @@ -4,7 +4,7 @@ from functools import wraps from .ke import Client -from .ke.client import PollResult +from .ke.client import ClientProtocol, PollResult from .ke.errors import KnowledgeEngineNotAvailableError from .ke.models import ( AskAnswerInteractionInfo, @@ -18,7 +18,10 @@ Handler, KnowledgeInteractionContext, KnowledgeInteractionStatus, + default_ask_handler, + default_post_handler, ) +from .settings import KnowledgeBaseSettings logger = logging.getLogger(__name__) @@ -37,12 +40,27 @@ class KnowledgeBase: def __init__(self, id: str, name: str, description: str, ke_url: str): self.state = KnowledgeBaseState.UNREGISTERED self.ki_registry: dict[str, KnowledgeInteractionContext] = {} - self.client = Client(ke_url) + self.client: ClientProtocol = Client(ke_url) self.info = KnowledgeBaseInfo( id=id, name=name, description=description, ) + self._build_settings: KnowledgeBaseSettings | None = None + + @classmethod + def from_settings(cls, settings: KnowledgeBaseSettings) -> "KnowledgeBase": + """Create a :class:`KnowledgeBase` from a + :class:`~.settings.KnowledgeBaseSettings` instance (or a subclass thereof). + """ + kb = cls( + id=settings.knowledge_base.id, + name=settings.knowledge_base.name, + description=settings.knowledge_base.description, + ke_url=settings.knowledge_engine_endpoint, + ) + kb._build_settings = settings + return kb def connect(self) -> None: """Checks whether the KE runtime is available and raises an exception if not. @@ -155,8 +173,10 @@ def _register_ki_decorator( def decorator(func: Handler) -> Handler: @wraps(func) - def wrapper(*args, **kwargs): - return func(*args, **kwargs) + def wrapper( + binding_set: BindingSet, info: KnowledgeInteractionInfo, *args, **kwargs + ): + return func(binding_set, info, *args, **kwargs) self.register_ki( KnowledgeInteractionContext( @@ -197,11 +217,31 @@ def sync_knowledge_interactions(self) -> None: ki_ctx.status = KnowledgeInteractionStatus.REGISTERED return + def ki_from_info( + self, + info: KnowledgeInteractionInfo, + defer_ke_registration: bool = True, + ) -> Callable[[Handler], Handler]: + """Return a decorator that registers the decorated function as a KI handler + based on the provided KnowledgeInteractionInfo. + + Raises: + ValueError: Propagated from ``register_ki`` if registration constraints are + violated. + SmartConnectorNotFoundError: Propagated from ``register_ki`` when contacting + the KE runtime. + UnexpectedHttpResponseError: Propagated from ``register_ki`` when contacting + the KE runtime. + """ + return self._register_ki_decorator( + info=info, defer_ke_registration=defer_ke_registration + ) + def ask_ki( self, name: str, graph_pattern: str, - prefixes: dict = None, + prefixes: dict | None = None, defer_ke_registration: bool = True, ) -> Callable[[Handler], Handler]: """Return a decorator that registers the decorated function as an ASK KI @@ -229,7 +269,7 @@ def answer_ki( self, name: str, graph_pattern: str, - prefixes: dict = None, + prefixes: dict | None = None, defer_ke_registration: bool = True, ) -> Callable[[Handler], Handler]: """Return a decorator that registers the decorated function as an ANSWER KI @@ -258,7 +298,7 @@ def post_ki( name: str, argument_graph_pattern: str, result_graph_pattern: str, - prefixes: dict = None, + prefixes: dict | None = None, defer_ke_registration: bool = True, ) -> Callable[[Handler], Handler]: """Return a decorator that registers the decorated function as a POST KI @@ -288,7 +328,7 @@ def react_ki( name: str, argument_graph_pattern: str, result_graph_pattern: str, - prefixes: dict = None, + prefixes: dict | None = None, defer_ke_registration: bool = True, ) -> Callable[[Handler], Handler]: """Return a decorator that registers the decorated function as a REACT KI @@ -313,6 +353,93 @@ def react_ki( defer_ke_registration=defer_ke_registration, ) + def ki_from_settings( + self, ki_name: str, defer_ke_registration: bool = True + ) -> Callable[[Handler], Handler]: + """Return a decorator that registers the decorated function as a KI + handler with info from the KB settings. + + Raises: + ValueError: If no settings are found or ``ki_name`` is not found in the + settings, or if registration constraints are violated. + SmartConnectorNotFoundError: Propagated from ``register_ki`` when contacting + the KE runtime. + UnexpectedHttpResponseError: Propagated from ``register_ki`` when contacting + the KE runtime. + """ + if not self._build_settings: + raise ValueError( + "Cannot register KI from settings because the KB was not built from " + "settings. Please build the KB using KnowledgeBase.from_settings() " + "with a KnowledgeBaseSettings that includes the desired KI info." + ) + try: + info = self._build_settings.get_configured_interaction(ki_name) + except ValueError as err: + raise ValueError( + f"KI named '{ki_name}' not found in KB settings. Please ensure the " + f"settings include a KI with this name." + ) from err + + return self._register_ki_decorator( + info=info, + defer_ke_registration=defer_ke_registration, + ) + + def ki_from_settings_with_default_handler( + self, ki_name: str, defer_ke_registration: bool = True + ) -> None: + """Register a KI that was defined in the settings of a KB. Only applicable to + KIs of type ASK or POST, which will be registered with the default ASK and POST + handlers, respectively. + + .. warning:: + The default ASK and POST handlers are not yet implemented. The KI will be + registered successfully, but invoking it will raise + :exc:`NotImplementedError`. Use :meth:`ki_from_settings` with a custom + handler instead. + + Raises: + ValueError: If no settings are found or ``ki_name`` is not found in the + settings, if the KI type is not ASK or POST, or if registration constraints + are violated. + SmartConnectorNotFoundError: Propagated from ``register_ki`` when contacting + the KE runtime. + UnexpectedHttpResponseError: Propagated from ``register_ki`` when contacting + the KE runtime. + """ + if not self._build_settings: + raise ValueError( + "Cannot register KI from settings because the KB was not built from " + "settings. Please build the KB using KnowledgeBase.from_settings() with" + " a KnowledgeBaseSettings that includes the desired KI info." + ) + + try: + info = self._build_settings.get_configured_interaction(ki_name) + except ValueError as err: + raise ValueError( + f"KI named '{ki_name}' not found in KB settings. Please ensure the " + f"settings include a KI with this name." + ) from err + + if not (info.type == KiTypes.ASK or info.type == KiTypes.POST): + raise ValueError( + f"KI named '{ki_name}' in settings must be of type ASK or POST to use " + f"the default handler registration method." + ) + + self.register_ki( + KnowledgeInteractionContext( + info=info, + handler=default_ask_handler + if info.type == KiTypes.ASK + else default_post_handler, + ), + defer_ke_registration=defer_ke_registration, + ) + return + def call(self, binding_set: BindingSet, ki_id: str) -> BindingSet: """Invoke the handler of a registered KI by its ID. @@ -320,10 +447,10 @@ def call(self, binding_set: BindingSet, ki_id: str) -> BindingSet: KeyError: If ``ki_id`` is not found in the local KI registry. """ ki_ctx = self.ki_registry[ki_id] - result = ki_ctx.handler(binding_set) + result = ki_ctx.handler(binding_set, ki_ctx.info) return result - def start_handling_loop(self, loops: int = None) -> None: + def start_handling_loop(self, loops: int | None = None) -> None: """Poll the KE runtime for incoming KI calls and dispatch them to handlers. Runs until an EXIT signal is received from the KE runtime, or until @@ -353,6 +480,7 @@ def start_handling_loop(self, loops: int = None) -> None: ) match poll_result, maybe_handle_request: case PollResult.HANDLE, _: + assert maybe_handle_request is not None self.call( maybe_handle_request.binding_set, maybe_handle_request.knowledge_interaction_id, diff --git a/src/knowledge_interaction.py b/src/knowledge_interaction.py index 27d3b76..9ec839f 100644 --- a/src/knowledge_interaction.py +++ b/src/knowledge_interaction.py @@ -4,13 +4,35 @@ from enum import StrEnum from typing import Concatenate -from src.ke.models import BindingModel, KnowledgeInteractionInfo +from src.ke.models import BindingSet, KnowledgeInteractionInfo type Handler = Callable[ - Concatenate[list[BindingModel], KnowledgeInteractionInfo, ...], list[BindingModel] + Concatenate[BindingSet, KnowledgeInteractionInfo, ...], BindingSet ] +def default_ask_handler( + binding_set: BindingSet, info: KnowledgeInteractionInfo +) -> BindingSet: + # TODO: Implement a default ASK handler when implementing serialization and + # validation of binding sets + raise NotImplementedError( + "default_ask_handler is not yet implemented. " + "Provide a custom handler via ki_from_settings instead." + ) + + +def default_post_handler( + binding_set: BindingSet, info: KnowledgeInteractionInfo +) -> BindingSet: + # TODO: Implement a default POST handler when implementing serialization and + # validation of binding sets + raise NotImplementedError( + "default_post_handler is not yet implemented. " + "Provide a custom handler via ki_from_settings instead." + ) + + class KnowledgeInteractionStatus(StrEnum): REGISTERED = "registered" UNREGISTERED = "unregistered" diff --git a/src/settings.py b/src/settings.py new file mode 100644 index 0000000..1cc8004 --- /dev/null +++ b/src/settings.py @@ -0,0 +1,88 @@ +from pydantic import Field +from pydantic_settings import ( + BaseSettings, + JsonConfigSettingsSource, + PydanticBaseSettingsSource, + SettingsConfigDict, + YamlConfigSettingsSource, +) + +from src.ke.models import KnowledgeBaseInfo, KnowledgeInteractionInfo + + +class KnowledgeBaseSettings(BaseSettings): + """Base settings for a KE Knowledge Base application, based on Pydantic + BaseSettings. + + Subclass this to add application-specific settings. All fields are + populated from the following sources, in priority order (highest first): + + 1. Initialiser keyword arguments + 2. Environment variables + 3. YAML config file (``yaml_file`` in ``model_config``, default ``config.yaml``) + 4. JSON config file (``json_file`` in ``model_config``, default ``config.json``) + 5. Field default values + + For CLI argument support, set ``cli_parse_args=True`` in your subclass + ``model_config`` and include a :class:`~pydantic_settings.CliSettingsSource` + in a custom ``settings_customise_sources`` override. + + Example:: + + from pydantic_settings import CliSettingsSource, SettingsConfigDict + from knowledge_mapper import KnowledgeBaseSettings + + class AppSettings(KnowledgeBaseSettings): + model_config = SettingsConfigDict( + yaml_file="config.yaml", + env_prefix="MYAPP_", + cli_parse_args=True, + ) + + # Application-specific fields + database_url: str = "sqlite:///./myapp.db" + debug: bool = False + + @classmethod + def settings_customise_sources(cls, settings_cls, **kwargs): + return ( + CliSettingsSource(settings_cls, cli_parse_args=True), + *super().settings_customise_sources(settings_cls, **kwargs), + ) + + settings = AppSettings() + """ + + model_config = SettingsConfigDict( + yaml_file="config.yaml", + json_file="config.json", + env_nested_delimiter="__", + extra="ignore", + ) + + knowledge_base: KnowledgeBaseInfo + knowledge_engine_endpoint: str + knowledge_interactions: list[KnowledgeInteractionInfo] = Field(default_factory=list) + + @classmethod + def settings_customise_sources( + cls, + settings_cls: type[BaseSettings], + init_settings: PydanticBaseSettingsSource, + env_settings: PydanticBaseSettingsSource, + dotenv_settings: PydanticBaseSettingsSource, + file_secret_settings: PydanticBaseSettingsSource, + ) -> tuple[PydanticBaseSettingsSource, ...]: + return ( + init_settings, + env_settings, + dotenv_settings, + YamlConfigSettingsSource(settings_cls), + JsonConfigSettingsSource(settings_cls), + ) + + def get_configured_interaction(self, name: str) -> KnowledgeInteractionInfo: + for ki in self.knowledge_interactions: + if ki.name == name: + return ki + raise ValueError(f"No interaction found with name '{name}'") diff --git a/tests/configuration/.env.test b/tests/configuration/.env.test new file mode 100644 index 0000000..68830bb --- /dev/null +++ b/tests/configuration/.env.test @@ -0,0 +1 @@ +KNOWLEDGE_BASE__ID="http://example.org/test/config#kb-from-env" \ No newline at end of file diff --git a/tests/configuration/config-with-interactions.yaml b/tests/configuration/config-with-interactions.yaml new file mode 100644 index 0000000..7860c53 --- /dev/null +++ b/tests/configuration/config-with-interactions.yaml @@ -0,0 +1,35 @@ +knowledge_base: + id: "http://example.org/test/config#kb-with-interactions" + name: "kb-with-interactions" + description: "A knowledge base with interactions loaded from config file." +knowledge_engine_endpoint: "http://example.org:8280/rest" + +knowledge_interactions: + - name: ask-from-settings + type: AskKnowledgeInteraction + prefixes: + ex: "http://example.org/knowledge-mapper/custom-settings#" + graph_pattern: | + ?s ?p ?o . + - name: answer-from-settings + type: AnswerKnowledgeInteraction + prefixes: + ex: "http://example.org/knowledge-mapper/custom-settings#" + graph_pattern: | + ?s ?p ?o . + - name: post-from-settings + type: PostKnowledgeInteraction + prefixes: + ex: "http://example.org/knowledge-mapper/custom-settings#" + argument_graph_pattern: | + ?s ?p ?o . + result_graph_pattern: | + ?s ?p ?o . + - name: react-from-settings + type: ReactKnowledgeInteraction + prefixes: + ex: "http://example.org/knowledge-mapper/custom-settings#" + argument_graph_pattern: | + ?s ?p ?o . + result_graph_pattern: | + ?s ?p ?o . \ No newline at end of file diff --git a/tests/configuration/config.yaml b/tests/configuration/config.yaml new file mode 100644 index 0000000..5a06b82 --- /dev/null +++ b/tests/configuration/config.yaml @@ -0,0 +1,5 @@ +knowledge_base: + id: "http://example.org/test/config#kb" + name: "config-knowledge-base" + description: "A knowledge base with settings loaded from config.yaml." +knowledge_engine_endpoint: "http://example.org:8280/rest" \ No newline at end of file diff --git a/tests/configuration/test_configuration.py b/tests/configuration/test_configuration.py new file mode 100644 index 0000000..1eb594f --- /dev/null +++ b/tests/configuration/test_configuration.py @@ -0,0 +1,56 @@ +from pydantic_settings import SettingsConfigDict + +from src import KnowledgeBase, KnowledgeBaseSettings + + +def test_basic_configuration(): + class KbSettings(KnowledgeBaseSettings): + model_config = SettingsConfigDict( + yaml_file="tests/configuration/config.yaml", + ) + + settings = KbSettings() # pyright: ignore[reportCallIssue] + kb = KnowledgeBase.from_settings(settings) + assert kb.info.id == settings.knowledge_base.id + + +def test_configuration_different_sources(): + class KbSettings(KnowledgeBaseSettings): + model_config = SettingsConfigDict( + yaml_file="tests/configuration/config.yaml", + env_file="tests/configuration/.env.test", + ) + + settings = KbSettings() # pyright: ignore[reportCallIssue] + kb = KnowledgeBase.from_settings(settings) + assert kb.info.id == "http://example.org/test/config#kb-from-env" + + +def test_configuration_interactions(): + class KbSettings(KnowledgeBaseSettings): + model_config = SettingsConfigDict( + yaml_file="tests/configuration/config-with-interactions.yaml", + ) + + settings = KbSettings() # pyright: ignore[reportCallIssue] + kb = KnowledgeBase.from_settings(settings) + kb.ki_from_settings_with_default_handler("ask-from-settings") + kb.ki_from_settings_with_default_handler("post-from-settings") + + ask_ki = kb.ki_registry["ask-from-settings"] + assert ask_ki.info.name == "ask-from-settings" + post_ki = kb.ki_registry["post-from-settings"] + assert post_ki.info.name == "post-from-settings" + + @kb.ki_from_settings("answer-from-settings") + def answer(binding_set, info): + return binding_set + + @kb.ki_from_settings("react-from-settings") + def react(binding_set, info): + return binding_set + + answer_ki = kb.ki_registry["answer-from-settings"] + assert answer_ki.info.name == "answer-from-settings" + react_ki = kb.ki_registry["react-from-settings"] + assert react_ki.info.name == "react-from-settings" diff --git a/tests/fake_client.py b/tests/fake_client.py index a77d913..3c7aeee 100644 --- a/tests/fake_client.py +++ b/tests/fake_client.py @@ -12,7 +12,7 @@ def __init__(self, fake_url) -> None: # Maps kb_id -> list of registered KIs self._knowledge_interactions: dict[str, list[KnowledgeInteractionInfo]] = {} self._next_ki_id: int = 1 - self.ke_url = fake_url + self._ke_url = fake_url def ke_is_available(self) -> bool: return True @@ -39,7 +39,9 @@ def unregister_kb(self, id: str) -> None: self._knowledge_bases.pop(id) self._knowledge_interactions.pop(id, None) - def get_knowledge_interactions(self, kb_id: str) -> list[KnowledgeInteractionInfo]: + def get_all_knowledge_interactions( + self, kb_id: str + ) -> list[KnowledgeInteractionInfo]: return list(self._knowledge_interactions.get(kb_id, [])) def register_ki( @@ -54,3 +56,7 @@ def poll_ki_call(self, kb_id: str) -> tuple[PollResult, None]: # This fake client never returns any KI calls to handle, but always asks to # repoll. return (PollResult.REPOLL, None) + + @property + def ke_url(self) -> str: + return self._ke_url diff --git a/tests/test_client.py b/tests/test_client.py index 53dadbf..f26325c 100644 --- a/tests/test_client.py +++ b/tests/test_client.py @@ -3,7 +3,12 @@ import pytest from src.ke import Client -from src.ke.models import KnowledgeBaseInfo, KnowledgeInteractionInfo +from src.ke.models import ( + AskAnswerInteractionInfo, + KnowledgeBaseInfo, + KnowledgeInteractionInfo, + PostReactInteractionInfo, +) @pytest.fixture @@ -107,9 +112,11 @@ def test_get_knowledge_interactions(client: Client): assert len(interactions) == 2 assert interactions[0].type == "AskKnowledgeInteraction" assert interactions[0].name == "ask-interaction" + assert isinstance(interactions[0], AskAnswerInteractionInfo) assert interactions[0].graph_pattern == "?s ?p ?o . " assert interactions[1].type == "PostKnowledgeInteraction" assert interactions[1].name == "post-interaction" + assert isinstance(interactions[1], PostReactInteractionInfo) assert interactions[1].argument_graph_pattern == "?s ?p ?o . " assert interactions[1].result_graph_pattern == "?s ?p ?o . " @@ -127,7 +134,7 @@ def test_register_knowledge_interaction(client: Client): ki=KnowledgeInteractionInfo( type="AskKnowledgeInteraction", name="ask-interaction", - graph_pattern="?s ?p ?o . ", + graph_pattern="?s ?p ?o . ", # pyright: ignore[reportCallIssue] prefixes={"test": "http://example.org/test#"}, ), ) diff --git a/tests/test_ki_registration.py b/tests/test_ki_registration.py index dffe73b..7ed3e2a 100644 --- a/tests/test_ki_registration.py +++ b/tests/test_ki_registration.py @@ -1,7 +1,12 @@ import pytest from src import KnowledgeBase -from src.ke.models import AskAnswerInteractionInfo, BindingSet, KiTypes +from src.ke.models import ( + AskAnswerInteractionInfo, + BindingSet, + KiTypes, + KnowledgeInteractionInfo, +) from src.knowledge_interaction import ( KnowledgeInteractionContext, KnowledgeInteractionStatus, @@ -35,7 +40,7 @@ def ki_ctx_setup() -> KnowledgeInteractionContext: graph_pattern="""?s ?p ?o . """, prefixes=shared_prefixes(), ), - handler=lambda binding_set: binding_set, # type: ignore + handler=lambda binding_set, info: binding_set, status=KnowledgeInteractionStatus.UNREGISTERED, ) @@ -120,8 +125,10 @@ def test_register_answer_ki(): """, prefixes=shared_prefixes(), ) - def answer_test(binding_set: BindingSet) -> BindingSet: - pass + def answer_test( + binding_set: BindingSet, info: KnowledgeInteractionInfo + ) -> BindingSet: + return binding_set kb.register() @@ -146,8 +153,10 @@ def test_register_react_ki(): """, prefixes=shared_prefixes(), ) - def react_test(binding_set: BindingSet) -> BindingSet: - pass + def react_test( + binding_set: BindingSet, info: KnowledgeInteractionInfo + ) -> BindingSet: + return binding_set kb.register() @@ -166,8 +175,10 @@ def test_register_ki_with_same_name(): ?s ?p ?o . """, ) - def first_handler(binding_set: BindingSet) -> BindingSet: - pass + def first_handler( + binding_set: BindingSet, info: KnowledgeInteractionInfo + ) -> BindingSet: + return binding_set with pytest.raises(ValueError): @@ -176,8 +187,10 @@ def first_handler(binding_set: BindingSet) -> BindingSet: argument_graph_pattern="""?s ?p ?o . """, result_graph_pattern="""?s ?p ?o . """, ) - def second_handler(binding_set: BindingSet) -> BindingSet: - pass + def second_handler( + binding_set: BindingSet, info: KnowledgeInteractionInfo + ) -> BindingSet: + return binding_set def test_handler_registration_no_binding_set_param(): @@ -188,7 +201,7 @@ def test_handler_registration_no_binding_set_param(): @kb.answer_ki( name="bad-handler", graph_pattern="""""", - ) + ) # pyright: ignore[reportArgumentType] def bad_handler(): pass @@ -211,7 +224,9 @@ def test_call_handler(): """, prefixes=shared_prefixes(), ) - def echo_handler(binding_set: BindingSet) -> BindingSet: + def echo_handler( + binding_set: BindingSet, info: KnowledgeInteractionInfo + ) -> BindingSet: return binding_set kb.register() diff --git a/uv.lock b/uv.lock index 74657ea..28df4f2 100644 --- a/uv.lock +++ b/uv.lock @@ -110,7 +110,7 @@ version = "0.1.0a0" source = { editable = "." } dependencies = [ { name = "pydantic" }, - { name = "pydantic-settings" }, + { name = "pydantic-settings", extra = ["yaml"] }, { name = "requests" }, ] @@ -123,7 +123,7 @@ dev = [ [package.metadata] requires-dist = [ { name = "pydantic", specifier = ">=2.12.5" }, - { name = "pydantic-settings", specifier = ">=2.13.1" }, + { name = "pydantic-settings", extras = ["yaml"], specifier = ">=2.13.1" }, { name = "requests", specifier = ">=2.32.5" }, ] @@ -233,6 +233,11 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/00/4b/ccc026168948fec4f7555b9164c724cf4125eac006e176541483d2c959be/pydantic_settings-2.13.1-py3-none-any.whl", hash = "sha256:d56fd801823dbeae7f0975e1f8c8e25c258eb75d278ea7abb5d9cebb01b56237", size = 58929, upload-time = "2026-02-19T13:45:06.034Z" }, ] +[package.optional-dependencies] +yaml = [ + { name = "pyyaml" }, +] + [[package]] name = "pygments" version = "2.19.2" @@ -267,6 +272,42 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/0b/d7/1959b9648791274998a9c3526f6d0ec8fd2233e4d4acce81bbae76b44b2a/python_dotenv-1.2.2-py3-none-any.whl", hash = "sha256:1d8214789a24de455a8b8bd8ae6fe3c6b69a5e3d64aa8a8e5d68e694bbcb285a", size = 22101, upload-time = "2026-03-01T16:00:25.09Z" }, ] +[[package]] +name = "pyyaml" +version = "6.0.3" +source = { registry = "https://pypi.org/simple" } +sdist = { url = "https://files.pythonhosted.org/packages/05/8e/961c0007c59b8dd7729d542c61a4d537767a59645b82a0b521206e1e25c2/pyyaml-6.0.3.tar.gz", hash = "sha256:d76623373421df22fb4cf8817020cbb7ef15c725b9d5e45f17e189bfc384190f", size = 130960, upload-time = "2025-09-25T21:33:16.546Z" } +wheels = [ + { url = "https://files.pythonhosted.org/packages/d1/11/0fd08f8192109f7169db964b5707a2f1e8b745d4e239b784a5a1dd80d1db/pyyaml-6.0.3-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:8da9669d359f02c0b91ccc01cac4a67f16afec0dac22c2ad09f46bee0697eba8", size = 181669, upload-time = "2025-09-25T21:32:23.673Z" }, + { url = "https://files.pythonhosted.org/packages/b1/16/95309993f1d3748cd644e02e38b75d50cbc0d9561d21f390a76242ce073f/pyyaml-6.0.3-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:2283a07e2c21a2aa78d9c4442724ec1eb15f5e42a723b99cb3d822d48f5f7ad1", size = 173252, upload-time = "2025-09-25T21:32:25.149Z" }, + { url = "https://files.pythonhosted.org/packages/50/31/b20f376d3f810b9b2371e72ef5adb33879b25edb7a6d072cb7ca0c486398/pyyaml-6.0.3-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:ee2922902c45ae8ccada2c5b501ab86c36525b883eff4255313a253a3160861c", size = 767081, upload-time = "2025-09-25T21:32:26.575Z" }, + { url = "https://files.pythonhosted.org/packages/49/1e/a55ca81e949270d5d4432fbbd19dfea5321eda7c41a849d443dc92fd1ff7/pyyaml-6.0.3-cp313-cp313-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:a33284e20b78bd4a18c8c2282d549d10bc8408a2a7ff57653c0cf0b9be0afce5", size = 841159, upload-time = "2025-09-25T21:32:27.727Z" }, + { url = "https://files.pythonhosted.org/packages/74/27/e5b8f34d02d9995b80abcef563ea1f8b56d20134d8f4e5e81733b1feceb2/pyyaml-6.0.3-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0f29edc409a6392443abf94b9cf89ce99889a1dd5376d94316ae5145dfedd5d6", size = 801626, upload-time = "2025-09-25T21:32:28.878Z" }, + { url = "https://files.pythonhosted.org/packages/f9/11/ba845c23988798f40e52ba45f34849aa8a1f2d4af4b798588010792ebad6/pyyaml-6.0.3-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:f7057c9a337546edc7973c0d3ba84ddcdf0daa14533c2065749c9075001090e6", size = 753613, upload-time = "2025-09-25T21:32:30.178Z" }, + { url = "https://files.pythonhosted.org/packages/3d/e0/7966e1a7bfc0a45bf0a7fb6b98ea03fc9b8d84fa7f2229e9659680b69ee3/pyyaml-6.0.3-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:eda16858a3cab07b80edaf74336ece1f986ba330fdb8ee0d6c0d68fe82bc96be", size = 794115, upload-time = "2025-09-25T21:32:31.353Z" }, + { url = "https://files.pythonhosted.org/packages/de/94/980b50a6531b3019e45ddeada0626d45fa85cbe22300844a7983285bed3b/pyyaml-6.0.3-cp313-cp313-win32.whl", hash = "sha256:d0eae10f8159e8fdad514efdc92d74fd8d682c933a6dd088030f3834bc8e6b26", size = 137427, upload-time = "2025-09-25T21:32:32.58Z" }, + { url = "https://files.pythonhosted.org/packages/97/c9/39d5b874e8b28845e4ec2202b5da735d0199dbe5b8fb85f91398814a9a46/pyyaml-6.0.3-cp313-cp313-win_amd64.whl", hash = "sha256:79005a0d97d5ddabfeeea4cf676af11e647e41d81c9a7722a193022accdb6b7c", size = 154090, upload-time = "2025-09-25T21:32:33.659Z" }, + { url = "https://files.pythonhosted.org/packages/73/e8/2bdf3ca2090f68bb3d75b44da7bbc71843b19c9f2b9cb9b0f4ab7a5a4329/pyyaml-6.0.3-cp313-cp313-win_arm64.whl", hash = "sha256:5498cd1645aa724a7c71c8f378eb29ebe23da2fc0d7a08071d89469bf1d2defb", size = 140246, upload-time = "2025-09-25T21:32:34.663Z" }, + { url = "https://files.pythonhosted.org/packages/9d/8c/f4bd7f6465179953d3ac9bc44ac1a8a3e6122cf8ada906b4f96c60172d43/pyyaml-6.0.3-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:8d1fab6bb153a416f9aeb4b8763bc0f22a5586065f86f7664fc23339fc1c1fac", size = 181814, upload-time = "2025-09-25T21:32:35.712Z" }, + { url = "https://files.pythonhosted.org/packages/bd/9c/4d95bb87eb2063d20db7b60faa3840c1b18025517ae857371c4dd55a6b3a/pyyaml-6.0.3-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:34d5fcd24b8445fadc33f9cf348c1047101756fd760b4dacb5c3e99755703310", size = 173809, upload-time = "2025-09-25T21:32:36.789Z" }, + { url = "https://files.pythonhosted.org/packages/92/b5/47e807c2623074914e29dabd16cbbdd4bf5e9b2db9f8090fa64411fc5382/pyyaml-6.0.3-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:501a031947e3a9025ed4405a168e6ef5ae3126c59f90ce0cd6f2bfc477be31b7", size = 766454, upload-time = "2025-09-25T21:32:37.966Z" }, + { url = "https://files.pythonhosted.org/packages/02/9e/e5e9b168be58564121efb3de6859c452fccde0ab093d8438905899a3a483/pyyaml-6.0.3-cp314-cp314-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:b3bc83488de33889877a0f2543ade9f70c67d66d9ebb4ac959502e12de895788", size = 836355, upload-time = "2025-09-25T21:32:39.178Z" }, + { url = "https://files.pythonhosted.org/packages/88/f9/16491d7ed2a919954993e48aa941b200f38040928474c9e85ea9e64222c3/pyyaml-6.0.3-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:c458b6d084f9b935061bc36216e8a69a7e293a2f1e68bf956dcd9e6cbcd143f5", size = 794175, upload-time = "2025-09-25T21:32:40.865Z" }, + { url = "https://files.pythonhosted.org/packages/dd/3f/5989debef34dc6397317802b527dbbafb2b4760878a53d4166579111411e/pyyaml-6.0.3-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:7c6610def4f163542a622a73fb39f534f8c101d690126992300bf3207eab9764", size = 755228, upload-time = "2025-09-25T21:32:42.084Z" }, + { url = "https://files.pythonhosted.org/packages/d7/ce/af88a49043cd2e265be63d083fc75b27b6ed062f5f9fd6cdc223ad62f03e/pyyaml-6.0.3-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:5190d403f121660ce8d1d2c1bb2ef1bd05b5f68533fc5c2ea899bd15f4399b35", size = 789194, upload-time = "2025-09-25T21:32:43.362Z" }, + { url = "https://files.pythonhosted.org/packages/23/20/bb6982b26a40bb43951265ba29d4c246ef0ff59c9fdcdf0ed04e0687de4d/pyyaml-6.0.3-cp314-cp314-win_amd64.whl", hash = "sha256:4a2e8cebe2ff6ab7d1050ecd59c25d4c8bd7e6f400f5f82b96557ac0abafd0ac", size = 156429, upload-time = "2025-09-25T21:32:57.844Z" }, + { url = "https://files.pythonhosted.org/packages/f4/f4/a4541072bb9422c8a883ab55255f918fa378ecf083f5b85e87fc2b4eda1b/pyyaml-6.0.3-cp314-cp314-win_arm64.whl", hash = "sha256:93dda82c9c22deb0a405ea4dc5f2d0cda384168e466364dec6255b293923b2f3", size = 143912, upload-time = "2025-09-25T21:32:59.247Z" }, + { url = "https://files.pythonhosted.org/packages/7c/f9/07dd09ae774e4616edf6cda684ee78f97777bdd15847253637a6f052a62f/pyyaml-6.0.3-cp314-cp314t-macosx_10_13_x86_64.whl", hash = "sha256:02893d100e99e03eda1c8fd5c441d8c60103fd175728e23e431db1b589cf5ab3", size = 189108, upload-time = "2025-09-25T21:32:44.377Z" }, + { url = "https://files.pythonhosted.org/packages/4e/78/8d08c9fb7ce09ad8c38ad533c1191cf27f7ae1effe5bb9400a46d9437fcf/pyyaml-6.0.3-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:c1ff362665ae507275af2853520967820d9124984e0f7466736aea23d8611fba", size = 183641, upload-time = "2025-09-25T21:32:45.407Z" }, + { url = "https://files.pythonhosted.org/packages/7b/5b/3babb19104a46945cf816d047db2788bcaf8c94527a805610b0289a01c6b/pyyaml-6.0.3-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:6adc77889b628398debc7b65c073bcb99c4a0237b248cacaf3fe8a557563ef6c", size = 831901, upload-time = "2025-09-25T21:32:48.83Z" }, + { url = "https://files.pythonhosted.org/packages/8b/cc/dff0684d8dc44da4d22a13f35f073d558c268780ce3c6ba1b87055bb0b87/pyyaml-6.0.3-cp314-cp314t-manylinux2014_s390x.manylinux_2_17_s390x.manylinux_2_28_s390x.whl", hash = "sha256:a80cb027f6b349846a3bf6d73b5e95e782175e52f22108cfa17876aaeff93702", size = 861132, upload-time = "2025-09-25T21:32:50.149Z" }, + { url = "https://files.pythonhosted.org/packages/b1/5e/f77dc6b9036943e285ba76b49e118d9ea929885becb0a29ba8a7c75e29fe/pyyaml-6.0.3-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:00c4bdeba853cc34e7dd471f16b4114f4162dc03e6b7afcc2128711f0eca823c", size = 839261, upload-time = "2025-09-25T21:32:51.808Z" }, + { url = "https://files.pythonhosted.org/packages/ce/88/a9db1376aa2a228197c58b37302f284b5617f56a5d959fd1763fb1675ce6/pyyaml-6.0.3-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:66e1674c3ef6f541c35191caae2d429b967b99e02040f5ba928632d9a7f0f065", size = 805272, upload-time = "2025-09-25T21:32:52.941Z" }, + { url = "https://files.pythonhosted.org/packages/da/92/1446574745d74df0c92e6aa4a7b0b3130706a4142b2d1a5869f2eaa423c6/pyyaml-6.0.3-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:16249ee61e95f858e83976573de0f5b2893b3677ba71c9dd36b9cf8be9ac6d65", size = 829923, upload-time = "2025-09-25T21:32:54.537Z" }, + { url = "https://files.pythonhosted.org/packages/f0/7a/1c7270340330e575b92f397352af856a8c06f230aa3e76f86b39d01b416a/pyyaml-6.0.3-cp314-cp314t-win_amd64.whl", hash = "sha256:4ad1906908f2f5ae4e5a8ddfce73c320c2a1429ec52eafd27138b7f1cbe341c9", size = 174062, upload-time = "2025-09-25T21:32:55.767Z" }, + { url = "https://files.pythonhosted.org/packages/f1/12/de94a39c2ef588c7e6455cfbe7343d3b2dc9d6b6b2f40c4c6565744c873d/pyyaml-6.0.3-cp314-cp314t-win_arm64.whl", hash = "sha256:ebc55a14a21cb14062aa4162f906cd962b28e2e9ea38f9b4391244cd8de4ae0b", size = 149341, upload-time = "2025-09-25T21:32:56.828Z" }, +] + [[package]] name = "requests" version = "2.32.5"