Add new class PromptDismissedException

secretstorage/collection.py

@@ -19,7 +19,8 @@
 from jeepney.integrate.blocking import DBusConnection
 from secretstorage.defines import SS_PREFIX, SS_PATH
 from secretstorage.dhcrypto import Session
-from secretstorage.exceptions import LockedException, ItemNotFoundException
+from secretstorage.exceptions import LockedException, ItemNotFoundException, \
+ PromptDismissedException
 from secretstorage.item import Item
 from secretstorage.util import DBusAddressWrapper, exec_prompt, \
  format_secret, open_session, unlock_objects
@@ -122,8 +123,10 @@ def create_item(self, label: str, attributes: Dict[str, str],
 def create_collection(connection: DBusConnection, label: str, alias: str = '',
                       session: Optional[Session] = None) -> Collection:
 	"""Creates a new :class:`Collection` with the given `label` and `alias`
-	and returns it. This action requires prompting. If prompt is dismissed,
-	raises :exc:`~secretstorage.exceptions.ItemNotFoundException`.
+	and returns it. This action requires prompting.
+
+	:raises: :exc:`~secretstorage.exceptions.PromptDismissedException`
+	         if the prompt is dismissed.
 	"""
 	if not session:
 		session = open_session(connection)
@@ -135,7 +138,7 @@ def create_collection(connection: DBusConnection, label: str, alias: str = '',
 		return Collection(connection, collection_path, session=session)
 	dismissed, result = exec_prompt(connection, prompt)
 	if dismissed:
-		raise ItemNotFoundException('Prompt dismissed.')
+		raise PromptDismissedException('Prompt dismissed.')
 	signature, collection_path = result
 	assert signature == 'o'
 	return Collection(connection, collection_path, session=session)

secretstorage/exceptions.py

@@ -36,8 +36,10 @@ class ItemNotFoundException(SecretStorageException):
 	...     print('Item not found!')
 	... 
 	Item not found!
+	"""
+
+class PromptDismissedException(ItemNotFoundException):
+	"""Raised when a prompt was dismissed by the user.
 
-	Also, :func:`~secretstorage.collection.create_collection` may raise
-	this exception when a prompt was dismissed during creating the
-	collection.
+	.. versionadded:: 3.1
 	"""