lionagi 0.7.8__py3-none-any.whl → 0.8.0__py3-none-any.whl

lionagi/operatives/forms/report.py

@@ -1,11 +1,8 @@
-# Copyright (c) 2023 - 2024, HaiyangLi <quantocean.li at gmail dot com>
-#
-# SPDX-License-Identifier: Apache-2.0
+# forms/report.py
 
 from pydantic import Field
 
 from lionagi.protocols.generic.pile import Pile
-from lionagi.utils import UNDEFINED
 
 from .base import BaseForm
 from .form import Form
@@ -13,311 +10,36 @@ from .form import Form
 
 class Report(BaseForm):
     """
-    Report class that extends BaseForm to manage and track task completion.
-
-    This class provides functionalities to create forms, track completed tasks,
-    and generate reports based on a template. It is designed to manage
-    multiple forms and their assignments, keeping track of completed tasks
-    and their results.
-
-    Attributes:
-        default_form_template (Type[Form]): Default template for creating forms
-        strict_form (bool): If True, form cannot be modified after init.
-        completed_tasks (Pile[Form]): A pile of completed tasks.
-        completed_task_assignments (dict[str, str]): Assignments completed for
-            the report, mapping form IDs to assignments.
+    A minimal class that collects multiple completed forms as "sub-tasks."
+    If you have a single FlowDefinition that describes the entire multi-step pipeline,
+    you can track each step as a separate form in here.
     """
 
