]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commitdiff
📝 Remove *, from functions where it's not needed #1234 (#1239)
authorPankaj Giri <giri.pankaj@gmail.com>
Fri, 12 Jun 2020 19:41:44 +0000 (01:11 +0530)
committerGitHub <noreply@github.com>
Fri, 12 Jun 2020 19:41:44 +0000 (21:41 +0200)
* Fix for - [FEATURE] Remove *, where it's not needed #1234

* 🔥 Remove unnecessary arg *,

* 🎨 Update docs format highlight lines

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
32 files changed:
docs/en/docs/tutorial/schema-extra-example.md
docs_src/body_fields/tutorial001.py
docs_src/body_multiple_params/tutorial002.py
docs_src/body_multiple_params/tutorial003.py
docs_src/body_multiple_params/tutorial005.py
docs_src/body_nested_models/tutorial001.py
docs_src/body_nested_models/tutorial002.py
docs_src/body_nested_models/tutorial003.py
docs_src/body_nested_models/tutorial004.py
docs_src/body_nested_models/tutorial005.py
docs_src/body_nested_models/tutorial006.py
docs_src/body_nested_models/tutorial007.py
docs_src/body_nested_models/tutorial008.py
docs_src/cookie_params/tutorial001.py
docs_src/extra_models/tutorial001.py
docs_src/extra_models/tutorial002.py
docs_src/header_params/tutorial001.py
docs_src/header_params/tutorial002.py
docs_src/path_operation_advanced_configuration/tutorial004.py
docs_src/path_operation_configuration/tutorial001.py
docs_src/path_operation_configuration/tutorial002.py
docs_src/path_operation_configuration/tutorial003.py
docs_src/path_operation_configuration/tutorial004.py
docs_src/path_operation_configuration/tutorial005.py
docs_src/request_forms/tutorial001.py
docs_src/response_model/tutorial002.py
docs_src/response_model/tutorial003.py
docs_src/schema_extra_example/tutorial001.py
docs_src/schema_extra_example/tutorial002.py
docs_src/schema_extra_example/tutorial003.py
docs_src/security/tutorial004.py
docs_src/security/tutorial005.py

index 70c3d184669b4424f7880ed6db59a2a1eef5abed..8a497ccd54403bf75045cee961259a7a99948220 100644 (file)
@@ -33,7 +33,7 @@ The same way you can pass extra info to `Field`, you can do the same with `Path`
 
 For example, you can pass an `example` for a body request to `Body`:
 
