Rename prefixes model to Prefix

Changes to be committed:
	modified:   api/admin.py
	modified:   api/groups.py
	new file:   api/migrations/0005_rename_prefixes_prefix.py
	modified:   api/models.py
	modified:   api/scripts/method_specific/POST_api_prefixes_create.py
	modified:   api/scripts/method_specific/POST_api_prefixes_delete.py
	modified:   api/scripts/method_specific/POST_api_prefixes_modify.py
	modified:   api/scripts/method_specific/POST_api_prefixes_permissions_set.py
	modified:   api/scripts/utilities/UserUtils.py

Author: HadleyKing

bco_api/api/admin.py

@@ -1,29 +1,13 @@
-from django.contrib import admin
-
-# Object-level permissions.
-# Source: https://github.com/django-guardian/django-guardian#admin-integration
-from guardian.admin import GuardedModelAdmin
-
-from .models import bco, prefix_table, new_users, prefixes
+"""Django Admin
 
-class BcoDraftAdmin(
-    GuardedModelAdmin
-):
-    pass
+Registers models for the Django Admin app
+"""
 
-admin.site.register(
-    bco,
-    BcoDraftAdmin
-)
-
-admin.site.register(
-    prefix_table
-)
-
-admin.site.register(
-    new_users
-)
+from django.contrib import admin
+from guardian.admin import GuardedModelAdmin
+from api.models import bco, prefix_table, new_users, Prefix
 
-admin.site.register(
-    prefixes
-)
+admin.site.register(bco, GuardedModelAdmin)
+admin.site.register(prefix_table)
+admin.site.register(new_users)
+admin.site.register(Prefix)

bco_api/api/groups.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 """Functions for operations with groups
 """
+
 from django.db import models
 import django.db.utils as PermErrors
 from django.db.models.signals import post_save, post_delete, pre_delete
@@ -11,7 +12,6 @@
 from django.utils import timezone
 from guardian.shortcuts import assign_perm
 from rest_framework import status
-from rest_framework.authtoken.models import Token
 from rest_framework.response import Response
 
 from api.scripts.utilities import DbUtils
@@ -26,23 +26,11 @@ class GroupInfo(models.Model):
     """
 
     delete_members_on_group_deletion = models.BooleanField(default=False)
-
-    # The group
     group = models.OneToOneField(Group, on_delete=models.CASCADE)
-    # Delete group members on group deletion?
-    delete_members_on_group_deletion = models.BooleanField(default=False)
-    # Description of the group
     description = models.TextField(blank = True)
-    # Expiration date
     expiration = models.DateTimeField(blank=True, null=True)
-
-    # The group
     group = models.ForeignKey(Group, on_delete=models.CASCADE, to_field='name')
-
-    # Size limit for the number of members
     max_n_members = models.IntegerField(blank=True, null=True)
-
-    # Which user owns it?
     owner_user = models.ForeignKey(User, on_delete=models.CASCADE, to_field='username')
 
 # --- Group --- #

bco_api/api/migrations/0005_rename_prefixes_prefix.py

@@ -0,0 +1,20 @@
+# Generated by Django 3.2.10 on 2022-03-22 18:29
+
+from django.conf import settings
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('auth', '0012_alter_user_first_name_max_length'),
+        ('api', '0004_rename_group_info_groupinfo'),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name='prefixes',
+            new_name='Prefix',
+        ),
+    ]

bco_api/api/models.py

@@ -114,13 +114,13 @@ class new_users(models.Model):
     created = models.DateTimeField(default=timezone.now)
 
 
-# Link prefixes to groups and users.
+# Link Prefix to groups and users.
 
 # Be careful about related_name.
 # Source: https://stackoverflow.com/questions/53651114/using-same-foreign-key-twice-in-a-model-in-django-as-different-fields
-class prefixes(models.Model):
-    
-    # Which server is this prefix certified with?
+class Prefix(models.Model):
+    """Which server is this prefix certified with?"""
+
     certifying_server = models.TextField(blank = True, null = True)
 
     # What is the certifying key?
@@ -162,7 +162,7 @@ class prefixes(models.Model):
 
     def __str__(self):
         """String for representing the BCO model (in Admin site etc.)."""
-        return self.prefix
+        return "{}".format(self.prefix)
 
 # def get_first_name(self):
 #     return self.first_name
@@ -224,7 +224,7 @@ def create_auth_token(sender, instance=None, created=False, **kwargs):
             Token.objects.create(user=instance)
 
 # --- Prefix --- #
-@receiver(post_save, sender=prefixes)
+@receiver(post_save, sender=Prefix)
 def create_permissions_for_prefix(sender, instance=None, created=False, **kwargs):
     """Link prefix creation to permissions creation.
         Check to see whether or not the permissions
