brutils-python
brutils-python copied to clipboard
feat: add Natureza Jurídica utilities
Descrição
Este PR adiciona o novo módulo brutils.legal_nature, responsável por validar e consultar os códigos da Tabela de Natureza Jurídica da Receita Federal do Brasil.
A funcionalidade permite verificar se um código é válido, obter sua descrição oficial e listar todas as Naturezas Jurídicas disponíveis, facilitando integrações com sistemas fiscais e de compliance.
Mudanças Propostas
- Criação do módulo
brutils/legal_nature.py. - Adição das funções:
is_valid(code: str) -> bool: valida se o código existe na tabela oficial.get_description(code: str) -> Optional[str]: retorna a descrição correspondente.list_all() -> dict[str, str]: retorna uma cópia completa do dicionário de Naturezas Jurídicas.
- Inclusão de testes unitários abrangentes (
tests/test_legal_nature.py). - Adição de nova seção no
README.mddocumentando o uso do utilitário. - Inclusão da referência à tabela oficial da Receita Federal (fonte dos dados).
- Entrada correspondente no
CHANGELOG.md.
Checklist de Revisão
- [x] Eu li o Contributing.md
- [x] Os testes foram adicionados ou atualizados para refletir as mudanças.
- [x] Foi adicionada uma entrada no changelog.
- [x] A documentação em português foi atualizada.
- [ ] A documentação em inglês será adicionada posteriormente.
- [x] As alterações possuem docstrings e seguem o padrão de estilo do projeto.
- [x] Todos os testes passam localmente (
make test). - [x] O PR foi testado localmente.
- [x] Não há conflitos de mesclagem.
Closes #641