simplibs-rules 0.2.1__tar.gz → 0.3.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (163) hide show
  1. {simplibs_rules-0.2.1/src/simplibs_rules.egg-info → simplibs_rules-0.3.0}/PKG-INFO +79 -36
  2. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/README.md +367 -324
  3. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/pyproject.toml +3 -3
  4. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/__init__.py +17 -8
  5. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/base_class/Rule.py +94 -10
  6. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/base_class/__init__.py +17 -17
  7. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/AllOf.py +34 -2
  8. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/AnyOf.py +33 -6
  9. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/Compose.py +26 -1
  10. simplibs_rules-0.3.0/src/simplibs/rules/containers/Described.py +122 -0
  11. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/ForEach.py +25 -1
  12. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/NoneOf.py +20 -0
  13. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/Not.py +25 -0
  14. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/__init__.py +29 -27
  15. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/_helpers/__init__.py +21 -21
  16. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/_helpers/as_predicate.py +1 -1
  17. simplibs_rules-0.3.0/src/simplibs/rules/containers/_helpers/describe_rule.py +102 -0
  18. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/arithmetic/CloseTo.py +16 -0
  19. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/arithmetic/DivisibleBy.py +16 -0
  20. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/arithmetic/HasRemainder.py +16 -0
  21. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/checkers/IsEmpty.py +16 -0
  22. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/checkers/IsFalse.py +16 -0
  23. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/checkers/IsNone.py +16 -0
  24. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/checkers/IsTrue.py +16 -0
  25. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/checkers/NotEmpty.py +16 -0
  26. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/collections/AllUnique.py +16 -0
  27. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/collections/HasItem.py +146 -130
  28. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/collections/HasKey.py +16 -0
  29. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/collections/HasKeys.py +16 -0
  30. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/collections/IsContainer.py +16 -0
  31. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/collections/IsSubsetOf.py +23 -0
  32. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/collections/IsSupersetOf.py +23 -0
  33. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/comparisons/Equals.py +16 -0
  34. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/comparisons/GreaterOrEqual.py +16 -0
  35. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/comparisons/GreaterThan.py +16 -0
  36. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/comparisons/InRange.py +27 -3
  37. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/comparisons/LessOrEqual.py +16 -0
  38. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/comparisons/LessThan.py +16 -0
  39. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/comparisons/NotEquals.py +16 -0
  40. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/introspection/HasAttribute.py +16 -0
  41. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/introspection/HasLength.py +30 -10
  42. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/introspection/IsCallable.py +16 -0
  43. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/introspection/IsDataclass.py +16 -0
  44. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/introspection/IsHashable.py +16 -0
  45. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/introspection/IsInstance.py +26 -0
  46. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/introspection/IsIterable.py +16 -0
  47. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/introspection/IsSubclass.py +16 -0
  48. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/introspection/IsType.py +16 -0
  49. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/logic/Is.py +15 -0
  50. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/logic/IsIn.py +29 -3
  51. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/logic/IsNot.py +15 -0
  52. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/logic/NotIn.py +27 -3
  53. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/logic/UserRule.py +134 -117
  54. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/numeric/IsBool.py +111 -95
  55. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/numeric/IsDecimal.py +16 -0
  56. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/numeric/IsEven.py +16 -0
  57. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/numeric/IsFinite.py +16 -0
  58. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/numeric/IsFloat.py +16 -0
  59. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/numeric/IsInfinity.py +16 -0
  60. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/numeric/IsInteger.py +16 -0
  61. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/numeric/IsNan.py +16 -0
  62. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/numeric/IsNumber.py +16 -0
  63. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/numeric/IsOdd.py +16 -0
  64. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/numeric/IsPi.py +16 -0
  65. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/numeric/IsPrimitiveNumber.py +16 -0
  66. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/numeric/IsZero.py +16 -0
  67. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/Contains.py +16 -0
  68. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/EndsWith.py +16 -0
  69. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/IsAlnum.py +16 -0
  70. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/IsAlpha.py +16 -0
  71. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/IsAscii.py +16 -0
  72. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/IsBlank.py +16 -0
  73. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/IsDigitString.py +16 -0
  74. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/IsIdentifier.py +115 -99
  75. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/IsLowercase.py +16 -0
  76. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/IsPrintable.py +114 -98
  77. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/IsString.py +119 -103
  78. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/IsSubstringOf.py +129 -113
  79. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/IsTitlecase.py +16 -0
  80. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/IsUppercase.py +16 -0
  81. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/IsWhitespace.py +114 -98
  82. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/NotBlank.py +16 -0
  83. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/Regex.py +16 -0
  84. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/StartsWith.py +16 -0
  85. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/IsAny.py +130 -113
  86. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/IsTyping.py +116 -99
  87. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/_builders/build_annotated_rule.py +123 -105
  88. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/_builders/build_any_of_rule.py +79 -72
  89. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/_builders/build_key_value_rule.py +0 -1
  90. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/_builders/build_literal_rule.py +0 -1
  91. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/_builders/build_tuple_rule.py +117 -110
  92. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/_builders/build_type_rule.py +113 -113
  93. simplibs_rules-0.3.0/src/simplibs/rules/predicates/typing/_helpers/__init__.py +17 -0
  94. simplibs_rules-0.3.0/src/simplibs/rules/predicates/typing/_helpers/format_annotation.py +146 -0
  95. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/build_typing_rule.py +174 -130
  96. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/testing/__init__.py +43 -37
  97. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/testing/assert_rule_contract.py +91 -13
  98. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/testing/asserts/__init__.py +29 -24
  99. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/testing/asserts/assert_rule_build_exception.py +60 -14
  100. simplibs_rules-0.3.0/src/simplibs/rules/testing/asserts/assert_rule_describe.py +76 -0
  101. simplibs_rules-0.3.0/src/simplibs/rules/testing/asserts/assert_rule_slots.py +67 -0
  102. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/testing/asserts/assert_rule_validate.py +1 -1
  103. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0/src/simplibs_rules.egg-info}/PKG-INFO +79 -36
  104. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs_rules.egg-info/SOURCES.txt +5 -0
  105. simplibs_rules-0.3.0/src/simplibs_rules.egg-info/requires.txt +5 -0
  106. simplibs_rules-0.2.1/src/simplibs/rules/containers/_helpers/describe_rule.py +0 -72
  107. simplibs_rules-0.2.1/src/simplibs_rules.egg-info/requires.txt +0 -5
  108. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/LICENSE +0 -0
  109. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/setup.cfg +0 -0
  110. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/base_class/_NotARule.py +0 -0
  111. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/_helpers/build_child_exception.py +0 -0
  112. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/_helpers/validations/__init__.py +0 -0
  113. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/_helpers/validations/raise_invalid_predicate.py +0 -0
  114. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/_init_validators/__init__.py +0 -0
  115. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/_init_validators/raise_container_param_not_type_error.py +0 -0
  116. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/_init_validators/raise_requires_at_least_one_rule_error.py +0 -0
  117. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/_init_validators/raise_rule_param_not_callable.py +0 -0
  118. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/containers/_init_validators/validate_compose_param_is_callable.py +0 -0
  119. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/__init__.py +0 -0
  120. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_helpers/__init__.py +0 -0
  121. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_helpers/accepts_one_positional_argument.py +0 -0
  122. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_helpers/format_container.py +0 -0
  123. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/__init__.py +0 -0
  124. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/rule_errors/__init__.py +0 -0
  125. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/rule_errors/raise_has_length_param_conflict_error.py +0 -0
  126. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/rule_errors/raise_regex_param_invalid_pattern_error.py +0 -0
  127. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/rule_errors/raise_user_rule_param_wrong_arity.py +0 -0
  128. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/shared_errors/__init__.py +0 -0
  129. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/shared_errors/raise_param_min_max_bounds_inverted_error.py +0 -0
  130. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/shared_errors/raise_param_min_max_incomparable_error.py +0 -0
  131. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/shared_errors/raise_param_missing_error.py +0 -0
  132. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/shared_errors/raise_param_not_callable_error.py +0 -0
  133. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/shared_errors/raise_param_not_container_error.py +0 -0
  134. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/shared_errors/raise_param_not_non_negative_integer_error.py +0 -0
  135. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/shared_errors/raise_param_not_string_error.py +0 -0
  136. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/shared_errors/raise_param_not_type_error.py +0 -0
  137. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/shared_validators/__init__.py +0 -0
  138. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/shared_validators/validate_param_is_integer.py +0 -0
  139. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/shared_validators/validate_param_is_not_zero.py +0 -0
  140. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/shared_validators/validate_param_is_primitive_number.py +0 -0
  141. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/_init_validators/shared_validators/validate_param_remainder_in_range.py +0 -0
  142. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/arithmetic/__init__.py +0 -0
  143. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/checkers/__init__.py +0 -0
  144. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/collections/__init__.py +0 -0
  145. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/comparisons/__init__.py +0 -0
  146. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/introspection/__init__.py +0 -0
  147. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/logic/__init__.py +0 -0
  148. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/numeric/__init__.py +0 -0
  149. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/strings/__init__.py +0 -0
  150. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/__init__.py +0 -0
  151. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/_builders/ORIGIN_TABLE.py +0 -0
  152. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/_builders/__init__.py +0 -0
  153. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/_builders/build_callable_rule.py +0 -0
  154. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/_builders/build_elements_rule.py +0 -0
  155. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/_validations/__init__.py +0 -0
  156. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/_validations/raise_unsupported_annotation_error.py +0 -0
  157. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/tools/__init__.py +0 -0
  158. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/tools/get_supported_origins.py +0 -0
  159. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/predicates/typing/tools/is_supported_annotation.py +0 -0
  160. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/testing/asserts/assert_rule_is_valid.py +0 -0
  161. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs/rules/testing/asserts/assert_rule_param_error.py +0 -0
  162. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs_rules.egg-info/dependency_links.txt +0 -0
  163. {simplibs_rules-0.2.1 → simplibs_rules-0.3.0}/src/simplibs_rules.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: simplibs-rules
