From 1b12ebfcbdef3715a1969139549d1038074f42aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maria=20Ant=C3=B4nia=20Maia?= Date: Tue, 27 Jun 2023 06:55:27 -0300 Subject: [PATCH] =?UTF-8?q?Altera=C3=A7=C3=A3o=20do=20nome=20dos=20m=C3=A9?= =?UTF-8?q?todos=20`parse`=20para=20`remove=5Fsymbols`=20=20(#112)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 16 ++++++++-------- README_EN.md | 16 ++++++++-------- brutils/__init__.py | 4 ++-- brutils/cnpj.py | 2 +- brutils/cpf.py | 2 +- tests/test_cnpj.py | 8 ++++---- tests/test_cpf.py | 8 ++++---- 7 files changed, 28 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 1effea7..39db492 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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' ``` diff --git a/README_EN.md b/README_EN.md index 3c72306..59d7119 100644 --- a/README_EN.md +++ b/README_EN.md @@ -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 @@ -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' ``` @@ -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' ``` diff --git a/brutils/__init__.py b/brutils/__init__.py index 33b415a..9f5de8d 100644 --- a/brutils/__init__.py +++ b/brutils/__init__.py @@ -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, ) diff --git a/brutils/cnpj.py b/brutils/cnpj.py index 540d199..efca157 100644 --- a/brutils/cnpj.py +++ b/brutils/cnpj.py @@ -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) diff --git a/brutils/cpf.py b/brutils/cpf.py index d0dad3c..ea93e75 100644 --- a/brutils/cpf.py +++ b/brutils/cpf.py @@ -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) diff --git a/tests/test_cnpj.py b/tests/test_cnpj.py index 40ab7e6..08b5cb8 100644 --- a/tests/test_cnpj.py +++ b/tests/test_cnpj.py @@ -18,7 +18,7 @@ generate, is_valid, format_cnpj, - parse, + remove_symbols, ) from unittest import TestCase, main @@ -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): diff --git a/tests/test_cpf.py b/tests/test_cpf.py index 434ddef..ff6aa4b 100644 --- a/tests/test_cpf.py +++ b/tests/test_cpf.py @@ -16,7 +16,7 @@ generate, is_valid, format_cpf, - parse, + remove_symbols, _hashdigit, _checksum, ) @@ -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):