Skip to content

rs_server_cadip/cadip_retriever.md

<< Back to index

This will be used to configure dataretriever used for cadip

init_cadip_provider(station) cached

Initialize the cadip provider for the given station.

It initializes an eodag provider for the given station. The EODAG configuration file is read from the path given in the EODAG_CADIP_CONFIG var env if set. It is read from the path config/cadip_ws_config.yaml otherwise.

If the station is unknown or if the cadip station configuration reading fails, a specific exception is raised to inform the caller of the issue.

Parameters:

Name Type Description Default
station str

the station to interact with: ns, mps, mti, nsg, sgs, cadip(?)

 required

Returns:

Type Description
EodagProvider

the EodagProvider initialized
Source code in docs/rs-server/services/cadip/rs_server_cadip/cadip_retriever.py 
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
@lru_cache
def init_cadip_provider(station: str) -> EodagProvider:
    """Initialize the cadip provider for the given station.

    It initializes an eodag provider for the given station.
    The EODAG configuration file is read from the path given in the EODAG_CADIP_CONFIG var env if set.
    It is read from the path config/cadip_ws_config.yaml otherwise.

    If the station is unknown or if the cadip station configuration reading fails,
    a specific exception is raised to inform the caller of the issue.

    Args:
        station: the station to interact with: ns, mps, mti, nsg, sgs, cadip(?)

    Returns:
        the EodagProvider initialized
    """
    station = station.lower()
    try:
        # Get the cadip_ws_config.yaml file path for eodag.
        # Check if the config file path is overriden in the environment variables
        eodag_config = Path(os.environ.get("EODAG_CADIP_CONFIG", DEFAULT_EODAG_CONFIG))

        # Read the station authentication from rs-server.yaml file or RSPY__TOKEN__xxx env vars
        ext_auth_config = load_external_auth_config(station, "cadip")

        # default to eodag, stations may be ins, mps, mti, nsg, sgs, cadip(?)
        return EodagProvider(ext_auth_config, eodag_config, station)

    except Exception as exception:
        raise CreateProviderFailed(f"Failed to setup eodag for CADIP station {station}") from exception