enhancements to testing framework (#142)

**Improvements**
 - Added `Session.version_info()` to check which version of Viya the session is connected to.
  - Updated the `properties=` parameter of `model_repository.create_model()` to accept a dictionary containing
   custom property names and values, and to correctly indicate their type (numeric, string, date, datetime) when
   passing the values to Viya.

**Changes**
 - Deprecated `core.platform_version()` in favor of `Session.version_info()`.
 - A `RuntimeError` is now raised if an obsolete service is called on a Viya 4 session (sentiment_analysis, 
   text_categorization, and text_parsing)
 - Replaced the JSON cassettes used for testing with compressed binary cassettes to save space.
 - Updated the testing framework to allow regression testing of multiple Viya versions.

**Bugfixes**
 - Fixed an issue with `register_model()` that caused invalid SAS score code to be generated when registering an
   ASTORE model in Viya 3.5.
 - Fixed a bug where calling a "get_item()" function and passing `None` would throw an error on most services instead
   of returning `None`.

Author: jlwalke2

.deepsource.toml

@@ -14,4 +14,6 @@ name = "python"
 enabled = true
 
   [analyzers.meta]
-  runtime_version = "3.x.x"
+  runtime_version = "3.x.x"
+  max_line_length = 90
+  skip_doc_coverage = ["init", "magic", "nonpublic"]

.github/workflows/build-test-deploy.yml

@@ -21,8 +21,7 @@ jobs:
       LANG: en_US.UTF-8
     strategy:
       matrix:
-        python-version: [3.6, 3.7, 3.8] #, 3.9, '3.10'] <-- auto fails due to lack of 3.9 & 3.10 env in tox.ini
-        # Removing support for Python 3.5
+        python-version: ['3.6', '3.7', '3.8', '3.9', '3.10']
         os-version: [ubuntu-latest, windows-latest, macos-latest]
 
     steps:

CHANGELOG.md

@@ -1,37 +1,57 @@
 Unreleased
 ----------
 
+**Improvements**
+ - Added `Session.version_info()` to check which version of Viya the session is connected to.
+  - Updated the `properties=` parameter of `model_repository.create_model()` to accept a dictionary containing
+   custom property names and values, and to correctly indicate their type (numeric, string, date, datetime) when
+   passing the values to Viya.
+
+**Changes**
+ - Deprecated `core.platform_version()` in favor of `Session.version_info()`.
+ - A `RuntimeError` is now raised if an obsolete service is called on a Viya 4 session (sentiment_analysis, 
+   text_categorization, and text_parsing)
+ - Replaced the JSON cassettes used for testing with compressed binary cassettes to save space.
+ - Updated the testing framework to allow regression testing of multiple Viya versions.
+
+**Bugfixes**
+ - Fixed an issue with `register_model()` that caused invalid SAS score code to be generated when registering an
+   ASTORE model in Viya 3.5.
+ - Fixed a bug where calling a "get_item()" function and passing `None` would throw an error on most services instead
+   of returning `None`. 
+   
+ 
 v1.7.3 (2022-09-20)
 -------------------
 **Improvements**
-- Refactor astore model upload to fix 422 response from SAS Viya 4 
-  - ASTORE model import now uses SAS Viya to generate ASTORE model assets
-- Expanded usage for cas_management service (credit to @SilvestriStefano)
+ - Refactor astore model upload to fix 422 response from SAS Viya 4 
+ - ASTORE model import now uses SAS Viya to generate ASTORE model assets
+ - Expanded usage for cas_management service (credit to @SilvestriStefano)
 
 **Bugfixes**
-- ASTORE model import no longer returns a 422 error
-- Fix improper filter usage for model_repository service
-- Fix error with loss of stream in add_model_content call for duplicate content
-- Update integration test cassettes for SAS Viya 4
+ - ASTORE model import no longer returns a 422 error
+ - Fix improper filter usage for model_repository service
+ - Fix error with loss of stream in add_model_content call for duplicate content
+ - Update integration test cassettes for SAS Viya 4
 
 v1.7.2 (2022-06-16)
 -------------------
 **Improvements**
-- Added a new example notebook for git integration
-- Added a model migration tool for migrating Python models from Viya 3.5 to Viya 4
-- Improved handling of CAS authentication with tokens
+ - Added a new example notebook for git integration
+ - Added a model migration tool for migrating Python models from Viya 3.5 to Viya 4
+ - Improved handling of CAS authentication with tokens
 
 **Bugfixes**
-- Fixed git integration failure caused by detached head
-- Fixed minor bugs in score code generation feature
-- Fixed 500 error when importing models to Viya 4 with prewritten score code
-- Fixed incorrect handling of optional packages in pzmm
+ - Fixed git integration failure caused by detached head
+ - Fixed minor bugs in score code generation feature
+ - Fixed 500 error when importing models to Viya 4 with prewritten score code
+ - Fixed incorrect handling of optional packages in pzmm
 
 v1.7.1 (2022-04-19)
 -------------------
 **Bugfixes**
-- Removed linux breaking import from new git integration feature
-- Various minor bug fixes in the git integration feature
+ - Removed linux breaking import from new git integration feature
+ - Various minor bug fixes in the git integration feature
 
 v1.7.0 (2022-04-07)
 -------------------

src/sasctl/_services/model_repository.py

@@ -6,6 +6,7 @@
 
 """The Model Repository service supports registering and managing models."""
 
+import datetime
 from warnings import warn
 
 from .service import Service
@@ -292,8 +293,9 @@ def create_model(
             Indicates whether the model can be retrained or not.
         is_immutable : bool
             Indicates whether the model can be changed or not.
-        properties : array_like, optional (custom properties)
-            Custom model properties that can be set: name, value, type
+        properties : dict, optional
+            Custom model properties provided as name: value pairs.
+            Allowed types are int, float, string, datetime.date, and datetime.datetime
         input_variables : array_like, optional
             Model input variables. By default, these are the same as the model
             project.
@@ -334,9 +336,27 @@ def create_model(
         elif is_challenger:
             model["role"] = "challenger"
 
-        model.setdefault(
-            "properties", [{"name": k, "value": v} for k, v in properties.items()]
-        )
+        model.setdefault("properties", [])
+        for k, v in properties.items():
+            if type(v) in (int, float):
+                t = "numeric"
+            elif type(v) is datetime.date:
+                # NOTE: do not use isinstance() to compare types as isinstance(v, datetime.date) evaluates to True
+                #       even for datetime.datetime instances.
+                # Convert to datetime to extract timestamp and then scale to milliseconds
+                v = datetime.datetime(v.year, v.month, v.day).timestamp()
+                v = int(v * 1000)
+                t = "date"
+            elif type(v) is datetime.datetime:
+                # Extract timestamp and scale to milliseconds
+                v = int(v.timestamp() * 1000)
+                t = "dateTime"
+            else:
+                t = "string"
+                v = str(v)
+
+            model["properties"].append({"name": k, "value": v, "type": t})
+
         model["scoreCodeType"] = score_code_type or model.get("scoreCodeType")
         model["trainTable"] = training_table or model.get("trainTable")
         model[
@@ -422,8 +442,11 @@ def add_model_content(
                 for item in model_contents:
                     if item.name == name:
                         cls.delete("/models/{}/contents/{}".format(id_, item.id))
+
                         # Return json stream to beginning of file content
-                        files["files"][1].seek(0)
+                        if hasattr(files["files"][1], "seek"):
+                            files["files"][1].seek(0)
+
                         return cls.post(
                             "/models/{}/contents".format(id_),
                             files=files,
@@ -777,7 +800,7 @@ def get_model_details(cls, model):
 
     @classmethod
     def list_project_versions(cls, project):
-        """_summary_
+        """Get a list of all versions of a project.
 
         Parameters
         ----------
@@ -796,8 +819,6 @@ def list_project_versions(cls, project):
                 modified : datetime
 
         """
-        from datetime import datetime
-
         project_info = cls.get_project(project)
 
         if project_info is None:
@@ -813,7 +834,7 @@ def list_project_versions(cls, project):
                     "name": version.name,
                     "id": version.id,
                     "number": version.versionNumber,
-                    "modified": datetime.strptime(
+                    "modified": datetime.datetime.strptime(
                         version.modifiedTimeStamp, "%Y-%m-%dT%H:%M:%S.%fZ"
                     ),
                 }
@@ -823,7 +844,7 @@ def list_project_versions(cls, project):
                 "name": projectVersions.name,
                 "id": projectVersions.id,
                 "number": projectVersions.versionNumber,
-                "modified": datetime.strptime(
+                "modified": datetime.datetime.strptime(
                     projectVersions.modifiedTimeStamp, "%Y-%m-%dT%H:%M:%S.%fZ"
                 ),
             }

src/sasctl/_services/sentiment_analysis.py

@@ -6,7 +6,7 @@
 
 
 from .service import Service
-from ..core import uri_as_str
+from ..core import current_session, uri_as_str
 
 
 class SentimentAnalysis(Service):
@@ -71,6 +71,11 @@ def analyze_sentiment(
         :meth:`cas_management.get_table <.CASManagement.get_table>`
 
         """
+        if current_session().version_info() >= 4:
+            raise RuntimeError(
+                "The Sentiment Analysis service was removed from Viya 4."
+            )
+
         if documents is None:
             raise TypeError("`documents` cannot be None.")
 

src/sasctl/_services/service.py

@@ -235,6 +235,9 @@ def get_item(cls, item, refresh=False):
             calls when data is already available on the client.
 
             """
+            if item is None:
+                return item
+
             # If the input already appears to be the requested object just
             # return it, unless a refresh of the data was explicitly requested.
             if isinstance(item, dict) and all(k in item for k in ("id", "name")):

src/sasctl/_services/text_categorization.py

@@ -6,7 +6,7 @@
 
 
 from .service import Service
-from ..core import uri_as_str
+from ..core import current_session, uri_as_str
 
 
 class TextCategorization(Service):
@@ -64,6 +64,11 @@ def categorize(
         :meth:`cas_management.get_table <.CASManagement.get_table>`
 
         """
+        if current_session().version_info() >= 4:
+            raise RuntimeError(
+                "The Text Categorization service was removed from Viya 4."
+            )
+
         if documents is None:
             raise TypeError("`documents` cannot be None.")
 

src/sasctl/_services/text_parsing.py

@@ -6,7 +6,7 @@
 
 
 from .service import Service
-from sasctl.core import uri_as_str
+from sasctl.core import current_session, uri_as_str
 
 
 class TextParsing(Service):
@@ -100,6 +100,8 @@ def parse_documents(
         :meth:`cas_management.get_table <.CASManagement.get_table>`
 
         """
+        if current_session().version_info() >= 4:
+            raise RuntimeError("The Text Parsing service was removed from Viya 4.")
 
         if documents is None:
             raise TypeError("`documents` cannot be None.")