add a device option to specify device name for convenience

shot_scraper/cli.py

@@ -124,6 +124,16 @@ def cli():
     type=int,
     help="Height of browser window and shot - defaults to the full height of the page",
 )
+@click.option(
+    "-d",
+    "--device",
+    help="Device name. Specify device name will override width height and retina option.",
+)
+@click.option(
+    "device_ratio",
+    "--device-ratio",
+    help="Ratio string(i.e 16:9), use with --device option."
+)
 @click.option(
     "-o",
     "--output",
@@ -207,6 +217,8 @@ def shot(
     output,
     width,
     height,
+    device,
+    device_ratio,
     selectors,
     selectors_all,
     js_selectors,
@@ -269,6 +281,7 @@ def shot(
         "javascript": javascript,
         "width": width,
         "height": height,
+        "device": device,
         "quality": quality,
         "wait": wait,
         "wait_for": wait_for,
@@ -291,6 +304,8 @@ def shot(
             timeout=timeout,
             reduced_motion=reduced_motion,
             bypass_csp=bypass_csp,
+            device=device,
+            device_ratio=device_ratio,
         )
         if interactive or devtools:
             use_existing_page = True
@@ -341,6 +356,8 @@ def _browser_context(
     timeout=None,
     reduced_motion=False,
     bypass_csp=False,
+    device=None,
+    device_ratio=None,
 ):
     browser_kwargs = dict(headless=not interactive, devtools=devtools)
     if browser == "chromium":
@@ -363,6 +380,14 @@ def _browser_context(
         context_args["user_agent"] = user_agent
     if bypass_csp:
         context_args["bypass_csp"] = bypass_csp
+    if device:
+        if device not in p.devices:
+            raise click.BadParameter("Invalid device name, please refer to playwright.devices")
+        device_spec = {**p.devices[device]}
+        if device_ratio:
+            rw, rh = map(int, device_ratio.split(":"))
+            device_spec["viewport"]["height"] = int(device_spec["viewport"]["width"] * rh / rw)
+        context_args.update(device_spec)
     context = browser_obj.new_context(**context_args)
     if timeout:
         context.set_default_timeout(timeout)
@@ -378,6 +403,7 @@ def _browser_context(
     help="Path to JSON authentication context file",
 )
 @click.option("--retina", is_flag=True, help="Use device scale factor of 2")
+@click.option("--device", help="Device name. Specify device name will override retina option")
 @click.option(
     "--timeout",
     type=int,
@@ -412,6 +438,7 @@ def multi(
     config,
     auth,
     retina,
+    device,
     timeout,
     fail_on_error,
     noclobber,
@@ -453,6 +480,7 @@ def multi(
             user_agent=user_agent,
             timeout=timeout,
             reduced_motion=reduced_motion,
+            device=device
         )
         for shot in shots:
             if (
@@ -1008,9 +1036,10 @@ def on_response(response):
     if log_console:
         page.on("console", console_log)
 
-    viewport = {}
     full_page = True
-    if shot.get("width") or shot.get("height"):
+    if shot.get("device"):
+        full_page = False
+    elif shot.get("width") or shot.get("height"):
         viewport = {
             "width": shot.get("width") or 1280,
             "height": shot.get("height") or 720,

shot_scraper/utils.py

@@ -12,7 +12,7 @@ def filename_for_url(url, ext=None, file_exists=file_exists_never):
     ext = ext or "png"
     bits = urllib.parse.urlparse(url)
     filename = (bits.netloc + bits.path).replace(".", "-").replace("/", "-").rstrip("-")
-    # Remove any characters outside of the allowed range
+    # Remove any characters outside the allowed range
     base_filename = disallowed_re.sub("", filename).lstrip("-")
     filename = base_filename + "." + ext
     suffix = 0