Merge branch 'main' into feat/subprocess-test-client

litestar-org · Aug 12, 2024 · cd6443e · cd6443e
2 parents 0c4a4d5 + f80b4d3
commit cd6443e
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 10 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -1818,6 +1818,15 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "Zimzozaur",
+      "name": "Simon Joseph",
+      "avatar_url": "https://avatars.githubusercontent.com/u/106471045?v=4",
+      "profile": "https://github.com/Zimzozaur",
+      "contributions": [
+        "doc"
+      ]
     }
   ],
   "contributorsPerLine": 7,

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -235,9 +235,8 @@ jobs:
         run: pdm run make docs-linkcheck
 
       - name: Save PR number
-        env:
-          PR_NUMBER: ${{ github.event.number }}
-        run: echo $PR_NUMBER > .pr_number
+        run: |
+          echo "${{ github.event.number }}" > .pr_number
 
       - name: Upload artifact
         uses: actions/upload-artifact@v3

diff --git a/.github/workflows/docs-preview.yml b/.github/workflows/docs-preview.yml
@@ -24,8 +24,14 @@ jobs:
           path: docs-preview
           name: docs-preview
 
-      - name: Set PR number
-        run: echo "PR_NUMBER=$(cat docs-preview/.pr_number)" >> $GITHUB_ENV
+      - name: Validate and set PR number
+        run: |
+          PR_NUMBER=$(cat docs-preview/.pr_number)
+          if ! [[ "$PR_NUMBER" =~ ^[0-9]+$ ]]; then
+            echo "Invalid PR number: $PR_NUMBER"
+            exit 1
+          fi
+          echo "PR_NUMBER=$PR_NUMBER" >> $GITHUB_ENV
 
       - name: Deploy docs preview
         uses: JamesIves/github-pages-deploy-action@v4

diff --git a/README.md b/README.md
@@ -572,6 +572,7 @@ see [the contribution guide](CONTRIBUTING.rst).
     </tr>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/Anu-cool-007"><img src="https://avatars.githubusercontent.com/u/16525919?v=4?s=100" width="100px;" alt="Anuranjan Srivastava"/><br /><sub><b>Anuranjan Srivastava</b></sub></a><br /><a href="https://github.com/litestar-org/litestar/commits?author=Anu-cool-007" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Zimzozaur"><img src="https://avatars.githubusercontent.com/u/106471045?v=4?s=100" width="100px;" alt="Simon Joseph"/><br /><sub><b>Simon Joseph</b></sub></a><br /><a href="https://github.com/litestar-org/litestar/commits?author=Zimzozaur" title="Documentation">📖</a></td>
     </tr>
   </tbody>
 </table>

diff --git a/docs/examples/parameters/header_and_cookie_parameters.py b/docs/examples/parameters/header_and_cookie_parameters.py
@@ -29,7 +29,7 @@ async def get_user(
 ) -> User:
     if token != VALID_TOKEN or cookie != VALID_COOKIE_VALUE:
         raise NotAuthorizedException
-    return User.parse_obj(USER_DB[user_id])
+    return User.model_validate(USER_DB[user_id])
 
 
 app = Litestar(route_handlers=[get_user])
diff --git a/docs/examples/parameters/path_parameters_1.py b/docs/examples/parameters/path_parameters_1.py
@@ -12,7 +12,7 @@ class User(BaseModel):
 
 @get("/user/{user_id:int}", sync_to_thread=False)
 def get_user(user_id: int) -> User:
-    return User.parse_obj(USER_DB[user_id])
+    return User.model_validate(USER_DB[user_id])
 
 
 app = Litestar(route_handlers=[get_user])
diff --git a/docs/migration/flask.rst b/docs/migration/flask.rst
@@ -202,11 +202,11 @@ Request methods
 +---------------------------------+-------------------------------------------------------------------------------------------------------+
 | ``request.environ``             | ``request.scope``                                                                                     |
 +---------------------------------+-------------------------------------------------------------------------------------------------------+
-| ``request.files``               | Use ```UploadFile`` <usage/4-request-data/#file-uploads>`__                                           |
+| ``request.files``               | Use ```UploadFile`` <usage/requests/file-uploads>`__                                                  |
 +---------------------------------+-------------------------------------------------------------------------------------------------------+
-| ``request.form``                | ``request.form()``, prefer ```Body`` <usage/4-request-data/#specifying-a-content-type>`__             |
+| ``request.form``                | ``request.form()``, prefer ```Body`` <usage/requests/content-type>`__                                 |
 +---------------------------------+-------------------------------------------------------------------------------------------------------+
-| ``request.get_json``            | ``request.json()``, prefer the ```data keyword argument`` <usage/4-request-data/#request-body>`__     |
+| ``request.get_json``            | ``request.json()``, prefer the ```data keyword argument`` <usage/requests/request-body>`__            |
 +---------------------------------+-------------------------------------------------------------------------------------------------------+
 | ``request.headers``             | ``request.headers``                                                                                   |
 +---------------------------------+-------------------------------------------------------------------------------------------------------+