rochacbruno/talkshow

Gerar dinâmicamente os validadores e definições para todas as 3 interfaces

Open

#9 aberto em 27 de ago. de 2018

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)Python (25 forks)github user discovery
difficultextend-branchhacktoberfest

Métricas do repositório

Stars
 (68 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

Atualmente temos definição de campos e validadores em 5 locais

  • cli (argumentos dos comandos)
  • UI (formulário wtforms)
  • Admin (Formulario wtform do admin)
  • API (reqparse do Flask_Restful)
  • Apidocs (YAML do flasgger)

Precisamos criar em um local base /definitions.py uma classe Python usando descriptor ou algo do tipo que seja capaz de a partir de um unico modelo gerar specs para esses 5 locais. ex: @definition.generate_cli_specs() para ser usado ao inves de @click.option no cli e um equivalente para os outros locais.

Essa solução pode se transformar em uma library de uso geral externa.

Guia do colaborador

Direção de pesquisa
Pesquise bibliotecas existentes como Marshmallow ou Pydantic para definição de esquemas e geração de código. Projete uma classe baseada em descritores em definitions.py que possa gerar argumentos CLI, campos WTForms, reqparse do Flask RESTful e YAML do Flasgger a partir de um único modelo. Considere torná la uma biblioteca reutilizável.
Pilha de tecnologia
pythonflask
Domain
backend
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
4
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
PythonFlask
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40