Skill de Padrões de Codificação Dignified Python
Padrões de codificação Python de qualidade de produção para escrever código Python limpo, sustentável e moderno (versões 3.10-3.13).
Quando Usar Esta Skill
Auto-invocar quando os usuários perguntarem sobre:
- "tornar isto pythonico" / "isto é bom Python?"
- "type hints" / "anotações de tipo" / "typing"
- "LBYL vs EAFP" / "tratamento de exceções"
- "pathlib vs os.path" / "operações de caminho"
- "padrões CLI" / "uso de click"
- "revisão de código" / "melhorar este código"
- Qualquer pergunta sobre padrões ou qualidade de código Python
Nota: Esta skill é de padrões Python gerais, não específica do Dagster. Use
/dagster-expert para padrões do Dagster.
Quando Usar Esta Skill vs. Outras
| Necessidade do Usuário | Usar Esta Skill | Skill Alternativa |
|---|---|---|
| "tornar isto pythonico" | ✅ Sim - Padrões Python | |
| "isto é bom Python?" | ✅ Sim - Qualidade de código | |
| "type hints" | ✅ Sim - Orientação de tipos | |
| "LBYL vs EAFP" | ✅ Sim - Padrões de exceção | |
| "pathlib vs os.path" | ✅ Sim - Manipulação de caminhos | |
| "padrões específicos do Dagster" | ❌ Não | /dagster-expert |
| "análise de argumentos CLI" | ✅ Sim - Padrões CLI |
Conhecimento Central (SEMPRE Carregado)
Detecção de Versão
Identifique a versão mínima do Python do projeto verificando (em ordem):
pyproject.toml- Procure pelo camporequires-python(ex.:requires-python = ">=3.12")setup.pyousetup.cfg- Procure porpython_requires- Arquivo
.python-version- Contém a versão como3.12ou3.12.0 - Padrão para Python 3.12 se nenhum especificador de versão for encontrado
Uma vez identificado, carregue o arquivo apropriado para a versão:
- Python 3.10: Carregar
versions/python-3.10.md - Python 3.11: Carregar
versions/python-3.11.md - Python 3.12: Carregar
versions/python-3.12.md - Python 3.13: Carregar
versions/python-3.13.md
Carregamento Condicional (Carregar com Base em Padrões da Tarefa)
Os arquivos principais acima cobrem 80%+ dos padrões de código Python. Carregue estes arquivos adicionais apenas quando você detectar padrões específicos:
Exemplos de detecção de padrões:
- Se a tarefa mencionar "click" ou "CLI" -> Carregar
cli-patterns.md - Se a tarefa mencionar "subprocess" -> Carregar
subprocess.md
Estrutura da Documentação de Referência
Os documentos de referência estão organizados em arquivos de nível superior e subdiretórios:
Referências Principais (junto com SKILL.md)
dignified-python-core.md- Padrões essenciais (sempre carregado)cli-patterns.md- Padrões de interface de linha de comando (click, argparse)subprocess.md- Operações de subprocesso
Referências Específicas de Versão (versions/)
versions/python-3.10.md- Funcionalidades disponíveis no Python 3.10+versions/python-3.11.md- Funcionalidades disponíveis no Python 3.11+versions/python-3.12.md- Funcionalidades disponíveis no Python 3.12+versions/python-3.13.md- Funcionalidades disponíveis no Python 3.13+
Tópicos Avançados (references/advanced/)
exception-handling.md- Padrões LBYL, limites de errointerfaces.md- Padrões ABC e Protocoltyping-advanced.md- Padrões avançados de tipagemapi-design.md- Princípios de design de API
Quando Ler Cada Documento de Referência
references/advanced/exception-handling.md
Leia quando:
- Escrevendo blocos try/except
- Encapsulando APIs de terceiros que podem levantar exceções
- Vendo ou escrevendo
from eoufrom None - Não tiver certeza se existe uma alternativa LBYL
references/advanced/interfaces.md
Leia quando:
- Criando classes ABC ou Protocol
- Escrevendo decoradores @abstractmethod
- Projetando interfaces de camada de gateway
- Escolhendo entre ABC e Protocol
references/advanced/typing-advanced.md
Leia quando:
- Usando typing.cast()
- Criando aliases de tipo Literal
- Restringindo tipos em blocos condicionais
references/module-design.md
Leia quando:
- Criando novos módulos Python
- Adicionando código no nível do módulo (além de constantes simples)
- Usando o decorador @cache no nível do módulo
- Vendo Path() ou computação no nível do módulo
- Considerando imports inline
references/api-design.md
Leia quando:
- Adicionando valores de parâmetros padrão a funções
- Definindo funções com 5 ou mais parâmetros
- Usando ThreadPoolExecutor.submit()
- Revisando assinaturas de funções
references/checklists.md
Leia quando:
- Revisão final antes de confirmar código Python
- Não tiver certeza se seguiu todas as regras
- Precisar de uma consulta rápida dos requisitos
Como Usar Esta Skill
- Conhecimento central é carregado automaticamente (LBYL, pathlib, imports básicos, anti-padrões)
- Detecção de versão ocorre uma vez - identifique a versão mínima do Python e carregue o arquivo de versão apropriado
- Documentos de referência são carregados sob demanda com base nos gatilhos acima
- Padrões adicionais podem exigir carregamento extra (padrões CLI, subprocesso)
- Cada arquivo é autocontido com orientação completa para seu domínio