refactor(ia): add propertyArrayIndices argument to readRawMultiple (#309)

* refactor(ia): add propertyArrayIndices argument to readRawMultiple

style:
- fix docstrings
- add raise keyword
- add return values

* chore: fix type for __init__

Author: cesarcoatl

Diff for: src/ch/qos/logback/classic/__init__.py

@@ -20,7 +20,7 @@ def fromLocationAwareLoggerInteger(levelInt):
 
     def isGreaterOrEqual(self, r):
         # type: (Level) -> bool
-        pass
+        return True
 
     def toInt(self):
         # type: () -> int

Diff for: src/com/google/common/collect/__init__.py

@@ -49,7 +49,7 @@ def builderWithExpectedSize():
 
     def contains(self, o):
         # type: (Object) -> bool
-        pass
+        return True
 
     @staticmethod
     def copyOf(*args):
@@ -106,7 +106,7 @@ def builderWithExpectedSize():
 
     def contains(self, o):
         # type: (Object) -> bool
-        pass
+        return True
 
     @staticmethod
     def copyOf(*args):

Diff for: src/com/inductiveautomation/ignition/client/util/gui/scheduling/__init__.py

@@ -38,7 +38,7 @@ def isAlldays(self):
 
     def isDaySelected(self, day):
         # type: (ScheduleModel.DayOfWeek) -> bool
-        pass
+        return True
 
     def isEveryHourEnabled(self):
         # type: () -> bool

Diff for: src/com/inductiveautomation/ignition/common/__init__.py

@@ -35,6 +35,22 @@ class Dataset(object):
 
     def binarySearch(self, column, key):
         # type: (int, Any) -> int
+        """Performs a binary search on the specified column, looking for
+        the specified key.
+
+        Args:
+            column: The column to search in.
+            key: The key to search for.
+
+        Returns:
+            The index of the key in the column, or a negative number if
+            the key is not found.
+
+        Raises:
+            ClassCastException: If the column is not Comparable.
+            UnsupportedOperationException: If the Dataset implementation
+                declines to implement this operation.
+        """
         pass
 
     def getColumnAsList(self, col):
@@ -55,6 +71,9 @@ def getColumnCount(self):
 
         Returns:
             The number of columns in the dataset.
+
+        Raises:
+            NotImplementedError: If the method is not implemented.
         """
         raise NotImplementedError
 
@@ -67,6 +86,9 @@ def getColumnIndex(self, colName):
 
         Returns:
             The index of the column with the name colName.
+
+        Raises:
+            NotImplementedError: If the method is not implemented.
         """
         raise NotImplementedError
 
@@ -79,6 +101,9 @@ def getColumnName(self, col):
 
         Returns:
             The name of the column at the index colIndex.
+
+        Raises:
+            NotImplementedError: If the method is not implemented.
         """
         raise NotImplementedError
 
@@ -88,6 +113,9 @@ def getColumnNames(self):
 
         Returns:
             A list with the names of all the columns.
+
+        Raises:
+            NotImplementedError: If the method is not implemented.
         """
         raise NotImplementedError
 
@@ -100,6 +128,9 @@ def getColumnType(self, col):
 
         Returns:
             The type of the column at the index.
+
+        Raises:
+            NotImplementedError: If the method is not implemented.
         """
         raise NotImplementedError
 
@@ -109,6 +140,9 @@ def getColumnTypes(self):
 
         Returns:
             A list with the types of all the columns.
+
+        Raises:
+            NotImplementedError: If the method is not implemented.
         """
         raise NotImplementedError
 
@@ -121,11 +155,12 @@ def getPrimitiveValueAt(self, row, col):
             row: The row index. Zero-based index.
             col: The column index. Zero-based index.
 
+        Returns:
+            If the given column is a numeric type or a Date, then
+                the value will be returned as a double.
+
         Raises:
-            IllegalArgumentException: if the value at row, col is not a
-                number or Date.
-            UnsupportedOperationException: If the Dataset implementation
-                declines to implement this operation.
+            NotImplementedError: If the method is not implemented.
         """
         raise NotImplementedError
 
@@ -137,9 +172,11 @@ def getQualityAt(self, row, col):
             row: The row index. Zero-based index.
             col: The column index. Zero-based index.
 
+        Returns:
+            The quality of the value at the given location.
+
         Raises:
-            ArrayIndexOutOfBoundsException: If the given row, col is out
-                of range and hasQualityData() returns true.
+            NotImplementedError: If the method is not implemented.
         """
         raise NotImplementedError
 
@@ -149,6 +186,9 @@ def getRowCount(self):
 
         Returns:
             The number of rows in the dataset.
+
+        Raises:
+            NotImplementedError: If the method is not implemented.
         """
         raise NotImplementedError
 
@@ -163,6 +203,9 @@ def getValueAt(self, row, col):
 
         Returns:
             The value found at the row and column.
+
+        Raises:
+            NotImplementedError: If the method is not implemented.
         """
         raise NotImplementedError
 
@@ -274,6 +317,10 @@ def getPrimitiveValueAt(self, row, col):
             row: The row index. Zero-based index.
             col: The column index. Zero-based index.
 
+        Returns:
+            If the given column is a numeric type or a Date, then
+                the value will be returned as a double.
+
         Raises:
             IllegalArgumentException: if the value at row, col is not a
                 number or Date.
@@ -290,6 +337,9 @@ def getQualityAt(self, row, col):
             row: The row index. Zero-based index.
             col: The column index. Zero-based index.
 
+        Returns:
+            The quality of the value at the given location.
+
         Raises:
             ArrayIndexOutOfBoundsException: If the given row, col is out
                 of range and hasQualityData() returns true.
@@ -501,12 +551,12 @@ def getPathLength(self):
 
     def isAncestorOf(self, path):
         # type: (Path) -> bool
-        pass
+        return True
 
     @staticmethod
     def isRelative(path):
         # type: (StringPath) -> bool
-        pass
+        return True
 
     def isRoot(self):
         # type: () -> bool
@@ -538,7 +588,7 @@ def compareTo(self, o):
 
         def isAncestorOf(self, child):
             # type: (Path) -> bool
-            pass
+            return True
 
 
 class TypeUtilities(Object):

Diff for: src/com/inductiveautomation/ignition/common/alarming/__init__.py

@@ -226,7 +226,7 @@ def __init__(self, event):
 
     def contains(self, property):
         # type: (AnyStr) -> bool
-        pass
+        return True
 
     def get(self, property):
         # type: (AnyStr) -> Object

Diff for: src/com/inductiveautomation/ignition/common/browsing/__init__.py

@@ -44,11 +44,11 @@ def addProperty(self, property, value):
 
     def checkNameFilters(self, path):
         # type: (Any) -> bool
-        pass
+        return True
 
     def checkProperties(self, toCheck):
         # type: (PropertyValueSource) -> bool
-        pass
+        return True
 
     def getAllowedTypes(self):
         # type: () -> Iterable[AnyStr]
@@ -157,7 +157,7 @@ def getTypeId(self):
 
         def passes(self, value):
             # type: (AnyStr) -> bool
-            pass
+            return True
 
 
 class Results(Object):

Diff for: src/com/inductiveautomation/ignition/common/licensing/__init__.py

@@ -16,7 +16,7 @@
 class LicenseDetails(object):
     def checkFlag(self, key):
         # type: (AnyStr) -> bool
-        pass
+        return True
 
     def getExpirationDate(self):
         # type: () -> Date

Diff for: src/com/inductiveautomation/ignition/common/modules/__init__.py

@@ -253,11 +253,11 @@ def isNativeLib(self):
 
         def isRequiredArchitecture(self, arch):
             # type: (Platform.Architecture) -> bool
-            pass
+            return True
 
         def isRequiredOS(self, os):
             # type: (Platform.OperatingSystem) -> bool
-            pass
+            return True
 
     class LibraryInfo(Object):
         def getName(self):

Diff for: src/com/inductiveautomation/ignition/common/project/resource/__init__.py

@@ -301,11 +301,11 @@ def getType(self):
 
     def isAncestorOf(self, possibleDescendant):
         # type: (ResourcePath) -> bool
-        pass
+        return True
 
     def isParentOf(self, possibleChild):
         # type: (ResourcePath) -> bool
-        pass
+        return True
 
     def isResourceTypeFolder(self):
         # type: () -> bool
@@ -368,7 +368,7 @@ def getTypeId(self):
 
     def matches(self, op):
         # type: (Any) -> bool
-        pass
+        return True
 
     def rootPath(self):
         # type: () -> ResourcePath

Diff for: src/com/inductiveautomation/ignition/common/script/builtin/__init__.py

@@ -281,6 +281,10 @@ def getColumnIndex(self, colName):
 
             Returns:
                 The index of the column with the name colName.
+
+            Raises:
+                ArrayIndexOutOfBoundsException: If the column isn't
+                    found.
             """
             pass
 
@@ -293,6 +297,10 @@ def getColumnName(self, col):
 
             Returns:
                 The name of the column at the index colIndex.
+
+            Raises:
+                ArrayIndexOutOfBoundsException: If the given index is
+                    out of range.
             """
             pass
 
@@ -314,12 +322,17 @@ def getColumnType(self, col):
 
             Returns:
                 The type of the column at the index.
+
+            Raises:
+                ArrayIndexOutOfBoundsException: If the given index is
+                    out of range.
             """
             pass
 
         def getColumnTypes(self):
             # type: () -> List[Class]
-            """Returns a list with the types of all the columns.
+            """Returns an unmodifiable list of this dataset's column
+            types, in order.
 
             Returns:
                 A list with the types of all the columns.
@@ -335,6 +348,10 @@ def getPrimitiveValueAt(self, row, col):
                 row: The row index. Zero-based index.
                 col: The column index. Zero-based index.
 
+            Returns:
+                If the given column is a numeric type or a Date, then
+                    the value will be returned as a double.
+
             Raises:
                 IllegalArgumentException: if the value at row, col is
                     not a number or Date.
@@ -351,6 +368,9 @@ def getQualityAt(self, row, col):
                 row: The row index. Zero-based index.
                 col: The column index. Zero-based index.
 
+            Returns:
+                The quality of the value at the given location.
+
             Raises:
                 ArrayIndexOutOfBoundsException: If the given row, col is
                     out of range and hasQualityData() returns true.
@@ -377,8 +397,13 @@ def getValueAt(self, row, col):
 
             Returns:
                 The value found at the row and column.
+
+            Raises:
+                ArrayIndexOutOfBoundsException: If the column isn't
+                    found.
             """
-            pass
+            print(row, col)
+            return True
 
         def setData(self, data):
             # type: (Dataset) -> None