osn-selenium 0.0.0__py3-none-any.whl → 1.0.0__py3-none-any.whl

osn_selenium/abstract/instances/dialog.py

@@ -0,0 +1,107 @@
+from abc import ABC, abstractmethod
+from typing import Optional, Sequence
+from selenium.webdriver.common.fedcm.account import Account
+from selenium.webdriver.common.fedcm.dialog import (
+	Dialog as legacyDialog
+)
+
+
+__all__ = ["AbstractDialog"]
+
+
+class AbstractDialog(ABC):
+	"""
+	Abstract base class for a FedCM (Federated Credential Management) dialog.
+
+	Defines the interface for interacting with a FedCM dialog, such as
+	retrieving accounts, selecting an account, and dismissing or accepting the dialog.
+	"""
+	
+	@abstractmethod
+	def accept(self) -> None:
+		"""
+		Accepts the dialog.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def dismiss(self) -> None:
+		"""
+		Dismisses the dialog.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def get_accounts(self) -> Sequence[Account]:
+		"""
+		Gets the list of accounts displayed in the dialog.
+
+		Returns:
+			Sequence[Account]: A sequence of Account objects.
+		"""
+		
+		...
+	
+	@property
+	@abstractmethod
+	def legacy(self) -> legacyDialog:
+		"""
+		Returns the underlying legacy Selenium Dialog instance.
+
+		This provides a way to access the original Selenium object for operations
+		not covered by this abstract interface.
+
+		Returns:
+			legacyDialog: The legacy Selenium Dialog object.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def select_account(self, index: int) -> None:
+		"""
+		Selects an account from the list in the dialog.
+
+		Args:
+			index (int): The index of the account to select.
+		"""
+		
+		...
+	
+	@property
+	@abstractmethod
+	def subtitle(self) -> Optional[str]:
+		"""
+		The subtitle of the dialog.
+
+		Returns:
+			Optional[str]: The dialog subtitle, or None if not available.
+		"""
+		
+		...
+	
+	@property
+	@abstractmethod
+	def title(self) -> str:
+		"""
+		The title of the dialog.
+
+		Returns:
+			str: The dialog title.
+		"""
+		
+		...
+	
+	@property
+	@abstractmethod
+	def type(self) -> Optional[str]:
+		"""
+		The type of the dialog.
+
+		Returns:
+			Optional[str]: The dialog type, or None if not available.
+		"""
+		
+		...

osn_selenium/abstract/instances/fedcm.py

@@ -0,0 +1,133 @@
+from abc import ABC, abstractmethod
+from typing import (
+	Mapping,
+	Optional,
+	Sequence
+)
+from selenium.webdriver.remote.fedcm import FedCM as legacyFedCM
+
+
+__all__ = ["AbstractFedCM"]
+
+
+class AbstractFedCM(ABC):
+	"""
+	Abstract base class for Federated Credential Management (FedCM) API.
+
+	Defines the interface for interacting with the FedCM dialog, managing accounts,
+	and controlling cooldown periods.
+	"""
+	
+	@abstractmethod
+	def accept(self) -> None:
+		"""
+		Accepts the FedCM dialog, typically confirming the selected account.
+		"""
+		
+		...
+	
+	@property
+	@abstractmethod
+	def account_list(self) -> Sequence[Mapping]:
+		"""
+		The list of accounts displayed in the FedCM dialog.
+
+		Returns:
+			Sequence[Mapping]: A sequence of dictionaries, each representing an account.
+		"""
+		
+		...
+	
+	@property
+	@abstractmethod
+	def dialog_type(self) -> str:
+		"""
+		The type of the FedCM dialog.
+
+		Returns:
+			str: The dialog type (e.g., 'AccountChooser', 'AutoReauthn').
+		"""
+		
+		...
+	
+	@abstractmethod
+	def disable_delay(self) -> None:
+		"""
+		Disables the delay for FedCM operations.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def dismiss(self) -> None:
+		"""
+		Dismisses the FedCM dialog.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def enable_delay(self) -> None:
+		"""
+		Enables the delay for FedCM operations, useful for testing.
+		"""
+		
+		...
+	
+	@property
+	@abstractmethod
+	def legacy(self) -> legacyFedCM:
+		"""
+		Returns the underlying legacy Selenium FedCM instance.
+
+		This provides a way to access the original Selenium object for operations
+		not covered by this abstract interface.
+
+		Returns:
+			legacyFedCM: The legacy Selenium FedCM object.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def reset_cooldown(self) -> None:
+		"""
+		Resets the FedCM cooldown timer.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def select_account(self, index: int) -> None:
+		"""
+		Selects an account from the list in the dialog.
+
+		Args:
+			index (int): The index of the account to select.
+		"""
+		
+		...
+	
+	@property
+	@abstractmethod
+	def subtitle(self) -> Optional[str]:
+		"""
+		The subtitle of the FedCM dialog.
+
+		Returns:
+			Optional[str]: The dialog subtitle, or None if it doesn't exist.
+		"""
+		
+		...
+	
+	@property
+	@abstractmethod
+	def title(self) -> str:
+		"""
+		The title of the FedCM dialog.
+
+		Returns:
+			str: The dialog title.
+		"""
+		
+		...

osn_selenium/abstract/instances/mobile.py

@@ -0,0 +1,79 @@
+from typing import Any, Sequence
+from abc import ABC, abstractmethod
+from selenium.webdriver.remote.mobile import (
+	Mobile as legacyMobile
+)
+
+
+__all__ = ["AbstractMobile"]
+
+
+class AbstractMobile(ABC):
+	"""
+	Abstract base class for mobile-specific interactions.
+
+	Defines the interface for managing network connections and contexts
+	in a mobile environment.
+	"""
+	
+	@abstractmethod
+	def context(self) -> str:
+		"""
+		The current context handle.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def contexts(self) -> Sequence[str]:
+		"""
+		A sequence of available context handles.
+		"""
+		
+		...
+	
+	@property
+	@abstractmethod
+	def legacy(self) -> legacyMobile:
+		"""
+		Returns the underlying legacy Selenium Mobile instance.
+
+		This provides a way to access the original Selenium object for operations
+		not covered by this abstract interface.
+
+		Returns:
+			legacyMobile: The legacy Selenium Mobile object.
+		"""
+		
+		...
+	
+	@property
+	@abstractmethod
+	def network_connection(self) -> Any:
+		"""
+		The current network connection type.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def set_context(self, new_context: str) -> None:
+		"""
+		Sets the current context.
+
+		Args:
+			new_context (str): The handle of the context to switch to.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def set_network_connection(self, network: Any) -> None:
+		"""
+		Sets the network connection type.
+
+		Args:
+			network (Any): The network type to set.
+		"""
+		
+		...

