move get_board_pkgs to attach_pkgs.py

Author: isabelizimm

vetiver/__init__.py

@@ -7,7 +7,7 @@
 from .server import VetiverAPI, vetiver_endpoint, predict  # noqa
 from .mock import get_mock_data, get_mock_model  # noqa
 from .pin_read_write import vetiver_pin_write  # noqa
-from .attach_pkgs import load_pkgs  # noqa
+from .attach_pkgs import load_pkgs, get_board_pkgs  # noqa
 from .meta import VetiverMeta  # noqa
 from .write_docker import write_docker, prepare_docker  # noqa
 from .write_fastapi import write_app, vetiver_write_app  # noqa

vetiver/attach_pkgs.py

@@ -1,31 +1,33 @@
 import tempfile
 import os
+import warnings
+from typing import List
 from .vetiver_model import VetiverModel
 from .meta import VetiverMeta
 
 
 def load_pkgs(model: VetiverModel = None, packages: list = None, path=""):
     """Load packages necessary for predictions
 
-    Args
-    ----
-        model: VetiverModel
-            VetiverModel to extract packages from
-        packages: list
-            List of extra packages to include
-        path: str
-            Where to save output file
+    Parameters
+    ----------
+    model: VetiverModel
+        VetiverModel to extract packages from
+    packages: list
+        List of extra packages to include
+    path: str
+        Where to save output file
     """
 
     required_pkgs = ["vetiver"]
     if packages:
-        required_pkgs = list(set(required_pkgs + packages))
+        required_pkgs += packages
 
     if isinstance(model.metadata, dict):
         model.metadata = VetiverMeta.from_dict(model.metadata)
 
     if model.metadata.required_pkgs:
-        required_pkgs = list(set(required_pkgs + model.metadata.required_pkgs))
+        required_pkgs += model.metadata.required_pkgs
 
     tmp = tempfile.NamedTemporaryFile(suffix=".in", delete=False)
     tmp.close()
@@ -36,3 +38,37 @@ def load_pkgs(model: VetiverModel = None, packages: list = None, path=""):
 
     os.system(f"pip-compile {tmp.name} --output-file={path}requirements.txt")
     os.remove(tmp.name)
+
+
+def get_board_pkgs(board) -> List[str]:
+    """
+    Extract packages required for pin board authorization
+
+    Parameters
+    ----------
+    board:
+        A pin board, created by `pins.board_folder()` or another `board_` function.
+
+    Returns
+    --------
+    list[str]
+    """
+    prot = board.fs.protocol
+
+    if prot == "rsc":
+        return ["rsconnect-python"]
+    elif prot == "file":
+        return []
+    elif prot == ["s3", "s3a"]:
+        return ["s3fs"]
+    elif prot == "abfs":
+        return ["adlfs"]
+    elif prot == ("gcs", "gs"):
+        return ["gcsfs"]
+    else:
+        warnings.warn(
+            f"required packages unknown for board protocol: {prot}, "
+            "add to model's metadata to export",
+            UserWarning,
+        )
+        return []

vetiver/pin_read_write.py

@@ -3,7 +3,6 @@
 from .utils import inform
 import warnings
 import logging
-from typing import List
 
 _log = logging.getLogger(__name__)
 
@@ -116,36 +115,3 @@ def vetiver_pin_read(board, name: str, version: str = None) -> VetiverModel:
     v = VetiverModel.from_pin(board=board, name=name, version=version)
 
     return v
-
-
-def _get_board_pkgs(board) -> List[str]:
-    """
-    Extract packages required for pin board authorization
-
-    Parameters
-    ----------
-    board:
-        A pin board, created by `pins.board_folder()` or another `board_` function.
-
-    Returns
-    --------
-    list[str]
-    """
-    prot = board.fs.protocol
-
-    if prot == "rsc":
-        return ["rsconnect-python"]
-    elif prot == "file":
-        return []
-    elif prot == ["s3", "s3a"]:
-        return ["s3fs"]
-    elif prot == "abfs":
-        return ["adlfs"]
-    elif prot == ("gcs", "gs"):
-        return ["gcsfs"]
-    else:
-        warnings.warn(
-            f"required packages unknown for board protocol: {prot}, "
-            "add to model's metadata to export"
-        )
-        return []

vetiver/vetiver_model.py

@@ -1,7 +1,6 @@
 import json
 from warnings import warn
 from vetiver.handlers.base import create_handler
-from .pin_read_write import _get_board_pkgs
 
 
 class NoModelAvailableError(Exception):
@@ -100,15 +99,13 @@ def from_pin(cls, board, name: str, version: str = None):
 
         if "vetiver_meta" in meta.user:
             get_prototype = meta.user.get("vetiver_meta").get("prototype", None)
-            required_pkgs = meta.user.get("vetiver_meta").get(
-                "required_pkgs", None
-            ) + _get_board_pkgs(board)
+            required_pkgs = meta.user.get("vetiver_meta").get("required_pkgs", None)
             python_version = meta.user.get("vetiver_meta").get("python_version", None)
             meta.user.pop("vetiver_meta")
         # old pin type
         else:
             get_prototype = meta.user.get("ptype")
-            required_pkgs = meta.user.get("required_pkgs") + _get_board_pkgs(board)
+            required_pkgs = meta.user.get("required_pkgs")
             python_version = meta.user.get("python_version")
 
         return cls(

vetiver/write_docker.py

@@ -3,7 +3,7 @@
 from pathlib import Path
 
 from .write_fastapi import write_app
-from .attach_pkgs import load_pkgs
+from .attach_pkgs import load_pkgs, get_board_pkgs
 from .vetiver_model import VetiverModel
 
 
@@ -101,7 +101,7 @@ def prepare_docker(
     board,
     pin_name: str,
     path: str = "./",
-    version=None,
+    version: str = None,
     rspm_env: bool = False,
     host: str = "0.0.0.0",
     port: str = "8080",
@@ -137,11 +137,20 @@ def prepare_docker(
     >>> v = vetiver.VetiverModel(model, "my_model", prototype_data = X)
     >>> vetiver.vetiver_pin_write(board, v)
     >>> vetiver.prepare_docker(board = board, pin_name = "my_model", path = tmp.name)
+
+    Notes
+    ------
+    This function uses `vetiver.get_board_pkgs(board)` for generating requirements.
+    For more complex use cases, call `write_docker()`, `load_pkgs()`, and
+    `write_app()` individually.
     """
 
     v = VetiverModel.from_pin(board=board, name=pin_name, version=version)
+
     write_app(
         board=board, pin_name=pin_name, version=version, file=Path(path, "app.py")
     )
-    load_pkgs(v, path=Path(path, "vetiver_"))
+
+    load_pkgs(v, path=Path(path, "vetiver_"), packages=get_board_pkgs(board))
+
     write_docker(path=path, rspm_env=rspm_env, host=host, port=port)