From 3a8377272faba027008ffa2a4c86c534810af432 Mon Sep 17 00:00:00 2001
From: Tanner Prestegard <tanner.prestegard@ligo.org>
Date: Thu, 31 May 2018 11:16:13 -0500
Subject: [PATCH] Adding comments
---
gracedb/superevents/utils.py | 6 ++++++
gracedb/superevents/views.py | 4 ++++
2 files changed, 10 insertions(+)
diff --git a/gracedb/superevents/utils.py b/gracedb/superevents/utils.py
index 0bff8ca16..36152d4a1 100644
--- a/gracedb/superevents/utils.py
+++ b/gracedb/superevents/utils.py
@@ -10,6 +10,9 @@ import os
import logging
logger = logging.getLogger(__name__)
+# NOTE: everything in here assumes that permissions have already been checked
+# and handled properly
+
# TODO:
# Add decorator to check access permissions (??) not sure if we should do it here or in the viewset itself
def create_superevent(submitter, t_start, t_0, t_end, preferred_event,
@@ -364,6 +367,8 @@ def get_or_create_tag(tag_name, display_name=None):
def get_or_create_tags(tag_name_list, display_name_list=[]):
+
+ # TODO: make this a useful error
if display_name_list and (len(display_name_list) != len(tag_name_list)):
raise ValueError('')
@@ -379,6 +384,7 @@ def get_or_create_tags(tag_name_list, display_name_list=[]):
# TODO: add permissions checking?
+# TODO: move this somewhere else?
def get_superevent_by_date_id_or_404(request, superevent_id):
filter_kwargs = Superevent.get_filter_kwargs_for_date_id_lookup(
diff --git a/gracedb/superevents/views.py b/gracedb/superevents/views.py
index e17279893..aaf0ec27a 100644
--- a/gracedb/superevents/views.py
+++ b/gracedb/superevents/views.py
@@ -21,6 +21,9 @@ logger = logging.getLogger(__name__)
# Need to restrict ability to view
def webview(request, superevent_id):
+ # TODO: any special web displays for template for confirmed GWs?
+ # can do this in template by checking superevent.is_gw
+
# Get superevent object
superevent = get_superevent_by_date_id_or_404(request, superevent_id)
@@ -186,6 +189,7 @@ def file_list(request, superevent_id):
}
return render(request, 'superevents/file_list.html', context=context)
+
# TODO:
# add permission checking
def file_download(request, superevent_id, filename):
--
GitLab