A library of string validators and sanitizers
Insipired by validator.js
This library validates and sanitizes strings only.
Passing anything other than a string will result in an error.
You can install it by running:
pip install py.validator
from pyvalidator import is_email, is_mobile_number, is_port
email = 'some@email.com'
is_email_flag = is_email(email)
mobile_number = '+15673628910'
is_mobile_number_flag = is_mobile_number(mobile_number)
port = '8000'
is_port_flag = is_port(port)
if is_email_flag and is_mobile_number_flag and is_port_flag:
print('All True!')Here is a list of the validators currently available.
| Validator | Description |
|---|---|
| is_after(str, date) | check if the string is a date that's after the specified argument date (defaults to now if not provided). |
| is_alpha(str, locale, options) | check if the string contains only letters (a-zA-Z). Locale is one of ['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fa-IR', 'fi-FI', 'fr-CA', 'fr-FR', 'he', 'hi-IN', 'hu-HU', 'it-IT', 'ku-IQ', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'sl-SI', 'sk-SK', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA']) and defaults to en-US. The locale list can be picked up from validator.locales. Options is an optional dictionary that can be supplied with the following key(s): ignore which can either be a String or RegExp of characters to be ignored e.g. " -" will ignore spaces and -'s. |
| is_alphanumeric(str, locale, options) | check if the string contains only letters and numbers (a-zA-Z0-9). Locale is one of ['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fa-IR', 'fi-FI', 'fr-CA', 'fr-FR', 'he', 'hi-IN', 'hu-HU', 'it-IT', 'ku-IQ', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'sl-SI', 'sk-SK', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA']) and defaults to en-US. The locale list can be picked up from validator.locales. options is an optional dictionary that can be supplied with the following key(s): ignore which can either be a String or RegExp of characters to be ignored e.g. " -" will ignore spaces and -'s. |
| is_ascii(str) | check if the string contains ASCII chars only. |
| is_aws_arn(str, resource) | check if the string is a valid amazon resource name. Supported resources are ['connect', 'iam', 'orgs', 'ecs', 'ec2', 'lambda', 's3', 'sts', 'sqs']. You may provide a second argument to be more specific with the resource for which the validation should be done. This are the options:- connect - iam - iam-user - iam-group - iam-role - iam-policy - orgs - orgs-account - orgs-handshake - orgs-org - org-unit - ecs - ecs-instance - ecs-service - ec2 - lambda - lambda-function - lambda-event-mapping - lambda-layer - s3 - sts - sqs |
| is_base32(str) | check if a string is base32 encoded. |
| is_base58(str) | check if a string is base58 encoded. |
| is_base64(str, options) | check if a string is base64 encoded. options is optional and defaults to { "url_safe": False }when url_safe is True it tests the given base64 encoded string is url safe. |
| is_before(str, date) | check if the string is a date that's before the specified date. |
| is_bic(str) | check if a string is a BIC (Bank Identification Code) or SWIFT code. |
| is_boolean(str, options) | check if a string is a boolean.options is an dictionary which defaults to { "loose": False }. If loose is is set to false, the validator will strictly match ['True', 'False', 'true', 'false', '0', '1']. If loose is set to true, the validator will also match yes, no, and will match a valid boolean string of any case (eg: ['true', 'True', 'TRUE']). |
| is_btc_address(str) | check if the string is a valid BTC address. |
| is_byte_length(str, options) | check if the string's length (in UTF-8 bytes) falls in a range.options is an dictionary which defaults to { "min": 0, "max": None }. |
| is_credit_card(str) | check if the string is a credit card. |
| is_css_unit(str) | check if the string is a css unit (eg. 3px, 3vh, 11%...), 0 without a unit is considered as valid. |
| is_currency(str, options) | check if the string is a valid currency amount.options is an optional dictionary which is defaultet to:{ "symbol": '$', "require_symbol": False, "allow_space_after_symbol": False, "symbol_after_digits": False, "allow_negatives": True, "parens_for_negatives": False, "negative_sign_before_digits": False, "negative_sign_after_digits": False, "allow_negative_sign_placeholder": False, "thousands_separator": ',', "decimal_separator": '.', "allow_decimal": True, "require_decimal": False, "digits_after_decimal": [2], "allow_space_after_digits": False } Note: The array digits_after_decimal is filled with the exact number of digits allowed not a range, for example a range 1 to 3 will be given as [1, 2, 3]. |
| is_data_uri(str) | check if the string is a data uri format. |
| is_date(str, options) | Check if the input is a valid date. e.g. [2002-07-15, new Date()].options is an optional dictionary which can contain the keys format, strict_mode and/or delimitersformat is a string and defaults to YYYY/MM/DD.strict_mode is a boolean and defaults to False. If strict_mode is set to True, the validator will reject inputs different from format.delimiters is an array of allowed date delimiters and defaults to ['/', '-'], supported delimiters are ['/', '-', '.', ',', ';', ':', '|' ]. |
| is_decimal(str, options) | check if the string represents a decimal number, such as 0.1, .3, 1.1, 1.00003, 4.0, etc.options is an dictionary which defaults to { "force_decimal": False, "decimal_digits": '1,', "locale": 'en-US' }locale determine the decimal separator and is one of ['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'el-GR', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fa', 'fa-AF', 'fa-IR', 'fr-FR', 'fr-CA', 'hu-HU', 'id-ID', 'it-IT', 'ku-IQ', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pl-Pl', 'pt-BR', 'pt-PT', 'ru-RU', 'sl-SI', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA', 'vi-VN'].Note: decimal_digits is given as a range like '1,3', a specific value like '3' or min like '1,'. |
| is_divisible_by(str, number) | check if the string is a number that's divisible by another. |
| is_ean(str) | check if the string is an EAN (European Article Number). |
| is_email(str, options) | check if the string is an email.options is an dictionary which defaults to { "allow_display_name": False, "require_display_name": False, "allow_utf8_local_part": True, "require_tld": True, "allow_ip_domain": False, "domain_specific_validation": False, "ignore_max_length": False, "blacklisted_chars": '', "host_blacklist": [] }. If allow_display_name is set to True, the validator will also match Display Name <email-address>. If require_display_name is set to True, the validator will reject strings without the format Display Name <email-address>. If allow_utf8_local_part is set to False, the validator will not allow any non-English UTF8 character in email address' local part. If require_tld is set to False, e-mail addresses without having TLD in their domain will also be matched. If ignore_max_length is set to True, the validator will not check for the standard max length of an email. If allow_ip_domain is set to True, the validator will allow IP addresses in the host part. If domain_specific_validation is True, some additional validation will be enabled, e.g. disallowing certain syntactically valid email addresses that are rejected by GMail. If blacklisted_chars receives a string, then the validator will reject emails that include any of the characters in the string, in the name part. If host_blacklist is set to an array of strings and the part of the email after the @ symbol matches one of the strings defined in it, the validation fails. |
| is_emoji(str, options) | check if the provided string is a valid emoji. A string of length grater then 1, is considered as a valid emoji if all of its characters are emoji characters, for example '🍗🍗🍗' is valid, while '🍗@🍗🍗' would be invalid. You can provide a second dict argument with the property 'omit_rule' to pass a regex patter which will be used to igore certain characters, for example passing { "omit_rule": r'[=]' } would treat the string "💪=💪=💪" as valid. |
| is_ethereum_address(str) | check if the string is an Ethereum address using basic regex. Does not validate address checksums. |
| is_even(str/int) | checks if the input is an even number, it accepts either a string or an int. |
| is_float(str, options) | check if the string is a float.options is an dictionary which can contain the keys min, max, gt, and/or lt to validate the float is within boundaries (e.g. { "min": 7.22, "max": 9.55 }) it also has locale as an option.min and max are equivalent to 'greater or equal' and 'less or equal', respectively while gt and lt are their strict counterparts.locale determine the decimal separator and is one of ['ar', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', 'ar-JO', 'ar-KW', 'ar-LB', 'ar-LY', 'ar-MA', 'ar-QA', 'ar-QM', 'ar-SA', 'ar-SD', 'ar-SY', 'ar-TN', 'ar-YE', 'bg-BG', 'cs-CZ', 'da-DK', 'de-DE', 'en-AU', 'en-GB', 'en-HK', 'en-IN', 'en-NZ', 'en-US', 'en-ZA', 'en-ZM', 'es-ES', 'fr-CA', 'fr-FR', 'hu-HU', 'it-IT', 'nb-NO', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'ru-RU', 'sl-SI', 'sr-RS', 'sr-RS@latin', 'sv-SE', 'tr-TR', 'uk-UA']. Locale list is validator.isFloatLocales. |
| is_fqdn(str, options) | check if the string is a fully qualified domain name (e.g. domain.com).options is an dictionary which defaults to { "require_tld": True, "allow_underscores": False, "allow_trailing_dot": False, "allow_numeric_tld": False, "allow_wildcard": False }. If allow_wildcard is set to True, the validator will allow domain starting with *. (e.g. *.example.com or *.shop.example.com). |
| is_freight_container_id(str) | alias for isISO6346, check if the string is a valid ISO 6346 shipping container identification. |
| is_full_width(str) | check if the string contains any full-width chars. |
| is_half_width(str) | check if the string contains any half-width chars. |
| is_hash(str, algorithm) | check if the string is a hash of type algorithm. Algorithm is one of ['md4', 'md5', 'sha1', 'sha256', 'sha384', 'sha512', 'ripemd128', 'ripemd160', 'tiger128', 'tiger160', 'tiger192', 'crc32', 'crc32b'] |
| is_hexadecimal(str) | check if the string is a hexadecimal number. |
| is_hsl(str) | check if the string is an HSL (hue, saturation, lightness, optional alpha) color based on CSS Colors Level 4 specification. Comma-separated format supported. Space-separated format supported with the exception of a few edge cases (ex: hsl(200grad+.1%62%/1)). |
| is_html_element(str, options) | check if the provided string represents an html element. The options dictionary accepts a contains flag which can be set to True, fo so it will check if the provided string contains an html element. It is defaulted to False, which means that it will expect an proper html element to be valid. |
| is_iban(str, country_code, options) | check if the provided string is a valid iban, country_code is an optional argument which if provided will check the input string if its a valid iban for that specified country and the options is an optional dictionary it does accept a insensitive property which will ignore character case upon validation.Available country codes: AD, AE, AL, AT, AZ, BA, BE, BG, BH, BR, BY, CH, CR, CY, CZ, DE, DK, DO, EE, EG, ES, FI, FO, FR, GB, GE, GI, GL, GR, GT, HR, HU, IE, IL, IQ, IS, IT, JO, KW, KZ, LB, LC, LI, LT, LU, LV, MC, MD, ME, MK, MR, MT, MU, NL, NO, PK, PL, PS, PT, QA, RO, RS, SA, SC, SE, SI, SK, SM, ST, SV, TL, TN, TR, UA, VA, VG. |
| is_imei(str, options) | check if the string is a valid IMEI number. Imei should be of format ############### or ##-######-######-#.options is an dictionary which can contain the property allow_hyphens (bool - default value is False). If the allow_hyphens prop is set to True, it will validate the IMEI with the hyphens. |
| is_int(str, options) | check if the string is an integer.options is an dictionary which can contain the keys min and/or max to check the integer is within boundaries (e.g. { "min": 10, "max": 99 }). options can also contain the key allow_leading_zeroes, which when set to false will disallow integer values with leading zeroes (e.g. { "allow_leading_zeroes": False }). Finally, options can contain the keys gt and/or lt which will enforce integers being greater than or less than, respectively, the value provided (e.g. { "gt": 1, "lt": 4 } for a number between 1 and 4). |
| is_ip(str, version) | check if the string is an IP (version 4 or 6), if the version is not set it will validate the input for any version. |
| is_ip_range(str, version) | check if the string is an IP Range (version 4 or 6), if the version is not set it will validate the input for any version.. |
| is_ISO31661_alpha2(str) | check if the string is a valid ISO 3166-1 alpha-2 officially assigned country code. |
| is_isrc(str) | check if the string is a ISRC. |
| is_json(str, options) | check if the string is valid JSON (note: uses JSON.parse).options is an dictionary which defaults to { "allow_primitives": False }. If allow_primitives is True, the primitives 'true', 'false' and 'null' are accepted as valid JSON values. |
| is_jwt(str) | check if the string is valid JWT token. |
| is_lat_long(str, options) | check if the string is a valid latitude-longitude coordinate in the format lat,long or lat, long.options is an object that defaults to { "check_dms": False }. Pass check_dms as True to validate DMS(degrees, minutes, and seconds) latitude-longitude format. |
| is_license_plate(str, locale) | check if string matches the format of a country's license plate. (locale is optional and can take any of the next supported values ['cs-CZ', 'de-DE', 'de-LI', 'fi-FI', 'pt-BR', 'pt-PT', 'sq-AL', 'sv-SE', 'en-IN', 'hi-IN', 'gu-IN', 'as-IN', 'bn-IN', 'kn-IN', 'ml-IN', 'mr-IN', 'or-IN', 'pa-IN', 'sa-IN', 'ta-IN', 'te-IN', 'kok-IN', 'sr-RS']) |
| is_lowercase(str) | check if the string is lowercase. |
| is_mac_address(str, options) | check if the string is a MAC address.options is an dictionary which defaults to { "no_separators": False, "eui": None }. If no_separators is True, the validator will allow MAC addresses without separators. Also, it allows the use of hyphens, spaces or dots e.g '01 02 03 04 05 ab', '01-02-03-04-05-ab' or '0102.0304.05ab'. The eui property helps specify if it needs to be validated against EUI-48 or EUI-64. The accepted values of eui are: [int] 48, 64, if not set it will check for either of them to be valid. |
| is_magnet_uri(str) | check if the string is a magnet uri format. |
| is_mailto_uri(str) | check if the string is a mailto uri format. |
| is_md5(str) | check if the string is a MD5 hash. Please note that you can also use the isHash(str, 'md5') function. Keep in mind that MD5 has some collision weaknesses compared to other algorithms (e.g., SHA). |
| is_mobile_number(str, locale, options) | check if the string is a mobile phone number, locale can be an array of locales (e.g ['sr-RS', 'bs-BA']) or a single locale from ['am-Am', 'ar-AE', 'ar-BH', 'ar-DZ', 'ar-EG', 'ar-IQ', ar-JO', 'ar-KW', 'ar-SA', 'ar-SY', 'ar-TN', 'az-AZ', 'az-LY', 'az-LB', 'bs-BA', 'be-BY', 'bg-BG', 'bn-BD', 'ca-AD', 'cs-CZ', 'da-DK', 'de-DE', 'de-AT', 'de-CH', 'de-LU', 'el-GR', 'en-AU', 'en-BM', 'en-CA', 'en-GB', 'en-GG', 'en-GH', 'en-HK', 'en-MO', 'en-IE', 'en-IN', 'en-KE', 'en-MT', 'en-MU', 'en-NG', 'en-NZ', 'en-PK', 'en-PH', 'en-RW', 'en-SG', 'en-SL', 'en-UG', 'en-US', 'en-TZ', 'en-ZA', 'en-ZM', 'en-ZW', 'es-AR', 'es-BO', 'es-CL', 'es-CO', 'es-CR', 'es-CU', 'es-DO', 'es-HN', 'es-PE', 'es-EC', 'es-ES', 'es-MX', 'es-PA', 'es-PY', 'es-UY', 'es-VE', 'et-EE', 'fa-IR', 'fi-FI', 'fj-FJ', 'fo-FO', 'fr-BE', 'fr-FR', 'fr-GF', 'fr-GP', 'fr-MQ', 'fr-RE', 'ga-IE', 'he-IL', 'hu-HU', 'id-ID', 'it-IT', 'it-SM', 'ja-JP', 'ka-GE', 'kk-KZ', 'kl-GL', 'ko-KR', 'lt-LT', 'ms-MY', ''mz-MZ', nb-NO', 'ne-NP', 'nl-BE', 'nl-NL', 'nn-NO', 'pl-PL', 'pt-BR', 'pt-PT', 'pt-AO', 'ro-RO', 'ru-RU', 'si-LK' 'sl-SI', 'sk-SK', 'sq-AL', 'sr-RS', 'sv-SE', 'tg-TJ', 'th-TH', 'tr-TR', 'uk-UA', 'uz-UZ', 'vi-VN', 'zh-CN', 'zh-HK', 'zh-MO', 'zh-TW', 'dz-BT'], or can be left out which would implicitly set it to 'any' and it would try to find a signle valid value from the previouse list of locales (can be explicitly set as well).options is an optional dictionary that can be supplied with the following keys: strictMode, if this is set to True, the mobile number must be supplied with the country code and therefore must start with +. If an invalid locale is provided, it will raise an exception. |
| is_mongo_id(str) | check if the string is a valid hex-encoded representation of a [MongoDB ObjectId][mongoid]. |
| is_multibyte(str) | check if the string contains one or more multibyte chars. |
| is_number(str) | check if the string is a number (int or float). |
| 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. 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. |
| is_regex(str, options) | check if the string is a valid (python) regular expression. Second argument is an optional dictionary, where if you can set with_init_slashes to True, the expression in that case is expected to be surrounded with front slashes (with or without expression flags), for example /[^a-z]/i would be valid. |
| is_rgb_color(str, include_percent_values) | check if the string is a rgb or rgba color.include_percent_values defaults to True, if not set. If you don't want to allow to set rgb or rgba values with percents, like rgb(5%,5%,5%), or rgba(90%,90%,90%,.3), then set it to False. |
| is_semantic_version(str) | check if the string is a Semantic Versioning Specification. |
| is_uppercase(str) | check if the string is uppercase. |
| is_uuid(str, version) | check if the string is a UUID (version 1, 2, 3, 4 or 5), if the version is not set it will chach if it is valid for any version. |
| is_url(str, options) | check if the string is a url. Options argument is a optional dictionary and it accepts the next properties: no_scheme - if set to True it will treat invalid urls with a protocol scheme (defaults to False), with_no_path - if set to True it will treat invalid urls with a path (defaults to False), insensitive - if set to True the validation will be case insensitive (defaults to True), top_level_domains - is a list of top level domains for which the validation will end up truthy, domains - is a list of domains for which the validation will end up truthy. |
| is_slug(str) | Check if the string is of type slug. Options allow a single hyphen between string. e.g. [cn-cn, cn-c-c] |
| is_strong_password(str, options) | Check if a password is strong or not. Allows for custom requirements or scoring rules. If return_score is True, then the function returns an integer score for the password rather than a boolean.Default options: { "min_length": 8, "min_lowercase": 1, "min_uppercase": 1, "min_numbers": 1, "min_symbols": 1, "return_score": False, "points_perUnique": 1, "points_per_repeat": 0.5, "points_for_containing_lower": 10, "points_for_containing_upper": 10, "points_for_containing_number": 10, "points_for_containing_symbol": 10 } |
| is_mime_type(str) | check if the string matches to a valid MIME type format. |
| is_iso6391(str) | check if the string is a valid ISO 639-1 language code. |
Feel free to propose any change!
- Fork the repo on GitHub
- Create a unique branch with a prefix lable feat/ for new features, fix/ for any fixes or improvements or chore/ for changes not changing the validation logic, also the commit messages should be including the mentioned labels
- Work on your branch
- if modifications are chainging the behaviour of an existing validator, do upgrade the tests of it to cover that functionality as well.
- tests are the main requirement of any new validators.
- update README if required
- Commit changes to your own branch
- verify all tests are passing
- Pull changes from the origin main branch in order to avoid pull request conflicts.
- Push your work back up to your fork
- Submit a Pull request so that the changes can be reviewed