Linting and docs for prefix token functions

Changes to be committed:
	modified:   bco_api/api/scripts/method_specific/POST_api_prefixes_create.py
	modified:   bco_api/api/scripts/method_specific/POST_api_prefixes_token.py
	modified:   bco_api/api/scripts/method_specific/POST_api_prefixes_token_flat.py
	modified:   bco_api/api/views.py

Author: HadleyKing

bco_api/api/scripts/method_specific/POST_api_prefixes_create.py

@@ -31,7 +31,6 @@ def POST_api_prefixes_create(request):
     rest_framework.response.Response
         An HttpResponse that allows its data to be rendered into
         arbitrary media types.
-
     """
 
     # TODO: replace user/group looping with basic filtering

bco_api/api/scripts/method_specific/POST_api_prefixes_token.py

@@ -1,36 +1,35 @@
-# User utilities
-from ..utilities import UserUtils
-
-# Responses
-from rest_framework import status
-from rest_framework.response import Response
-
-
+#!/usr/bin/env python3
+"""Get Prefixes for a Token
 
+Get all available prefixes and their associated permissions for a given token.
+The word 'Token' must be included in the header.
+The token has already been validated,
+so the user is guaranteed to exist.
 
-def POST_api_prefixes_token(
-	request
-):
-
-	# Instantiate any necessary imports.
-	uu = UserUtils.UserUtils()
-	
-	# The token has already been validated,
-	# so the user is guaranteed to exist.
-
-	# A little expensive, but use the utility
-	# we already have. Default will return flattened list of permissions 
-	prefixes = uu.prefix_perms_for_user(
-		user_object = uu.user_from_request(
-			rq = request
-		).username,
-        flatten = False
-	)
+A little expensive, but use the utility
+we already have. Default will return flattened list of permissions.
+"""
 
+from api.scripts.utilities import UserUtils
+from rest_framework import status
+from rest_framework.response import Response
 
-	return(
-		Response(
-			status = status.HTTP_200_OK,
-			data = prefixes
-		)
-	)
+def POST_api_prefixes_token(request):
+    """Get Prefixes for a Token
+
+    Parameters
+    ----------
+    request: rest_framework.request.Request
+            Django request object.
+
+    Returns
+    -------
+    rest_framework.response.Response
+        An HttpResponse that allows its data to be rendered into
+        arbitrary media types.
+    """
+
+    prefixes = UserUtils.UserUtils().prefix_perms_for_user(
+        user_object = UserUtils.UserUtils().user_from_request(
+            request = request).username, flatten = False)
+    return Response(status = status.HTTP_200_OK, data = prefixes)

bco_api/api/scripts/method_specific/POST_api_prefixes_token_flat.py

@@ -1,38 +1,34 @@
-# User utilities
-from ..utilities import UserUtils
+#!/usr/bin/env python3
+"""Get Prefixes for a Token, flat list
 
-# Responses
+Get all available prefixes and their associated permissions for a given token.
+The word 'Token' must be included in the header. The token has already been
+validated, so the user is guaranteed to exist.
+
+A little expensive, but use the utility we already have. Default will return
+flattened list of permissions.
+"""
+from api.scripts.utilities import UserUtils
 from rest_framework import status
 from rest_framework.response import Response
 
+def POST_api_prefixes_token_flat(request):
+    """Get Prefixes for a Token
 
+    Parameters
+    ----------
+    request: rest_framework.request.Request
+            Django request object.
 
+    Returns
+    -------
+    rest_framework.response.Response
+        An HttpResponse that allows its data to be rendered into
+        arbitrary media types.
+    """
 
-def POST_api_prefixes_token_flat(
-	request
-):
-
-	# Instantiate any necessary imports.
-	uu = UserUtils.UserUtils()
-	
-	# The token has already been validated,
-	# so the user is guaranteed to exist.
-
-	# A little expensive, but use the utility
-	# we already have. Default will return flattened list of permissions 
-	prefixes = uu.prefix_perms_for_user(
-		user_object = uu.user_from_request(
-			rq = request
-		).username,
-        flatten = True
-	)
-
-	# We only need the permissions that are specific
-	# to the bco model.
+    prefixes = UserUtils.UserUtils().prefix_perms_for_user(
+        user_object = UserUtils.UserUtils().user_from_request(
+            request = request).username,flatten = True)
 
-	return(
-		Response(
-			status = status.HTTP_200_OK,
-			data = prefixes
-		)
-	)
+    return Response(status = status.HTTP_200_OK, data = prefixes)

bco_api/api/views.py

@@ -1166,12 +1166,11 @@ def post(self, request) -> Response:
 
 class ApiPrefixesToken(APIView):
     """
-    Get Prefixes for a Token
+    Get list of prefixes
 
     --------------------
 
-    # Get all available prefixes and their associated permissions for a given token.
-
+    Get all available prefixes and their associated permissions for a given token.
     The word 'Token' must be included in the header.
 
     For example: 'Token 627626823549f787c3ec763ff687169206626149'.
@@ -1194,16 +1193,12 @@ def post(self, request) -> Response:
 
 class ApiPrefixesTokenFlat(APIView):
     """
-    Get Prefixes for a Token in Flat Format
+    Get a flat list of prefixes
 
     --------------------
 
-    # Get all available prefixes and their associated permissions for a given token in flat format.
-
-    # TODO: What does this do?  Appears to flatten the prefixes (not sure what for)
-    # Answer (Chris, 1/22):  These may be easier for a requestor to parse rapidly on a web page.
-
-    The word 'Token' must be included in the header.
+    Get all available prefixes and their associated permissions for a given
+    token in flat format. The word 'Token' must be included in the header.
 
     For example: 'Token 627626823549f787c3ec763ff687169206626149'.
     """