-
Notifications
You must be signed in to change notification settings - Fork 151
Add support for setting strict_nullable from CLI #493
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.
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
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
0a827a7
Add support for setting strict_nullable from CLI
gregrutz-comcast 5f5a163
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] 1a781df
Merge main into strict_nullable
koxudaxi 0b897c3
Merge main and address review feedback
koxudaxi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
24 changes: 24 additions & 0 deletions
24
tests/data/expected/openapi/default_template/nullable_test/main.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # generated by fastapi-codegen: | ||
| # filename: nullable_test.yaml | ||
| # timestamp: 2020-06-19T00:00:00+00:00 | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from fastapi import FastAPI | ||
|
|
||
| from .models import User | ||
|
|
||
| app = FastAPI( | ||
| version='1.0.0', | ||
| title='Nullable Test API', | ||
| description='API for testing nullable field behavior', | ||
| servers=[{'url': 'http://api.example.com/v1'}], | ||
| ) | ||
|
|
||
|
|
||
| @app.get('/users', response_model=User) | ||
| def get_user_details() -> User: | ||
| """ | ||
| Get user details | ||
| """ | ||
| pass |
21 changes: 21 additions & 0 deletions
21
tests/data/expected/openapi/default_template/nullable_test/models.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # generated by fastapi-codegen: | ||
| # filename: nullable_test.yaml | ||
| # timestamp: 2020-06-19T00:00:00+00:00 | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from typing import Optional | ||
|
|
||
| from pydantic import BaseModel, Field | ||
|
|
||
|
|
||
| class User(BaseModel): | ||
| id: int | ||
| username: str | ||
| email: Optional[str] = Field( | ||
| None, description="User's email address (explicitly nullable)" | ||
| ) | ||
| phone: str = Field(..., description="User's phone number (explicitly non-nullable)") | ||
| nickname: Optional[str] = Field( | ||
| None, description="User's nickname (optional, not nullable under strict mode)" | ||
| ) |
24 changes: 24 additions & 0 deletions
24
tests/data/expected/openapi/default_template/nullable_test_strict/main.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # generated by fastapi-codegen: | ||
| # filename: nullable_test.yaml | ||
| # timestamp: 2020-06-19T00:00:00+00:00 | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from fastapi import FastAPI | ||
|
|
||
| from .models import User | ||
|
|
||
| app = FastAPI( | ||
| version='1.0.0', | ||
| title='Nullable Test API', | ||
| description='API for testing nullable field behavior', | ||
| servers=[{'url': 'http://api.example.com/v1'}], | ||
| ) | ||
|
|
||
|
|
||
| @app.get('/users', response_model=User) | ||
| def get_user_details() -> User: | ||
| """ | ||
| Get user details | ||
| """ | ||
| pass |
21 changes: 21 additions & 0 deletions
21
tests/data/expected/openapi/default_template/nullable_test_strict/models.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| # generated by fastapi-codegen: | ||
| # filename: nullable_test.yaml | ||
| # timestamp: 2020-06-19T00:00:00+00:00 | ||
|
|
||
| from __future__ import annotations | ||
|
|
||
| from typing import Optional | ||
|
|
||
| from pydantic import BaseModel, Field | ||
|
|
||
|
|
||
| class User(BaseModel): | ||
| id: int | ||
| username: str | ||
| email: Optional[str] = Field( | ||
| None, description="User's email address (explicitly nullable)" | ||
| ) | ||
| phone: str = Field(..., description="User's phone number (explicitly non-nullable)") | ||
| nickname: Optional[str] = Field( | ||
| None, description="User's nickname (optional, not nullable under strict mode)" | ||
| ) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| openapi: "3.0.0" | ||
| info: | ||
| version: 1.0.0 | ||
| title: Nullable Test API | ||
| description: API for testing nullable field behavior | ||
| servers: | ||
| - url: http://api.example.com/v1 | ||
| paths: | ||
| /users: | ||
| get: | ||
| summary: Get user details | ||
| operationId: getUserDetails | ||
| responses: | ||
| "200": | ||
| description: User details | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: "#/components/schemas/User" | ||
| components: | ||
| schemas: | ||
| User: | ||
| type: object | ||
| required: | ||
| - id | ||
| - phone | ||
| - username | ||
| properties: | ||
| id: | ||
| type: integer | ||
| format: int64 | ||
| username: | ||
| type: string | ||
| email: | ||
| type: string | ||
| nullable: true | ||
| description: User's email address (explicitly nullable) | ||
| phone: | ||
| type: string | ||
| nullable: false | ||
| description: User's phone number (explicitly non-nullable) | ||
| nickname: | ||
| type: string | ||
| description: User's nickname (optional, not nullable under strict mode) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.