cornflow 1.3.6__tar.gz → 1.3.7__tar.gz

{cornflow-1.3.6/cornflow.egg-info → cornflow-1.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cornflow
-Version: 1.3.6
+Version: 1.3.7
 Summary: cornflow is an open source multi-solver optimization server with a REST API built using flask.
 Home-page: https://github.com/baobabsoluciones/cornflow
 Author: baobab soluciones
@@ -14,7 +14,7 @@ Requires-Dist: alembic==1.9.2
 Requires-Dist: apispec==6.3.0
 Requires-Dist: cachetools==5.3.3
 Requires-Dist: click==8.1.7
-Requires-Dist: cornflow-client==1.3.6
+Requires-Dist: cornflow-client==1.3.7
 Requires-Dist: cryptography==48.0.1
 Requires-Dist: disposable-email-domains==0.0.162
 Requires-Dist: Flask==2.3.2

{cornflow-1.3.6 → cornflow-1.3.7}/cornflow/endpoints/data_check.py

@@ -219,7 +219,9 @@ class DataCheckInstanceEndpoint(BaseMetaResource):
         user = self.get_user()
         context_str = f"instance {idx}"
 
-        instance = InstanceModel.get_one_object(user=self.get_user(), idx=idx)
+        instance = InstanceModel.get_one_object(
+            user=self.get_user(), idx=idx, defer_data=True
+        )
         if instance is None:
             err = "The instance to check does not exist"
             raise ObjectDoesNotExist(

{cornflow-1.3.6 → cornflow-1.3.7}/cornflow/endpoints/execution.py

@@ -24,6 +24,7 @@ from cornflow.models import InstanceModel, DeployedWorkflow, ExecutionModel
 from cornflow.schemas.execution import (
     ExecutionDetailsEndpointResponse,
     ExecutionDetailsEndpointWithIndicatorsResponse,
+    ExecutionDetailsEndpointNoDataResponse,
     ExecutionDataEndpointResponse,
     ExecutionLogEndpointResponse,
     ExecutionStatusEndpointResponse,
@@ -497,7 +498,7 @@ class ExecutionDetailsEndpointBase(OrchestratorMixin):
 class ExecutionDetailsEndpoint(ExecutionDetailsEndpointBase):
     @doc(description="Get details of an execution", tags=["Executions"], inherit=False)
     @authenticate(auth_class=Auth())
-    @marshal_with(ExecutionDetailsEndpointWithIndicatorsResponse)
+    @marshal_with(ExecutionDetailsEndpointNoDataResponse)
     @BaseMetaResource.get_data_or_404
     def get(self, idx):
         """
@@ -513,7 +514,7 @@ class ExecutionDetailsEndpoint(ExecutionDetailsEndpointBase):
         current_app.logger.info(
             f"User {self.get_user()} gets details of execution {idx}"
         )
-        return self.get_detail(user=self.get_user(), idx=idx)
+        return self.get_detail(user=self.get_user(), idx=idx, defer_data=True)
 
     @doc(description="Edit an execution", tags=["Executions"], inherit=False)
     @authenticate(auth_class=Auth())

{cornflow-1.3.6 → cornflow-1.3.7}/cornflow/endpoints/instance.py

@@ -139,7 +139,7 @@ class InstanceDetailsEndpointBase(BaseMetaResource):
         :rtype: Tuple(dict, integer)
         """
         current_app.logger.info(f"User {self.get_user()} gets instance {idx}")
-        return self.get_detail(user=self.get_user(), idx=idx)
+        return self.get_detail(user=self.get_user(), idx=idx, defer_data=True)
 
 
 class InstanceDetailsEndpoint(InstanceDetailsEndpointBase):
@@ -157,7 +157,9 @@ class InstanceDetailsEndpoint(InstanceDetailsEndpointBase):
         :return: A dictionary with a confirmation message and an integer with the HTTP status code.
         :rtype: Tuple(dict, integer)
         """
-        schema = InstanceModel.get_one_object(user=self.get_user(), idx=idx).schema
+        schema = InstanceModel.get_one_object(
+            user=self.get_user(), idx=idx, defer_data=True
+        ).schema
 
         if kwargs.get("data") is not None and schema is not None:
             if schema == "pulp":

{cornflow-1.3.6 → cornflow-1.3.7}/cornflow/models/base_data_model.py

@@ -58,6 +58,7 @@ class BaseDataModel(TraceAttributesModel):
         offset=0,
         limit=10,
         user=None,
+        options=None,
     ):
         """
         Query to get all objects from a user
@@ -72,10 +73,13 @@ class BaseDataModel(TraceAttributesModel):
         :param string update_date_lte: update_at needs to be smaller or equal to this
         :param int offset: query offset for pagination
         :param int limit: query size limit
+        :param list options: extra SQLAlchemy loader options (e.g. defer()) to apply to the query
         :return: The objects
         :rtype: list(:class:`BaseDataModel`)
         """
         query = cls.query.filter(cls.deleted_at == None)
+        if options:
+            query = query.options(*options)
         user_access = int(current_app.config["USER_ACCESS_ALL_OBJECTS"])
         if (
             user is not None
@@ -103,19 +107,23 @@ class BaseDataModel(TraceAttributesModel):
         return query.order_by(desc(cls.created_at)).offset(offset).limit(limit).all()
 
     @classmethod
-    def get_one_object(cls, user=None, idx=None, **kwargs):
+    def get_one_object(cls, user=None, idx=None, options=None, **kwargs):
         """
         Query to get one object from the user and the id.
 
         :param UserModel user: user object performing the query
         :param str or int idx: ID from the object to get
+        :param list options: extra SQLAlchemy loader options (e.g. defer()) to apply to the query
         :return: The object or None if it does not exist
         :rtype: :class:`BaseDataModel`
         """
         user_access = int(current_app.config["USER_ACCESS_ALL_OBJECTS"])
         if user is None:
             return super().get_one_object(idx=idx)
-        query = cls.query.filter_by(id=idx, deleted_at=None)
+        query = cls.query
+        if options:
+            query = query.options(*options)
+        query = query.filter_by(id=idx, deleted_at=None)
         if not user.is_admin() and not user.is_service_user() and user_access == USER_ACCESS_ALL_OBJECTS_NO:
             query = query.filter_by(user_id=user.id)
         return query.first()

{cornflow-1.3.6 → cornflow-1.3.7}/cornflow/models/case.py

@@ -7,6 +7,7 @@ import jsonpatch
 from flask import current_app
 from sqlalchemy.dialects.postgresql import JSON
 from sqlalchemy.exc import DBAPIError, IntegrityError
+from sqlalchemy.orm import defer
 
 # Import from internal modules
 from cornflow.models.base_data_model import BaseDataModel
@@ -126,6 +127,21 @@ class CaseModel(BaseDataModel):
         self.solution_checks = data.get("solution_checks", None)
         self.kpis = data.get("kpis", None)
 
+    @classmethod
+    def get_all_objects(cls, *args, **kwargs):
+        """
+        Query to get all cases from a user, deferring the checks/solution_checks/kpis
+        columns since the list endpoint does not serialize them (only data and solution
+        are used, for the is_dir flag and the indicators).
+
+        :return: The objects
+        :rtype: list(:class:`CaseModel`)
+        """
+        kwargs.setdefault(
+            "options", [defer(cls.checks), defer(cls.solution_checks), defer(cls.kpis)]
+        )
+        return super().get_all_objects(*args, **kwargs)
+
     @classmethod
     def from_parent_id(cls, user, data):
         """

{cornflow-1.3.6 → cornflow-1.3.7}/cornflow/models/execution.py

@@ -162,6 +162,24 @@ class ExecutionModel(BaseDataModel):
         self.log_text = txt
         super().update({})
 
+    @classmethod
+    def get_one_object(cls, user=None, idx=None, defer_data=False, **kwargs):
+        """
+        Query to get one object from the user and the id.
+
+        :param UserModel user: user object performing the query
+        :param str or int idx: ID from the object to get
+        :param bool defer_data: whether to defer loading the heavy data/log columns
+        :return: The object or None if it does not exist
+        :rtype: :class:`ExecutionModel`
+        """
+        options = (
+            [defer(cls.data), defer(cls.log_text), defer(cls.log_json)]
+            if defer_data
+            else None
+        )
+        return super().get_one_object(user=user, idx=idx, options=options, **kwargs)
+
     @classmethod
     def get_all_objects(
         cls,

{cornflow-1.3.6 → cornflow-1.3.7}/cornflow/models/instance.py

@@ -3,6 +3,8 @@
 # Import from libraries
 import hashlib
 
+from sqlalchemy.orm import defer
+
 # Imported from internal models
 from cornflow.models.base_data_model import BaseDataModel
 from cornflow.shared import db
@@ -78,6 +80,32 @@ class InstanceModel(BaseDataModel):
 
         super().update(data)
 
+    @classmethod
+    def get_all_objects(cls, *args, **kwargs):
+        """
+        Query to get all instances from a user, deferring the heavy data/checks
+        columns since the list endpoints do not serialize them.
+
+        :return: The objects
+        :rtype: list(:class:`InstanceModel`)
+        """
+        kwargs.setdefault("options", [defer(cls.data), defer(cls.checks)])
+        return super().get_all_objects(*args, **kwargs)
+
+    @classmethod
+    def get_one_object(cls, user=None, idx=None, defer_data=False, **kwargs):
+        """
+        Query to get one instance from the user and the id.
+
+        :param UserModel user: user object performing the query
+        :param str or int idx: ID from the object to get
+        :param bool defer_data: whether to defer loading the heavy data/checks columns
+        :return: The object or None if it does not exist
+        :rtype: :class:`InstanceModel`
+        """
+        options = [defer(cls.data), defer(cls.checks)] if defer_data else None
+        return super().get_one_object(user=user, idx=idx, options=options, **kwargs)
+
     def __repr__(self):
         """
         Method to represent the class :class:`InstanceModel`

{cornflow-1.3.6 → cornflow-1.3.7}/cornflow/schemas/execution.py

@@ -156,6 +156,13 @@ class ExecutionDetailsWithIndicatorsAndLogResponse(
         exclude = ("indicators",)
 
 
+class ExecutionDetailsEndpointNoDataResponse(ExecutionDetailsEndpointWithIndicatorsResponse):
+    class Meta:
+        # Exclude 'indicators': data/log_text/log_json are deferred in get_one_object,
+        # so accessing obj.data here would trigger an extra load of those columns.
+        exclude = ("indicators",)
+
+
 class ExecutionStatusEndpointResponse(Schema):
     id = fields.Str()
     state = fields.Int()

{cornflow-1.3.6 → cornflow-1.3.7}/cornflow/shared/const.py

@@ -7,7 +7,7 @@ AIRFLOW_BACKEND = 1
 DATABRICKS_BACKEND = 2
 
 
-CORNFLOW_VERSION = "1.3.6"
+CORNFLOW_VERSION = "1.3.7"
 INTERNAL_TOKEN_ISSUER = "cornflow"
 
 # endpoints responses for health check

{cornflow-1.3.6 → cornflow-1.3.7/cornflow.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cornflow
-Version: 1.3.6
+Version: 1.3.7
 Summary: cornflow is an open source multi-solver optimization server with a REST API built using flask.
 Home-page: https://github.com/baobabsoluciones/cornflow
 Author: baobab soluciones
@@ -14,7 +14,7 @@ Requires-Dist: alembic==1.9.2
 Requires-Dist: apispec==6.3.0
 Requires-Dist: cachetools==5.3.3
 Requires-Dist: click==8.1.7
-Requires-Dist: cornflow-client==1.3.6
+Requires-Dist: cornflow-client==1.3.7
 Requires-Dist: cryptography==48.0.1
 Requires-Dist: disposable-email-domains==0.0.162
 Requires-Dist: Flask==2.3.2

{cornflow-1.3.6 → cornflow-1.3.7}/cornflow.egg-info/requires.txt

@@ -2,7 +2,7 @@ alembic==1.9.2
 apispec==6.3.0
 cachetools==5.3.3
 click==8.1.7
-cornflow-client==1.3.6
+cornflow-client==1.3.7
 cryptography==48.0.1
 disposable-email-domains==0.0.162
 Flask==2.3.2

{cornflow-1.3.6 → cornflow-1.3.7}/requirements.txt

@@ -2,7 +2,7 @@ alembic==1.9.2
 apispec==6.3.0
 cachetools==5.3.3
 click==8.1.7
-cornflow-client==1.3.6
+cornflow-client==1.3.7
 cryptography==48.0.1
 disposable-email-domains==0.0.162
 Flask==2.3.2

{cornflow-1.3.6 → cornflow-1.3.7}/setup.py

@@ -9,7 +9,7 @@ with open("requirements.txt", "r") as fh:
 
 setuptools.setup(
     name="cornflow",
-    version="1.3.6",
+    version="1.3.7",
     author="baobab soluciones",
     author_email="cornflow@baobabsoluciones.es",
     description="cornflow is an open source multi-solver optimization server with a REST API built using flask.",