validatedata 0.3.0__tar.gz → 0.4.0__tar.gz

{validatedata-0.3.0/validatedata.egg-info → validatedata-0.4.0}/PKG-INFO

@@ -1,12 +1,13 @@
 Metadata-Version: 2.4
 Name: validatedata
-Version: 0.3.0
+Version: 0.4.0
 Summary: An easier way to validate data in python
 Author-email: Edward Kigozi <edwardinbytes@gmail.com>
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/Edward-K1/validatedata
 Project-URL: Repository, https://github.com/Edward-K1/validatedata.git
 Project-URL: Issues, https://github.com/Edward-K1/validatedata/issues
+Project-URL: Documentation, https://validatedata.readthedocs.io
 Keywords: validate,data,validation
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
@@ -37,6 +38,7 @@ pip install phonenumbers
 ```
 
 ---
+📖 **[Read the full documentation](https://validatedata.readthedocs.io)**
 
 ## Quick Start
 
@@ -44,11 +46,11 @@ pip install phonenumbers
 from validatedata import validate_data
 
 # with shorthand
-rule={'keys': {
+rule={
     'username': 'str|min:3|max:32',
     'email': 'email',
     'age': 'int|min:18',
-}}
+}
 
 
 result = validate_data(
@@ -62,14 +64,14 @@ else:
     print(result.errors)
 ```
 
-> **Python 3.7+:** For simple cases you can omit the `keys` wrapper and pass a bare field map directly:
+> With the  `keys` wrapper
 >
 > ```python
-> rule = {
+> rule = {'keys': {
 >     'username': 'str|min:3|max:32',
 >     'email': 'email',
 >     'age': 'int|min:18',
-> }
+> }}
 > ```
 >
 > The `keys` form is recommended when you need to pair field rules with top-level options (such as `strict_keys` in a future release).
