Implement mypy annotations (#557)

Squashed commit: see https://github.com/64bitpandas/ocfweb/tree/mypy for full commit history

* Add mypy annotations

* Upgrade mypy version to 0.730

* Replace request: Any with request: HttpRequest

* Add warn_unused_ignores, clean up comments

* Fix form._errors call, clean comments/typeignores

* Remove field_order unnecessary comments

Author: 64bitpandas

mypy.ini

@@ -1,6 +1,19 @@
 [mypy]
-# TODO: enable more flags like in https://github.com/ocf/slackbridge/blob/master/mypy.ini
 show_traceback = True
 ignore_missing_imports = True
+check_untyped_defs = True
+
 plugins =
     mypy_django_plugin.main
+
+disallow_untyped_defs = True
+disallow_untyped_calls = True
+disallow_any_generics = True
+
+warn_no_return = True
+warn_redundant_casts = True
+warn_unused_configs = True
+warn_unused_ignores = True
+
+[mypy.plugins.django-stubs]
+django_settings_module = ocfweb.settings

ocfweb/about/lab.py

@@ -1,7 +1,9 @@
+from django.http import HttpRequest
+from django.http import HttpResponse
 from django.shortcuts import render
 
 
-def lab_open_source(request):
+def lab_open_source(request: HttpRequest) -> HttpResponse:
     return render(
         request,
         'about/lab-open-source.html',
@@ -11,7 +13,7 @@ def lab_open_source(request):
     )
 
 
-def lab_vote(request):
+def lab_vote(request: HttpRequest) -> HttpResponse:
     return render(
         request,
         'about/lab-vote.html',

ocfweb/about/staff.py

@@ -1,7 +1,9 @@
+from django.http import HttpRequest
+from django.http import HttpResponse
 from django.shortcuts import render
 
 
-def about_staff(request):
+def about_staff(request: HttpRequest) -> HttpResponse:
     return render(
         request,
         'about/staff.html',

ocfweb/account/chpass.py

@@ -1,4 +1,10 @@
+from typing import Any
+from typing import Iterator
+from typing import List
+
 from django import forms
+from django.http import HttpRequest
+from django.http import HttpResponse
 from django.shortcuts import render
 from django.template.loader import render_to_string
 from django.utils.safestring import mark_safe
@@ -15,15 +21,14 @@
 from ocfweb.component.celery import change_password as change_password_task
 from ocfweb.component.forms import Form
 
-
 CALLINK_ERROR_MSG = (
     "Couldn't connect to CalLink API. Resetting group "
     'account passwords online is unavailable.'
 )
 
 
-def get_accounts_signatory_for(calnet_uid):
-    def flatten(lst):
+def get_accounts_signatory_for(calnet_uid: str) -> List[Any]:
+    def flatten(lst: Iterator[Any]) -> List[Any]:
         return [item for sublist in lst for item in sublist]
 
     group_accounts = flatten(
@@ -40,7 +45,7 @@ def flatten(lst):
     return group_accounts
 
 
-def get_accounts_for(calnet_uid):
+def get_accounts_for(calnet_uid: str) -> List[Any]:
     accounts = users_by_calnet_uid(calnet_uid)
 
     if calnet_uid in TESTER_CALNET_UIDS:
@@ -51,7 +56,7 @@ def get_accounts_for(calnet_uid):
 
 
 @calnet_required
-def change_password(request):
+def change_password(request: HttpRequest) -> HttpResponse:
     calnet_uid = request.session['calnet_uid']
     error = None
     accounts = get_accounts_for(calnet_uid)
@@ -117,19 +122,20 @@ def change_password(request):
 
 
 class ChpassForm(Form):
-
-    def __init__(self, ocf_accounts, calnet_uid, *args, **kwargs):
+    # fix self.fields.keyOrder type error in mypy
+    field_order = [
+        'ocf_account',
+        'new_password',
+        'confirm_password',
+    ]
+
+    def __init__(self, ocf_accounts: List[str], calnet_uid: str, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
         self.calnet_uid = calnet_uid
         self.fields['ocf_account'] = forms.ChoiceField(
             choices=[(x, x) for x in ocf_accounts],
             label='OCF account',
         )
-        self.fields.keyOrder = [
-            'ocf_account',
-            'new_password',
-            'confirm_password',
-        ]
 
     new_password = forms.CharField(
         widget=forms.PasswordInput,
@@ -141,7 +147,7 @@ def __init__(self, ocf_accounts, calnet_uid, *args, **kwargs):
         label='Confirm password',
     )
 
-    def clean_ocf_account(self):
+    def clean_ocf_account(self) -> str:
         data = self.cleaned_data['ocf_account']
         if not user_exists(data):
             raise forms.ValidationError('OCF user account does not exist.')
@@ -161,7 +167,7 @@ def clean_ocf_account(self):
 
         return data
 
-    def clean_confirm_password(self):
+    def clean_confirm_password(self) -> str:
         new_password = self.cleaned_data.get('new_password')
         confirm_password = self.cleaned_data.get('confirm_password')
 

ocfweb/account/commands.py

@@ -1,5 +1,7 @@
 from django import forms
 from django.forms import widgets
+from django.http import HttpRequest
+from django.http import HttpResponse
 from django.shortcuts import render
 from paramiko import AuthenticationException
 from paramiko import SSHClient
@@ -8,7 +10,7 @@
 from ocfweb.component.forms import Form
 
 
-def commands(request):
+def commands(request: HttpRequest) -> HttpResponse:
     command_to_run = ''
     output = ''
     error = ''

ocfweb/account/recommender.py

@@ -1,15 +1,17 @@
 from random import randint
+from typing import Any
+from typing import List
 
 from ocflib.account.creation import validate_username
 from ocflib.account.creation import ValidationError
 from ocflib.account.creation import ValidationWarning
 
 
-def recommend(real_name, n):
-    name_fields = [name.lower() for name in real_name.split()]
+def recommend(real_name: str, n: int) -> List[Any]:
+    name_fields: List[str] = [name.lower() for name in real_name.split()]
 
     # Can reimplement name_field_abbrevs to only remove vowels or consonants
-    name_field_abbrevs = [[] for i in range(len(name_fields))]
+    name_field_abbrevs: List[List[str]] = [[] for i in range(len(name_fields))]
     for i in range(len(name_fields)):
         name_field = name_fields[i]
         for j in range(1, len(name_field) + 1):
@@ -23,7 +25,7 @@ def recommend(real_name, n):
                 new_unvalidated_recs.append(rec + name_field_abbrev)
         unvalidated_recs = new_unvalidated_recs
 
-    validated_recs = []
+    validated_recs: List[Any] = []
     while len(validated_recs) < n and len(unvalidated_recs) > 0:
         rec = unvalidated_recs.pop(randint(0, len(unvalidated_recs) - 1))
         try:

ocfweb/account/register.py

@@ -1,10 +1,13 @@
+from typing import Union
+
 import ocflib.account.search as search
 import ocflib.account.validators as validators
 import ocflib.misc.validators
 import ocflib.ucb.directory as directory
 from Crypto.PublicKey import RSA
 from django import forms
-from django.core.exceptions import NON_FIELD_ERRORS
+from django.http import HttpRequest
+from django.http import HttpResponse
 from django.http import HttpResponseBadRequest
 from django.http import HttpResponseRedirect
 from django.http import JsonResponse
@@ -29,7 +32,7 @@
 
 
 @calnet_required
-def request_account(request):
+def request_account(request: HttpRequest) -> Union[HttpResponseRedirect, HttpResponse]:
     calnet_uid = request.session['calnet_uid']
     status = 'new_request'
 
@@ -87,10 +90,10 @@ def request_account(request):
             if isinstance(task.result, NewAccountResponse):
                 if task.result.status == NewAccountResponse.REJECTED:
                     status = 'has_errors'
-                    form._errors[NON_FIELD_ERRORS] = form.error_class(task.result.errors)
+                    form.add_error('NON_FIELD_ERRORS', task.result.errors)
                 elif task.result.status == NewAccountResponse.FLAGGED:
                     status = 'has_warnings'
-                    form._errors[NON_FIELD_ERRORS] = form.error_class(task.result.errors)
+                    form.add_error('NON_FIELD_ERRORS', task.result.errors)
                 elif task.result.status == NewAccountResponse.PENDING:
                     return HttpResponseRedirect(reverse('account_pending'))
                 else:
@@ -114,7 +117,7 @@ def request_account(request):
     )
 
 
-def recommend(request):
+def recommend(request: HttpRequest) -> Union[JsonResponse, HttpResponseBadRequest]:
     real_name = request.GET.get('real_name', None)
     if real_name is None:
         return HttpResponseBadRequest('No real_name in recommend request')
@@ -127,7 +130,7 @@ def recommend(request):
     )
 
 
-def validate(request):
+def validate(request: HttpRequest) -> Union[HttpResponseBadRequest, JsonResponse]:
     real_name = request.GET.get('real_name', None)
     if real_name is None:
         return HttpResponseBadRequest('No real_name in validate request')
@@ -149,7 +152,7 @@ def validate(request):
         })
 
 
-def wait_for_account(request):
+def wait_for_account(request: HttpRequest) -> Union[HttpResponse, HttpResponseRedirect]:
     if 'approve_task_id' not in request.session:
         return render(
             request,
@@ -180,11 +183,11 @@ def wait_for_account(request):
     return render(request, 'account/register/wait/error-probably-not-created.html', {})
 
 
-def account_pending(request):
+def account_pending(request: HttpRequest) -> HttpResponse:
     return render(request, 'account/register/pending.html', {'title': 'Account request pending'})
 
 
-def account_created(request):
+def account_created(request: HttpRequest) -> HttpResponse:
     return render(request, 'account/register/success.html', {'title': 'Account request successful'})
 
 
@@ -232,7 +235,7 @@ class ApproveForm(Form):
         },
     )
 
-    def clean_verify_password(self):
+    def clean_verify_password(self) -> str:
         password = self.cleaned_data.get('password')
         verify_password = self.cleaned_data.get('verify_password')
 
@@ -241,7 +244,7 @@ def clean_verify_password(self):
                 raise forms.ValidationError("Your passwords don't match.")
         return verify_password
 
-    def clean_verify_contact_email(self):
+    def clean_verify_contact_email(self) -> str:
         email = self.cleaned_data.get('contact_email')
         verify_contact_email = self.cleaned_data.get('verify_contact_email')
 
@@ -250,7 +253,8 @@ def clean_verify_contact_email(self):
                 raise forms.ValidationError("Your emails don't match.")
         return verify_contact_email
 
-    def clean(self):
+    # clean incompatible with supertype BaseForm which is defined in django.
+    def clean(self) -> None:  # type: ignore
         cleaned_data = super().clean()
 
         # validate password (requires username to check similarity)

ocfweb/account/templatetags/vhost_mail.py

@@ -1,8 +1,10 @@
+from typing import List
+
 from django import template
 
 register = template.Library()
 
 
 @register.filter
-def address_to_parts(address):
+def address_to_parts(address: str) -> List[str]:
     return address.split('@')

ocfweb/account/vhost.py

@@ -2,9 +2,12 @@
 import re
 import socket
 from textwrap import dedent
+from typing import Any
 
 from django import forms
 from django.conf import settings
+from django.http import HttpRequest
+from django.http import HttpResponse
 from django.shortcuts import redirect
 from django.shortcuts import render
 from django.urls import reverse
@@ -23,18 +26,18 @@
 from ocfweb.component.session import logged_in_user
 
 
-def available_domain(domain):
+def available_domain(domain: str) -> bool:
     if not re.match(r'^[a-zA-Z0-9]+\.berkeley\.edu$', domain):
         return False
     return not host_exists(domain)
 
 
-def valid_domain_external(domain):
+def valid_domain_external(domain: str) -> bool:
     return bool(re.match(r'([a-zA-Z0-9]+\.)+[a-zA-Z0-9]{2,}', domain))
 
 
 @login_required
-def request_vhost(request):
+def request_vhost(request: HttpRequest) -> HttpResponse:
     user = logged_in_user(request)
     attrs = user_attrs(user)
     is_group = 'callinkOid' in attrs
@@ -137,7 +140,9 @@ def request_vhost(request):
                 else:
                     return redirect(reverse('request_vhost_success'))
     else:
-        form = VirtualHostForm(is_group, initial={'requested_subdomain': user + '.berkeley.edu'})
+        # Unsupported left operand type for + ("None") because form might not have been instantiated at this point...
+        # but this doesn't matter because of if-else clause
+        form = VirtualHostForm(is_group, initial={'requested_subdomain': user + '.berkeley.edu'})  # type: ignore
 
     group_url = f'https://www.ocf.berkeley.edu/~{user}/'
 
@@ -156,7 +161,7 @@ def request_vhost(request):
     )
 
 
-def request_vhost_success(request):
+def request_vhost_success(request: HttpRequest) -> HttpResponse:
     return render(
         request,
         'account/vhost/success.html',
@@ -231,7 +236,7 @@ class VirtualHostForm(Form):
         max_length=1024,
     )
 
-    def __init__(self, is_group=True, *args, **kwargs):
+    def __init__(self, is_group: bool = True, *args: Any, **kwargs: Any) -> None:
         super(Form, self).__init__(*args, **kwargs)
 
         # It's pretty derpy that we have to set the labels here, but we can't
@@ -266,7 +271,7 @@ def __init__(self, is_group=True, *args, **kwargs):
                 max_length=64,
             )
 
-    def clean_requested_subdomain(self):
+    def clean_requested_subdomain(self) -> str:
         requested_subdomain = self.cleaned_data['requested_subdomain'].lower().strip()
 
         if self.cleaned_data['requested_own_domain']:
@@ -291,7 +296,7 @@ def clean_requested_subdomain(self):
 
         return requested_subdomain
 
-    def clean_your_email(self):
+    def clean_your_email(self) -> str:
         your_email = self.cleaned_data['your_email']
         if not valid_email(your_email):
             raise forms.ValidationError(