documente_shared 0.1.37__py3-none-any.whl → 0.1.39__py3-none-any.whl

documente_shared/application/digest.py

@@ -1,7 +1,7 @@
-import hashlib
-
-
-def get_file_digest(file_bytes: bytes) -> str:
-     sha256_hash = hashlib.sha256()
-     sha256_hash.update(file_bytes)
-     return sha256_hash.hexdigest()
+import hashlib
+
+
+def get_file_digest(file_bytes: bytes) -> str:
+     sha256_hash = hashlib.sha256()
+     sha256_hash.update(file_bytes)
+     return sha256_hash.hexdigest()

documente_shared/application/exceptions.py

@@ -0,0 +1,23 @@
+import sentry_sdk
+from functools import wraps
+from typing import Callable, Any, TypeVar
+
+F = TypeVar("F", bound=Callable[..., Any])
+
+def initialize_sentry(dsn: str, environment: str = "dev") -> None:
+    if not sentry_sdk.Hub.current.client: 
+        sentry_sdk.init(
+            dsn=dsn,
+            environment=environment,
+        )
+
+def track_exceptions(func: F) -> F:
+    @wraps(func)
+    def wrapper(*args: Any, **kwargs: Any) -> Any:
+        try:
+            return func(*args, **kwargs)
+        except Exception as e:
+            sentry_sdk.capture_exception(e)
+            sentry_sdk.flush()
+            raise
+    return wrapper  # type: ignore

documente_shared/application/time_utils.py

@@ -1,10 +1,10 @@
-from datetime import datetime
-from typing import Union
-
-
-def get_datetime_from_data(input_datetime: Union[datetime, str]):
-    if isinstance(input_datetime, datetime):
-        return input_datetime
-    elif isinstance(input_datetime, str):
-        return datetime.fromisoformat(input_datetime)
+from datetime import datetime
+from typing import Union
+
+
+def get_datetime_from_data(input_datetime: Union[datetime, str]):
+    if isinstance(input_datetime, datetime):
+        return input_datetime
+    elif isinstance(input_datetime, str):
+        return datetime.fromisoformat(input_datetime)
     return None

documente_shared/domain/base_enum.py

@@ -1,54 +1,54 @@
-from enum import Enum
-from typing import Union, Optional
-
-
-class BaseEnum(Enum):
-    """Provides the common functionalties to multiple model choices."""
-
-    @classmethod
-    def get_members(cls):
-        return [tag for tag in cls if type(tag.value) in [int, str, float]]
-
-    @classmethod
-    def choices(cls):
-        """Generate choice options for models."""
-        return [
-            (option.value, option.value)
-            for option in cls
-            if type(option.value) in [int, str, float]
-        ]
-
-    @classmethod
-    def values(cls):
-        """Returns values from choices."""
-        return [option.value for option in cls]
-
-    def __str__(self):  # noqa: D105
-        return str(self.value)
-
-    def __repr__(self):
-        return self.__str__()
-
-    def __hash__(self):
-        return hash(self.value)
-
-    @classmethod
-    def as_list(cls):
-        """Returns properties as a list."""
-        return [
-            value
-            for key, value in cls.__dict__.items()
-            if isinstance(value, str) and not key.startswith('__')
-        ]
-
-    @classmethod
-    def from_value(
-        cls,
-        value: Union[str, int],
-    ) -> Optional['BaseEnum']:
-        for tag in cls:
-            if isinstance(tag.value, str) and str(tag.value).upper() == str(value).upper():
-                return tag
-            elif not isinstance(tag.value, str) and tag.value == value:
-                return tag
+from enum import Enum
+from typing import Union, Optional
+
+
+class BaseEnum(Enum):
+    """Provides the common functionalties to multiple model choices."""
+
+    @classmethod
+    def get_members(cls):
+        return [tag for tag in cls if type(tag.value) in [int, str, float]]
+
+    @classmethod
+    def choices(cls):
+        """Generate choice options for models."""
+        return [
+            (option.value, option.value)
+            for option in cls
+            if type(option.value) in [int, str, float]
+        ]
+
+    @classmethod
+    def values(cls):
+        """Returns values from choices."""
+        return [option.value for option in cls]
+
+    def __str__(self):  # noqa: D105
+        return str(self.value)
+
+    def __repr__(self):
+        return self.__str__()
+
+    def __hash__(self):
+        return hash(self.value)
+
+    @classmethod
+    def as_list(cls):
+        """Returns properties as a list."""
+        return [
+            value
+            for key, value in cls.__dict__.items()
+            if isinstance(value, str) and not key.startswith('__')
+        ]
+
+    @classmethod
+    def from_value(
+        cls,
+        value: Union[str, int],
+    ) -> Optional['BaseEnum']:
+        for tag in cls:
+            if isinstance(tag.value, str) and str(tag.value).upper() == str(value).upper():
+                return tag
+            elif not isinstance(tag.value, str) and tag.value == value:
+                return tag
         return None

