From b83d6ef63b44e2c38415ae0d5004b6898db922d7 Mon Sep 17 00:00:00 2001
From: Kira <117554978+kiraware@users.noreply.github.com>
Date: Thu, 19 Sep 2024 09:46:54 +0800
Subject: [PATCH] docs: beautify parsers docstring in src and test

---
 src/bmkg/parsers/parse_area_element.py        | 24 ++++----
 src/bmkg/parsers/parse_datetime_element.py    | 36 ++++++------
 src/bmkg/parsers/parse_humidity_element.py    | 18 +++---
 src/bmkg/parsers/parse_issue_element.py       | 14 ++---
 src/bmkg/parsers/parse_temperature_element.py | 24 ++++----
 src/bmkg/parsers/parse_weather_element.py     | 18 +++---
 .../parsers/parse_wind_direction_element.py   | 30 +++++-----
 src/bmkg/parsers/parse_wind_speed_element.py  | 36 ++++++------
 .../test_parse_weather_forecast_data.py       | 56 +++++++++----------
 9 files changed, 128 insertions(+), 128 deletions(-)

diff --git a/src/bmkg/parsers/parse_area_element.py b/src/bmkg/parsers/parse_area_element.py
index 145417c..e1f2654 100644
--- a/src/bmkg/parsers/parse_area_element.py
+++ b/src/bmkg/parsers/parse_area_element.py
@@ -30,19 +30,19 @@ def parse_area_element(element: Element) -> Area:
     >>> from defusedxml.ElementTree import fromstring
     >>> element = fromstring(
     ...     "<area"
-    ...     ' id="501409"'
-    ...     ' latitude="4.176594"'
-    ...     ' longitude="96.124878"'
-    ...     ' coordinate="96.124878 4.176594"'
-    ...     ' type="land"'
-    ...     ' region=""'
-    ...     ' level="1"'
-    ...     ' description="Aceh Barat"'
-    ...     ' domain="Aceh"'
-    ...     ' tags=""'
+    ...     '  id="501409"'
+    ...     '  latitude="4.176594"'
+    ...     '  longitude="96.124878"'
+    ...     '  coordinate="96.124878 4.176594"'
+    ...     '  type="land"'
+    ...     '  region=""'
+    ...     '  level="1"'
+    ...     '  description="Aceh Barat"'
+    ...     '  domain="Aceh"'
+    ...     '  tags=""'
     ...     ">"
-    ...     '<name xml:lang="en_US">Aceh Barat</name>'
-    ...     '<name xml:lang="id_ID">Kab. Aceh Barat</name>'
+    ...     '  <name xml:lang="en_US">Aceh Barat</name>'
+    ...     '  <name xml:lang="id_ID">Kab. Aceh Barat</name>'
     ...     "</area>"
     ... )
     >>> area = parse_area_element(element)
