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

osn_selenium/flags/chrome.py

@@ -0,0 +1,259 @@
+from typing import Dict, Optional
+from osn_selenium._typehints import PATH_TYPEHINT
+from selenium.webdriver.chrome.options import Options
+from osn_selenium.flags.blink import BlinkFlagsManager
+from osn_selenium.flags.models.blink import BlinkFeatures
+from osn_selenium.flags.models.base import (
+	FlagDefinition,
+	FlagType
+)
+from osn_selenium.flags.models.chrome import (
+	ChromeArguments,
+	ChromeAttributes,
+	ChromeExperimentalOptions,
+	ChromeFlags
+)
+
+
+__all__ = ["ChromeFlagsManager"]
+
+
+class ChromeFlagsManager(BlinkFlagsManager):
+	"""
+	Manages Chrome Browser-specific options for Selenium WebDriver.
+
+	This class extends BrowserOptionsManager to provide specific configurations
+	for Chrome Browser options, such as experimental options and arguments.
+
+	Attributes:
+	"""
+	
+	def __init__(
+			self,
+			browser_exe: Optional[PATH_TYPEHINT] = None,
+			start_page_url: Optional[str] = None,
+			flags_types: Optional[Dict[str, FlagType]] = None,
+			flags_definitions: Optional[Dict[str, FlagDefinition]] = None
+	):
+		"""
+		Initializes ChromeOptionsManager.
+
+		Sets up the Chrome Browser options manager with specific option configurations for
+		debugging port, user agent, proxy, and BiDi protocol.
+		"""
+		
+		yandex_flags_types = {}
+		
+		if flags_types is not None:
+			yandex_flags_types.update(flags_types)
+		
+		yandex_flags_definitions = {}
+		
+		if flags_definitions is not None:
+			yandex_flags_definitions.update(flags_definitions)
+		
+		super().__init__(
+				browser_exe=browser_exe,
+				start_page_url=start_page_url,
+				flags_types=yandex_flags_types,
+				flags_definitions=yandex_flags_definitions,
+		)
+	
+	def _build_options_arguments(self, options: Options) -> Options:
+		"""
+		Adds configured command-line arguments to the WebDriver options.
+
+		Args:
+			options (Options): The WebDriver options object.
+
+		Returns:
+			Options: The modified WebDriver options object.
+		"""
+		
+		return super()._build_options_arguments(options)
+	
+	def _build_options_attributes(self, options: Options) -> Options:
+		"""
+		Applies configured attributes to the WebDriver options.
+
+		Args:
+			options (Options): The WebDriver options object.
+
+		Returns:
+			Options: The modified WebDriver options object.
+		"""
+		
+		return super()._build_options_attributes(options)
+	
+	def _build_options_blink_features(self, options: Options) -> Options:
+		"""
+		Adds configured Chrome features (`--enable-blink-features` and `--disable-blink-features`) to the WebDriver options.
+
+		Args:
+			options (Options): The WebDriver options object to modify.
+
+		Returns:
+			Options: The modified WebDriver options object.
+		"""
+		
+		return super()._build_options_blink_features(options)
+	
+	def _build_options_experimental_options(self, options: Options) -> Options:
+		"""
+		Adds experimental options to the WebDriver options.
+
+		Args:
+			options (Options): The WebDriver options object.
+
+		Returns:
+			Options: The modified WebDriver options object.
+		"""
+		
+		return super()._build_options_experimental_options(options)
+	
+	def _renew_webdriver_options(self) -> Options:
+		"""
+		Creates and returns a new Options object.
+
+		Returns a fresh instance of `webdriver.ChromeOptions`, as Chrome Browser is based on Chromium,
+		allowing for a clean state of browser options to be configured.
+
+		Returns:
+			Options: A new Selenium Chrome Browser options object, based on ChromeOptions.
+		"""
+		
+		return Options()
+	
+	def set_arguments(self, arguments: ChromeArguments):
+		"""
+		Clears existing and sets new command-line arguments from a dictionary.
+
+		Args:
+			arguments (ChromeArguments): A dictionary of arguments to set.
+
+		Raises:
+			ValueError: If an unknown argument key is provided.
+		"""
+		
+		super().set_arguments(arguments)
+	
+	def set_attributes(self, attributes: ChromeAttributes):
+		"""
+		Clears existing and sets new browser attributes from a dictionary.
+
+		Args:
+			attributes (ChromeAttributes): A dictionary of attributes to set.
+
+		Raises:
+			ValueError: If an unknown attribute key is provided.
+		"""
+		
+		super().set_attributes(attributes)
+	
+	def set_blink_features(self, blink_features: BlinkFeatures):
+		"""
+		Clears existing and sets new Chrome features from a dictionary.
+
+		Args:
+			blink_features (BlinkFeatures): A dictionary of Chrome features to set.
+
+		Raises:
+			ValueError: If an unknown Chrome feature key is provided.
+		"""
+		
+		super().set_blink_features(blink_features)
+	
+	def set_experimental_options(self, experimental_options: ChromeExperimentalOptions):
+		"""
+		Clears existing and sets new experimental options from a dictionary.
+
+		Args:
+			experimental_options (ChromeExperimentalOptions): A dictionary of experimental options to set.
+
+		Raises:
+			ValueError: If an unknown experimental option key is provided.
+		"""
+		
+		super().set_experimental_options(experimental_options)
+	
+	def set_flags(self, flags: ChromeFlags):
+		"""
+		Clears all existing flags and sets new ones, including Chrome features.
+
+		This method delegates to the parent `set_flags` method, allowing it to handle
+		all flag types defined in this manager, including 'arguments', 'experimental_options',
+		'attributes', and 'blink_features'.
+
+		Args:
+			flags (ChromeFlags): A dictionary where keys are flag types
+				and values are dictionaries of flags to set for that type.
+		"""
+		
+		super().set_flags(flags)
+	
+	def update_arguments(self, arguments: ChromeArguments):
+		"""
+		Updates command-line arguments from a dictionary without clearing existing ones.
+
+		Args:
+			arguments (ChromeArguments): A dictionary of arguments to set or update.
+
+		Raises:
+			ValueError: If an unknown argument key is provided.
+		"""
+		
+		super().update_arguments(arguments)
+	
+	def update_attributes(self, attributes: ChromeAttributes):
+		"""
+		Updates browser attributes from a dictionary without clearing existing ones.
+
+		Args:
+			attributes (ChromeAttributes): A dictionary of attributes to set or update.
+
+		Raises:
+			ValueError: If an unknown attribute key is provided.
+		"""
+		
+		super().update_attributes(attributes)
+	
+	def update_blink_features(self, blink_features: BlinkFeatures):
+		"""
+		Updates Chrome features from a dictionary without clearing existing ones.
+
+		Args:
+			blink_features (BlinkFeatures): A dictionary of Chrome features to set or update.
+
+		Raises:
+			ValueError: If an unknown Chrome feature key is provided.
+		"""
+		
+		super().update_blink_features(blink_features)
+	
+	def update_experimental_options(self, experimental_options: ChromeExperimentalOptions):
+		"""
+		Updates experimental options from a dictionary without clearing existing ones.
+
+		Args:
+			experimental_options (ChromeExperimentalOptions): A dictionary of experimental options to set or update.
+
+		Raises:
+			ValueError: If an unknown experimental option key is provided.
+		"""
+		
+		super().update_experimental_options(experimental_options)
+	
+	def update_flags(self, flags: ChromeFlags):
+		"""
+		Updates all flags, including Chrome features, without clearing existing ones.
+
+		This method delegates to the parent `update_flags` method, allowing it to handle
+		all flag types defined in this manager, including 'arguments', 'experimental_options',
+		'attributes', and 'blink_features'.
+
+		Args:
+			flags (ChromeFlags): A dictionary where keys are flag types
+				and values are dictionaries of flags to update for that type.
+		"""
+		
+		super().update_flags(flags)

