Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions src/bo4e/com/zeitintervall.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
"""
Contains Zeitintervall class
and corresponding marshmallow schema for de-/serialization
"""
import attr
from marshmallow import fields, post_load
from marshmallow_enum import EnumField # type:ignore[import]

from bo4e.com.com import COM, COMSchema
from bo4e.enum.zeiteinheit import Zeiteinheit


# pylint: disable=too-few-public-methods
@attr.s(auto_attribs=True, kw_only=True)
class Zeitintervall(COM):
"""
Abbildung für ein Zeitintervall. Die Abbildung eines Zeitintervalls.
Z.B. zur Anwendung als Raster in äquidistanten Zeitreihen/Lastgängen, beispielsweise 15 Minuten.
"""

# required attributes
wert: int = attr.ib(validator=attr.validators.instance_of(int))
zeiteinheit: Zeiteinheit = attr.ib(validator=attr.validators.instance_of(Zeiteinheit))


class ZeitintervallSchema(COMSchema):
"""
Schema for de-/serialization of Zeitintervall.
"""

# required attributes
wert = fields.Integer()
zeiteinheit = EnumField(Zeiteinheit)

# pylint: disable=no-self-use, unused-argument
@post_load
def deserialize(self, data, **kwargs) -> Zeitintervall:
"""Deserialize JSON to Zeitintervall object"""
return Zeitintervall(**data)
40 changes: 40 additions & 0 deletions tests/test_zeitintervall.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
from datetime import datetime, timezone
from decimal import Decimal

import pytest # type:ignore[import]

from bo4e.com.zeitintervall import Zeitintervall, ZeitintervallSchema
from bo4e.enum.zeiteinheit import Zeiteinheit


class TestZeitintervall:
def test_zeitintervall_daten(self):
"""
Test de-/serialisation of Zeitintervall (only has optional attributes) with option startdatum and enddatum.
"""
zeitintervall = Zeitintervall(wert=2, zeiteinheit=Zeiteinheit.VIERTEL_STUNDE)

schema = ZeitintervallSchema()
json_string = schema.dumps(zeitintervall, ensure_ascii=False)

assert "2" in json_string
assert "VIERTEL_STUNDE" in json_string

zeitintervall_deserialized = schema.loads(json_string)

assert isinstance(zeitintervall_deserialized.wert, int)
assert zeitintervall_deserialized.wert == 2
assert isinstance(zeitintervall_deserialized.zeiteinheit, Zeiteinheit)
assert zeitintervall_deserialized.zeiteinheit == Zeiteinheit.VIERTEL_STUNDE.value

def test_wrong_datatype(self):
with pytest.raises(TypeError) as excinfo:
_ = Zeitintervall(wert="3", zeiteinheit=Zeiteinheit.TAG)

assert "'wert' must be <class 'int'>" in str(excinfo.value)

def test_missing_required_attribute(self):
with pytest.raises(TypeError) as excinfo:
_ = Zeitintervall(wert=3)

assert "missing 1 required keyword" in str(excinfo.value)