Merge ec0deec into 816496f

seanbudd · web-flow · commit cea73e529609 · 2023-01-10T10:07:01.000+10:00
diff --git a/source/NVDAObjects/IAccessible/ia2Web.py b/source/NVDAObjects/IAccessible/ia2Web.py
@@ -7,7 +7,8 @@
 """
 import typing
 from typing import (
-	Iterable,
+	Generator,
+	Optional,
 )
 from ctypes import c_short
 from comtypes import COMError, BSTR
@@ -57,7 +58,7 @@ def __bool__(self) -> bool:
 		)
 
 	@property
-	def targets(self) -> Iterable[AnnotationTarget]:
+	def targets(self) -> Generator[AnnotationTarget, None, None]:
 		if not bool(self):
 			# optimisation that avoids having to fetch details relations which may be a more costly procedure.
 			if config.conf["debugLog"]["annotations"]:
@@ -71,7 +72,7 @@ def targets(self) -> Iterable[AnnotationTarget]:
 		yield from ia2WebAnnotationTargetsGen
 
 	@property
-	def roles(self) -> Iterable[controlTypes.Role]:
+	def roles(self) -> Generator[Optional[controlTypes.Role], None, None]:
 		"""
 		Since Chromium exposes the roles via the "details-roles" IA2Attributes, an optimisation can be used
 		to return them.
@@ -96,7 +97,7 @@ def roles(self) -> Iterable[controlTypes.Role]:
 			yield detailsRole
 
 	@property
-	def summaries(self) -> Iterable[str]:
+	def summaries(self) -> Generator[str, None, None]:
 		for target in self.targets:
 			yield target.summary
 
diff --git a/source/NVDAObjects/IAccessible/mozilla.py b/source/NVDAObjects/IAccessible/mozilla.py
@@ -5,7 +5,7 @@
 # Copyright (C) 2006-2022 NV Access Limited, Peter Vágner
 
 from typing import (
-	Iterable,
+	Generator,
 	Optional,
 )
 
@@ -34,7 +34,7 @@ def summary(self) -> str:
 		return self._target.summarizeInProcess()
 
 	@property
-	def role(self) -> controlTypes.Role:
+	def role(self) -> Optional[controlTypes.Role]:
 		# details-roles is currently only defined in Chromium
 		# this may diverge in Firefox in the future.
 		from .chromium import supportedAriaDetailsRoles
@@ -46,7 +46,10 @@ def role(self) -> controlTypes.Role:
 			log.debug(f"detailsRole: {repr(detailsRole)}")
 		if detailsRole in supportedAriaDetailsRoles.values():
 			return detailsRole
-		raise ValueError(f"Unsupported aria details role: {detailsRole}")
+
+		if config.conf["debugLog"]["annotations"]:
+			log.warning(f"Unsupported aria details role: {detailsRole}")
+		return None
 
 	@property
 	def targetObject(self) -> IAccessible:
@@ -68,25 +71,24 @@ def __bool__(self) -> bool:
 		)
 
 	@property
-	def targets(self) -> Iterable[MozAnnotationTarget]:
+	def targets(self) -> Generator[MozAnnotationTarget, None, None]:
 		detailsRelations = self._originObj.detailsRelations
 		for rel in detailsRelations:
 			yield MozAnnotationTarget(rel)
 
 	@property
-	def roles(self) -> Iterable[controlTypes.Role]:
+	def roles(self) -> Generator[Optional[controlTypes.Role], None, None]:
 		# Unlike base Ia2Web implementation, the details-roles
 		# IA2 attribute is not exposed in Firefox.
 		# Although slower, we have to fetch the details relations instead.
 		for target in self.targets:
-			# just take the first target for now.
 			try:
 				yield target.role
 			except ValueError:
 				log.error("Error getting role.", exc_info=True)
 
 	@property
-	def summaries(self) -> Iterable[str]:
+	def summaries(self) -> Generator[str, None, None]:
 		for target in self.targets:
 			yield target.summary
 
diff --git a/source/annotation.py b/source/annotation.py
@@ -13,7 +13,7 @@
 from dataclasses import dataclass
 from typing import (
 	TYPE_CHECKING,
-	Iterable,
+	Generator,
 	List,
 	Optional,
 	Set,
@@ -35,7 +35,7 @@ class AnnotationTarget:
 	"""
 
 	@property
-	def role(self) -> "controlTypes.Role":
+	def role(self) -> Optional["controlTypes.Role"]:
 		raise NotImplementedError
 
 	@property
@@ -65,15 +65,15 @@ def __bool__(self):
 		raise NotImplementedError
 
 	@property
-	def targets(self) -> Iterable[AnnotationTarget]:
+	def targets(self) -> Generator[AnnotationTarget, None, None]:
 		raise NotImplementedError
 
 	@property
-	def roles(self) -> Iterable["controlTypes.Role"]:
+	def roles(self) -> Generator[Optional["controlTypes.Role"], None, None]:
 		raise NotImplementedError
 
 	@property
-	def summaries(self) -> Iterable[str]:
+	def summaries(self) -> Generator[str, None, None]:
 		raise NotImplementedError
 
 
