cs-models 0.0.627__py3-none-any.whl → 0.0.847__py3-none-any.whl

cs_models/resources/WorkbookBlockComment/schemas.py

@@ -0,0 +1,15 @@
+"""Marshmallow Schema for AssistantCommand."""
+from marshmallow import Schema, fields
+
+
+class WorkbookBlockCommentResourceSchema(Schema):
+    """Class for AssistantCommandResource schema"""
+
+    id = fields.Integer(dump_only=True)
+    block_id = fields.Integer(required=True)
+    user_id = fields.String(required=True)
+    sequence_number = fields.Integer(required=True)
+    comment = fields.String(allow_none=True)
+    is_deleted = fields.Boolean(allow_none=True)
+    created_at = fields.DateTime(dump_only=True)
+    updated_at = fields.DateTime(dump_only=True)

cs_models/resources/WorkbookCommentThread/models.py

@@ -0,0 +1,59 @@
+from datetime import datetime
+
+from sqlalchemy import Column, DateTime, Boolean, ForeignKey, Integer, Text, String
+from sqlalchemy.orm import relationship
+
+from ...database import Base
+from ..WorkbookThreadComment.models import WorkbookThreadCommentModel
+
+
+class WorkbookCommentThreadModel(Base):
+    """
+    Represents a comment thread tied to a text selection in a workbook block.
+    """
+    __tablename__ = "workbook_comment_threads"
+
+    id = Column(Integer, primary_key=True)
+    workbook_id = Column(
+        Integer,
+        ForeignKey("workbooks.id", ondelete="CASCADE"),
+        nullable=False,
+    )
+    block_uid = Column(String(64), nullable=False)  # Root parent block UID
+
+    # Selection context
+    selected_text = Column(Text, nullable=False)  # The highlighted text
+
+    # Thread status
+    is_resolved = Column(Boolean, default=False, nullable=False)
+    resolved_by = Column(String(128), nullable=True)  # user_id who resolved
+    resolved_at = Column(DateTime, nullable=True)
+
+    # Soft delete
+    is_deleted = Column(Boolean, default=False, nullable=True)
+
+    # Timestamps
+    created_at = Column(DateTime, nullable=False, default=lambda: datetime.utcnow())
+    updated_at = Column(
+        DateTime,
+        nullable=False,
+        default=lambda: datetime.utcnow(),
+        onupdate=lambda: datetime.utcnow(),
+    )
+    created_by = Column(String(128), nullable=False)  # user_id who created thread
+
+    # Smart Grid Cells
+    cell_session_id = Column(Integer, nullable=True)
+    cell_user_query_id = Column(Integer, nullable=True)
+
+    # Relationships
+    workbook = relationship("WorkbookModel", back_populates="comment_threads")
+
+    comments = relationship(
+        "WorkbookThreadCommentModel",
+        primaryjoin="and_(WorkbookCommentThreadModel.id==WorkbookThreadCommentModel.thread_id, "
+                    "or_(WorkbookThreadCommentModel.is_deleted==False, WorkbookThreadCommentModel.is_deleted==None))",
+        order_by=WorkbookThreadCommentModel.sequence_number,
+        back_populates="thread",
+        lazy="joined",  # Eager load comments when loading thread
+    )

cs_models/resources/WorkbookCommentThread/schemas.py

@@ -0,0 +1,35 @@
+from marshmallow import Schema, fields, EXCLUDE
+from ..WorkbookThreadComment.schemas import (
+    WorkbookThreadCommentSchema,
+)
+
+
+class WorkbookCommentThreadResourceSchema(Schema):
+    """Class for AssistantCommandResource schema"""
+    class Meta:
+        unknown = EXCLUDE
+
+    id = fields.Integer(dump_only=True, data_key="thread_id")
+    workbook_id = fields.Integer(required=True)
+    block_uid = fields.String(required=True)
+    selected_text = fields.String(required=True)
+
+    # Thread status
+    is_resolved = fields.Boolean(allow_none=True)
+    resolved_by = fields.String(allow_none=True)
+    resolved_at = fields.DateTime(allow_none=True)
+
+    # Soft delete
+    is_deleted = fields.Boolean(allow_none=True)
+
+    # Timestamps
+    created_at = fields.DateTime(dump_only=True)
+    updated_at = fields.DateTime(dump_only=True)
+    created_by = fields.String(required=True)
+
+    # Smart Grid Cells
+    cell_session_id = fields.Integer(allow_none=True)
+    cell_user_query_id = fields.Integer(allow_none=True)
+
+    # Nested comments
+    comments = fields.Nested(WorkbookThreadCommentSchema(exclude=("thread_id",)), many=True, dump_only=True)