-    default_form_template: type[Form] = Form
-    strict_form: bool = Field(
-        default=False,
-        description="If True, form cannot be modified after init.",
-    )
-
-    completed_tasks: Pile[Form] = Field(
+    default_form_cls: type[Form] = Form
+    completed_forms: Pile[Form] = Field(
         default_factory=lambda: Pile(item_type={Form}),
-        description="A pile of tasks completed",
+        description="A list of forms that have been completed for this report.",
     )
-
-    completed_task_assignments: dict[str, str] = Field(
+    form_assignments: dict[str, str] = Field(
         default_factory=dict,
-        description="assignments completed for the report",
+        description="Mapping from form ID -> assignment string",
     )
 
-    @property
-    def work_fields(self) -> list[str]:
-        """
-        Get a list of work fields in the report.
-
-        Work fields are fields that are not part of the base report structure
-        but are added dynamically. These fields represent the core tasks
-        or assignments being tracked in the report.
-
-        Returns:
-            list[str]: A list of work fields.
-        """
-        base_report_fields = self.__class__.model_fields.keys()
-        all_fields = self.all_fields.keys()
-        return [i for i in all_fields if i not in base_report_fields]
-
-    def get_incomplete_fields(
-        self,
-        none_as_valid_value: bool = False,
-    ) -> list[str]:
-        """
-        Get a list of incomplete fields in the report.
-
-        This method checks all fields in the report and returns a list of those
-        that are incomplete, based on whether `None` is considered a valid
-        value.
-
-        Args:
-            none_as_valid_value (bool): If True, `None` is considered valid.
-
-        Returns:
-            list[str]: A list of incomplete fields.
-        """
-        base_report_fields = self.__class__.model_fields.keys()
-
-        result = []
-        for i in self.all_fields:
-            if i in base_report_fields:
-                continue
-            if none_as_valid_value:
-                if getattr(self, i) is UNDEFINED:
-                    result.append(i)
-            else:
-                if getattr(self, i) in [None, UNDEFINED]:
-                    result.append(i)
-        return result
-
-    def parse_assignment(
-        self,
-        input_fields: list[str],
-        request_fields: list[str],
-    ) -> str:
-        """
-        Parse and create an assignment string from input and request fields.
-
-        This method generates an assignment string in the format
-        "input_field1, input_field2 -> request_field1, request_field2".
-
-        Args:
-            input_fields (list[str]): A list of input fields.
-            request_fields (list[str]): A list of request fields.
-
-        Returns:
-            str: The parsed assignment string.
-
-        Raises:
-            ValueError: If input_fields or request_fields are not lists or
-                        if any field is missing from the form.
-        """
-        if not isinstance(input_fields, list):
-            raise TypeError("The input_fields must be a list of strings.")
-
-        if not isinstance(request_fields, list):
-            raise TypeError("The request_fields must be a list of strings.")
-
-        for i in input_fields + request_fields:
-            if i not in self.all_fields:
-                raise ValueError(f"Field {i} is missing.")
-
-        input_assignment = ", ".join(input_fields)
-        output_assignment = ", ".join(request_fields)
-        return f"{input_assignment} -> {output_assignment}"
-
-    def create_form(
-        self,
-        assignment: str,
-        *,
-        input_fields: list[str] | None = None,
-        request_fields: list[str] | None = None,
-        task_description: str | None = None,
-        fill_inputs: bool | None = True,
-        none_as_valid_value: bool | None = False,
-        strict=None,
-    ) -> Form:
-        """
-        Create a form based on the assignment or input/request fields.
-
-        This method generates a new form either based on a direct assignment
-        string or by parsing input and request fields to create the assignment.
-        The form can be configured to pre-fill input fields and handle `None`
-        values as valid or invalid.
-
-        Args:
-            assignment (str): The assignment string defining the task.
-            input_fields (list[str], optional): A list of input fields.
-            request_fields (list[str], optional): A list of request fields.
-            task_description (str, optional): A description of the task.
-            fill_inputs (bool, optional): Whether to pre-fill input fields.
-            none_as_valid_value (bool, optional): Treat `None` as valid value.
-            strict (bool, optional): Whether the form should be strict.
-
-        Returns:
-            Form: The created form.
-
-        Raises:
-            ValueError: If both assignment and input/request fields are
-                        provided or if neither is provided.
-        """
-        if assignment is not None:
-            if input_fields is not None or request_fields is not None:
-                raise ValueError(
-                    "Cannot provide input/request fields with assignment.",
-                )
-        else:
-            if input_fields is None or request_fields is None:
-                raise ValueError(
-                    "Provide input_fields and request_fields lists together."
-                )
-
-        if not assignment:
-            assignment = self.parse_assignment(
-                input_fields=input_fields,
-                request_fields=request_fields,
-            )
-
-        f_ = self.default_form_template.from_form(
-            assignment=assignment,
-            form=self,
-            task_description=task_description,
-            fill_inputs=fill_inputs,
-            none_as_valid_value=none_as_valid_value,
-            strict=strict if isinstance(strict, bool) else self.strict_form,
-        )
-        return f_
-
-    def save_completed_form(
-        self,
-        form: Form,
-        update_results=False,
-    ) -> None:
+    def add_completed_form(
+        self, form: Form, update_report_fields: bool = False
+    ):
         """
-        Save a completed form to the report.
-
-        This method adds a form to the `completed_tasks` pile, ensuring that
-        all fields in the form are compatible with the report. Optionally, it
-        can update the report fields with results from the form.
-
-        Args:
-            form (Form): The form to be saved.
-            update_results (bool): Update the report with form results.
-
-        Raises:
-            ValueError: If the form is incomplete or if its fields do not
-                        match the report's fields.
+        Add a completed form. Optionally update the report’s fields from the form's output.
         """
-        try:
-            form.check_is_completed(handle_how="raise")
-        except Exception as e:
-            raise ValueError(f"Failed to add completed form. Error: {e}")
-
-        report_fields = self.all_fields.keys()
-        for i in form.work_dict.keys():
-            if i not in report_fields:
-                raise ValueError(
-                    f"The task does not match the report. "
-                    f"Field {i} in task assignment not found in report."
-                )
-
-        self.completed_tasks.include(form)
-        self.completed_task_assignments[form.id] = form.assignment
-
-        if update_results:
-            for i in form.request_fields:
-                field_result = getattr(form, i)
-                setattr(self, i, field_result)
-
-    @classmethod
-    def from_form_template(
-        cls,
-        template_class: type[BaseForm],
-        **input_kwargs,
-    ) -> "Report":
-        """
-        Create a report from a form template.
-
-        This method generates a report object using the fields from a specified
-        form template. The report is populated with input values provided via
-        keyword arguments.
-
-        Args:
-            template_class (Type[BaseForm]): The form template class to use.
-            **input_kwargs: Values to initialize the report's fields.
-
-        Returns:
-            Report: The generated report.
-
-        Raises:
-            ValueError: If template class is not a subclass of `BaseForm`.
-        """
-        if not issubclass(template_class, BaseForm):
+        missing = form.check_completeness()
+        if missing:
             raise ValueError(
-                "Invalid form template. Must be a subclass of Form.",
+                f"Form {form.id} is incomplete: missing {missing}."
             )
-        template_class = template_class or cls.default_form_template
-        rep_template = "report_for_"
-        rep_template += template_class.model_fields["template_name"].default
-
-        report_obj = cls(template_name=rep_template)
-
-        base_report_fields = cls.model_fields.keys()
-
-        for field, field_info in template_class.model_fields.items():
-            if field in base_report_fields:
-                continue
-            if field not in report_obj.all_fields:
-                report_obj.add_field(field, field_obj=field_info)
-            if field in input_kwargs:
-                value = input_kwargs.get(field)
-                setattr(report_obj, field, value)
-
-        return report_obj
-
-    @classmethod
-    def from_form(
-        cls,
-        form: BaseForm,
-        fill_inputs: bool = True,
-    ) -> "Report":
-        """
-        Create a report from an existing form.
-
-        This method generates a report object using the fields from an existing
-        form, optionally filling the report with the form's input values.
-
-        Args:
-            form (BaseForm): The form to use as a template.
-            fill_inputs (bool): Fill the report with form's input values.
-
-        Returns:
-            Report: The generated report.
-
-        Raises:
-            ValueError: If form is not an instance of `BaseForm`.
-        """
-        if not isinstance(form, BaseForm):
-            raise TypeError("Invalid form. Should be an instance of BaseForm.")
-
-        report_template_name = "report_for_" + form.template_name
-        report_obj = cls(template_name=report_template_name)
-
-        base_report_fields = cls.model_fields.keys()
-
-        for field, field_info in form.all_fields.items():
-            if field in base_report_fields:
-                continue
-            if field not in report_obj.all_fields:
-                report_obj.add_field(field, field_obj=field_info)
-            if fill_inputs:
-                value = getattr(form, field)
-                setattr(report_obj, field, value)
-
-        return report_obj
-
-
-__all__ = ["Report"]
-
-# File: lion_core/form/report.py
+        self.completed_forms.append(form)
+        self.form_assignments[form.id] = form.assignment or ""
+        # optionally update the report’s own fields
+        if update_report_fields:
+            for f_ in form.output_fields:
+                val = getattr(form, f_, None)
+                setattr(self, f_, val)

lionagi/operatives/types.py

@@ -10,6 +10,7 @@ from .action.request_response_model import (
 )
 from .action.tool import FuncTool, FuncToolRef, Tool, ToolRef
 from .forms.base import BaseForm
+from .forms.flow import FlowDefinition, FlowStep
 from .forms.form import Form
 from .forms.report import Report
 from .instruct.base import (
@@ -66,4 +67,6 @@ __all__ = (
     "FuncTool",
     "FuncToolRef",
     "FunctionCalling",
+    "FlowDefinition",
+    "FlowStep",
 )

lionagi/version.py

@@ -1 +1 @@
-__version__ = "0.7.8"
+__version__ = "0.8.0"

{lionagi-0.7.8.dist-info → lionagi-0.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lionagi
-Version: 0.7.8
+Version: 0.8.0
 Summary: An Intelligence Operating System.
 Author-email: HaiyangLi <quantocean.li@gmail.com>
 License:            Apache License

{lionagi-0.7.8.dist-info → lionagi-0.8.0.dist-info}/RECORD

@@ -4,7 +4,7 @@ lionagi/_errors.py,sha256=wNKdnVQvE_CHEstK7htrrj334RA_vbGcIds-3pUiRkc,455
 lionagi/_types.py,sha256=9g7iytvSj3UjZxD-jL06_fxuNfgZyWT3Qnp0XYp1wQU,63
 lionagi/settings.py,sha256=k9zRJXv57TveyfHO3Vr9VGiKrSwlRUUVKt5zf6v9RU4,1627
 lionagi/utils.py,sha256=QbF4E1PG-BaRcEVH3kJIYCJVNq-oRNoTxjda5k8NYW4,73177
-lionagi/version.py,sha256=uC8wB9mRblQ0jUBAOUyCQLUQJ39MC2xybVLB_8ZsevU,22
+lionagi/version.py,sha256=iPlYCcIzuzW7T2HKDkmYlMkRI51dBLfNRxPPiWrfw9U,22
 lionagi/libs/__init__.py,sha256=v8vNyJVIVj8_Oz9RJdVe6ZKUQMYTgDh1VQpnr1KdLaw,112
 lionagi/libs/parse.py,sha256=tpEbmIRGuHhLCJlUlm6fjmqm_Z6XJLAXGNFHNuk422I,1011
 lionagi/libs/file/__init__.py,sha256=v8vNyJVIVj8_Oz9RJdVe6ZKUQMYTgDh1VQpnr1KdLaw,112
@@ -45,7 +45,7 @@ lionagi/libs/validate/fuzzy_validate_mapping.py,sha256=SQqyxgrAgJ5zBKxIAnulWsZXb
 lionagi/libs/validate/string_similarity.py,sha256=7x8D4LZCMNJGz2ZCeKmct7Nc4i8m_ORoHIeGvkeMZOA,8733
 lionagi/libs/validate/validate_boolean.py,sha256=h3d7Dn7asJokBozWaKxaV_3Y6vUWBc0-zfNJjTQ9Bo8,3614
 lionagi/operations/__init__.py,sha256=O7nV0tedpUe7_OlUWmCcduGPFtqtzWZcR_SIOnjLsro,134
-lionagi/operations/manager.py,sha256=qjDMSOJ35XjDXkVq0SlEb4inTS7OXGwxly2doiQCNas,556
+lionagi/operations/manager.py,sha256=H7UY86PIxvxKdzJY9YVsWyJcqlwLWhVyvm4sYePH_uY,565
 lionagi/operations/types.py,sha256=LIa68xcyKLVafof-DSFwKtSkneuYPFqrtGyClohYI6o,704
 lionagi/operations/utils.py,sha256=Twy6L_UFt9JqJFRYuKKTKVZIXsePidNl5ipcYcCbesI,1220
 lionagi/operations/ReAct/ReAct.py,sha256=tAZ-3Ya68tVUa112wgOMUJpBVw-RWBSYTfgicbInRuQ,3954
@@ -80,7 +80,7 @@ lionagi/operatives/__init__.py,sha256=v8vNyJVIVj8_Oz9RJdVe6ZKUQMYTgDh1VQpnr1KdLa
 lionagi/operatives/manager.py,sha256=pFGKSOIkXayHfDHCMJJwZXBhx3O02UlYK5mZ_-53AVg,190
 lionagi/operatives/operative.py,sha256=Pahhjlav-Y1rCYwUZkWNrw6nIOpR9zrqXwuHTYcbjMc,6734
 lionagi/operatives/step.py,sha256=DevwisZc2q88ynUiiSu7VBEY2A_G4Q5iRLrVgVLHNJU,9843
-lionagi/operatives/types.py,sha256=8krpGIeJL2GkO580ePOuAZfGc7vUVPIanemoA77tbVY,1697
+lionagi/operatives/types.py,sha256=X0Pz0aqVg20D3lfnKOZ0GtLj01M5WoYagVmu_aArkoo,1784
 lionagi/operatives/action/__init__.py,sha256=v8vNyJVIVj8_Oz9RJdVe6ZKUQMYTgDh1VQpnr1KdLaw,112
 lionagi/operatives/action/function_calling.py,sha256=dHWxnWj-YD2PkYoRO_iOI1dryb8tThuPDX1OMI0y8GM,4631
 lionagi/operatives/action/manager.py,sha256=FXfWhQMSFE5qJNZPpgdz4ePvthLafZfnmak2PImCrsc,8824
@@ -88,10 +88,10 @@ lionagi/operatives/action/request_response_model.py,sha256=mCyKub_WoEttJ_mqLhGoO
 lionagi/operatives/action/tool.py,sha256=CVCNd154XDxRvinmfO_2y72RsCn3UfZEecY7QG2qIjE,5217
 lionagi/operatives/action/utils.py,sha256=vUe7Aysuzbg16rAfe2Ttp5QUz5_L6mMedBVAWzGAHwk,4330
 lionagi/operatives/forms/__init__.py,sha256=v8vNyJVIVj8_Oz9RJdVe6ZKUQMYTgDh1VQpnr1KdLaw,112
-lionagi/operatives/forms/base.py,sha256=ALPREgOkRcY2wtRG0JpTXztlohkRjyCiwoleQfGCpSg,7207
-lionagi/operatives/forms/form.py,sha256=5z5VfDqcKVFYvhDVZZQwMDczSof2lSx_VxQo32jlkGk,27178
-lionagi/operatives/forms/report.py,sha256=KUapeSAB67ElyU1fl4DxtfvobKGnpDPetso6cT6GT4E,11167
-lionagi/operatives/forms/utils.py,sha256=sCjYRy-EJIh1py9qIb04LVgALy2YiPHbhXhNyDNwvoQ,701
+lionagi/operatives/forms/base.py,sha256=hitr0eKk7Yts2VfpuBGl0YxpClMJEpsy7xWodhg2AhQ,2720
+lionagi/operatives/forms/flow.py,sha256=JRHY_t8yZNN2p_spPvoFG1hD--2YVtAiA8h3hrK7Vt0,2556
+lionagi/operatives/forms/form.py,sha256=GJTE_PrlHT_bgWf-zOQaIFdEkx1CUDTzgAyRofPXoOE,2934
+lionagi/operatives/forms/report.py,sha256=ZQsM5nDnmF3WdCSurDUBTMI-PEy8yTnRA_uN6tyRneA,1488
 lionagi/operatives/instruct/__init__.py,sha256=v8vNyJVIVj8_Oz9RJdVe6ZKUQMYTgDh1VQpnr1KdLaw,112
 lionagi/operatives/instruct/base.py,sha256=Vw9u3BGzjNRGcPfW1ROr2uCZcZsjrm4WU6491P6ecCI,1895
 lionagi/operatives/instruct/instruct.py,sha256=vzIQks5gSXJQzdEE_l4PgJPw2ZUZPbAfZ-cDt6CPmeQ,4794
@@ -189,7 +189,7 @@ lionagi/service/providers/perplexity_/chat_completions.py,sha256=SsDbrtXwQsR4Yu2
 lionagi/session/__init__.py,sha256=v8vNyJVIVj8_Oz9RJdVe6ZKUQMYTgDh1VQpnr1KdLaw,112
 lionagi/session/branch.py,sha256=JvErd9YUuGdWyLj37rtKOteSqV0ltn9lg0R2G8GO40c,62539
 lionagi/session/session.py,sha256=po6C7PnM0iu_ISHUo4PBzzQ61HFOgcsAUfPoO--eLak,8987
-lionagi-0.7.8.dist-info/METADATA,sha256=DOTDD2nvGUO23P3KgSK-3RFla-5mkuuGEnWwiZHfAL8,22819
-lionagi-0.7.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-lionagi-0.7.8.dist-info/licenses/LICENSE,sha256=VXFWsdoN5AAknBCgFqQNgPWYx7OPp-PFEP961zGdOjc,11288
-lionagi-0.7.8.dist-info/RECORD,,
+lionagi-0.8.0.dist-info/METADATA,sha256=h38ifIVBrti2rDeeyvJiKB991VxdESlYSiIXl7KJsT8,22819
+lionagi-0.8.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+lionagi-0.8.0.dist-info/licenses/LICENSE,sha256=VXFWsdoN5AAknBCgFqQNgPWYx7OPp-PFEP961zGdOjc,11288
+lionagi-0.8.0.dist-info/RECORD,,

lionagi/operatives/forms/utils.py

@@ -1,26 +0,0 @@
-# Copyright (c) 2023 - 2024, HaiyangLi <quantocean.li at gmail dot com>
-#
-# SPDX-License-Identifier: Apache-2.0
-
-RESTRICTED_FIELDS = {
-    "input_fields",
-    "request_fields",
-    "init_input_kwargs",
-    "output_fields",
-}
-
-
-def get_input_output_fields(str_: str) -> tuple[list[str], list[str]]:
-    if str_ is None:
-        return [], []
-
-    if "->" not in str_:
-        raise ValueError(
-            "Invalid assignment format. Expected 'inputs -> outputs'.",
-        )
-
-    inputs, outputs = str_.split("->")
-    input_fields = [str(i).strip().lower() for i in inputs.split(",")]
-    request_fields = [str(o).strip().lower() for o in outputs.split(",")]
-
-    return input_fields, request_fields