koi-net 1.0.0b10__py3-none-any.whl → 1.0.0b12__py3-none-any.whl

koi_net/processor/knowledge_object.py

@@ -1,123 +1,123 @@
-from enum import StrEnum
-from pydantic import BaseModel
-from rid_lib import RID
-from rid_lib.ext import Manifest
-from rid_lib.ext.bundle import Bundle
-from rid_lib.types.koi_net_node import KoiNetNode
-from ..protocol.event import Event, EventType
-
-
-type KnowledgeEventType = EventType | None
-
-class KnowledgeSource(StrEnum):
-    Internal = "INTERNAL"
-    External = "EXTERNAL"
-
-class KnowledgeObject(BaseModel):
-    """A normalized knowledge representation for internal processing.
-    
-    Capable of representing an RID, manifest, bundle, or event. Contains three additional fields use for decision making in the knowledge processing pipeline. 
-    
-    The source indicates whether this object was generated by this node, or sourced from another node in the network. 
-    
-    The normalized event type indicates how the knowledge object is viewed from the perspective of this node, and what cache actions will take place. `NEW`, `UPDATE` -> cache write, `FORGET` -> cache delete, `None` -> no cache action.
-    
-    The network targets indicate other nodes in the network this knowledge object will be sent to. The event sent to them will be constructed from this knowledge object's RID, manifest, contents, and normalized event type.
-    
-    Constructors are provided to create a knowledge object from an RID, manifest, bundle, or event.
-    """
-    rid: RID
-    manifest: Manifest | None = None
-    contents: dict | None = None
-    event_type: KnowledgeEventType = None
-    normalized_event_type: KnowledgeEventType = None
-    source: KnowledgeSource
-    network_targets: set[KoiNetNode] = set()
-    
-    def __repr__(self):
-        return f"<KObj '{self.rid}' event type: '{self.event_type}' -> '{self.normalized_event_type}', source: '{self.source}'>"
-    
-    @classmethod
-    def from_rid(
-        cls, 
-        rid: RID, 
-        event_type: KnowledgeEventType = None, 
-        source: KnowledgeSource = KnowledgeSource.Internal
-    ) -> "KnowledgeObject":
-        return cls(
-            rid=rid,
-            event_type=event_type,
-            source=source
-        )
-        
-    @classmethod
-    def from_manifest(
-        cls, 
-        manifest: Manifest, 
-        event_type: KnowledgeEventType = None, 
-        source: KnowledgeSource = KnowledgeSource.Internal
-    ) -> "KnowledgeObject":
-        return cls(
-            rid=manifest.rid,
-            manifest=manifest,
-            event_type=event_type,
-            source=source
-        )
-        
-    @classmethod
-    def from_bundle(
-        cls, 
-        bundle: Bundle, 
-        event_type: KnowledgeEventType = None, 
-        source: KnowledgeSource = KnowledgeSource.Internal
-    ) -> "KnowledgeObject":
-        return cls(
-            rid=bundle.rid,
-            manifest=bundle.manifest,
-            contents=bundle.contents,
-            event_type=event_type,
-            source=source
-        )
-        
-    @classmethod
-    def from_event(
-        cls,
-        event: Event,
-        source: KnowledgeSource = KnowledgeSource.Internal
-    ) -> "KnowledgeObject":
-        return cls(
-            rid=event.rid,
-            manifest=event.manifest,
-            contents=event.contents,
-            event_type=event.event_type,
-            source=source
-        )
-    
-    @property
-    def bundle(self):
-        if self.manifest is None or self.contents is None:
-            return
-        
-        return Bundle(
-            manifest=self.manifest,
-            contents=self.contents
-        )
-    
-    @property
-    def normalized_event(self):
-        if self.normalized_event_type is None:
-            raise ValueError("Internal event's normalized event type is None, cannot convert to Event")
-        
-        elif self.normalized_event_type == EventType.FORGET:
-            return Event(
-                rid=self.rid,
-                event_type=EventType.FORGET
-            )
-        
-        else:    
-            return Event(
-                rid=self.rid,
-                event_type=self.normalized_event_type,
-                manifest=self.manifest,
-                contents=self.contents
+from enum import StrEnum
+from pydantic import BaseModel
+from rid_lib import RID
+from rid_lib.ext import Manifest
+from rid_lib.ext.bundle import Bundle
+from rid_lib.types.koi_net_node import KoiNetNode
+from ..protocol.event import Event, EventType
+
+
+type KnowledgeEventType = EventType | None
+
+class KnowledgeSource(StrEnum):
+    Internal = "INTERNAL"
+    External = "EXTERNAL"
+
+class KnowledgeObject(BaseModel):
+    """A normalized knowledge representation for internal processing.
+    
+    Capable of representing an RID, manifest, bundle, or event. Contains three additional fields use for decision making in the knowledge processing pipeline. 
+    
+    The source indicates whether this object was generated by this node, or sourced from another node in the network. 
+    
+    The normalized event type indicates how the knowledge object is viewed from the perspective of this node, and what cache actions will take place. `NEW`, `UPDATE` -> cache write, `FORGET` -> cache delete, `None` -> no cache action.
+    
+    The network targets indicate other nodes in the network this knowledge object will be sent to. The event sent to them will be constructed from this knowledge object's RID, manifest, contents, and normalized event type.
+    
+    Constructors are provided to create a knowledge object from an RID, manifest, bundle, or event.
+    """
+    rid: RID
+    manifest: Manifest | None = None
+    contents: dict | None = None
+    event_type: KnowledgeEventType = None
+    normalized_event_type: KnowledgeEventType = None
+    source: KnowledgeSource
+    network_targets: set[KoiNetNode] = set()
+    
+    def __repr__(self):
+        return f"<KObj '{self.rid}' event type: '{self.event_type}' -> '{self.normalized_event_type}', source: '{self.source}'>"
+    
+    @classmethod
+    def from_rid(
+        cls, 
+        rid: RID, 
+        event_type: KnowledgeEventType = None, 
+        source: KnowledgeSource = KnowledgeSource.Internal
+    ) -> "KnowledgeObject":
+        return cls(
+            rid=rid,
+            event_type=event_type,
+            source=source
+        )
+        
+    @classmethod
+    def from_manifest(
+        cls, 
+        manifest: Manifest, 
+        event_type: KnowledgeEventType = None, 
+        source: KnowledgeSource = KnowledgeSource.Internal
+    ) -> "KnowledgeObject":
+        return cls(
+            rid=manifest.rid,
+            manifest=manifest,
+            event_type=event_type,
+            source=source
+        )
+        
+    @classmethod
+    def from_bundle(
+        cls, 
+        bundle: Bundle, 
+        event_type: KnowledgeEventType = None, 
+        source: KnowledgeSource = KnowledgeSource.Internal
+    ) -> "KnowledgeObject":
+        return cls(
+            rid=bundle.rid,
+            manifest=bundle.manifest,
+            contents=bundle.contents,
+            event_type=event_type,
+            source=source
+        )
+        
+    @classmethod
+    def from_event(
+        cls,
+        event: Event,
+        source: KnowledgeSource = KnowledgeSource.Internal
+    ) -> "KnowledgeObject":
+        return cls(
+            rid=event.rid,
+            manifest=event.manifest,
+            contents=event.contents,
+            event_type=event.event_type,
+            source=source
+        )
+    
+    @property
+    def bundle(self):
+        if self.manifest is None or self.contents is None:
+            return
+        
+        return Bundle(
+            manifest=self.manifest,
+            contents=self.contents
+        )
+    
+    @property
+    def normalized_event(self):
+        if self.normalized_event_type is None:
+            raise ValueError("Internal event's normalized event type is None, cannot convert to Event")
+        
+        elif self.normalized_event_type == EventType.FORGET:
+            return Event(
+                rid=self.rid,
+                event_type=EventType.FORGET
+            )
+        
+        else:    
+            return Event(
+                rid=self.rid,
+                event_type=self.normalized_event_type,
+                manifest=self.manifest,
+                contents=self.contents
             )

koi_net/protocol/api_models.py

@@ -1,47 +1,47 @@
-"""Pydantic models for request and response/payload objects in the KOI-net API."""
-
-from pydantic import BaseModel
-from rid_lib import RID, RIDType
-from rid_lib.ext import Bundle, Manifest
-from .event import Event
-
-
-# REQUEST MODELS
-
-class PollEvents(BaseModel):
-    rid: RID
-    limit: int = 0
-    
-class FetchRids(BaseModel):
-    rid_types: list[RIDType] = []
-    
-class FetchManifests(BaseModel):
-    rid_types: list[RIDType] = []
-    rids: list[RID] = []
-    
-class FetchBundles(BaseModel):
-    rids: list[RID]
-    
-
-# RESPONSE/PAYLOAD MODELS
-
-class RidsPayload(BaseModel):
-    rids: list[RID]
-
-class ManifestsPayload(BaseModel):
-    manifests: list[Manifest]
-    not_found: list[RID] = []
-    
-class BundlesPayload(BaseModel):
-    bundles: list[Bundle]
-    not_found: list[RID] = []
-    deferred: list[RID] = []
-    
-class EventsPayload(BaseModel):
-    events: list[Event]
-    
-
-# TYPES
-
-type RequestModels = EventsPayload | PollEvents | FetchRids | FetchManifests | FetchBundles
+"""Pydantic models for request and response/payload objects in the KOI-net API."""
+
+from pydantic import BaseModel
+from rid_lib import RID, RIDType
+from rid_lib.ext import Bundle, Manifest
+from .event import Event
+
+
+# REQUEST MODELS
+
+class PollEvents(BaseModel):
+    rid: RID
+    limit: int = 0
+    
+class FetchRids(BaseModel):
+    rid_types: list[RIDType] = []
+    
+class FetchManifests(BaseModel):
+    rid_types: list[RIDType] = []
+    rids: list[RID] = []
+    
+class FetchBundles(BaseModel):
+    rids: list[RID]
+    
+
+# RESPONSE/PAYLOAD MODELS
+
+class RidsPayload(BaseModel):
+    rids: list[RID]
+
+class ManifestsPayload(BaseModel):
+    manifests: list[Manifest]
+    not_found: list[RID] = []
+    
+class BundlesPayload(BaseModel):
+    bundles: list[Bundle]
+    not_found: list[RID] = []
+    deferred: list[RID] = []
+    
+class EventsPayload(BaseModel):
+    events: list[Event]
+    
+
+# TYPES
+
+type RequestModels = EventsPayload | PollEvents | FetchRids | FetchManifests | FetchBundles
 type ResponseModels = RidsPayload | ManifestsPayload | BundlesPayload | EventsPayload

koi_net/protocol/consts.py

@@ -1,7 +1,7 @@
-"""API paths for KOI-net protocol."""
-
-BROADCAST_EVENTS_PATH = "/events/broadcast"
-POLL_EVENTS_PATH      = "/events/poll"
-FETCH_RIDS_PATH       = "/rids/fetch"
-FETCH_MANIFESTS_PATH  = "/manifests/fetch"
+"""API paths for KOI-net protocol."""
+
+BROADCAST_EVENTS_PATH = "/events/broadcast"
+POLL_EVENTS_PATH      = "/events/poll"
+FETCH_RIDS_PATH       = "/rids/fetch"
+FETCH_MANIFESTS_PATH  = "/manifests/fetch"
 FETCH_BUNDLES_PATH    = "/bundles/fetch"

koi_net/protocol/edge.py

@@ -1,20 +1,20 @@
-from enum import StrEnum
-from pydantic import BaseModel
-from rid_lib import RIDType
-from rid_lib.types import KoiNetNode
-
-
-class EdgeStatus(StrEnum):
-    PROPOSED = "PROPOSED"
-    APPROVED = "APPROVED"
-    
-class EdgeType(StrEnum):
-    WEBHOOK = "WEBHOOK"
-    POLL = "POLL"
-
-class EdgeProfile(BaseModel):
-    source: KoiNetNode
-    target: KoiNetNode
-    edge_type: EdgeType
-    status: EdgeStatus
-    rid_types: list[RIDType]
+from enum import StrEnum
+from pydantic import BaseModel
+from rid_lib import RIDType
+from rid_lib.types import KoiNetNode
+
+
+class EdgeStatus(StrEnum):
+    PROPOSED = "PROPOSED"
+    APPROVED = "APPROVED"
+    
+class EdgeType(StrEnum):
+    WEBHOOK = "WEBHOOK"
+    POLL = "POLL"
+
+class EdgeProfile(BaseModel):
+    source: KoiNetNode
+    target: KoiNetNode
+    edge_type: EdgeType
+    status: EdgeStatus
+    rid_types: list[RIDType]

koi_net/protocol/event.py

@@ -1,51 +1,51 @@
-from enum import StrEnum
-from pydantic import BaseModel
-from rid_lib import RID
-from rid_lib.ext import Manifest, Bundle
-
-
-class EventType(StrEnum):
-    NEW = "NEW"
-    UPDATE = "UPDATE"
-    FORGET = "FORGET"
-
-class Event(BaseModel):
-    rid: RID
-    event_type: EventType
-    manifest: Manifest | None = None
-    contents: dict | None = None
-    
-    def __repr__(self):
-        return f"<Event '{self.rid}' event type: '{self.event_type}'>"
-    
-    @classmethod
-    def from_bundle(cls, event_type: EventType, bundle: Bundle):
-        return cls(
-            rid=bundle.manifest.rid,
-            event_type=event_type,
-            manifest=bundle.manifest,
-            contents=bundle.contents
-        )
-        
-    @classmethod
-    def from_manifest(cls, event_type: EventType, manifest: Manifest):
-        return cls(
-            rid=manifest.rid,
-            event_type=event_type,
-            manifest=manifest
-        )
-        
-    @classmethod
-    def from_rid(cls, event_type: EventType, rid: RID):
-        return cls(
-            rid=rid,
-            event_type=event_type
-        )
-        
-    @property
-    def bundle(self):
-        if self.manifest is not None and self.contents is not None:
-            return Bundle(
-                manifest=self.manifest,
-                contents=self.contents
+from enum import StrEnum
+from pydantic import BaseModel
+from rid_lib import RID
+from rid_lib.ext import Manifest, Bundle
+
+
+class EventType(StrEnum):
+    NEW = "NEW"
+    UPDATE = "UPDATE"
+    FORGET = "FORGET"
+
+class Event(BaseModel):
+    rid: RID
+    event_type: EventType
+    manifest: Manifest | None = None
+    contents: dict | None = None
+    
+    def __repr__(self):
+        return f"<Event '{self.rid}' event type: '{self.event_type}'>"
+    
+    @classmethod
+    def from_bundle(cls, event_type: EventType, bundle: Bundle):
+        return cls(
+            rid=bundle.manifest.rid,
+            event_type=event_type,
+            manifest=bundle.manifest,
+            contents=bundle.contents
+        )
+        
+    @classmethod
+    def from_manifest(cls, event_type: EventType, manifest: Manifest):
+        return cls(
+            rid=manifest.rid,
+            event_type=event_type,
+            manifest=manifest
+        )
+        
+    @classmethod
+    def from_rid(cls, event_type: EventType, rid: RID):
+        return cls(
+            rid=rid,
+            event_type=event_type
+        )
+        
+    @property
+    def bundle(self):
+        if self.manifest is not None and self.contents is not None:
+            return Bundle(
+                manifest=self.manifest,
+                contents=self.contents
             )

koi_net/protocol/helpers.py

@@ -1,25 +1,25 @@
-from rid_lib.core import RIDType
-from rid_lib.ext.bundle import Bundle
-from rid_lib.types import KoiNetEdge
-from rid_lib.types.koi_net_node import KoiNetNode
-from .edge import EdgeProfile, EdgeStatus, EdgeType
-
-def generate_edge_bundle(
-    source: KoiNetNode,
-    target: KoiNetNode,
-    rid_types: list[RIDType],
-    edge_type: EdgeType
-) -> Bundle:
-    edge_rid = KoiNetEdge.generate(source, target)
-    edge_profile = EdgeProfile(
-        source=source,
-        target=target,
-        rid_types=rid_types,
-        edge_type=edge_type,
-        status=EdgeStatus.PROPOSED
-    )
-    edge_bundle = Bundle.generate(
-        edge_rid,
-        edge_profile.model_dump()
-    )
+from rid_lib.core import RIDType
+from rid_lib.ext.bundle import Bundle
+from rid_lib.types import KoiNetEdge
+from rid_lib.types.koi_net_node import KoiNetNode
+from .edge import EdgeProfile, EdgeStatus, EdgeType
+
+def generate_edge_bundle(
+    source: KoiNetNode,
+    target: KoiNetNode,
+    rid_types: list[RIDType],
+    edge_type: EdgeType
+) -> Bundle:
+    edge_rid = KoiNetEdge.generate(source, target)
+    edge_profile = EdgeProfile(
+        source=source,
+        target=target,
+        rid_types=rid_types,
+        edge_type=edge_type,
+        status=EdgeStatus.PROPOSED
+    )
+    edge_bundle = Bundle.generate(
+        edge_rid,
+        edge_profile.model_dump()
+    )
     return edge_bundle

koi_net/protocol/node.py

@@ -1,17 +1,17 @@
-from enum import StrEnum
-from pydantic import BaseModel
-from rid_lib import RIDType
-
-
-class NodeType(StrEnum):
-    FULL = "FULL"
-    PARTIAL = "PARTIAL"
-
-class NodeProvides(BaseModel):
-    event: list[RIDType] = []
-    state: list[RIDType] = []
-
-class NodeProfile(BaseModel):
-    base_url: str | None = None
-    node_type: NodeType
+from enum import StrEnum
+from pydantic import BaseModel
+from rid_lib import RIDType
+
+
+class NodeType(StrEnum):
+    FULL = "FULL"
+    PARTIAL = "PARTIAL"
+
+class NodeProvides(BaseModel):
+    event: list[RIDType] = []
+    state: list[RIDType] = []
+
+class NodeProfile(BaseModel):
+    base_url: str | None = None
+    node_type: NodeType
     provides: NodeProvides = NodeProvides()

{koi_net-1.0.0b10.dist-info → koi_net-1.0.0b12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: koi-net
-Version: 1.0.0b10
+Version: 1.0.0b12
 Summary: Implementation of KOI-net protocol in Python
 Project-URL: Homepage, https://github.com/BlockScience/koi-net/
 Author-email: Luke Miller <luke@block.science>
@@ -118,7 +118,9 @@ The request and payload JSON objects are composed of the fundamental "knowledge
 }
 ```
 
-This means that events are essentially just an RID, manifest, or bundle with an event type attached. Event types can be one of `"FORGET"`, `"UPDATE"`, or `"NEW"` forming the "FUN" acronym. While these types roughly correspond to delete, update, and create from CRUD operations, but they are not commands, they are signals. A node emits an event to indicate that its internal state has changed:
+An event is a signalling construct that conveys information about RID objects between networked nodes. Events are composed of an RID, manifest, or bundle with an event type attached. Event types can be one of `"FORGET"`, `"UPDATE"`, or `"NEW"` forming the "FUN" acronym. 
+
+As opposed to CRUD (create, read, update, delete), events are a series of messages, not operations. Each node has its own autonomy in deciding how to react based on the message it receives. For example, a processor node may receive a `"NEW"` event for an RID object its not interested in, and ignore it. Or it may decide that an `"UPDATE"` event should trigger fetching a bundle from another node. A node emits an event to indicate that its internal state has changed:
 - `"NEW"` - indicates an previously unknown RID was cached
 - `"UPDATE"` - indicates a previously known RID was cached
 - `"FORGET"` - indicates a previously known RID was deleted

koi_net-1.0.0b12.dist-info/RECORD

@@ -0,0 +1,24 @@
+koi_net/__init__.py,sha256=b0Ze0pZmJAuygpWUFHM6Kvqo3DkU_uzmkptv1EpAArw,31
+koi_net/core.py,sha256=7tSGGdV_EYUKNF5q7q5gV0KCelkuDLQapQhcB4GiZAQ,4562
+koi_net/identity.py,sha256=xSWmAgG2RJbixijdELPI--LSgHxrNteEcTN1M0Ekib4,2317
+koi_net/network/__init__.py,sha256=r_RN-q_mDYC-2RAkN-lJoMUX76TXyfEUc_MVKW87z0g,39
+koi_net/network/graph.py,sha256=dsfPuHUTkCzlj0QeL0e7dgp7-FR5_AGP7eE8EpBPhC0,4710
+koi_net/network/interface.py,sha256=-_pkWEcUIdWyvwJxaoPpiE8yVlg5w7c417U7cBTawuw,10387
+koi_net/network/request_handler.py,sha256=66gjX2x4UnBWZYwKLjp_3WkhL-ekhR3VAyfGviHTcUs,4790
+koi_net/network/response_handler.py,sha256=CAwici2Etj9ESndERXdtYkMlc4gWHz_xc7jHgY2Qjcg,1830
+koi_net/processor/__init__.py,sha256=x4fAY0hvQEDcpfdTB3POIzxBQjYAtn0qQazPo1Xm0m4,41
+koi_net/processor/default_handlers.py,sha256=vfQNvucQR5zANyYhdLnc3kOXGFrgNtq5swd-vH7n0Uo,6810
+koi_net/processor/handler.py,sha256=7X6M6PP8m6-xdtsP1y4QO83g_MN5VSszNNikprITK80,2523
+koi_net/processor/interface.py,sha256=Qvm0TaYB8kLraiLArupHx0KivI4yB83gOsiGirUkvcw,12890
+koi_net/processor/knowledge_object.py,sha256=RCgzkILsWm1Jw_NkSu4jTRYA9Ugga6mJ4jqKWwketQs,4090
+koi_net/protocol/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+koi_net/protocol/api_models.py,sha256=DYDKCRD2Uja633bBAyTsaxyb1oF9pX9yQ9NpNAbkczo,1070
+koi_net/protocol/consts.py,sha256=bisbVEojPIHlLhkLafBzfIhH25TjNfvTORF1g6YXzIM,243
+koi_net/protocol/edge.py,sha256=CcmvIY4P1HEBdKNJ4wFRDmwYMRMss24Besmbi7ZRFxQ,427
+koi_net/protocol/event.py,sha256=HxzLN-iCXPyr2YzrswMIkgZYeUdFbBpa5v98dAB06lQ,1328
+koi_net/protocol/helpers.py,sha256=8ZkQrjb_G0QEaMIKe9wkFOBonl1bkmemx_pwKMwIiLg,695
+koi_net/protocol/node.py,sha256=2HhCh3LdBLlY2Z_kXNmKHzpVLKbP_ODob3HjHayFQtM,375
+koi_net-1.0.0b12.dist-info/METADATA,sha256=0ic3QADnehpTrxpXo4VqruuhEw74N7tDaKYyvFsBEvY,34131
+koi_net-1.0.0b12.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+koi_net-1.0.0b12.dist-info/licenses/LICENSE,sha256=03mgCL5qth2aD9C3F3qNVs4sFJSpK9kjtYCyOwdSp7s,1069
+koi_net-1.0.0b12.dist-info/RECORD,,