Descrição

Adiciona uma nova função para formatar números no formato monetário brasileiro.

Mudanças Propostas

Esse PR propõe a adição do método format_currency para formatar números seguindo o formato monetário brasileiro. A função recebe como input um número float ou Decimal e realiza a formatação seguindo o padrão: R$ XX.XX,XX, onde os agrupadores de milhar serão separados mediante ponto e a casa decimal por meio de vírgula.

Como ponto importante, foi avaliado uma solução através do módulo locale, porém dado a necessidade da existência dos pacotes locales no sistema operacional, a proposta foi feita de forma manual e sem acoplamento de pacotes externos.

Exemplo de uso:

>>> from brutils.currency import format_currency
>>> format_currency(1259.03)
'R$ 1.259,03'
>>> format_currency(0)
'R$ 0,00'
>>> format_currency("not a number")
None

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 #426