3
- Version: 0.2.1
3
+ Version: 0.3.0
4
4
  Summary: Composable, explicit validation rules — pure predicates, zero transformation.
5
5
  Author-email: "Dalibor Sova (Sudip2708)" <daliborsova@seznam.cz>
6
6
  License-Expression: MIT
@@ -20,8 +20,8 @@ Classifier: Topic :: Software Development :: Testing
20
20
  Requires-Python: >=3.11
21
21
  Description-Content-Type: text/markdown
22
22
  License-File: LICENSE
23
- Requires-Dist: simplibs-exception>=1.1.2
24
- Requires-Dist: simplibs-sentinels>=0.1.0
23
+ Requires-Dist: simplibs-exception>=1.1.3
24
+ Requires-Dist: simplibs-sentinels>=0.2.0
25
25
  Provides-Extra: dev
26
26
  Requires-Dist: pytest>=7.0; extra == "dev"
27
27
  Dynamic: license-file
@@ -134,27 +134,42 @@ typing_rule.is_valid({"apples": 5, "oranges": 10}) # -> True
134
134
  typing_rule.is_valid({"apples": "5"}) # -> False
135
135
  ```
136
136
 
137
+ ### Level 4: Readable descriptions
138
+
139
+ Every rule can say what it requires in a few words, and containers and annotations
140
+ compose those texts — so a failure names what was expected instead of class names:
141
+
142
+ ```python
143
+ rule = IsTyping(list[int] | set[int] | str)
144
+
145
+ rule.describe() # -> "list[int] | set[int] | str"
146
+ (is_integer & greater_than(0)).describe() # -> "int & > 0"
147
+
148
+ rule.validate(["a"], value_name="payload")
149
+ # Expected: value satisfying at least one of: list[int], set[int], str
150
+ ```
151
+
137
152
  ---
138
153
 
139
154
  ## 🛠️ Architecture & Package Structure
140
155
 
141
156
  ```
