robotframework-browserpom 0.5.2__tar.gz → 0.6.1__tar.gz

{robotframework_browserpom-0.5.2 → robotframework_browserpom-0.6.1}/BrowserPOM/__init__.py

@@ -7,6 +7,7 @@ from typing import TYPE_CHECKING, cast
 
 from Browser import Browser
 from Browser.utils import ScreenshotFileTypes, ScreenshotReturnType
+from robot.api import logger
 from robot.api.deco import keyword
 from robot.libraries.BuiltIn import BuiltIn, RobotNotRunningError
 
@@ -121,7 +122,7 @@ class BrowserPOM(Browser):
         Optional arguments are passed to the
         [https://robotframework-browser.org/|BrowserLibrary] constructor.
         """
-        addon_path = Path(__file__).parent / "addons" / "playwright_page_method.js"
+        addon_path = Path(__file__).parent / "addons" / "filter_locator.js"
         with contextlib.suppress(RobotNotRunningError):
             BuiltIn().set_library_search_order("BrowserPOM", "Browser")
 
@@ -135,7 +136,25 @@ class BrowserPOM(Browser):
         kwargs["jsextension"] = jsextensions
 
         browser_init = cast("Callable[..., None]", super().__init__)
-        browser_init(*args, **kwargs)
+        try:
+            browser_init(*args, **kwargs)
+        except Exception as error:  # noqa: BLE001
+            # Passing a ``jsextension`` makes BrowserLibrary eagerly start the
+            # Playwright Node.js process during ``__init__`` (to register the JS
+            # keywords). When BrowserPOM is only imported so another library or
+            # tool can gather its keywords, that spawn can fail in fork-unsafe
+            # contexts (e.g. grpc already initialised, pabot,
+            # pytest_robotframework), raising errors such as
+            # "TypeError: 'NoneType' object is not callable" from subprocess.
+            # Fall back to a plain init so keyword gathering does not crash the
+            # importing library.
+            logger.warn(
+                "BrowserPOM: failed to load the 'filter_locator' jsextension "
+                f"during import ({error}). The library was initialised without "
+                "it so keyword gathering can continue.",
+            )
+            kwargs["jsextension"] = [extension for extension in jsextensions if extension != str(addon_path)] or None
+            browser_init(*args, **kwargs)
 
     @keyword
     def take_screenshot(self, *args, **kwargs):  # noqa:ANN002,ANN003,ANN201

robotframework_browserpom-0.6.1/BrowserPOM/addons/filter_locator.js

@@ -0,0 +1,25 @@
+async function filterLocator(base_locator, filter_statement, page, logger) {
+    const playwright_function = "(page.locator('" + base_locator + "').filter({" + filter_statement + "}))"
+    logger("Filtering Playwright locator: " + playwright_function)
+    const result = await eval(playwright_function);
+    // If the result is an object we assume it's a locator so we return the _selector property of the locator object
+    if (typeof result == "object") {
+        return result._selector;
+    } else {
+        return result;
+    }
+}
+
+filterLocator.rfdoc = `
+This keyword returns a Playwright locator with the given filter applied.
+
+Parameters:
+base_locator : (string) The locator on which the filter should be applied.
+filter_statement : (string) The filter to apply, e.g. 'hasText: "foo"'
+
+Example
+| Filter Locator  //li    hasText: "foo"
+`
+
+exports.__esModule = true;
+exports.filterLocator = filterLocator;

{robotframework_browserpom-0.5.2 → robotframework_browserpom-0.6.1}/BrowserPOM/uiobject.py

@@ -71,10 +71,7 @@ class UIObject:
 
         """
         base_locator = str(self).replace("'", '"')
-        locator = BuiltIn().run_keyword(
-            "Playwright Page Method",
-            "locator('" + base_locator + "').filter({" + filter_text + "})",
-        )
+        locator = BuiltIn().run_keyword("Filter Locator", base_locator, filter_text)
         return self.__class__(locator)
 
     def self_locator(self) -> str:

{robotframework_browserpom-0.5.2 → robotframework_browserpom-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-browserpom
-Version: 0.5.2
+Version: 0.6.1
 Summary: robotframework-browser library extension to create Page Objects
 Author-email: Hasan Alp Zengin <hasanalpzengin@gmail.com>
 License-File: LICENSE

{robotframework_browserpom-0.5.2 → robotframework_browserpom-0.6.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "robotframework-browserpom"
-version = "0.5.2"
+version = "0.6.1"
 description = "robotframework-browser library extension to create Page Objects"
 authors = [{ name = "Hasan Alp Zengin", email = "hasanalpzengin@gmail.com" }]
 requires-python = ">=3.9,<4.0"
@@ -24,9 +24,10 @@ repository = "https://github.com/hasanalpzengin/robotframework-browserpom"
 [dependency-groups]
 test = [
     "prek>=0.2.19",
-    "pyrefly>=0.44.1",
+    "pyrefly>=1.1.1",
     "pytest_robotframework>=4.3.0,<5",
     "ruff>=0.11.0,<0.12",
+    "robotframework-browser-batteries>=19.9.0",
 ]
 dev = [
     "hatchling",

robotframework_browserpom-0.5.2/BrowserPOM/addons/playwright_page_method.js

@@ -1,52 +0,0 @@
-const path = require('node:path');
-const { expect } = require(path.resolve('node_modules/playwright/test'));
-
-async function playwrightPageMethod(page_method, page, logger) {
-    const playwright_function = '(page.' + page_method + ')';
-    logger("Executing Playwright Page method: " + page_method)
-    const result = await eval(playwright_function);
-    // If the result is an object we assume it's a locator so we return the _selector property of the locator object
-    if (typeof result == "object") {
-        return result._selector;
-    } else {
-        return result;
-    }
-}
-
-async function playwrightJS(statement, page, logger) {
-    const playwright_statement = '(' + statement + ')';
-    logger("Executing Playwright method: " + statement)
-    const result = await eval(playwright_statement);
-    // If the result is an object we assume it's a locator so we return the _selector property of the locator object
-    if (typeof result == "object") {
-        return result._selector;
-    } else {
-        return result;
-    }
-}
-
-playwrightPageMethod.rfdoc = `
-This keyword executes a Playwright Page method. 
-
-Parameters: page_method : (string) The page method to be executed in Playwright.
-
-Example
-| Playwright Page Method  getByRole('link', { name: 'Get started' }).click()
-`
-
-playwrightJS.rfdoc = `
-This keyword executes a JavaScript Playwright statement, which can be page methods including assertions.
-Except for the following assertions which are not supported: 
-| expect(page).toHaveScreenshot()
-| expect(page).toMatchSnapshot()
-
-Parameters: statement : (string) The Playwright statement to be executed.
-
-Example
-| Playwright JS  page.getByRole('link', { name: 'Get started' }).click()
-| Playwright JS  expect(page.getByRole('link', { name: 'Get started' })).toBeVisible()
-`
-
-exports.__esModule = true;
-exports.playwrightPageMethod = playwrightPageMethod;
-exports.playwrightJS = playwrightJS;