osn_selenium/flags/edge.py

@@ -0,0 +1,259 @@
+from typing import Dict, Optional
+from osn_selenium._typehints import PATH_TYPEHINT
+from selenium.webdriver.chrome.options import Options
+from osn_selenium.flags.blink import BlinkFlagsManager
+from osn_selenium.flags.models.blink import BlinkFeatures
+from osn_selenium.flags.models.base import (
+	FlagDefinition,
+	FlagType
+)
+from osn_selenium.flags.models.edge import (
+	EdgeArguments,
+	EdgeAttributes,
+	EdgeExperimentalOptions,
+	EdgeFlags
+)
+
+
+__all__ = ["EdgeFlagsManager"]
+
+
+class EdgeFlagsManager(BlinkFlagsManager):
+	"""
+	Manages Edge Browser-specific options for Selenium WebDriver.
+
+	This class extends BrowserOptionsManager to provide specific configurations
+	for Edge Browser options, such as experimental options and arguments.
+
+	Attributes:
+	"""
+	
+	def __init__(
+			self,
+			browser_exe: Optional[PATH_TYPEHINT] = None,
+			start_page_url: Optional[str] = None,
+			flags_types: Optional[Dict[str, FlagType]] = None,
+			flags_definitions: Optional[Dict[str, FlagDefinition]] = None
+	):
+		"""
+		Initializes EdgeOptionsManager.
+
+		Sets up the Edge Browser options manager with specific option configurations for
+		debugging port, user agent, proxy, and BiDi protocol.
+		"""
+		
+		yandex_flags_types = {}
+		
+		if flags_types is not None:
+			yandex_flags_types.update(flags_types)
+		
+		yandex_flags_definitions = {}
+		
+		if flags_definitions is not None:
+			yandex_flags_definitions.update(flags_definitions)
+		
+		super().__init__(
+				browser_exe=browser_exe,
+				start_page_url=start_page_url,
+				flags_types=yandex_flags_types,
+				flags_definitions=yandex_flags_definitions,
+		)
+	
+	def _build_options_arguments(self, options: Options) -> Options:
+		"""
+		Adds configured command-line arguments to the WebDriver options.
+
+		Args:
+			options (Options): The WebDriver options object.
+
+		Returns:
+			Options: The modified WebDriver options object.
+		"""
+		
+		return super()._build_options_arguments(options)
+	
+	def _build_options_attributes(self, options: Options) -> Options:
+		"""
+		Applies configured attributes to the WebDriver options.
+
+		Args:
+			options (Options): The WebDriver options object.
+
+		Returns:
+			Options: The modified WebDriver options object.
+		"""
+		
+		return super()._build_options_attributes(options)
+	
+	def _build_options_blink_features(self, options: Options) -> Options:
+		"""
+		Adds configured Edge features (`--enable-blink-features` and `--disable-blink-features`) to the WebDriver options.
+
+		Args:
+			options (Options): The WebDriver options object to modify.
+
+		Returns:
+			Options: The modified WebDriver options object.
+		"""
+		
+		return super()._build_options_blink_features(options)
+	
+	def _build_options_experimental_options(self, options: Options) -> Options:
+		"""
+		Adds experimental options to the WebDriver options.
+
+		Args:
+			options (Options): The WebDriver options object.
+
+		Returns:
+			Options: The modified WebDriver options object.
+		"""
+		
+		return super()._build_options_experimental_options(options)
+	
+	def _renew_webdriver_options(self) -> Options:
+		"""
+		Creates and returns a new Options object.
+
+		Returns a fresh instance of `webdriver.EdgeOptions`, as Edge Browser is based on Chromium,
+		allowing for a clean state of browser options to be configured.
+
+		Returns:
+			Options: A new Selenium Edge Browser options object, based on EdgeOptions.
+		"""
+		
+		return Options()
+	
+	def set_arguments(self, arguments: EdgeArguments):
+		"""
+		Clears existing and sets new command-line arguments from a dictionary.
+
+		Args:
+			arguments (EdgeArguments): A dictionary of arguments to set.
+
+		Raises:
+			ValueError: If an unknown argument key is provided.
+		"""
+		
+		super().set_arguments(arguments)
+	
+	def set_attributes(self, attributes: EdgeAttributes):
+		"""
+		Clears existing and sets new browser attributes from a dictionary.
+
+		Args:
+			attributes (EdgeAttributes): A dictionary of attributes to set.
+
+		Raises:
+			ValueError: If an unknown attribute key is provided.
+		"""
+		
+		super().set_attributes(attributes)
+	
+	def set_blink_features(self, blink_features: BlinkFeatures):
+		"""
+		Clears existing and sets new Edge features from a dictionary.
+
+		Args:
+			blink_features (BlinkFeatures): A dictionary of Edge features to set.
+
+		Raises:
+			ValueError: If an unknown Edge feature key is provided.
+		"""
+		
+		super().set_blink_features(blink_features)
+	
+	def set_experimental_options(self, experimental_options: EdgeExperimentalOptions):
+		"""
+		Clears existing and sets new experimental options from a dictionary.
+
+		Args:
+			experimental_options (EdgeExperimentalOptions): A dictionary of experimental options to set.
+
+		Raises:
+			ValueError: If an unknown experimental option key is provided.
+		"""
+		
+		super().set_experimental_options(experimental_options)
+	
+	def set_flags(self, flags: EdgeFlags):
+		"""
+		Clears all existing flags and sets new ones, including Edge features.
+
+		This method delegates to the parent `set_flags` method, allowing it to handle
+		all flag types defined in this manager, including 'arguments', 'experimental_options',
+		'attributes', and 'blink_features'.
+
+		Args:
+			flags (EdgeFlags): A dictionary where keys are flag types
+				and values are dictionaries of flags to set for that type.
+		"""
+		
+		super().set_flags(flags)
+	
+	def update_arguments(self, arguments: EdgeArguments):
+		"""
+		Updates command-line arguments from a dictionary without clearing existing ones.
+
+		Args:
+			arguments (EdgeArguments): A dictionary of arguments to set or update.
+
+		Raises:
+			ValueError: If an unknown argument key is provided.
+		"""
+		
+		super().update_arguments(arguments)
+	
+	def update_attributes(self, attributes: EdgeAttributes):
+		"""
+		Updates browser attributes from a dictionary without clearing existing ones.
+
+		Args:
+			attributes (EdgeAttributes): A dictionary of attributes to set or update.
+
+		Raises:
+			ValueError: If an unknown attribute key is provided.
+		"""
+		
+		super().update_attributes(attributes)
+	
+	def update_blink_features(self, blink_features: BlinkFeatures):
+		"""
+		Updates Edge features from a dictionary without clearing existing ones.
+
+		Args:
+			blink_features (BlinkFeatures): A dictionary of Edge features to set or update.
+
+		Raises:
+			ValueError: If an unknown Edge feature key is provided.
+		"""
+		
+		super().update_blink_features(blink_features)
+	
+	def update_experimental_options(self, experimental_options: EdgeExperimentalOptions):
+		"""
+		Updates experimental options from a dictionary without clearing existing ones.
+
+		Args:
+			experimental_options (EdgeExperimentalOptions): A dictionary of experimental options to set or update.
+
+		Raises:
+			ValueError: If an unknown experimental option key is provided.
+		"""
+		
+		super().update_experimental_options(experimental_options)
+	
+	def update_flags(self, flags: EdgeFlags):
+		"""
+		Updates all flags, including Edge features, without clearing existing ones.
+
+		This method delegates to the parent `update_flags` method, allowing it to handle
+		all flag types defined in this manager, including 'arguments', 'experimental_options',
+		'attributes', and 'blink_features'.
+
+		Args:
+			flags (EdgeFlags): A dictionary where keys are flag types
+				and values are dictionaries of flags to update for that type.
+		"""
+		
+		super().update_flags(flags)