142
157
  src/simplibs/rules/
143
- ├── base_class/ ◄── Abstract base class Rule & internal helpers (_NotARule)
158
+ ├── base_class/ ◄── Abstract base class Rule & internal helpers (_NotARule)
144
159
  │ ├── Rule.py
145
160
  │ └── _NotARule.py
146
- ├── containers/ ◄── Rule combinators (AllOf, AnyOf, Not, NoneOf, ForEach, Compose)
147
- ├── predicates/ ◄── Single-purpose predicate rules
148
- │ ├── arithmetic/ ◄── CloseTo, DivisibleBy, HasRemainder
149
- │ ├── checkers/ ◄── IsEmpty, NotEmpty, IsNone, IsTrue, IsFalse
150
- │ ├── collections/ ◄── IsContainer, HasItem, HasKey, HasKeys, AllUnique, IsSubsetOf, IsSupersetOf
151
- │ ├── comparisons/ ◄── Equals, NotEquals, GreaterThan, GreaterOrEqual, LessThan, LessOrEqual, InRange
152
- │ ├── introspection/ ◄── IsInstance, IsType, IsSubclass, IsDataclass, IsCallable, IsHashable, IsIterable, HasAttribute, HasLength
153
- │ ├── logic/ ◄── Is, IsNot, IsIn, NotIn, UserRule
154
- │ ├── numeric/ ◄── IsBool, IsInteger, IsFloat, IsDecimal, IsNumber, IsPrimitiveNumber, IsZero, IsNan, IsInfinity, IsPi
155
- │ ├── strings/ ◄── IsString, Contains, IsSubstringOf, StartsWith, EndsWith, Regex, IsBlank, NotBlank
156
- │ └── typing/ ◄── Annotation-driven evaluation (IsAny, IsTyping, build_typing_rule)
157
- └── testing/ ◄── Testing contracts for Rule implementations
161
+ ├── containers/ ◄── Rule combinators (AllOf, AnyOf, Not, NoneOf, ForEach, Compose, Described)
162
+ ├── predicates/ ◄── Single-purpose predicate rules
163
+ │ ├── arithmetic/ ◄── CloseTo, DivisibleBy, HasRemainder
164
+ │ ├── checkers/ ◄── IsEmpty, NotEmpty, IsNone, IsTrue, IsFalse
165
+ │ ├── collections/ ◄── IsContainer, HasItem, HasKey, HasKeys, AllUnique, IsSubsetOf, IsSupersetOf
166
+ │ ├── comparisons/ ◄── Equals, NotEquals, GreaterThan, GreaterOrEqual, LessThan, LessOrEqual, InRange
167
+ │ ├── introspection/ ◄── IsInstance, IsType, IsSubclass, IsDataclass, IsCallable, IsHashable, IsIterable, HasAttribute, HasLength
168
+ │ ├── logic/ ◄── Is, IsNot, IsIn, NotIn, UserRule
169
+ │ ├── numeric/ ◄── IsBool, IsInteger, IsFloat, IsDecimal, IsNumber, IsPrimitiveNumber, IsZero, IsNan, IsInfinity, IsPi, IsEven, IsOdd, IsFinite
170
+ │ ├── strings/ ◄── IsString, Contains, IsSubstringOf, StartsWith, EndsWith, Regex, IsBlank, NotBlank, IsAlnum, IsAlpha, IsAscii, IsDigitString, IsLowercase, IsTitlecase, IsUppercase, IsIdentifier, IsPrintable, IsWhitespace
171
+ │ └── typing/ ◄── Annotation-driven evaluation (IsAny, IsTyping, build_typing_rule)
172
+ └── testing/ ◄── Testing contracts for Rule implementations
158
173
  └── assert_rule_contract.py
