File: test_populate_by_name.py

package info (click to toggle)
flask-openapi3 4.1.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,976 kB
  • sloc: python: 4,754; sh: 17; makefile: 15; javascript: 5
file content (132 lines) | stat: -rw-r--r-- 2,860 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# -*- coding: utf-8 -*-
# @Author  : llc
# @Time    : 2024/8/31 15:35
from typing import Sequence

import pytest
from pydantic import BaseModel, Field

from flask_openapi3 import OpenAPI

app = OpenAPI(__name__)
app.config["TESTING"] = True


@pytest.fixture
def client():
    client = app.test_client()

    return client


class BookQuery(BaseModel):
    age: int
    author: str = Field(..., alias="author_name")

    model_config = {"populate_by_name": True}


@app.get("/book", summary="get books")
def get_book(query: BookQuery):
    """
    get all books
    """
    print(query)
    return "ok"


class QueryModel(BaseModel):
    aliased_field: str = Field(alias="aliasedField")

    aliased_list_field: list[str] = Field(alias="aliasedListField")


@app.get("/query-alias-test")
def query_alias_test(query: QueryModel):
    assert query.aliased_field == "test"
    return "ok"


class HeaderModel(BaseModel):
    Hello1: str = Field(..., alias="Hello2")

    model_config = {"populate_by_name": True}


@app.get("/header")
def get_book_header(header: HeaderModel):
    return header.model_dump(by_alias=True)


class TupleModel(BaseModel):
    values: tuple[int, int]
    sequence: Sequence[int] = Field(alias="Sequence")

    model_config = {"populate_by_name": True}


@app.get("/tuple-test")
def tuple_test(query: TupleModel):
    assert query.values == (2, 2)
    return b"", 200


class AliasModel(BaseModel):
    aliased_field: str = Field(alias="aliasedField")


@app.post("/form-alias-test")
def alias_test(form: AliasModel):
    assert form.aliased_field == "test"
    return b"", 200


def test_header(client):
    headers = {"Hello2": "111"}
    resp = client.get("/header", headers=headers)
    print(resp.json)
    assert resp.status_code == 200
    assert resp.json == headers


def test_tuple_query(client):
    resp = client.get(
        "/tuple-test",
        query_string={"values": [2, 2], "sequence": [1, 2, 3]},
    )
    assert resp.status_code == 200


def test_form_alias(client):
    resp = client.post(
        "/form-alias-test",
        data={"aliasedField": "test"},
    )
    assert resp.status_code == 200

    resp = client.post(
        "/form-alias-test",
        data={"aliased_field": "test"},
    )
    assert resp.status_code == 422


def test_query_alias(client):
    resp = client.get(
        "/query-alias-test",
        query_string={"aliasedField": "test", "aliasedListField": ["test"]},
    )
    assert resp.status_code == 200

    resp = client.get(
        "/query-alias-test",
        data={"aliased_field": "test", "aliased_list_field": ["test"]},
    )
    assert resp.status_code == 422


def test_query_populate_by_name(client):
    resp = client.get("/book?age=1&author=aa")
    assert resp.status_code == 200
    resp = client.get("/book?age=1&author_name=aa")
    assert resp.status_code == 200