cornflow 1.0.10__tar.gz → 1.0.11__tar.gz

{cornflow-1.0.10/cornflow.egg-info → cornflow-1.0.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: cornflow
-Version: 1.0.10
+Version: 1.0.11
 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

{cornflow-1.0.10 → cornflow-1.0.11}/cornflow/models/base_data_model.py

@@ -28,6 +28,9 @@ class BaseDataModel(TraceAttributesModel):
 
     @declared_attr
     def user_id(self):
+        """
+        The foreign key for the user (:class:`UserModel<cornflow.models.UserModel>`).
+        """
         return db.Column(db.Integer, db.ForeignKey("users.id"), nullable=False)
 
     @declared_attr

{cornflow-1.0.10 → cornflow-1.0.11}/cornflow/models/case.py

@@ -34,10 +34,40 @@ SEPARATOR = "/"
 
 
 class CaseModel(BaseDataModel):
+    """
+    Model class for the Cases. 
+    It inherits from :class:`BaseDataModel<cornflow.models.base_data_model.BaseDataModel>` to have the trace fields and user field.
+
+    - **id**: int, the primary key for the cases, is an autoincrement.
+    - **path**: str, the path for the case, by default it would be the "root folder" (empty string).
+    - **name**: str, the name of the case given by the user.
+    - **description**: str, the description of the case given by the user. It is optional.
+    - **data**: dict (JSON), the data of the instance of the case.
+    - **checks**: dict (JSON), the checks of instance of the case.
+    - **data_hash**: str, the hash of the data of the instance of the case.
+    - **solution**: dict (JSON), the solution of the instance of the case.
+    - **solution_hash**: str, the hash of the solution of the instance of the case.
+    - **solution_checks**: dict (JSON), the checks of the solution of the instance of the case.
+    - **schema**: str, the schema of the instance of the case.
+    - **user_id**: int, the foreign key for the user (:class:`UserModel<cornflow.models.UserModel>`). It links the case to its owner.
+    - **created_at**: datetime, the datetime when the case was created (in UTC).
+      This datetime is generated automatically, the user does not need to provide it.
+    - **updated_at**: datetime, the datetime when the case was last updated (in UTC).
+      This datetime is generated automatically, the user does not need to provide it.
+    - **deleted_at**: datetime, the datetime when the case was deleted (in UTC). Even though it is deleted, actually, it is not deleted from the database, in order to have a command that cleans up deleted data after a certain time of its deletion.
+
+    """
+
+
     __tablename__ = "cases"
 
     id = db.Column(db.Integer, primary_key=True, autoincrement=True)
     path = db.Column(db.String(500), nullable=False, index=True)
+    solution = db.Column(JSON, nullable=True)
+    solution_hash = db.Column(db.String(256), nullable=False)
+    solution_checks = db.Column(JSON, nullable=True)
+
+
     # To find the descendants of this node, we look for nodes whose path
     # starts with this node's path.
     # c_path =
@@ -49,9 +79,7 @@ class CaseModel(BaseDataModel):
             path.concat(id).concat(SEPARATOR + "%")
         ),
     )
-    solution = db.Column(JSON, nullable=True)
-    solution_hash = db.Column(db.String(256), nullable=False)
-    solution_checks = db.Column(JSON, nullable=True)
+    
 
     # TODO: maybe implement this while making it compatible with sqlite:
     # Finding the ancestors is a little bit trickier. We need to create a fake
@@ -100,6 +128,17 @@ class CaseModel(BaseDataModel):
 
     @classmethod
     def from_parent_id(cls, user, data):
+        """
+        Class method to create a new case from an already existing case.
+
+        :param user: the user that is creating the case.
+        :type user: :class:`UserModel<cornflow.models.UserModel>`
+        :param data: the data of the case
+        :type data: dict
+        :return: the new case
+        :rtype: :class:`CaseModel<cornflow.models.CaseModel>`
+        """
+        
         if data.get("parent_id") is None:
             # we assume at root
             return cls(data, parent=None)
@@ -195,6 +234,12 @@ class CaseModel(BaseDataModel):
         return patched_data, hash_json_256(patched_data)
 
     def move_to(self, new_parent=None):
+        """
+        Method to move the case to a new path based on a new parent case
+
+        :param new_parent: the new parent case
+        :type new_parent: :class:`CaseModel<cornflow.models.CaseModel>`
+        """
         if new_parent is None:
             new_path = ""
         else:

{cornflow-1.0.10 → cornflow-1.0.11}/cornflow/models/execution.py

@@ -15,7 +15,7 @@ from cornflow.shared.const import DEFAULT_EXECUTION_CODE, EXECUTION_STATE_MESSAG
 class ExecutionModel(BaseDataModel):
     """
     Model class for the Executions.
-    It inherits from :class:`BaseDataModel` to have the trace fields and user field
+    It inherits from :class:`BaseDataModel<cornflow.models.base_data_model.BaseDataModel>` to have the trace fields and user field.
 
     - **id**: str, the primary key for the executions, a hash generated upon creation of the execution
       and the id given back to the user.

{cornflow-1.0.10 → cornflow-1.0.11}/cornflow/models/instance.py

@@ -11,7 +11,7 @@ from cornflow.shared import db
 class InstanceModel(BaseDataModel):
     """
     Model class for the Instances
-    It inherits from :class:`BaseDataModel` to have the trace fields and user field
+    It inherits from :class:`BaseDataModel<cornflow.models.base_data_model.BaseDataModel>` to have the trace fields and user field
 
     The :class:`InstanceModel` has the following fields:
 
@@ -58,12 +58,14 @@ class InstanceModel(BaseDataModel):
             (str(self.created_at) + " " + str(self.user_id)).encode()
         ).hexdigest()
 
-    def update(self, data):
+    def update(self, data: dict):
         """
-        Method used to update an instance from the database
+        Method used to update an instance from the database.
+
+        This method is mainly used on PUT requests to update the instance.
 
         :param dict data: the data of the object
-        :return: None
+        :return: Nothing, it will update the instance in-place and on the database
         :rtype: None
         """
         # Delete the checks if the data has been modified since they are probably not valid anymore

{cornflow-1.0.10 → cornflow-1.0.11/cornflow.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: cornflow
-Version: 1.0.10
+Version: 1.0.11
 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

{cornflow-1.0.10 → cornflow-1.0.11}/cornflow.egg-info/requires.txt

@@ -8,7 +8,7 @@ Flask==2.3.2
 flask-apispec<=0.11.4
 Flask-Bcrypt<=1.0.1
 Flask-Compress<=1.13
-flask-cors<=3.0.10
+flask-cors<=4.0.1
 flask-inflate<=0.3
 Flask-Migrate<=4.0.4
 Flask-RESTful<=0.3.9
@@ -25,7 +25,7 @@ pytups>=0.86.2
 requests<=2.31.0
 SQLAlchemy==1.3.21
 webargs<=8.2.0
-Werkzeug<=2.3.8
+Werkzeug<=3.0.3
 
 [:python_version < "3.11"]
 greenlet<=2.0.2

{cornflow-1.0.10 → cornflow-1.0.11}/setup.py

@@ -9,7 +9,7 @@ with open("requirements.txt", "r") as fh:
 
 setuptools.setup(
     name="cornflow",
-    version="1.0.10",
+    version="1.0.11",
     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.",