File and comment formatting + simplifications

Author: andrewtavis

backend/authentication/models.py

@@ -83,7 +83,7 @@ class Support(models.Model):
     creation_date = models.DateTimeField(auto_now_add=True)
 
     def __str__(self) -> str:
-        return f"{self.id}"
+        return str(self.id)
 
 
 class UserModel(AbstractUser, PermissionsMixin):

backend/communities/groups/models.py

@@ -51,7 +51,7 @@ class GroupImage(models.Model):
     sequence_index = models.IntegerField()
 
     def __str__(self) -> str:
-        return f"{self.id}"
+        return str(self.id)
 
 
 class GroupMember(models.Model):
@@ -68,7 +68,7 @@ class GroupMember(models.Model):
     is_comms = models.BooleanField(default=False)
 
     def __str__(self) -> str:
-        return f"{self.id}"
+        return str(self.id)
 
 
 class GroupSocialLink(SocialLink):

backend/communities/organizations/models.py

@@ -68,7 +68,7 @@ class OrganizationApplication(models.Model):
     creation_date = models.DateTimeField(auto_now_add=True)
 
     def __str__(self) -> str:
-        return f"{self.creation_date}"
+        return str(self.creation_date)
 
 
 class OrganizationApplicationStatus(models.Model):
@@ -85,7 +85,7 @@ class OrganizationImage(models.Model):
     sequence_index = models.IntegerField()
 
     def __str__(self) -> str:
-        return f"{self.id}"
+        return str(self.id)
 
 
 class OrganizationMember(models.Model):
@@ -96,7 +96,7 @@ class OrganizationMember(models.Model):
     is_comms = models.BooleanField(default=False)
 
     def __str__(self) -> str:
-        return f"{self.id}"
+        return str(self.id)
 
 
 class OrganizationSocialLink(SocialLink):
@@ -114,7 +114,7 @@ class OrganizationTask(models.Model):
     )
 
     def __str__(self) -> str:
-        return f"{self.id}"
+        return str(self.id)
 
 
 class OrganizationText(models.Model):

backend/content/models.py

@@ -26,7 +26,7 @@ class Discussion(models.Model):
     tags = models.ManyToManyField("content.Tag", blank=True)
 
     def __str__(self) -> str:
-        return f"{self.id}"
+        return str(self.id)
 
 
 class Faq(models.Model):
@@ -45,9 +45,10 @@ def __str__(self) -> str:
 # This is used to set the filename to the UUID of the model, in the Image model.
 def set_filename_to_uuid(instance: Any, filename: str) -> str:
     """Generate a new filename using the model's UUID and keep the original extension."""
-    ext = os.path.splitext(filename)[1]  # Extract file extension
-    new_filename = f"{instance.id}{ext}"  # Use model UUID as filename
-    return os.path.join("images/", new_filename)  # Store in 'images/' folder
+    ext = os.path.splitext(filename)[1]  # extract file extension
+    new_filename = f"{instance.id}{ext}"  # use model UUID as filename
+
+    return os.path.join("images/", new_filename)  # store in 'images/' folder
 
 
 class Image(models.Model):
@@ -72,7 +73,7 @@ class Location(models.Model):
     display_name = models.CharField(max_length=255)
 
     def __str__(self) -> str:
-        return f"{self.id}"
+        return str(self.id)
 
 
 class Resource(models.Model):
@@ -128,7 +129,7 @@ class Tag(models.Model):
     creation_date = models.DateTimeField(auto_now_add=True)
 
     def __str__(self) -> str:
-        return f"{self.id}"
+        return str(self.id)
 
 
 class Task(models.Model):
@@ -174,4 +175,4 @@ class DiscussionEntry(models.Model):
     deletion_date = models.DateTimeField(blank=True, null=True)
 
     def __str__(self) -> str:
-        return f"{self.id}"
+        return str(self.id)

backend/content/serializers.py

@@ -39,46 +39,50 @@ class Meta:
         fields = "__all__"
 
 
-# MARK: Clear out image meta data. Used in Image Serializer, below.
+# MARK: Clear Metadata
+
+
 def scrub_exif(image_file: InMemoryUploadedFile) -> InMemoryUploadedFile:
     """
-    Remove EXIF data from JPEGs and text metadata from PNGs.
+    Remove EXIF metadata from JPEGs and text metadata from PNGs.
     """
     try:
         img: PILImage.Image = PILImage.open(image_file)
         output_format = img.format
 
         if output_format == "JPEG":
             img = img.convert("RGB")
+
         elif output_format == "PNG":
             img = img.copy()
             img.info = {}
+
         else:
-            return image_file  # Return as-is if it's not JPEG or PNG
+            return image_file  # return as-is if it's not JPEG or PNG
 
