Skip to content

Add docstrings to Preis COM #237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hf-kklein merged 6 commits into from
Dec 8, 2021
Merged

Add docstrings to Preis COM #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b52ccc5
add docstrings
Dec 8, 2021
f88691f
Update src/bo4e/com/preis.py
hf-kklein Dec 8, 2021
8e4bac4
Update src/bo4e/com/preis.py
hf-kklein Dec 8, 2021
cd6af6a
Update src/bo4e/com/preis.py
hf-kklein Dec 8, 2021
9117947
blacky
hf-kklein Dec 8, 2021
b51636f
Merge remote-tracking branch 'origin/feature/add_docstrings' into fea…
hf-kklein Dec 8, 2021
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
4 changes: 4 additions & 0 deletions src/bo4e/com/preis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,15 @@ class Preis(COM):
"""

# required attributes
#: Gibt die nomiale Höhe des Preises an.
wert: Decimal = attr.ib(validator=attr.validators.instance_of(Decimal))
#: Währungseinheit für den Preis, z.B. Euro oder Ct.
einheit: Waehrungseinheit = attr.ib(validator=attr.validators.in_(Waehrungseinheit))
#: Angabe, für welche Bezugsgröße der Preis gilt. Z.B. kWh.
bezugswert: Mengeneinheit = attr.ib(validator=attr.validators.in_(Mengeneinheit))

# optional attributes
#: Gibt den Status des veröffentlichten Preises an
status: Optional[Preisstatus] = attr.ib(default=None)


Expand Down
14 changes: 9 additions & 5 deletions tests/test_preis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,7 @@ def test_preis_only_required(self):
"""
Test de-/serialisation of Preis (only has required attributes).
"""
preis = Preis(
wert=Decimal(2.53), einheit=Waehrungseinheit.EUR, bezugswert=Mengeneinheit.KWH
)
preis = Preis(wert=Decimal(2.53), einheit=Waehrungseinheit.EUR, bezugswert=Mengeneinheit.KWH)

schema = PreisSchema()
json_string = schema.dumps(preis, ensure_ascii=False)
Expand All @@ -29,7 +27,8 @@ def test_preis_only_required(self):
assert isinstance(preis_deserialized.wert, Decimal)
assert isinstance(preis_deserialized.einheit, Waehrungseinheit)
assert isinstance(preis_deserialized.bezugswert, Mengeneinheit)
assert not preis_deserialized.status
assert preis_deserialized.status is None
assert preis == preis_deserialized

def test_wrong_datatype(self):
with pytest.raises(TypeError) as excinfo:
Expand All @@ -44,7 +43,12 @@ def test_missing_required_attribute(self):
assert "missing 1 required" in str(excinfo.value)

def test_optional_attribute(self):
preis = Preis(wert=Decimal(3.50), einheit=Waehrungseinheit.EUR, bezugswert=Mengeneinheit.KWH, status=Preisstatus.ENDGUELTIG)
preis = Preis(
wert=Decimal(3.50),
einheit=Waehrungseinheit.EUR,
bezugswert=Mengeneinheit.KWH,
status=Preisstatus.ENDGUELTIG,
)

schema = PreisSchema()
json_string = schema.dumps(preis, ensure_ascii=False)
Expand Down