[test]: add test case for __version__ existence

ilias-ant · Jul 19, 2023 · 577cab9 · 577cab9
1 parent 2af5e49
commit 577cab9
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -135,5 +135,4 @@ dmypy.json
 .pyre/
 
 .DS_Store
-.python-version
 .ipynb_checkpoints/
diff --git a/README.md b/README.md
@@ -37,6 +37,6 @@ are_similar = validate(
 # // {
 # //     "datasets_follow_same_distribution": True,
 # //     'mean_roc_auc': 0.5021320833333334,
-# //     "adversarial_features': [],
+# //     "adversarial_features': ['id'],
 # // }
 ```
diff --git a/advertion/__init__.py b/advertion/__init__.py
@@ -1,4 +1,4 @@
-from .validate import validate
+from .public import validate
 from .version import __version__
 
 __all__ = ["__version__", "validate"]
diff --git a/advertion/validate.py → advertion/public.py b/advertion/validate.py → advertion/public.py
@@ -48,7 +48,7 @@ def validate(
         >>> // {
         >>> //     "datasets_follow_same_distribution": True,
         >>> //     'mean_roc_auc': 0.5021320833333334,
-        >>> //     "adversarial_features': [],
+        >>> //     "adversarial_features': ['id'],
         >>> // }
 
     """

diff --git a/tests/test_validate.py → tests/test_public.py b/tests/test_validate.py → tests/test_public.py
@@ -2,10 +2,10 @@
 import pandas as pd
 import pytest
 
-from advertion.validate import validate
+from advertion import validate
 
 
-class TestValidate:
+class TestPublic:
     def test_validate_and_datasets_follow_same_distribution(self):
         seed = 313233
 
@@ -111,3 +111,15 @@ def test_validate_and_datasets_do_not_follow_same_distribution_and_mean_roc_auc_
         assert verdict["datasets_follow_same_distribution"] is False
         assert verdict["mean_roc_auc"] == pytest.approx(0.15, abs=0.1)
         assert verdict["adversarial_features"] == []
+
+    def test_version_exists(self):
+
+        try:
+
+            from advertion import __version__
+
+            assert isinstance(__version__, str)
+
+        except ImportError:
+
+            pytest.fail("advertion.__version__ does not exist.")