Remove items from PY2; comments on behavior of items and iteritems

Author: amysutedja

splunklib/searchcommands/eventing_command.py

@@ -16,6 +16,7 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 
+from splunklib import six
 from splunklib.six.moves import map as imap
 
 from .decorators import ConfigurationSetting
@@ -135,10 +136,14 @@ def fix_up(cls, command):
                 raise AttributeError('No EventingCommand.transform override')
             SearchCommand.ConfigurationSettings.fix_up(command)
 
+        # TODO: Stop looking like a dictionary because we don't obey the semantics
+        # N.B.: Does not use Python 2 dict copy semantics
         def iteritems(self):
             iteritems = SearchCommand.ConfigurationSettings.iteritems(self)
             return imap(lambda name_value: (name_value[0], 'events' if name_value[0] == 'type' else name_value[1]), iteritems)
 
-        items = iteritems
+        # N.B.: Does not use Python 3 dict view semantics
+        if not six.PY2:
+            items = iteritems
 
         # endregion

splunklib/searchcommands/generating_command.py

@@ -19,6 +19,7 @@
 from .decorators import ConfigurationSetting
 from .search_command import SearchCommand
 
+from splunklib import six
 from splunklib.six.moves import map as imap, filter as ifilter
 
 # P1 [O] TODO: Discuss generates_timeorder in the class-level documentation for GeneratingCommand
@@ -324,6 +325,8 @@ def fix_up(cls, command):
             if command.generate == GeneratingCommand.generate:
                 raise AttributeError('No GeneratingCommand.generate override')
 
+        # TODO: Stop looking like a dictionary because we don't obey the semantics
+        # N.B.: Does not use Python 2 dict copy semantics
         def iteritems(self):
             iteritems = SearchCommand.ConfigurationSettings.iteritems(self)
             version = self.command.protocol_version
@@ -334,7 +337,9 @@ def iteritems(self):
                         lambda name_value: (name_value[0], 'stateful') if name_value[0] == 'type' else (name_value[0], name_value[1]), iteritems)
             return iteritems
 
-        items = iteritems
+        # N.B.: Does not use Python 3 dict view semantics
+        if not six.PY2:
+            items = iteritems
 
         pass
         # endregion

splunklib/searchcommands/search_command.py

@@ -1036,6 +1036,8 @@ def fix_up(cls, command_class):
             """
             return
 
+        # TODO: Stop looking like a dictionary because we don't obey the semantics
+        # N.B.: Does not use Python 2 dict copy semantics
         def iteritems(self):
             definitions = type(self).configuration_setting_definitions
             version = self.command.protocol_version
@@ -1044,7 +1046,9 @@ def iteritems(self):
                     lambda setting: (setting.name, setting.__get__(self)), ifilter(
                         lambda setting: setting.is_supported_by_protocol(version), definitions)))
 
-        items = iteritems
+        # N.B.: Does not use Python 3 dict view semantics
+        if not six.PY2:
+            items = iteritems
 
         pass  # endregion
 

splunklib/searchcommands/streaming_command.py

@@ -16,6 +16,7 @@
 
 from __future__ import absolute_import, division, print_function, unicode_literals
 
+from splunklib import six
 from splunklib.six.moves import map as imap, filter as ifilter
 
 from .decorators import ConfigurationSetting
@@ -172,6 +173,8 @@ def fix_up(cls, command):
                 raise AttributeError('No StreamingCommand.stream override')
             return
 
+        # TODO: Stop looking like a dictionary because we don't obey the semantics
+        # N.B.: Does not use Python 2 dict copy semantics
         def iteritems(self):
             iteritems = SearchCommand.ConfigurationSettings.iteritems(self)
             version = self.command.protocol_version
@@ -185,6 +188,8 @@ def iteritems(self):
                         lambda name_value1: (name_value1[0], 'stateful') if name_value1[0] == 'type' else (name_value1[0], name_value1[1]), iteritems)
             return iteritems
 
-        items = iteritems
+        # N.B.: Does not use Python 3 dict view semantics
+        if not six.PY2:
+            items = iteritems
 
         # endregion