159
174
  ```
160
175
 
@@ -168,6 +183,7 @@ capabilities out of the box.
168
183
 
169
184
  ```python
170
185
  class Rule(ABC):
186
+ __slots__ = ()
171
187
 
172
188
  @abstractmethod
173
189
  def is_valid(self, value: Any) -> bool:
@@ -206,6 +222,10 @@ class Rule(ABC):
206
222
 
207
223
  raise self.build_exception(value, value_name=value_name, context=context)
208
224
 
225
+ def describe(self) -> str:
226
+ """Return a short, human-readable description of what this rule requires."""
227
+ return type(self).__name__
228
+
209
229
  def annotated(self, type_: type) -> Any:
210
230
  """Wrap this rule as `typing.Annotated[type_, self]` for type hints."""
211
231
  return Annotated[type_, self]
@@ -237,27 +257,49 @@ Both are fully interchangeable.
237
257
 
238
258
  ### `containers/` — Composing other rules
239
259
 
240
- | Class | Shortcut | Description / Parameters |
241
- |-----------|------------|----------------------------------------------------------------|
242
- | `AllOf` | `all_of` | Logical AND across multiple rules (`*rules`). Behind `&`. |
243
- | `AnyOf` | `any_of` | Logical OR across multiple rules (`*rules`). Behind `\|`. |
244
- | `Compose` | `compose` | Transforms value before checking (`transformer, validator`). |
245
- | `ForEach` | `for_each` | Validates every item in an iterable (`rule`). |
246
- | `NoneOf` | `none_of` | Value must satisfy none of the given rules (`*rules`). |
247
- | `Not` | `negate` | Logical NOT for a single rule (`rule`). Behind `~`. |
260
+ | Class | Shortcut | Description / Parameters |
261
+ |-------------|-------------|---------------------------------------------------------------------------------------|
262
+ | `AllOf` | `all_of` | Logical AND across multiple rules (`*rules`). Behind `&`. |
263
+ | `AnyOf` | `any_of` | Logical OR across multiple rules (`*rules`). Behind `\|`. |
264
+ | `Compose` | `compose` | Transforms value before checking (`transformer, validator`). |
265
+ | `ForEach` | `for_each` | Validates every item in an iterable (`rule`). |
266
+ | `NoneOf` | `none_of` | Value must satisfy none of the given rules (`*rules`). |
267
+ | `Not` | `negate` | Logical NOT for a single rule (`rule`). Behind `~`. |
268
+ | `Described` | - | Behaves like the wrapped rule, but describes itself with a fixed text (`rule, text`). |
248
269
 
