use google convention for docstrings

api/views/__init__.py

@@ -23,9 +23,9 @@ from core.views import can_edit, can_view
 
 
 def check_if(obj, user, test):
-    """
-    Detect if it's a single object or a queryset
-    aply a given test on individual object and return global permission
+    """Detect if it's a single object or a queryset.
+
+    Apply a given test on individual object and return global permission.
     """
     if isinstance(obj, QuerySet):
         for o in obj:
@@ -39,9 +39,7 @@ def check_if(obj, user, test):
 class ManageModelMixin:
     @action(detail=True)
     def id(self, request, pk=None):
-        """
-        Get by id (api/v1/router/{pk}/id/)
-        """
+        """Get by id (api/v1/router/{pk}/id/)."""
         self.queryset = get_object_or_404(self.queryset.filter(id=pk))
         serializer = self.get_serializer(self.queryset)
         return Response(serializer.data)

api/views/api.py

@@ -23,9 +23,7 @@ from core.templatetags.renderer import markdown
 @api_view(["POST"])
 @renderer_classes((StaticHTMLRenderer,))
 def RenderMarkdown(request):
-    """
-    Render Markdown
-    """
+    """Render Markdown."""
     try:
         data = markdown(request.POST["text"])
     except:

api/views/club.py

@@ -31,9 +31,7 @@ class ClubSerializer(serializers.ModelSerializer):
 
 
 class ClubViewSet(RightModelViewSet):
-    """
-    Manage Clubs (api/v1/club/)
-    """
+    """Manage Clubs (api/v1/club/)."""
 
     serializer_class = ClubSerializer
     queryset = Club.objects.all()

api/views/counter.py

@@ -33,18 +33,14 @@ class CounterSerializer(serializers.ModelSerializer):
 
 
 class CounterViewSet(RightModelViewSet):
-    """
-    Manage Counters (api/v1/counter/)
-    """
+    """Manage Counters (api/v1/counter/)."""
 
     serializer_class = CounterSerializer
     queryset = Counter.objects.all()
 
     @action(detail=False)
     def bar(self, request):
-        """
-        Return all bars (api/v1/counter/bar/)
-        """
+        """Return all bars (api/v1/counter/bar/)."""
         self.queryset = self.queryset.filter(type="BAR")
         serializer = self.get_serializer(self.queryset, many=True)
         return Response(serializer.data)

api/views/group.py

@@ -25,9 +25,7 @@ class GroupSerializer(serializers.ModelSerializer):
 
 
 class GroupViewSet(RightModelViewSet):
-    """
-    Manage Groups (api/v1/group/)
-    """
+    """Manage Groups (api/v1/group/)."""
 
     serializer_class = GroupSerializer
     queryset = RealGroup.objects.all()

api/views/launderette.py

@@ -60,54 +60,42 @@ class LaunderetteTokenSerializer(serializers.ModelSerializer):
 
 
 class LaunderettePlaceViewSet(RightModelViewSet):
-    """
-    Manage Launderette (api/v1/launderette/place/)
-    """
+    """Manage Launderette (api/v1/launderette/place/)."""
 
     serializer_class = LaunderettePlaceSerializer
     queryset = Launderette.objects.all()
 
 
 class LaunderetteMachineViewSet(RightModelViewSet):
-    """
-    Manage Washing Machines (api/v1/launderette/machine/)
-    """
+    """Manage Washing Machines (api/v1/launderette/machine/)."""
 
     serializer_class = LaunderetteMachineSerializer
     queryset = Machine.objects.all()
 
 
 class LaunderetteTokenViewSet(RightModelViewSet):
-    """
-    Manage Launderette's tokens (api/v1/launderette/token/)
-    """
+    """Manage Launderette's tokens (api/v1/launderette/token/)."""
 
     serializer_class = LaunderetteTokenSerializer
     queryset = Token.objects.all()
 
     @action(detail=False)
     def washing(self, request):
