Skip to content
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
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ False

### What if I want to format a numbers only string?
```
>>> cpf.display('00011122233')
>>> from brutils import format_cpf, format_cnpj
>>> format_cpf('00011122233')
'000.111.222-33'
>>> from brutils import format_cnpj
>>> format_cnpj('00111222000100')
'00.111.222/0001-00'
```
Expand Down
4 changes: 2 additions & 2 deletions README_PT_BR.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ False

### E se eu quiser formatar uma string numérica?
```
>>> cpf.display('00011122233')
>>> from brutils import format_cpf, format_cnpj
>>> format_cpf('00011122233')
'000.111.222-33'
>>> from brutils import format_cnpj
>>> format_cnpj('00111222000100')
'00.111.222/0001-00'
```
Expand Down
2 changes: 1 addition & 1 deletion brutils/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
from brutils.cpf import is_valid as is_valid_cpf
from brutils.cpf import is_valid as is_valid_cpf, format_cpf
from brutils.cnpj import is_valid as is_valid_cnpj, format_cnpj
8 changes: 8 additions & 0 deletions brutils/cpf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ def display(cpf): # type: (str) -> str
return "{}.{}.{}-{}".format(cpf[:3], cpf[3:6], cpf[6:9], cpf[9:])


def format_cpf(cpf): # type: (str) -> str
"""
Will format an adequately formatted numbers-only CPF string,
adding in standard formatting visual aid symbols for display.
"""
return display(cpf)


# CALCULATORS
#############

Expand Down
7 changes: 7 additions & 0 deletions tests/test_cpf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
validate,
generate,
is_valid,
format_cpf,
)
from unittest import TestCase, main

Expand All @@ -35,6 +36,12 @@ def test_display(self):
assert display("0000000000a") is None
assert display("000000000000") is None

def test_format_cpf(self):
assert format_cpf("00000000011") == "000.000.000-11"
assert format_cpf("00000000000") is None
assert format_cpf("0000000000a") is None
assert format_cpf("000000000000") is None

def test_hashdigit(self):
assert hashdigit("000000000", 10) == 0
assert hashdigit("0000000000", 11) == 0
Expand Down