from __future__ import annotations
from datetime import date
from onegov.core.orm import Base
from onegov.core.orm.mixins import content_property
from onegov.core.orm.mixins import ContentMixin
from onegov.core.orm.mixins import TimestampMixin
from onegov.core.orm.types import UUID
from onegov.pas import _
from sqlalchemy import Column
from sqlalchemy import Enum
from sqlalchemy import String
from sqlalchemy.orm import object_session
from uuid import uuid4
from typing import TYPE_CHECKING
if TYPE_CHECKING:
import uuid
from onegov.core.orm.mixins import dict_property
from onegov.pas.models import Attendence
from onegov.pas.models import Commission
from onegov.pas.models import Parliamentarian
from onegov.town6.request import TownRequest
from typing import Literal
from typing import TypeAlias
[docs]
Action: TypeAlias = Literal[
'add',
'edit',
'delete'
]
[docs]
ACTIONS: list[Action] = [
'add',
'edit',
'delete',
]
[docs]
class Change(Base, ContentMixin, TimestampMixin):
[docs]
__tablename__ = 'pas_changes'
#: Internal ID
[docs]
id: Column[uuid.UUID] = Column(
UUID, # type:ignore[arg-type]
primary_key=True,
default=uuid4
)
#: The user id responsible for the change
[docs]
user_id: Column[str | None] = Column(
String,
nullable=True
)
#: The user name responsible for the change
[docs]
user_name: Column[str | None] = Column(
String,
nullable=True
)
@property
[docs]
def user(self) -> str | None:
if (
self.user_name
and self.user_id
and self.user_name != self.user_id
):
return f'{self.user_name} ({self.user_id})'
return self.user_name or self.user_id
#: The type of change
[docs]
action: Column[Action] = Column(
Enum(
*ACTIONS, # type:ignore[arg-type]
name='pas_actions'
),
nullable=False
)
@property
[docs]
def action_label(self) -> str:
if self.action == 'add' and self.model == 'attendence':
return _('Attendence added')
if self.action == 'edit' and self.model == 'attendence':
return _('Attendence modified')
if self.action == 'delete' and self.model == 'attendence':
return _('Attendence removed')
raise NotImplementedError()
#: The model behind this change
[docs]
model: Column[str] = Column(
String,
nullable=False
)
@property
[docs]
def attendence(self) -> Attendence | None:
from onegov.pas.models import Attendence
attendence_id = (self.changes or {}).get('id')
if self.model == 'attendence' and attendence_id:
session = object_session(self)
query = session.query(Attendence).filter_by(id=attendence_id)
return query.first()
return None
#: The changes
[docs]
changes: dict_property[dict[str, str | int | None] | None]
changes = content_property()
@property
[docs]
def date(self) -> date | None:
date_string = (self.changes or {}).get('date')
if date_string:
assert isinstance(date_string, str)
return date.fromisoformat(date_string)
return None
@property
[docs]
def parliamentarian(self) -> Parliamentarian | None:
from onegov.pas.models import Parliamentarian
parliamentarian_id = (self.changes or {}).get('parliamentarian_id')
if self.model == 'attendence' and parliamentarian_id:
session = object_session(self)
query = session.query(Parliamentarian).filter_by(
id=parliamentarian_id
)
return query.first()
return None
@property
[docs]
def commission(self) -> Commission | None:
from onegov.pas.models import Commission
commission_id = (self.changes or {}).get('commission_id')
if self.model == 'attendence' and commission_id:
session = object_session(self)
query = session.query(Commission).filter_by(id=commission_id)
return query.first()
return None
@classmethod
[docs]
def add(
cls,
request: TownRequest,
action: Action,
attendence: Attendence
) -> Change:
""" Create a new change and add it to the session. """
change = cls()
change.user_id = request.current_username
change.user_name = (
request.current_user.title if request.current_user else None
)
change.action = action
change.model = 'attendence'
change.changes = {
'id': str(attendence.id),
'date': attendence.date.isoformat(),
'duration': attendence.duration,
'type': attendence.type,
'parliamentarian': (
attendence.parliamentarian.title
if attendence.parliamentarian else ''
),
'parliamentarian_id': str(attendence.parliamentarian_id),
'commission_id': str(attendence.commission_id or ''),
'commission': (
attendence.commission.title
if attendence.commission else ''
),
}
request.session.add(change)
return change