Added type hints and Playwright improvements to code

Author: AutomationPanda

pages/result.py

@@ -3,26 +3,22 @@
 the page object for the DuckDuckGo result page.
 """
 
+from playwright.sync_api import Page
+from typing import List
+
+
 class DuckDuckGoResultPage:
 
-    RESULT_LINKS = '.result__title a.result__a'
-    SEARCH_INPUT = '#search_form_input'
-    
-    def __init__(self, page):
+    def __init__(self, page: Page) -> None:
         self.page = page
+        self.result_links = page.locator('.result__title a.result__a')
+        self.search_input = page.locator('#search_form_input')
 
-    def result_link_titles(self):
-        self.page.locator(f'{self.RESULT_LINKS} >> nth=4').wait_for()
-        titles = self.page.locator(self.RESULT_LINKS).all_text_contents()
-        return titles
+    def result_link_titles(self) -> List[str]:
+        self.result_links.nth(4).wait_for()
+        return self.result_links.all_text_contents()
 
-    def result_link_titles_contain_phrase(self, phrase, minimum=1):
+    def result_link_titles_contain_phrase(self, phrase: str, minimum: int = 1) -> bool:
         titles = self.result_link_titles()
         matches = [t for t in titles if phrase.lower() in t.lower()]
         return len(matches) >= minimum
-
-    def search_input_value(self):
-        return self.page.input_value(self.SEARCH_INPUT)
-    
-    def title(self):
-        return self.page.title()

pages/search.py

@@ -3,19 +3,21 @@
 the page object for the DuckDuckGo search page.
 """
 
-class DuckDuckGoSearchPage:
+from playwright.sync_api import Page
+
 
-    SEARCH_BUTTON = '#search_button_homepage'
-    SEARCH_INPUT = '#search_form_input_homepage'
+class DuckDuckGoSearchPage:
 
     URL = 'https://www.duckduckgo.com'
 
-    def __init__(self, page):
+    def __init__(self, page: Page) -> None:
         self.page = page
+        self.search_button = page.locator('#search_button_homepage')
+        self.search_input = page.locator('#search_form_input_homepage')
 
-    def load(self):
+    def load(self) -> None:
         self.page.goto(self.URL)
 
-    def search(self, phrase):
-        self.page.fill(self.SEARCH_INPUT, phrase)
-        self.page.click(self.SEARCH_BUTTON)
+    def search(self, phrase: str) -> None:
+        self.search_input.fill(phrase)
+        self.search_button.click()

tests/conftest.py

@@ -6,13 +6,15 @@
 
 from pages.result import DuckDuckGoResultPage
 from pages.search import DuckDuckGoSearchPage
+from playwright.sync_api import Page
+
 
 
 @pytest.fixture
-def result_page(page):
+def result_page(page: Page) -> DuckDuckGoResultPage:
     return DuckDuckGoResultPage(page)
 
 
 @pytest.fixture
-def search_page(page):
+def search_page(page: Page) -> DuckDuckGoSearchPage:
     return DuckDuckGoSearchPage(page)

tests/test_search.py

@@ -2,10 +2,15 @@
 These tests cover DuckDuckGo searches.
 """
 
+from pages.result import DuckDuckGoResultPage
+from pages.search import DuckDuckGoSearchPage
 from playwright.sync_api import expect, Page
 
 
-def test_basic_duckduckgo_search(search_page, result_page) -> None:
+def test_basic_duckduckgo_search(
+    page: Page,
+    search_page: DuckDuckGoSearchPage,
+    result_page: DuckDuckGoResultPage) -> None:
 
     # Given the DuckDuckGo home page is displayed
     search_page.load()
@@ -14,11 +19,11 @@ def test_basic_duckduckgo_search(search_page, result_page) -> None:
     search_page.search('panda')
 
     # Then the search result query is the phrase
-    assert 'panda' == result_page.search_input_value()
+    expect(result_page.search_input).to_have_value('panda')
 
     # And the search result links pertain to the phrase
     assert result_page.result_link_titles_contain_phrase('panda')
 
     # And the search result title contains the phrase
-    assert 'panda' in result_page.title()
+    expect(page).to_have_title('panda at DuckDuckGo')