@@ -789,6 +791,38 @@ result = validate_data(
 result.errors  # ['company.address.postcode: value is not of required length']
 ```
 
+**Mirror-structure shorthand (0.4.0+):**
+
+Instead of wrapping every nested dict in `{'type': 'dict', 'fields': {...}}`, you can write a rule that mirrors the shape of your data:
+```python
+data = {
+    'app': {
+        'name':    'QuickScript',
+        'version': '1.0.0',
+    }
+}
+
+# before — explicit form
+rule = {'keys': {
+    'app': {
+        'type': 'dict',
+        'fields': {
+            'name':    {'type': 'str', 'range': (3, 'any')},
+            'version': {'type': 'semver'},
+        }
+    }
+}}
+
+# after — rule mirrors the data
+rule = {
+    'app': {
+        'name':    'str|min:3',
+        'version': 'semver',
+    }
+}
+```
+
+Error paths are identical in both forms. Nesting can go up to **100 levels** deep — exceeding this raises a `ValueError`. See the [mirror-rules guide](https://validatedata.readthedocs.io/en/latest/mirror-rules.html) for the full reference.
 **List of typed items:**
 
 ```python

validatedata-0.3.0/PKG-INFO → validatedata-0.4.0/README.md

@@ -1,21 +1,3 @@
-Metadata-Version: 2.4
-Name: validatedata
-Version: 0.3.0
-Summary: An easier way to validate data in python
-Author-email: Edward Kigozi <edwardinbytes@gmail.com>
-License-Expression: MIT
-Project-URL: Homepage, https://github.com/Edward-K1/validatedata
-Project-URL: Repository, https://github.com/Edward-K1/validatedata.git
-Project-URL: Issues, https://github.com/Edward-K1/validatedata/issues
-Keywords: validate,data,validation
-Classifier: Programming Language :: Python :: 3
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: python-dateutil
-Dynamic: license-file
-
 # Validatedata
 ![build workflow](https://github.com/Edward-K1/validatedata/actions/workflows/test.yml/badge.svg)
 [![PyPI version](https://badge.fury.io/py/validatedata.svg)](https://badge.fury.io/py/validatedata)
@@ -37,6 +19,7 @@ pip install phonenumbers
 ```
 
 ---
+📖 **[Read the full documentation](https://validatedata.readthedocs.io)**
 
 ## Quick Start
 
@@ -44,11 +27,11 @@ pip install phonenumbers
 from validatedata import validate_data
 
 # with shorthand
-rule={'keys': {
+rule={
     'username': 'str|min:3|max:32',
     'email': 'email',
     'age': 'int|min:18',
-}}
+}
 
 
 result = validate_data(
@@ -62,14 +45,14 @@ else:
     print(result.errors)
 ```
 
-> **Python 3.7+:** For simple cases you can omit the `keys` wrapper and pass a bare field map directly:
+> With the  `keys` wrapper
 >
 > ```python
-> rule = {
+> rule = {'keys': {
 >     'username': 'str|min:3|max:32',
 >     'email': 'email',
 >     'age': 'int|min:18',
-> }
+> }}
 > ```
 >
 > The `keys` form is recommended when you need to pair field rules with top-level options (such as `strict_keys` in a future release).
@@ -789,6 +772,38 @@ result = validate_data(
 result.errors  # ['company.address.postcode: value is not of required length']
 ```
 
+**Mirror-structure shorthand (0.4.0+):**
+
+Instead of wrapping every nested dict in `{'type': 'dict', 'fields': {...}}`, you can write a rule that mirrors the shape of your data:
+```python
+data = {
+    'app': {
+        'name':    'QuickScript',
+        'version': '1.0.0',
+    }
+}
+
+# before — explicit form
+rule = {'keys': {
+    'app': {
+        'type': 'dict',
+        'fields': {
+            'name':    {'type': 'str', 'range': (3, 'any')},
+            'version': {'type': 'semver'},
+        }
+    }
+}}
+
+# after — rule mirrors the data
+rule = {
+    'app': {
+        'name':    'str|min:3',
+        'version': 'semver',
+    }
+}
+```
+
+Error paths are identical in both forms. Nesting can go up to **100 levels** deep — exceeding this raises a `ValueError`. See the [mirror-rules guide](https://validatedata.readthedocs.io/en/latest/mirror-rules.html) for the full reference.
 **List of typed items:**
 
 ```python

{validatedata-0.3.0 → validatedata-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "validatedata"
-version = "0.3.0"
+version = "0.4.0"
 authors = [
   { name="Edward Kigozi", email="edwardinbytes@gmail.com" },
 ]
@@ -26,6 +26,8 @@ classifiers = [
 Homepage = "https://github.com/Edward-K1/validatedata"
 Repository = "https://github.com/Edward-K1/validatedata.git"
 Issues = "https://github.com/Edward-K1/validatedata/issues"
+Documentation = "https://validatedata.readthedocs.io"
+
 
 [tool.setuptools]
 packages = ["validatedata"]

validatedata-0.4.0/tests/test_check_rule.py

@@ -0,0 +1,107 @@
+"""
+Tests for the 0.4.0 rule-validation features:
+  - VALID_RULE_KEYS exported frozenset
+  - Unknown rule key detection with did-you-mean suggestions
+  - check_rule() public function
+"""
+
+import unittest
+
+from validatedata import check_rule, VALID_RULE_KEYS, validate_data
+from .base import BaseTest
+
+
+class TestValidRuleKeys(BaseTest):
+
+    def test_is_frozenset(self):
+        self.assertIsInstance(VALID_RULE_KEYS, frozenset)
+
+    def test_contains_expected_keys(self):
+        for key in ('type', 'keys', 'fields', 'items', 'range', 'length',
+                    'nullable', 'strict', 'message', 'transform', 'depends_on'):
+            self.assertIn(key, VALID_RULE_KEYS, f"Expected '{key}' in VALID_RULE_KEYS")
+
+    def test_is_immutable(self):
+        with self.assertRaises(AttributeError):
+            VALID_RULE_KEYS.add('fake_key')
+
+
+class TestUnknownKeyDetection(BaseTest):
+
+    def test_unknown_key_raises_value_error(self):
+        with self.assertRaises(ValueError):
+            validate_data(['hello'], [{'type': 'str', 'nulable': True}])
+
+    def test_error_message_includes_bad_key(self):
+        with self.assertRaises(ValueError) as ctx:
+            validate_data(['hello'], [{'type': 'str', 'nulable': True}])
+        self.assertIn('nulable', str(ctx.exception))
+
+    def test_did_you_mean_suggestion(self):
+        with self.assertRaises(ValueError) as ctx:
+            validate_data(['hello'], [{'type': 'str', 'nulable': True}])
+        self.assertIn('nullable', str(ctx.exception))
+
+    def test_no_suggestion_for_gibberish(self):
+        # A key with no close match should still raise but without a suggestion
+        with self.assertRaises(ValueError) as ctx:
+            validate_data(['hello'], [{'type': 'str', 'zzzzfake': True}])
+        self.assertNotIn('Did you mean', str(ctx.exception))
+
+    def test_multiple_unknown_keys_reported(self):
+        with self.assertRaises(ValueError) as ctx:
+            validate_data(['hello'], [{'type': 'str', 'nulable': True, 'strikt': True}])
+        msg = str(ctx.exception)
+        self.assertIn('nulable', msg)
+        self.assertIn('strikt', msg)
+
+    def test_message_suffix_keys_are_allowed(self):
+        # Any '<key>-message' key should not raise
+        rule = [{'type': 'int', 'range': (1, 10), 'range-message': 'out of range'}]
+        self.assertTrue(validate_data([5], rule).ok)
+
+    def test_valid_rule_dict_does_not_raise(self):
+        rule = [{'type': 'str', 'nullable': True, 'length': 5, 'strict': True}]
+        try:
+            validate_data(['hello'], rule)
+        except ValueError:
+            self.fail("validate_data raised ValueError on a valid rule dict")
+
+
+class TestCheckRule(BaseTest):
+
+    def test_valid_rule_passes_silently(self):
+        try:
+            check_rule({'type': 'str', 'nullable': True})
+        except ValueError:
+            self.fail("check_rule raised ValueError on a valid rule")
+
+    def test_unknown_key_raises_value_error(self):
+        with self.assertRaises(ValueError):
+            check_rule({'type': 'str', 'nulable': True})
+
+    def test_did_you_mean_in_message(self):
+        with self.assertRaises(ValueError) as ctx:
+            check_rule({'type': 'str', 'nulable': True})
+        self.assertIn('nullable', str(ctx.exception))
+
+    def test_keys_wrapper_is_valid(self):
+        # The canonical {'keys': {...}} form must not raise
+        try:
+            check_rule({'keys': {'username': {'type': 'str'}}})
+        except ValueError:
+            self.fail("check_rule raised ValueError on canonical {'keys': {...}} rule")
+
+    def test_returns_none_on_success(self):
+        result = check_rule({'type': 'int', 'range': (1, 100)})
+        self.assertIsNone(result)
+
+    def test_does_not_accept_path_as_argument(self):
+        # check_rule is a clean public API — path param must not be exposed
+        import inspect
+        sig = inspect.signature(check_rule)
+        self.assertNotIn('path', sig.parameters)
+
+
+if __name__ == '__main__':
+    unittest.main()