-        # Save the cleaned image into a buffer
+        # Save the cleaned image into a buffer.
         output = BytesIO()
         img.save(
             output,
             format=output_format,
-            quality=95 if output_format == "JPEG" else None,  # Set JPEG quality
-            optimize=True if output_format == "JPEG" else False,  # Optimize JPEG
+            quality=95 if output_format == "JPEG" else None,  # set JPEG quality
+            optimize=output_format == "JPEG",  # optimize JPEG
         )
         output.seek(0)
 
         # Return a new InMemoryUploadedFile
         return InMemoryUploadedFile(
             output,
-            image_file.field_name,  # Use original field name
+            image_file.field_name,  # use original field name
             image_file.name,
             f"image/{output_format.lower()}",
             output.getbuffer().nbytes,
-            image_file.charset,  # Preserve charset (if applicable)
+            image_file.charset,  # preserve charset (if applicable)
         )
 
     except Exception as e:
         print(f"Error scrubbing EXIF: {e}")
-        return image_file  # Return original file in case of error
+        return image_file  # return original file in case of error
 
 
 class ImageSerializer(serializers.ModelSerializer[Image]):
@@ -92,8 +96,7 @@ def validate(self, data: Dict[str, UploadedFile]) -> Dict[str, UploadedFile]:
             raise serializers.ValidationError("No file was submitted.")
 
         # DATA_UPLOAD_MAX_MEMORY_SIZE and IMAGE_UPLOAD_MAX_FILE_SIZE are set in core/settings.py.
-        # For whatever reason, the file size limit is not being enforced. To get around this,
-        # we're checking the file size here.
+        # The file size limit is not being enforced. We're checking the file size here.
         if (
             data["file_object"].size is not None
             and data["file_object"].size > settings.IMAGE_UPLOAD_MAX_FILE_SIZE
@@ -111,10 +114,10 @@ def create(self, validated_data: Dict[str, Any]) -> Image:
         if file_obj := request.FILES.get("file_object"):
             validated_data["file_object"] = scrub_exif(file_obj)
 
-        # Create the image instance
+        # Create the image instance.
         image = super().create(validated_data)
 
-        # Handle organization image indexing if applicable
+        # Handle organization image indexing if applicable.
         if organization_id := request.data.get("organization_id"):
             next_index = OrganizationImage.objects.filter(
                 org_id=organization_id

backend/content/tests/test_image_upload.py

@@ -143,6 +143,7 @@ def test_image_create_view(client: APIClient, image_with_file: Image) -> None:
     try:
         uuid_obj = uuid.UUID(uuid_filename, version=4)
         assert str(uuid_obj) == uuid_filename
+
     except ValueError:
         assert False, f"Filename is not a valid UUID: {uuid_filename}"
 
@@ -183,9 +184,9 @@ def test_image_create_corrupted_file(client: APIClient) -> None:
     img = TestImage.new("RGB", (100, 100), color="red")
     img_file = io.BytesIO()
     img.save(img_file, format="JPEG")
-    # Take the first 100 bytes
+    # Take the first 100 bytes.
     corrupted_img = img_file.getvalue()[:100]
-    # Add some corrupt data after
+    # Add some corrupt data after.
     corrupted_img += b"corrupteddata"
     # Wrap the corrupted image data in a SimpleUploadedFile.
     file = SimpleUploadedFile(
@@ -231,8 +232,7 @@ def test_image_create_large_file(client: APIClient) -> None:
     assert response.status_code == 400
 
     # DATA_UPLOAD_MAX_MEMORY_SIZE and IMAGE_UPLOAD_MAX_FILE_SIZE are set in core/settings.py.
-    # For whatever reason, the file size limit is not being enforced. To get around this,
-    # we're checking the file size in the serializer validation.
+    # The file size limit is not being enforced. We're checking the file size in the serializer validation.
     assert (
         f"The file size ({file.size} bytes) is too large. The maximum file size is {settings.IMAGE_UPLOAD_MAX_FILE_SIZE} bytes."
         in response.json()["nonFieldErrors"]

docker-compose.yml

@@ -42,6 +42,7 @@ services:
       retries: 5
     volumes:
       - ./backend/media:/app/media
+
   frontend:
     env_file:
       - .env.dev

frontend/nuxt.config.ts

@@ -137,7 +137,8 @@ export default defineNuxtConfig({
       interval: "minute",
       whiteList: ["127.0.0.1"],
     },
-    removeLoggers: false, // When true, turns off console.log output? Also lookk at unplugin-remove Vite Plugin by Talljack
+    // When true, turns off console.log output? Also look at unplugin-remove Vite Plugin by Talljack.
+    removeLoggers: false,
     requestSizeLimiter: {
       maxUploadFileRequestInBytes: 5000000,
     },