cs_models/resources/WorkbookMeta/models.py

@@ -0,0 +1,14 @@
+from sqlalchemy import (
+    Column,
+    Integer,
+    DateTime,
+    ForeignKey,
+)
+from datetime import datetime
+from ...database import Base
+
+
+class WorkbookMetaModel(Base):
+    __tablename__ = 'workbook_meta'
+    workbook_id = Column(Integer, ForeignKey("workbooks.id"), primary_key=True)
+    version = Column(Integer, nullable=False, default=0)

cs_models/resources/WorkbookMeta/schemas.py

@@ -0,0 +1,9 @@
+from marshmallow import (
+    Schema,
+    fields,
+)
+
+
+class WorkbookMetaResourceSchema(Schema):
+    workbook_id = fields.Integer(required=True)
+    version = fields.Integer(required=True)

cs_models/resources/WorkbookThreadComment/models.py

@@ -0,0 +1,38 @@
+from datetime import datetime
+
+from sqlalchemy import Column, DateTime, Boolean, ForeignKey, Integer, Text, String
+from sqlalchemy.orm import relationship
+
+from ...database import Base
+
+
+class WorkbookThreadCommentModel(Base):
+    """
+    Represents an individual comment within a thread.
+    """
+    __tablename__ = "workbook_thread_comments"
+
+    id = Column(Integer, primary_key=True)
+    thread_id = Column(
+        Integer,
+        ForeignKey("workbook_comment_threads.id", ondelete="CASCADE"),
+        nullable=False,
+    )
+    user_id = Column(String(128), nullable=False)
+    sequence_number = Column(Integer, nullable=False)  # 1 = initial comment
+    comment = Column(Text, nullable=False)
+
+    # Soft delete
+    is_deleted = Column(Boolean, default=False, nullable=True)
+
+    # Timestamps
+    created_at = Column(DateTime, nullable=False, default=lambda: datetime.utcnow())
+    updated_at = Column(
+        DateTime,
+        nullable=False,
+        default=lambda: datetime.utcnow(),
+        onupdate=lambda: datetime.utcnow(),
+    )
+
+    # Relationships
+    thread = relationship("WorkbookCommentThreadModel", back_populates="comments")

cs_models/resources/WorkbookThreadComment/schemas.py

@@ -0,0 +1,14 @@
+from marshmallow import Schema, fields
+
+
+class WorkbookThreadCommentSchema(Schema):
+    """Class for AssistantCommandResource schema"""
+
+    id = fields.Integer(dump_only=True)
+    thread_id = fields.Integer(required=True)
+    user_id = fields.String(required=True)
+    sequence_number = fields.Integer(required=True)
+    comment = fields.String(required=True)
+    is_deleted = fields.Boolean(allow_none=True)
+    created_at = fields.DateTime(dump_only=True)
+    updated_at = fields.DateTime(dump_only=True)

cs_models/resources/WorkbookWorkflow/models.py

