knowledgenet 1.0.0__tar.gz

knowledgenet-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

knowledgenet-1.0.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: knowledgenet
+Version: 1.0.0
+Author: Amit Chatterjee
+Project-URL: Homepage, https://github.com/amitchatterjee/knowledgenet
+Project-URL: Issues, https://github.com/amitchatterjee/knowledgenet
+Project-URL: Repository, https://github.com/amitchatterjee/knowledgenet.git
+Project-URL: Documentation, https://github.com/amitchatterjee/knowledgenet/tree/develop/docs
+License-File: LICENSE
+Requires-Dist: opentelemetry-api>=1.39.1
+Requires-Dist: opentelemetry-sdk>=1.39.1
+Requires-Dist: opentelemetry-exporter-otlp>=1.39.1
+Dynamic: license-file

knowledgenet-1.0.0/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "knowledgenet"
+version = "1.0.0"
+authors = [
+  { name="Amit Chatterjee"},
+]
+
+dependencies = [
+  "opentelemetry-api >= 1.39.1",
+  "opentelemetry-sdk >= 1.39.1",
+  "opentelemetry-exporter-otlp >= 1.39.1"
+]
+
+[dependency-groups]
+dev = ["pytest", "pytest-cov", "build", "debugpy", "twine", "pip-tools", "sphinx", "sphinx-markdown-builder"]
+
+description = "Knowledgenet RETE engine"
+requires-python = ">=3.13"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+]
+keywords = [
+    "RETE",
+    "rules engine",
+    "knowledgebase",
+    "inference engine",
+    "expert systems",
+    "rule.based system",
+    "forward chaining",
+    "backward chaining",
+]
+license = "Apache-2.0"
+readme = "readme.md"
+[project.urls]
+Homepage = "https://github.com/amitchatterjee/knowledgenet"
+Issues = "https://github.com/amitchatterjee/knowledgenet"
+Repository = "https://github.com/amitchatterjee/knowledgenet.git"
+Documentation = "https://github.com/amitchatterjee/knowledgenet/tree/develop/docs"

knowledgenet-1.0.0/readme.md

@@ -0,0 +1,16 @@
+# Knowledgenet
+Knowledgenet is a Python Language software library that enables application developers to build applications that make complex decisions based on **facts** supplied to the service entrypoint and **rules** developed by **application developers** and **business users**. Knowledgenet is an implementation of an **Inference Engine** using an adaptation of the Rete algorithm designed by **Charles L. Forgy** of Carnegie Melon University. Rete is an efficient pattern matching algorithm that is widely used in many AI systems including Expert Systems.
+
+Please refer to the product documentation in [docs/index.md](docs/index.md) and in the [Knowledgenet Repository](https://github.com/amitchatterjee/knowledgenet/tree/develop/docs).
+
+## Setup
+
+### Install Python 3.14
+- Recommended: download the Windows installer from `https://www.python.org/downloads/release/python-3140/` and run it. During installation:
+    - check "Add Python to PATH"
+
+### Create and activate a virtual environment
+```bash
+python -m venv ~/venvs/knowledgenet
+source ~/venvs/knowledgenet/bin/activate
+```

knowledgenet-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

knowledgenet-1.0.0/src/api/conf.py

@@ -0,0 +1,24 @@
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
+
+project = "Knowledgenet API"
+author = "Knowledgenet Contributors"
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+]
+
+templates_path = []
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": True,
+    "show-inheritance": True,
+}
+
+html_theme = "alabaster"
+html_static_path = []

knowledgenet-1.0.0/src/knowledgenet/__init__.py

@@ -0,0 +1,11 @@
+"""Public package entrypoint for the Knowledgenet rules engine.
+
+This package exposes the rule authoring DSL, scanner utilities, and service
+runtime used to execute repositories of rulesets against transaction facts.
+
+Typical transaction lifecycle:
+1. Build or scan a Repository of Rulesets and Rules.
+2. Initialize Service(repository).
+3. Execute many transactions with ``service.execute(input_facts)``.
+4. Consume returned fact set containing original and derived facts.
+"""

knowledgenet-1.0.0/src/knowledgenet/container.py

