initial commit

2026-06-25 21:29:21 +00:00
commit 0d0a7456de
2738 changed files with 542622 additions and 0 deletions
@@ -0,0 +1,32 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+import importlib
+
+_LAZY_SUBMODULES = ["options", "remote_connection", "service", "webdriver"]
+
+
+def __getattr__(name):
+    if name in _LAZY_SUBMODULES:
+        module = importlib.import_module(f".{name}", __name__)
+        globals()[name] = module
+        return module
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+def __dir__():
+    return sorted(_LAZY_SUBMODULES)
@@ -0,0 +1,26 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+"""Type stub with lazy import mapping from __init__.py.
+
+This stub file is necessary for type checkers and IDEs to automatically have
+visibility into lazy modules since they are not imported immediately at runtime.
+"""
+
+from . import options, remote_connection, service, webdriver
+
+__all__ = ["options", "remote_connection", "service", "webdriver"]
@@ -0,0 +1,59 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from selenium.webdriver.chromium.options import ChromiumOptions
+from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
+
+
+class Options(ChromiumOptions):
+    KEY = "ms:edgeOptions"
+
+    def __init__(self) -> None:
+        """Initialize EdgeOptions with default settings."""
+        super().__init__()
+        self._use_webview = False
+
+    @property
+    def use_webview(self) -> bool:
+        """Returns Whether WebView2 is enabled for Edge browser."""
+        return self._use_webview
+
+    @use_webview.setter
+    def use_webview(self, value: bool) -> None:
+        """Enables or disables WebView2 support for Edge browser.
+
+        Args:
+            value: True to enable WebView2 support, False to disable.
+        """
+        self._use_webview = bool(value)
+
+    def to_capabilities(self) -> dict:
+        """Creates a capabilities with all the options that have been set.
+
+        Returns:
+            A dictionary with all set options for Edge browser.
+        """
+        caps = super().to_capabilities()
+        if self._use_webview:
+            caps["browserName"] = "webview2"
+
+        return caps
+
+    @property
+    def default_capabilities(self) -> dict:
+        """Returns the default capabilities for Edge browser."""
+        return DesiredCapabilities.EDGE.copy()
@@ -0,0 +1,41 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+
+from selenium.webdriver.chromium.remote_connection import ChromiumRemoteConnection
+from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
+from selenium.webdriver.remote.client_config import ClientConfig
+
+
+class EdgeRemoteConnection(ChromiumRemoteConnection):
+    browser_name = DesiredCapabilities.EDGE["browserName"]
+
+    def __init__(
+        self,
+        remote_server_addr: str,
+        keep_alive: bool = True,
+        ignore_proxy: bool = False,
+        client_config: ClientConfig | None = None,
+    ) -> None:
+        super().__init__(
+            remote_server_addr=remote_server_addr,
+            vendor_prefix="ms",
+            browser_name=EdgeRemoteConnection.browser_name,
+            keep_alive=keep_alive,
+            ignore_proxy=ignore_proxy,
+            client_config=client_config,
+        )
@@ -0,0 +1,77 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from collections.abc import Mapping, Sequence
+from typing import IO, Any
+
+from selenium.webdriver.chromium import service
+
+
+class Service(service.ChromiumService):
+    """Service class responsible for starting and stopping msedgedriver.
+
+    Args:
+        executable_path: Install path of the msedgedriver executable, defaults to `msedgedriver`.
+        port: Port for the service to run on, defaults to 0 where the operating system will decide.
+        log_output: (Optional) int representation of STDOUT/DEVNULL, any IO instance or String path to file.
+        service_args: (Optional) Sequence of args to be passed to the subprocess when launching the executable.
+        env: (Optional) Mapping of environment variables for the new process, defaults to `os.environ`.
+        driver_path_env_key: (Optional) Environment variable to use to get the path to the driver executable.
+    """
+
+    def __init__(
+        self,
+        executable_path: str | None = None,
+        port: int = 0,
+        log_output: int | str | IO[Any] | None = None,
+        service_args: Sequence[str] | None = None,
+        env: Mapping[str, str] | None = None,
+        driver_path_env_key: str | None = None,
+        **kwargs,
+    ) -> None:
+        """Initialize Edge service with the specified parameters."""
+        self._service_args = list(service_args or [])
+        driver_path_env_key = driver_path_env_key or "SE_EDGEDRIVER"
+
+        super().__init__(
+            executable_path=executable_path,
+            port=port,
+            service_args=service_args,
+            log_output=log_output,
+            env=env,
+            driver_path_env_key=driver_path_env_key,
+            **kwargs,
+        )
+
+    @property
+    def service_args(self) -> Sequence[str]:
+        """Returns the sequence of service arguments."""
+        return self._service_args
+
+    @service_args.setter
+    def service_args(self, value: Sequence[str]):
+        """Sets the service arguments for the Edge driver.
+
+        Args:
+            value: A sequence of strings representing service arguments.
+
+        Raises:
+            TypeError: If value is not a sequence or is a string.
+        """
+        if isinstance(value, str) or not isinstance(value, Sequence):
+            raise TypeError("service_args must be a sequence")
+        self._service_args = list(value)
@@ -0,0 +1,51 @@
+# Licensed to the Software Freedom Conservancy (SFC) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The SFC licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from selenium.webdriver.chromium.webdriver import ChromiumDriver
+from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
+from selenium.webdriver.edge.options import Options
+from selenium.webdriver.edge.service import Service
+
+
+class WebDriver(ChromiumDriver):
+    """Controls the MSEdgeDriver and allows you to drive the browser."""
+
+    def __init__(
+        self,
+        options: Options | None = None,
+        service: Service | None = None,
+        keep_alive: bool = True,
+    ) -> None:
+        """Creates a new instance of the edge driver.
+
+        Starts the service and then creates new instance of edge driver.
+
+        Args:
+            options: Instance of Options.
+            service: Service object for handling the browser driver if you need to pass extra details.
+            keep_alive: Whether to configure EdgeRemoteConnection to use HTTP keep-alive.
+        """
+        self.service = service if service else Service()
+        self.options = options if options else Options()
+
+        super().__init__(
+            browser_name=DesiredCapabilities.EDGE["browserName"],
+            vendor_prefix="ms",
+            options=self.options,
+            service=self.service,
+            keep_alive=keep_alive,
+        )