Skip to content

rs_server_adgs/adgs_utils.md

<< Back to index

Module for interacting with ADGS system through a FastAPI APIRouter.

auxip_odata_to_stac_template() cached

Used each time to read the ODataToSTAC_template json template.

Source code in docs/rs-server/services/adgs/rs_server_adgs/adgs_utils.py 
47
48
49
50
51
52
@lru_cache
def auxip_odata_to_stac_template():
    """Used each time to read the ODataToSTAC_template json template."""
    with open(ADGS_CONFIG / "ODataToSTAC_template.json", encoding="utf-8") as mapper:
        config = json.loads(mapper.read())
    return config  # WARNING: if the caller wants to modify this cached object, he must deepcopy it first

auxip_stac_mapper() cached

Used each time to read the adgs_stac_mapper config yaml.

Source code in docs/rs-server/services/adgs/rs_server_adgs/adgs_utils.py 
55
56
57
58
59
60
@lru_cache
def auxip_stac_mapper():
    """Used each time to read the adgs_stac_mapper config yaml."""
    with open(ADGS_CONFIG / "adgs_stac_mapper.json", encoding="utf-8") as stac_map:
        config = json.loads(stac_map.read())
    return config  # WARNING: if the caller wants to modify this cached object, it must deepcopy it first

prepare_collection(collection)

Used to create a more complex mapping on platform/constallation from odata to stac.

Source code in docs/rs-server/services/adgs/rs_server_adgs/adgs_utils.py 
107
108
109
110
111
112
113
114
def prepare_collection(collection: stac_pydantic.ItemCollection) -> stac_pydantic.ItemCollection:
    """Used to create a more complex mapping on platform/constallation from odata to stac."""
    for feature in collection.features:
        feature.properties.platform, feature.properties.constellation = reverse_adgs_prip_map_mission(
            feature.properties.platform,
            feature.properties.constellation,
        )
    return collection

read_conf() cached

Used each time to read RSPY_ADGS_SEARCH_CONFIG config yaml.

Source code in docs/rs-server/services/adgs/rs_server_adgs/adgs_utils.py 
38
39
40
41
42
43
44
@lru_cache
def read_conf():
    """Used each time to read RSPY_ADGS_SEARCH_CONFIG config yaml."""
    adgs_search_config = os.environ.get("RSPY_ADGS_SEARCH_CONFIG", str(search_yaml.absolute()))
    with open(adgs_search_config, encoding="utf-8") as search_conf:
        config = yaml.safe_load(search_conf)
    return config  # WARNING: if the caller wants to modify this cached object, it must deepcopy it first

select_config(configuration_id)

Used to select a specific configuration from yaml file, returns None if not found.

Source code in docs/rs-server/services/adgs/rs_server_adgs/adgs_utils.py 
63
64
65
66
67
68
def select_config(configuration_id: str) -> dict | None:
    """Used to select a specific configuration from yaml file, returns None if not found."""
    return next(
        (item for item in read_conf()["collections"] if item["id"] == configuration_id),
        None,
    )

serialize_adgs_asset(feature_collection, products)

Used to update adgs asset with proper href and format {asset_name: asset_body}.

Source code in docs/rs-server/services/adgs/rs_server_adgs/adgs_utils.py 
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def serialize_adgs_asset(feature_collection, products):
    """Used to update adgs asset with proper href and format {asset_name: asset_body}."""
    for feature in feature_collection.features:
        external_ids = feature.properties.dict().get("externalIds") or []
        auxip_id = next(
            (
                entry.get("value")
                for entry in external_ids
                if isinstance(entry, dict) and entry.get("scheme") == "auxip"
            ),
            None,
        )
        if not auxip_id:
            raise HTTPException(
                status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
                detail=f"Missing externalIds for feature {feature.id}",
            )
        # Find matching product by id and update feature href
        try:
            matched_product = next((p for p in products if p.properties["id"] == auxip_id), None)
        except StopIteration as exc:
            raise HTTPException(status_code=status.HTTP_404_NOT_FOUND, detail=f"Unable to map {feature.id}") from exc
        if matched_product:
            feature.assets["file"].href = re.sub(r"\([^\)]*\)", f"({auxip_id})", matched_product.properties["href"])
        # Rename "file" asset to feature.id
        feature.assets[feature.id] = feature.assets.pop("file")
        feature.id = feature.id.rsplit(".", 1)[0]  # remove extension if any
    return feature_collection

stac_to_odata(stac_params)

Convert a parameter directory from STAC keys to OData keys. Return the new directory.

Source code in docs/rs-server/services/adgs/rs_server_adgs/adgs_utils.py 
71
72
73
74
def stac_to_odata(stac_params: dict) -> dict:
    """Convert a parameter directory from STAC keys to OData keys. Return the new directory."""
    params = apply_external_ids(stac_params, "auxip")
    return {auxip_stac_mapper().get(stac_key, stac_key): value for stac_key, value in params.items()}