Skip to content

Commit

Permalink
Merge pull request #20 from alvarofpp/v1.4.0
Browse files Browse the repository at this point in the history
V1.4.0
  • Loading branch information
alvarofpp authored Oct 2, 2019
2 parents 72bf27c + 9483875 commit ad05723
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 6 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,25 @@ cpf.validate("012.345.678-90") # True
cpf.validate("012.345.678-91") # False
```

[Caso especial de CPF](https://alvarofpp.github.io/validate-docbr/guia-de-uso/#caso-especial-de-cpf).

### validate_list

Valida uma lista de documentos passado como argumento. Retorna uma lista de `bool`, `True` caso seja válido, `False` caso contrário. Recebe os parâmetros:

| Parâmetro | Tipo | Valor padrão | Obrigatório | Descrição |
| --------- | ---- | ----------- | ------------ | --------- |
| `docs` | `List[str]`| `[]` | X | A lista de 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
4 changes: 2 additions & 2 deletions docs/guia-de-uso.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,11 +54,11 @@ 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:
Valida uma lista de documentos passado como argumento. Retorna uma lista de `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. |
| `docs` | `List[str]`| `[]` | X | A lista de documentos para validar. |

```python
from validate_docbr import CPF
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

setuptools.setup(
name="validate_docbr",
version="1.3.0",
version="1.4.0",
author="Álvaro Ferreira Pires de Paiva",
author_email="[email protected]",
description="Validate brazilian documents.",
Expand Down
6 changes: 3 additions & 3 deletions validate_docbr/BaseDoc.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +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 ]
return [self.validate(doc) for doc in docs]

def generate(self, mask: bool = False) -> str:
"""Método para gerar um documento válido."""
Expand All @@ -32,7 +32,7 @@ def generate_list(self, n: int = 1, mask: bool = False, repeat: bool = False) ->
unique_values = len(doc_set)

if unique_values < n:
doc_list = list(doc_set) + self.generate_list((n-unique_values), mask, repeat)
doc_list = list(doc_set) + self.generate_list((n - unique_values), mask, repeat)
else:
repeat = True

Expand Down

0 comments on commit ad05723

Please sign in to comment.