arche.rules.result module¶
-
class
arche.rules.result.
Message
(summary: str, detailed: Optional[str] = None, errors: Optional[dict] = None)¶ Bases:
object
- Parameters
summary – a concise outcome
detailed – detailed message
errors – error messages grouped by attributes
-
detailed
= None¶
-
errors
= None¶
-
class
arche.rules.result.
Result
(name: str, messages: Dict[arche.rules.result.Level, List[arche.rules.result.Message]] = <factory>, stats: Optional[List[Union[pandas.core.series.Series, pandas.core.frame.DataFrame]]] = <factory>, items_count: Optional[int] = 0, checked_fields: Optional[List[str]] = <factory>, err_items_count: Optional[int] = 0)¶ Bases:
object
- Parameters
name – a rule name
messages – messages separated by severity
stats – pandas data to plot
items_count – the count of verified items
checked_fields – the names of verified fields
err_items_count – the number of error items
-
add_error
(summary, detailed=None, errors=None)¶
-
add_info
(summary, detailed=None, errors=None)¶
-
add_message
(level: arche.rules.result.Level, summary: str, detailed: Optional[str] = None, errors: Optional[dict] = None)¶
-
add_warning
(summary, detailed=None, errors=None)¶
-
detailed_messages_count
¶
-
err_items_count
= 0¶
-
errors
¶
-
get_detailed_messages_count
()¶
-
get_errors_count
()¶
-
info
¶
-
items_count
= 0¶
-
show
(short: bool = False, keys_limit: int = 10)¶
-
static
tensors_equal
(left: Union[pandas.core.series.Series, pandas.core.frame.DataFrame], right: Union[pandas.core.series.Series, pandas.core.frame.DataFrame])¶
-
warnings
¶