feat: enable mypy session for ndb (#16691)

This PR enables the mypy session in noxfile.py for ndb and aligns it
with the GAPIC generator template.

Author: chalmerlowe

packages/google-cloud-ndb/google/cloud/ndb/__init__.py

@@ -23,7 +23,7 @@
 
 fromgoogle.cloud.ndbimportversion
 
-__version__=version.__version__
+__version__: str=version.__version__
 
 fromgoogle.cloud.ndb.clientimportClient
 fromgoogle.cloud.ndb.contextimportAutoBatcher

packages/google-cloud-ndb/google/cloud/ndb/_cache.py

@@ -117,18 +117,18 @@ def done_callback(self, cache_call):
  """
 exception=cache_call.exception()
 ifexception:
-forfutureinself.futures:
+forfutureinself.futures:# type: ignore[attr-defined]
 future.set_exception(exception)
 
 else:
-forfutureinself.futures:
+forfutureinself.futures:# type: ignore[attr-defined]
 future.set_result(None)
 
 defmake_call(self):
 """Make the actual call to the global cache. To be overridden."""
 raiseNotImplementedError
 
-deffuture_info(self, key):
+deffuture_info(self, key, value=None):
 """Generate info string for Future. To be overridden."""
 raiseNotImplementedError
 
@@ -279,7 +279,7 @@ def make_call(self):
 """Call :method:`GlobalCache.get`."""
 return_global_cache().get(self.keys)
 
-deffuture_info(self, key):
+deffuture_info(self, key, value=None):
 """Generate info string for Future."""
 return"GlobalCache.get({})".format(key)
 
@@ -373,7 +373,7 @@ def make_call(self):
 """Call :method:`GlobalCache.set`."""
 return_global_cache().set(self.todo, expires=self.expires)
 
-deffuture_info(self, key, value):
+deffuture_info(self, key, value=None):
 """Generate info string for Future."""
 return"GlobalCache.set({}, {})".format(key, value)
 
@@ -436,7 +436,7 @@ def make_call(self):
 """Call :method:`GlobalCache.set`."""
 return_global_cache().set_if_not_exists(self.todo, expires=self.expires)
 
-deffuture_info(self, key, value):
+deffuture_info(self, key, value=None):
 """Generate info string for Future."""
 return"GlobalCache.set_if_not_exists({}, {})".format(key, value)
 
@@ -482,7 +482,7 @@ def make_call(self):
 """Call :method:`GlobalCache.delete`."""
 return_global_cache().delete(self.keys)
 
-deffuture_info(self, key):
+deffuture_info(self, key, value=None):
 """Generate info string for Future."""
 return"GlobalCache.delete({})".format(key)
 
@@ -513,7 +513,7 @@ def make_call(self):
 """Call :method:`GlobalCache.watch`."""
 return_global_cache().watch(self.todo)
 
-deffuture_info(self, key, value):
+deffuture_info(self, key, value=None):
 """Generate info string for Future."""
 return"GlobalCache.watch({}, {})".format(key, value)
 
@@ -543,7 +543,7 @@ def make_call(self):
 """Call :method:`GlobalCache.unwatch`."""
 return_global_cache().unwatch(self.keys)
 
-deffuture_info(self, key):
+deffuture_info(self, key, value=None):
 """Generate info string for Future."""
 return"GlobalCache.unwatch({})".format(key)
 
@@ -580,7 +580,7 @@ def make_call(self):
 """Call :method:`GlobalCache.compare_and_swap`."""
 return_global_cache().compare_and_swap(self.todo, expires=self.expires)
 
-deffuture_info(self, key, value):
+deffuture_info(self, key, value=None):
 """Generate info string for Future."""
 return"GlobalCache.compare_and_swap({}, {})".format(key, value)
 
@@ -627,8 +627,7 @@ def global_lock_for_write(key):
  tasklets.Future: Eventual result will be a lock value to be used later with
  :func:`global_unlock`.
  """
-lock="."+str(uuid.uuid4())
-lock=lock.encode("ascii")
+lock= ("."+str(uuid.uuid4())).encode("ascii")
 utils.logging_debug(log, "lock for write: {}", lock)
 
 defnew_value(old_value):

packages/google-cloud-ndb/google/cloud/ndb/_datastore_api.py

@@ -168,7 +168,7 @@ def lookup(key, options):
 ifuse_global_cacheandnotkey_locked:
 ifentity_pbisnot_NOT_FOUND:
 expires=context._global_cache_timeout(key, options)
-serialized=entity_pb._pb.SerializeToString()
+serialized=entity_pb._pb.SerializeToString()# type: ignore[attr-defined]
 yield_cache.global_compare_and_swap(
 cache_key, serialized, expires=expires
  )

packages/google-cloud-ndb/google/cloud/ndb/_datastore_query.py

@@ -342,6 +342,10 @@ def has_next_async(self):
 ifself._batchisNone:
 yieldself._next_batch() # First time
 
+ifself._batchisNone:
+raiseTypeError("self._batch cannot be None")
+ifself._indexisNone:
+raiseTypeError("self._index cannot be None")
 ifself._index<len(self._batch):
 raisetasklets.Return(True)
 
@@ -359,7 +363,9 @@ def probably_has_next(self):
 return (
 self._batchisNone# Haven't even started yet
 orself._has_next_batch# There's another batch to fetch
-orself._index<len(self._batch) # Not done with current batch
+or (
+self._indexisnotNoneandself._index<len(self._batch)
+ ) # Not done with current batch
  )
 
 @tasklets.tasklet
@@ -421,6 +427,10 @@ def next(self):
 self._cursor_before=None
 raiseStopIteration
 
+ifself._batchisNone:
+raiseTypeError("self._batch cannot be None")
+ifself._indexisNone:
+raiseTypeError("self._index cannot be None")
 # Won't block
 next_result=self._batch[self._index]
 self._index+=1
@@ -446,7 +456,7 @@ def _peek(self):
 batch=self._batch
 index=self._index
 
-ifbatchandindex<len(batch):
+ifbatchandindexisnotNoneandindex<len(batch):
 returnbatch[index]
 
 raiseKeyError(index)
@@ -554,6 +564,8 @@ def next(self):
 ifnotself.has_next():
 raiseStopIteration()
 
+ifself._next_resultisNone:
+raiseTypeError("self._next_result cannot be None")
 # Won't block
 next_result=self._next_result
 self._next_result=None
@@ -718,6 +730,8 @@ def next(self):
 ifnotself.has_next():
 raiseStopIteration()
 
+ifself._next_resultisNone:
+raiseTypeError("self._next_result cannot be None")
 # Won't block
 next_result=self._next_result
 self._next_result=None
@@ -949,7 +963,7 @@ def _query_to_protobuf(query):
 filter_pb=ancestor_filter_pb
 
 elifisinstance(filter_pb, query_pb2.CompositeFilter):
-filter_pb.filters._pb.add(property_filter=ancestor_filter_pb._pb)
+filter_pb.filters._pb.add(property_filter=ancestor_filter_pb._pb)# type: ignore[attr-defined]
 
 else:
 filter_pb=query_pb2.CompositeFilter(

packages/google-cloud-ndb/google/cloud/ndb/_eventloop.py

@@ -116,12 +116,15 @@ class EventLoop(object):
  """
 
 def__init__(self):
-self.current=collections.deque()
-self.idlers=collections.deque()
+self._init()
+
+def_init(self):
+self.current: collections.deque=collections.deque()
+self.idlers: collections.deque=collections.deque()
 self.inactive=0
 self.queue= []
 self.rpcs= {}
-self.rpc_results=queue.Queue()
+self.rpc_results: queue.Queue=queue.Queue()
 
 defclear(self):
 """Remove all pending events without running any."""
@@ -139,7 +142,7 @@ def clear(self):
 utils.logging_debug(log, " queue = {}", queue)
 ifrpcs:
 utils.logging_debug(log, " rpcs = {}", rpcs)
-self.__init__()
+self._init()
 current.clear()
 idlers.clear()
 queue[:] = []

packages/google-cloud-ndb/google/cloud/ndb/_gql.py

@@ -1,6 +1,7 @@
 importdatetime
 importre
 importtime
+fromtypingimportAny
 
 fromgoogle.cloud.ndbimportcontextascontext_module
 fromgoogle.cloud.ndbimportexceptions
@@ -408,7 +409,8 @@ def _AddProcessedParameterFilter(self, identifier, condition, operator, paramete
 ifidentifier.lower() =="ancestor":
 self._has_ancestor=True
 filter_rule= (self._ANCESTOR, "is")
-assertcondition.lower() =="is"
+ifcondition.lower() !="is":
+raiseValueError("condition must be 'is'")
 
 ifoperator=="list"andcondition.lower() notin ["in", "not_in"]:
 self._Error("Only IN can process a list of values, given '%s'"%condition)
@@ -485,7 +487,7 @@ def _Literal(self):
  a string, integer, floating point value, boolean or None).
  """
 
-literal=None
+literal: Any=None
 
 ifself._next_symbol<len(self._symbols):
 try:
@@ -770,27 +772,38 @@ def _raise_cast_error(message):
 
 
 def_time_function(values):
+t_tuple: tuple[int, ...]
 iflen(values) ==1:
 value=values[0]
 ifisinstance(value, str):
 try:
-time_tuple=time.strptime(value, "%H:%M:%S")
+parsed_time=time.strptime(value, "%H:%M:%S")
 exceptValueErroraserror:
 _raise_cast_error(
 "Error during time conversion, {}, {}".format(error, values)
  )
-time_tuple=time_tuple[3:]
-time_tuple=time_tuple[0:3]
+t_tuple= (
+parsed_time.tm_hour,
+parsed_time.tm_min,
+parsed_time.tm_sec,
+ )
 elifisinstance(value, int):
-time_tuple= (value,)
+t_tuple= (value,)
 else:
 _raise_cast_error("Invalid argument for time(), {}".format(value))
 eliflen(values) <4:
-time_tuple=tuple(values)
+t_tuple=tuple(values)
 else:
 _raise_cast_error("Too many arguments for time(), {}".format(values))
 try:
-returndatetime.time(*time_tuple)
+iflen(t_tuple) ==1:
+returndatetime.time(t_tuple[0])
+eliflen(t_tuple) ==2:
+returndatetime.time(t_tuple[0], t_tuple[1])
+eliflen(t_tuple) ==3:
+returndatetime.time(t_tuple[0], t_tuple[1], t_tuple[2])
+else:
+_raise_cast_error("Invalid arguments for time()")
 exceptValueErroraserror:
 _raise_cast_error("Error during time conversion, {}, {}".format(error, values))
 

packages/google-cloud-ndb/google/cloud/ndb/_legacy_entity_pb.py

@@ -389,11 +389,10 @@ class Property(ProtocolBuffer.ProtocolMessage):
 24: "EMPTY_LIST",
  }
 
+@classmethod
 defMeaning_Name(cls, x):
 returncls._Meaning_NAMES.get(x, "")
 
-Meaning_Name=classmethod(Meaning_Name)
-
 has_meaning_=0
 meaning_=0
 has_meaning_uri_=0
@@ -526,7 +525,7 @@ class Path_Element(ProtocolBuffer.ProtocolMessage):
 deftype(self):
 # Force legacy byte-str to be a str.
 iftype(self.type_) isbytes:
-returnself.type_.decode()
+returnself.type_.decode()# type: ignore[attr-defined]
 returnself.type_
 
 defset_type(self, x):

packages/google-cloud-ndb/google/cloud/ndb/_legacy_protocol_buffer.py

@@ -32,6 +32,9 @@ def MergePartialFromString(self, s):
 d=Decoder(a, 0, len(a))
 self.TryMerge(d)
 
+defTryMerge(self, d):
+raiseNotImplementedError
+
 
 classDecoder:
 NUMERIC=0

packages/google-cloud-ndb/google/cloud/ndb/_options.py

@@ -19,11 +19,16 @@
 importlogging
 
 fromgoogle.cloud.ndbimportexceptions
+fromtypingimportAny
 
 log=logging.getLogger(__name__)
 
 
 classOptions(object):
+max_memcache_items: Any
+force_writes: Any
+propagation: Any
+
 __slots__= (
 # Supported
 "retries",

packages/google-cloud-ndb/google/cloud/ndb/_remote.py

@@ -41,7 +41,7 @@ def __init__(self, future, info):
 self.future=future
 self.info=info
 self.start_time=time.time()
-self.elapsed_time=0
+self.elapsed_time=0.0
 
 defrecord_time(future):
 self.elapsed_time=time.time() -self.start_time