249
270
  ➡️ [README_RULE_CONTAINERS](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_CONTAINERS.md)
250
271
 
251
272
  ### `predicates/` — Atomic predicates
252
273
 
253
- * **`arithmetic/`**: `CloseTo`, `DivisibleBy`, `HasRemainder` — [README](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_ARITHMETIC.md)
254
- * **`checkers/`**: `IsEmpty`, `NotEmpty`, `IsNone`, `IsTrue`, `IsFalse` — [README](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_CHECKERS.md)
255
- * **`collections/`**: `IsContainer`, `HasItem`, `HasKey`, `HasKeys`, `AllUnique`, `IsSubsetOf`, `IsSupersetOf` — [README](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_COLLECTIONS.md)
256
- * **`comparisons/`**: `Equals`, `NotEquals`, `GreaterThan`, `GreaterOrEqual`, `LessThan`, `LessOrEqual`, `InRange` — [README](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_COMPARISONS.md)
257
- * **`introspection/`**: `IsInstance`, `IsType`, `IsSubclass`, `IsDataclass`, `IsCallable`, `IsHashable`, `IsIterable`, `HasAttribute`, `HasLength` — [README](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_INTROSPECTION.md)
258
- * **`logic/`**: `Is`, `IsNot`, `IsIn`, `NotIn`, `UserRule` — [README](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_LOGIC.md)
259
- * **`numeric/`**: `IsBool`, `IsInteger`, `IsFloat`, `IsDecimal`, `IsNumber`, `IsPrimitiveNumber`, `IsZero`, `IsNan`, `IsInfinity`, `IsPi` — [README](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_NUMERIC.md)
260
- * **`strings/`**: `IsString`, `Contains`, `IsSubstringOf`, `StartsWith`, `EndsWith`, `Regex`, `IsBlank`, `NotBlank` — [README](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_STRINGS.md)
274
+ * **`arithmetic/`**: `CloseTo`, `DivisibleBy`, `HasRemainder`
275
+ [README_RULE_PREDICATE_ARITHMETIC](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_ARITHMETIC.md)
276
+
277
+ * **`checkers/`**: `IsEmpty`, `NotEmpty`, `IsNone`, `IsTrue`, `IsFalse`
278
+ [README_RULE_PREDICATE_CHECKERS](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_CHECKERS.md)
279
+
280
+ * **`collections/`**: `IsContainer`, `HasItem`, `HasKey`, `HasKeys`, `AllUnique`,
281
+ `IsSubsetOf`, `IsSupersetOf`
282
+ [README_RULE_PREDICATE_COLLECTIONS](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_COLLECTIONS.md)
283
+
284
+ * **`comparisons/`**: `Equals`, `NotEquals`, `GreaterThan`, `GreaterOrEqual`,
285
+ `LessThan`, `LessOrEqual`, `InRange`
286
+ [README_RULE_PREDICATE_COMPARISONS](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_COMPARISONS.md)
287
+
288
+ * **`introspection/`**: `IsInstance`, `IsType`, `IsSubclass`, `IsDataclass`,
289
+ `IsCallable`, `IsHashable`, `IsIterable`, `HasAttribute`, `HasLength`
290
+ [README_RULE_PREDICATE_INTROSPECTION](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_INTROSPECTION.md)
291
+
292
+ * **`logic/`**: `Is`, `IsNot`, `IsIn`, `NotIn`, `UserRule`
293
+ [README_RULE_PREDICATE_LOGIC](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_LOGIC.md)
294
+
295
+ * **`numeric/`**: `IsBool`, `IsInteger`, `IsFloat`, `IsDecimal`, `IsNumber`,
296
+ `IsPrimitiveNumber`, `IsZero`, `IsNan`, `IsInfinity`, `IsPi`, `IsEven`, `IsOdd`, `IsFinite`
297
+ [README_RULE_PREDICATE_NUMERIC](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_NUMERIC.md)
298
+
299
+ * **`strings/`**: `IsString`, `Contains`, `IsSubstringOf`, `StartsWith`, `EndsWith`,
300
+ `Regex`, `IsBlank`, `NotBlank`, `IsAlnum`, `IsAlpha`, `IsAscii`, `IsDigitString`,
301
+ `IsLowercase`, `IsTitlecase`, `IsUppercase`, `IsIdentifier`, `IsPrintable`, `IsWhitespace`
302
+ [README_RULE_PREDICATE_STRINGS](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_PREDICATE_STRINGS.md)
261
303
 
