Normalize incline values during OSM to OSW conversion

Author: sujata-m

src/osm_osw_reformatter/serializer/osw/osw_normalizer.py

@@ -67,7 +67,7 @@ def normalize(self):
             raise ValueError("This is an invalid way")
 
     def _normalize_way(self, keep_keys={}, defaults = {}):
-        generic_keep_keys = {"highway": str, "width": float, "surface": surface, "name": str, "description": str, "foot": foot}
+        generic_keep_keys = {"highway": str, "width": float, "surface": surface, "name": str, "description": str, "foot": foot, "incline": incline}
         generic_defaults = {}
 
         new_tags = _normalize(self.tags, {**generic_keep_keys, **keep_keys}, {**generic_defaults, **defaults})
@@ -81,7 +81,7 @@ def _normalize_pedestrian(self, keep_keys = {}, defaults = {}):
         return new_tags
 
     def _normalize_stairs(self, keep_keys = {}, defaults = {}):
-        generic_keep_keys = {"step_count": int, "incline": ["climb", climb]}
+        generic_keep_keys = {"step_count": int, "incline": incline}
         generic_defaults = {"foot": "yes"}
 
         new_tags = self._normalize_way({**generic_keep_keys, **keep_keys}, {**generic_defaults, **defaults})
@@ -584,13 +584,19 @@ def crossing_markings(tag_value, tags):
         return None
 
 def climb(tag_value, tags):
-    if tag_value.lower() not in (                        
+    if tag_value.lower() not in (
                                 "up",
                                 "down"
                                 ):
         return None
     else:
         return tag_value.lower()
+
+def incline(tag_value, tags):
+    try:
+        return float(str(tag_value).rstrip('%'))
+    except (ValueError, TypeError):
+        return None
 
 def foot(tag_value, tags):
     if tag_value.lower() not in (

tests/unit_tests/test_files/incline-test.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<osm version="0.6" generator="test" upload="false">
+  <node id="1" lat="0.0" lon="0.0" />
+  <node id="2" lat="0.0" lon="0.1" />
+  <way id="1">
+    <nd ref="1"/>
+    <nd ref="2"/>
+    <tag k="highway" v="footway"/>
+    <tag k="incline" v="0.1"/>
+    <tag k="_id" v="1"/>
+  </way>
+</osm>

tests/unit_tests/test_osm2osw/test_osm2osw.py

@@ -10,6 +10,7 @@
 OUTPUT_DIR = os.path.join(os.path.dirname(os.path.dirname(ROOT_DIR)), 'output')
 TEST_FILE = os.path.join(ROOT_DIR, 'test_files/wa.microsoft.osm.pbf')
 TEST_WIDTH_FILE = os.path.join(ROOT_DIR, 'test_files/width-test.xml')
+TEST_INCLINE_FILE = os.path.join(ROOT_DIR, 'test_files/incline-test.xml')
 
 
 def is_valid_float(value):
@@ -218,6 +219,33 @@ async def run_test():
 
         asyncio.run(run_test())
 
+    def test_retains_incline_tag(self):
+        osm_file_path = TEST_INCLINE_FILE
+
+        async def run_test():
+            osm2osw = OSM2OSW(osm_file=osm_file_path, workdir=OUTPUT_DIR, prefix='test')
+            result = await osm2osw.convert()
+            self.assertTrue(result.status)
+
+            found_incline = False
+            for file_path in result.generated_files:
+                if file_path.endswith('edges.geojson'):
+                    with open(file_path) as f:
+                        geojson = json.load(f)
+                        for feature in geojson.get('features', []):
+                            props = feature.get('properties', {})
+                            if 'incline' in props:
+                                self.assertIsInstance(props['incline'], (int, float))
+                                found_incline = True
+                    break
+
+            for file_path in result.generated_files:
+                os.remove(file_path)
+
+            self.assertTrue(found_incline, 'Incline tag not found in output edges')
+
+        asyncio.run(run_test())
+
 
 if __name__ == '__main__':
     unittest.main()

tests/unit_tests/test_serializer/test_osw_normalizer.py

@@ -1,6 +1,15 @@
 import unittest
-from src.osm_osw_reformatter.serializer.osw.osw_normalizer import OSWWayNormalizer, OSWNodeNormalizer, \
-    OSWPointNormalizer, tactile_paving, surface, crossing_markings, climb, _normalize
+from src.osm_osw_reformatter.serializer.osw.osw_normalizer import (
+    OSWWayNormalizer,
+    OSWNodeNormalizer,
+    OSWPointNormalizer,
+    tactile_paving,
+    surface,
+    crossing_markings,
+    climb,
+    incline,
+    _normalize,
+)
 
 
 class TestOSWWayNormalizer(unittest.TestCase):
@@ -53,6 +62,13 @@ def test_normalize_crossing(self):
         expected = {'highway': 'footway', 'footway': 'crossing', 'foot': 'yes'}
         self.assertEqual(result, expected)
 
+    def test_normalize_incline(self):
+        tags = {'highway': 'footway', 'incline': '10%'}
+        normalizer = OSWWayNormalizer(tags)
+        result = normalizer.normalize()
+        expected = {'highway': 'footway', 'incline': 10.0, 'foot': 'yes'}
+        self.assertEqual(result, expected)
+
     def test_normalize_invalid_way(self):
         tags = {'highway': 'invalid_type'}
         normalizer = OSWWayNormalizer(tags)
@@ -121,11 +137,16 @@ def test_crossing_markings(self):
         self.assertEqual(crossing_markings('dots', {'crossing:markings': 'dots'}), 'dots')
         self.assertIsNone(crossing_markings('invalid_value', {'crossing:markings': 'invalid_value'}))
 
-    def test_incline(self):
+    def test_climb(self):
         self.assertEqual(climb('up', {}), 'up')
         self.assertEqual(climb('down', {}), 'down')
         self.assertIsNone(climb('invalid_value', {}))
 
+    def test_incline(self):
+        self.assertEqual(incline('10%', {}), 10.0)
+        self.assertEqual(incline('0.5', {}), 0.5)
+        self.assertIsNone(incline('steep', {}))
+
 
 class TestNormalizeWidthField(unittest.TestCase):
     def test_removes_width_when_value_is_nan_string(self):