F-string formatting, and error standardization (#27)

* fix: f-string and raise ValueError when failing to get url

* fix: exclude extra test code from package

Author: eggplants

.github/workflows/test-macOS-sur.yml

@@ -36,4 +36,4 @@ jobs:
 
     - name: Test with pytest
       run: |
-        pytest pyderman/test.py
+        pytest -vv

.github/workflows/test-macOS.yml

@@ -36,4 +36,4 @@ jobs:
 
     - name: Test with pytest
       run: |
-        pytest pyderman/test.py
+        pytest -vv

.github/workflows/test-ubuntu.yml

@@ -36,4 +36,4 @@ jobs:
 
     - name: Test with pytest
       run: |
-        pytest pyderman/test.py
+        pytest -vv

.github/workflows/test-windows.yml

@@ -36,4 +36,4 @@ jobs:
 
     - name: Test with pytest
       run: |
-        pytest pyderman/test.py
+        pytest -vv

.pre-commit-config.yaml

@@ -53,3 +53,8 @@ repos:
     rev: 'typos-v0.9.0'
     hooks:
       - id: typos
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.31.1
+    hooks:
+      - id: markdownlint
+        args: [--disable=MD013]

README.md

@@ -1,25 +1,9 @@
 # Pyderman (Selenium Web Driver Installer)
 
-[![Ubuntu](
-  https://github.com/shadowmoose/pyderman/workflows/Ubuntu/badge.svg
-  )](
-  https://github.com/shadowmoose/pyderman/actions?query=workflow%3AUbuntu
-) [![MacOS](
-  https://github.com/shadowmoose/pyderman/workflows/MacOS/badge.svg
-  )](
-  https://github.com/shadowmoose/pyderman/actions?query=workflow%3AMacOS
-) [![Windows](
-  https://github.com/shadowmoose/pyderman/workflows/Windows/badge.svg
-  )](
-  https://github.com/shadowmoose/pyderman/actions?query=workflow%3AWindows
-) [![MacOS (SUR)](
-  https://github.com/shadowmoose/pyderman/actions/workflows/test-macOS-sur.yml/badge.svg
-  )](
-  https://github.com/shadowmoose/pyderman/actions/workflows/test-macOS-sur.yml
-)
+[![Ubuntu](https://github.com/shadowmoose/pyderman/workflows/Ubuntu/badge.svg)](https://github.com/shadowmoose/pyderman/actions?query=workflow%3AUbuntu) [![MacOS](https://github.com/shadowmoose/pyderman/workflows/MacOS/badge.svg)](https://github.com/shadowmoose/pyderman/actions?query=workflow%3AMacOS) [![Windows](https://github.com/shadowmoose/pyderman/workflows/Windows/badge.svg)](https://github.com/shadowmoose/pyderman/actions?query=workflow%3AWindows) [![MacOS (SUR)](https://github.com/shadowmoose/pyderman/actions/workflows/test-macOS-sur.yml/badge.svg)](https://github.com/shadowmoose/pyderman/actions/workflows/test-macOS-sur.yml)
 
 This is a fast, simple, dependency-free package that can automatically find & download any version of
-the *Google Chrome (chromeDriver), Firefox (geckoDriver), PhantomJS, Opera (operaDriver), and Edge (edgeDriver)* web drivers.
+the _Google Chrome (chromeDriver), Firefox (geckoDriver), PhantomJS, Opera (operaDriver), and Edge (edgeDriver)_ web drivers.
 
 This project was built to allow developers to seamlessly include selenium support on the user-side, without requiring any manual configuration on their part. It will automatically locate the correct driver binary for the platform & version you choose, as well as setting the os-specific permissions after downloading.
 
@@ -40,22 +24,22 @@ After installed, call it in your code like so:
 ```python
 import pyderman as driver
 path = driver.install(browser=driver.firefox)
-print('Installed geckodriver driver to path: %s' % path)
+print(f"Installed geckodriver driver to path: {path}")
 ```
 
 There are options for the output directory, disabling printout, running chmod on the downloaded executable,
 automatic overwriting, executable file name, and version number.
 All parameters are optional, and the default values are listed below.
 
-This example downloads the Chrome Driver instead, by changing ```browser``` like so:
+This example downloads the Chrome Driver instead, by changing `browser` like so:
 
 ```python
 import pyderman as dr
 path = dr.install(browser=dr.chrome, file_directory='./lib/', verbose=True, chmod=True, overwrite=False, version=None, filename=None, return_info=False)
-print('Installed chromedriver to path: %s' % path)
+print(f"Installed chromedriver to path: {path}")
 ```
 
-The download is very fast, and will skip downloading if the file already exists. This behavior can be toggled with ```overwrite```.
+The download is very fast, and will skip downloading if the file already exists. This behavior can be toggled with `overwrite`.
 
 ## Notes
 
@@ -73,4 +57,4 @@ Apple broke a ton of compatibility moving to Big Sur, and now many of the web dr
 
 ## Why's it called 'Pyderman'?
 
-Because it installs *web*-drivers. [Get it?](https://youtu.be/4o29VoxtsFk)
+Because it installs _web_-drivers. [Get it?](https://youtu.be/4o29VoxtsFk)

pyderman/__init__.py

@@ -60,7 +60,7 @@ def install(
     :return: The absolute path of the downloaded driver, or None if something failed.
     """
     if not _current_os:
-        raise Exception("Cannot determine OS version! [%s]" % platform.system())
+        raise Exception(f"Cannot determine OS version! [{platform.system()}]")
     if not version:
         version = "latest"
     if not browser:
@@ -75,26 +75,23 @@ def install(
         exts = [e for e in [".zip", ".tar.gz", ".tar.bz2"] if url.endswith(e)]
         if len(exts) != 1:
             raise Exception(
-                "Unable to locate file extension in URL: %s (%s)"
-                % (url, ",".join(exts))
+                f"Unable to locate file extension in URL: {url} ({','.join(exts)})"
             )
         archive = exts[0]
 
-        archive_path = join(
-            abspath(file_directory), "{}_{}{}".format(driver, ver, archive)
-        )
-        file_path = join(abspath(file_directory), "{}_{}{}".format(driver, ver, _ext))
+        archive_path = join(abspath(file_directory), f"{driver}_{ver}{archive}")
+        file_path = join(abspath(file_directory), f"{driver}_{ver}{_ext}")
         if filename:
             file_path = join(abspath(file_directory), filename)
 
         if not overwrite and isfile(file_path):
             if verbose:
-                print("%s is already installed." % driver)
+                print(f"{driver} is already installed.")
             return file_path
 
         if not _download(url, archive_path, verbose):
             if verbose:
-                print("Download for %s version failed; Trying alternates." % _os_bit)
+                print(f"Download for {_os_bit} version failed; Trying alternates.")
             continue
 
         out = _extract(archive_path, driver_path, file_path)
@@ -128,7 +125,7 @@ def _extract(path: str, driver_pattern: str, out_file: str) -> str | None:
     out_file = abspath(out_file)
     if not isfile(path):
         return None
-    tmp_path = join(dirname(out_file), "tmp_dl_dir_%s" % basename(path))
+    tmp_path = join(dirname(out_file), f"tmp_dl_dir_{basename(path)}")
     zip_ref: zipfile.ZipFile | tarfile.TarFile | None = None
     namelist: list[str] = []
     if path.endswith(".zip"):

pyderman/drivers/chrome.py

@@ -5,7 +5,7 @@
 from pyderman.util import downloader
 
 _base_version = "https://chromedriver.storage.googleapis.com/LATEST_RELEASE"
-_base_download = "https://chromedriver.storage.googleapis.com/%s/chromedriver_%s%s.zip"
+_base_download = "https://chromedriver.storage.googleapis.com/{version}/chromedriver_{os}{os_bit}.zip"
 
 
 def get_url(
@@ -15,20 +15,20 @@ def get_url(
     if version == "latest":
         resolved_version = downloader.raw(_base_version)
     elif match:
-        major, minor, patch, build = match.groups()
+        major, minor, patch, _build = match.groups()
         if patch:
-            patch_version = "{}.{}.{}".format(major, minor, patch)
+            patch_version = f"{major}.{minor}.{patch}"
         else:
             patch_version = major
-        resolved_version = downloader.raw("{}_{}".format(_base_version, patch_version))
+        resolved_version = downloader.raw(f"{_base_version}_{patch_version}")
     else:
         resolved_version = version
     if not resolved_version:
-        raise Exception("Unable to locate ChromeDriver version: {}!".format(version))
+        raise ValueError(f"Unable to locate ChromeDriver version! [{version}]")
     if _os == "mac-m1":
         _os = "mac"  # chromedriver_mac64_m1
         _os_bit = "%s_m1" % _os_bit
-    download = _base_download % (resolved_version, _os, _os_bit)
+    download = _base_download.format(version=resolved_version, os=_os, os_bit=_os_bit)
     return "chromedriver", download, resolved_version
 
 

pyderman/drivers/edge.py

@@ -6,7 +6,9 @@
 
 _stable = "https://msedgedriver.azureedge.net/LATEST_STABLE"
 _base_version = "https://msedgedriver.azureedge.net/LATEST_RELEASE"
-_base_download = "https://msedgedriver.azureedge.net/{}/edgedriver_{}{}.zip"
+_base_download = (
+    "https://msedgedriver.azureedge.net/{version}/edgedriver_{os}{os_bit}.zip"
+)
 
 
 def get_url(
@@ -20,7 +22,7 @@ def get_url(
     elif _os == "mac":
         _os_name = "MACOS"
     else:
-        raise OSError("There is no valid EdgeDriver release for {}".format(_os))
+        raise OSError(f"There is no valid EdgeDriver release for {_os}")
 
     if version in ("latest", "stable"):
         resolved_version = downloader.raw(_stable, "utf-16")
@@ -29,17 +31,17 @@ def get_url(
         if version == "latest":
             match = re.match(r"^(\d*)[.]?(\d*)[.]?(\d*)[.]?(\d*)$", resolved_version)
             if match:
-                major, minor, patch, build = match.groups()
-                _url = "{}_{}_{}".format(_base_version, major, _os_name)
+                major, _minor, _patch, _build = match.groups()
+                _url = f"{_base_version}_{major}_{_os_name}"
                 resolved_version = downloader.raw(_url, "utf-16")
                 resolved_version = resolved_version.strip() if resolved_version else ""
     else:
         resolved_version = version
 
-    url = _base_download.format(resolved_version, _os, _os_bit)
+    url = _base_download.format(version=resolved_version, os=_os, os_bit=_os_bit)
 
     if not resolved_version:
-        raise Exception("Unable to locate EdgeDriver version: {}!".format(version))
+        raise ValueError(f"Unable to locate EdgeDriver version! [{version}]")
     return "msedgedriver", url, resolved_version
 
 

pyderman/drivers/firefox.py

@@ -10,14 +10,14 @@ def get_url(
 ) -> tuple[str, str, str]:
     urls = github.find_links("mozilla", "geckodriver", version)
     for u in urls:
-        target = "{}{}.".format(_os, _os_bit) if _os != "mac" else "macos."
+        target = f"{_os}{_os_bit}." if _os != "mac" else "macos."
         if _os == "mac-m1":
             target = "macos-aarch64."
         if target in u:
             ver = re.search(r"v(\d{1,2}\.\d{1,2}\.\d{1,2})", u)
             if ver is not None:
                 return "geckodriver", u, str(ver.group(1))
-    raise ValueError("Unable to get url")
+    raise ValueError(f"Unable to locate FirefoxDriver version! [{version}]")
 
 
 if __name__ == "__main__":

pyderman/drivers/opera.py

@@ -12,11 +12,11 @@ def get_url(
         "operasoftware", "operachromiumdriver", version, prefix="v."
     )
     for u in urls:
-        if "{}{}".format(_os, _os_bit) in u:
+        if f"{_os}{_os_bit}" in u:
             ver = re.search(r"v\.(\d{1,2}\.\d{1,2})", u)
             if ver is not None:
                 return "operadriver.*/operadriver", u, str(ver.group(1))
-    raise ValueError("Unable to get url")
+    raise ValueError(f"Unable to locate OperaDriver version! [{version}]")
 
 
 if __name__ == "__main__":

pyderman/drivers/phantomjs.py

@@ -30,15 +30,15 @@ def get_url(
                     release["links"]["self"]["href"],
                     str(ver.group(1)),
                 )
-    raise ValueError("Unable to get url")
+    raise ValueError(f"Unable to locate PhantomJSDriver version! [{version}]")
 
 
 def _releases() -> Generator[dict[str, Any], None, None]:
     page = "https://api.bitbucket.org/2.0/repositories/ariya/phantomjs/downloads/"
     while page:
         s = downloader.raw(page)
         if s is None:
-            raise ValueError("Unable to get page: %s" % page)
+            raise ValueError(f"Unable to get page: {page}")
         else:
             data = json.loads(s)
             for release in data["values"]:

pyderman/util/github.py

@@ -12,10 +12,10 @@ def find_links(
         version = "latest"
     if version != "latest" and not version.startswith(prefix):
         version = "{}{}".format(prefix, version)
-    repo = "https://github.com/{}/{}/releases/{}".format(author, project, version)
+    repo = f"https://github.com/{author}/{project}/releases/{version}"
     html = downloader.raw(repo)
     if html is None:
-        raise Exception("Unable to download {} version: {}".format(project, version))
+        raise Exception(f"Unable to download {project} version: {version}")
     return [
         "https://github.com%s" % str(u)
         for u in re.findall(r"\"(.+?/download.+?)\"", html)

setup.cfg

@@ -22,8 +22,7 @@ classifiers =
 [options]
 packages = find:
 python_requires = >=3.7
-packages_data =
-    pyderman = py.typed
+include_package_data = True
 
 [options.extras_require]
 dev =
@@ -37,6 +36,9 @@ dev =
     types-setuptools
     wheel
 
+[options.package_data]
+pyderman = py.typed
+
 [isort]
 profile = black
 

pyderman/test.py renamed to test_pyderman.py

@@ -112,7 +112,7 @@ def test_get_nonsense(self) -> None:
         with self.assertRaises(Exception) as exc:
             self.chrome_version("25.25.25.25")
         self.assertEqual(
-            str(exc.exception), "Unable to locate ChromeDriver version: 25.25.25.25!"
+            str(exc.exception), "Unable to locate ChromeDriver version! [25.25.25.25]"
         )
         return
 
@@ -231,9 +231,9 @@ def test_get_invalid_os(self) -> None:
 
     def test_unresolved_version(self) -> None:
         with self.assertRaises(Exception) as exc:
-            edge.get_url(None, _os="mac", _os_bit="64")  # type: ignore
+            edge.get_url(None, _os="mac", _os_bit="64")  # type: ignore[arg-type]
         self.assertEqual(
-            str(exc.exception), "Unable to locate EdgeDriver version: None!"
+            str(exc.exception), "Unable to locate EdgeDriver version! [None]"
         )
         return