diff --git a/docs/guia-de-uso.md b/docs/guia-de-uso.md index 9ff9d4b..bc48686 100644 --- a/docs/guia-de-uso.md +++ b/docs/guia-de-uso.md @@ -51,6 +51,24 @@ cpf.repeated_digits = False cpf.validate("111.111.111-11") # False ``` +------------ +## validate_list + +Valida uma lista contendo documentos passado como argumento. Retorna uma lista contendo `bool`, `True` caso seja válido, `False` caso contrário. Recebe os parâmetros: + +| Parâmetro | Tipo | Valor padrão | Obrigatório | Descrição | +| --------- | ---- | ----------- | ------------ | --------- | +| `doc` | `List[str]`| `[]` | X | A lista contendo documentos para validar. | + +```python +from validate_docbr import CPF + +cpf = CPF() + +# Validar CPFs +cpf.validate_list(["012.345.678-90", "012.345.678-91"]) # [True, False] +``` + ------------ ## generate Gera um novo documento, retorna em formato de `str`. Recebe os parâmetros: diff --git a/validate_docbr/BaseDoc.py b/validate_docbr/BaseDoc.py index 9ef76c8..a8f15b2 100644 --- a/validate_docbr/BaseDoc.py +++ b/validate_docbr/BaseDoc.py @@ -1,4 +1,5 @@ from abc import ABC +from typing import List class BaseDoc(ABC): @@ -7,6 +8,10 @@ class BaseDoc(ABC): def validate(self, doc: str = '') -> bool: """Método para validar o documento desejado.""" pass + + def validate_list(self, docs: List[str]) -> List[bool]: + """Método para validar uma lista de documentos desejado.""" + return [ self.validate(doc) for doc in docs ] def generate(self, mask: bool = False) -> str: """Método para gerar um documento válido."""