tidy up some issues highlighted by quantifiedcode

api/drf_permissions.py

@@ -5,41 +5,47 @@ class CanSeeGroups(permissions.BasePermission):
     """Check if a user should see Groups."""
 
     def has_permission(self, request, view):
+        """Check permission."""
         return request.user.profile.can_see_groups
 
 
 class CanSeeContactNames(permissions.BasePermission):
     """Check if a user should see names of Contacts."""
 
     def has_permission(self, request, view):
+        """Check permission."""
         return request.user.profile.can_see_contact_names
 
 
 class CanSeeKeywords(permissions.BasePermission):
     """Check if a user should have access to keywords."""
 
     def has_permission(self, request, view):
+        """Check permission."""
         return request.user.profile.can_see_keywords
 
 
 class CanSeeOutgoing(permissions.BasePermission):
     """Check if a user should have access to outgoing log."""
 
     def has_permission(self, request, view):
+        """Check permission."""
         return request.user.profile.can_see_outgoing
 
 
 class CanSeeIncoming(permissions.BasePermission):
     """Check if a user should have access to incoming log."""
 
     def has_permission(self, request, view):
+        """Check permission."""
         return request.user.profile.can_see_incoming
 
 
 class CanSeeKeyword(permissions.BasePermission):
     """Check if a user should have access to a single keyword."""
 
     def has_object_permission(self, request, view, obj):
+        """Check permission."""
         if not obj.is_locked:
             return True
 
@@ -50,11 +56,13 @@ class CanImport(permissions.BasePermission):
     """Check if a user can import."""
 
     def has_permission(self, request, view):
+        """Check permission."""
         return request.user.is_staff or request.user.profile.can_import
 
 
 class IsStaff(permissions.BasePermission):
     """Check if a user has staff privileges."""
 
     def has_permission(self, request, view):
+        """Check permission."""
         return request.user.is_staff or request.user.is_superuser

api/serializers.py

@@ -186,11 +186,13 @@ def _split_args(sched_args):
         return ast.literal_eval(sched_args)
 
     def get_message_body(self, obj):
+        """Fetch the message body arg."""
         if obj.args is None:
             return None
         return self._split_args(obj.args)[1]
 
     def get_recipient(self, obj):
+        """Fetch the recipient arg and serialize."""
         if obj.args is None:
             return None
         pk = self._split_args(obj.args)[0]
@@ -202,6 +204,7 @@ def get_recipient(self, obj):
             return {'url': '#', 'full_name': 'n/a'}
 
     def get_recipient_group(self, obj):
+        """Fetch the recipient group arg and serialize."""
         if obj.args is None:
             return None
         grp_name = self._split_args(obj.args)[2]
@@ -213,6 +216,7 @@ def get_recipient_group(self, obj):
             return {'url': '#', 'name': 'n/a'}
 
     def get_queued_by(self, obj):
+        """Fetch the queued by arg."""
         if obj.args is None:
             return None
         return self._split_args(obj.args)[3]

apostello/account.py

@@ -4,6 +4,11 @@
 
 
 class ApostelloAccountAdapter(DefaultAccountAdapter):
+    """Custom dapter for django-allauth.
+
+    Overrides `get_from_email` to load from db then fall back to settings.
+    """
+
     def get_from_email(self):
         """Override to use SiteConfiguration, then fall back to settings."""
         from site_config.models import SiteConfiguration

apostello/forms.py

@@ -36,6 +36,7 @@ class SendAdhocRecipientsForm(forms.Form):
     )
 
     def clean(self):
+        """Override clean method to check SMS cost limit."""
         cleaned_data = super(SendAdhocRecipientsForm, self).clean()
         if 'recipients' in cleaned_data and 'content' in cleaned_data:
             # if we have no recipients, we don't need to check cost limit
@@ -82,6 +83,7 @@ class SendRecipientGroupForm(forms.Form):
     )
 
     def clean(self):
+        """Override clean method to check SMS cost limit."""
         cleaned_data = super(SendRecipientGroupForm, self).clean()
         if 'recipient_group' in cleaned_data and 'content' in cleaned_data:
             # if we have no recipient group, we don't need to check cost limit

apostello/management/commands/import_incoming_sms.py

@@ -13,4 +13,5 @@ class Command(BaseCommand):
     help = 'Import incoming messages from twilio'
 
     def handle(self, *args, **options):
+        """Handle the command."""
         check_incoming_log(fetch_all=True)

apostello/management/commands/import_outgoing_sms.py

@@ -13,4 +13,5 @@ class Command(BaseCommand):
     help = 'Import outgoing messages from twilio'
 
     def handle(self, *args, **options):
+        """Handle the command."""
         check_outgoing_log(fetch_all=True)

apostello/management/commands/setup_periodic_tasks.py

@@ -5,6 +5,7 @@
 
 
 def add_day_if_req(dt):
+    """Check to see if the time has passsed already and adds a day if so."""
     if dt > datetime.datetime.now():
         return dt
 
@@ -21,6 +22,7 @@ class Command(BaseCommand):
     help = 'Import incoming messages from twilio'
 
     def handle(self, *args, **options):
+        """Handle the command."""
         now = datetime.datetime.now()
         now = now.replace(minute=0, second=0)
         next_3am = add_day_if_req(now.replace(hour=3))

apostello/management/commands/update_sms_name_fields.py

