- issue2551103 - add pragma 'display_protected' to roundup-admin.

If setting is true, print protected attributes like id, activity,
actor...  when using display or specification subcommands.

Author: rouilj

CHANGES.txt

@@ -12,6 +12,16 @@ v2.7.2 or later are required to run newer releases of Roundup.
 Roundup 2.0 supports Python 3.4 and later. Roundup 2.1.0 supports
 python 3.6 or newer (3.4/3.5 might work, but they are not tested).
 
+2024-XX-YY 2.4.0
+
+Fixed:
+
+Features:
+
+- issue2551103 - add pragma 'display_protected' to roundup-admin. If
+  true, print protected attributes like id, activity, actor...
+  when using display or specification subcommands. (John Rouillard)
+
 2023-07-13 2.3.0
 
 Fixed:

roundup/admin.py

@@ -114,7 +114,8 @@ def __init__(self):
         }
         self.settings_help = {
             'display_protected':
-            _("Have 'display designator' show protected fields: creator. NYI"),
+            _("Have 'display designator' show protected fields: "
+              "creator, id etc."),
 
             'indexer_backend':
             _("Set indexer to use when running 'reindex' NYI"),
@@ -522,10 +523,18 @@ def do_display(self, args):
             cl = self.get_class(classname)
 
             # display the values
-            keys = sorted(cl.properties)
+            normal_props = sorted(cl.properties)
+            if self.settings['display_protected']:
+                keys = sorted(cl.getprops())
+            else:
+                keys = normal_props
+
             for key in keys:
                 value = cl.get(nodeid, key)
-                print(_('%(key)s: %(value)s') % locals())
+                # prepend * for protected propeties else just indent
+                # with space.
+                protected = "*" if key not in normal_props else ' '
+                print(_('%(protected)s%(key)s: %(value)s') % locals())
 
     def do_export(self, args, export_files=True):
         ''"""Usage: export [[-]class[,class]] export_dir
@@ -1479,6 +1488,19 @@ def do_pragma(self, args):
          will show all settings and their current values. If verbose
          is enabled hidden settings and descriptions will be shown.
         """
+        """
+          The following are to be implemented:
+
+           indexer - Not Implemented - set indexer to use for
+                     reindex.  Use when changing indexer backends.
+
+           exportfiles={true|false} - Not Implemented - If true
+                    (default) export/import db tables and files. If
+                    False, export/import just database tables, not
+                    files. Use for faster database migration.
+                    Replaces exporttables/importtables with
+                    exportfiles=false then export/import
+        """
 
         if len(args) < 1:
             raise UsageError(_('Not enough arguments supplied'))
@@ -1798,8 +1820,12 @@ def do_specification(self, args):
 
         # get the key property
         keyprop = cl.getkey()
-        for key in cl.properties:
-            value = cl.properties[key]
+        if self.settings['display_protected']:
+            properties = cl.getprops()
+        else:
+            properties = cl.properties
+        for key in properties:
+            value = properties[key]
             if keyprop == key:
                 sys.stdout.write(_('%(key)s: %(value)s (key property)\n') %
                                  locals())

test/test_admin.py

@@ -1032,6 +1032,26 @@ def testPragma(self):
         expected = 'Error: Internal error: pragma can not handle values of type: float'
         self.assertIn(expected, out)
 
+
+        # -----
+        inputs = iter(["pragma display_protected=yes",
+                       "display user1",
+                       "quit"])
+        AdminTool.my_input = lambda _self, _prompt: next(inputs)
+
+        self.install_init()
+        self.admin=AdminTool()
+        sys.argv=['main', '-i', self.dirname]
+
+        with captured_output() as (out, err):
+            ret = self.admin.main()
+
+        out = out.getvalue().strip()
+        
+        print(ret)
+        expected = '\n*creation: '
+        self.assertIn(expected, out)
+
         # -----
         AdminTool.my_input = orig_input
 
@@ -1479,6 +1499,7 @@ def testSpecification(self):
                 'timezone: <roundup.hyperdb.String>',
                 'password: <roundup.hyperdb.Password>',
             ]
+
 
         with captured_output() as (out, err):
             sys.argv=['main', '-i', self.dirname, 'specification', 'user']
@@ -1488,6 +1509,28 @@ def testSpecification(self):
         print(outlist)
         self.assertEqual(sorted(outlist), sorted(spec))
 
+        # -----
+        inputs = iter(["pragma display_protected=1", "spec user", "quit"])
+        AdminTool.my_input = lambda _self, _prompt: next(inputs)
+
+        self.install_init()
+        self.admin=AdminTool()
+        sys.argv=['main', '-i', self.dirname]
+
+        with captured_output() as (out, err):
+            ret = self.admin.main()
+
+        # strip greeting and help text lines
+        outlist = out.getvalue().strip().split('\n')[2:]
+        
+        protected = [ 'id: <roundup.hyperdb.String>',
+                      'creation: <roundup.hyperdb.Date>',
+                      'activity: <roundup.hyperdb.Date>',
+                      'creator: <roundup.hyperdb.Link to "user">',
+                      'actor: <roundup.hyperdb.Link to "user">']
+        print(outlist)
+        self.assertEqual(sorted(outlist), sorted(spec + protected))
+
     def testRetireRestore(self):
         ''' Note the tests will fail if you run this under pdb.
             the context managers capture the pdb prompts and this screws