@@ -0,0 +1,158 @@
+"""Collection primitives used to aggregate facts during session execution."""
+
+from typing import Callable
+from numbers import Number
+import inspect
+import hashlib
+import statistics
+
+from knowledgenet.util import of_type, to_tuple
+from knowledgenet.core.tracer import trace
+
+class Collector:
+    """Accumulates facts of one type and exposes aggregate operations.
+
+    Collector is itself a fact and can participate in rule matching through
+    ``Collection(...)`` or ``Fact(of_type=Collector, group=...)``.
+
+    Example:
+        Aggregate C1 facts and expose sum/size to rules::
+
+            Collector(
+                of_type=C1,
+                group='sum_of_c1s',
+                value=lambda obj: obj.val,
+            )
+    """
+
+    def __init__(self, group: str, 
+                of_type: type | str, 
+                filter: list[Callable] | tuple[Callable] | Callable | str = lambda this,child: True, 
+                value: Callable | None = None, key: Callable | None = None, 
+                **kwargs):
+        from knowledgenet.ftypes import EventFact
+        if of_type in (Collector, EventFact):
+            raise Exception('Nested Collector and Eventfact types are not supported')
+        self.of_type = of_type
+        self.group = group
+        self.filter = to_tuple(filter)
+        self.value = value
+        self.key = key
+        self.init_args = kwargs
+        for key,value in kwargs.items(): # type: ignore
+            setattr(self, key, value) # type: ignore
+
+        self.collection = set()
+        self._cached_sum = None
+        self._cached_variance = None
+        self._cached_min = None
+        self._cached_max = None
+
+        hasher = hashlib.sha256(group.encode())
+        for key,value in sorted(kwargs.items()): # type: ignore
+            hasher.update(str(key).encode())
+            hasher.update(str(value).encode())
+        self.__int_hash = int(hasher.hexdigest(), 16)
+
+    def __str__(self):
+        return f"Collector({self.group}, args={self.init_args})"
+    
+    def __repr__(self):
+        return self.__str__()
+   
+    def __hash__(self):
+        return self.__int_hash
+
+    def __eq__(self, other):
+        if not isinstance(other, Collector):
+            return False
+        return self.__hash__() == other.__hash__()
+
+    def size(self) -> int:
+        """Return the number of currently collected facts."""
+        return len(self.collection)
+    
+    def empty(self) -> bool:
+        """Return True when the collector has no facts."""
+        return len(self.collection) == 0
+
+    def reset_cache(self):
+        """Clear cached aggregate values after collection changes."""
+        self._cached_sum = None
+        self._cached_variance = None
+        self._cached_min = None
+        self._cached_max = None
+
+    def _filter_obj(self, obj):
+        for each_filter in self.filter:
+            if not each_filter(self, obj):
+                return False
+        return True
+
+    @trace(level=14)
+    def add(self, obj: object) -> bool:
+        """Attempt to add one fact to the collection.
+
+        Returns True only when type checks, filter checks, and deduplication all
+        pass and the collection actually changes.
+        """
+        if of_type(obj) != self.of_type:
+            return False
+        if obj in self.collection:
+            return False
+        if not self._filter_obj(obj):
+            return False
+        
+        self.collection.add(obj)
+        self.reset_cache()
+        return True
+
+    @trace(level=14)
+    def remove(self, obj: object) -> bool:
+        """Attempt to remove one fact from the collection.
+
+        Returns True only when the fact is currently present and passes the same
+        filter constraints used for insertion.
+        """
+        if of_type(obj) != self.of_type:
+            return False
+        if obj not in self.collection:
+            return False
+        if not self._filter_obj(obj):
+            return False
+        
+        self.collection.remove(obj)
+        self.reset_cache()
+        return True
+    
+    def sum(self) -> Number:
+        """Return sum of collected values using configured ``value`` accessor."""
+        if self._cached_sum is None:
+            if not self.value:
+                raise Exception("Don't know how to compute sum as value function is not defined")
+            self._cached_sum = sum([self.value(each) for each in self.collection])
+        return self._cached_sum
+
+    def variance(self) -> float:
+        """Return variance of collected values using configured ``value`` accessor."""
+        if self._cached_variance is None:
+            if not self.value:
+                raise Exception("Don't know how to compute variance as value function is not defined")
+            self._cached_variance = statistics.variance([self.value(each) for each in self.collection]) if len(self.collection) >= 2 else 0.0
+        return self._cached_variance
+
+    def minimum(self) -> object:
+        """Return minimum collected fact according to configured ``key`` accessor."""
+        if self._cached_min is None:
+            if not self.key:
+                raise Exception("Don't know how to compute min as key function is not defined")
+        self._cached_min = min(self.collection, key=self.key)
+        return self._cached_min
+
+    def maximum(self) -> object:
+        """Return maximum collected fact according to configured ``key`` accessor."""
+        if self._cached_max is None:
+            if not self.key:
+                raise Exception("Don't know how to compute max as key function is not defined")
+            self._cached_max = max(self.collection, key=self.key)
+        return self._cached_max

knowledgenet-1.0.0/src/knowledgenet/controls.py

