rochacbruno/talkshow

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

Open

#9 opened on Aug 27, 2018

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

Repository metrics

Stars
 (68 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Investigate existing libraries like Marshmallow or Pydantic for schema definition and code generation. Design a descriptor based class in definitions.py that can generate CLI arguments, WTForms fields, Flask RESTful reqparse, and Flasgger YAML from a single model. Consider making it a reusable library.
Tech stack
pythonflask
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PythonFlask
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40