feat: improve hashes and iban modules

- re-formats `hashes` and `iban.py`, fix typos
- Uses type hints, adds relevant doc refs
- Updates corresponding tests

Author: yozachar

docs/index.md

@@ -12,4 +12,8 @@
 
 ::: validators.email
 
+::: validators.hashes
+
+::: validators.iban
+
 ::: validators.length

tests/test_domain.py

@@ -1,7 +1,7 @@
 """Test Domain."""
 # -*- coding: utf-8 -*-
 
-# standard
+# external
 import pytest
 
 # local

tests/test_email.py

@@ -1,7 +1,7 @@
 """Test eMail."""
 # -*- coding: utf-8 -*-
 
-# standard
+# external
 import pytest
 
 # local

tests/test_hashes.py

@@ -0,0 +1,156 @@
+"""Test Hashes."""
+# -*- coding: utf-8 -*-
+
+# external
+import pytest
+
+# local
+from validators import md5, sha1, sha224, sha256, sha512, ValidationFailure
+
+
+# ==> md5 <== #
+
+
+@pytest.mark.parametrize(
+    "value", ["d41d8cd98f00b204e9800998ecf8427e", "D41D8CD98F00B204E9800998ECF8427E"]
+)
+def test_returns_true_on_valid_md5(value: str):
+    """Test returns true on valid md5."""
+    assert md5(value)
+
+
+@pytest.mark.parametrize(
+    "value",
+    [
+        "z41d8cd98f00b204e9800998ecf8427e",
+        "z8cd98f00b204e9800998ecf8427e",
+        "z4aaaa1d8cd98f00b204e9800998ecf8427e",
+    ],
+)
+def test_returns_failed_validation_on_invalid_md5(value: str):
+    """Test returns failed validation on invalid md5."""
+    assert isinstance(md5(value), ValidationFailure)
+
+
+# ==> sha1 <== #
+
+
+@pytest.mark.parametrize(
+    "value",
+    ["da39a3ee5e6b4b0d3255bfef95601890afd80709", "DA39A3EE5E6B4B0D3255BFEF95601890AFD80709"],
+)
+def test_returns_true_on_valid_sha1(value: str):
+    """Test returns true on valid sha1."""
+    assert sha1(value)
+
+
+@pytest.mark.parametrize(
+    "value",
+    [
+        "za39a3ee5e6b4b0d3255bfef95601890afd80709",
+        "da39e5e6b4b0d3255bfef95601890afd80709",
+        "daaaa39a3ee5e6b4b0d3255bfef95601890afd80709",
+    ],
+)
+def test_returns_failed_validation_on_invalid_sha1(value: str):
+    """Test returns failed validation on invalid sha1."""
+    assert isinstance(sha1(value), ValidationFailure)
+
+
+# ==> sha224 <== #
+
+
+@pytest.mark.parametrize(
+    "value",
+    [
+        "d14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42f",
+        "D14A028C2A3A2BC9476102BB288234C415A2B01F828EA62AC5B3E42F",
+    ],
+)
+def test_returns_true_on_valid_sha224(value: str):
+    """Test returns true on valid sha224."""
+    assert sha224(value)
+
+
+@pytest.mark.parametrize(
+    "value",
+    [
+        "z14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42f",
+        "d028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42f",
+        "daaa14a028c2a3a2bc9476102bb288234c415a2b01f828ea62ac5b3e42f",
+    ],
+)
+def test_returns_failed_validation_on_invalid_sha224(value: str):
+    """Test returns failed validation on invalid sha224."""
+    assert isinstance(sha224(value), ValidationFailure)
+
+
+# ==> sha256 <== #
+
+
+@pytest.mark.parametrize(
+    "value",
+    [
+        "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+        "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855",
+    ],
+)
+def test_returns_true_on_valid_sha256(value: str):
+    """Test returns true on valid sha256."""
+    assert sha256(value)
+
+
+@pytest.mark.parametrize(
+    "value",
+    [
+        "z3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+        "ec44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+        "eaaaa3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
+    ],
+)
+def test_returns_failed_validation_on_invalid_sha256(value: str):
+    """Test returns failed validation on invalid sha256."""
+    assert isinstance(sha256(value), ValidationFailure)
+
+
+# ==> sha256 <== #
+
+
+@pytest.mark.parametrize(
+    "value",
+    [
+        (
+            "cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d"
+            "13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e"
+        ),
+        (
+            "CF83E1357EEFB8BDF1542850D66D8007D620E4050B5715DC83F4A921D36CE9CE47D0D"
+            "13C5D85F2B0FF8318D2877EEC2F63B931BD47417A81A538327AF927DA3E"
+        ),
+    ],
+)
+def test_returns_true_on_valid_sha512(value: str):
+    """Test returns true on valid sha512."""
+    assert sha512(value)
+
+
+@pytest.mark.parametrize(
+    "value",
+    [
+        (
+            "zf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d"
+            "13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e"
+        ),
+        (
+            "cf8357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c"
+            "5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e"
+        ),
+        (
+            "cf8aaaa3e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce4"
+            "7d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e"
+        ),
+    ],
+)
+def test_returns_failed_validation_on_invalid_sha512(value: str):
+    """Test returns failed validation on invalid sha512."""
+    assert isinstance(sha512(value), ValidationFailure)

tests/test_iban.py

@@ -1,21 +1,20 @@
+"""Test IBAN."""
 # -*- coding: utf-8 -*-
+
+# external
 import pytest
 
-import validators
+# local
+from validators import iban, ValidationFailure
 
 
-@pytest.mark.parametrize('value', [
-    'GB82WEST12345698765432',
-    'NO9386011117947'
-])
-def test_returns_true_on_valid_iban(value):
-    assert validators.iban(value)
+@pytest.mark.parametrize("value", ["GB82WEST12345698765432", "NO9386011117947"])
+def test_returns_true_on_valid_iban(value: str):
+    """Test returns true on valid iban."""
+    assert iban(value)
 
 
-@pytest.mark.parametrize('value', [
-    'GB81WEST12345698765432',
-    'NO9186011117947'
-])
-def test_returns_failed_validation_on_invalid_iban(value):
-    result = validators.iban(value)
-    assert isinstance(result, validators.ValidationFailure)
+@pytest.mark.parametrize("value", ["GB81WEST12345698765432", "NO9186011117947"])
+def test_returns_failed_validation_on_invalid_iban(value: str):
+    """Test returns failed validation on invalid iban."""
+    assert isinstance(iban(value), ValidationFailure)