factories¶
Factory class for registering and creating strategy instances.
Factory wrapper methods for creating the individual strategies.
StrategiesNotLoaded
¶
Bases: Exception
Entry point strategies have not been loaded, run
load_strategies()
.
Source code in oteapi/plugins/factories.py
20 21 22 |
|
StrategyFactory
¶
Decorator-based Factory class.
Attributes:
Name | Type | Description |
---|---|---|
strategy_create_func |
Dict[StrategyType, EntryPointStrategyCollection]
|
An in-memory cache of all registered strategies. |
Source code in oteapi/plugins/factories.py
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 80 81 82 83 84 85 86 87 88 89 90 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 186 187 188 189 |
|
list_loaded_strategies()
classmethod
¶
Lists all loaded strategy plugins (endpoints).
Returns:
Type | Description |
---|---|
dict[StrategyType, list[str]]
|
A dictionary where keys are strategy types and values are lists of |
dict[StrategyType, list[str]]
|
loaded strategy names for each type. |
Raises:
Type | Description |
---|---|
StrategiesNotLoaded
|
If the strategies are not loaded or
|
Source code in oteapi/plugins/factories.py
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 |
|
load_strategies(test_for_uniqueness=True)
classmethod
¶
Load strategies from entry points and store in class attribute.
Important
This is not a cached method. The importlib.metadata API will be re-requested to load the entry points and strategies.
Note
This does not import the actual strategy implementations (classes). It only loads the strategies from the registerred OTE-API entry points.
Raises:
Type | Description |
---|---|
KeyError
|
If |
Parameters:
Name | Type | Description | Default |
---|---|---|---|
test_for_uniqueness |
bool
|
If |
True
|
Source code in oteapi/plugins/factories.py
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 |
|
make_strategy(config, strategy_type)
classmethod
¶
Instantiate a strategy in a context class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
config |
Union[StrategyConfig, dict[str, Any]]
|
A strategy configuration. |
required |
strategy_type |
Union[StrategyType, str]
|
The strategy type, e.g., |
required |
Raises:
Type | Description |
---|---|
NotImplementedError
|
If the strategy cannot be found. |
ValueError
|
If the |
StrategiesNotLoaded
|
If the entry point strategies have not been loaded. |
Returns:
Type | Description |
---|---|
IStrategy
|
An instantiated strategy. The strategy is instantiated with the provided |
IStrategy
|
configuration, through the |
Source code in oteapi/plugins/factories.py
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 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
|
create_strategy(strategy_type, config)
¶
Proxy function for
StrategyFactory.make_strategy()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
strategy_type |
Union[StrategyType, str]
|
A valid strategy type.
See the |
required |
config |
Union[StrategyConfig, dict[str, Any]]
|
A strategy configuration. |
required |
Returns:
Type | Description |
---|---|
IStrategy
|
The created strategy. |
Source code in oteapi/plugins/factories.py
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 |
|
list_strategies()
¶
Proxy function for
StrategyFactory.list_loaded_strategies()
.
Returns:
Type | Description |
---|---|
dict[StrategyType, list[str]]
|
A dictionary where keys are strategy types and values are lists of |
dict[StrategyType, list[str]]
|
loaded strategy names for each type. |
Source code in oteapi/plugins/factories.py
206 207 208 209 210 211 212 213 214 |
|
load_strategies(test_for_uniqueness=True)
¶
Proxy function for
StrategyFactory.load_strategies()
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
test_for_uniqueness |
bool
|
If |
True
|
Source code in oteapi/plugins/factories.py
192 193 194 195 196 197 198 199 200 201 202 203 |
|