parse¶
Generic parse strategy using DLite storage plugin.
DLiteParseConfig
¶
Bases: AttrDict
Configuration for generic DLite parser.
Source code in oteapi_dlite/strategies/parse.py
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 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 68 69 70 71 72 73 74 75 76 77 78 79 |
|
datacache_config: Annotated[Optional[DataCacheConfig], Field(description='Configuration options for the local data cache.')] = None
class-attribute
instance-attribute
¶
datamodel: Annotated[Optional[str], Field(description='DLite datamodel documenting the structure of the data set. Often unused, since the datamodel is implicitly defined in the DLite driver (DLite plugin), but for a documentation point of view this is a very important field.')] = None
class-attribute
instance-attribute
¶
driver: Annotated[str, Field(description='Name of DLite driver (ex: "json").')]
instance-attribute
¶
id: Annotated[Optional[str], Field(description='If given, the id of the instance in the storage.')] = None
class-attribute
instance-attribute
¶
label: Annotated[Optional[str], Field(description='Optional label of the new DLite instance in the collection.')] = None
class-attribute
instance-attribute
¶
location: Annotated[Optional[str], Field(description="Explicit location of storage. Normally data is read from the data cache using `datacache_config.accessKey` (default: 'key').")] = None
class-attribute
instance-attribute
¶
options: Annotated[Optional[str], Field(description='Comma-separated list of options passed to the DLite storage plugin.')] = None
class-attribute
instance-attribute
¶
DLiteParseResourceConfig
¶
Bases: ResourceConfig
DLite parse strategy resource config.
Source code in oteapi_dlite/strategies/parse.py
82 83 84 85 86 87 88 |
|
configuration: Annotated[DLiteParseConfig, Field(description='DLite parse strategy-specific configuration.')]
instance-attribute
¶
DLiteParseStrategy
¶
Generic DLite parse strategy utilising DLite storage plugins.
Registers strategies:
("mediaType", "application/vnd.dlite-parse")
Source code in oteapi_dlite/strategies/parse.py
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
|
parse_config: DLiteParseResourceConfig
instance-attribute
¶
get(session=None)
¶
Execute the strategy.
This method will be called through the strategy-specific endpoint of the OTE-API Services.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session
|
Optional[dict[str, Any]]
|
A session-specific dictionary context. |
None
|
Returns:
Type | Description |
---|---|
DLiteSessionUpdate
|
SessionUpdate instance. |
Source code in oteapi_dlite/strategies/parse.py
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 |
|
initialize(session=None)
¶
Initialize.
Source code in oteapi_dlite/strategies/parse.py
103 104 105 106 107 108 |
|