osn_selenium/abstract/instances/network.py

@@ -0,0 +1,100 @@
+from abc import ABC, abstractmethod
+from typing import (
+	Any,
+	Callable,
+	Optional,
+	Sequence
+)
+from selenium.webdriver.common.bidi.network import (
+	Network as legacyNetwork
+)
+
+
+__all__ = ["AbstractNetwork"]
+
+
+class AbstractNetwork(ABC):
+	"""
+	Abstract base class for network interception.
+
+	Defines the interface for adding and removing handlers for network events
+	and authentication challenges.
+	"""
+	
+	@abstractmethod
+	def add_auth_handler(self, username: str, password: str) -> None:
+		"""
+		Adds a handler for authentication challenges.
+
+		Args:
+			username (str): The username for authentication.
+			password (str): The password for authentication.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def add_request_handler(
+			self,
+			event: Any,
+			callback: Callable,
+			url_patterns: Optional[Sequence[str]] = None,
+			contexts: Optional[Sequence[str]] = None,
+	) -> None:
+		"""
+		Adds a handler for a network request event.
+
+		Args:
+			event (Any): The network event to listen for.
+			callback (Callable): The function to call when the event occurs.
+			url_patterns (Optional[Sequence[str]]): URL patterns to filter requests.
+			contexts (Optional[Sequence[str]]): Browsing context IDs to filter requests.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def clear_request_handlers(self) -> None:
+		"""
+		Clears all registered network request handlers.
+		"""
+		
+		...
+	
+	@property
+	@abstractmethod
+	def legacy(self) -> legacyNetwork:
+		"""
+		Returns the underlying legacy Selenium Network instance.
+
+		This provides a way to access the original Selenium object for operations
+		not covered by this abstract interface.
+
+		Returns:
+			legacyNetwork: The legacy Selenium Network object.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def remove_auth_handler(self, callback_id: str) -> None:
+		"""
+		Removes an authentication handler.
+
+		Args:
+			callback_id (str): The ID of the handler to remove.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def remove_request_handler(self, event: Any, callback_id: str) -> None:
+		"""
+		Removes a network request handler.
+
+		Args:
+			event (Any): The network event to stop listening to.
+			callback_id (str): The ID of the handler to remove.
+		"""
+		
+		...

osn_selenium/abstract/instances/permissions.py

