feat: adds doctest (#417)

* running `doctest` failes
Fixes #416

* check docstring examples with pytest

* changed line-length due doctest output

- bsc_address.py:20:101: E501 Line too long (103 > 100)
- all tox env passed

* chore: ignore line lenght in specific docs

* specifing testpath for pytest

* fix: lint rule name

* chore: update pytest in requirements file

* chore: install module before pytest

* fix: ru_inn docttest

---------

Co-authored-by: Yozachar <[email protected]>

Author: d-chris

.github/workflows/pycqa.yaml

@@ -48,6 +48,8 @@ jobs:
           cache: "pip"
       # testing
       - name: Install 'testing' dependencies
-        run: pip install -r package/requirements.testing.txt
+        run: |
+          pip install -r package/requirements.testing.txt
+          pip install .
       - name: Testing
         run: pytest .

package/requirements.testing.txt

@@ -41,9 +41,9 @@ pycryptodome==3.20.0 \
     --hash=sha256:f35d6cee81fa145333137009d9c8ba90951d7d77b67c79cbe5f03c7eb74d8fe2 \
     --hash=sha256:f47888542a0633baff535a04726948e876bf1ed880fddb7c10a736fa99146ab3 \
     --hash=sha256:fb3b87461fa35afa19c971b0a2b7456a7b1db7b4eba9a8424666104925b78128
-pytest==8.2.2 \
-    --hash=sha256:c434598117762e2bd304e526244f67bf66bbd7b5d6cf22138be51ff661980343 \
-    --hash=sha256:de4bb8104e201939ccdc688b27a89a7be2079b22e2bd2b07f806b6ba71117977
+pytest==8.3.2 \
+    --hash=sha256:4ba08f9ae7dcf84ded419494d229b48d0903ea6407b030eaec46df5e6a73bba5 \
+    --hash=sha256:c132345d12ce551242c87269de812483f5bcc87cdbb4722e48487ba194f9fdce
 tomli==2.0.1; python_version < "3.11" \
     --hash=sha256:939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc \
     --hash=sha256:de526c12914f0c550d15924c62d72abc48d6fe7364aa87328337a31007fe8a4f

pyproject.toml

@@ -126,7 +126,11 @@ pythonPlatform = "All"
 typeCheckingMode = "strict"
 
 [tool.pytest.ini_options]
+minversion = "6.0"
 pythonpath = ["src"]
+testpaths = "tests"
+addopts = ["--doctest-modules"]
+
 
 [tool.ruff]
 lint.select = [

src/validators/_extremes.py

@@ -12,13 +12,13 @@ class AbsMax:
     Inspired by https://pypi.python.org/pypi/Extremes.
 
     Examples:
-        >>> from sys import maxint
-        >>> AbsMax > AbsMin
-        # Output: True
-        >>> AbsMax > maxint
-        # Output: True
-        >>> AbsMax > 99999999999999999
-        # Output: True
+        >>> from sys import maxsize
+        >>> AbsMax() > AbsMin()
+        True
+        >>> AbsMax() > maxsize
+        True
+        >>> AbsMax() > 99999999999999999
+        True
     """
 
     def __ge__(self, other: Any):
@@ -33,13 +33,13 @@ class AbsMin:
     Inspired by https://pypi.python.org/pypi/Extremes.
 
     Examples:
-        >>> from sys import maxint
-        >>> AbsMin < -maxint
-        # Output: True
-        >>> AbsMin < None
-        # Output: True
-        >>> AbsMin < ''
-        # Output: True
+        >>> from sys import maxsize
+        >>> AbsMin() < -maxsize
+        True
+        >>> AbsMin() < None
+        True
+        >>> AbsMin() < ''
+        True
     """
 
     def __le__(self, other: Any):

src/validators/between.py

@@ -29,16 +29,16 @@ def between(
     Examples:
         >>> from datetime import datetime
         >>> between(5, min_val=2)
-        # Output: True
+        True
         >>> between(13.2, min_val=13, max_val=14)
-        # Output: True
+        True
         >>> between(500, max_val=400)
-        # Output: ValidationError(func=between, args=...)
+        ValidationError(func=between, args={'value': 500, 'max_val': 400})
         >>> between(
         ...     datetime(2000, 11, 11),
         ...     min_val=datetime(1999, 11, 11)
         ... )
-        # Output: True
+        True
 
     Args:
         value:

src/validators/card.py

@@ -17,9 +17,9 @@ def card_number(value: str, /):
 
     Examples:
         >>> card_number('4242424242424242')
-        # Output: True
+        True
         >>> card_number('4242424242424241')
-        # Output: ValidationError(func=card_number, args={'value': '4242424242424241'})
+        ValidationError(func=card_number, args={'value': '4242424242424241'})
 
     Args:
         value:
@@ -46,9 +46,9 @@ def visa(value: str, /):
 
     Examples:
         >>> visa('4242424242424242')
-        # Output: True
+        True
         >>> visa('2223003122003222')
-        # Output: ValidationError(func=visa, args={'value': '2223003122003222'})
+        ValidationError(func=visa, args={'value': '2223003122003222'})
 
     Args:
         value:
@@ -68,9 +68,9 @@ def mastercard(value: str, /):
 
     Examples:
         >>> mastercard('5555555555554444')
-        # Output: True
+        True
         >>> mastercard('4242424242424242')
-        # Output: ValidationError(func=mastercard, args={'value': '4242424242424242'})
+        ValidationError(func=mastercard, args={'value': '4242424242424242'})
 
     Args:
         value:
@@ -90,9 +90,9 @@ def amex(value: str, /):
 
     Examples:
         >>> amex('378282246310005')
-        # Output: True
+        True
         >>> amex('4242424242424242')
-        # Output: ValidationError(func=amex, args={'value': '4242424242424242'})
+        ValidationError(func=amex, args={'value': '4242424242424242'})
 
     Args:
         value:
@@ -112,9 +112,9 @@ def unionpay(value: str, /):
 
     Examples:
         >>> unionpay('6200000000000005')
-        # Output: True
+        True
         >>> unionpay('4242424242424242')
-        # Output: ValidationError(func=unionpay, args={'value': '4242424242424242'})
+        ValidationError(func=unionpay, args={'value': '4242424242424242'})
 
     Args:
         value:
@@ -134,9 +134,9 @@ def diners(value: str, /):
 
     Examples:
         >>> diners('3056930009020004')
-        # Output: True
+        True
         >>> diners('4242424242424242')
-        # Output: ValidationError(func=diners, args={'value': '4242424242424242'})
+        ValidationError(func=diners, args={'value': '4242424242424242'})
 
     Args:
         value:
@@ -156,9 +156,9 @@ def jcb(value: str, /):
 
     Examples:
         >>> jcb('3566002020360505')
-        # Output: True
+        True
         >>> jcb('4242424242424242')
-        # Output: ValidationError(func=jcb, args={'value': '4242424242424242'})
+        ValidationError(func=jcb, args={'value': '4242424242424242'})
 
     Args:
         value:
@@ -178,9 +178,9 @@ def discover(value: str, /):
 
     Examples:
         >>> discover('6011111111111117')
-        # Output: True
+        True
         >>> discover('4242424242424242')
-        # Output: ValidationError(func=discover, args={'value': '4242424242424242'})
+        ValidationError(func=discover, args={'value': '4242424242424242'})
 
     Args:
         value:

src/validators/country.py

@@ -245,9 +245,9 @@ def calling_code(value: str, /):
 
     Examples:
         >>> calling_code('+91')
-        # Output: True
+        True
         >>> calling_code('-31')
-        # Output: ValidationError(func=calling_code, args={'value': '-31'})
+        ValidationError(func=calling_code, args={'value': '-31'})
 
     Args:
         value:
@@ -273,15 +273,15 @@ def country_code(value: str, /, *, iso_format: str = "auto", ignore_case: bool =
 
     Examples:
         >>> country_code('GB', iso_format='alpha3')
-        # Output: False
+        ValidationError(func=country_code, args={'value': 'GB', 'iso_format': 'alpha3'})
         >>> country_code('USA')
-        # Output: True
+        True
         >>> country_code('840', iso_format='numeric')
-        # Output: True
+        True
         >>> country_code('iN', iso_format='alpha2')
-        # Output: False
+        ValidationError(func=country_code, args={'value': 'iN', 'iso_format': 'alpha2'})
         >>> country_code('ZWE', iso_format='alpha3')
-        # Output: True
+        True
 
     Args:
         value:
@@ -327,9 +327,9 @@ def currency(value: str, /, *, skip_symbols: bool = True, ignore_case: bool = Fa
 
     Examples:
         >>> currency('USD')
-        # Output: True
+        True
         >>> currency('ZWX')
-        # Output: ValidationError(func=currency, args={'value': 'ZWX'})
+        ValidationError(func=currency, args={'value': 'ZWX'})
 
     Args:
         value:

src/validators/cron.py

@@ -44,9 +44,9 @@ def cron(value: str, /):
 
     Examples:
         >>> cron('*/5 * * * *')
-        # Output: True
+        True
         >>> cron('30-20 * * * *')
-        # Output: ValidationError(func=cron, ...)
+        ValidationError(func=cron, args={'value': '30-20 * * * *'})
 
     Args:
         value:

src/validators/crypto_addresses/bsc_address.py

@@ -15,9 +15,9 @@ def bsc_address(value: str, /):
 
     Examples:
         >>> bsc_address('0x4e5acf9684652BEa56F2f01b7101a225Ee33d23f')
-        # Output: True
+        True
         >>> bsc_address('0x4g5acf9684652BEa56F2f01b7101a225Eh33d23z')
-        # Output: ValidationError(func=bsc_address, args=...)
+        ValidationError(func=bsc_address, args={'value': '0x4g5acf9684652BEa56F2f01b7101a225Eh33d23z'})
 
     Args:
         value:
@@ -26,7 +26,7 @@ def bsc_address(value: str, /):
     Returns:
         (Literal[True]): If `value` is a valid bsc address.
         (ValidationError): If `value` is an invalid bsc address.
-    """
+    """  # noqa: E501
     if not value:
         return False
 

src/validators/crypto_addresses/btc_address.py

@@ -33,9 +33,9 @@ def btc_address(value: str, /):
 
     Examples:
         >>> btc_address('3Cwgr2g7vsi1bXDUkpEnVoRLA9w4FZfC69')
-        # Output: True
+        True
         >>> btc_address('1BvBMsEYstWetqTFn5Au4m4GFg7xJaNVN2')
-        # Output: ValidationError(func=btc_address, args=...)
+        ValidationError(func=btc_address, args={'value': '1BvBMsEYstWetqTFn5Au4m4GFg7xJaNVN2'})
 
     Args:
         value: