Superevents

Adding superevents to GraceDB, including the necessary models, utility functions, and API resources. This has also resulted in changes to the overall configuration and some parts of the events model.

Many models in the events app, like Labels, Tags, EventLogs, etc. were needed in a similar form for superevents. We were able to completely reuse the existing Label and Tag models for superevents. In other cases, we had to abstract the main functionality of the class into an abstract base class and then implement separate models for events and superevents, due to foreign key requirements. This should leave the current functionality of the events models unchanged.

Some portions of the events API have been modified because of one of the following reasons:

• It didn't make sense and was unnecessarily difficult to duplicate for superevents
• It was inefficient or bad

These changes are documented here: https://bugs.ligo.org/redmine/issues/6133

gracedb/core/utils.py

+from django.utils.six import string_types
+
 import string
 
+import logging
+logger = logging.getLogger(__name__)
+
 # Get lowercase alphabet as string
 ALPHABET = string.ascii_lowercase
 BASE = len(ALPHABET)
+ASCII_ALPHABET_START = ord('a') - 1
 
 def int_to_letters(num, positive_only=True):
     """
-
     Enumeration starts at 1 (i.e., 1 => 'a')
     """
 
     # Argument checking
-    if not isinstance(num, int):
-        raise TypeError("Input 'num' is not an int")
+    if not isinstance(num, (int, long)):
+        # Coerce to int
+        logger.warning('Coercing argument of type {0} to int'.format(
+            type(num)))
+        num = int(num)
     if (positive_only and num <= 0):
         raise ValueError(("Input 'num' is non-positive, but the positive_only "
             "flag is set"))
 
     out_str = ''
-    while (num > BASE):
-        r = num % BASE
-        num /= BASE
-        out_str = ALPHABET[r-1] + out_str
-    out_str = ALPHABET[num-1] + out_str
+    while num:
+        num, remainder = divmod(num - 1, BASE)
+        out_str = chr(ASCII_ALPHABET_START + 1 + remainder) + out_str
     return out_str
 
+
 def letters_to_int(letters):
     # TODO: remove assert statement!
-    assert isinstance(letters, str), "letters is not a string"
+    assert isinstance(letters, string_types), "letters is not a string"
 
+    # Convert to lowercase
     letters = letters.lower()
-    pass
+
+    num = sum([(BASE**i)*(ord(l)-ASCII_ALPHABET_START) for i,l in
+        enumerate(letters[::-1])])
+
+    return num