diff --git a/src/bmkg/parsers/parse_datetime_element.py b/src/bmkg/parsers/parse_datetime_element.py
index 190c3a4..4e0f48e 100644
--- a/src/bmkg/parsers/parse_datetime_element.py
+++ b/src/bmkg/parsers/parse_datetime_element.py
@@ -30,24 +30,24 @@ def parse_datetime_element(element: Element) -> Iterator[datetime]:
     >>> from defusedxml.ElementTree import fromstring
     >>> element = fromstring(
     ...     '<parameter id="ws" description="datetime" type="hourly">'
-    ...     '<timerange type="hourly" h="0" datetime="202401170000">'
-    ...     '<value unit="Kt">5</value>'
-    ...     '<value unit="MPH">5.75389725</value>'
-    ...     '<value unit="KPH">9.26</value>'
-    ...     '<value unit="MS">2.57222222</value>'
-    ...     "</timerange>"
-    ...     '<timerange type="hourly" h="6" datetime="202401170600">'
-    ...     '<value unit="Kt">2</value>'
-    ...     '<value unit="MPH">2.3015589</value>'
-    ...     '<value unit="KPH">3.704</value>'
-    ...     '<value unit="MS">1.028888888</value>'
-    ...     "</timerange>"
-    ...     '<timerange type="hourly" h="12" datetime="202401171200">'
-    ...     '<value unit="Kt">0</value>'
-    ...     '<value unit="MPH">0</value>'
-    ...     '<value unit="KPH">0</value>'
-    ...     '<value unit="MS">0</value>'
-    ...     "</timerange>"
+    ...     '  <timerange type="hourly" h="0" datetime="202401170000">'
+    ...     '    <value unit="Kt">5</value>'
+    ...     '    <value unit="MPH">5.75389725</value>'
+    ...     '    <value unit="KPH">9.26</value>'
+    ...     '    <value unit="MS">2.57222222</value>'
+    ...     "  </timerange>"
+    ...     '  <timerange type="hourly" h="6" datetime="202401170600">'
+    ...     '    <value unit="Kt">2</value>'
+    ...     '    <value unit="MPH">2.3015589</value>'
+    ...     '    <value unit="KPH">3.704</value>'
+    ...     '    <value unit="MS">1.028888888</value>'
+    ...     "  </timerange>"
+    ...     '  <timerange type="hourly" h="12" datetime="202401171200">'
+    ...     '    <value unit="Kt">0</value>'
+    ...     '    <value unit="MPH">0</value>'
+    ...     '    <value unit="KPH">0</value>'
+    ...     '    <value unit="MS">0</value>'
+    ...     "  </timerange>"
     ...     "</parameter>"
     ... )
     >>> datetime = parse_datetime_element(element)
diff --git a/src/bmkg/parsers/parse_humidity_element.py b/src/bmkg/parsers/parse_humidity_element.py
index 6a5dbfe..03ad096 100644
--- a/src/bmkg/parsers/parse_humidity_element.py
+++ b/src/bmkg/parsers/parse_humidity_element.py
@@ -27,15 +27,15 @@ def parse_humidity_element(element: Element) -> Iterator[Humidity]:
     >>> from defusedxml.ElementTree import fromstring
     >>> element = fromstring(
     ...     '<parameter id="hu" description="Humidity" type="hourly">'
-    ...     '<timerange type="hourly" h="0" datetime="202401170000">'
-    ...     '<value unit="%">95</value>'
-    ...     "</timerange>"
-    ...     '<timerange type="hourly" h="6" datetime="202401170600">'
-    ...     '<value unit="%">90</value>'
-    ...     "</timerange>"
-    ...     '<timerange type="hourly" h="12" datetime="202401171200">'
-    ...     '<value unit="%">95</value>'
-    ...     "</timerange>"
+    ...     '  <timerange type="hourly" h="0" datetime="202401170000">'
+    ...     '    <value unit="%">95</value>'
+    ...     "  </timerange>"
+    ...     '  <timerange type="hourly" h="6" datetime="202401170600">'
+    ...     '    <value unit="%">90</value>'
+    ...     "  </timerange>"
+    ...     '  <timerange type="hourly" h="12" datetime="202401171200">'
+    ...     '    <value unit="%">95</value>'
+    ...     "  </timerange>"
     ...     "</parameter>"
     ... )
     >>> humidity = parse_humidity_element(element)
diff --git a/src/bmkg/parsers/parse_issue_element.py b/src/bmkg/parsers/parse_issue_element.py
index 9cbd30c..eb279f2 100644
--- a/src/bmkg/parsers/parse_issue_element.py
+++ b/src/bmkg/parsers/parse_issue_element.py
@@ -26,13 +26,13 @@ def parse_issue_element(element: Element) -> datetime:
     >>> from defusedxml.ElementTree import fromstring
     >>> element = fromstring(
     ...     "<issue>"
-    ...     "<timestamp>20240116032347</timestamp>"
-    ...     "<year>2024</year>"
-    ...     "<month>01</month>"
-    ...     "<day>16</day>"
-    ...     "<hour>03</hour>"
-    ...     "<minute>23</minute>"
-    ...     "<second>47</second>"
+    ...     "  <timestamp>20240116032347</timestamp>"
+    ...     "  <year>2024</year>"
+    ...     "  <month>01</month>"
+    ...     "  <day>16</day>"
+    ...     "  <hour>03</hour>"
+    ...     "  <minute>23</minute>"
+    ...     "  <second>47</second>"
     ...     "</issue>"
     ... )
     >>> issue = parse_issue_element(element)
