Skip to content

feat: introduce default values #347

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

Open
raven-wing wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: introduce default values #347

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c505024
feat: introduce default values
raven-wing May 1, 2026
73333ad
fix linting
raven-wing May 1, 2026
0cfcd4a
Merge branch 'Problematy:main' into default_fields
raven-wing May 20, 2026
311253e
removed default_field
raven-wing May 21, 2026
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
37 changes: 36 additions & 1 deletion docs/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,35 @@ configuration keys control how these fields appear on the map:
forms. Supported types: ``str``, ``list``, ``int``, ``float``, ``bool``,
``dict``.

``data_templates``
Per-value defaults keyed by a field name and its possible values. When a
point has a matching field value, the corresponding template fields are
merged in. Point-level fields always win.

This lets you define "presets" for recurring location types so shared
fields don't have to be repeated on every record.

.. code-block:: json

{
"data_templates": {
"type_of_place": {
"big bridge": {
"accessible_by": ["pedestrians", "cars"],
"material": "steel"
},
"small bridge": {
"accessible_by": ["pedestrians"],
"material": "concrete"
}
}
}
}

With this configuration a point that only stores ``{"type_of_place": "big bridge"}``
will automatically receive ``accessible_by`` and ``material`` without those
fields being duplicated in every record.

Example configuration in your data source:

.. code-block:: json
Expand All @@ -67,7 +96,13 @@ Example configuration in your data source:
"meta_data": ["uuid"],
"location_obligatory_fields": [
["test_category", "list[str]"]
]
],
"data_templates": {
"type_of_place": {
"big bridge": {"accessible_by": ["pedestrians", "cars"]},
"small bridge": {"accessible_by": ["pedestrians"]}
}
}
}

