Handle import to different project versions #107

Author: smlindauer

src/sasctl/_services/model_repository.py

@@ -54,7 +54,7 @@ class ModelRepository(Service):
 
     @classmethod
     def get_astore(cls, model):
-        """Get the ASTORE for a model registered int he model repository.
+        """Get the ASTORE for a model registered in the model repository.
 
         Parameters
         ----------
@@ -503,6 +503,8 @@ def import_model_from_zip(
             The ZIP file containing the model and contents.
         description : str
             The description of the model.
+        version : str, optional
+            Name of the project version. Default value is "latest".
 
         Returns
         -------
@@ -769,3 +771,47 @@ def get_model_details(cls, model):
             id_ = model["id"]
 
         return cls.get("/models/%s" % id_)
+
+    @classmethod
+    def list_project_versions(cls, project):
+        """_summary_
+
+        Parameters
+        ----------
+        project : str or dict
+            The name or id of the model project, or a dictionary representation
+            of the model project.
+
+        Returns
+        -------
+        list of dicts
+            List of dicts representing different project versions. Dict key/value
+            pairs are as follows.
+                name : str
+                id : str
+                number : str
+                modified : datetime
+
+        """
+        from datetime import datetime
+
+        project_info = cls.get_project(project)
+
+        if project_info is None:
+            raise ValueError("Project `%s` could not be found." % str(project))
+
+        projectVersions = cls.get(
+            "/projects/{}/projectVersions".format(project_info.id)
+        )
+        versionList = []
+        for version in projectVersions:
+            versionDict = {
+                "name": version.name,
+                "id": version.id,
+                "number": version.versionNumber,
+                "modified": datetime.strptime(
+                    version.modifiedTimeStamp, "%Y-%m-%dT%H:%M:%S.%fZ"
+                ),
+            }
+            versionList.append(versionDict)
+        return versionList

src/sasctl/pzmm/importModel.py

@@ -49,17 +49,21 @@ def project_exists(response, project):
         return response
 
 
-def model_exists(project, name, force):
-    """Checks if model already exists and either raises an error or deletes the redundant model.
+def model_exists(project, name, force, versionName="latest"):
+    """Checks if model already exists in the same project and either raises an error or deletes
+    the redundant model. If no project version is provided, the version is assumed to be "latest".
 
     Parameters
     ----------
-    project : string or dict
+    project : str or dict
         The name or id of the model project, or a dictionary representation of the project.
     name : str or dict
         The name of the model.
     force : bool, optional
         Sets whether to overwrite models with the same name upon upload.
+    versionName : str, optional
+        Name of project version to check if a model of the same name already exists. Default
+        value is "latest".
 
     Raises
     ------
@@ -69,7 +73,19 @@ def model_exists(project, name, force):
     """
     project = mr.get_project(project)
     projectId = project["id"]
-    projectModels = mr.get("/projects/{}/models".format(projectId))
+    projectVersions = mr.list_project_versions(project)
+    if versionName == "latest":
+        modTime = [item["modified"] for item in projectVersions]
+        latestVersion = modTime.index(max(modTime))
+        versionId = projectVersions[latestVersion]["id"]
+    else:
+        for version in projectVersions:
+            if versionName is version["name"]:
+                versionId = version["id"]
+                break
+    projectModels = mr.get(
+        "/projects/{}/projectVersions/{}/models".format(projectId, versionId)
+    )
 
     for model in projectModels:
         # Throws a TypeError if only one model is in the project
@@ -106,6 +122,7 @@ def pzmmImportModel(
         targetDF,
         predictmethod,
         metrics=["EM_EVENTPROBABILITY", "EM_CLASSIFICATION"],
+        projectVersion="latest",
         modelFileName=None,
         pyPath=None,
         threshPrediction=None,
@@ -156,9 +173,12 @@ def pzmmImportModel(
         metrics : string list, optional
             The scoring metrics for the model. The default is a set of two
             metrics: EM_EVENTPROBABILITY and EM_CLASSIFICATION.
+        projectVersion : str, optional
+            Name of project version to check if a model of the same name already exists. Default
+            value is "latest".
         modelFileName : string, optional
             Name of the model file that contains the model. By default None and assigned as
-            model_prefix + '.pickle'.
+            modelPrefix + '.pickle'.
         pyPath : string, optional
             The local path of the score code file. By default None and assigned as the zPath.
         threshPrediction : float, optional
@@ -265,7 +285,9 @@ def getFiles(extensions):
             # Check if model with same name already exists in project.
             model_exists(project, modelPrefix, force)
 
-            response = mr.import_model_from_zip(modelPrefix, project, zipIOFile)
+            response = mr.import_model_from_zip(
+                modelPrefix, project, zipIOFile, version=projectVersion
+            )
             try:
                 print(
                     "Model was successfully imported into SAS Model Manager as {} with UUID: {}.".format(
@@ -286,7 +308,9 @@ def getFiles(extensions):
             # Check if model with same name already exists in project.
             model_exists(project, modelPrefix, force)
 
-            response = mr.import_model_from_zip(modelPrefix, project, zipIOFile, force)
+            response = mr.import_model_from_zip(
+                modelPrefix, project, zipIOFile, force, version=projectVersion
+            )
             try:
                 print(
                     "Model was successfully imported into SAS Model Manager as {} with UUID: {}.".format(