262
304
  ### `predicates/typing/` — Annotation-driven evaluation
263
305
 
@@ -271,7 +313,7 @@ Both are fully interchangeable.
271
313
  int] | None`, `Literal[...]`, `Callable[...]`, ...) into a composed `Rule` tree — the
272
314
  mechanism that also powers `simplibs-validate`'s `validate_call`/`validate_dataclass`.
273
315
 
274
- ➡️ [README_RULE_TYPING](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_TYPING.md) — the public `IsTyping`/`build_typing_rule` entry points
316
+ ➡️ [README_RULE_TYPING](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_TYPING.md) — the public `IsTyping`/`build_typing_rule` entry points
275
317
  ➡️ [README_RULE_TYPING_BUILDERS](https://github.com/simplibs/simplibs-rules/blob/main/docs/rules/README_RULE_TYPING_BUILDERS.md) — the internal per-construct decomposition engine
276
318
 
277
319
  ---
@@ -281,8 +323,9 @@ mechanism that also powers `simplibs-validate`'s `validate_call`/`validate_datac
281
323
  `simplibs-rules` includes its own contract testing tools to ensure custom or existing `Rule`
282
324
  implementations strictly follow all rules and return modes:
283
325
 
284
- assert_rule_contract: Verifies is_valid, direct calling, validate() matrix, return modes,
285
- and exception generation consistency for any Rule instance.
326
+ assert_rule_contract: Verifies is_valid, direct calling, the validate() matrix and return
327
+ modes, exception generation consistency, the describe() text contract and `__slots__`
328
+ integrity — plus, optionally, the constructor's `ParamError` guard — for any Rule instance.
286
329
 
287
330
  ➡️ [README_TESTING_ASSERTS_RULE_CONTRACT](https://github.com/simplibs/simplibs-rules/blob/main/docs/testing/README_TESTING_ASSERTS_RULE_CONTRACT.md)
288
331
 
@@ -303,7 +346,7 @@ on top of the same mechanism for the higher-level entry points (`validate()`,
303
346
  * **[`simplibs-validate`](https://pypi.org/project/simplibs-validate/)** — the `validate()`
304
347
  entry point, ready-made validate_* wrappers, operational tools (raise_invalid, validated_type),
305
348
  and self-validating decorators (validate_call, validate_dataclass) built on top of Rule.
306
- * **`simplibs-types`** *(in progress)* — reusable, named validated types (`Annotated[type,
349
+ * **`simplibs-types`** — reusable, named validated types (`Annotated[type,
307
350
  Rule]` combinations) built on `Rule`, for sharing a single constraint definition across
308
351
  many annotations.
309
352