Added doctest

Author: tarunbatra

src/password_validator/password_validator.py

@@ -1,4 +1,3 @@
-
 import re
 
 from . import lib
@@ -11,8 +10,10 @@ class PasswordValidator:
     Example:
         >>> schema = PasswordValidator()
         >>> schema.has().letters().has().digits().no().spaces()
+        <src.password_validator.password_validator.PasswordValidator object at ...>
         >>> schema.validate('testPassword123')
         True
+
     Returns:
         PasswordValidator: Schema object
     '''
@@ -30,6 +31,7 @@ def validate(self, pwd):
             False
             >>> PasswordValidator().letters().validate('abc')
             True
+
         Args:
             pwd (str): Password to validate against the schema
         Returns:
@@ -63,6 +65,7 @@ def has(self, regexp=None):
             True
             >>> PasswordValidator().has(r'[a-z]+').validate('test')
             True
+
         Args:
             regexp (str, optional): The regular expression or string to mandate on the password
         Returns:
@@ -107,6 +110,7 @@ def uppercase(self):
             True
             >>> PasswordValidator().uppercase().validate('test')
             False
+
         Returns:
             PasswordValidator: Updated schema object
         '''
@@ -121,6 +125,7 @@ def lowercase(self):
             True
             >>> PasswordValidator().lowercase().validate('TEST')
             False
+
         Returns:
             PasswordValidator: Updated schema object
         '''
@@ -136,6 +141,7 @@ def letters(self):
             True
             >>> PasswordValidator().no().letters().validate('test')
             False
+
         Returns:
             PasswordValidator: Updated schema object
         '''
@@ -151,6 +157,7 @@ def digits(self):
             False
             >>> PasswordValidator().no().digits().validate('test123')
             False
+
         Returns:
             PasswordValidator: Updated schema object
         '''
@@ -166,6 +173,7 @@ def min(self, length):
             True
             >>> PasswordValidator().min(8).validate('test')
             False
+
         Args:
             length (int): Minimum length allowed
         Returns:
@@ -184,6 +192,7 @@ def max(self, length):
             False
             >>> PasswordValidator().max(8).validate('test')
             True
+
         Args:
             length (int): Maximum length allowed
         Returns:
@@ -201,6 +210,7 @@ def spaces(self):
             True
             >>> PasswordValidator().no().spaces().validate('a  bc')
             False
+
         Returns:
             PasswordValidator: Updated schema object
         '''

tests/test_doctest.py

@@ -0,0 +1,7 @@
+import unittest
+import doctest
+from src.password_validator import password_validator
+
+def load_tests(loader, tests, ignore):
+    tests.addTests(doctest.DocTestSuite(password_validator, optionflags=doctest.ELLIPSIS))
+    return tests