diff --git a/src/bmkg/parsers/parse_temperature_element.py b/src/bmkg/parsers/parse_temperature_element.py
index 6133814..1033272 100644
--- a/src/bmkg/parsers/parse_temperature_element.py
+++ b/src/bmkg/parsers/parse_temperature_element.py
@@ -27,18 +27,18 @@ def parse_temperature_element(element: Element) -> Iterator[Temperature]:
     >>> from defusedxml.ElementTree import fromstring
     >>> element = fromstring(
     ...     '<parameter id="t" description="Temperature" type="hourly">'
-    ...     '<timerange type="hourly" h="0" datetime="202401170000">'
-    ...     '<value unit="C">24</value>'
-    ...     '<value unit="F">75.2</value>'
-    ...     "</timerange>"
-    ...     '<timerange type="hourly" h="6" datetime="202401170600">'
-    ...     '<value unit="C">28</value>'
-    ...     '<value unit="F">82.4</value>'
-    ...     "</timerange>"
-    ...     '<timerange type="hourly" h="12" datetime="202401171200">'
-    ...     '<value unit="C">26</value>'
-    ...     '<value unit="F">78.8</value>'
-    ...     "</timerange>"
+    ...     '  <timerange type="hourly" h="0" datetime="202401170000">'
+    ...     '    <value unit="C">24</value>'
+    ...     '    <value unit="F">75.2</value>'
+    ...     "  </timerange>"
+    ...     '  <timerange type="hourly" h="6" datetime="202401170600">'
+    ...     '    <value unit="C">28</value>'
+    ...     '    <value unit="F">82.4</value>'
+    ...     "  </timerange>"
+    ...     '  <timerange type="hourly" h="12" datetime="202401171200">'
+    ...     '    <value unit="C">26</value>'
+    ...     '    <value unit="F">78.8</value>'
+    ...     "  </timerange>"
     ...     "</parameter>"
     ... )
     >>> temperature = parse_temperature_element(element)
diff --git a/src/bmkg/parsers/parse_weather_element.py b/src/bmkg/parsers/parse_weather_element.py
index c3cc46f..684399b 100644
--- a/src/bmkg/parsers/parse_weather_element.py
+++ b/src/bmkg/parsers/parse_weather_element.py
@@ -27,15 +27,15 @@ def parse_weather_element(element: Element) -> Iterator[enums.Weather]:
     >>> from defusedxml.ElementTree import fromstring
     >>> element = fromstring(
     ...     '<parameter id="weather" description="Weather" type="hourly">'
-    ...     '<timerange type="hourly" h="0" datetime="202401170000">'
-    ...     '<value unit="icon">60</value>'
-    ...     "</timerange>"
-    ...     '<timerange type="hourly" h="6" datetime="202401170600">'
-    ...     '<value unit="icon">60</value>'
-    ...     "</timerange>"
-    ...     '<timerange type="hourly" h="12" datetime="202401171200">'
-    ...     '<value unit="icon">1</value>'
-    ...     "</timerange>"
+    ...     '  <timerange type="hourly" h="0" datetime="202401170000">'
+    ...     '    <value unit="icon">60</value>'
+    ...     "  </timerange>"
+    ...     '  <timerange type="hourly" h="6" datetime="202401170600">'
+    ...     '    <value unit="icon">60</value>'
+    ...     "  </timerange>"
+    ...     '  <timerange type="hourly" h="12" datetime="202401171200">'
+    ...     '    <value unit="icon">1</value>'
+    ...     "  </timerange>"
     ...     "</parameter>"
     ... )
     >>> weather = parse_weather_element(element)
diff --git a/src/bmkg/parsers/parse_wind_direction_element.py b/src/bmkg/parsers/parse_wind_direction_element.py
index 78cfca7..fc4a9e5 100644
--- a/src/bmkg/parsers/parse_wind_direction_element.py
+++ b/src/bmkg/parsers/parse_wind_direction_element.py
@@ -28,21 +28,21 @@ def parse_wind_direction_element(element: Element) -> Iterator[WindDirection]:
     >>> from defusedxml.ElementTree import fromstring
     >>> element = fromstring(
     ...     '<parameter id="wd" description="Wind direction" type="hourly">'
-    ...     '<timerange type="hourly" h="0" datetime="202401170000">'
-    ...     '<value unit="deg">90</value>'
-    ...     '<value unit="CARD">E</value>'
-    ...     '<value unit="SEXA">9000</value>'
-    ...     "</timerange>"
-    ...     '<timerange type="hourly" h="6" datetime="202401170600">'
-    ...     '<value unit="deg">157.5</value>'
-    ...     '<value unit="CARD">SSE</value>'
-    ...     '<value unit="SEXA">15730</value>'
-    ...     "</timerange>"
-    ...     '<timerange type="hourly" h="12" datetime="202401171200">'
-    ...     '<value unit="deg">0</value>'
-    ...     '<value unit="CARD">VARIABLE</value>'
-    ...     '<value unit="SEXA">000</value>'
-    ...     "</timerange>"
+    ...     '  <timerange type="hourly" h="0" datetime="202401170000">'
+    ...     '    <value unit="deg">90</value>'
+    ...     '    <value unit="CARD">E</value>'
+    ...     '    <value unit="SEXA">9000</value>'
+    ...     "  </timerange>"
+    ...     '  <timerange type="hourly" h="6" datetime="202401170600">'
+    ...     '    <value unit="deg">157.5</value>'
+    ...     '    <value unit="CARD">SSE</value>'
+    ...     '    <value unit="SEXA">15730</value>'
+    ...     "  </timerange>"
+    ...     '  <timerange type="hourly" h="12" datetime="202401171200">'
+    ...     '    <value unit="deg">0</value>'
+    ...     '    <value unit="CARD">VARIABLE</value>'
+    ...     '    <value unit="SEXA">000</value>'
+    ...     "  </timerange>"
     ...     "</parameter>"
     ... )
     >>> wind_direction = parse_wind_direction_element(element)
