Changeset 1494:ae76ea63ee12 in freeDiameter

Timestamp:

Mar 30, 2020, 2:46:31 PM (4 years ago)

Author:

Luke Mewburn <luke@mewburn.net>

Branch:

default

Phase:

public

Message:

csv_to_fd: improve comments and usage

File:

• contrib/tools/csv_to_fd (modified) (10 diffs)

contrib/tools/csv_to_fd

@@ -11 +11 @@
         AVP Name. String, validated as ALPHA *(ALPHA / DIGIT / "-")
         per RFC 6733 section 3.2.
+        May start with a DIGIT (e.g., "3GPP-IMSI").
     - Code:
         AVP Code. Integer, 0..4294967295.
@@ -21 +22 @@
             - RFC 7155 section 4.1
     - Must, May, ShouldNot, MustNot:
-        Flags, possibly comma or space separated: M, V
+        Flags, possibly comma or space separated: M, P, V
 
 - Comment row. First cell:
@@ -183 +184 @@
 
 class Processor(object):
-    """Interface for processor of Avp"""
+    """Interface for processor of Avp."""
 
     __metaclass__ = abc.ABCMeta
@@ -227 +228 @@
 
 class DebugProcessor(Processor):
-    """Display the CSV parsing"""
+    """Display the CSV parsing."""
 
     def next_file(self, filename):
@@ -244 +245 @@
 
 class NoopProcessor(Processor):
-    """Validate the CSV; no other output"""
+    """Validate the CSV; no other output."""
 
     def next_file(self, filename):
@@ -260 +261 @@
 
 class FdcProcessor(Processor):
-    """Generate freeDiameter C code
+    """Generate freeDiameter C code.
 
     Comment cells are parsed as:
@@ -375 +376 @@
 
 class JsonProcessor(Processor):
-    """Generate freeDiameter JSON object
+    """Generate freeDiameter JSON object.
     """
 
@@ -461 +462 @@
     # Parse options
     parser = MyParser(
+        usage='%prog [-h] [-p PROCESSOR] FILE ...',
         description="""\
-Convert CSV files containing RADIUS or Diameter AVP tables
+Convert CSV files FILE ... containing RADIUS or Diameter AVP tables
 into various formats using the specified processor PROCESSOR.
 """)
@@ -473 +475 @@
     (opts, args) = parser.parse_args()
     if len(args) < 1:
-        parser.error('Incorrect number of arguments')
+        parser.error('Incorrect number of arguments. Use -h for help.')
 
     # Find processor
@@ -479 +481 @@
         avpproc = processors[opts.processor]()
     except KeyError as e:
-        parser.error('Unknown processor "{}"'.format(opts.processor))
+        parser.error('Unknown processor "{}".'.format(opts.processor))
 
     # dict of [vendor][code] : Avp