Skip to content

Commit

Permalink
Merge pull request #19 from Jonatha-Varjao/feature/validate_list
Browse files Browse the repository at this point in the history
Adding validate_list function into BaseDoc class #16
  • Loading branch information
alvarofpp authored Oct 2, 2019
2 parents ead9282 + ae887e2 commit 72bf27c
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/guia-de-uso.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 5 additions & 0 deletions validate_docbr/BaseDoc.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
from abc import ABC
from typing import List


class BaseDoc(ABC):
Expand All @@ -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."""
Expand Down

0 comments on commit 72bf27c

Please sign in to comment.