valediction 1.0.3__py3-none-any.whl → 1.1.0__py3-none-any.whl

valediction/convenience.py

@@ -3,12 +3,11 @@ from pathlib import Path
 from pandas import DataFrame
 
 from valediction.datasets.datasets import Dataset
-from valediction.dictionary.importing import import_dictionary
 from valediction.dictionary.model import Dictionary
 
 
 def validate(
-    data: str | Path | dict[str, DataFrame] | Dictionary,
+    dataset: str | Path | dict[str, DataFrame],
     dictionary: Dictionary | str | Path,
     *,
     import_data: bool = False,
@@ -31,20 +30,16 @@ def validate(
     Returns:
         Dataset: dataset, with or without Issues
     """
-    dictionary = (
-        dictionary
-        if isinstance(dictionary, Dictionary)
-        else import_dictionary(dictionary)
-    )
-    data: Dataset = Dataset.create_from(data)
-    data.import_dictionary(dictionary)
+
+    _dataset: Dataset = Dataset.create_from(dataset)
+    _dataset.import_dictionary(dictionary)
 
     if import_data:
-        data.import_data()
+        _dataset.import_data()
 
-    data.validate(
+    _dataset.validate(
         chunk_size=chunk_size,
         feedback=feedback,
     )
 
-    return data
+    return _dataset

valediction/datasets/datasets.py

@@ -135,16 +135,16 @@ class DatasetItem:
     # Validation
     def validate(
         self,
-        chunk_size: int = None,
+        chunk_size: int | None = 10_000_000,
         feedback: bool = True,
-    ):
+    ) -> None:
         """
         Summary:
             Validates the dataset item against the dictionary.
             Warns if there are issues with the integrity of the data.
 
         Arguments:
-            chunk_size (int): Size of chunks for validating data to optimise RAM usage,
+            chunk_size (int | None): Size of chunks for validating data to optimise RAM usage,
                 if reading from CSV (default: 10_000_000)
             feedback (bool): Provide user feedback on progress (default: True)
 
@@ -710,7 +710,7 @@ class Dataset(list[DatasetItem]):
     # Validation
     def validate(
         self,
-        chunk_size: int = None,
+        chunk_size: int | None = 10_000_000,
         feedback: bool = True,
     ) -> None:
         """
@@ -751,7 +751,7 @@ class Dataset(list[DatasetItem]):
         if feedback:
             print("\n", end="")
 
-    def __reattach_issues(self):
+    def __reattach_issues(self) -> None:
         self.issues = Issues()
         for item in self:
             self.issues.extend(item.issues)

valediction/validation/validation.py

@@ -62,7 +62,7 @@ class Validator:
         dataset_item: DatasetItemLike,
         table_dictionary: Table,
         feedback: bool = True,
-        chunk_size: int = 10_000_000,
+        chunk_size: int | None = 10_000_000,
         _padding: int = 0,
     ):
         # User Variables

{valediction-1.0.3.dist-info → valediction-1.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: valediction
-Version: 1.0.3
+Version: 1.1.0
 Summary: Valediction is a convenience data validation package that allows generation, import, and constraint enforcement of user-defined data dictionaries against datasets.
 Author-email: Cai Davis <Cai.Davis@uhs.nhs.uk>
 Requires-Python: <4.0,>=3.11

{valediction-1.0.3.dist-info → valediction-1.1.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 valediction/__init__.py,sha256=HJy57qHyaeENZ0xGf5-jkkal-P92n242UU6vIqtsnaw,511
-valediction/convenience.py,sha256=6PM4lxoyxUNvU2GE8wqxOvJ_KBCFNxbDivTmPKATzEI,1620
+valediction/convenience.py,sha256=gDSNcI_T9VKO3Lk1Van4YQCt6hp_fqPyJnUJD8QNP_o,1438
 valediction/exceptions.py,sha256=OtAq_ShVCZeoNx0hWCzJVlVdl3Gm55l72IP1KrKUMR0,748
 valediction/integrity.py,sha256=_4kTywJFSoQIkQ3tFbxMJH1---N8ML9SY0C7j2ZXA-c,3352
 valediction/progress.py,sha256=fXld7BRhp8kk7xPCG50PbRPXvF8RV7Br2hENHuOUlbo,5974
@@ -9,7 +9,7 @@ valediction/data_types/data_type_helpers.py,sha256=iqcpSPBoFZybkTMHBmxrlv56ZRg8P
 valediction/data_types/data_types.py,sha256=MJv_io_hvbLo0G0N38kwj71goXlAo0isPFyS3TU05II,1605
 valediction/data_types/type_inference.py,sha256=11SGYgpvfAfwrDwyOewVIwvfA6pQtDo6i94_xfebYM8,19952
 valediction/datasets/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-valediction/datasets/datasets.py,sha256=JplnTf-sLxXbMuVzzBIgzw3pKD707NppsDCjk9hXX14,30020
+valediction/datasets/datasets.py,sha256=uDDzmLLAWbzKwXhT_RtLaVH-2f_QEhxAFxNFDotTLdY,30069
 valediction/datasets/datasets_helpers.py,sha256=AdB3ws5MYFpiXTmHXmSsdm2wZVwDXkXDOtYLvSYhs4I,1159
 valediction/demo/DEMO - Data Dictionary.xlsx,sha256=wj1JG8dHgdALVwV0zSSYnyWMomMTzrHxGFRm491wM_A,45308
 valediction/demo/DEMOGRAPHICS.csv,sha256=ochj8tiHdRByvK2YbZTw5UR3UxbjYxA2xVbA1BfUlbU,3437
@@ -32,7 +32,7 @@ valediction/io/csv_readers.py,sha256=6MAOZFZexvNwqiZz-8Er8Me8L4n9NVjLIj6oZOxzZ64
 valediction/validation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 valediction/validation/helpers.py,sha256=qSs_rlJzZ29TPO0pHHFFg9XqVdl1XRxu048NWDl78I0,10180
 valediction/validation/issues.py,sha256=bvHawjehs_e_2xQGoSvPdOt4t8dfASES3KBKHO3zFZo,9122
-valediction/validation/validation.py,sha256=GiRhz6kay9lQMX_hqZSwfDRPsi-hFrfJFyGpsIHXjS8,21548
-valediction-1.0.3.dist-info/METADATA,sha256=JHRYy5xdKmaHgfxoklhSjXGMvojCqgf0vmSJhvPianU,612
-valediction-1.0.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-valediction-1.0.3.dist-info/RECORD,,
+valediction/validation/validation.py,sha256=ahYhWlY6wjwL7blYOfNhNIoRCyXCWnNrYn10G0AQGjU,21555
+valediction-1.1.0.dist-info/METADATA,sha256=tg9HnCfKQhYplzno5mOrw_hSICZZL3FyXPhNedYglOE,612
+valediction-1.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+valediction-1.1.0.dist-info/RECORD,,