osn_selenium/flags/models/__init__.py

@@ -0,0 +1 @@
+

osn_selenium/flags/models/base.py

@@ -0,0 +1,130 @@
+from pydantic import Field
+from osn_selenium.models import (
+	DictModel,
+	ExtraDictModel
+)
+from typing import (
+	Any,
+	Callable,
+	List,
+	Literal,
+	Optional
+)
+from osn_selenium.flags._typehints import (
+	ANY_WEBDRIVER_OPTION_TYPEHINT
+)
+
+
+__all__ = [
+	"BrowserArguments",
+	"BrowserAttributes",
+	"BrowserExperimentalOptions",
+	"BrowserFlags",
+	"FlagDefinition",
+	"FlagNotDefined",
+	"FlagType",
+	"FlagTypeNotDefined"
+]
+
+
+class FlagTypeNotDefined:
+	"""
+	Sentinel indicating missing flag type definition.
+	"""
+	
+	pass
+
+
+class FlagDefinition(DictModel):
+	"""
+	Defines a browser flag with name, command, type, and how it is applied.
+
+	Attributes:
+		name (str): Internal name of the flag.
+		command (str): Command-line argument or key.
+		type (Literal): Category of the flag (e.g., argument, attribute).
+		mode (Literal): How the flag is applied (e.g., startup, webdriver).
+		adding_validation_function (Callable): Validator function for the value.
+	"""
+	
+	name: str
+	command: str
+	type: Literal["argument", "experimental_option", "attribute", "blink_feature"]
+	mode: Literal["webdriver_option", "startup_argument", "both"]
+	adding_validation_function: Callable[[Any], bool]
+
+
+class FlagType(DictModel):
+	"""
+	Represents callable interfaces for setting and managing browser flags.
+
+	Attributes:
+		set_flag_function (Callable): Function to set a single flag.
+		remove_flag_function (Callable): Function to remove a flag.
+		set_flags_function (Callable): Function to set multiple flags.
+		update_flags_function (Callable): Function to update multiple flags.
+		clear_flags_function (Callable): Function to clear all flags.
+		build_options_function (Callable): Builds webdriver options.
+		build_start_args_function (Callable): Builds command-line arguments.
+	"""
+	
+	set_flag_function: Callable[[FlagDefinition, Any], None]
+	remove_flag_function: Callable[[str], None]
+	set_flags_function: Callable[[ExtraDictModel], None]
+	update_flags_function: Callable[[ExtraDictModel], None]
+	clear_flags_function: Callable[..., None]
+	build_options_function: Callable[[ANY_WEBDRIVER_OPTION_TYPEHINT], ANY_WEBDRIVER_OPTION_TYPEHINT]
+	build_start_args_function: Callable[..., List[str]]
+
+
+class FlagNotDefined:
+	"""
+	A sentinel class to indicate that a flag definition was not found.
+	"""
+	
+	pass
+
+
+class BrowserAttributes(ExtraDictModel):
+	"""
+	WebDriver attributes for browser.
+
+	Attributes:
+		enable_bidi (Optional[bool]): Enable/disable BiDi protocol.
+	"""
+	
+	enable_bidi: Optional[bool] = None
+
+
+class BrowserExperimentalOptions(ExtraDictModel):
+	"""
+	WebDriver experimental options for browser.
+	"""
+	
+	pass
+
+
+class BrowserArguments(ExtraDictModel):
+	"""
+	WebDriver command-line arguments.
+
+	Attributes:
+		se_downloads_enabled (Optional[bool]): Enable Selenium downloads.
+	"""
+	
+	se_downloads_enabled: Optional[bool] = None
+
+
+class BrowserFlags(DictModel):
+	"""
+	Combined structure of all browser flags.
+
+	Attributes:
+		argument (BrowserArguments): Command-line arguments.
+		experimental_option (BrowserExperimentalOptions): Experimental options.
+		attribute (BrowserAttributes): WebDriver attributes.
+	"""
+	
+	argument: BrowserArguments = Field(default_factory=BrowserArguments)
+	experimental_option: BrowserExperimentalOptions = Field(default_factory=BrowserExperimentalOptions)
+	attribute: BrowserAttributes = Field(default_factory=BrowserAttributes)