Add documentation and source

Added documentation, source and extra files.

source/advanced/various/__init__.py

@@ -0,0 +1,9 @@
+from django.apps import AppConfig
+
+
+class VariousConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "various"
+
+
+default_app_config = "various.VariousConfig"

source/advanced/various/admin/__init__.py

@@ -0,0 +1 @@
+from .room import *

source/advanced/various/admin/room.py

@@ -0,0 +1,51 @@
+from django.contrib import admin
+from django.db import models
+from django.db.models import F
+from django.http import HttpRequest
+from django.utils.translation import gettext_lazy as _
+
+from various.models import Room
+
+
+@admin.register(Room)
+class RoomAdmin(admin.ModelAdmin):
+    """
+    Admin configuration for rooms.
+
+    """
+
+    list_display = ["id", "name", "length", "width", "height", "get_volume_display"]
+    list_editable = ["name", "length", "width", "height"]
+    actions = ["action_fix_minimum"]
+
+    def get_queryset(self, request):
+        """
+        Change queryset to add a computed field for volume.
+
+        Args:
+            request: HTTP
+
+        """
+        return super().get_queryset(request).annotate(volume=F("width") * F("length") * F("height"))
+
+    def get_volume_display(self, obj: Room) -> str:
+        return f"{obj.get_volume()} cm³"
+
+    get_volume_display.short_description = _("area")
+    get_volume_display.admin_order_field = "volume"
+
+    def action_fix_minimum(self, request: HttpRequest, queryset: models.QuerySet):
+        """
+        Change room dimensions to have at least 1cm in every axis.
+
+        Args:
+            request: HTTP request.
+            queryset: selected rooms.
+
+        """
+        for room in queryset:  # type: Room
+            room.width = max(1, room.width)
+            room.length = max(1, room.length)
+            room.height = max(1, room.height)
+            room.save()
+        self.message_user(request, _("The selected rooms have been updated."))

source/advanced/various/locale/fr/LC_MESSAGES/django.po

@@ -0,0 +1,59 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
+# This file is distributed under the same license as the PACKAGE package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: PACKAGE VERSION\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2021-04-18 11:30+0000\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+#: various/admin/room.py:34
+msgid "area"
+msgstr "aire"
+
+#: various/admin/room.py:51
+msgid "The selected rooms have been updated."
+msgstr "Les salles sélectionnées ont été mises à jour."
+
+#: various/models/room.py:11
+msgid "name"
+msgstr "nom"
+
+#: various/models/room.py:12
+msgid "description"
+msgstr "description"
+
+#: various/models/room.py:13 various/models/room.py:14
+#: various/models/room.py:15
+msgid "centimeters"
+msgstr "centimètres"
+
+#: various/models/room.py:13
+msgid "width"
+msgstr "largeur"
+
+#: various/models/room.py:14
+msgid "length"
+msgstr "longueur"
+
+#: various/models/room.py:15
+msgid "height"
+msgstr "hauteur"
+
+#: various/models/room.py:18
+msgid "room"
+msgstr "salle"
+
+#: various/models/room.py:19
+msgid "rooms"
+msgstr "salles"

source/advanced/various/migrations/0001_initial.py

@@ -0,0 +1,29 @@
+# Generated by Django 3.2 on 2021-04-18 11:28
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Room',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=32, unique=True, verbose_name='name')),
+                ('description', models.TextField(blank=True, verbose_name='description')),
+                ('width', models.PositiveIntegerField(default=0, help_text='centimeters', verbose_name='width')),
+                ('length', models.PositiveIntegerField(default=0, help_text='centimeters', verbose_name='length')),
+                ('height', models.PositiveIntegerField(default=0, help_text='centimeters', verbose_name='height')),
+            ],
+            options={
+                'verbose_name': 'room',
+                'verbose_name_plural': 'rooms',
+            },
+        ),
+    ]

source/advanced/various/models/__init__.py

@@ -0,0 +1 @@
+from .room import *

source/advanced/various/models/room.py

@@ -0,0 +1,49 @@
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+
+class Room(models.Model):
+    """
+    Room definition.
+
+    """
+
+    name = models.CharField(max_length=32, blank=False, unique=True, verbose_name=_("name"))
+    description = models.TextField(blank=True, verbose_name=_("description"))
+    width = models.PositiveIntegerField(default=0, help_text=_("centimeters"), verbose_name=_("width"))
+    length = models.PositiveIntegerField(default=0, help_text=_("centimeters"), verbose_name=_("length"))
+    height = models.PositiveIntegerField(default=0, help_text=_("centimeters"), verbose_name=_("height"))
+
+    class Meta:
+        verbose_name = _("room")
+        verbose_name_plural = _("rooms")
+
+    def get_area(self) -> int:
+        """
+        Get the area of the room.
+
+        Returns:
+            Area of the room in square centimeters.
+
+        """
+        return self.width * self.length
+
+    def get_volume(self) -> int:
+        """
+        Get the volume of the room.
+
+        Returns:
+            Volume of the room in cube centimeters.
+
+        """
+        return self.width * self.length * self.height
+
+    def is_empty(self) -> bool:
+        """
+        Tell if the room is empty (has no volume).
+
+        Returns:
+            Whether the room has no volume (zero).
+
+        """
+        return self.width * self.length * self.height == 0

source/advanced/various/tests/__init__.py

@@ -0,0 +1 @@
+from .room import *

source/advanced/various/tests/room.py

@@ -0,0 +1,55 @@
+from django import test
+
+from various.models import Room
+
+
+class RoomTestCase(test.TestCase):
+    """
+    Basic test case for rooms.
+
+    This method is executed before every `test_` function.
+    To run those automatic tests, in a terminal, just run
+
+    `./manage.py test`
+
+    """
+
+    def setUp(self) -> None:
+        self.room1 = Room(name="Kitchen", width=260, length=320, height=250)  # basic
+        self.room2 = Room(name="Fake", width=0, length=320, height=250)  # a 2D object
+
+    @classmethod
+    def setUpClass(cls):
+        """Cette méthode est exécutée une seule fois avant ous les tests."""
+        pass
+
+    @classmethod
+    def tearDownClass(cls):
+        pass
+
+    def tearDown(self) -> None:
+        """
+        End unit test.
+
+        Is executed after every `test_` method.
+
+        """
+
+    def test_base_room(self):
+        """
+        Basic test using the fixture set up in the `setUp` method.
+
+        """
+        self.assertEqual(self.room2.get_volume(), 0)
+        self.assertEqual(self.room1.get_area(), 83200)
+
+    def test_dummy_page(self):
+        """
+        Test the Django test client.
+
+        Used to test that pages of the projet answer properly.
+
+        """
+        client = test.Client()
+        response = client.get("/admin/")
+        self.assertNotEqual(response.status_code, 404)

source/advanced/various/views.py

@@ -0,0 +1,21 @@
+from django.core.files.storage import DefaultStorage
+from django.http import HttpRequest, HttpResponse
+
+
+def view_file_download(request: HttpRequest) -> HttpResponse:
+    """
+    Serve a media file like a download.
+
+    Args:
+        request: HTTP request.
+
+    Returns:
+        Media file as an attachment to download.
+
+    """
+    storage = DefaultStorage()  # Objet capable de manipuler des fichiers média
+    with storage.open("django-upload.jpg", "rb") as file:  # relative to MEDIA_ROOT
+        response = HttpResponse(file, content_type="image/jpeg")
+        # Use list notation to set headers
+        response["Content-Disposition"] = "attachment; filename=django-upload.jpg"
+        return response