@@ -0,0 +1,52 @@
+from typing import Optional, Union
+from abc import ABC, abstractmethod
+from selenium.webdriver.common.bidi.permissions import (
+	PermissionDescriptor,
+	Permissions as legacyPermissions
+)
+
+
+__all__ = ["AbstractPermissions"]
+
+
+class AbstractPermissions(ABC):
+	"""
+	Abstract base class for managing browser permissions.
+
+	Defines the interface for setting permission states for various APIs.
+	"""
+	
+	@property
+	@abstractmethod
+	def legacy(self) -> legacyPermissions:
+		"""
+		Returns the underlying legacy Selenium Permissions instance.
+
+		This provides a way to access the original Selenium object for operations
+		not covered by this abstract interface.
+
+		Returns:
+			legacyPermissions: The legacy Selenium Permissions object.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def set_permission(
+			self,
+			descriptor: Union[str, PermissionDescriptor],
+			state: str,
+			origin: str,
+			user_context: Optional[str] = None,
+	) -> None:
+		"""
+		Sets the state of a permission.
+
+		Args:
+			descriptor (Union[str, PermissionDescriptor]): The permission descriptor.
+			state (str): The desired state of the permission (e.g., 'granted', 'denied').
+			origin (str): The origin for which to set the permission.
+			user_context (Optional[str]): The user context ID.
+		"""
+		
+		...

osn_selenium/abstract/instances/script.py

@@ -0,0 +1,109 @@
+from abc import ABC, abstractmethod
+from typing import (
+	Any,
+	Callable,
+	Mapping
+)
+from selenium.webdriver.common.bidi.script import (
+	Script as legacyScript
+)
+
+
+__all__ = ["AbstractScript"]
+
+
+class AbstractScript(ABC):
+	"""
+	Abstract base class for script execution and management.
+
+	Defines the interface for executing JavaScript, handling console messages,
+	and managing pinned scripts.
+	"""
+	
+	@abstractmethod
+	def add_console_message_handler(self, handler: Callable) -> None:
+		"""
+		Adds a handler for console messages.
+
+		Args:
+			handler (Callable): The callback function to handle console messages.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def add_javascript_error_handler(self, handler: Callable) -> None:
+		"""
+		Adds a handler for JavaScript errors.
+
+		Args:
+			handler (Callable): The callback function to handle errors.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def execute(self, script: str, *args: Any) -> Mapping:
+		"""
+		Executes a script.
+
+		Args:
+			script (str): The script to execute.
+			*args (Any): Arguments to pass to the script.
+
+		Returns:
+			Mapping: The result of the script execution.
+		"""
+		
+		...
+	
+	@property
+	@abstractmethod
+	def legacy(self) -> legacyScript:
+		"""
+		Returns the underlying legacy Selenium Script instance.
+
+		This provides a way to access the original Selenium object for operations
+		not covered by this abstract interface.
+
+		Returns:
+			legacyScript: The legacy Selenium Script object.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def pin(self, script: str) -> str:
+		"""
+		Pins a script for faster execution.
+
+		Args:
+			script (str): The JavaScript code to pin.
+
+		Returns:
+			str: The ID of the pinned script.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def remove_console_message_handler(self, id: str) -> None:
+		"""
+		Removes a console message handler.
+
+		Args:
+			id (str): The ID of the handler to remove.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def unpin(self, script_id: str) -> None:
+		"""
+		Unpins a previously pinned script.
+
+		Args:
+			script_id (str): The ID of the script to unpin.
+		"""
+		
+		...

osn_selenium/abstract/instances/shadow_root.py

@@ -0,0 +1,81 @@
+from abc import ABC, abstractmethod
+from selenium.webdriver.common.by import By
+from typing import (
+	Optional,
+	Sequence,
+	TYPE_CHECKING
+)
+from selenium.webdriver.remote.shadowroot import (
+	ShadowRoot as legacyShadowRoot
+)
+
+
+__all__ = ["AbstractShadowRoot"]
+
+if TYPE_CHECKING:
+	from osn_selenium.abstract.instances.web_element import AbstractWebElement
+
+
+class AbstractShadowRoot(ABC):
+	"""
+	Abstract base class for a shadow root.
+
+	Defines the interface for finding elements within a shadow DOM.
+	"""
+	
+	@abstractmethod
+	def find_element(self, by: By = By.ID, value: Optional[str] = None) -> "AbstractWebElement":
+		"""
+		Find an element within the shadow root's context.
+
+		Args:
+			by (By): The strategy to use for finding the element.
+			value (Optional[str]): The value of the locator.
+
+		Returns:
+			"AbstractWebElement": The found WebElement.
+		"""
+		
+		...
+	
+	@abstractmethod
+	def find_elements(self, by: By = By.ID, value: Optional[str] = None) -> Sequence["AbstractWebElement"]:
+		"""
+		Find all elements within the shadow root's context.
+
+		Args:
+			by (By): The strategy to use for finding elements.
+			value (Optional[str]): The value of the locator.
+
+		Returns:
+			Sequence["AbstractWebElement"]: A sequence of found WebElements.
+		"""
+		
+		...
+	
+	@property
+	@abstractmethod
+	def id(self) -> str:
+		"""
+		The ID of the shadow root.
+
+		Returns:
+			str: The unique identifier for the shadow root.
+		"""
+		
+		...
+	
+	@property
+	@abstractmethod
+	def legacy(self) -> legacyShadowRoot:
+		"""
+		Returns the underlying legacy Selenium ShadowRoot instance.
+
+		This provides a way to access the original Selenium object for operations
+		not covered by this abstract interface.
+
+		Returns:
+			legacyShadowRoot: The legacy Selenium ShadowRoot object.
+		"""
+		
+		...