Repository: brazilian-utils/brutils-python
Pull request #112 (2023-06-25 10:38:22)

Alteração do nome dos métodos `parse` para `remove_symbols` 
* Alteração de `cpf.parse` para `cpf.remove_symbols`
* Alteração de `parse_cpf` para `remove_symbols_cpf`
* Alteração de `cnpj.parse` para `cnpj.remove_symbols`
* Alteração de `parse_cnpj` para `remove_symbols_cnpj`
* Atualização da documentação


codecov[bot]: ## [Codecov](https://app.codecov.io/gh/brazilian-utils/brutils-python/pull/112?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=brazilian-utils) Report
> Merging [#112](https://app.codecov.io/gh/brazilian-utils/brutils-python/pull/112?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=brazilian-utils) (080f5b3) into [main](https://app.codecov.io/gh/brazilian-utils/brutils-python/commit/5ad023f9f6fdb2bc1a3003be84de9e1b613fe8a0?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=brazilian-utils) (5ad023f) will **not change** coverage.
> The diff coverage is `100.00%`.

```diff
@@           Coverage Diff           @@
##             main     #112   +/-   ##
=======================================
  Coverage   98.46%   98.46%           
=======================================
  Files           3        3           
  Lines          65       65           
=======================================
  Hits           64       64           
  Misses          1        1           
```


| [Impacted Files](https://app.codecov.io/gh/brazilian-utils/brutils-python/pull/112?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=brazilian-utils) | Coverage Δ | |
|---|---|---|
| [brutils/\_\_init\_\_.py](https://app.codecov.io/gh/brazilian-utils/brutils-python/pull/112?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=brazilian-utils#diff-YnJ1dGlscy9fX2luaXRfXy5weQ==) | `100.00% <ø> (ø)` | |
| [brutils/cnpj.py](https://app.codecov.io/gh/brazilian-utils/brutils-python/pull/112?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=brazilian-utils#diff-YnJ1dGlscy9jbnBqLnB5) | `97.05% <100.00%> (ø)` | |
| [brutils/cpf.py](https://app.codecov.io/gh/brazilian-utils/brutils-python/pull/112?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=brazilian-utils#diff-YnJ1dGlscy9jcGYucHk=) | `100.00% <100.00%> (ø)` | |


antoniamaia: closes #110 
camilamaia: Ah, aqui também daria para deixar o título e a descrição do PR um pouco mais explícitos. Por exemplo:

Título
```Alteração do nome dos métodos `parse` para `remove_symbols` ```

Descrição
```
* Alteração de `cpf.parse` para `cpf.remove_symbols`
* Alteração de `parse_cpf` para `remove_symbols_cpf`
* Alteração de `cnpj.parse` para `cnpj.remove_symbols`
* Alteração de `parse_cnpj` para `remove_symbols_cnpj`
* Atualização da documentação

Closes #110
```
antoniamaia: > Ah, aqui também daria para deixar o título e a descrição do PR um pouco mais explícitos. Por exemplo:
> 
> Título `` Alteração do nome dos métodos `parse` para `remove_symbols` ``
> 
> Descrição
> 
> ```
> * Alteração de `cpf.parse` para `cpf.remove_symbols`
> * Alteração de `parse_cpf` para `remove_symbols_cpf`
> * Alteração de `cnpj.parse` para `cnpj.remove_symbols`
> * Alteração de `parse_cnpj` para `remove_symbols_cnpj`
> * Atualização da documentação
> 
> Closes #110
> ```
> 
> Ah, e sempre dá para editar as informações do PR depois
> 
> ![image](https://user-images.githubusercontent.com/2728804/248744986-c308bce3-cb96-4009-998c-1474f3f475bb.png)
> 
> ![image](https://user-images.githubusercontent.com/2728804/248745049-f38ed440-b7a1-4839-a5b1-663241464cc8.png)

Obrigada, @camilamaia! Você é perfeita ❤️ estudar com você é sensacional, tudo muito claro e bem explicadinho! Acredito que agora, finally closed #110?  🙌🏼 
antoniamaia: > Obrigada, @camilamaia! Você é perfeita heart estudar com você é sensacional, tudo muito claro e bem explicadinho! Acredito que agora, finally closed #110? 🙌🏼



Patch:
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d8d616a..7b99b39 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,42 +1,42 @@
 # Contributing
 
-Thanks for taking the time to contribute! 🙇‍♀️🙇‍♂️ Every little bit of help counts!
+Obrigada por disponibilizar seu tempo para contribuir! 🙇‍♀️🙇‍♂️ Toda ajuda é bem-vinda!
 
-## Installation
-### Requirements
+## Instalação
+### Requisitos
 - [Python 3.7+][python]
 - [Poetry][poetry]
 
-Fork or clone the repository and enter into the project's folder:
+'Fork' ou clone o repositório e entre na pasta do projeto:
 
 ```shell
 $ git clone git@github.com:brazilian-utils/brutils-python.git
 $ cd brutils-python
 ```
 
-Create a [virtualenv][virtualenv] for brutils and activate it:
+Crie uma [virtualenv][virtualenv] para brutils e ative:
 
 ```shell
 $ make shell
 ```
 
-**Note: You need to run `make shell` every time you open a new terminal window/tab.**
+**Nota: Você vai precisar rodar `make shell` todas as vezes que abrir um novo terminal.**
 
-Install the dependencies:
+Instale as dependências:
 
 ```shell
 $ make install
 ```
 
-## Using locally
+## Usando localmente
 
 ```shell
 $ make run-python
 ```
 
-Now, you can use it [in the same way described in the README.md file](/README.md#usage)
+Agora, você pode usá-lo [da mesma forma descrita no arquivo README.md](/README.md#usage)
 
-## Tests
+## Testes
 
 ```shell
 $ make test
diff --git a/CONTRIBUTING_EN.md b/CONTRIBUTING_EN.md
new file mode 100644
index 0000000..8ba4a3b
--- /dev/null
+++ b/CONTRIBUTING_EN.md
@@ -0,0 +1,47 @@
+# Contributing
+
+Thanks for taking the time to contribute! 🙇‍♀️🙇‍♂️ Every little bit of help counts!
+
+## Installation
+### Requirements
+- [Python 3.7+][python]
+- [Poetry][poetry]
+
+Fork or clone the repository and enter into the project's folder:
+
+```shell
+$ git clone git@github.com:brazilian-utils/brutils-python.git
+$ cd brutils-python
+```
+
+Create a [virtualenv][virtualenv] for brutils and activate it:
+
+```shell
+$ make shell
+```
+
+**Note: You need to run `make shell` every time you open a new terminal window/tab.**
+
+Install the dependencies:
+
+```shell
+$ make install
+```
+
+## Using locally
+
+```shell
+$ make run-python
+```
+
+Now, you can use it [in the same way described in the README.md file](/README_EN.md#usage)
+
+## Tests
+
+```shell
+$ make test
+```
+
+[poetry]: https://python-poetry.org/docs/#installation
+[python]: https://www.python.org/downloads/
+[virtualenv]: https://virtualenv.pypa.io/en/latest/
diff --git a/README.md b/README.md
index 19246e0..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'
 ```
 
@@ -127,3 +127,12 @@ Gera um CNPJ válido aleatório.
 >>> generate_cnpj()
 '34665388000161'
 ```
+
+## Contributing
+
+Sua colaboração é sempre bem-vinda! Preparamos o [arquivo contributing][contributing] pra te ajudar nos primeiros passos. Toda ajuda conta! Sinta-se livre para criar novas [GitHub issues][github-issues] e interagir aqui.
+
+Vamos construir juntos! 🚀🚀
+
+[github-issues]: https://github.com/brazilian-utils/brutils-python/issues
+[contributing]: CONTRIBUTING.md
diff --git a/README_EN.md b/README_EN.md
index c607124..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'
 ```
 
@@ -132,3 +132,12 @@ Generate a valid random CNPJ.
 >>> generate_cnpj()
 '34665388000161'
 ```
+
+## Contributing
+
+Collaboration is super welcome! We prepared the [contributing file][contributing] to help you in the first steps. Every little bit of help counts! Feel free to create new [GitHub issues][github-issues] and interact here.
+
+Let's build it together 🚀🚀
+
+[github-issues]: https://github.com/brazilian-utils/brutils-python/issues
+[contributing]: CONTRIBUTING_EN.md
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)
 


Test patch:
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 @@ from brutils.cnpj import (
     generate,
     is_valid,
     format_cnpj,
-    parse,
+    remove_symbols,
 )
 from unittest import TestCase, main
 
@@ -32,10 +32,10 @@ class CNPJ(TestCase):
         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 @@ from brutils.cpf import (
     generate,
     is_valid,
     format_cpf,
-    parse,
+    remove_symbols,
     _hashdigit,
     _checksum,
 )
@@ -32,10 +32,10 @@ class CPF(TestCase):
         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):