diff --git a/src/bmkg/parsers/parse_wind_speed_element.py b/src/bmkg/parsers/parse_wind_speed_element.py
index 6c26ce0..95481d3 100644
--- a/src/bmkg/parsers/parse_wind_speed_element.py
+++ b/src/bmkg/parsers/parse_wind_speed_element.py
@@ -27,24 +27,24 @@ def parse_wind_speed_element(element: Element) -> Iterator[WindSpeed]:
     >>> from defusedxml.ElementTree import fromstring
     >>> element = fromstring(
     ...     '<parameter id="ws" description="Wind speed" type="hourly">'
-    ...     '<timerange type="hourly" h="0" datetime="202401170000">'
-    ...     '<value unit="Kt">5</value>'
-    ...     '<value unit="MPH">5.75389725</value>'
-    ...     '<value unit="KPH">9.26</value>'
-    ...     '<value unit="MS">2.57222222</value>'
-    ...     "</timerange>"
-    ...     '<timerange type="hourly" h="6" datetime="202401170600">'
-    ...     '<value unit="Kt">2</value>'
-    ...     '<value unit="MPH">2.3015589</value>'
-    ...     '<value unit="KPH">3.704</value>'
-    ...     '<value unit="MS">1.028888888</value>'
-    ...     "</timerange>"
-    ...     '<timerange type="hourly" h="12" datetime="202401171200">'
-    ...     '<value unit="Kt">0</value>'
-    ...     '<value unit="MPH">0</value>'
-    ...     '<value unit="KPH">0</value>'
-    ...     '<value unit="MS">0</value>'
-    ...     "</timerange>"
+    ...     '  <timerange type="hourly" h="0" datetime="202401170000">'
+    ...     '    <value unit="Kt">5</value>'
+    ...     '    <value unit="MPH">5.75389725</value>'
+    ...     '    <value unit="KPH">9.26</value>'
+    ...     '    <value unit="MS">2.57222222</value>'
+    ...     "  </timerange>"
+    ...     '  <timerange type="hourly" h="6" datetime="202401170600">'
+    ...     '    <value unit="Kt">2</value>'
+    ...     '    <value unit="MPH">2.3015589</value>'
+    ...     '    <value unit="KPH">3.704</value>'
+    ...     '    <value unit="MS">1.028888888</value>'
+    ...     "  </timerange>"
+    ...     '  <timerange type="hourly" h="12" datetime="202401171200">'
+    ...     '    <value unit="Kt">0</value>'
+    ...     '    <value unit="MPH">0</value>'
+    ...     '    <value unit="KPH">0</value>'
+    ...     '    <value unit="MS">0</value>'
+    ...     "  </timerange>"
     ...     "</parameter>"
     ... )
     >>> wind_speed = parse_wind_speed_element(element)
diff --git a/tests/test_parsers/test_parse_weather_forecast_data.py b/tests/test_parsers/test_parse_weather_forecast_data.py
index 295f998..6671305 100644
--- a/tests/test_parsers/test_parse_weather_forecast_data.py
+++ b/tests/test_parsers/test_parse_weather_forecast_data.py
@@ -10,33 +10,33 @@ def test_parse_element_with_invalid_attribute():
     ):
         parse_weather_forecast_data(
             '<data source="meteofactory" productioncenter="NC Jakarta">'
-            "<forecast domain='local'>"
-            "<issue>"
-            "<timestamp>20240216023745</timestamp>"
-            "<year>2024</year>"
-            "<month>02</month>"
-            "<day>16</day>"
-            "<hour>02</hour>"
-            "<minute>37</minute>"
-            "<second>45</second>"
-            "</issue>"
-            "<area"
-            ' id="501409"'
-            ' latitude="4.176594"'
-            ' longitude="96.124878"'
-            ' coordinate="96.124878 4.176594"'
-            ' type="land"'
-            ' region=""'
-            ' level="1"'
-            ' description="Aceh Barat"'
-            ' domain="Aceh"'
-            ' tags=""'
-            ">"
-            '<name xml:lang="en_US">Aceh Barat</name>'
-            '<name xml:lang="id_ID">Kab. Aceh Barat</name>'
-            '<parameter description="Humidity" type="hourly">'
-            "</parameter>"
-            "</area>"
-            "</forecast>"
+            "  <forecast domain='local'>"
+            "    <issue>"
+            "      <timestamp>20240216023745</timestamp>"
+            "      <year>2024</year>"
+            "      <month>02</month>"
+            "      <day>16</day>"
+            "      <hour>02</hour>"
+            "      <minute>37</minute>"
+            "      <second>45</second>"
+            "    </issue>"
+            "    <area"
+            '      id="501409"'
+            '      latitude="4.176594"'
+            '      longitude="96.124878"'
+            '      coordinate="96.124878 4.176594"'
+            '      type="land"'
+            '      region=""'
+            '      level="1"'
+            '      description="Aceh Barat"'
+            '      domain="Aceh"'
+            '      tags=""'
+            "    >"
+            '      <name xml:lang="en_US">Aceh Barat</name>'
+            '      <name xml:lang="id_ID">Kab. Aceh Barat</name>'
+            '      <parameter description="Humidity" type="hourly">'
+            "      </parameter>"
+            "    </area>"
+            "  </forecast>"
             "</data>"
         )