documente_shared/domain/entities/document_process.py

@@ -1,203 +1,226 @@
-from dataclasses import dataclass
-from datetime import datetime
-from decimal import Decimal
-from typing import Optional, List
-
-from documente_shared.application.time_utils import get_datetime_from_data
-from documente_shared.domain.entities.document_process_metadata import DocumentProcessMetadata
-from documente_shared.domain.enums import (
-    DocumentProcessStatus,
-    DocumentProcessSubCategory,
-    DocumentProcessCategory,
-)
-
-def remove_slash_from_path(path: str) -> str:
-    if path and path.startswith('/'):
-        return path[1:]
-    return path
-
-@dataclass
-class DocumentProcess(object):
-    digest: str
-    status: DocumentProcessStatus
-    file_path: Optional[str] = None
-    file_bytes: Optional[bytes] = None
-    category: Optional[DocumentProcessCategory] = None
-    sub_category: Optional[DocumentProcessSubCategory] = None
-    processed_csv_path: Optional[str] = None
-    processed_csv_bytes: Optional[bytes] = None
-    processed_xlsx_path: Optional[str] = None
-    processed_xlsx_bytes: Optional[bytes] = None
-    processed_metadata_path: Optional[str] = None
-    processing_time: Optional[Decimal] = None
-    uploaded_at: Optional[datetime] = None
-    enqueued_at: Optional[datetime] = None
-    started_at: Optional[datetime] = None
-    failed_at: Optional[datetime] = None
-    failed_reason: Optional[str] = None
-    completed_at: Optional[datetime] = None
-    metadata_items: Optional[List[DocumentProcessMetadata]] = None
-
-    def __post_init__(self):
-        self.metadata_items = self.metadata_items or []
-
-    @property
-    def is_pending(self) -> bool:
-        return self.status == DocumentProcessStatus.PENDING
-
-    @property
-    def is_enqueued(self) -> bool:
-        return self.status == DocumentProcessStatus.ENQUEUED
-
-    @property
-    def is_processing(self) -> bool:
-        return self.status == DocumentProcessStatus.PROCESSING
-
-    @property
-    def is_completed(self) -> bool:
-        return self.status == DocumentProcessStatus.COMPLETED
-
-    @property
-    def is_failed(self) -> bool:
-        return self.status == DocumentProcessStatus.FAILED
-
-    @property
-    def is_valid(self) -> bool:
-        return all([
-            self.digest,
-            self.status,
-            self.file_path,
-        ])
-
-    def enqueue(self):
-        self.status = DocumentProcessStatus.ENQUEUED
-        self.enqueued_at = datetime.now()
-
-    def processing(self):
-        self.status = DocumentProcessStatus.PROCESSING
-        self.started_at = datetime.now()
-
-    def failed(self, error_message: Optional[str] = None):
-        self.failed_reason = error_message
-        self.status = DocumentProcessStatus.FAILED
-        self.failed_at = datetime.now()
-
-    def completed(self):
-        self.status = DocumentProcessStatus.COMPLETED
-        self.completed_at = datetime.now()
-
-    def deleted(self):
-        self.status = DocumentProcessStatus.DELETED
-
-    @property
-    def file_key(self) -> str:
-        return remove_slash_from_path(self.file_path)
-
-    @property
-    def processed_csv_key(self) -> str:
-        return remove_slash_from_path(self.processed_csv_path)
-
-    @property
-    def processed_xlsx_key(self) -> str:
-        return remove_slash_from_path(self.processed_xlsx_path)
-
-    @property
-    def processed_metadata_key(self) -> str:
-        return remove_slash_from_path(self.processed_metadata_path)
-
-    @property
-    def extended_filename(self) -> str:
-        return self.file_path.split('/')[-1]
-
-    @property
-    def filename(self) -> str:
-        filename_with_extension = self.extended_filename
-        return filename_with_extension.split('.')[0]
-
-    @property
-    def to_dict(self) -> dict:
-        return {
-            'digest': self.digest,
-            'status': str(self.status),
-            'file_path': self.file_path,
-            'category': (
-                str(self.category)
-                if self.category else None
-            ),
-            'sub_category': (
-                str(self.sub_category)
-                if self.sub_category else None
-            ),
-            'processed_csv_path': self.processed_csv_path,
-            'processed_xlsx_path': self.processed_xlsx_path,
-            'processed_metadata_path': self.processed_metadata_path,
-            'processing_time': (
-                str(self.processing_time.quantize(Decimal('0.00001')))
-                if self.processing_time else None
-            ),
-            'uploaded_at': self.uploaded_at.isoformat() if self.uploaded_at else None,
-            'enqueued_at': self.enqueued_at.isoformat() if self.enqueued_at else None,
-            'started_at': self.started_at.isoformat() if self.started_at else None,
-            'failed_at': self.failed_at.isoformat() if self.failed_at else None,
-            'failed_reason': self.failed_reason,
-            'completed_at': self.completed_at.isoformat() if self.completed_at else None,
-            'metadata_items': [metadata.to_dict for metadata in self.metadata_items],
-        }
-
-    @property
-    def to_simple_dict(self) -> dict:
-        simple_dict = self.to_dict.copy()
-        simple_dict.pop('metadata_items')
-        return simple_dict
-
-    def overload(
-        self,
-        new_instance: 'DocumentProcess',
-        properties: List[str] = None,
-    ):
-        instance_properties = properties or [
-            'status', 'metadata', 'file_path', 'file_bytes', 'category', 'sub_category',
-            'processed_csv_path', 'processed_csv_bytes', 'processed_xlsx_path', 'processed_metadata_path',
-            'processed_xlsx_bytes', 'processing_time', 'uploaded_at',
-            'enqueued_at', 'started_at', 'failed_at', 'failed_reason', 'completed_at',
-        ]
-        for _property in instance_properties:
-            property_value = getattr(new_instance, _property)
-            if not hasattr(self, _property):
-                continue
-            setattr(self, _property, property_value)
-        return self
-
-    @classmethod
-    def from_dict(cls, data: dict) -> 'DocumentProcess':
-        return cls(
-            digest=data.get('digest'),
-            status=DocumentProcessStatus.from_value(data.get('status')),
-            file_path=data.get('file_path'),
-            category=(
-                DocumentProcessCategory.from_value(data.get('category'))
-                if data.get('category') else None
-            ),
-            sub_category=(
-                DocumentProcessSubCategory.from_value(data.get('sub_category'))
-                if data.get('sub_category') else None
-            ),
-            processed_csv_path=data.get('processed_csv_path'),
-            processed_xlsx_path=data.get('processed_xlsx_path'),
-            processed_metadata_path=data.get('processed_metadata_path'),
-            processing_time=(
-                Decimal(data.get('processing_time'))
-                if data.get('processing_time') else None
-            ),
-            uploaded_at=get_datetime_from_data(input_datetime=data.get('uploaded_at')),
-            enqueued_at=get_datetime_from_data(input_datetime=data.get('enqueued_at')),
-            started_at=get_datetime_from_data(input_datetime=data.get('started_at')),
-            failed_at=get_datetime_from_data(input_datetime=data.get('failed_at')),
-            failed_reason=data.get('failed_reason'),
-            completed_at=get_datetime_from_data(input_datetime=data.get('completed_at')),
-            metadata_items=[
-                DocumentProcessMetadata.from_dict(metadata)
-                for metadata in data.get('metadata_items', [])
-            ],
-        )
-
+from dataclasses import dataclass
+from datetime import datetime
+from decimal import Decimal
+from typing import Optional, List
+
+from documente_shared.application.time_utils import get_datetime_from_data
+from documente_shared.domain.entities.document_process_metadata import DocumentProcessMetadata
+from documente_shared.domain.enums import (
+    DocumentProcessStatus,
+    DocumentProcessSubCategory,
+    DocumentProcessCategory,
+)
+
+def remove_slash_from_path(path: str) -> str:
+    if path and path.startswith('/'):
+        return path[1:]
+    return path
+
+@dataclass
+class DocumentProcess(object):
+    digest: str
+    status: DocumentProcessStatus
+    file_path: Optional[str] = None
+    file_bytes: Optional[bytes] = None
+    category: Optional[DocumentProcessCategory] = None
+    sub_category: Optional[DocumentProcessSubCategory] = None
+    processed_csv_path: Optional[str] = None
+    processed_csv_bytes: Optional[bytes] = None
+    processed_xlsx_path: Optional[str] = None
+    processed_xlsx_bytes: Optional[bytes] = None
+    processed_metadata_path: Optional[str] = None
+    processing_time: Optional[Decimal] = None
+    uploaded_at: Optional[datetime] = None
+    enqueued_at: Optional[datetime] = None
+    started_at: Optional[datetime] = None
+    failed_at: Optional[datetime] = None
+    failed_reason: Optional[str] = None
+    completed_at: Optional[datetime] = None
+    metadata_items: Optional[List[DocumentProcessMetadata]] = None
+
+    def __post_init__(self):
+        self.metadata_items = self.metadata_items or []
+
+    @property
+    def is_pending(self) -> bool:
+        return self.status == DocumentProcessStatus.PENDING
+
+    @property
+    def is_enqueued(self) -> bool:
+        return self.status == DocumentProcessStatus.ENQUEUED
+
+    @property
+    def is_processing(self) -> bool:
+        return self.status == DocumentProcessStatus.PROCESSING
+
+    @property
+    def is_completed(self) -> bool:
+        return self.status == DocumentProcessStatus.COMPLETED
+
+    @property
+    def is_failed(self) -> bool:
+        return self.status == DocumentProcessStatus.FAILED
+
+    @property
+    def is_valid(self) -> bool:
+        return all([
+            self.digest,
+            self.status,
+            self.file_path,
+        ])
+
+    @property
+    def is_finished(self) -> bool:
+        return self.status in [
+            DocumentProcessStatus.COMPLETED,
+            DocumentProcessStatus.FAILED,
+        ]
+
+    def enqueue(self):
+        self.status = DocumentProcessStatus.ENQUEUED
+        self.enqueued_at = datetime.now()
+
+    def processing(self):
+        self.status = DocumentProcessStatus.PROCESSING
+        self.started_at = datetime.now()
+
+    def failed(self, error_message: Optional[str] = None):
+        self.failed_reason = error_message
+        self.status = DocumentProcessStatus.FAILED
+        self.failed_at = datetime.now()
+
+    def completed(self):
+        self.status = DocumentProcessStatus.COMPLETED
+        self.completed_at = datetime.now()
+
+    def deleted(self):
+        self.status = DocumentProcessStatus.DELETED
+
+    @property
+    def file_key(self) -> str:
+        return remove_slash_from_path(self.file_path)
+
+    @property
+    def processed_csv_key(self) -> str:
+        return remove_slash_from_path(self.processed_csv_path)
+
+    @property
+    def processed_xlsx_key(self) -> str:
+        return remove_slash_from_path(self.processed_xlsx_path)
+
+    @property
+    def processed_metadata_key(self) -> str:
+        return remove_slash_from_path(self.processed_metadata_path)
+
+    @property
+    def extended_filename(self) -> str:
+        return self.file_path.split('/')[-1]
+
+    @property
+    def filename(self) -> str:
+        filename_with_extension = self.extended_filename
+        return filename_with_extension.split('.')[0]
+
+    def __eq__(self, other: 'DocumentProcess') -> bool:
+        if not other:
+            return False
+
+        return (
+            self.digest == other.digest
+            and self.status == other.status
+            and self.file_path == other.file_path
+            and self.uploaded_at == other.uploaded_at
+            and self.enqueued_at == other.enqueued_at
+            and self.started_at == other.started_at
+            and self.failed_at == other.failed_at
+            and self.completed_at == other.completed_at
+        )
+
+
+    @property
+    def to_dict(self) -> dict:
+        return {
+            'digest': self.digest,
+            'status': str(self.status),
+            'file_path': self.file_path,
+            'category': (
+                str(self.category)
+                if self.category else None
+            ),
+            'sub_category': (
+                str(self.sub_category)
+                if self.sub_category else None
+            ),
+            'processed_csv_path': self.processed_csv_path,
+            'processed_xlsx_path': self.processed_xlsx_path,
+            'processed_metadata_path': self.processed_metadata_path,
+            'processing_time': (
+                str(self.processing_time.quantize(Decimal('0.00001')))
+                if self.processing_time else None
+            ),
+            'uploaded_at': self.uploaded_at.isoformat() if self.uploaded_at else None,
+            'enqueued_at': self.enqueued_at.isoformat() if self.enqueued_at else None,
+            'started_at': self.started_at.isoformat() if self.started_at else None,
+            'failed_at': self.failed_at.isoformat() if self.failed_at else None,
+            'failed_reason': self.failed_reason,
+            'completed_at': self.completed_at.isoformat() if self.completed_at else None,
+            'metadata_items': [metadata.to_dict for metadata in self.metadata_items],
+        }
+
+    @property
+    def to_simple_dict(self) -> dict:
+        simple_dict = self.to_dict.copy()
+        simple_dict.pop('metadata_items')
+        return simple_dict
+
+    def overload(
+        self,
+        new_instance: 'DocumentProcess',
+        properties: List[str] = None,
+    ):
+        instance_properties = properties or [
+            'status', 'metadata', 'file_path', 'file_bytes', 'category', 'sub_category',
+            'processed_csv_path', 'processed_csv_bytes', 'processed_xlsx_path', 'processed_metadata_path',
+            'processed_xlsx_bytes', 'processing_time', 'uploaded_at',
+            'enqueued_at', 'started_at', 'failed_at', 'failed_reason', 'completed_at',
+        ]
+        for _property in instance_properties:
+            property_value = getattr(new_instance, _property)
+            if not hasattr(self, _property):
+                continue
+            setattr(self, _property, property_value)
+        return self
+
+    @classmethod
+    def from_dict(cls, data: dict) -> 'DocumentProcess':
+        return cls(
+            digest=data.get('digest'),
+            status=DocumentProcessStatus.from_value(data.get('status')),
+            file_path=data.get('file_path'),
+            category=(
+                DocumentProcessCategory.from_value(data.get('category'))
+                if data.get('category') else None
+            ),
+            sub_category=(
+                DocumentProcessSubCategory.from_value(data.get('sub_category'))
+                if data.get('sub_category') else None
+            ),
+            processed_csv_path=data.get('processed_csv_path'),
+            processed_xlsx_path=data.get('processed_xlsx_path'),
+            processed_metadata_path=data.get('processed_metadata_path'),
+            processing_time=(
+                Decimal(data.get('processing_time'))
+                if data.get('processing_time') else None
+            ),
+            uploaded_at=get_datetime_from_data(input_datetime=data.get('uploaded_at')),
+            enqueued_at=get_datetime_from_data(input_datetime=data.get('enqueued_at')),
+            started_at=get_datetime_from_data(input_datetime=data.get('started_at')),
+            failed_at=get_datetime_from_data(input_datetime=data.get('failed_at')),
+            failed_reason=data.get('failed_reason'),
+            completed_at=get_datetime_from_data(input_datetime=data.get('completed_at')),
+            metadata_items=[
+                DocumentProcessMetadata.from_dict(metadata)
+                for metadata in data.get('metadata_items', [])
+            ],
+        )
+