feat: added is_palindrome validator

Author: theteladras

.gitignore

@@ -4,3 +4,4 @@ dist
 build
 py.validator.egg-info
 *.pyc
+*.tmp

README.md

@@ -94,6 +94,7 @@ Validator                                | Description
 **is_octal(str)**                       | check if the string is a valid octal number.
 **is_odd(str/int)**                     | checks if the input is an odd number, it accepts either a string or an int.
 **is_online(str)**                      | checks if the internet connection is available, where the input argument is an optional url, if passed it will be check if it is reachable _(if it is reachable it will evaluate to *True*)_.
+**is_palindrome(str, options)**         | checks if the string is a palindrom. The options argument is a optional dictionary which can contain a `insensitive` boolean property that will enable / disable case sensitivity, the default value is *True*. Special character that are contained in the string are ignored.
 **is_passport_number(str, country_code)**                     | check if the string is a valid passport number.<br/><br/>country_code is one of `['AM', 'AR', 'AT', 'AU', 'BA', 'BE', 'BG', 'BY', 'BR', 'CA', 'CH', 'CN', 'CY', 'CZ', 'DE', 'DK', 'DZ', 'EE', 'ES', 'FI', 'FR', 'GB', 'GR', 'HR', 'HU', 'IE' 'IN', 'IR', 'ID', 'IS', 'IT', 'JP', 'KR', 'LT', 'LU', 'LV', 'LY', 'MT', 'MY', 'MZ', 'NL', 'PL', 'PT', 'RO', 'RS', 'RU', 'SE', 'SL', 'SK', 'TR', 'UA', 'US']`.
 **is_port(str)**                        | check if the string is a valid port number.
 **is_prime(str/int)**                   | checks if the input is an prime number, it accepts either a string or an int.

pyvalidator/__init__.py

@@ -48,6 +48,7 @@
 from pyvalidator.is_octal import is_octal
 from pyvalidator.is_odd import is_odd
 from pyvalidator.is_online import is_online
+from pyvalidator.is_palindrome import is_palindrome
 from pyvalidator.is_passport_number import is_passport_number
 from pyvalidator.is_port import is_port
 from pyvalidator.is_prime import is_prime

pyvalidator/is_palindrome.py

@@ -0,0 +1,23 @@
+from typing import TypedDict
+from .utils.assert_string import assert_string
+from .utils.merge import merge
+
+
+class IsPalindromeOptions(TypedDict):
+	insensitive: bool
+
+default_is_palindrome_options: IsPalindromeOptions = {
+  "insensitive": True,
+}
+
+def is_palindrome(input: str, options: IsPalindromeOptions = {}) -> bool:
+    input = assert_string(input)
+
+    options = merge(options, default_is_palindrome_options)
+
+    input = input.sub(r'[^a-zA-Z\d\u00A0-\uD7FF\uF900-\uFDCF\uFDF0-\uFFEF]', '')
+
+    if not options['insensitive']: 
+        return input == input[::-1]
+
+    return input.lower() == input[::-1].lower()

setup.py

@@ -4,8 +4,8 @@
     readme = f.read()
 
 MAJOR = 0
-MINOR = 13
-PATCH = 6
+MINOR = 14
+PATCH = 0
 
 VERSION = '{}.{}.{}'.format(MAJOR, MINOR, PATCH)
 DESCRIPTION = 'String validation and sanitization'

test/test_is_palindrome.py

@@ -0,0 +1,77 @@
+import unittest
+
+from pyvalidator import *
+
+
+class TestIsPalindrome(unittest.TestCase):
+	def valid_check(self, items, options = {}):
+		for item in items:
+			try:
+				self.assertTrue(is_palindrome(item, options))
+			except Exception as e:
+				print(f'failed for input: {item}')
+				raise e
+
+	def invalid_check(self, items, options = {}):
+		for item in items:
+			try:
+				self.assertFalse(is_palindrome(item, options))
+			except Exception as e:
+				print(f'failed for input: {item}')
+				raise e
+
+	def test_valid_palindrome(self):
+		valid_items = [
+			'',
+			'A',
+			'EVE',
+			'radar',
+			'reviver',
+			'top spot',
+			'ROTATOR',
+			'step not on pets.',
+			'MADAM I\'M ADAM',
+			'no lemon, NO Melon'
+			'No LeMoN, nomelon',
+			'Able was I, ere I saw Elba!',
+			'Was it a car or a cat I saw',
+			'Eine treue Familie bei Lima feuerte nie',
+			'Die Liebe ist Sieger; stets rege ist sie bei Leid',
+			'O Genie, der Herr ehre Dein Ego',
+			'Elu par cette crapule',
+			'Tu l\'as trop ecrase cesar ce port salut.',
+			'A l\'autel elle alla, elle le tua la',
+			'Caser vite ce palindrome ne mord ni lape cet ivre sac',
+			'isälläsi',
+			'Ana, kanna kana',
+			'Hupaisa asia, Puh',
+			'Isorikas sika sökösakissa kirosi',
+			'I jogurt ujutru goji?',
+			'УЈАК ИМА РАДАР  А МИ КАЈУ',
+			'око',
+			'12321'
+			
+        ]
+		self.valid_check(valid_items)
+		print('OK - test_valid_palindrome')
+
+	def test_invalid_palindrome(self):
+		invalid_items = [
+			'asd',
+			'hello, world'
+			'this is not a palindrome',
+			'12345',
+			'ок0'
+			
+        ]
+		self.invalid_check(invalid_items)
+		print('OK - test_invalid_palindrome')
+
+	def test_invalid_case_sensitive_palindrome(self):
+		invalid_items = [
+			'No LeMoN, nomelon',
+			'Was it a car or a cat I saw',
+			'isäLläSi',
+        ]
+		self.invalid_check(invalid_items, { "insensitive": False })
+		print('OK - test_invalid_case_sensitive_palindrome')