feat(pypac): add tldextract cache directory in pyinstaller

Author: jmkerloch

.github/workflows/build_release.yml

@@ -92,6 +92,9 @@ jobs:
       - name: Install project as a package
         run: python -m pip install -e .
 
+      - name: Generates tldextract cache
+        run: python -O ./builder/tldextract_update.py
+
       - name: Generates Executable
         run: python -O ./builder/pyinstaller_build_macos.py
 
@@ -126,6 +129,8 @@ jobs:
 
       - name: Install project as a package
         run: python -m pip install -e .
+      - name: Generates tldextract cache
+        run: python -O ./builder/tldextract_update.py
 
       - name: Generates Executable
         run: python -O ./builder/pyinstaller_build_ubuntu.py
@@ -165,6 +170,9 @@ jobs:
       - name: Generates MS Version Info
         run: python .\builder\version_info_templater.py
 
+      - name: Generates tldextract cache
+        run: python -O .\builder\tldextract_update.py
+
       - name: Generates MS Executable
         run: python -O .\builder\pyinstaller_build_windows.py
 

builder/pyinstaller_build_macos.py

@@ -53,6 +53,8 @@
     [
         "--add-data=LICENSE:.",
         "--add-data=README.md:.",
+        f"--add-data={Path(__file__).parent / 'build' / 'tldextract_cache'/ '.suffix_cache'}:tldextract/.suffix_cache",
+        f"--add-data={Path(__file__).parent / 'build' / 'tldextract_cache'/'.tld_set_snapshot'}:tldextract/",
         f"--add-data={package_folder.joinpath('shortcuts/shortcut_freedesktop.template').resolve()}:profiles/",
         f"--log-level={getenv('PYINSTALLER_LOG_LEVEL', 'WARN')}",
         f"--name={output_filename}",

builder/pyinstaller_build_ubuntu.py

@@ -52,6 +52,8 @@
     [
         "--add-data=LICENSE:.",
         "--add-data=README.md:.",
+        f"--add-data={Path(__file__).parent / 'build' / 'tldextract_cache'/ '.suffix_cache'}:tldextract/.suffix_cache",
+        f"--add-data={Path(__file__).parent / 'build' / 'tldextract_cache'/'.tld_set_snapshot'}:tldextract/",
         f"--add-data={package_folder.joinpath('shortcuts/shortcut_freedesktop.template').resolve()}:shortcuts/",
         f"--log-level={getenv('PYINSTALLER_LOG_LEVEL', 'WARN')}",
         f"--name={output_filename}",

builder/pyinstaller_build_windows.py

@@ -50,6 +50,8 @@
     [
         "--add-data=LICENSE:.",
         "--add-data=README.md:.",
+        f"--add-data={Path(__file__).parent / 'build' / 'tldextract_cache'/ '.suffix_cache'}:tldextract/.suffix_cache",
+        f"--add-data={Path(__file__).parent / 'build' / 'tldextract_cache'/'.tld_set_snapshot'}:tldextract/",
         # "--clean",
         f"--icon={package_folder.parent.resolve()}/docs/static/logo_qdt.ico",
         f"--log-level={getenv('PYINSTALLER_LOG_LEVEL', 'WARN')}",

builder/tldextract_update.py

@@ -0,0 +1,83 @@
+#! python3  # noqa: E265
+
+"""
+    Create tldextract update cache folder
+
+"""
+
+# #############################################################################
+# ########## Libraries #############
+# ##################################
+
+# Standard library
+import argparse
+import sys
+import urllib.request
+from os import W_OK, access, path
+from pathlib import Path
+
+# 3rd party
+from tldextract import TLDExtract
+
+sys.path.insert(0, path.abspath(r"."))
+
+
+# #############################################################################
+# ########### MAIN #################
+# ##################################
+
+
+def run():
+    """Minimal CLI to generate a tldextract cache.
+
+    :raises PermissionError: if output directory already exists but it's not writable
+    :raises SystemExit: in case of user abort
+
+    :example:
+
+    .. code-block:: bash
+
+        python tldextract_update.py
+    """
+    # variables
+    script_path = Path(__file__).parent
+
+    # cli parser arguments
+    parser = argparse.ArgumentParser(
+        epilog=("tdlextract cache are created in output folder")
+    )
+    parser.add_argument(
+        "-o",
+        "--output",
+        default=script_path / "build" / "tldextract_cache",
+        help="tld extract cache output folder",
+        type=Path,
+    )
+
+    args = parser.parse_args()
+
+    try:
+        # check output directory
+        output_dir = Path(args.output)
+        if output_dir.exists() and not access(output_dir, W_OK):
+            raise PermissionError(output_dir.resolve())
+
+        output_dir.mkdir(exist_ok=True, parents=True)
+
+        tld_extract = TLDExtract(str(output_dir / ".suffix_cache"))
+        tld_extract.update(True)
+
+        urllib.request.urlretrieve(
+            "https://publicsuffix.org/list/public_suffix_list.dat",
+            output_dir / ".tld_set_snapshot",
+        )
+
+        # log user
+        print(f"tldextract cache written to: {output_dir.resolve()}")
+    except KeyboardInterrupt:
+        raise SystemExit("Aborted by user request.")
+
+
+# Stand alone execution
+if __name__ == "__main__":
+    run()

docs/development/packaging.md

@@ -14,6 +14,9 @@ The output binary and all embedded dependencies is located into a subfolder name
 # Generates MS Version Info
 python .\builder\version_info_templater.py
 
+# Generates tldextract cache
+python .\builder\tldextract_update.py
+
 # Generates MS Executable
 python -O .\builder\pyinstaller_build_windows.py
 ```
@@ -29,6 +32,8 @@ To run it, double-click on the executable file (*.exe) loated into `dist` folder
 ```sh
 # Generates binary executable
 python -O ./builder/pyinstaller_build_ubuntu.py
+# Generates tldextract cache
+python ./builder/tldextract_update.py
 # make it runnable
 chmod +x dist/QGISDeploymentToolbelt_*
 ```