Some cleaning and organization in the code (#44)

fordev/consts.py

@@ -2,14 +2,15 @@
 fordev.consts
 -------------
 
-Este módulo contém todas as variáveis com valores constantes usadas no pacote fordev.
+Este módulo contém todas as variáveis com valores constantes
+usadas no pacote fordev.
 """
 
 URL_4DEV_API = 'https://www.4devs.com.br/ferramentas_online.php'
 
 ALL_UF_CODE = [
     'AC', 'AL', 'AP', 'AM', 'BA', 'CE', 'ES', 'GO', 'MA',
-    'MT', 'MS', 'MG','PA', 'PB', 'PR', 'PE', 'PI', 'RJ',
+    'MT', 'MS', 'MG', 'PA', 'PB', 'PR', 'PE', 'PI', 'RJ',
     'RN', 'RS', 'RO', 'RR', 'SC', 'SP', 'SE', 'TO', 'DF'
 ]
 

fordev/core.py

@@ -18,7 +18,8 @@ def _create_headers(content_length: int, referer: str) -> dict:
     Parameters
     ----------
     content_length
-        Indica o tamanho do entity-body, em bytes, enviados no header para o destinatário.
+        Indica o tamanho do entity-body, em bytes, enviados no header
+        para o destinatário.
 
     referer
         Referência a ação a ser executada pela API do site 4devs.
@@ -28,8 +29,9 @@ def _create_headers(content_length: int, referer: str) -> dict:
 
     headers = {
         'user-agent': (
-            'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko)'
-            'Chrome/106.0.0.0 Safari/537.36'
+            'Mozilla/5.0 (Windows NT 10.0; Win64; x64)'
+            ' AppleWebKit/537.36 (KHTML, like Gecko)'
+            ' Chrome/106.0.0.0 Safari/537.36'
         ),
         'authority': 'www.4devs.com.br',
         'method': 'POST',
@@ -59,14 +61,16 @@ def fordev_request(content_length: int, referer: str, payload: dict) -> dict:
     Parameters
     ----------
     content_length
-        Indica o tamanho do entity-body, em bytes, enviados no header para o destinatário.
+        Indica o tamanho do entity-body, em bytes, enviados no header
+        para o destinatário.
 
     referer
         Referência a ação a ser executada pela API do site 4devs.
         Pode-se interpretar como o endpoint do serviço a ser disponibilizado.
 
     payload
-        Um dicionário de dados contendo a ação e outros dados solicitados pela API.
+        Um dicionário de dados contendo a ação e outros dados
+        solicitados pela API.
     """
 
     try:

fordev/filters.py

@@ -42,7 +42,9 @@ def filter_bank_account_info(html: str) -> dict:
 
     labels = [div.text for div in soup.find_all('div', 'output-subtitle')]
 
-    data_of_bank_account = [div.text for div in soup.find_all('div', 'output-txt')]
+    data_of_bank_account = [
+        div.text for div in soup.find_all('div', 'output-txt')
+    ]
 
     data_dict = dict(
         zip(labels, data_of_bank_account)
@@ -65,7 +67,8 @@ def filter_vehicle_info(html: str) -> dict:
 
     labels = [div.text[:-1] for div in soup.find_all('strong')]
 
-    data_of_vehicle = [input_.get('value') for input_ in soup.find_all('input', 'margem_menor')]
+    data_of_vehicle = [input_.get('value')
+                       for input_ in soup.find_all('input', 'margem_menor')]
 
     data_dict = dict(
         zip(labels, data_of_vehicle)
@@ -88,7 +91,8 @@ def filter_credit_card_info(html: str) -> dict:
 
     labels = [div.text for div in soup.find_all('div', 'output-subtitle')]
 
-    data_of_credit_card = [div.text.strip() for div in soup.find_all('div', 'output-txt')]
+    data_of_credit_card = [div.text.strip()
+                           for div in soup.find_all('div', 'output-txt')]
 
     data_dict = dict(
         zip(labels, data_of_credit_card)
@@ -98,7 +102,8 @@ def filter_credit_card_info(html: str) -> dict:
 
 
 def filter_company_info(html: str) -> dict:
-    """Filtra dados de companhia (empresa/organização) contidos na estrutura HTML.
+    """Filtra dados de companhia (empresa/organização) contidos na
+    estrutura HTML.
 
     Parameters
     ----------
@@ -111,7 +116,8 @@ def filter_company_info(html: str) -> dict:
 
     labels = [div.text[:-1] for div in soup.find_all('strong')]
 
-    data_of_company = [input_.get('value') for input_ in soup.find_all('input', 'margem_menor')]
+    data_of_company = [input_.get('value')
+                       for input_ in soup.find_all('input', 'margem_menor')]
 
     data_dict = dict(
         zip(labels, data_of_company)

fordev/generators/__init__.py

@@ -2,8 +2,8 @@
 fordev.generators
 -----------------
 
-Este módulo coleta dados aleatórios gerados pelo site `4Devs <https://www.4devs.com.br/>`_
-e disponíbiliza uma API simples para uso.
+Este módulo coleta dados aleatórios gerados pelo site
+`4Devs <https://www.4devs.com.br/>`_ e disponíbiliza uma API simples para uso.
 
 Use a função ``help()`` para mais informações:
 
@@ -30,16 +30,18 @@
     Recebe o Código da **Unidade Federativa** para geração do dado.
 
     Caso não saiba o que é ou não conheça o do estado que necessita,
-    obtenha mais informações em: https://pt.wikipedia.org/wiki/Subdivis%C3%B5es_do_Brasil
+    obtenha mais informações em:
+     - https://pt.wikipedia.org/wiki/Subdivisões_do_Brasil
 
 formatting: bool
     Se receber o valor ``True``, retorna os dados formatados.
     Se receber o valor ``False``, retorna os dados sem formatação.
 
 data_only: bool
     Se receber o valor ``True``, retorna somente os dados em texto puro.
-    Se receber o valor ``False``, retorna um dicionário contendo uma chave ``msg`` e ``data`` ou ``error``
-    contendo valores correspondentes à nomenclatura de suas chaves.
+    Se receber o valor ``False``, retorna um dicionário contendo uma
+    chave ``msg`` e ``data`` ou ``error`` contendo valores correspondentes
+    à nomenclatura de suas chaves.
 
 Sendo assim, sempre que os encontrar, utilize conforme o descrito acima.
 """

fordev/generators/bank_account.py

@@ -11,7 +11,11 @@
 from fordev.validators.utils import raise_for_invalid_uf
 
 
-def bank_account(bank: int=0, uf_code: str='', data_only: bool=True) -> dict:
+def bank_account(
+    bank: int = 0,
+    uf_code: str = '',
+    data_only: bool = True
+) -> dict:
     """Gere dados de conta bancária.
 
     Parameters
@@ -26,8 +30,8 @@ def bank_account(bank: int=0, uf_code: str='', data_only: bool=True) -> dict:
 
     if not (0 <= bank <= 5):
         msg_error = (
-            f'The bank code value "{bank}" is invalid. Enter a valid bank code.'
-            ' The range is 0 to 5.'
+            f'The bank code value "{bank}" is invalid.'
+            ' Enter a valid bank code. The range is 0 to 5.'
         )
 
         raise ValueError(msg_error)

fordev/generators/certificate.py

@@ -3,13 +3,20 @@
 -----------------------------
 """
 
+from typing import Union
+
 from fordev.core import fordev_request
 
 from fordev.filters import data_format
 
 
-def certificate(type_: str='I', formatting: bool=True, data_only: bool=True) -> str:
-    """Gere o código de certidões (birth, wedding, religious wedding and death) aleatórias.
+def certificate(
+    type_: str = 'I',
+    formatting: bool = True,
+    data_only: bool = True
+) -> Union[str, dict]:
+    """Gere o código de certidões (birth, wedding, religious wedding and death)
+    aleatórias.
 
     Parameters
     ----------

fordev/generators/city.py

@@ -3,6 +3,8 @@
 ----------------------
 """
 
+from typing import Union
+
 from fordev.core import fordev_request
 
 from fordev.validators.utils import raise_for_invalid_uf
@@ -11,7 +13,7 @@
 from fordev.filters import data_format
 
 
-def city(uf_code: str='SP', data_only: bool=True) -> list:
+def city(uf_code: str = 'SP', data_only: bool = True) -> Union[list, dict]:
     """Obtenha as cidades do UF especificado."""
 
     uf_code = uf_code.upper()

fordev/generators/cnh.py

@@ -3,12 +3,14 @@
 ---------------------
 """
 
+from typing import Union
+
 from fordev.core import fordev_request
 
 from fordev.filters import data_format
 
 
-def cnh(data_only: bool=True) -> str:
+def cnh(data_only: bool = True) -> Union[str, dict]:
     """Geração aleatória de CNH (Carteira Nacional de Habilitação)."""
 
     resp = fordev_request(

fordev/generators/cnpj.py

@@ -3,13 +3,17 @@
 ----------------------
 """
 
+from typing import Union
+
 from fordev.core import fordev_request
 
 from fordev.filters import data_format
 
 
-def cnpj(formatting: bool=True, data_only: bool=True) -> str:
-    """Gere o código do CNPJ(Cadastro Nacional da Pessoa Jurídica) aleatório."""
+def cnpj(formatting: bool = True, data_only: bool = True) -> Union[str, dict]:
+    """Gere o código do CNPJ(Cadastro Nacional da Pessoa Jurídica)
+    aleatório.
+    """
 
     resp = fordev_request(
         content_length=27,

fordev/generators/company.py

@@ -11,7 +11,12 @@
 from fordev.filters import data_format
 
 
-def company(uf_code: str='SP', age: int=1, formatting: bool=True, data_only: bool=True) -> dict:
+def company(
+    uf_code: str = 'SP',
+    age: int = 1,
+    formatting: bool = True,
+    data_only: bool = True
+) -> dict:
     """Gere dados de companhia (empresa/organização) aleatório.
 
     Parameters
@@ -26,8 +31,8 @@ def company(uf_code: str='SP', age: int=1, formatting: bool=True, data_only: boo
 
     if not (1 <= age <= 30):
         msg_error = (
-            f'The company age value "{age}" is invalid. Enter a valid company age.'
-            ' The range is 1 to 30.'
+            f'The company age value "{age}" is invalid.'
+            ' Enter a valid company age. The range is 1 to 30.'
         )
 
         raise ValueError(msg_error)

fordev/generators/cpf.py

@@ -3,14 +3,20 @@
 ---------------------
 """
 
+from typing import Union
+
 from fordev.core import fordev_request
 
 from fordev.filters import data_format
 
 from fordev.validators.utils import raise_for_invalid_uf
 
 
-def cpf(uf_code: str='', formatting: bool=True, data_only: bool=True) -> str:
+def cpf(
+    uf_code: str = '',
+    formatting: bool = True,
+    data_only: bool = True
+) -> Union[str, dict]:
     """Gere o código de um CPF(Cadastro de Pessoas Físicas) aleatório."""
 
     uf_code = uf_code.upper()

fordev/generators/credit_card.py

@@ -13,7 +13,11 @@
 from fordev.filters import data_format
 
 
-def credit_card(bank: int=0, formatting: bool=True, data_only: bool=True) -> dict:
+def credit_card(
+    bank: int = 0,
+    formatting: bool = True,
+    data_only: bool = True
+) -> dict:
     """Gere dados de cartão de crédito aleatório.
 
     Parameters
@@ -28,16 +32,16 @@ def credit_card(bank: int=0, formatting: bool=True, data_only: bool=True) -> dic
 
     if not (0 <= bank <= 10):
         msg_error = (
-            f'The bank code value "{bank}" is invalid. Enter a valid bank code.'
-            ' The range is 0 to 10.'
+            f'The bank code value "{bank}" is invalid.'
+            ' Enter a valid bank code. The range is 0 to 10.'
         )
 
         raise ValueError(msg_error)
 
     if bank != 0:
-        bank = ALL_BANK_FLAGS[bank]
+        bank_flag = ALL_BANK_FLAGS[bank]
     else:
-        bank = random_choice(
+        bank_flag = random_choice(
             list(ALL_BANK_FLAGS.values())
         )
 
@@ -47,7 +51,7 @@ def credit_card(bank: int=0, formatting: bool=True, data_only: bool=True) -> dic
         payload={
             'acao': 'gerar_cc',
             'pontuacao': 'S' if formatting else 'N',
-            'bandeira': bank
+            'bandeira': bank_flag
         }
     )
 

fordev/generators/people.py

@@ -3,6 +3,8 @@
 ------------------------
 """
 
+from typing import Union
+
 from json import loads as json_loads
 
 from fordev.core import fordev_request
@@ -11,13 +13,13 @@
 
 
 def people(
-        n: int=1,
-        sex: str='R',
-        age: int=0,
-        uf_code: str='',
-        formatting: bool=True,
-        data_only: bool=True
-    ) -> str:
+    n: int = 1,
+    sex: str = 'R',
+    age: int = 0,
+    uf_code: str = '',
+    formatting: bool = True,
+    data_only: bool = True
+) -> Union[str, dict]:
     """Gere dados de pessoa(s) aleatório(s)
 
     Parameters
@@ -32,7 +34,8 @@ def people(
         https://fordev.rtfd.io/pt_BR/latest/fordev/generators.html
 
     age
-        A idade da pessoa para geração dos dados. A idade mínima é 18 e a máxima é 80.
+        A idade da pessoa para geração dos dados. A idade mínima é 18 e a
+        máxima é 80.
     """
 
     sex = sex.upper()

fordev/generators/pis_pasep.py

@@ -3,12 +3,17 @@
 ---------------------------
 """
 
+from typing import Union
+
 from fordev.core import fordev_request
 
 from fordev.filters import data_format
 
 
-def pis_pasep(formatting: bool=True, data_only: bool=True) -> str:
+def pis_pasep(
+    formatting: bool = True,
+    data_only: bool = True
+) -> Union[str, dict]:
     """Gere o código do PIS/PASEP aleatório."""
 
     resp = fordev_request(