Make alphabetical sort of records and fields optional (#25)

* Make alphabetical sort of records and fields optional

* Review comments

Author: coretl

docs/api.rst

@@ -33,7 +33,7 @@ Initialisation
 Record Output
 -------------
 
-..  function:: WriteRecords(filename, header=None)
+..  function:: WriteRecords(filename, header=None, alphabetical=True)
 
     This should be called after creating all records.  The generated records
     will be written out to the file `filename`.  If `header` is left unspecified
@@ -45,6 +45,10 @@ Record Output
 
     Note that the leading ``#`` comments are added to any header that is passed
 
+    If `alphabetical` then records, their fields and aliases will be sorted 
+    alphabetically, otherwise the records and aliases will be in insertion
+    order and fields in DBD order.
+
 ..  function:: Disclaimer(source=None, normalise_path=True)
 
     This function generates the disclaimer above.  If a source file name is

epicsdbbuilder/recordbase.py

@@ -4,6 +4,7 @@
 
 import string
 import json
+from collections import OrderedDict
 
 from . import recordnames
 from .recordset import recordset
@@ -112,8 +113,8 @@ def __init__(self, record, **fields):
 
         # These assignment have to be directly into the dictionary to
         # bypass the tricksy use of __setattr__.
-        self.__setattr('__fields', {})
-        self.__setattr('__aliases', set())
+        self.__setattr('__fields', OrderedDict())
+        self.__setattr('__aliases', OrderedDict())
         self.__setattr('__comments', [])
         self.__setattr('__infos', [])
         self.__setattr('name', recordnames.RecordName(record))
@@ -132,9 +133,8 @@ def __init__(self, record, **fields):
 
         recordset.PublishRecord(self.name, self)
 
-
     def add_alias(self, alias):
-        self.__aliases.add(alias)
+        self.__aliases[alias] = self
 
     def add_comment(self, comment):
         self.__comments.append('# ' + comment)
@@ -145,10 +145,18 @@ def add_metadata(self, metadata):
     def add_info(self, name, info):
         self.__infos.append((name, info))
 
+    def __dbd_order(self, fields):
+        field_set = set(fields)
+        for field_name in self._validate.dbEntry.iterate_fields():
+            if field_name in field_set:
+                yield field_name
+                field_set.remove(field_name)
+        assert not field_set, "DBD for %s doesn't contain %s" % (
+            self._type, sorted(field_set))
 
     # Call to generate database description of this record.  Outputs record
     # definition in .db file format.  Hooks for meta-data can go here.
-    def Print(self, output):
+    def Print(self, output, alphabetical=True):
         print(file = output)
         for comment in self.__comments:
             print(comment, file=output)
@@ -157,14 +165,16 @@ def Print(self, output):
         # Print the fields in alphabetical order.  This is more convenient
         # to the eye and has the useful side effect of bypassing a bug
         # where DTYPE needs to be specified before INP or OUT fields.
-        for k in sorted(self.__fields.keys()):
+        sort = sorted if alphabetical else self.__dbd_order
+        for k in sort(self.__fields.keys()):
             value = self.__fields[k]
             if getattr(value, 'ValidateLater', False):
                 self.__ValidateField(k, value)
             value = self.__FormatFieldForDb(k, value)
             padding = ''.ljust(4-len(k))  # To align field values
             print('    field(%s, %s%s)' % (k, padding, value), file = output)
-        for alias in sorted(list(self.__aliases)):
+        sort = sorted if alphabetical else list
+        for alias in sort(self.__aliases.keys()):
             print('    alias("%s")' % alias, file = output)
         for name, info in self.__infos:
             value = self.__FormatFieldForDb(name, info)

epicsdbbuilder/recordset.py

@@ -2,6 +2,7 @@
 
 from __future__ import print_function
 
+from collections import OrderedDict
 import os
 import time
 
@@ -12,7 +13,7 @@
 
 class RecordSet(object):
     def ResetRecords(self):
-        self.__RecordSet = {}
+        self.__RecordSet = OrderedDict()
         self.__HeaderLines = []
         self.__BodyLines = []
 
@@ -29,7 +30,7 @@ def LookupRecord(self, full_name):
         return self.__RecordSet[full_name]
 
     # Output complete set of records to the given file.
-    def Print(self, output):
+    def Print(self, output, alphabetical):
         for line in self.__HeaderLines:
             print(line, file = output)
         if self.__BodyLines:
@@ -38,8 +39,9 @@ def Print(self, output):
                 print(line, file = output)
         # Print the records in alphabetical order: gives the reader a fighting
         # chance to find their way around the generated database!
-        for record in sorted(self.__RecordSet.keys()):
-            self.__RecordSet[record].Print(output)
+        sort = sorted if alphabetical else list
+        for record in sort(self.__RecordSet):
+            self.__RecordSet[record].Print(output, alphabetical)
 
     # Returns the number of published records.
     def CountRecords(self):
@@ -78,12 +80,12 @@ def Disclaimer(source = None, normalise_source = True):
     return message
 
 
-def WriteRecords(filename, header = None):
+def WriteRecords(filename, header=None, alphabetical=True):
     if header is None:
         header = Disclaimer()
     header = header.split('\n')
     assert header[-1] == '', 'Terminate header with empty line'
     with open(filename, 'w') as output:
         for line in header[:-1]:
             print('#', line, file = output)
-        recordset.Print(output)
+        recordset.Print(output, alphabetical)

test/expected_output.db

@@ -1,117 +1,117 @@
-# This file was automatically generated on Mon 08 Nov 2021 09:23:43 GMT.
+# This file was automatically generated on Thu 25 Nov 2021 10:35:33 GMT.
 # 
 # *** Please do not edit this file: edit the source file instead. ***
 # 
 #% macro, DEVICE, Device name
 #% macro, P, A parameter
 #% macro, Q, A number
 
-record(bi, "$(DEVICE):BOO")
+record(longin, "XX-YY-ZZ-01:A")
 {
-    field(INP,  "XX-YY-ZZ-01:TRIG")
+    field(DESC, "blah")
 }
 
-record(waveform, "$(DEVICE):FIELD:WITH_CONST_ARRAY")
+record(ai, "XX-YY-ZZ-01:B")
 {
-    field(INP,  ["A","B","C"])
-    info(Q:group, {
-        "MYTABLE": {
-            "+id": "epics:nt/NTTable:1.0",
-            "labels": {
-                "+type": "plain",
-                "+channel": "VAL"
-            }
-        }
-    })
+    field(INP,  "SR-DI-DCCT-01:SIGNAL")
 }
 
-record(ai, "$(DEVICE):FIELD:WITH_JSON_LINK")
+record(fanout, "XX-YY-ZZ-01:FAN")
 {
-    field(INP,  {
-        "const": 3.14159265358979
-    })
-    info(asyn:READBACK, "1")
-    info(autosaveFields, "PREC EGU DESC")
+    field(SELM, "All")
+    field(LNK1, "XX-YY-ZZ-01:A")
+    field(LNK2, "XX-YY-ZZ-01:B")
 }
 
-record(ai, "$(DEVICE):OPTIONS:CA")
+record(bi, "XX-YY-ZZ-01:TRIG")
 {
-    field(INP,  "$(DEVICE):TEST CA")
+    field(SCAN, "1 second")
+    field(FLNK, "XX-YY-ZZ-01:FAN")
 }
 
-record(ai, "$(DEVICE):OPTIONS:CP")
+# comment 1
+#% metadata
+# comment 2
+record(ai, "XX-YY-ZZ-01:ABC:TEST")
 {
-    field(INP,  "$(DEVICE):TEST CP")
 }
 
-record(ai, "$(DEVICE):OPTIONS:CPP")
+record(ai, "$(DEVICE):TEST")
 {
-    field(INP,  "$(DEVICE):TEST CPP")
+    field(SCAN, "1 second")
+    field(VAL,  "$(Q)")
+    field(INP,  "@$(P)")
 }
 
-record(ai, "$(DEVICE):OPTIONS:MSI")
+record(bi, "$(DEVICE):BOO")
 {
-    field(INP,  "$(DEVICE):TEST MSI")
+    field(INP,  "XX-YY-ZZ-01:TRIG")
 }
 
-record(ai, "$(DEVICE):OPTIONS:MSS")
+record(ai, "$(DEVICE):OPTIONS:CA")
 {
-    field(INP,  "$(DEVICE):TEST MSS")
+    field(INP,  "$(DEVICE):TEST CA")
 }
 
-record(ai, "$(DEVICE):OPTIONS:NMS")
+record(ai, "$(DEVICE):OPTIONS:CP")
 {
-    field(INP,  "$(DEVICE):TEST NMS")
+    field(INP,  "$(DEVICE):TEST CP")
 }
 
-record(ai, "$(DEVICE):OPTIONS:NP")
+record(ai, "$(DEVICE):OPTIONS:CPP")
 {
-    field(INP,  "$(DEVICE):TEST NPP")
+    field(INP,  "$(DEVICE):TEST CPP")
 }
 
-record(ai, "$(DEVICE):OPTIONS:PP:MS")
+record(ai, "$(DEVICE):OPTIONS:NP")
 {
-    field(INP,  "$(DEVICE):TEST MS PP")
+    field(INP,  "$(DEVICE):TEST NPP")
 }
 
-record(stringin, "$(DEVICE):STRING")
+record(ai, "$(DEVICE):OPTIONS:MSS")
 {
-    field(VAL,  "\"\x0a\\\x01€")
+    field(INP,  "$(DEVICE):TEST MSS")
 }
 
-record(ai, "$(DEVICE):TEST")
+record(ai, "$(DEVICE):OPTIONS:MSI")
 {
-    field(INP,  "@$(P)")
-    field(SCAN, "1 second")
-    field(VAL,  "$(Q)")
+    field(INP,  "$(DEVICE):TEST MSI")
 }
 
-record(longin, "XX-YY-ZZ-01:A")
+record(ai, "$(DEVICE):OPTIONS:NMS")
 {
-    field(DESC, "blah")
+    field(INP,  "$(DEVICE):TEST NMS")
 }
 
-# comment 1
-#% metadata
-# comment 2
-record(ai, "XX-YY-ZZ-01:ABC:TEST")
+record(ai, "$(DEVICE):OPTIONS:PP:MS")
 {
+    field(INP,  "$(DEVICE):TEST MS PP")
 }
 
-record(ai, "XX-YY-ZZ-01:B")
+record(waveform, "$(DEVICE):FIELD:WITH_CONST_ARRAY")
 {
-    field(INP,  "SR-DI-DCCT-01:SIGNAL")
+    field(INP,  ["A","B","C"])
+    info(Q:group, {
+        "MYTABLE": {
+            "+id": "epics:nt/NTTable:1.0",
+            "labels": {
+                "+type": "plain",
+                "+channel": "VAL"
+            }
+        }
+    })
 }
 
-record(fanout, "XX-YY-ZZ-01:FAN")
+record(ai, "$(DEVICE):FIELD:WITH_JSON_LINK")
 {
-    field(LNK1, "XX-YY-ZZ-01:A")
-    field(LNK2, "XX-YY-ZZ-01:B")
-    field(SELM, "All")
+    field(INP,  {
+        "const": 3.14159265358979
+    })
+    info(asyn:READBACK, "1")
+    info(autosaveFields, "PREC EGU DESC")
 }
 
-record(bi, "XX-YY-ZZ-01:TRIG")
+record(stringin, "$(DEVICE):STRING")
 {
-    field(FLNK, "XX-YY-ZZ-01:FAN")
-    field(SCAN, "1 second")
+    field(VAL,  "\"\x0a\\\x01€")
 }