@@ -11,5 +11,6 @@ class Command(BaseCommand):
     help = 'Update from_name fields'
 
     def handle(self, *args, **options):
+        """Handle the command."""
         for c in Recipient.objects.all():
             update_msgs_name(c.id)

apostello/models.py

@@ -50,6 +50,7 @@ def archive(self):
         self.save()
 
     def check_user_cost_limit(self, limit, msg):
+        """Check the user has not exceeded their per SMS cost limit."""
         num_sms = ceil(len(msg) / 160)
         if limit == 0:
             return
@@ -178,6 +179,7 @@ def archive(self):
 
     @staticmethod
     def check_user_cost_limit(recipients, limit, msg):
+        """Check the user has not exceeded their per SMS cost limit."""
         num_sms = ceil(len(msg) / 160)
         if limit == 0:
             return
@@ -662,6 +664,7 @@ class UserProfile(models.Model):
     can_archive = models.BooleanField(default=True)
 
     def get_absolute_url(self):
+        """Url for this user profile."""
         return reverse('user_profile_form', args=[str(self.pk)])
 
     def __str__(self):

apostello/signals.py

@@ -35,5 +35,5 @@ def email_admin_on_signup(request, user, **kwargs):
     body = body.format(str(user))
     from site_config.models import SiteConfiguration
     to_ = SiteConfiguration.get_solo().office_email
-    if len(to_) > 0:
+    if to_:
         send_async_mail("[apostello] New User", body, [to_], )

apostello/utils.py

@@ -53,6 +53,7 @@ def fetch_default_reply(msg=''):
 
 
 def retry_request(url, http_method, *args, **kwargs):
+    """Make a http request and retry 3 times if it fails."""
     assert http_method in ['get', 'post', 'delete', 'patch', 'put']
     MAX_TRIES = 3
     r_func = getattr(requests, http_method)

apostello/views.py

@@ -44,9 +44,11 @@ def get(self, request, *args, **kwargs):
 
 
 class NotApprovedView(TemplateView):
+    """Simple view that presents the not approved page."""
     template_name = 'apostello/not_approved.html'
 
     def get_context_data(self, **kwargs):
+        """Inject not approved message into context."""
         context = super(NotApprovedView, self).get_context_data(**kwargs)
         s = SiteConfiguration.get_solo()
         context['msg'] = s.not_approved_msg
@@ -342,6 +344,7 @@ class CreateAllGroupView(LoginRequiredMixin, ProfilePermsMixin, FormView):
     success_url = '/group/all/'
 
     def get_context_data(self, **kwargs):
+        """Inject intro and button text into context."""
         context = super(CreateAllGroupView, self).get_context_data(**kwargs)
         context['submit_text'] = 'Create'
         context['intro_text'] = 'You can use this form to create a new group' \

graphs/renderers.py

@@ -7,7 +7,7 @@
 )
 from graphs.sms_freq import sms_graph_data
 
-CleanStyleLargeText = CleanStyle(legend_font_size=30, tooltip_font_size=30, )
+clean_style_large_text = CleanStyle(legend_font_size=30, tooltip_font_size=30,)
 
 
 def recent():
@@ -38,7 +38,7 @@ def contacts():
     """Render pie chart for contacts."""
     pie_chart = pygal.Pie(
         inner_radius=.6,
-        style=CleanStyleLargeText,
+        style=clean_style_large_text,
         margin=0,
         value_formatter=lambda x: '{}'.format(x),
     )
@@ -59,7 +59,7 @@ def contacts():
 
 def groups():
     """Render tree map of group size."""
-    treemap = pygal.Treemap(style=CleanStyleLargeText, margin=0, )
+    treemap = pygal.Treemap(style=clean_style_large_text, margin=0, )
     for grp in RecipientGroup.objects.filter(is_archived=False):
         treemap.add(str(grp), [grp.recipient_set.all().count()])
 
@@ -70,7 +70,7 @@ def keywords():
     """Render pie chart for keywords."""
     pie_chart = pygal.Pie(
         inner_radius=.6,
-        style=CleanStyleLargeText,
+        style=clean_style_large_text,
         margin=0,
         value_formatter=lambda x: '{}'.format(x),
     )
@@ -86,7 +86,7 @@ def keywords():
 
 def incoming_by_contact():
     """Render tree map of incoming messages, grouped by user."""
-    treemap = pygal.Treemap(style=CleanStyleLargeText, margin=0, )
+    treemap = pygal.Treemap(style=clean_style_large_text, margin=0, )
     for con in Recipient.objects.filter(is_archived=False):
         treemap.add(
             str(con),
@@ -98,7 +98,7 @@ def incoming_by_contact():
 
 def outgoing_by_contact():
     """Render tree map of outgoing messages, grouped by user."""
-    treemap = pygal.Treemap(style=CleanStyleLargeText, margin=0, )
+    treemap = pygal.Treemap(style=clean_style_large_text, margin=0, )
     for con in Recipient.objects.filter(is_archived=False):
         treemap.add(
             str(con),
@@ -112,7 +112,7 @@ def sms_totals():
     """Render pie chart for sms totals."""
     pie_chart = pygal.Pie(
         inner_radius=.6,
-        style=CleanStyleLargeText,
+        style=clean_style_large_text,
         margin=0,
         value_formatter=lambda x: '{}'.format(x),
     )