-        """
-        Return all washing tokens (api/v1/launderette/token/washing)
-        """
+        """Return all washing tokens (api/v1/launderette/token/washing)."""
         self.queryset = self.queryset.filter(type="WASHING")
         serializer = self.get_serializer(self.queryset, many=True)
         return Response(serializer.data)
 
     @action(detail=False)
     def drying(self, request):
-        """
-        Return all drying tokens (api/v1/launderette/token/drying)
-        """
+        """Return all drying tokens (api/v1/launderette/token/drying)."""
         self.queryset = self.queryset.filter(type="DRYING")
         serializer = self.get_serializer(self.queryset, many=True)
         return Response(serializer.data)
 
     @action(detail=False)
     def avaliable(self, request):
-        """
-        Return all avaliable tokens (api/v1/launderette/token/avaliable)
-        """
+        """Return all avaliable tokens (api/v1/launderette/token/avaliable)."""
         self.queryset = self.queryset.filter(
             borrow_date__isnull=True, user__isnull=True
         )
@@ -116,9 +104,7 @@ class LaunderetteTokenViewSet(RightModelViewSet):
 
     @action(detail=False)
     def unavaliable(self, request):
-        """
-        Return all unavaliable tokens (api/v1/launderette/token/unavaliable)
-        """
+        """Return all unavaliable tokens (api/v1/launderette/token/unavaliable)."""
         self.queryset = self.queryset.filter(
             borrow_date__isnull=False, user__isnull=False
         )

api/views/user.py

@@ -39,9 +39,9 @@ class UserSerializer(serializers.ModelSerializer):
 
 
 class UserViewSet(RightModelViewSet):
-    """
-    Manage Users (api/v1/user/)
-    Only show active users
+    """Manage Users (api/v1/user/).
+
+    Only show active users.
     """
 
     serializer_class = UserSerializer
@@ -49,9 +49,7 @@ class UserViewSet(RightModelViewSet):
 
     @action(detail=False)
     def birthday(self, request):
-        """
-        Return all users born today (api/v1/user/birstdays)
-        """
+        """Return all users born today (api/v1/user/birstdays)."""
         date = datetime.datetime.today()
         self.queryset = self.queryset.filter(date_of_birth=date)
         serializer = self.get_serializer(self.queryset, many=True)

api/views/uv.py

@@ -28,10 +28,10 @@ def uv_endpoint(request):
     return Response(make_clean_uv(short_uv, full_uv))
 
 
-def find_uv(lang, year, code):
-    """
-    Uses the UTBM API to find an UV.
-    short_uv is the UV entry in the UV list. It is returned as it contains
+def find_uv(lang: str, year: int | str, code: str) -> tuple[dict | None, dict | None]:
+    """Uses the UTBM API to find an UV.
+
+    Short_uv is the UV entry in the UV list. It is returned as it contains
     information which are not in full_uv.
     full_uv is the detailed representation of an UV.
     """
@@ -44,7 +44,7 @@ def find_uv(lang, year, code):
         # find the first UV which matches the code
         short_uv = next(uv for uv in uvs if uv["code"] == code)
     except StopIteration:
-        return (None, None)
+        return None, None
 
     # get detailed information about the UV
     uv_url = settings.SITH_PEDAGOGY_UTBM_API + "/uv/{}/{}/{}/{}".format(
@@ -53,13 +53,11 @@ def find_uv(lang, year, code):
     response = urllib.request.urlopen(uv_url)
     full_uv = json.loads(response.read().decode("utf-8"))
 
-    return (short_uv, full_uv)
+    return short_uv, full_uv
 
 
-def make_clean_uv(short_uv, full_uv):
-    """
-    Cleans the data up so that it corresponds to our data representation.
-    """
+def make_clean_uv(short_uv: dict, full_uv: dict):
+    """Cleans the data up so that it corresponds to our data representation."""
     res = {}
 
     res["credit_type"] = short_uv["codeCategorie"]