435

[luizcarlosom]

Descrição

Mudanças Propostas

Checklist de Revisão

• Eu li o Contributing.md
• Os testes foram adicionados ou atualizados para refletir as mudanças (se aplicável).
• Foi adicionada uma entrada no changelog / Meu PR não necessita de uma nova entrada no changelog.
• A documentação em português foi atualizada ou criada, se necessário.
• Se feita a documentação, a atualização do arquivo em inglês.
• Eu documentei as minhas mudanças no código, adicionando docstrings e comentários. Instruções
• O código segue as diretrizes de estilo e padrões de codificação do projeto.
• Todos os testes passam. Instruções
• O Pull Request foi testado localmente. Instruções
• Não há conflitos de mesclagem.

Comentários Adicionais (opcional)

Issue Relacionada

Closes #<numero_da_issue>

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.84%. Comparing base (60c8937) to head (d7e3f1c).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #464   +/-   ##
=======================================
  Coverage   99.83%   99.84%           
=======================================
  Files          21       23    +2     
  Lines         612      641   +29     
=======================================
+ Hits          611      640   +29     
  Misses          1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[BeneBr]

Opa passei aqui para comentar seu código para auxiliar o pessoal do brutils.
O ponto principal de mudança aqui é no tipo de dado que deve ser passado para a função. A função deve receber uma string, e não um dicionário. Cabendo a função tratar de maneira adequada a string passada e retornando um boleto corretamente formatado. A issue que você pegou trata exatamente disso, passar uma string.

[BeneBr]

Suggested change

	This function takes information from a boleto
	and turns it into a string.
	This function takes information from a bank slip (in brazilian portuguese, boleto)
	and turns it into a string.

[BeneBr]

Suggested change

	Esta função pega as informações de um boleto
	e transforma em uma string
	Esta função obtém as informações de um boleto
	e as transforma em uma string.

[BeneBr]

Suggested change

	boleto (Boleto): A dictionary with boleto information
	boleto (Boleto): A dictionary with a bank slip information

[BeneBr]

Suggested change

	str: A string with the formatted boleto reading code
	str: A string with the formatted bank slip reading code

[BeneBr]

Suggested change

	"format_boleto",
	"format_bank_slip",

[BeneBr]

Suggested change

	>>> boleto = Boleto(
	>>> bank_slip = BankSlip(

[BeneBr]

É esperado uma string ser passada para o parâmetro e não um dicionário:

def format_boleto(boleto_string: str) -> str:
    """Formata uma string de boleto.

    **Args:**
        boleto_string (str): A string representando o boleto.

    **Returns:**
        str: A string formatada, ou None se a entrada for inválida.

    **Raises:**
        NotImplementedError: A implementação da lógica ainda está pendente.

Pense em você como um usuário dessa função. Você tem uma string que foi lida de algum lugar, você não se perguntaria o porquê de ter que criar um objeto nesse formato ao invés de simplesmente passar uma string? Então, a função format_boleto (que deve se chamar format_bank_slip) deve receber uma string apenas contendo a informação do código de barras.

[BeneBr]

Suggested change

	boleto (Boleto): A dictionary with boleto information
	bank_slip: A string with the bank slip information.

Como uma boa prática de documentação, utilize pontos no final de cada linha.

[BeneBr]

Aqui faz ainda mais sentido recber uma string ao invés de um dicionário. Você está obtendo cada elemento de um dicionário e o transformando em uma tupla para depois o transformar em uma lista? Não faz muito sentido não. Aqui se for utilizado apenas string, você poderia muito bem obter cada uma das partes do boleto, apenas utilizando o seu código abaixo:

bank_slip = "00190500954014481606906809350314337370000000100"

first_piece = bank_slip[:5]
second_piece = bank_slip[5:10]
>>>>  00190 50095

Exatamente o que você precisa.

[BeneBr]

Esse arquivo não é necessário uma vez que a entrada da função é uma string.