Skip to main content

Multilingual library made for validation, various form fields, such as: email, cpf, cnpj, credit card, and much more.

Project description

Multiform-validator

PyPI version License: MIT PyPI downloads

This package provides Python functions to validate various forms fields.

Documentation: https://gabriel-logan.github.io/multiform-validator/documentation/py

Feel free to find bugs and report them to me. Your feedback is highly appreciated. Hugs from Gabriel Logan!

If you want to help me, you can buy me a coffee (:

Buy Me A Coffee

Installation

pip install multiform-validator

Data Validator

This package contains various modules for validating different types of data. Below are the available validation modules:

Avaliable for while

  • cnpjValidator: CNPJ validation.
  • cpfValidator: CPF validation.
  • getOnlyEmail: Extracts only the email or emails address from a string.
  • identifyFlagCard: Identifies the flag of a credit card.
  • isCreditCardValid: Credit card validation.
  • isEmail: Email address validation format.
  • passwordStrengthTester: Password strength test.
  • validateBRPhoneNumber: Brazilian phone number validation.

Usage

Here is an example of how to use the functions in this package:

from multiform_validator import (
    cnpjIsValid,
    cpfIsValid,
    getOnlyEmail,
    identifyFlagCard,
    isCreditCardValid,
    isEmail,
    passwordStrengthTester,
    validateBRPhoneNumber
)
print("Is email", isEmail("foo@bar.com")) # True
print("Get only email", getOnlyEmail("awdawd wadawd wda awd jhony@gmail.com awdawdawd")) # jhony@gmail.com
print("Password strength", passwordStrengthTester("aA1!asd@qd2asd")) # Strong
print("Is CPF valid", cpfIsValid("123.456.789-02")['isValid']) # False
print("Is CNPJ valid", cnpjIsValid("12.345.678/0001-09")) # { 'isValid': False, 'errorMsg': 'CNPJ is not valid' }
print("Is credit card valid", isCreditCardValid("5117 2161 1334 8362")) # True
print("Identify flag card", identifyFlagCard("5117 2161 1334 8362")) # Mastercard
print("Validate BR phone number", validateBRPhoneNumber("(11) 91234-5678")) # { 'isValid': True, 'errorMsg': None }

Functions signature

All params with default values are optional.

def isEmail(email: str) -> bool:
    pass

def getOnlyEmail(text: str, multiple=False, clean_domain=False, repeat_email=False) -> str:
    pass

def passwordStrengthTester(password: str) -> str:
    pass

defaultErrorMsgCPF = [
  'CPF invalid',
  'CPF must have 11 numerical digits',
  'CPF is not valid',
  'Unknown error',
]
def cpfIsValid(cpf: str, errorMsg=defaultErrorMsgCPF) -> Dict[str, Union[bool, str, None]]:
    pass

default_error_msgCNPJ = [
   'CNPJ invalid', 
   'CNPJ must have 14 numerical digits', 
   'CNPJ is not valid', 
   'Unknown error'
]
def cnpjIsValid(cnpj: str, errorMsg=default_error_msgCNPJ) -> Dict[str, Union[bool, str, None]]:
    pass

def isCreditCardValid(cardNumber: str) -> bool:
    pass

def identifyFlagCard(cardNumber: str) -> str:
    pass

default_error_msg = ['Invalid value passed', 'Invalid phone number', 'Unknown error']
def validateBRPhoneNumber(phoneNumber: str, errorMsg=default_error_msg) -> Dict[str, Union[bool, str, None]]:
    pass

Looking for contributions.

Available Validation Modules !!! STILL NOT AVALIABLE !!!

  • isAscii: Checks if the string contains only ASCII characters.
  • isBase64: Checks if the string is a valid Base64 encoding.
  • isCEP: CEP validation (Brazilian postal code).
  • isDate: Date format validation.
  • isDecimal: Checks if the number is a decimal.
  • isEmpty: Checks if the string is empty.
  • isMACAddress: MAC address validation.
  • isMD5: Checks if the string is a valid MD5 hash.
  • validatePassportNumber: Passport number validation.
  • isPort: Port number validation.
  • isPostalCode: Postal code validation.
  • isTime: Time format validation.
  • validateEmail: Email address full validation.
  • validatePassword: Password validation.
  • validatePhoneNumber: Phone number validation.
  • validateUsername: Username validation.
  • validateUSPhoneNumber: US phone number validation.
  • isNumber: Checks if the value is a number.
  • validateName: Name validation.
  • validateSurname: Surname validation.
  • validateTextarea: Textarea validation.

For better information, read the documentation

Feel free to explore the various functions and experiment with different inputs to understand their behavior. If you encounter any issues or have suggestions, don't hesitate to reach out to me. Your feedback is valuable and helps improve the package. Happy coding!

By - Gabriel Logan

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

multiform_validator-0.0.9.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

multiform_validator-0.0.9-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file multiform_validator-0.0.9.tar.gz.

File metadata

  • Download URL: multiform_validator-0.0.9.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for multiform_validator-0.0.9.tar.gz
Algorithm Hash digest
SHA256 994c21c235603d8cce39047de4fe9e6221ce374e006872ab1d0fcfd8fa6ea0b9
MD5 0b7b28bff3b42ffc82bd0948d2135dee
BLAKE2b-256 72b1a0683f95fd9c58913594ca1bb0afa39471fd31dab095830064d033f201e1

See more details on using hashes here.

File details

Details for the file multiform_validator-0.0.9-py3-none-any.whl.

File metadata

File hashes

Hashes for multiform_validator-0.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 8f57e75d05a0ac70b0d53a1891bd2f14d6903b1446c74ea610dd973cd9e065da
MD5 18a28588428ca2453c2ed563e45c241b
BLAKE2b-256 cf22323ed2e9687f3fb69e54a33633031b32f37afb7c20c153b89383e4131558

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page