Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Alteração do nome dos métodos parse para remove_symbols #112

Merged
merged 4 commits into from
Jun 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ False
- [CPF](#cpf)
- [is_valid_cpf](#is_valid_cpf)
- [format_cpf](#format_cpf)
- [parse_cpf](#parse_cpf)
- [remove_symbols_cpf](#remove_symbols_cpf)
- [generate_cpf](#generate_cpf)
- [CNPJ](#cnpj)
- [is_valid_cnpj](#is_valid_cnpj)
- [format_cnpj](#format_cnpj)
- [parse_cnpj](#parse_cnpj)
- [remove_symbols_cnpj](#remove_symbols_cnpj)
- [generate_cnpj](#generate_cnpj)

## CPF
Expand All @@ -67,13 +67,13 @@ Formata o CPF. Retorna None se o CPF for inválido.
'111.444.777-35'
```

### parse_cpf
### remove_symbols_cpf

Remove os símbolos de formatação do CPF e retorna somente números. Filtra apenas os símbolos utilizados para a validação do CPF. Propositalmente não remove outros símbolos.

```python
>>> from brutils import parse_cpf
>>> parse_cpf('000.111.222-33')
>>> from brutils import remove_symbols_cpf
>>> remove_symbols_cpf('000.111.222-33')
'00011122233'
```
### generate_cpf
Expand Down Expand Up @@ -108,13 +108,13 @@ Formata o CNPJ.
'00.111.222/0001-00'
```

### parse_cnpj
### remove_symbols_cnpj

Remove os símbolos de formatação do CPF e retorna somente números. Filtra apenas os símbolos utilizados para a validação do CPF. Propositalmente não remove outros símbolos.

```python
>>> from brutils import parse_cnpj
>>> parse_cnpj('00.111.222/0001-00')
>>> from brutils import remove_symbols_cnpj
>>> remove_symbols_cnpj('00.111.222/0001-00')
'00111222000100'
```

Expand Down
16 changes: 8 additions & 8 deletions README_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ False
- [CPF](#cpf)
- [is_valid_cpf](#is_valid_cpf)
- [format_cpf](#format_cpf)
- [parse_cpf](#parse_cpf)
- [remove_symbols_cpf](#remove_symbols_cpf)
- [generate_cpf](#generate_cpf)
- [CNPJ](#cnpj)
- [is_valid_cnpj](#is_valid_cnpj)
- [format_cnpj](#format_cnpj)
- [parse_cnpj](#parse_cnpj)
- [remove_symbols_cnpj](#remove_symbols_cnpj)
- [generate_cnpj](#generate_cnpj)

## CPF
Expand All @@ -67,15 +67,15 @@ Format CPF. Returns None if CPF is invalid.
'111.444.777-35'
```

### parse_cpf
### remove_symbols_cpf

Remove formatting symbols from CPF and return only digits.
It only filters out the symbols used for CPF validation.
It purposefully doesn't remove other symbols.

```python
>>> from brutils import parse_cpf
>>> parse_cpf('000.111.222-33')
>>> from brutils import remove_symbols_cpf
>>> remove_symbols_cpf('000.111.222-33')
'00011122233'
```

Expand Down Expand Up @@ -111,15 +111,15 @@ Format CNPJ.
'00.111.222/0001-00'
```

### parse_cnpj
### remove_symbols_cnpj

Remove formatting symbols from CNPJ and return only digits.
It only filters out the symbols used for CNPJ validation.
It purposefully doesn't remove other symbols.

```python
>>> from brutils import parse_cnpj
>>> parse_cnpj('00.111.222/0001-00')
>>> from brutils import remove_symbols_cnpj
>>> remove_symbols_cnpj('00.111.222/0001-00')
'00111222000100'
```

Expand Down
4 changes: 2 additions & 2 deletions brutils/__init__.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
from brutils.cpf import (
is_valid as is_valid_cpf,
format_cpf,
parse as parse_cpf,
remove_symbols as remove_symbols_cpf,
generate as generate_cpf,
)
from brutils.cnpj import (
is_valid as is_valid_cnpj,
format_cnpj,
parse as parse_cnpj,
remove_symbols as remove_symbols_cnpj,
generate as generate_cnpj,
)
2 changes: 1 addition & 1 deletion brutils/cnpj.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ def sieve(dirty): # type: (str) -> str
return "".join(filter(lambda char: char not in "./-", dirty))


def parse(dirty): # type: (str) -> str
def remove_symbols(dirty): # type: (str) -> str
"""Alias to the function `sieve`. Better naming."""
return sieve(dirty)

Expand Down
2 changes: 1 addition & 1 deletion brutils/cpf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ def sieve(dirty): # type: (str) -> str
return "".join(filter(lambda char: char not in ".-", dirty))


def parse(dirty): # type: (str) -> str
def remove_symbols(dirty): # type: (str) -> str
"""Alias to the function `sieve`. Better naming."""
return sieve(dirty)

Expand Down
8 changes: 4 additions & 4 deletions tests/test_cnpj.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
generate,
is_valid,
format_cnpj,
parse,
remove_symbols,
)
from unittest import TestCase, main

Expand All @@ -32,10 +32,10 @@ def test_sieve(self):
assert sieve("ab.c1.--.2-3/09.-1-./6/-.*.-!*&#") == "abc1230916*!*&#"
assert sieve("/...---.../") == ""

def test_parse(self):
def test_remove_symbols(self):
with patch("brutils.cnpj.sieve") as mock_sieve:
# When call parse, it calls sieve
parse("12.345.678/0001-90")
# When call remove_symbols, it calls sieve
remove_symbols("12.345.678/0001-90")
mock_sieve.assert_called()

def test_display(self):
Expand Down
8 changes: 4 additions & 4 deletions tests/test_cpf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
generate,
is_valid,
format_cpf,
parse,
remove_symbols,
_hashdigit,
_checksum,
)
Expand All @@ -32,10 +32,10 @@ def test_sieve(self):
assert sieve("ab.c1.--.2-309.-1-.6-.*.-!*&#") == "abc1230916*!*&#"
assert sieve("...---...") == ""

def test_parse(self):
def test_remove_symbols(self):
with patch("brutils.cpf.sieve") as mock_sieve:
# When call parse, it calls sieve
parse("123.456.789-10")
# When call remove_symbols, it calls sieve
remove_symbols("123.456.789-10")
mock_sieve.assert_called()

def test_display(self):
Expand Down