API Reference
_engine.py
Module implementing the rules engine.
Class: RulesEngine
RulesEngine
The Rules Engine is in charge of executing different groups of rules of a given rule set on user input data.
Attributes:
Name | Type | Description |
---|---|---|
rules |
dict[str, dict[str, list[Rule]]]
|
A dictionary of rules with k: rule set, v: (k: rule group, v: list of rule instances). |
Source code in arta/_engine.py
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 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 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
|
__init__(*, rules_dict=None, config_path=None, config_dict=None)
Initialize the rules.
3 possibilities: either one of 'rules_dict', or 'config_path', or 'config_dict'.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
rules_dict |
dict[str, dict[str, Any]] | None
|
A dictionary containing the rules' definitions. |
None
|
config_path |
str | None
|
Path of a directory containing the YAML files. |
None
|
config_dict |
dict[str, Any] | None
|
A dictionary containing the configuration (same as YAML files but already parsed in a dictionary). |
None
|
Raises:
Type | Description |
---|---|
KeyError
|
Key not found. |
TypeError
|
Wrong type. |
ValueError
|
Bad given parameters. |
Source code in arta/_engine.py
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 |
|
__str__()
Object human string representation (called by str()).
Returns:
Type | Description |
---|---|
str
|
A string representation of the instance. |
Source code in arta/_engine.py
apply_rules(input_data, *, rule_set=None, ignored_rules=None, verbose=False, **kwargs)
Apply the rules and return results.
For each rule group of a given rule set, rules are applied sequentially, The loop is broken when a rule is applied (an action is triggered). Then, the next rule group is evaluated. And so on...
This means that the order of the rules in the configuration file (e.g., rules.yaml) is meaningful.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
input_data |
dict[str, Any]
|
Input data to apply rules on. |
required |
rule_set |
str | None
|
Apply rules associated with the specified rule set. |
None
|
ignored_rules |
set[str] | None
|
A set/list of rule's ids to be ignored/disabled during evaluation. |
None
|
verbose |
bool
|
If True, add extra ids (group_id, rule_id) for result explicability. |
False
|
**kwargs |
Any
|
For user extra arguments. |
{}
|
Returns:
Type | Description |
---|---|
dict[str, Any]
|
A dictionary containing the rule groups' results (k: group id, v: action result). |
Raises:
Type | Description |
---|---|
TypeError
|
Wrong type (e.g., input_data is not a dictionary). |
KeyError
|
Key not found (e.g., input_data is an empty dictionary). |
RuleExecutionError
|
A rule fails during execution. |
ConditionExecutionError
|
A condition fails during execution. |
Source code in arta/_engine.py
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 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 |
|
condition.py
Condition implementation.
Classes: BaseCondition, StandardCondition, SimpleCondition
BaseCondition
Bases: ABC
Base class of a Condition object (Strategy Pattern).
Is an abstract class and can't be instantiated.
Attributes:
Name | Type | Description |
---|---|---|
condition_id |
Id of a condition. |
|
description |
Description of a condition. |
|
validation_function |
Validation function of a condition. |
|
validation_function_parameters |
Arguments of the validation function. |
Source code in arta/condition.py
__init__(condition_id, description, validation_function=None, validation_function_parameters=None)
Initialize attributes.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
condition_id |
str
|
Id of a condition. |
required |
description |
str
|
Description of a condition. |
required |
validation_function |
Callable | None
|
Validation function of a condition. |
None
|
validation_function_parameters |
dict[str, Any] | None
|
Arguments of the validation function. |
None
|
Source code in arta/condition.py
extract_condition_ids_from_expression(condition_expr=None)
classmethod
Get the condition ids from a string (e.g., UPPERCASE words).
E.g., CONDITION_1 and not CONDITION_2
Warning: implementation is based on the current class constant CONDITION_SPLIT_PATTERN.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
condition_expr |
str | None
|
A boolean expression (string). |
None
|
Returns:
Type | Description |
---|---|
set[str]
|
A set of extracted condition ids. |
Source code in arta/condition.py
get_sanitized_id()
Return the sanitized (regex) condition id.
E.g., 'CONDITION_2' --> '\bCONDITION_2\b'
Returns:
Type | Description |
---|---|
str
|
A sanitized regex pattern string. |
verify(input_data, parsing_error_strategy, **kwargs)
abstractmethod
(Abstract) Return True if the condition is verified.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
input_data |
dict[str, Any]
|
Input data to apply rules on. |
required |
parsing_error_strategy |
ParsingErrorStrategy
|
Error handling strategy for parameter parsing. |
required |
**kwargs |
Any
|
For user extra arguments. |
{}
|
Returns:
Type | Description |
---|---|
bool
|
True if the condition is verified, otherwise False. |
Source code in arta/condition.py
SimpleCondition
Bases: BaseCondition
Class implementing a built-in simple condition.
Attributes:
Name | Type | Description |
---|---|---|
condition_id |
Id of a condition. |
|
description |
Description of a condition. |
|
validation_function |
Validation function of a condition. |
|
validation_function_parameters |
Arguments of the validation function. |
Source code in arta/condition.py
get_sanitized_id()
Return the sanitized (regex) condition id.
E.g., 'input.power=="fly"' --> 'input.power==\"fly\"'
Returns:
Type | Description |
---|---|
str
|
A sanitized regex pattern string. |
verify(input_data, parsing_error_strategy, **kwargs)
Return True if the condition is verified.
Example of a unitary simple condition to be verified: 'input.age>=100'
Parameters:
Name | Type | Description | Default |
---|---|---|---|
input_data |
dict[str, Any]
|
Request or input data to apply rules on. |
required |
parsing_error_strategy |
ParsingErrorStrategy
|
Error handling strategy for parameter parsing. |
required |
**kwargs |
Any
|
For user extra arguments. |
{}
|
Returns:
Type | Description |
---|---|
bool
|
True if the condition is verified, otherwise False. |
Raises:
Type | Description |
---|---|
AttributeError
|
Check the validation function or its parameters. |
Source code in arta/condition.py
StandardCondition
Bases: BaseCondition
Class implementing a built-in condition, named standard condition.
Attributes:
Name | Type | Description |
---|---|---|
condition_id |
Id of a condition. |
|
description |
Description of a condition. |
|
validation_function |
Validation function of a condition. |
|
validation_function_parameters |
Arguments of the validation function. |
Source code in arta/condition.py
verify(input_data, parsing_error_strategy, **kwargs)
Return True if the condition is verified.
Example of a unitary standard condition: CONDITION_1
Parameters:
Name | Type | Description | Default |
---|---|---|---|
input_data |
dict[str, Any]
|
Request or input data to apply rules on. |
required |
parsing_error_strategy |
ParsingErrorStrategy
|
Error handling strategy for parameter parsing. |
required |
**kwargs |
Any
|
For user extra arguments. |
{}
|
Returns:
Type | Description |
---|---|
bool
|
True if the condition is verified, otherwise False. |
Raises:
Type | Description |
---|---|
AttributeError
|
Check the validation function or its parameters. |