Skip to content

Default

DefaultExtract

Bases: ExtractionMethod

Takes a set of default key value pairs.

Method name: default

Example configuration

.. code-block:: yaml

- method: default
  inputs:
    defaults:
        mip_era: CMIP6
Source code in extraction_methods/plugins/default.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
class DefaultExtract(ExtractionMethod):
    """
    Takes a set of default key value pairs.

    **Method name:** ``default``

    Example configuration:
        .. code-block:: yaml

            - method: default
              inputs:
                defaults:
                    mip_era: CMIP6
    """

    input_class = DefaultInput

    @update_input
    def run(self, body: dict[str, Any]) -> dict[str, Any]:

        return body | self.input.defaults  # type: ignore[no-any-return]

DefaultInput

Bases: Input

Model for Default Method Input.

Parameters:

Name Type Description Default
defaults dict[str, Any]

Defaults to be added.

 required
Source code in extraction_methods/plugins/default.py 
22
23
24
25
26
27
28
29
class DefaultInput(Input):
    """
    Model for Default Method Input.
    """

    defaults: dict[str, Any] = Field(
        description="Defaults to be added.",
    )