Add a lot of comments

apps/registration/views.py

@@ -19,6 +19,9 @@ from .models import StudentRegistration
 
 
 class SignupView(CreateView):
+    """
+    Signup, as a participant or a coach.
+    """
     model = User
     form_class = SignupForm
     template_name = "registration/signup.html"
@@ -126,23 +129,34 @@ class UserResendValidationEmailView(LoginRequiredMixin, DetailView):
 
 
 class MyAccountDetailView(LoginRequiredMixin, RedirectView):
+    """
+    Redirect to our own profile detail page.
+    """
     def get_redirect_url(self, *args, **kwargs):
         return reverse_lazy("registration:user_detail", args=(self.request.user.pk,))
 
 
 class UserDetailView(LoginRequiredMixin, DetailView):
+    """
+    Display the detail about a user.
+    """
+
     model = User
     context_object_name = "user_object"
     template_name = "registration/user_detail.html"
 
     def dispatch(self, request, *args, **kwargs):
         user = request.user
+        # Only an admin or the concerned user can see the information
         if not user.registration.is_admin and user.pk != kwargs["pk"]:
             raise PermissionDenied
         return super().dispatch(request, *args, **kwargs)
 
 
 class UserUpdateView(LoginRequiredMixin, UpdateView):
+    """
+    Update the detail about a user and its registration.
+    """
     model = User
     form_class = UserForm
     template_name = "registration/update_user.html"
@@ -176,6 +190,9 @@ class UserUpdateView(LoginRequiredMixin, UpdateView):
 
 
 class UserUploadPhotoAuthorizationView(LoginRequiredMixin, UpdateView):
+    """
+    A participant can send its photo authorization.
+    """
     model = StudentRegistration
     form_class = PhotoAuthorizationForm
     template_name = "registration/upload_photo_authorization.html"
@@ -198,6 +215,9 @@ class UserUploadPhotoAuthorizationView(LoginRequiredMixin, UpdateView):
 
 
 class PhotoAuthorizationView(LoginRequiredMixin, View):
+    """
+    Display the sent photo authorization.
+    """
     def get(self, request, *args, **kwargs):
         filename = kwargs["filename"]
         path = f"media/authorization/photo/{filename}"
@@ -207,18 +227,21 @@ class PhotoAuthorizationView(LoginRequiredMixin, View):
         user = request.user
         if not user.registration.is_admin and user.pk != student.user.pk:
             raise PermissionDenied
+        # Guess mime type of the file
         mime = Magic(mime=True)
         mime_type = mime.from_file(path)
         ext = mime_type.split("/")[1].replace("jpeg", "jpg")
+        # Replace file name
         true_file_name = _("Photo authorization of {student}.{ext}").format(student=str(student), ext=ext)
         return FileResponse(open(path, "rb"), content_type=mime_type, filename=true_file_name)
 
 
 class UserImpersonateView(LoginRequiredMixin, RedirectView):
+    """
+    An administrator can log in through this page as someone else, and act as this other person.
+    """
+
     def dispatch(self, request, *args, **kwargs):
-        """
-        An administrator can log in through this page as someone else, and act as this other person.
-        """
         if self.request.user.registration.is_admin:
             if not User.objects.filter(pk=kwargs["pk"]).exists():
                 raise Http404