Closes #5213: add TypeGuards to dtypes module

Author: ajpotts

.docstr.yaml

@@ -4,6 +4,6 @@ exclude: .*/tests     # regex to skip test files
 skip_magic: True      # ignore __dunder__ methods (except __init__)
 skip_init: True       # ignore __init__ methods
 skip_private: True    # ignore names starting with _
-fail_under: 76.0        # exit non-zero if coverage < 76%
+fail_under: 75.9        # exit non-zero if coverage < 76%
 badge: docs/badge.svg # generate an SVG badge
 

arkouda/__init__.py

@@ -220,11 +220,11 @@
     intersect1d,
     intp,
     isnumeric,
-    isSupportedBool,
-    isSupportedDType,
-    isSupportedFloat,
-    isSupportedInt,
-    isSupportedNumber,
+    is_supported_bool,
+    is_supported_dtype,
+    is_supported_float,
+    is_supported_int,
+    is_supported_number,
     is_registered,
     is_sorted,
     isfinite,
@@ -396,10 +396,10 @@
     ruok,
     shutdown,
 )
-from arkouda.client_dtypes import BitVector, BitVectorizer, Fields, IPv4, ip_address, is_ipv4, is_ipv6
+from arkouda.client_dtypes import BitVector, bit_vectorizer, Fields, IPv4, ip_address, is_ipv4, is_ipv6
 from arkouda.groupbyclass import GROUPBY_REDUCTION_TYPES, GroupBy, broadcast, groupable, unique
 from arkouda.categorical import Categorical
