Add support for getting the contents of a collection as a dictionary where the

keys are the indexes of the collection and the values are elements of the
collection.

Author: anthony-tuininga

doc/src/objecttype.rst

@@ -66,6 +66,12 @@ Object Objects
     collection.
 
 
+.. method:: Object.asdict()
+
+    Return a dictionary where the collection's indexes are the keys and the
+    elements are its values.
+
+
 .. method:: Object.aslist()
 
     Return a list of each of the collection's elements in index order.

src/cxoObject.c

@@ -22,6 +22,7 @@ static PyObject *cxoObject_getAttr(cxoObject*, PyObject*);
 static PyObject *cxoObject_repr(cxoObject*);
 static int cxoObject_setAttr(cxoObject*, PyObject*, PyObject*);
 static PyObject *cxoObject_append(cxoObject*, PyObject*);
+static PyObject *cxoObject_asDict(cxoObject*, PyObject*);
 static PyObject *cxoObject_asList(cxoObject*, PyObject*);
 static PyObject *cxoObject_copy(cxoObject*, PyObject*);
 static PyObject *cxoObject_delete(cxoObject*, PyObject*);
@@ -42,6 +43,7 @@ static PyObject *cxoObject_trim(cxoObject*, PyObject*);
 //-----------------------------------------------------------------------------
 static PyMethodDef cxoObjectMethods[] = {
     { "append", (PyCFunction) cxoObject_append, METH_O },
+    { "asdict", (PyCFunction) cxoObject_asDict, METH_NOARGS },
     { "aslist", (PyCFunction) cxoObject_asList, METH_NOARGS },
     { "copy", (PyCFunction) cxoObject_copy, METH_NOARGS },
     { "delete", (PyCFunction) cxoObject_delete, METH_VARARGS },
@@ -384,6 +386,59 @@ static PyObject *cxoObject_internalGetElementByIndex(cxoObject *obj,
 }
 
 
+//-----------------------------------------------------------------------------
+// cxoObject_asDict()
+//   Returns a collection as a dictionary. If the object is not a collection,
+// an error is returned.
+//-----------------------------------------------------------------------------
+static PyObject *cxoObject_asDict(cxoObject *obj, PyObject *args)
+{
+    PyObject *dict, *key, *value;
+    int32_t index, nextIndex;
+    int exists;
+
+    // create the result dictionary
+    dict = PyDict_New();
+    if (!dict)
+        return NULL;
+
+    // populate it with each of the elements in the collection
+    if (dpiObject_getFirstIndex(obj->handle, &index, &exists) < 0) {
+        Py_DECREF(dict);
+        return cxoError_raiseAndReturnNull();
+    }
+    while (exists) {
+        value = cxoObject_internalGetElementByIndex(obj, index);
+        if (!value) {
+            Py_DECREF(dict);
+            return NULL;
+        }
+        key = PyInt_FromLong(index);
+        if (!key) {
+            Py_DECREF(value);
+            Py_DECREF(dict);
+            return NULL;
+        }
+        if (PyDict_SetItem(dict, key, value) < 0) {
+            Py_DECREF(key);
+            Py_DECREF(value);
+            Py_DECREF(dict);
+            return NULL;
+        }
+        Py_DECREF(key);
+        Py_DECREF(value);
+        if (dpiObject_getNextIndex(obj->handle, index, &nextIndex,
+                &exists) < 0) {
+            Py_DECREF(dict);
+            return cxoError_raiseAndReturnNull();
+        }
+        index = nextIndex;
+    }
+
+    return dict;
+}
+
+
 //-----------------------------------------------------------------------------
 // cxoObject_asList()
 //   Returns a collection as a list of elements. If the object is not a

test/Features12_1.py

@@ -243,9 +243,17 @@ def testBindPLSQLStringCollectionOutWithHoles(self):
         self.assertEqual(obj.aslist(),
                 ["First element", "Second element", "Third element",
                  "Fourth element"])
+        self.assertEqual(obj.asdict(),
+                { -1048576 : 'First element',
+                  -576 : 'Second element',
+                  284 : 'Third element',
+                  8388608: 'Fourth element' })
         obj.delete(-576)
         obj.delete(284)
         self.assertEqual(obj.aslist(), ["First element", "Fourth element"])
+        self.assertEqual(obj.asdict(),
+                { -1048576 : 'First element',
+                  8388608: 'Fourth element' })
 
     def testExceptionInIteration(self):
         "test executing with arraydmlrowcounts with exception"