flasgger/flasgger

swag_from does not accept pathlib.Path objects as path specification

Open

#251 opened on Oct 9, 2018

View on GitHub
 (2 comments) (1 reaction) (0 assignees)Python (3,435 stars) (500 forks)batch import
enhancementhacktoberfesthelp wanted

Description

I think it would be nice if the swag_from decorator would accept pathlib.Path objects as this makes the paths os independent. Thus instead of:

@swag_from("swagger/version.yaml", endpoint='version')
def get(self):
....

I rather use:

@swag_from(Path("swagger/version.yaml"), endpoint='version')
def get(self):
....

I now have to wrap Path("swagger/version.yaml") into str()

Contributor guide

Tech stack
pythonflask
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
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
PythonFlaskpathlib
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Locate the swag from decorator in the flasgger source code (likely in flasgger/utils.py or flasgger/decorators.py). Modify the decorator to accept both str and pathlib.Path objects by converting Path objects to str using str(path) or using os.fspath. Add a simple unit test to verify the change. The issue is straightforward and well specified.