Tighten up utils.get_user_agent and add a test

palewire · Dec 22, 2022 · f24ab7d · f24ab7d
1 parent 51d183b
commit f24ab7d
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/newshomepages/utils.py b/newshomepages/utils.py
@@ -193,7 +193,10 @@ def get_extract_df(name: str, **kwargs) -> pd.DataFrame:
 
 
 def get_user_agent() -> str:
-    """Return a user agent string ready to pass to a browser."""
+    """Provide a user-agent string.
+
+    Returns a string ready to use as a header in web request.
+    """
     return "Mozilla/5.0 (Macintosh; Intel Mac OS X 12_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36"
 
 

diff --git a/tests/test_utils.py b/tests/test_utils.py
@@ -41,6 +41,11 @@ def test_get_local_time():
     assert utils.get_local_time(bbc).tzname() == "GMT"
 
 
+def test_get_user_agent():
+    """Test get_user_agent."""
+    assert utils.get_user_agent()
+
+
 def test_sites():
     """Test sites utils."""
     # Read in the list