Skip to content

Update NumberConverter regex to match new Werkzeug behavior (v2) #1643

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
RobbeSneyders merged 3 commits into from
Feb 21, 2023
Merged

Update NumberConverter regex to match new Werkzeug behavior (v2) #1643

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71f67a4
Use non-capturing group in NumberConverter to match new Werkzeug beha…
RobbeSneyders Feb 17, 2023
d425479
Add test for multiple float path parameters
RobbeSneyders Feb 17, 2023
9feaf11
Drop Python 3.6
RobbeSneyders Feb 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/pipeline.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.6, 3.7, 3.8, 3.9]
python-version: [3.7, 3.8, 3.9]
steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
Expand Down
2 changes: 1 addition & 1 deletion connexion/apps/flask_app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ def default(self, o):

class NumberConverter(werkzeug.routing.BaseConverter):
""" Flask converter for OpenAPI number type """
regex = r"[+-]?[0-9]*(\.[0-9]*)?"
regex = r"[+-]?[0-9]*(?:\.[0-9]*)?"

def to_python(self, value):
return float(value)
Expand Down
10 changes: 10 additions & 0 deletions tests/api/test_parameters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,16 @@ def test_path_parameter_somefloat(simple_app, arg, result):
assert resp.data.decode('utf-8', 'replace') == f'"{result}"\n'


@pytest.mark.parametrize('arg, arg2, result', [
['-0.000000001', '0.3', 'float -1e-09, 0.3'],
])
def test_path_parameter_doublefloat(simple_app, arg, arg2, result):
assert isinstance(arg, str) # sanity check
app_client = simple_app.app.test_client()
resp = app_client.get(f'/v1.0/test-float-path/{arg}/{arg2}') # type: flask.Response
assert resp.data.decode('utf-8', 'replace') == f'"{result}"\n'


def test_path_parameter_somefloat__bad(simple_app):
# non-float values will not match Flask route
app_client = simple_app.app.test_client()
Expand Down
4 changes: 4 additions & 0 deletions tests/fakeapi/hello/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,10 @@ def test_get_somefloat(somefloat):
return f'{type(somefloat).__name__} {somefloat:g}'


def test_get_doublefloat(somefloat, someotherfloat):
return f'{type(somefloat).__name__} {somefloat:g}, {someotherfloat}'


def test_default_param(name):
return {"app_name": name}

Expand Down
18 changes: 18 additions & 0 deletions tests/fixtures/simple/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -528,6 +528,24 @@ paths:
responses:
'200':
description: OK
'/test-float-path/{somefloat}/{someotherfloat}':
get:
summary: Test type casting of path parameter
operationId: fakeapi.hello.test_get_doublefloat
parameters:
- name: somefloat
in: path
required: true
schema:
type: number
- name: someotherfloat
in: path
required: true
schema:
type: number
responses:
'200':
description: OK
/test-default-query-parameter:
get:
summary: Test if default parameter is passed to function
Expand Down
17 changes: 17 additions & 0 deletions tests/fixtures/simple/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,23 @@ paths:
200:
description: OK

/test-float-path/{somefloat}/{someotherfloat}:
get:
summary: Test type casting of path parameter
operationId: fakeapi.hello.test_get_doublefloat
parameters:
- name: somefloat
in: path
type: number
required: true
- name: someotherfloat
in: path
type: number
required: true
responses:
200:
description: O

/test-default-query-parameter:
get:
summary: Test if default parameter is passed to function
Expand Down
2 changes: 0 additions & 2 deletions tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ rst-roles=class

[tox]
envlist =
{py36}-{min,pypi,dev}
{py37}-{min,pypi,dev}
{py38}-{min,pypi,dev}
{py39}-{min,pypi,dev}
Expand All @@ -17,7 +16,6 @@ envlist =

[gh-actions]
python =
3.6: py36-min,py36-pypi
3.7: py37-min,py37-pypi
3.8: py38-min,py38-pypi
3.9: py39-min,py39-pypi,flake8,isort-check,isort-check-examples,isort-check-tests,mypy
Expand Down