-```Python hl_lines="20 21 22 23 24 25"
+```Python hl_lines="19 20 21 22 23 24"
 {!../../../docs_src/schema_extra_example/tutorial003.py!}
 ```
 
index 7b2c9454d82f4379b556c421bb7e6125e02a276b..dcd5b9764af9c51feffbfe12f9ee773ebb4ff117 100644 (file)
@@ -12,6 +12,6 @@ class Item(BaseModel):
 
 
 @app.put("/items/{item_id}")
-async def update_item(*, item_id: int, item: Item = Body(..., embed=True)):
+async def update_item(item_id: int, item: Item = Body(..., embed=True)):
     results = {"item_id": item_id, "item": item}
     return results
index 5c9e8344d834292b2110c24d405058ce939ddbf9..54f6d9138b91063e71100e3d75930a49451f45e4 100644 (file)
@@ -17,6 +17,6 @@ class User(BaseModel):
 
 
 @app.put("/items/{item_id}")
-async def update_item(*, item_id: int, item: Item, user: User):
+async def update_item(item_id: int, item: Item, user: User):
     results = {"item_id": item_id, "item": item, "user": user}
     return results
index 301f1a86214ede899d78357cbaff8dff54d82812..691fe848b64d777e6ed6405cc4b6f3fcbeb088f1 100644 (file)
@@ -18,7 +18,7 @@ class User(BaseModel):
 
 @app.put("/items/{item_id}")
 async def update_item(
-    *, item_id: int, item: Item, user: User, importance: int = Body(...)
+    item_id: int, item: Item, user: User, importance: int = Body(...)
 ):
     results = {"item_id": item_id, "item": item, "user": user, "importance": importance}
     return results
index 61f1b29170f0c3e68d3f501f3a1bf152cb225030..606d3bbbb0dd715d5f5c87b1570edddb1cd61bb3 100644 (file)
@@ -12,6 +12,6 @@ class Item(BaseModel):
 
 
 @app.put("/items/{item_id}")
-async def update_item(*, item_id: int, item: Item = Body(..., embed=True)):
+async def update_item(item_id: int, item: Item = Body(..., embed=True)):
     results = {"item_id": item_id, "item": item}
     return results
index 9e0fa4494e8cbcef8e5ea695197769d4b2e3591f..56db2a09386391f112437c232d7b58fd4e7947d5 100644 (file)
@@ -13,6 +13,6 @@ class Item(BaseModel):
 
 
 @app.put("/items/{item_id}")
-async def update_item(*, item_id: int, item: Item):
+async def update_item(item_id: int, item: Item):
     results = {"item_id": item_id, "item": item}
     return results
index 8f769279b1fc49601e8581a18cc13a68bc71e120..db33e483f4a1d618f2a240dc2ba8b6457f4400da 100644 (file)
@@ -15,6 +15,6 @@ class Item(BaseModel):
 
 
 @app.put("/items/{item_id}")
-async def update_item(*, item_id: int, item: Item):
+async def update_item(item_id: int, item: Item):
     results = {"item_id": item_id, "item": item}
     return results
index bb539b12722a03855bd207c8d428bd7a85df93d2..f65195b620c01e20ba394fb3dc39be36e4eebef0 100644 (file)
@@ -15,6 +15,6 @@ class Item(BaseModel):
 
 
 @app.put("/items/{item_id}")
-async def update_item(*, item_id: int, item: Item):
+async def update_item(item_id: int, item: Item):
     results = {"item_id": item_id, "item": item}
     return results
index 257928ef39b3783388ea591f6c93b1d12521ec06..6c2ca25eb7536a13d3a3e19654792b6f43aa837e 100644 (file)
@@ -21,6 +21,6 @@ class Item(BaseModel):
 
 
 @app.put("/items/{item_id}")
-async def update_item(*, item_id: int, item: Item):
+async def update_item(item_id: int, item: Item):
     results = {"item_id": item_id, "item": item}
     return results
index afea77179a413c68d1626b19388e5e7d7901c401..d6d9d6479ec5700f4e284f9ea7216f3cedbc1aee 100644 (file)
@@ -21,6 +21,6 @@ class Item(BaseModel):
 
 
 @app.put("/items/{item_id}")
-async def update_item(*, item_id: int, item: Item):
+async def update_item(item_id: int, item: Item):
     results = {"item_id": item_id, "item": item}
     return results
index 3d0db6e588804895f513ac8d18d864e738ee81a7..d64668518e477866f79304b31d0d3a05b1c86fee 100644 (file)
@@ -21,6 +21,6 @@ class Item(BaseModel):
 
 
 @app.put("/items/{item_id}")
-async def update_item(*, item_id: int, item: Item):
+async def update_item(item_id: int, item: Item):
     results = {"item_id": item_id, "item": item}
     return results
index f13c07ad531b0cb55800785769c8c79f556ad825..f4b699dbfb8c42d046366bae9f7364572d8bbab3 100644 (file)
@@ -28,5 +28,5 @@ class Offer(BaseModel):
 
 
 @app.post("/offers/")
-async def create_offer(*, offer: Offer):
+async def create_offer(offer: Offer):
     return offer
index b6f5c0660b7d97c91178f144a5ef8bb72234045e..3431cc6365d162c2821232bdb0bad9df3dc0295a 100644 (file)
@@ -12,5 +12,5 @@ class Image(BaseModel):
 
 
 @app.post("/images/multiple/")
-async def create_multiple_images(*, images: List[Image]):
+async def create_multiple_images(images: List[Image]):
     return images
index 5a6fd30fe60d266ac9feda44a5b469c1ba89ca1a..bee934b0674d16e7238ca880eb70827b45115210 100644 (file)
@@ -4,5 +4,5 @@ app = FastAPI()
 
 
 @app.get("/items/")
-async def read_items(*, ads_id: str = Cookie(None)):
+async def read_items(ads_id: str = Cookie(None)):
     return {"ads_id": ads_id}
index 08d3659b0148d7797035ed6167b2f530b7216679..7ff4bba7ea4fb24094c4c0d782dafcb4d45329d4 100644 (file)
@@ -36,6 +36,6 @@ def fake_save_user(user_in: UserIn):
 
 
 @app.post("/user/", response_model=UserOut)
-async def create_user(*, user_in: UserIn):
+async def create_user(user_in: UserIn):
     user_saved = fake_save_user(user_in)
     return user_saved
index ab680eca0adc3d8a3ccdb29c99bc2ab3ef061158..03069911402534512c1242ae3b3e886929476f97 100644 (file)
@@ -34,6 +34,6 @@ def fake_save_user(user_in: UserIn):
 
 
 @app.post("/user/", response_model=UserOut)
-async def create_user(*, user_in: UserIn):
+async def create_user(user_in: UserIn):
     user_saved = fake_save_user(user_in)
     return user_saved
index 69f3dc7125333770b45934773710483770de9966..e871de68d7f529194f12112fcce362668ccb37c3 100644 (file)
@@ -4,5 +4,5 @@ app = FastAPI()
 
 
 @app.get("/items/")
-async def read_items(*, user_agent: str = Header(None)):
+async def read_items(user_agent: str = Header(None)):
     return {"User-Agent": user_agent}
index 4edc4b6fda6433f2cc3733279838a2ad9b77a3da..ba6cef1dedc23578b5ff83c2b585b260dfd58eec 100644 (file)
@@ -4,5 +4,5 @@ app = FastAPI()
 
 
 @app.get("/items/")
-async def read_items(*, strange_header: str = Header(None, convert_underscores=False)):
+async def read_items(strange_header: str = Header(None, convert_underscores=False)):
     return {"strange_header": strange_header}
index 36bf02b1133f50bd6890022e2a8fd5f4247b6d32..24be0cb940868370fe9eac9f27ab8d6000c85b78 100644 (file)
@@ -15,7 +15,7 @@ class Item(BaseModel):
 
 
 @app.post("/items/", response_model=Item, summary="Create an item")
-async def create_item(*, item: Item):
+async def create_item(item: Item):
     """
     Create an item with all the information:
 
index a60b47fef0f201753cd049d69e28ae85aab26354..77437cd08a9ac2b6863e41c704eb940a3d05bb1f 100644 (file)
@@ -15,5 +15,5 @@ class Item(BaseModel):
 
 
 @app.post("/items/", response_model=Item, status_code=status.HTTP_201_CREATED)
-async def create_item(*, item: Item):
+async def create_item(item: Item):
     return item
index b5d0f12ca64ae8b67ce4a2c6863ece6b6cca1f78..ed29ea014ff6dabd826982e2cb62869f3c0b963b 100644 (file)
@@ -15,7 +15,7 @@ class Item(BaseModel):
 
 
 @app.post("/items/", response_model=Item, tags=["items"])
-async def create_item(*, item: Item):
+async def create_item(item: Item):
     return item
 
 
index 106607fd2d3ace29c56fb0f493d90806684b62ff..4c4b048c7c56e7acf9ea86151f263e8c029b62c9 100644 (file)
@@ -20,5 +20,5 @@ class Item(BaseModel):
     summary="Create an item",
     description="Create an item with all the information, name, description, price, tax and a set of unique tags",
 )
-async def create_item(*, item: Item):
+async def create_item(item: Item):
     return item
index f47d422e0c27effcb0ba6b73ec92dfb8bc3394d6..f9822aae423d5a18a3675594d09ee3cb241431b6 100644 (file)
@@ -15,7 +15,7 @@ class Item(BaseModel):
 
 
 @app.post("/items/", response_model=Item, summary="Create an item")
-async def create_item(*, item: Item):
+async def create_item(item: Item):
     """
     Create an item with all the information:
 
index 72d02ece396353a03683364298c8961d1c6860e4..7ae2acafc33bb2975d0fe854ae739049965db6cb 100644 (file)
@@ -20,7 +20,7 @@ class Item(BaseModel):
     summary="Create an item",
     response_description="The created item",
 )
-async def create_item(*, item: Item):
+async def create_item(item: Item):
     """
     Create an item with all the information:
 
index 0290b644d374739bc668f7a1f24b99ffcc4fcfe2..c07e2294585eb317a0c621f0b241fc48f63d37a9 100644 (file)
@@ -4,5 +4,5 @@ app = FastAPI()
 
 
 @app.post("/login/")
-async def login(*, username: str = Form(...), password: str = Form(...)):
+async def login(username: str = Form(...), password: str = Form(...)):
     return {"username": username}
index b36b2a347cdbdff3717f13ea9b83ece537aa64cb..67084b45e9787bfa97b8d14e3dca1efb30d8845e 100644 (file)
@@ -13,5 +13,5 @@ class UserIn(BaseModel):
 
 # Don't do this in production!
 @app.post("/user/", response_model=UserIn)
-async def create_user(*, user: UserIn):
+async def create_user(user: UserIn):
     return user
index a73372901416de5e0ad66669955c8a92f6a08374..8450723c24909047731a5372bc1f6025f8688514 100644 (file)
@@ -18,5 +18,5 @@ class UserOut(BaseModel):
 
 
 @app.post("/user/", response_model=UserOut)
-async def create_user(*, user: UserIn):
+async def create_user(user: UserIn):
     return user
index cd4d45f51d4d2de6dcf3b7ed4b2f8bacade0043a..59a58375035ceb57e9fba7c4f84c02c7936d8256 100644 (file)
@@ -22,6 +22,6 @@ class Item(BaseModel):
 
 
 @app.put("/items/{item_id}")
-async def update_item(*, item_id: int, item: Item):
+async def update_item(item_id: int, item: Item):
     results = {"item_id": item_id, "item": item}
     return results
index edf9897d08b98ea6d69ce594131c3d8f49eb5e09..0a567bd79e43da5e7c4194261cd41ad2d3d8330d 100644 (file)
@@ -12,6 +12,6 @@ class Item(BaseModel):
 
 
 @app.put("/items/{item_id}")
-async def update_item(*, item_id: int, item: Item):
+async def update_item(item_id: int, item: Item):
     results = {"item_id": item_id, "item": item}
     return results
index 1165fd7a05642f8d59353787bc0afb2e0539f07e..87fbefbb6f53f5892d37ef00af89eb4daefafbd7 100644 (file)
@@ -13,7 +13,6 @@ class Item(BaseModel):
 
 @app.put("/items/{item_id}")
 async def update_item(
-    *,
     item_id: int,
     item: Item = Body(
         ...,
@@ -23,7 +22,7 @@ async def update_item(
             "price": 35.4,
             "tax": 3.2,
         },
-    )
+    ),
 ):
     results = {"item_id": item_id, "item": item}
     return results
index 3c8b6693d2f5ce344ff460d7c9d2a9461ed1621d..56f0eb0ea45dfea107ea9e1dbf7bf678df8fe8b2 100644 (file)
@@ -75,7 +75,7 @@ def authenticate_user(fake_db, username: str, password: str):
     return user
 
 
-def create_access_token(*, data: dict, expires_delta: timedelta = None):
+def create_access_token(data: dict, expires_delta: timedelta = None):
     to_encode = data.copy()
     if expires_delta:
         expire = datetime.utcnow() + expires_delta
index f43659454c167b36f37f44f08b8e3459fb4759f6..489404d6f302a2f071ee61764e4a484ce951380a 100644 (file)
@@ -91,7 +91,7 @@ def authenticate_user(fake_db, username: str, password: str):
     return user
 
 
-def create_access_token(*, data: dict, expires_delta: timedelta = None):
+def create_access_token(data: dict, expires_delta: timedelta = None):
     to_encode = data.copy()
     if expires_delta:
         expire = datetime.utcnow() + expires_delta