Skip to content

Commit

Permalink
Development (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
PHKenny authored Jul 9, 2024
2 parents 515ad51 + c3c3c71 commit a172cb7
Show file tree
Hide file tree
Showing 56 changed files with 843 additions and 889 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:
lint:
runs-on: ubuntu-latest
container:
image: ghcr.io/goldenm-software/python-builder:3.11
image: ghcr.io/goldenm-software/python-builder:3.10
options: --user root
credentials:
username: ${{ github.repository_owner }}
Expand All @@ -35,7 +35,7 @@ jobs:
needs: lint
runs-on: ubuntu-latest
container:
image: ghcr.io/goldenm-software/python-builder:3.11
image: ghcr.io/goldenm-software/python-builder:3.10
options: --user root
credentials:
username: ${{ github.repository_owner }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:

runs-on: ubuntu-latest
container:
image: ghcr.io/goldenm-software/python-builder:3.11
image: ghcr.io/goldenm-software/python-builder:3.10
options: --user root
credentials:
username: ${{ github.repository_owner }}
Expand Down
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Changelog

## 3.0.11

- Added way to standarize the `int` and `float` arguments to `float`. Allowing comparison between `int` and `float` values in LCL formulas

## 3.0.10

- Removed Self type annotation from all classes

## 3.0.9

- Added different return data of Report when password is set
Expand Down
19 changes: 10 additions & 9 deletions layrz_sdk/entities/broadcasts/request.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
""" Broadcast Result Request data """
from typing import Dict, List, Self
"""Broadcast Result Request data"""

from typing import Dict, List


class BroadcastRequest:
Expand All @@ -11,19 +12,19 @@ class BroadcastRequest:
- raw : Raw data
"""

def __init__(self: Self, json: Dict | List, raw: str) -> None:
def __init__(self, json: Dict | List, raw: str) -> None:
self.json = json
self.raw = raw

@property
def _readable(self: Self) -> str | None | bool:
""" Readable """
def _readable(self) -> str | None | bool:
"""Readable"""
return f'BroadcastRequest(json={self.json}, raw={self.raw})'

def __repr__(self: Self) -> str | None | bool:
""" Readable property """
def __repr__(self) -> str | None | bool:
"""Readable property"""
return self._readable

def __str__(self: Self) -> str | None | bool:
""" Readable property """
def __str__(self) -> str | None | bool:
"""Readable property"""
return self._readable
19 changes: 10 additions & 9 deletions layrz_sdk/entities/broadcasts/response.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
""" Broadcast Result Response data """
from typing import Dict, List, Self
"""Broadcast Result Response data"""

from typing import Dict, List


class BroadcastResponse:
Expand All @@ -11,19 +12,19 @@ class BroadcastResponse:
- raw (str): Raw data
"""

def __init__(self: Self, json: Dict | List, raw: str) -> str | None | bool:
def __init__(self, json: Dict | List, raw: str) -> str | None | bool:
self.json = json
self.raw = raw

@property
def _readable(self: Self) -> str | None | bool:
""" Readable """
def _readable(self) -> str | None | bool:
"""Readable"""
return f'BroadcastResponse(json={self.json}, raw={self.raw})'

def __repr__(self: Self) -> str | None | bool:
""" Readable property """
def __repr__(self) -> str | None | bool:
"""Readable property"""
return self._readable

def __str__(self: Self) -> str | None | bool:
""" Readable property """
def __str__(self) -> str | None | bool:
"""Readable property"""
return self._readable
24 changes: 13 additions & 11 deletions layrz_sdk/entities/broadcasts/result.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
""" Broadcast result """
"""Broadcast result"""

from datetime import datetime
from typing import Self

from .request import BroadcastRequest
from .response import BroadcastResponse
Expand All @@ -21,7 +21,7 @@ class BroadcastResult:
"""

def __init__(
self: Self,
self,
service_id: int,
asset_id: int,
status: BroadcastStatus,
Expand All @@ -37,15 +37,17 @@ def __init__(
self.submitted_at = submitted_at

@property
def _readable(self: Self) -> str | None | bool:
""" Readable """
return f'BroadcastResult(service_id={self.service_id}, asset_id={self.asset_id}, status={self.status}, ' +\
f'request={self.request}, response={self.response}, submitted_at={self.submitted_at})'
def _readable(self) -> str | None | bool:
"""Readable"""
return (
f'BroadcastResult(service_id={self.service_id}, asset_id={self.asset_id}, status={self.status}, '
+ f'request={self.request}, response={self.response}, submitted_at={self.submitted_at})'
)

def __repr__(self: Self) -> str | None | bool:
""" Readable property """
def __repr__(self) -> str | None | bool:
"""Readable property"""
return self._readable

def __str__(self: Self) -> str | None | bool:
""" Readable property """
def __str__(self) -> str | None | bool:
"""Readable property"""
return self._readable
17 changes: 8 additions & 9 deletions layrz_sdk/entities/broadcasts/service.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
""" Service entity """
from typing import Self
"""Service entity"""


class OutboundService:
Expand All @@ -11,19 +10,19 @@ class OutboundService:
- name : Service Name
"""

def __init__(self: Self, pk: int, name: str) -> str | None | bool:
def __init__(self, pk: int, name: str) -> str | None | bool:
self.pk = pk
self.name = name

@property
def _readable(self: Self) -> str | None | bool:
""" Readable """
def _readable(self) -> str | None | bool:
"""Readable"""
return f'OutboundService(pk={self.pk}, name={self.name})'

def __repr__(self: Self) -> str | None | bool:
""" Readable property """
def __repr__(self) -> str | None | bool:
"""Readable property"""
return self._readable

def __str__(self: Self) -> str | None | bool:
""" Readable property """
def __str__(self) -> str | None | bool:
"""Readable property"""
return self._readable
19 changes: 10 additions & 9 deletions layrz_sdk/entities/broadcasts/status.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
""" Broadcast result Status """
"""Broadcast result Status"""

from enum import Enum
from typing import Self


class BroadcastStatus(Enum):
""" Broadcast result status """
"""Broadcast result status"""

OK = 'OK'
BADREQUEST = 'BADREQUEST'
INTERNALERROR = 'INTERNALERROR'
Expand All @@ -13,14 +14,14 @@ class BroadcastStatus(Enum):
DISCONNECTED = 'DISCONNECTED'

@property
def _readable(self: Self) -> str | None | bool:
""" Readable """
def _readable(self) -> str | None | bool:
"""Readable"""
return f'BroadcastStatus.{self.value}'

def __str__(self: Self) -> str | None | bool:
""" Readable property """
def __str__(self) -> str | None | bool:
"""Readable property"""
return self._readable

def __repr__(self: Self) -> str | None | bool:
""" Readable property """
def __repr__(self) -> str | None | bool:
"""Readable property"""
return self._readable
63 changes: 33 additions & 30 deletions layrz_sdk/entities/cases/case.py
Original file line number Diff line number Diff line change
@@ -1,52 +1,53 @@
""" Events entitites """
"""Events entitites"""

from datetime import datetime
from enum import Enum
from typing import Self

from .trigger import Trigger


class CaseStatus(Enum):
""" Case status enum """
"""Case status enum"""

PENDING = 'PENDING'
FOLLOWED = 'FOLLOWED'
CLOSED = 'CLOSED'

@property
def _readable(self: Self) -> str | None | bool:
""" Readable """
def _readable(self) -> str | None | bool:
"""Readable"""
return f'BroadcastStatus.{self.value}'

def __str__(self: Self) -> str | None | bool:
""" Readable property """
def __str__(self) -> str | None | bool:
"""Readable property"""
return self._readable

def __repr__(self: Self) -> str | None | bool:
""" Readable property """
def __repr__(self) -> str | None | bool:
"""Readable property"""
return self._readable


class CaseIgnoredStatus(Enum):
"""
Case ignore status, will define what kind ignore happened.
"""

NORMAL = 'NORMAL'
IGNORED = 'IGNORED'
PRESSET = 'PRESSET'
AUTO = 'AUTO'

@property
def _readable(self: Self) -> str | None | bool:
""" Readable """
def _readable(self) -> str | None | bool:
"""Readable"""
return f'BroadcastStatus.{self.value}'

def __str__(self: Self) -> str | None | bool:
""" Readable property """
def __str__(self) -> str | None | bool:
"""Readable property"""
return self._readable

def __repr__(self: Self) -> str | None | bool:
""" Readable property """
def __repr__(self) -> str | None | bool:
"""Readable property"""
return self._readable


Expand All @@ -67,7 +68,7 @@ class Case:
"""

def __init__(
self: Self,
self,
pk: int,
trigger: Trigger,
asset_id: int,
Expand All @@ -78,7 +79,7 @@ def __init__(
status: CaseStatus = CaseStatus.CLOSED,
ignored_status: CaseIgnoredStatus = CaseIgnoredStatus.NORMAL,
) -> None:
""" Constructor """
"""Constructor"""
self.pk = pk
self.trigger = trigger
self.asset_id = asset_id
Expand All @@ -89,29 +90,31 @@ def __init__(
self._sequence = sequence
self.ignored_status = ignored_status

def get_sequence(self: Self) -> str | None | bool:
""" Sequence getter """
def get_sequence(self) -> str | None | bool:
"""Sequence getter"""
if self._sequence is not None:
return f'{self.trigger.code}/{self._sequence}'
else:
return f'GENERIC/{self.pk}'

def set_sequence(self: Self, sequence: int) -> None:
""" Sequence setter """
def set_sequence(self, sequence: int) -> None:
"""Sequence setter"""
self._sequence = sequence

sequence = property(get_sequence, set_sequence)

@property
def _readable(self: Self) -> str | None | bool:
""" Readable """
return f'Case(pk={self.pk}, trigger={self.trigger}, asset_id={self.asset_id}, ' +\
f'comments={len(self.comments)}, opened_at={self.opened_at}, closed_at={self.closed_at})'

def __str__(self: Self) -> str | None | bool:
""" Readable property """
def _readable(self) -> str | None | bool:
"""Readable"""
return (
f'Case(pk={self.pk}, trigger={self.trigger}, asset_id={self.asset_id}, '
+ f'comments={len(self.comments)}, opened_at={self.opened_at}, closed_at={self.closed_at})'
)

def __str__(self) -> str | None | bool:
"""Readable property"""
return self._readable

def __repr__(self: Self) -> str | None | bool:
""" Readable property """
def __repr__(self) -> str | None | bool:
"""Readable property"""
return self._readable
20 changes: 10 additions & 10 deletions layrz_sdk/entities/cases/comment.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
""" Comment entity """
"""Comment entity"""

from datetime import datetime
from typing import Self

from layrz_sdk.entities.general.user import User

Expand All @@ -16,22 +16,22 @@ class Comment:
- submitted_at : Date of comment submission
"""

def __init__(self: Self, pk: int, content: str, user: User, submitted_at: datetime) -> None:
""" Constructor """
def __init__(self, pk: int, content: str, user: User, submitted_at: datetime) -> None:
"""Constructor"""
self.pk = pk
self.content = content
self.user = user
self.submitted_at = submitted_at

@property
def _readable(self: Self) -> str | None | bool:
""" Readable """
def _readable(self) -> str | None | bool:
"""Readable"""
return f'Comment(pk={self.pk}, content="{self.content}", user={self.user}, submitted_at={self.submitted_at})'

def __str__(self: Self) -> str | None | bool:
""" Readable property """
def __str__(self) -> str | None | bool:
"""Readable property"""
return self._readable

def __repr__(self: Self) -> str | None | bool:
""" Readable property """
def __repr__(self) -> str | None | bool:
"""Readable property"""
return self._readable
Loading

0 comments on commit a172cb7

Please sign in to comment.