marshmallow-code/apispec-webframeworks

Separate path_helper and operation_helper logic in web framework plugins

Open

#17 opened on Nov 3, 2018

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Python (24 forks)github user discovery
help wantedrefactor

Repository metrics

Stars
 (33 stars)
PR merge metrics
 (Avg merge 30m) (3 merged PRs in 30d)

Description

Issue by sloria Monday Jul 30, 2018 at 00:44 GMT Originally opened as https://github.com/marshmallow-code/apispec/issues/257

From #246:

Also the web framework path helpers deal with operations quite a lot, and perhaps this logic should be split into path_helper and operation_helper. From a quick glance, the coupling between the two seems loose. Could be a bit trickier with flask due to the if method in rule.methods test, which covers what looks like a twisted but legit case (method declared in the view but not in the rule).

Contributor guide

Research direction
Examine the path and operation helper functions in the existing plugins, identify common patterns, and create separate modules.
Tech stack
python
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50