Improve exception handlers []

Author: wchilders-nvidia

dev_tools/bin/edgy

@@ -648,7 +648,7 @@ def _diagnose_bad_expectations_file(file_path: Path) -> None:
       line_ctr += 1
       try:
         parse_test_status(line_text)
-      except:
+      except Exception:
         if len(line_text) != 0:
           edgutil.eprint(
             f"{file_path_str}, line {line_ctr}: "
@@ -689,7 +689,7 @@ def _construct_replay_filters(
         )
         for key in comparison:
           desired_tests.add(parsed_test_status_key_to_name(key))
-    except:
+    except Exception:
       edgutil.eprint(
         f"Failed to compare the previous run of the {test_suite.name} "
         'suite to its expectations.'
@@ -712,7 +712,7 @@ def _construct_replay_filters(
           elif (args.replay == 'output-mismatch' and
                 parsed_test_status.is_output_mismatch()):
             desired_tests.add(parsed_test_status_key_to_name(key))
-    except:
+    except Exception:
       edgutil.eprint(
         f"Failed to parse test statuses in previous run of {test_suite.name}."
       )
@@ -1254,7 +1254,7 @@ class TestStatusChecker:
                 encountered_lines: List[str]) -> Optional['TestStatusChecker']:
     try:
       return TestStatusChecker(expected_lines, encountered_lines)
-    except:
+    except Exception:
       return None
 
   def _get_status_for_comparison(

dev_tools/bin/ifc-qt

@@ -383,7 +383,7 @@ class PartitionNodeFormatter:
         values.append(template_string.format(value.description))
       else:
         values.append(format_fn(value))
-    except:
+    except Exception:
       traceback.print_exc()
       values.append(edgifc.decoration.UNKNOWN_VALUE)
 
@@ -428,7 +428,7 @@ class PartitionNodeFormatter:
           stream_reader,
           tacit_field.name()
         )
-      except:
+      except Exception:
         traceback.print_exc()
         field_value = 0
 

dev_tools/pylibs/edgacknowledg/client/__init__.py

@@ -500,7 +500,8 @@ async def add_section(self, handler: ReviewClientHandler) -> None:
           await self.subscribe_section(handler)
         except NotConnectedError:
           pass
-        except Exception:
+        except BaseException:
+          # Failed or cancelled: not added.
           self._review.discard_handler(handler)
           raise
 
@@ -676,7 +677,8 @@ async def add_section(self, handler: ReviewClientHandler) -> None:
     self._review.register_handler(handler)
     try:
       await self.subscribe_section(handler)
-    except Exception:
+    except BaseException:
+      # Failed or cancelled: not added.
       self._review.discard_handler(handler)
       raise
 
@@ -1096,7 +1098,8 @@ async def _subscribe(self, payload: Dict[str, Any]) -> uuid.UUID:
         SUBSCRIBE_TIMEOUT_S,
         f"subscribe {key[1]}/{key[2]}"
       )
-    except Exception:
+    except BaseException:
+      # Failed or cancelled: no longer awaited.
       self._pending_subscribe.pop(key, None)
       if not future.done():
         future.cancel()
@@ -1118,7 +1121,8 @@ async def _unsubscribe(self, subscription_id: uuid.UUID) -> None:
         UNSUBSCRIBE_TIMEOUT_S,
         f"unsubscribe {subscription_id}"
       )
-    except Exception:
+    except BaseException:
+      # Failed or cancelled: no longer awaited.
       self._pending_unsubscribe.pop(subscription_id, None)
       if not future.done():
         future.cancel()

dev_tools/pylibs/edgifc/decoration/__init__.py

@@ -111,7 +111,7 @@ def name(self):
   def decorate(self, ifc_reader, value):
     try:
       return ifc_reader.get_decomposed_index_sort(self.sort_name, value)[0]
-    except:
+    except Exception:
       sort, _ = ifc_reader.get_decomposed_index_sort_values(
         self.sort_name, value
       )
@@ -127,7 +127,7 @@ def name(self):
   def decorate(self, ifc_reader, value):
     try:
       return ifc_reader.get_decomposed_index_sort(self.sort_name, value)[1]
-    except:
+    except Exception:
       _, idx = ifc_reader.get_decomposed_index_sort_values(
         self.sort_name, value
       )

dev_tools/services/acknowledg-forge/tests/test_client_cancellation.py

@@ -0,0 +1,96 @@
+# Part of the EDG Compiler Project, under the Apache License v2.0 with LLVM
+# Exceptions.
+# See https://edgcpp.org/LICENSE.txt for license information.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+'''Cancelling AcknowlEDG client requests undoes them, as failing does.'''
+
+import asyncio
+import uuid
+
+from typing import Any
+
+from edgacknowledg.client import (
+  BatchClientSession,
+  _BatchClientReview,
+  _DirectClientReview,
+)
+
+
+class _Unanswered:
+  '''A batch connection the server never answers on.'''
+
+  def __init__(self) -> None:
+    self.sent: list[Any] = []
+
+  async def send(self, data: Any) -> None:
+    self.sent.append(data)
+
+
+class _Handler:
+  subscription_type = 'test.src'
+  slug = 'test-changes'
+
+
+def _session() -> BatchClientSession:
+  session = BatchClientSession(
+    status_listener = None,
+    api_host = '127.0.0.1',
+    api_port = 1,
+    api_key = None,
+    open_timeout = None
+  )
+  session._connection = _Unanswered()  # type: ignore[assignment]
+  session._session_ready.set()
+  return session
+
+
+async def _cancel_once_sent(session: BatchClientSession,
+                            request: 'asyncio.Task[Any]') -> None:
+  connection = session._connection
+  assert isinstance(connection, _Unanswered)
+  while len(connection.sent) == 0:
+    await asyncio.sleep(0.01)
+  request.cancel()
+  await asyncio.gather(request, return_exceptions = True)
+  assert request.cancelled()
+
+
+async def test_cancelled_subscribes_are_not_awaited() -> None:
+  session = _session()
+  subscribing = asyncio.create_task(session._subscribe({
+    'id': str(uuid.uuid4()), 'type': 'test.src', 'slug': 'test-changes',
+  }))
+  await _cancel_once_sent(session, subscribing)
+  assert session._pending_subscribe == {}
+
+  unsubscribing = asyncio.create_task(session._unsubscribe(uuid.uuid4()))
+  session._connection = _Unanswered()  # type: ignore[assignment]
+  await _cancel_once_sent(session, unsubscribing)
+  assert session._pending_unsubscribe == {}
+
+
+async def test_cancelled_batch_sections_are_not_added() -> None:
+  session = _session()
+  review = _BatchClientReview(session, uuid.uuid4(), [], '')
+  adding = asyncio.create_task(review.add_section(_Handler()))  # type: ignore
+  await _cancel_once_sent(session, adding)
+  # Not left to be subscribed on reconnecting.
+  assert review.sections() == []
+  assert session._pending_subscribe == {}
+
+
+async def test_cancelled_direct_sections_are_not_added() -> None:
+  review = _DirectClientReview(None, uuid.uuid4(), [], '')  # type: ignore
+  subscribing = asyncio.Event()
+
+  async def subscribe_section(handler: Any) -> None:
+    subscribing.set()
+    await asyncio.Event().wait()
+
+  review.subscribe_section = subscribe_section  # type: ignore[method-assign]
+  adding = asyncio.create_task(review.add_section(_Handler()))  # type: ignore
+  await subscribing.wait()
+  adding.cancel()
+  await asyncio.gather(adding, return_exceptions = True)
+  assert review.sections() == []