Migrar type hints de brutils/phone.py para anotações modernas (PEP 484) #617
Description
Seu pedido de recurso está relacionado a um problema?
- O arquivo
brutils/phone.pymantém type hints via comentários (# type:), o que reduz a legibilidade e não aproveita totalmente ferramentas modernas de tipagem.
Descreva a solução que você gostaria
- Migrar para anotações modernas nas assinaturas, declarando parâmetros como
phone: str,type: Literal["mobile", "landline"] | Nonee retornosstr | Noneonde aplicável (ex.:format_phone).
Descreva alternativas que você considerou
- Permanecer com docstrings: limita a checagem estática.
- Stubs
.pyi: aumenta esforço e chance de inconsistência.
Contexto adicional
- Arquivo: https://github.com/brazilian-utils/python/blob/main/brutils/phone.py
- Funções relevantes:
is_valid_phone,format_phone,remove_symbols_phone,remove_international_dialing_code,generate_phone. - Benefícios: validação mais precisa (ex.:
Literal), melhor auxílio de IDEs e padronização dos contratos.
💌 Quer contribuir, mas não se sente à vontade?
Você tem vontade de contribuir, mas não se sente à vontade em abrir issues, PRs ou fazer perguntas publicamente?
Nós sabemos como pode ser difícil dar o primeiro passo em um espaço aberto. A insegurança, o medo de errar ou até a sensação de “será que minha dúvida é boba?” podem pesar bastante. E tá tudo bem sentir isso. 💜
Queremos que você saiba que aqui ninguém precisa enfrentar esse caminho sem apoio. Se preferir um espaço mais reservado, você pode mandar um e-mail para [email protected] e teremos o maior prazer em ajudar. Seja para tirar dúvidas, pedir orientação ou simplesmente ter alguém para conversar sobre como começar.
O importante é que você saiba: sua participação é muito bem-vinda, e cada contribuição, por menor que pareça, faz uma grande diferença. ✨
Metadata
Metadata
Assignees
Type
Projects
Status