@@ -0,0 +1,65 @@
+"""Rule action helpers used from then clauses.
+
+These helpers do not mutate Factset directly. Instead they record requested
+changes in ``ctx._changes`` so Session can apply merges in a deterministic
+order after node execution.
+"""
+
+from knowledgenet.core.tracer import trace
+from knowledgenet.ftypes import Switch
+
+def _add_key(ctx, key, fact):
+    if key not in ctx._changes:
+        ctx._changes[key] = []
+    ctx._changes[key].append(fact)
+
+@trace(level=3)
+def insert(ctx, fact):
+    """Request insertion of fact(s) after current node completes."""
+    _add_key(ctx, 'insert', fact)
+
+@trace(level=3)
+def update(ctx, fact):
+    """Request update propagation for fact(s) modified in place.
+
+    Example:
+        After mutating an existing fact, call update so dependent rules can be
+        re-evaluated::
+
+            ctx.item.val = 0
+            update(ctx, ctx.item)
+    """
+    _add_key(ctx, 'update', fact)
+
+@trace(level=3)
+def delete(ctx, fact):
+    """Request deletion of fact(s) after current node completes."""
+    _add_key(ctx, 'delete', fact)
+
+@trace(level=3)
+def next_ruleset(ctx):
+    """Stop the current ruleset session and continue with next repository ruleset."""
+    ctx._changes['break'] = True
+
+@trace(level=3)
+def switch(ctx, ruleset):
+    """Stop current session and request jump to a specific ruleset id.
+
+    Example:
+        Jump from current ruleset to ``rs3``::
+
+            switch(ctx, 'rs3')
+    """
+    ctx._changes['switch'] = Switch(ruleset)
+
+@trace(level=3)
+def end(ctx):
+    """Stop all remaining ruleset execution for this transaction.
+
+    Example:
+        End processing when validation fails::
+
+            if not ctx.validation.ok:
+                end(ctx)
+    """
+    switch(ctx, None)

knowledgenet-1.0.0/src/knowledgenet/core/file_trace_exporter.py

@@ -0,0 +1,90 @@
+import json
+import threading
+from typing import Sequence
+
+from opentelemetry.sdk.trace.export import SpanExporter, SpanExportResult
+
+class FileSpanExporter(SpanExporter):
+    """A simple OpenTelemetry span exporter that writes spans to a file as JSON lines.
+
+    This exporter performs a best-effort conversion of span objects to JSON-serializable
+    dictionaries and appends them to the configured file. It is intended for local
+    debugging or CI use where an OTLP backend is not available.
+    """
+    def __init__(self, file_path: str = "trace.ndjson"):
+        self._file_path = file_path
+        self._lock = threading.Lock()
+
+    def export(self, spans: Sequence[object]) -> "SpanExportResult":
+        records = []
+        for span in spans:
+            try:
+                rec = self._span_to_dict(span)
+            except Exception:
+                # fallback to a minimal representation
+                rec = {"name": getattr(span, "name", str(span)), "error": "serialization_failed"}
+            records.append(rec)
+
+        # append JSON lines
+        try:
+            with self._lock:
+                with open(self._file_path, "a", encoding="utf-8") as fh:
+                    for r in records:
+                        fh.write(json.dumps(r, default=str))
+                        fh.write("\n")
+            return SpanExportResult.SUCCESS
+        except Exception:
+            return SpanExportResult.FAILURE if hasattr(SpanExportResult, 'FAILURE') else SpanExportResult.SUCCESS
+
+    def shutdown(self) -> None:
+        # nothing to clean up for file exporter
+        return None
+
+    def _span_to_dict(self, span: object) -> dict:
+        # span is typically an opentelemetry.sdk.trace._Span
+        d = {
+            "name": getattr(span, "name", None),
+            "context": {
+                "span_id": getattr(getattr(span, "context", None), "span_id", None),
+                "trace_id": getattr(getattr(span, "context", None), "trace_id", None),
+            },
+            "parent_span_id": getattr(getattr(span, "parent", None), "span_id", None) or getattr(span, "parent_span_id", None),
+            "start_time": getattr(span, "start_time", None),
+            "end_time": getattr(span, "end_time", None),
+            "attributes": {},
+            "events": [],
+            "status": None,
+        }
+
+        # attributes
+        attrs = getattr(span, "attributes", None)
+        if attrs:
+            try:
+                for k, v in attrs.items():
+                    d["attributes"][k] = v
+            except Exception:
+                d["attributes"] = {str(k): str(v) for k, v in attrs.items()}
+
+        # events
+        events = getattr(span, "events", None)
+        if events:
+            try:
+                for ev in events:
+                    evdict = {
+                        "name": getattr(ev, "name", None),
+                        "attributes": getattr(ev, "attributes", None),
+                        "timestamp": getattr(ev, "timestamp", None),
+                    }
+                    d["events"].append(evdict)
+            except Exception:
+                pass
+
+        # status
+        st = getattr(span, "status", None)
+        if st is not None:
+            try:
+                d["status"] = {"status_code": getattr(st, "status_code", None), "description": getattr(st, "description", None)}
+            except Exception:
+                d["status"] = str(st)
+
+        return d