PYTHON-4197: Convert str usage to SecretStr (#30)

Author: Jibola

{{cookiecutter.project_slug}}/backend/app/app/schemas/emails.py

@@ -1,5 +1,4 @@
-from pydantic import BaseModel, EmailStr
-from typing import List
+from pydantic import BaseModel, EmailStr, SecretStr
 
 
 class EmailContent(BaseModel):
@@ -11,4 +10,4 @@ class EmailContent(BaseModel):
 class EmailValidation(BaseModel):
     email: EmailStr
     subject: str
-    token: str
+    token: SecretStr

{{cookiecutter.project_slug}}/backend/app/app/schemas/token.py

@@ -1,10 +1,10 @@
 from typing import Optional
-from pydantic import ConfigDict, BaseModel
+from pydantic import BaseModel, ConfigDict, SecretStr
 from odmantic import Model, ObjectId
 
 
 class RefreshTokenBase(BaseModel):
-    token: str
+    token: SecretStr
     authenticates: Optional[Model] = None
 
 
@@ -21,8 +21,8 @@ class RefreshToken(RefreshTokenUpdate):
 
 
 class Token(BaseModel):
-    access_token: str
-    refresh_token: Optional[str] = None
+    access_token: SecretStr
+    refresh_token: Optional[SecretStr] = None
     token_type: str
 
 

{{cookiecutter.project_slug}}/backend/app/app/schemas/totp.py

@@ -1,14 +1,14 @@
 from typing import Optional
-from pydantic import BaseModel
+from pydantic import BaseModel, SecretStr
 
 
 class NewTOTP(BaseModel):
-    secret: Optional[str] = None
+    secret: Optional[SecretStr] = None
     key: str
     uri: str
 
 
 class EnableTOTP(BaseModel):
     claim: str
     uri: str
-    password: Optional[str] = None
+    password: Optional[SecretStr] = None

{{cookiecutter.project_slug}}/backend/app/app/schemas/user.py

@@ -1,6 +1,6 @@
 from typing import Optional
 from typing_extensions import Annotated
-from pydantic import ConfigDict, BaseModel, Field, EmailStr, StringConstraints, field_validator
+from pydantic import BaseModel, ConfigDict, Field, EmailStr, StringConstraints, field_validator, SecretStr
 from odmantic import ObjectId
 
 
@@ -56,6 +56,6 @@ def evaluate_totp_secret(cls, totp_secret):
 
 # Additional properties stored in DB
 class UserInDB(UserInDBBase):
-    hashed_password: Optional[str] = None
-    totp_secret: Optional[str] = None
+    hashed_password: Optional[SecretStr] = None
+    totp_secret: Optional[SecretStr] = None
     totp_counter: Optional[int] = None