.. _data-model-visible_data:
Expand Down
157 changes: 99 additions & 58 deletions examples/e2e_test_data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
{
"map": {
"data_templates": {
"type_of_place": {
"big bridge": {
"accessible_by": ["pedestrians", "cars"],
"material": "steel",
"river": "Odra"
},
"small bridge": {
"accessible_by": ["pedestrians"],
"material": "concrete",
"river": "Odra"
}
}
},
"data": [
{
"name": "Grunwaldzki",
"position": [
51.1095,
17.0525
],
"accessible_by": [
"pedestrians",
"cars"
],
"position": [51.1095, 17.0525],
"type_of_place": "big bridge",
"uuid": "hidden",
"uuid": "grunwaldzki",
"year_built": 1910,
"length_m": 112,
"CTA": {
"type": "CTA",
"value": "https://www.example.com",
Expand All @@ -21,66 +30,98 @@
},
{
"name": "Zwierzyniecka",
"position": [
51.10655,
17.0555
],
"accessible_by": [
"bikes",
"pedestrians"
],
"position": [51.10655, 17.0555],
"type_of_place": "small bridge",
"uuid": "dattarro",
"uuid": "zwierzyniecka",
"year_built": 1897,
"length_m": 35,
"remark": "very old bridge"
},
{
"name": "Mieszczański",
"position": [51.1150, 17.0390],
"type_of_place": "big bridge",
"uuid": "mieszczanski",
"year_built": 1949,
"length_m": 145
},
{
"name": "Szczytnicki",
"position": [51.1080, 17.0620],
"type_of_place": "small bridge",
"uuid": "szczytnicki",
"year_built": 1927,
"length_m": 28
},
{
"name": "Pokoju",
"position": [51.1200, 17.0310],
"type_of_place": "big bridge",
"uuid": "pokoju",
"year_built": 1947,
"length_m": 130
},
{
"name": "Osobowicki",
"position": [51.1350, 17.0280],
"type_of_place": "big bridge",
"uuid": "osobowicki",
"year_built": 1935,
"length_m": 160
},
{
"name": "Rędziński",
"position": [51.1420, 17.0180],
"type_of_place": "big bridge",
"uuid": "redzinski",
"year_built": 2011,
"length_m": 612,
"material": "cable-stayed",
"remark": "longest cable-stayed bridge in Poland"
},
{
"name": "Trzebnicki",
"position": [51.1280, 17.0200],
"type_of_place": "small bridge",
"uuid": "trzebnicki",
"year_built": 1912,
"length_m": 42
},
{
"name": "Bolesława Chrobrego",
"position": [51.1070, 17.0470],
"type_of_place": "small bridge",
"uuid": "chrobrego",
"year_built": 1904,
"length_m": 31,
"accessible_by": ["pedestrians", "bikes"]
},
{
"name": "Łużycki",
"position": [51.1030, 17.0590],
"type_of_place": "small bridge",
"uuid": "luzycki",
"year_built": 1966,
"length_m": 22
}
],
"location_obligatory_fields": [
[
"name",
"str"
],
[
"accessible_by",
"list"
],
[
"type_of_place",
"str"
]
["name", "str"],
["accessible_by", "list"],
["type_of_place", "str"]
],
"reported_issue_types": ["under construction", "has a hole"],
"categories": {
"accessible_by": [
"bikes",
"cars",
"pedestrians"
],
"type_of_place": [
"big bridge",
"small bridge"
]
"accessible_by": ["bikes", "cars", "pedestrians"],
"type_of_place": ["big bridge", "small bridge"]
},
"categories_help": [
"accessible_by"
],
"categories_help": ["accessible_by"],
"categories_options_help": {
"type_of_place": [
"small bridge"
],
"accessible_by": [
"cars",
"pedestrians"
]
"type_of_place": ["small bridge"],
"accessible_by": ["cars", "pedestrians"]
},
"visible_data": [
"remark",
"accessible_by",
"type_of_place",
"CTA"
],
"meta_data": [
"uuid"
]
"visible_data": ["remark", "accessible_by", "type_of_place", "material", "year_built", "length_m", "CTA"],
"meta_data": ["uuid", "river"]
},
"site_content": {
"pages": [
Expand Down
35 changes: 32 additions & 3 deletions goodmap/db.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -682,6 +682,32 @@ def get_category_data(db):
return globals()[f"{db.module_name}_get_category_data"]


# ------------------------------------------------
# data_templates helpers


def apply_data_defaults(map_data: dict, point: dict) -> dict:
"""Merge data_templates defaults into a point. Point fields always win.

data_templates structure:
"data_templates": {
"type_of_place": {
"big bridge": {"accessible_by": ["pedestrians", "cars"]},
"small bridge": {"accessible_by": ["pedestrians"]}
}
}
"""
type_defaults: dict = {}
for field, variants in map_data.get("data_templates", {}).items():
value = point.get(field)
if value is not None and value in variants:
type_defaults.update(variants[value])
Comment on lines +701 to +704

@coderabbitai coderabbitai Bot May 1, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Guard template matching against malformed template/value shapes.

value in variants / variants[value] can raise at runtime (e.g., unhashable discriminator values or non-dict template payloads), which would fail the whole read path.

Proposed fix 
-    for field, variants in map_data.get("data_templates", {}).items():
-        value = point.get(field)
-        if value is not None and value in variants:
-            type_defaults.update(variants[value])
+    for field, variants in map_data.get("data_templates", {}).items():
+        if not isinstance(variants, dict):
+            continue
+        value = point.get(field)
+        if value is None:
+            continue
+        try:
+            matched_template = variants.get(value)
+        except TypeError:
+            continue
+        if isinstance(matched_template, dict):
+            type_defaults.update(matched_template)
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@goodmap/db.py` around lines 708 - 711, Guard the template matching loop
against malformed shapes by first validating types and handling unhashable
values: ensure map_data.get("data_templates", {}) yields dict-like entries and
that each variants is a dict before using "value in variants", and only call
type_defaults.update(variants[value]) if variants[value] is also a dict. In
practice, around the loop over map_data.get("data_templates", {}) check
isinstance(variants, dict), wrap the membership test in a try/except TypeError
to catch unhashable point values, and verify isinstance(variants.get(value),
dict) before calling type_defaults.update to avoid runtime errors from non-dict
template payloads.


if not type_defaults:
return point
return {**type_defaults, **point}


# ------------------------------------------------
# get_location

Expand All @@ -697,8 +723,10 @@ def get_location_from_raw_data(raw_data, uuid, location_model):
Returns:
Validated location model instance, or None if not found.
"""
point = next((point for point in raw_data["data"] if point["uuid"] == uuid), None)
return location_model.model_validate(point) if point else None
point = next((p for p in raw_data["data"] if p["uuid"] == uuid), None)

@coderabbitai coderabbitai Bot May 1, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Avoid hard failure when one row is missing uuid.

Using p["uuid"] can throw KeyError and abort lookup even if a valid matching row exists later. Use .get("uuid") for resilient scanning.

Proposed fix 
-    point = next((p for p in raw_data["data"] if p["uuid"] == uuid), None)
+    point = next((p for p in raw_data["data"] if p.get("uuid") == uuid), None)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
point = next((p for p in raw_data["data"] if p["uuid"] == uuid), None)
point = next((p for p in raw_data["data"] if p.get("uuid") == uuid), None)
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@goodmap/db.py` at line 733, The lookup using next((p for p in
raw_data["data"] if p["uuid"] == uuid), None) will raise KeyError if any row
lacks the "uuid" key; change the predicate to use p.get("uuid") == uuid so the
scan is resilient to missing keys (update the expression that assigns point and
any similar lookups over raw_data["data"] to use .get("uuid") instead of
p["uuid"]).

if point is None:
return None
return location_model.model_validate(apply_data_defaults(raw_data, point))


def google_json_db_get_location(self, uuid, location_model):
Expand Down Expand Up @@ -744,7 +772,8 @@ def get_locations_list_from_raw_data(map_data, query, location_model):
Returns:
List of validated location model instances.
"""
filtered_locations = get_queried_data(map_data["data"], map_data["categories"], query)
merged_data = [apply_data_defaults(map_data, p) for p in map_data["data"]]
filtered_locations = get_queried_data(merged_data, map_data["categories"], query)
return [location_model.model_validate(point) for point in filtered_locations]


Expand Down
Loading
Loading