@@ -0,0 +1,39 @@
+from sqlalchemy import (
+    Column,
+    Integer,
+    DateTime,
+    Boolean,
+    String,
+    ForeignKey,
+)
+from datetime import datetime
+from sqlalchemy.orm import relationship
+
+from ...database import Base
+from ..WorkbookWorkflowBlock.models import WorkbookWorkflowBlockModel
+
+
+class WorkbookWorkflowModel(Base):
+    __tablename__ = 'workbook_workflows'
+
+    id = Column(Integer, primary_key=True)
+    workbook_id = Column(
+        Integer,
+        ForeignKey("workbooks.id"),
+        nullable=False,
+    )
+    status = Column(String(50), nullable=False)
+    is_completed = Column(Boolean, nullable=True)
+    is_deleted = Column(Boolean, nullable=True)
+    updated_at = Column(
+        DateTime,
+        default=datetime.utcnow,
+        onupdate=datetime.utcnow,
+    )
+
+    workflow_blocks = relationship(
+        "WorkbookWorkflowBlockModel",
+        primaryjoin="WorkbookWorkflowModel.id==WorkbookWorkflowBlockModel.workflow_id",
+        order_by=WorkbookWorkflowBlockModel.sequence_number,
+        back_populates="workbook_workflow",
+    )

cs_models/resources/WorkbookWorkflow/schemas.py

@@ -0,0 +1,24 @@
+from marshmallow import (
+    Schema,
+    fields,
+    validate,
+)
+from ..WorkbookWorkflowBlock.schemas import (
+    WorkbookWorkflowBlockResourceSchema,
+)
+
+
+class WorkbookWorkflowResourceSchema(Schema):
+    not_blank = validate.Length(min=1, error="Field cannot be blank")
+
+    id = fields.Integer(dump_only=True)
+    workbook_id = fields.Integer(required=True)
+    status = fields.String(required=True)
+    is_completed = fields.Boolean(allow_none=True)
+    is_deleted = fields.Boolean(allow_none=True)
+    workflow_blocks = fields.Nested(
+        WorkbookWorkflowBlockResourceSchema(exclude=("workflow_id",)),
+        many=True,
+        dump_only=True,
+    )
+    updated_at = fields.DateTime(dump_only=True)

cs_models/resources/WorkbookWorkflowBlock/models.py

@@ -0,0 +1,37 @@
+from datetime import datetime
+from sqlalchemy import Column, DateTime, Boolean, ForeignKey, Integer, Text, String
+from sqlalchemy.orm import relationship
+from ...database import Base
+
+
+class WorkbookWorkflowBlockModel(Base):
+    __tablename__ = "workbook_workflow_blocks"
+
+    id = Column(Integer, primary_key=True)
+    workflow_id = Column(
+        Integer,
+        ForeignKey("workbook_workflows.id"),
+        nullable=False,
+    )
+    sequence_number = Column(Integer, nullable=False)
+    block_type = Column(String(50), nullable=False)
+    data = Column(Text, nullable=True)
+    status = Column(String(50), nullable=False)
+    rendered = Column(Boolean, nullable=True)
+    is_completed = Column(Boolean, nullable=True)
+    is_deleted = Column(Boolean, nullable=True)
+    created_at = Column(DateTime, nullable=False, default=lambda: datetime.utcnow())
+    updated_at = Column(
+        DateTime,
+        nullable=False,
+        # https://stackoverflow.com/questions/58776476/why-doesnt-freezegun-work-with-sqlalchemy-default-values
+        default=lambda: datetime.utcnow(),
+        onupdate=lambda: datetime.utcnow(),
+    )
+
+    # These are ORM fields. Don't need to be added in the corresponding migration.
+    # https://docs.sqlalchemy.org/en/14/orm/tutorial.html#building-a-relationship
+    workbook_workflow = relationship(
+        "WorkbookWorkflowModel",
+        back_populates="workflow_blocks",
+    )

cs_models/resources/WorkbookWorkflowBlock/schemas.py

