Remove contains methods everywhere in client.py.

Everything now must use the in operator instead.
Updated the CHANGELOG, fixed two examples that depend on contains,
and one test.

Author: Frederick Ross

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 1.0
 
+* All the .contains methods on collections have been removed. Use Python's `in` operator instead.
 * Confs has been renamed to Configurations, and ConfFile to ConfigurationFile.
 * Stanza.submit now takes a dictionary of key/value pairs specifying the stanza instead of a raw string.
 * Namespace handling has changed subtly. Code that depends on namespace handling in detail may break.

examples/index.py

@@ -131,7 +131,7 @@ def foreach(self, argv, func):
         if len(opts.args) == 0:
             error("Command requires an index name", 2)
         for name in opts.args:
-            if not self.service.indexes.contains(name):
+            if name not in self.service.indexes:
                 error("Index '%s' does not exist" % name, 2)
             index = self.service.indexes[name]
             func(index)
@@ -143,7 +143,7 @@ def update(self, argv):
             error("Command requires an index name", 2)
         name = argv[0]
 
-        if not self.service.indexes.contains(name):
+        if name not in self.service.indexes:
             error("Index '%s' does not exist" % name, 2)
         index = self.service.indexes[name]
 

examples/upload.py

@@ -59,7 +59,7 @@ def main(argv):
     service = client.connect(**kwargs_splunk)
 
     name = opts.kwargs['index']
-    if not service.indexes.contains(name):
+    if name not in service.indexes:
         error("Index '%s' does not exist." % name, 2)
     index = service.indexes[name]
 

splunklib/client.py

@@ -1276,22 +1276,6 @@ def _load_list(self, response):
             entities.append(entity)
         return entities
 
-    def contains(self, name):
-        """**Deprecated**: Use the ``in`` operator instead.
-
-        Indicates whether an entity name exists in the collection.
-
-        Makes a single roundtrip to the server, plus at most two more
-        if
-        the ``autologin`` field of :func:`connect` is set to ``True``.
-
-        :param name: The entity name.
-        :type name: ``string``
-        :return: ``True`` if the entity exists, ``False`` if not.
-        :rtype: ``boolean``
-        """
-        return name in self
-
     def itemmeta(self):
         """Returns metadata for members of the collection.
 
@@ -3196,13 +3180,6 @@ def __getitem__(self, key):
     def __contains__(self, name):
         return Collection.__contains__(self, name.lower())
 
-    def contains(self, name):
-        """**Deprecated**: Use ``in`` operator instead.
-
-        Checks whether there is a user *name* in this Splunk instance.
-        """
-        return Collection.__contains__(self, name.lower())
-
     def create(self, username, password, roles, **params):
         """Creates a new user.
 
@@ -3337,13 +3314,6 @@ def __getitem__(self, key):
     def __contains__(self, name):
         return Collection.__contains__(self, name.lower())
 
-    def contains(self, name):
-        """**Deprecated**: Use ``in`` operator instead.
-
-        Checks whether there is a user *name* in this Splunk instance.
-        """
-        return Collection.__contains__(self, name.lower())
-
     def create(self, name, **params):
         """Creates a new role.
 

tests/test_job.py

@@ -30,7 +30,7 @@
 class TestUtilities(testlib.SDKTestCase):
     def test_service_search(self):
         job = self.service.search('search index=_internal earliest=-1m | head 3')
-        self.assertTrue(self.service.jobs.contains(job.sid))
+        self.assertTrue(job.sid in self.service.jobs)
         job.cancel()
 
     def test_oneshot_with_garbage_fails(self):