@@ -286,7 +286,7 @@ def create_permissions_for_prefix(sender, instance=None, created=False, **kwargs
             pass
 
 
-@receiver(post_delete, sender=prefixes)
+@receiver(post_delete, sender=Prefix)
 def delete_permissions_for_prefix(sender, instance=None, **kwargs):
     """Link prefix deletion to permissions deletion.
     No risk of raising an error when using

bco_api/api/scripts/method_specific/POST_api_prefixes_create.py

@@ -10,7 +10,7 @@
 
 from api.scripts.utilities import DbUtils
 from api.scripts.utilities import UserUtils
-from api.models import prefixes
+from api.models import Prefix
 
 from rest_framework import status
 from rest_framework.response import Response
@@ -46,7 +46,7 @@ def POST_api_prefixes_create(request):
 
     # Get all existing prefixes.
     available_prefixes = list(
-        prefixes.objects.all().values_list('prefix', flat = True))
+        Prefix.objects.all().values_list('prefix', flat = True))
 
     # Construct an array to return information about processing
     # the request.
@@ -118,7 +118,7 @@ def POST_api_prefixes_create(request):
                 # The prefix has not been created, so create it.                
                 DbUtils.DbUtils().write_object(
                     p_app_label = 'api',
-                    p_model_name = 'prefixes',
+                    p_model_name = 'Prefix',
                     p_fields = ['created_by', 'description', 'owner_group', 'owner_user', 'prefix'],
                     p_data = {
                         'created_by': user_utils.user_from_request(

bco_api/api/scripts/method_specific/POST_api_prefixes_delete.py

@@ -8,7 +8,7 @@
 objects.
 """
 from api.scripts.utilities import DbUtils
-from api.models import prefixes
+from api.models import Prefix
 from rest_framework import status
 from rest_framework.response import Response
 
@@ -33,7 +33,7 @@ def POST_api_prefixes_delete(request):
 
     # Get all existing prefixes.
     available_prefixes = list(
-            prefixes.objects.all().values_list('prefix', flat=True))
+            Prefix.objects.all().values_list('prefix', flat=True))
 
     returning = []
 
@@ -60,7 +60,7 @@ def POST_api_prefixes_delete(request):
             # just delete straight up.
             # Source: https://stackoverflow.com/a/3681691
             # Django *DOESN'T* want primary keys now...
-            prefixed = prefixes.objects.get(prefix=standardized)
+            prefixed = Prefix.objects.get(prefix=standardized)
             prefixed.delete()
             # Deleted the prefix.
             errors['200_OK_prefix_delete'] = db_utils.messages(parameters={

bco_api/api/scripts/method_specific/POST_api_prefixes_modify.py

@@ -7,7 +7,7 @@
 """
 from api.scripts.utilities import DbUtils
 from api.scripts.utilities import UserUtils
-from api.models import prefixes
+from api.models import Prefix
 from rest_framework import status
 from rest_framework.response import Response
 
@@ -34,7 +34,7 @@ def POST_api_prefixes_modify(request):
 
     bulk_request = request.data['POST_api_prefixes_modify']
     available_prefixes = list(
-        prefixes.objects.all().values_list('prefix', flat = True))
+        Prefix.objects.all().values_list('prefix', flat = True))
 
     # Construct an array to return information about processing
     # the request.
@@ -112,7 +112,7 @@ def POST_api_prefixes_modify(request):
                 # The prefix has not been created, so create it.			
                 DbUtils.DbUtils().write_object(
                     p_app_label = 'api',
-                    p_model_name = 'prefixes',
+                    p_model_name = 'Prefix',
                     p_fields = ['created_by', 'description', 'owner_group', 'owner_user', 'prefix'],
                     p_data = {
                         'created_by': user_utils.user_from_request(

bco_api/api/scripts/method_specific/POST_api_prefixes_permissions_set.py

@@ -1,5 +1,5 @@
 # Prefixes
-from ...models import prefixes
+from api.models import Prefix
 
 # DB utilities
 from ..utilities import DbUtils
@@ -37,7 +37,7 @@ def POST_api_prefixes_permissions_set(
 
 	# Get all existing prefixes.
 	available_prefixes = list(
-		prefixes.objects.all().values_list(
+		Prefix.objects.all().values_list(
 				'prefix', 
 				flat = True
 		)

bco_api/api/scripts/utilities/UserUtils.py

@@ -1,5 +1,5 @@
-# Prefixes
-from ...models import prefixes
+# Prefix
+from api.models import Prefix
 
 # For returning server information.
 from django.conf import settings
@@ -102,7 +102,7 @@ def check_user_owns_prefix(
         ):
 
         # Check if a user owns a prefix.
-        return prefixes.objects.filter(owner_user=un, prefix=prfx).exists()
+        return Prefix.objects.filter(owner_user=un, prefix=prfx).exists()
 
     def get_user_groups_by_token(
             self,
@@ -253,7 +253,7 @@ def get_user_info(
                 'other_info'             : other_info
                 }
 
-    # Prefixes for a given user.
+    # Prefix for a given user.
     def prefixes_for_user(
             self,
             user_object
@@ -285,7 +285,7 @@ def prefix_perms_for_user(self, user_object, flatten=True, specific_permission=N
 
         # Get the prefixes for the user and their groups, then filter.
         # pxs = list(
-        #         prefixes.objects.filter(
+        #         Prefix.objects.filter(
         #         Q(owner_user = user_object.id) |
         #         Q(owner_group__in = list(user_object.groups.all().values_list(
         #             'id',