overturetoosm

 9def process_place(
10    props: dict,
11    confidence: float = 0.0,
12    region_tag: str = "addr:state",
13    unmatched: Literal["error", "force", "ignore"] = "ignore",
14) -> Dict[str, str]:
15    """Convert Overture's places properties to OSM tags.
16
17    Example usage:
18    ```python
19    import json
20    from overturetoosm import process_place
21
22    with open("overture.geojson", "r", encoding="utf-8") as f:
23        contents: dict = json.load(f)
24
25        for feature in contents["features"]:
26            feature["properties"] = process_place(feature["properties"], confidence=0.5)
27
28    with open("overture_out.geojson", "w+", encoding="utf-8") as x:
29        json.dump(contents, x, indent=4)
30    ```
31    Args:
32        props (dict): The feature properties from the Overture GeoJSON.
33        region_tag (str, optional): What tag to convert Overture's `region` tag to.
34            Defaults to `addr:state`.
35        confidence (float, optional): The minimum confidence level. Defaults to 0.0.
36        unmatched (Literal["error", "force", "ignore"], optional): How to handle
37            unmatched Overture categories. The "error" option raises an UnmatchedError
38            exception, "force" puts the category into the `type` key, and "ignore"
39            only returns other properties. Defaults to "ignore".
40
41    Returns:
42        dict[str, str]: The reshaped and converted properties in OSM's flat str:str
43            schema.
44
45    Raises:
46        `overturetoosm.objects.UnmatchedError`: Raised if `unmatched` is set to `error`
47            and the Overture category has no OSM definition.
48        `overturetoosm.objects.ConfidenceError`: Raised if the confidence level is set
49            above a feature's confidence.
50    """
51    return PlaceProps(**props).to_osm(confidence, region_tag, unmatched)

 9def process_building(props: dict, confidence: float = 0.0) -> Dict[str, str]:
10    """Convert Overture's building properties to OSM tags.
11
12    Args:
13        props (dict): The feature properties from the Overture GeoJSON.
14        confidence (float, optional): The minimum confidence level. Defaults to 0.0.
15
16    Returns:
17        Dict[str, str]: The reshaped and converted properties in OSM's flat
18            str:str schema.
19
20    Raises:
21        `overturetoosm.objects.ConfidenceError`: Raised if the confidence level is set
22            above a feature's confidence.
23    """
24    return BuildingProps(**props).to_osm(confidence)

 9def process_address(props: dict, style: str = "US") -> Dict[str, str]:
10    """Convert Overture's address properties to OSM tags.
11
12    Args:
13        props (dict): The feature properties from the Overture GeoJSON.
14        style (str, optional): How to handle the `address_levels` field. Open
15            a pull request or issue to add support for other regions. Defaults to "US".
16
17    Returns:
18        Dict[str, str]: The reshaped and converted properties in OSM's flat
19            str:str schema.
20    """
21    return AddressProps(**props).to_osm(style)

 9def process_geojson(
10    geojson: dict,
11    fx: Callable,
12    confidence: Optional[float] = None,
13    options: Optional[dict] = None,
14) -> dict:
15    """Convert an Overture `place` GeoJSON to one that follows OSM's schema.
16
17    Example usage:
18    ```python
19    import json
20    from overturetoosm import process_geojson
21
22    with open("overture.geojson", "r", encoding="utf-8") as f:
23        contents: dict = json.load(f)
24        geojson = process_geojson(contents, fx=process_building)
25
26    with open("overture_out.geojson", "w+", encoding="utf-8") as x:
27        json.dump(geojson, x, indent=4)
28    ```
29    Args:
30        geojson (dict): The dictionary representation of the Overture GeoJSON.
31        fx (Callable): The function to apply to each feature.
32        confidence (float, optional): The minimum confidence level. Defaults to 0.0.
33        options (dict, optional): Function-specific options to pass as arguments to
34            the `fx` function.
35
36    Returns:
37        dict: The dictionary representation of the GeoJSON that follows OSM's schema.
38    """
39    options = options or {}
40    new_features = []
41    for feature in geojson["features"]:
42        try:
43            if confidence:
44                feature["properties"] = fx(feature["properties"], confidence, **options)
45            else:
46                feature["properties"] = fx(feature["properties"], **options)
47            new_features.append(feature)
48        except (ConfidenceError, UnmatchedError):
49            pass
50
51    geojson["features"] = new_features
52    return geojson