service cleanup

Author: jlwalke2

doc/api/sasctl.pzmm.rst

@@ -0,0 +1,10 @@
+sasctl.pzmm package
+====================
+
+Module contents
+---------------
+
+.. automodule:: sasctl.pzmm
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/api/sasctl.rst

@@ -23,4 +23,5 @@ Subpackages
 .. toctree::
 
     sasctl.services
-    sasctl.utils
+    sasctl.utils
+    sasctl.pzmm

src/sasctl/__init__.py

@@ -13,11 +13,28 @@
                 'Cary, NC, USA.  All Rights Reserved.'
 
 import logging
+import warnings
 
 
-from .core import current_session, delete, get, get_link, platform_version, post, put, request_link
+from .core import (
+    current_session,
+    delete,
+    get,
+    get_link,
+    platform_version,
+    post,
+    put,
+    request_link,
+)
 from .core import RestObj, Session, HTTPError
-from .tasks import register_model, publish_model, update_model_performance
+from .tasks import (
+    publish_model,
+    register_model,
+    update_model_performance,
+)
+
+# Ensure deprecation warnings are shown to users.
+warnings.filterwarnings('always', category=DeprecationWarning, module=r'^sasctl\.')
 
 
 # Prevent package from emitting log records unless consuming

src/sasctl/_services/cas_management.py

@@ -4,8 +4,13 @@
 # Copyright © 2019, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 
+import os
+
 from .service import Service
 
+DEFAULT_SERVER = 'cas-shared-default'
+DEFAULT_CASLIB = 'casuser'
+
 
 class CASManagement(Service):
     """The CAS Management service provides the ability to manage and perform
@@ -16,14 +21,15 @@ class CASManagement(Service):
 
     list_servers, get_server, _, _ = Service._crud_funcs('/servers', 'server')
 
-    def list_caslibs(self, server, filter=None):
+    @classmethod
+    def list_caslibs(cls, server, filter_=None):
         """List caslibs available on a server.
 
         Parameters
         ----------
         server : str or dict
             Name, ID, or dictionary representation of the server.
-        filter : str, optional
+        filter_ : str, optional
             A `formatted <https://developer.sas.com/reference/filtering>`_
             filter string.
 
@@ -33,10 +39,12 @@ def list_caslibs(self, server, filter=None):
             A collection of :class:`.RestObj` instances.
 
         """
-        return self._get_rel(server, 'caslibs', func=self.get_server,
-                             filter=filter) or []
+        return (
+            cls._get_rel(server, 'caslibs', func=cls.get_server, filter_=filter_) or []
+        )
 
-    def get_caslib(self, name, server=None):
+    @classmethod
+    def get_caslib(cls, name, server=None):
         """Get a caslib by name.
 
         Parameters
@@ -51,14 +59,15 @@ def get_caslib(self, name, server=None):
         RestObj
 
         """
-        server = server or 'cas-shared-default'
-        caslibs = self.list_caslibs(server,
-                                    filter='eq($primary,name, "%s")' % name)
+        server = server or DEFAULT_SERVER
+        caslibs = cls.list_caslibs(server, filter_='eq($primary,name, "%s")' % name)
 
         if caslibs:
             return caslibs[0]
+        return None
 
-    def list_tables(self, caslib, server=None, filter=None):
+    @classmethod
+    def list_tables(cls, caslib, server=None, filter_=None):
         """List tables available in a caslib.
 
         Parameters
@@ -67,7 +76,7 @@ def list_tables(self, caslib, server=None, filter=None):
             Name, ID, or dictionary representation of the caslib.
         server : str, optional
             Server where the `caslib` is registered.
-        filter : str, optional
+        filter_ : str, optional
             Filter string in the `https://developer.sas.com/reference/filtering
             /` format.
 
@@ -77,18 +86,19 @@ def list_tables(self, caslib, server=None, filter=None):
             A collection of :class:`.RestObj` instances.
 
         """
-        return self._get_rel(caslib, 'tables', self.get_caslib, filter,
-                             server) or []
+        return cls._get_rel(caslib, 'tables', server, func=cls.get_caslib, filter_=filter_) or []
 
-    def get_table(self, name, caslib, server=None):
+    @classmethod
+    def get_table(cls, name, caslib=None, server=None):
         """Get a table by name.
 
         Parameters
         ----------
         name : str
             Name of the table.
-        caslib : str or dict
-            Name, ID, or dictionary representation of the caslib.
+        caslib : str or dict, optional
+            Name, ID, or dictionary representation of the caslib.  Defaults to
+            CASUSER.
         server : str, optional
             Server where the `caslib` is registered.
 
@@ -97,9 +107,77 @@ def get_table(self, name, caslib, server=None):
         RestObj
 
         """
-        tables = self.list_tables(caslib,
-                                  server=server,
-                                  filter='eq($primary,name, "%s")' % name)
+        caslib = caslib or DEFAULT_CASLIB
+        tables = cls.list_tables(
+            caslib, server=server, filter_='eq($primary,name, "%s")' % name
+        )
 
         if tables:
             return tables[0]
+        return None
+
+    @classmethod
+    def upload_file(
+        cls, file, name, caslib=None, server=None, header=None, format_=None
+    ):
+        """Upload a file to a CAS table.
+
+        Uploads the contents of a CSV, XLS, XLSX, SAS7BDT or SASHDAT file to a
+        newly created CAS table.
+
+        Parameters
+        ----------
+        file : str or file-like object
+            File containing data to upload or path to the file.
+        name : str
+            Name of the table to create
+        caslib : str, optional
+            caslib in which the table will be created.  Defaults to CASUSER.
+        server : str, optional
+            CAS server on which the table will be created.  Defaults to
+            cas-shared-default.
+        header : bool, optional
+            Whether the first row of data contains column headers.  Defaults to
+            True.
+        format_ : {"csv", "xls", "xlsx", "sas7bdat", "sashdat"}, optional
+            File of input `file`.  Not required if format can be discerned from
+            the file path.
+
+        Returns
+        -------
+        RestObj
+            Table reference
+
+        """
+        name = str(name)
+        caslib = caslib or DEFAULT_CASLIB
+        server = server or DEFAULT_SERVER
+        header = True if header is None else bool(header)
+
+        # Not a file-like object, assuming it's a file path
+        if not hasattr(file, 'read'):
+            path = os.path.abspath(os.path.expanduser(file))
+            format_ = os.path.splitext(path)[-1].lstrip('.').lower()
+
+            # Extension should be supported & needs to be explicitly set in
+            # the "format" parameter to avoid errors.
+            if format_ not in ('csv', 'xls', 'xlsx', 'sas7bdat', 'sashdat'):
+                raise ValueError("File '%s' has an unsupported file type." % file)
+
+            with open(path, 'rb') as f:
+                file = f.read()
+
+        data = {
+            'tableName': name,
+            'containsHeaderRow': header,
+        }
+
+        if format_ is not None:
+            data['format'] = format_
+
+        tbl = cls.post(
+            '/servers/%s/caslibs/%s/tables' % (server, caslib),
+            data=data,
+            files={name: file},
+        )
+        return tbl

src/sasctl/_services/concepts.py

@@ -15,8 +15,9 @@ class Concepts(Service):
 
     _SERVICE_ROOT = '/concepts'
 
+    @classmethod
     def assign_concepts(
-        self,
+        cls,
         documents,
         caslib=None,
         id_column=None,
@@ -123,4 +124,4 @@ def assign_concepts(
                 'Accept': 'application/vnd.sas.text.concepts.job+json',
             }
 
-        return self.post(url, json=data, headers=headers)
+        return cls.post(url, json=data, headers=headers)