-from arkouda.logger import LogLevel, disableVerbose, enableVerbose, write_log
+from arkouda.logger import LogLevel, disable_verbose, enable_verbose, write_log
 from arkouda.infoclass import (
     AllSymbols,
     RegisteredSymbols,

arkouda/array_api/array_object.py

@@ -869,7 +869,7 @@ def device(self) -> Device:
         return "cpu"
 
     @property
-    def mT(self) -> Array:
+    def mT(self) -> Array:  # noqa: N802
         raise ValueError("Not implemented")
 
     @property

arkouda/client.py

@@ -74,7 +74,7 @@
 import zmq  # for typechecking
 
 from arkouda import __version__, security
-from arkouda.logger import ArkoudaLogger, LogLevel, getArkoudaLogger
+from arkouda.logger import ArkoudaLogger, LogLevel, get_arkouda_logger
 from arkouda.message import (
     MessageFormat,
     MessageType,
@@ -172,8 +172,8 @@ def _mem_get_factor(unit: str) -> int:
         )
 
 
-logger = getArkoudaLogger(name="Arkouda Client", logLevel=LogLevel.INFO)
-clientLogger = getArkoudaLogger(name="Arkouda User Logger", logFormat="%(message)s")
+logger = get_arkouda_logger(name="Arkouda Client", logLevel=LogLevel.INFO)
+clientLogger = get_arkouda_logger(name="Arkouda User Logger", logFormat="%(message)s")
 
 
 class ClientMode(Enum):
@@ -348,7 +348,7 @@ def __init__(
         self._set_url(server, port, connect_url)
         self.user = user
         self._set_access_token(server, port, token)
-        self.logger = getArkoudaLogger(name="Arkouda Client")
+        self.logger = get_arkouda_logger(name="Arkouda Client")
 
     def _set_url(self, server: str, port: int, connect_url: Optional[str] = None) -> None:
         """

arkouda/client_dtypes.py

@@ -13,7 +13,7 @@
 
 Functions
 ---------
-- `BitVectorizer`: Creates a partially applied BitVector constructor.
+- `bit_vectorizer`: Creates a partially applied BitVector constructor.
 - `ip_address`: Converts various formats to an Arkouda IPv4 object.
 - `is_ipv4`: Returns a boolean array indicating IPv4 addresses.
 - `is_ipv6`: Returns a boolean array indicating IPv6 addresses.
@@ -57,7 +57,7 @@
 
 from typeguard import typechecked
 
-from arkouda.numpy.dtypes import bitType, intTypes, isSupportedInt
+from arkouda.numpy.dtypes import bitType, intTypes, is_supported_int
 from arkouda.numpy.dtypes import uint64 as akuint64
 from arkouda.numpy.pdarrayclass import RegistrationError, pdarray
 from arkouda.pandas.groupbyclass import GroupBy, broadcast
@@ -73,7 +73,7 @@
 
 __all__ = [
     "BitVector",
-    "BitVectorizer",
+    "bit_vectorizer",
     "Fields",
     "IPv4",
     "ip_address",
@@ -82,7 +82,7 @@
 ]
 
 
-def BitVectorizer(width=64, reverse=False):
+def bit_vectorizer(width=64, reverse=False):
     """
     Make a callback (i.e. function) that can be called on an array to create a BitVector.
 
@@ -230,7 +230,7 @@ def __getitem__(self, key):
             A single formatted string or a BitVector slice.
 
         """
-        if isSupportedInt(key):
+        if is_supported_int(key):
             # Return single value as a formatted string
             return self.format(self.values[key])
         else:
@@ -252,7 +252,7 @@ def __setitem__(self, key, value):
         if isinstance(value, self.__class__):
             # Set a slice or selection of values directly
             self.values[key] = value.values
-        elif isSupportedInt(key) and isSupportedInt(value):
+        elif is_supported_int(key) and is_supported_int(value):
             # Set a single value
             self.values[key] = value
         else:
@@ -261,7 +261,7 @@ def __setitem__(self, key, value):
     def _binop(self, other, op):
         # Based on other type, select which data to pass
         # to _binop of pdarray
-        if isSupportedInt(other):
+        if is_supported_int(other):
             otherdata = other
         elif isinstance(other, self.__class__):
             otherdata = other.values
@@ -279,7 +279,7 @@ def _binop(self, other, op):
     def _r_binop(self, other, op):
         # Cases where left operand is BitVector are handled above by _binop
         # Only two cases to handle here: scalar int and int64 pdarray
-        if isSupportedInt(other):
+        if is_supported_int(other):
             if op in self.conserves:
                 return self._cast(self.values._r_binop(other, op))
             else:
@@ -306,7 +306,7 @@ def opeq(self, other, op):
 
         """
         # Based on other type, select data to pass to pdarray opeq
-        if isSupportedInt(other):
+        if is_supported_int(other):
             otherdata = other
         elif isinstance(other, self.__class__):
             otherdata = other.values
@@ -699,7 +699,7 @@ def export_uint(self):
 
     def format(self, x):
         """Format a single integer IP address as a string."""
-        if not isSupportedInt(x):
+        if not is_supported_int(x):
             raise TypeError("Argument must be an integer scalar")
         return str(_ip_address(int(x)))
 
@@ -711,7 +711,7 @@ def normalize(self, x):
         and convert it to an integer.
 
         """
-        if not isSupportedInt(x):
+        if not is_supported_int(x):
             x = int(_ip_address(x))
         if x < 0:
             raise ValueError(f"Not an IP address: {_ip_address(x)}")
@@ -782,7 +782,7 @@ def __getitem__(self, key):
             Formatted IP address string or a sliced IPv4 instance.
 
         """
-        if isSupportedInt(key):
+        if is_supported_int(key):
             # Display single item as string
             return self.format(self.values[key])
         else:

arkouda/dtypes/__init__.py

@@ -62,11 +62,11 @@
     int64,
     int_scalars,
     intTypes,
-    isSupportedBool,
-    isSupportedDType,
-    isSupportedFloat,
-    isSupportedInt,
-    isSupportedNumber,
+    is_supported_bool,
+    is_supported_dtype,
+    is_supported_float,
+    is_supported_int,
+    is_supported_number,
     numeric_and_bool_scalars,
     numeric_scalars,
     numpy_scalars,

arkouda/logger.py

@@ -26,27 +26,27 @@
 
 Functions
 ---------
-getArkoudaLogger(name, handlers=None, logFormat=None, logLevel=None)
+get_arkouda_logger(name, handlers=None, logFormat=None, logLevel=None)
     Instantiate a logger with customizable format and log level.
 
-getArkoudaClientLogger(name)
+get_arkouda_client_logger(name)
     Instantiate a logger for client-facing output (no formatting, INFO level default).
 
-enableVerbose()
+enable_verbose()
     Globally set all ArkoudaLoggers to DEBUG level.
 
-disableVerbose(logLevel=LogLevel.INFO)
+disable_verbose(logLevel=LogLevel.INFO)
     Globally disable DEBUG output by setting all loggers to the specified level.
 
 write_log(log_msg, tag="ClientGeneratedLog", log_lvl=LogLevel.INFO)
     Submit a custom log message to the Arkouda server’s logging system.
 
 Usage Example
 -------------
->>> from arkouda.logger import getArkoudaLogger, LogLevel
->>> logger = getArkoudaLogger("myLogger")
+>>> from arkouda.logger import get_arkouda_logger, LogLevel
+>>> logger = get_arkouda_logger("myLogger")
 >>> logger.info("This is an info message.")
->>> logger.enableVerbose()
+>>> logger.enable_verbose()
 >>> logger.debug("Now showing debug messages.")
 
 See Also
@@ -75,7 +75,7 @@
 from typeguard import typechecked
 
 
-__all__ = ["LogLevel", "enableVerbose", "disableVerbose", "write_log"]
+__all__ = ["LogLevel", "enable_verbose", "disable_verbose", "write_log"]
 
 loggers = {}
 
@@ -210,7 +210,7 @@ def __init__(
             self.addHandler(handler)
 
     @typechecked
-    def changeLogLevel(self, level: LogLevel, handlerNames: Optional[List[str]] = None) -> None:
+    def change_log_level(self, level: LogLevel, handlerNames: Optional[List[str]] = None) -> None:
         """
         Dynamically changes the logging level for ArkoudaLogger and 1..n of configured Handlers.
 
@@ -246,12 +246,12 @@ def changeLogLevel(self, level: LogLevel, handlerNames: Optional[List[str]] = No
                 if name == handler.name:
                     handler.setLevel(newLevel)
 
-    def enableVerbose(self) -> None:
+    def enable_verbose(self) -> None:
         """Enable verbose output by setting the log level for all handlers to DEBUG."""
-        self.changeLogLevel(LogLevel.DEBUG)
+        self.change_log_level(LogLevel.DEBUG)
 
     @typechecked
-    def disableVerbose(self, logLevel: LogLevel = LogLevel.INFO) -> None:
+    def disable_verbose(self, logLevel: LogLevel = LogLevel.INFO) -> None:
         """
         Disables verbose output.
 
@@ -270,10 +270,10 @@ def disableVerbose(self, logLevel: LogLevel = LogLevel.INFO) -> None:
             Raised if logLevel is not a LogLevel enum
 
         """
-        self.changeLogLevel(logLevel)
+        self.change_log_level(logLevel)
 
     @typechecked
-    def getHandler(self, name: str) -> Handler:
+    def get_handler(self, name: str) -> Handler:
         """
         Retrieve the Handler object corresponding to the name.
 
@@ -302,7 +302,7 @@ def getHandler(self, name: str) -> Handler:
 
 
 @typechecked
-def getArkoudaLogger(
+def get_arkouda_logger(
     name: str,
     handlers: Optional[List[Handler]] = None,
     logFormat: Optional[str] = ArkoudaLogger.DEFAULT_LOG_FORMAT,
@@ -349,7 +349,7 @@ def getArkoudaLogger(
 
 
 @typechecked
-def getArkoudaClientLogger(name: str) -> ArkoudaLogger:
+def get_arkouda_client_logger(name: str) -> ArkoudaLogger:
     """
     Instantiate an ArkoudaLogger that retrieves the logging level from ARKOUDA_LOG_LEVEL env variable.
 
@@ -378,17 +378,17 @@ def getArkoudaClientLogger(name: str) -> ArkoudaLogger:
     confirmation of successful login or pdarray creation
 
     """
-    return getArkoudaLogger(name=name, logFormat=ArkoudaLogger.CLIENT_LOG_FORMAT)
+    return get_arkouda_logger(name=name, logFormat=ArkoudaLogger.CLIENT_LOG_FORMAT)
 
 
-def enableVerbose() -> None:
+def enable_verbose() -> None:
     """Enable verbose logging (DEBUG log level) for all ArkoudaLoggers."""
     for logger in loggers.values():
-        logger.enableVerbose()
+        logger.enable_verbose()
 
 
 @typechecked
-def disableVerbose(logLevel: LogLevel = LogLevel.INFO) -> None:
+def disable_verbose(logLevel: LogLevel = LogLevel.INFO) -> None:
     """
     Disables verbose logging.
 
@@ -407,7 +407,7 @@ def disableVerbose(logLevel: LogLevel = LogLevel.INFO) -> None:
 
     """
     for logger in loggers.values():
-        logger.disableVerbose(logLevel)
+        logger.disable_verbose(logLevel)
 
 
 @typechecked

arkouda/message.py

@@ -70,7 +70,7 @@
 
 from typeguard import typechecked
 
-from arkouda.numpy.dtypes import isSupportedNumber, resolve_scalar_dtype
+from arkouda.numpy.dtypes import is_supported_number, resolve_scalar_dtype
 
 
 __all__ = [
@@ -222,7 +222,7 @@ def _is_supported_value(val):
 
         import numpy as np
 
-        return isinstance(val, (str, np.str_, builtins.bool, np.bool_)) or isSupportedNumber(val)
+        return isinstance(val, (str, np.str_, builtins.bool, np.bool_)) or is_supported_number(val)
 
     @staticmethod
     def _format_param(p):

arkouda/numpy/__init__.py

@@ -135,11 +135,11 @@
     int8,
     intTypes,
     int_scalars,
-    isSupportedBool,
-    isSupportedDType,
-    isSupportedFloat,
-    isSupportedInt,
-    isSupportedNumber,
+    is_supported_bool,
+    is_supported_dtype,
+    is_supported_float,
+    is_supported_int,
+    is_supported_number,
     numeric_and_bool_scalars,
     numeric_scalars,
     numpy_scalars,