From e113ef09e472b8a7af6d9c69d2e73c3fcfea49fb Mon Sep 17 00:00:00 2001 From: Sergey Vartanov Date: Fri, 7 May 2021 01:34:53 +0300 Subject: [PATCH] Add documentation. --- roentgen/text.py | 1 - test/test_text.py | 23 +++++++++++++++++++---- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/roentgen/text.py b/roentgen/text.py index 3023d17..99cc625 100644 --- a/roentgen/text.py +++ b/roentgen/text.py @@ -95,4 +95,3 @@ def get_text(tags: Dict[str, Any]) -> List[str]: format_frequency, tags["frequency"].split(";")))) return texts - diff --git a/test/test_text.py b/test/test_text.py index b811f7f..fe53f1b 100644 --- a/test/test_text.py +++ b/test/test_text.py @@ -1,28 +1,43 @@ """ Author: Sergey Vartanov (me@enzet.ru). """ +from typing import List + from roentgen.scheme import Scheme +from roentgen.text import Label -def get_text(tags): +def construct_labels(tags) -> List[Label]: + """ + Construct labels from OSM node tags. + """ scheme = Scheme("scheme/default.yml") return scheme.construct_text(tags, True) def test_1_label() -> None: - labels = get_text({"name": "Name"}) + """ + Test tags that should be converted into single label. + """ + labels = construct_labels({"name": "Name"}) assert len(labels) == 1 assert labels[0].text == "Name" def test_1_label_unknown_tags() -> None: - labels = get_text({"name": "Name", "aaa": "bbb"}) + """ + Test tags with some unknown tags that should be converted into single label. + """ + labels = construct_labels({"name": "Name", "aaa": "bbb"}) assert len(labels) == 1 assert labels[0].text == "Name" def test_2_labels() -> None: - labels = get_text({"name": "Name", "ref": "5"}) + """ + Test tags that should be converted into two labels. + """ + labels = construct_labels({"name": "Name", "ref": "5"}) assert len(labels) == 2 assert labels[0].text == "Name" assert labels[1].text == "5"