mindbridge-api-python-client 1.4.11__tar.gz → 1.5.0__tar.gz

{mindbridge_api_python_client-1.4.11 → mindbridge_api_python_client-1.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mindbridge-api-python-client
-Version: 1.4.11
+Version: 1.5.0
 Summary: Interact with the MindBridge API
 Home-page: https://www.mindbridge.ai
 License: Proprietary

{mindbridge_api_python_client-1.4.11 → mindbridge_api_python_client-1.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "mindbridge-api-python-client"
-version = "1.4.11"
+version = "1.5.0"
 description = "Interact with the MindBridge API"
 license = "Proprietary"
 authors = [

{mindbridge_api_python_client-1.4.11 → mindbridge_api_python_client-1.5.0}/src/mindbridgeapi/__init__.py

@@ -19,23 +19,21 @@ from mindbridgeapi.engagement_item import EngagementItem
 from mindbridgeapi.enumerations.analysis_source_type import AnalysisSourceType
 from mindbridgeapi.enumerations.analysis_type import AnalysisType
 from mindbridgeapi.enumerations.system_library import SystemLibrary
-from mindbridgeapi.file_manager_item import FileManagerItem
+from mindbridgeapi.file_manager_item import FileManagerItem, FileManagerType
 from mindbridgeapi.generated_pydantic_model.model import (
     PeriodType as AnalysisEffectiveDateMetricsPeriod,
 )
 from mindbridgeapi.generated_pydantic_model.model import Frequency
-from mindbridgeapi.generated_pydantic_model.model import Status4 as TaskStatus
 from mindbridgeapi.generated_pydantic_model.model import TargetWorkflowState
-from mindbridgeapi.generated_pydantic_model.model import Type5 as FileManagerType
-from mindbridgeapi.generated_pydantic_model.model import Type11 as TaskType
-from mindbridgeapi.generated_pydantic_model.model import Type13 as TransactionIdType
-from mindbridgeapi.generated_pydantic_model.model import Type17 as VirtualColumnType
 from mindbridgeapi.library_item import LibraryItem
 from mindbridgeapi.organization_item import OrganizationItem
 from mindbridgeapi.server import Server
-from mindbridgeapi.task_item import TaskItem
-from mindbridgeapi.transaction_id_selection import TransactionIdSelection
-from mindbridgeapi.virtual_column import VirtualColumn
+from mindbridgeapi.task_item import TaskItem, TaskStatus, TaskType
+from mindbridgeapi.transaction_id_selection import (
+    TransactionIdSelection,
+    TransactionIdType,
+)
+from mindbridgeapi.virtual_column import VirtualColumn, VirtualColumnType
 
 __all__ = [
     "AccountingPeriod",

{mindbridge_api_python_client-1.4.11 → mindbridge_api_python_client-1.5.0}/src/mindbridgeapi/account_grouping_item.py

@@ -17,6 +17,12 @@ from mindbridgeapi.generated_pydantic_model.model import (
     ApiAccountGroupingRead,
     ApiAccountGroupingUpdate,
 )
+from mindbridgeapi.generated_pydantic_model.model import (
+    Type7 as _AccountGroupingFileType,
+)
+
+# Match the type of ApiImportAccountGroupingParamsCreateOnly.type:
+AccountGroupingFileType = _AccountGroupingFileType
 
 
 def _empty_account_groups() -> Generator[AccountGroupItem, None, None]:

{mindbridge_api_python_client-1.4.11 → mindbridge_api_python_client-1.5.0}/src/mindbridgeapi/account_groupings.py

@@ -10,8 +10,11 @@ from dataclasses import dataclass
 from functools import cached_property
 import logging
 from typing import TYPE_CHECKING, Any, Dict, Generator, Optional, Union
-from mindbridgeapi.account_grouping_item import AccountGroupingItem
-from mindbridgeapi.async_result_item import AsyncResultItem
+from mindbridgeapi.account_grouping_item import (
+    AccountGroupingFileType,
+    AccountGroupingItem,
+)
+from mindbridgeapi.async_result_item import AsyncResultItem, AsyncResultType
 from mindbridgeapi.async_results import AsyncResults
 from mindbridgeapi.base_set import BaseSet
 from mindbridgeapi.exceptions import ItemError, ItemNotFoundError
@@ -19,16 +22,11 @@ from mindbridgeapi.generated_pydantic_model.model import (
     ApiImportAccountGroupingParamsCreateOnly,
     ApiImportAccountGroupingParamsUpdate,
 )
-from mindbridgeapi.generated_pydantic_model.model import (
-    Type7 as AccountGroupingFileType,
-)
-from mindbridgeapi.generated_pydantic_model.model import Type1 as AsyncResultType
 
 if TYPE_CHECKING:
     from os import PathLike
     from pathlib import Path
 
-
 logger = logging.getLogger(__name__)
 
 

{mindbridge_api_python_client-1.4.11 → mindbridge_api_python_client-1.5.0}/src/mindbridgeapi/analyses.py

@@ -13,8 +13,9 @@ import logging
 from typing import TYPE_CHECKING, Any, Dict, Generator, Optional
 import warnings
 from mindbridgeapi.analysis_item import AnalysisItem
+from mindbridgeapi.analysis_results import AnalysisResults
 from mindbridgeapi.analysis_sources import AnalysisSources
-from mindbridgeapi.async_result_item import AsyncResultItem
+from mindbridgeapi.async_result_item import AsyncResultItem, AsyncResultType
 from mindbridgeapi.base_set import BaseSet
 from mindbridgeapi.data_tables import DataTables
 from mindbridgeapi.exceptions import (
@@ -30,7 +31,6 @@ from mindbridgeapi.generated_pydantic_model.model import (
     ApiEngagementRollForwardRequest,
     EntityType,
 )
-from mindbridgeapi.generated_pydantic_model.model import Type1 as AsyncResultType
 from mindbridgeapi.tasks import Tasks
 
 if TYPE_CHECKING:
@@ -257,19 +257,31 @@ class Analyses(BaseSet):
         if analysis.id is None:
             raise ItemNotFoundError
 
+        self.restart_analysis_results(analysis)
+        analysis_results_list = list(analysis.analysis_results)
+        if not analysis_results_list:
+            raise ValidationError(
+                f"Unable to find any analysis_results for: {analysis.id}. Possibly the "
+                "analysis has not been started yet?"
+            )
+
+        analysis_result = max(
+            analysis_results_list, key=lambda x: getattr(x, "creation_date", date.min)
+        )
+
         async_results = self.server.async_results.get(
             json={
                 "$and": [
-                    {"entityId": {"$eq": analysis.id}},
+                    {"entityId": {"$eq": analysis_result.id}},
                     {"type": {"$eq": AsyncResultType.ANALYSIS_RUN}},
-                    {"entityType": {"$eq": EntityType.ANALYSIS}},
+                    {"entityType": {"$eq": EntityType.ANALYSIS_RESULT}},
                 ]
             }
         )
         async_results_list = list(async_results)
         if not async_results_list:
             raise ValidationError(
-                f"Unable to find {EntityType.ANALYSIS} run status for: {analysis.id}."
+                f"Unable to find {AsyncResultType.ANALYSIS_RUN} for: {analysis.id}."
                 " Possibly the analysis has not been started yet?"
             )
 
@@ -330,12 +342,21 @@ class Analyses(BaseSet):
         return self._restart_all_children(analysis)
 
     def _restart_all_children(self, analysis: AnalysisItem) -> AnalysisItem:
+        self.restart_analysis_results(analysis)
         self.restart_analysis_sources(analysis)
         self.restart_data_tables(analysis)
         self.restart_tasks(analysis)
 
         return analysis
 
+    def restart_analysis_results(self, analysis: AnalysisItem) -> None:
+        if analysis.id is None:
+            raise ItemNotFoundError
+
+        analysis.analysis_results = AnalysisResults(server=self.server).get(
+            json={"analysisId": {"$eq": analysis.id}}
+        )
+
     def restart_analysis_sources(self, analysis_item: AnalysisItem) -> None:
         if getattr(analysis_item, "id", None) is None:
             raise ItemNotFoundError

{mindbridge_api_python_client-1.4.11 → mindbridge_api_python_client-1.5.0}/src/mindbridgeapi/analysis_item.py

@@ -11,6 +11,7 @@ from typing import Any, Dict, Generator, List, Type, Union
 from pydantic import ConfigDict, Field, field_validator, model_validator
 from pydantic_core import PydanticUndefined
 from mindbridgeapi.analysis_period import AnalysisPeriod
+from mindbridgeapi.analysis_result_item import AnalysisResultItem
 from mindbridgeapi.analysis_source_item import AnalysisSourceItem
 from mindbridgeapi.analysis_type_item import AnalysisTypeItem
 from mindbridgeapi.common_validators import (
@@ -28,6 +29,15 @@ from mindbridgeapi.generated_pydantic_model.model import (
 from mindbridgeapi.task_item import TaskItem
 
 
+def _empty_analysis_results() -> Generator[AnalysisResultItem, None, None]:
+    """Empty generator function
+
+    This returns an empty generator function, it's use is to ensure analysis_results is
+    not None for the AnalysisItem class
+    """
+    yield from ()
+
+
 def _empty_analysis_sources() -> Generator[AnalysisSourceItem, None, None]:
     """Empty generator function
 
@@ -77,6 +87,9 @@ class AnalysisItem(ApiAnalysisRead):
     periodic: bool = Field().merge_field_infos(
         ApiAnalysisRead.model_fields["periodic"], default=False
     )
+    analysis_results: Generator[AnalysisResultItem, None, None] = Field(
+        default_factory=_empty_analysis_results, exclude=True
+    )
     analysis_sources: Generator[AnalysisSourceItem, None, None] = Field(
         default_factory=_empty_analysis_sources, exclude=True
     )

mindbridge_api_python_client-1.5.0/src/mindbridgeapi/analysis_result_item.py

@@ -0,0 +1,25 @@
+#
+#  Copyright MindBridge Analytics Inc. all rights reserved.
+#
+#  This material is confidential and may not be copied, distributed,
+#  reversed engineered, decompiled or otherwise disseminated without
+#  the prior written consent of MindBridge Analytics Inc.
+#
+
+from pydantic import ConfigDict, field_validator, model_validator
+from mindbridgeapi.common_validators import (
+    _convert_userinfo_to_useritem,
+    _warning_if_extra_fields,
+)
+from mindbridgeapi.generated_pydantic_model.model import ApiAnalysisResultRead
+
+
+class AnalysisResultItem(ApiAnalysisResultRead):
+    model_config = ConfigDict(
+        extra="allow",
+        validate_assignment=True,
+        validate_default=True,
+        validate_return=True,
+    )
+    _a = model_validator(mode="after")(_warning_if_extra_fields)
+    _b = field_validator("*")(_convert_userinfo_to_useritem)

mindbridge_api_python_client-1.5.0/src/mindbridgeapi/analysis_results.py

@@ -0,0 +1,36 @@
+#
+#  Copyright MindBridge Analytics Inc. all rights reserved.
+#
+#  This material is confidential and may not be copied, distributed,
+#  reversed engineered, decompiled or otherwise disseminated without
+#  the prior written consent of MindBridge Analytics Inc.
+#
+
+from dataclasses import dataclass
+from functools import cached_property
+from typing import Any, Dict, Generator, Optional
+from mindbridgeapi.analysis_result_item import AnalysisResultItem
+from mindbridgeapi.base_set import BaseSet
+
+
+@dataclass
+class AnalysisResults(BaseSet):
+    @cached_property
+    def base_url(self) -> str:
+        return f"{self.server.base_url}/analysis-results"
+
+    def get_by_id(self, id: str) -> AnalysisResultItem:
+        url = f"{self.base_url}/{id}"
+        resp_dict = super()._get_by_id(url=url)
+
+        return AnalysisResultItem.model_validate(resp_dict)
+
+    def get(
+        self, json: Optional[Dict[str, Any]] = None
+    ) -> Generator[AnalysisResultItem, None, None]:
+        if json is None:
+            json = {}
+
+        url = f"{self.base_url}/query"
+        for resp_dict in super()._get(url=url, json=json):
+            yield AnalysisResultItem.model_validate(resp_dict)

{mindbridge_api_python_client-1.4.11 → mindbridge_api_python_client-1.5.0}/src/mindbridgeapi/analysis_source_item.py

@@ -24,8 +24,7 @@ from mindbridgeapi.generated_pydantic_model.model import (
     ApiSplitByDelimiterVirtualColumnUpdate,
     ApiSplitByPositionVirtualColumnUpdate,
 )
-from mindbridgeapi.generated_pydantic_model.model import Type17 as VirtualColumnType
-from mindbridgeapi.virtual_column import VirtualColumn
+from mindbridgeapi.virtual_column import VirtualColumn, VirtualColumnType
 
 if sys.version_info >= (3, 9):
     from typing import Annotated

{mindbridge_api_python_client-1.4.11 → mindbridge_api_python_client-1.5.0}/src/mindbridgeapi/analysis_sources.py

@@ -11,7 +11,7 @@ from functools import cached_property
 import logging
 from typing import Any, Dict, Generator, Optional
 from mindbridgeapi.analysis_source_item import AnalysisSourceItem
-from mindbridgeapi.async_result_item import AsyncResultItem
+from mindbridgeapi.async_result_item import AsyncResultItem, AsyncResultType
 from mindbridgeapi.base_set import BaseSet
 from mindbridgeapi.exceptions import (
     ItemAlreadyExistsError,
@@ -25,7 +25,6 @@ from mindbridgeapi.generated_pydantic_model.model import (
 from mindbridgeapi.generated_pydantic_model.model import (
     PeriodType as AnalysisEffectiveDateMetricsPeriod,
 )
-from mindbridgeapi.generated_pydantic_model.model import Type1 as AsyncResultType
 
 logger = logging.getLogger(__name__)
 

{mindbridge_api_python_client-1.4.11 → mindbridge_api_python_client-1.5.0}/src/mindbridgeapi/async_result_item.py

@@ -14,11 +14,14 @@ from mindbridgeapi.common_validators import (
 )
 from mindbridgeapi.exceptions import ItemError, ItemNotFoundError, ValidationError
 from mindbridgeapi.generated_pydantic_model.model import ApiAsyncResult
-from mindbridgeapi.generated_pydantic_model.model import Status2 as AsyncResultStatus
-from mindbridgeapi.generated_pydantic_model.model import Type1 as AsyncResultType
+from mindbridgeapi.generated_pydantic_model.model import Status3 as _AsyncResultStatus
+from mindbridgeapi.generated_pydantic_model.model import Type1 as _AsyncResultType
 
 logger = logging.getLogger(__name__)
 
+AsyncResultStatus = _AsyncResultStatus  # Match the type of AsyncResultItem.status
+AsyncResultType = _AsyncResultType  # Match the type of AsyncResultItem.type
+
 
 class AsyncResultItem(ApiAsyncResult):
     model_config = ConfigDict(

{mindbridge_api_python_client-1.4.11 → mindbridge_api_python_client-1.5.0}/src/mindbridgeapi/async_results.py

@@ -11,14 +11,13 @@ from functools import cached_property
 import logging
 import time
 from typing import Any, Dict, Generator, List, Optional
-from mindbridgeapi.async_result_item import AsyncResultItem
+from mindbridgeapi.async_result_item import AsyncResultItem, AsyncResultStatus
 from mindbridgeapi.base_set import BaseSet
 from mindbridgeapi.exceptions import (
     ItemNotFoundError,
     UnexpectedServerError,
     ValidationError,
 )
-from mindbridgeapi.generated_pydantic_model.model import Status2 as AsyncResultStatus
 
 logger = logging.getLogger(__name__)
 

{mindbridge_api_python_client-1.4.11 → mindbridge_api_python_client-1.5.0}/src/mindbridgeapi/data_tables.py

@@ -11,7 +11,7 @@ from functools import cached_property
 import logging
 from typing import TYPE_CHECKING, Any, Dict, Generator, List, Optional
 import warnings
-from mindbridgeapi.async_result_item import AsyncResultItem
+from mindbridgeapi.async_result_item import AsyncResultItem, AsyncResultType
 from mindbridgeapi.async_results import AsyncResults
 from mindbridgeapi.base_set import BaseSet
 from mindbridgeapi.exceptions import ItemError, ItemNotFoundError, ParameterError
@@ -22,7 +22,6 @@ from mindbridgeapi.generated_pydantic_model.model import (
     Direction,
     MindBridgeQueryTerm,
 )
-from mindbridgeapi.generated_pydantic_model.model import Type1 as AsyncResultType
 from mindbridgeapi.generated_pydantic_model.model import Type4 as DataTableColumnType
 
 if TYPE_CHECKING:

{mindbridge_api_python_client-1.4.11 → mindbridge_api_python_client-1.5.0}/src/mindbridgeapi/engagement_account_groupings.py

@@ -9,11 +9,10 @@
 from dataclasses import dataclass
 from functools import cached_property
 from typing import TYPE_CHECKING, Any, Dict, Generator, Optional
-from mindbridgeapi.async_result_item import AsyncResultItem
+from mindbridgeapi.async_result_item import AsyncResultItem, AsyncResultType
 from mindbridgeapi.base_set import BaseSet
 from mindbridgeapi.engagement_account_grouping_item import EngagementAccountGroupingItem
 from mindbridgeapi.exceptions import ItemError, ItemNotFoundError
-from mindbridgeapi.generated_pydantic_model.model import Type1 as AsyncResultType
 
 if TYPE_CHECKING:
     from pathlib import Path

{mindbridge_api_python_client-1.4.11 → mindbridge_api_python_client-1.5.0}/src/mindbridgeapi/file_manager.py

@@ -17,8 +17,7 @@ from mindbridgeapi.exceptions import (
     ItemError,
     ItemNotFoundError,
 )
-from mindbridgeapi.file_manager_item import FileManagerItem
-from mindbridgeapi.generated_pydantic_model.model import Type5 as FileManagerType
+from mindbridgeapi.file_manager_item import FileManagerItem, FileManagerType
 
 if TYPE_CHECKING:
     from os import PathLike

{mindbridge_api_python_client-1.4.11 → mindbridge_api_python_client-1.5.0}/src/mindbridgeapi/file_manager_item.py

@@ -22,10 +22,12 @@ from mindbridgeapi.generated_pydantic_model.model import (
     ApiFileManagerFileRead,
     ApiFileManagerFileUpdate,
 )
-from mindbridgeapi.generated_pydantic_model.model import Type5 as FileManagerType
+from mindbridgeapi.generated_pydantic_model.model import Type5 as _FileManagerType
 
 logger = logging.getLogger(__name__)
 
+FileManagerType = _FileManagerType  # Match the type of FileManagerItem.status
+
 
 class FileManagerItem(ApiFileManagerFileRead):
     """A File or Directory on the File manager"""