Skip to content

base_studio

base_studio

Classes:

BaseComponent 

BaseComponent(cfg: dict)

Methods:

  • load –

    Load a Component configuration from dict.

  • stringify_class –

    Return a JSON-friendly representation of a value.

load 

load(cfg: dict[str, Any]) -> None

Load a Component configuration from dict.

Parameters:

  • cfg
    (dict[str, Any]) –

    dict from JSON configuration .

Returns:

  • BaseConfig ( None ) –

    Instance initialized with the loaded configuration.

stringify_class classmethod 

stringify_class(value: Any) -> Any

Return a JSON-friendly representation of a value.

Parameters:

  • value
    (Any) –

    Object to convert.

Returns:

  • Any –

    A value that can be serialized by :mod:json.

BaseConfig dataclass 

BaseConfig()

Methods:

  • deserialize –

    Create an instance from a JSON string or dictionary.

  • serialize –

    Convert the configuration into a serializable dictionary.

  • stringify_class –

    Return a JSON-friendly representation of a value.

deserialize classmethod 

deserialize(data: Union[str, Dict[str, Any]]) -> BaseStudioConfig

Create an instance from a JSON string or dictionary.

Parameters:

  • data
    (Union[str, Dict[str, Any]]) –

    JSON string or already parsed dictionary.

Returns:

serialize 

serialize() -> Dict[str, Any]

Convert the configuration into a serializable dictionary.

Returns:

  • dict ( Dict[str, Any] ) –

    Serialized representation of the configuration.

stringify_class classmethod 

stringify_class(value: Any) -> Any

Return a JSON-friendly representation of a value.

Parameters:

  • value
    (Any) –

    Object to convert.

Returns:

  • Any –

    A value that can be serialized by :mod:json.

BasePluginConfig dataclass 

BasePluginConfig(testexamplevalue12345555555: str = 'examplevalue')


              flowchart LR
              task_schema.plugins.base_studio.BasePluginConfig[BasePluginConfig]
              task_schema.plugins.base_studio.BaseConfig[BaseConfig]

                              task_schema.plugins.base_studio.BaseConfig --> task_schema.plugins.base_studio.BasePluginConfig
                


              click task_schema.plugins.base_studio.BasePluginConfig href "" "task_schema.plugins.base_studio.BasePluginConfig"
              click task_schema.plugins.base_studio.BaseConfig href "" "task_schema.plugins.base_studio.BaseConfig"

Configuration for a GwaIO project plugin.

Methods:

  • deserialize –

    Create an instance from a JSON string or dictionary.

  • serialize –

    Convert the configuration into a serializable dictionary.

  • stringify_class –

    Return a JSON-friendly representation of a value.

deserialize classmethod 

deserialize(data: Union[str, Dict[str, Any]]) -> BaseStudioConfig

Create an instance from a JSON string or dictionary.

Parameters:

  • data
    (Union[str, Dict[str, Any]]) –

    JSON string or already parsed dictionary.

Returns:

serialize 

serialize() -> Dict[str, Any]

Convert the configuration into a serializable dictionary.

Returns:

  • dict ( Dict[str, Any] ) –

    Serialized representation of the configuration.

stringify_class classmethod 

stringify_class(value: Any) -> Any

Return a JSON-friendly representation of a value.

Parameters:

  • value
    (Any) –

    Object to convert.

Returns:

  • Any –

    A value that can be serialized by :mod:json.