@@ -0,0 +1,60 @@
+"""Marshmallow Schema for AssistantCommand."""
+import json
+from marshmallow import Schema, fields
+from ..WorkbookBlockComment.schemas import (
+    WorkbookBlockCommentResourceSchema,
+)
+
+
+class WorkbookWorkflowBlockDataField(fields.Field):
+    """Field that stores result for the Assistant command."""
+
+    def _serialize(self, value, attr, obj, **kwargs):
+        """
+        In the DB, the `result` field is a text field. We persist
+        data by performing the following:
+
+        AssistantCommandModel(
+            ...
+            result=json.dumps({...}),
+        )
+
+        So here we need to perform the inverse operation (i.e `json.loads(..)`)
+        """
+        if value is None:
+            return None
+        return json.loads(value)
+
+    def _deserialize(self, value, attr, data, **kwargs):
+        """
+        In the DB, the `result` field is a text field. We persist
+        data by performing the following:
+
+
+
+        AssistantCommandModel(
+            ***AssistantCommandResourceSchema().load({
+                ...
+                "result": [{"some_key": 1}, {"some_key": 2}],
+            }),
+        )
+        """
+        if value is None:
+            return None
+        return json.dumps(value)
+
+
+class WorkbookWorkflowBlockResourceSchema(Schema):
+    """Class for AssistantCommandResource schema"""
+
+    id = fields.Integer(dump_only=True)
+    workflow_id = fields.Integer(required=True)
+    sequence_number = fields.Integer(required=True)
+    block_type = fields.String(required=True)
+    data = WorkbookWorkflowBlockDataField(required=True, allow_none=True)
+    status = fields.String(required=True)
+    rendered = fields.Boolean(allow_none=True)
+    is_completed = fields.Boolean(allow_none=True)
+    is_deleted = fields.Boolean(allow_none=True)
+    created_at = fields.DateTime(dump_only=True)
+    updated_at = fields.DateTime(dump_only=True)

cs_models/utils/utils.py

@@ -1,7 +1,7 @@
 import json
 import pytz
 from datetime import datetime
-from marshmallow import ValidationError
+from marshmallow import ValidationError, fields
 from sqlalchemy.sql.expression import ClauseElement
 
 
@@ -144,6 +144,32 @@ def pre_load_date_fields(in_data, date_fields, date_format='%m-%d-%Y'):
     return in_data
 
 
+class Safe13FDate(fields.Date):
+    def __init__(self, format="%d-%b-%Y", **kwargs):
+        super().__init__(format=format, **kwargs)
+
+    def _deserialize(self, value, attr, data, **kwargs):
+        if value in (None, ""):
+            return None
+        try:
+            return datetime.strptime(value, self.format).date()
+        except (ValueError, TypeError):
+            raise ValidationError("Not a valid date.")
+
+
+class Safe13FInteger(fields.Integer):
+    def __init__(self, **kwargs):
+        super().__init__(format=format, **kwargs)
+
+    def _deserialize(self, value, attr, data, **kwargs):
+        if value in (None, ""):
+            return None
+        try:
+            return int(value)
+        except (ValueError, TypeError):
+            raise ValidationError("Not a valid integer.")
+
+
 if __name__ == '__main__':
     from doctest import testmod
     testmod()

cs_models-0.0.847.dist-info/METADATA

@@ -0,0 +1,29 @@
+Metadata-Version: 2.1
+Name: cs-models
+Version: 0.0.847
+Summary: MySQL db models
+Home-page: https://github.com/mindgram/cs-models
+Author: Shrey Verma
+Author-email: sverma@mindgram.ai
+License: UNKNOWN
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: marshmallow==3.19.0
+Requires-Dist: PyMySQL==1.1.1
+Requires-Dist: python-dateutil==2.8.2
+Requires-Dist: pytz==2022.1
+Requires-Dist: SQLAlchemy==1.4.35
+Requires-Dist: boto3>=1.28.30
+Requires-Dist: botocore>=1.31.30
+Requires-Dist: s3transfer>=0.6.2
+Requires-Dist: six==1.16.0
+Requires-Dist: urllib3>=1.26.19
+Requires-Dist: dnspython==2.6.1
+Requires-Dist: pymongo==4.6.3
+Requires-Dist: psycopg2-binary<=2.9.9,>=2.9.3
+Requires-Dist: sshtunnel==0.4.0
+
+UNKNOWN
+
+