parse_excel¶
Strategy for parsing an Excel spreadsheet to a DLite instance.
DLiteExcelParseConfig
¶
Bases: AttrDict
Configuration for DLite Excel parser.
Source code in oteapi_dlite/strategies/parse_excel.py
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 |
|
excel_config: Annotated[XLSXParseConfig, Field(description='DLite-specific excel configurations.')]
instance-attribute
¶
id: Annotated[Optional[str], Field(description='Optional id on new instance.')] = None
class-attribute
instance-attribute
¶
label: Annotated[Optional[str], Field(description='Optional label for new instance in collection.')] = 'excel-data'
class-attribute
instance-attribute
¶
metadata: Annotated[Optional[HttpUrl], Field(description='URI of DLite metadata to return. If not provided, the metadata will be inferred from the excel file.')] = None
class-attribute
instance-attribute
¶
storage_path: Annotated[Optional[str], Field(description='Path to metadata storage')] = None
class-attribute
instance-attribute
¶
DLiteExcelParseResourceConfig
¶
Bases: ResourceConfig
DLite excel parse strategy resource config.
Source code in oteapi_dlite/strategies/parse_excel.py
67 68 69 70 71 72 73 |
|
configuration: Annotated[DLiteExcelParseConfig, Field(description='DLite excel parse strategy-specific configuration.')]
instance-attribute
¶
DLiteExcelSessionUpdate
¶
Bases: DLiteSessionUpdate
Class for returning values from DLite excel parser.
Source code in oteapi_dlite/strategies/parse_excel.py
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
|
DLiteExcelStrategy
¶
Parse strategy for Excel files.
Registers strategies:
("mediaType", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
Source code in oteapi_dlite/strategies/parse_excel.py
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 |
|
parse_config: DLiteExcelParseResourceConfig
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 |
---|---|
DLiteExcelSessionUpdate
|
DLite instance. |
Source code in oteapi_dlite/strategies/parse_excel.py
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 |
|
initialize(session=None)
¶
Initialize.
Source code in oteapi_dlite/strategies/parse_excel.py
106 107 108 109 110 111 |
|
infer_metadata(rec, units)
¶
Infer dlite metadata from recarray rec
.
Source code in oteapi_dlite/strategies/parse_excel.py
181 182 183 184 185 186 187 188 189 190 191 192 193 194 |
|
split_column_name(column)
¶
Split column name into a (name, unit) tuple.
Source code in oteapi_dlite/strategies/parse_excel.py
172 173 174 175 176 177 178 |
|