improved pymas scoring

removed winkerberos requirement
moved exceptions

Author: jlwalke2

CHANGELOG.md

@@ -4,6 +4,7 @@ Unreleased
 **Changed**
  - Exceptions moved from `sasctl.core` to `sasctl.exceptions`
  - `SWATCASActionError` raised if ASTORE cannot be saved during model registration.
+ - Improved handling of MAS calls made via `define_steps()` 
 
 
 v1.0.0 (2019-07-24)

doc/index.rst

@@ -45,11 +45,11 @@ Installation
 
 For basic functionality::
 
-    pip install git+https://gitlab.sas.com/xeno/python-sasctl
+    pip install sasctl
 
 For full functionality::
 
-    pip install git+https://gitlab.sas.com/xeno/python-sasctl#egg=sasctl[all]
+    pip install sasctl[all]
 
 Quickstart
 ----------

examples/sklearn_model.py

@@ -37,7 +37,8 @@
     module = publish_model(model_name, 'maslocal')
 
     # Select the first row of training data
-    x = {k.lower(): v for k, v in X.iloc[0, :].items()}
+    x = X.iloc[0, :]
 
     # Call the published module and score the record
     result = module.score(**x)
+    print(result)

src/sasctl/_services/microanalytic_store.py

@@ -129,23 +129,63 @@ def create_module(self, name=None, description=None, source=None,
         return r
 
     def define_steps(self, module):
+        """Defines python methods on a module that automatically call the
+        corresponding MAS steps.
+
+        Parameters
+        ----------
+        module : str or dict
+            Name, id, or dictionary representation of a module
+
+        Returns
+        -------
+        module
+
+        """
         import types
 
         module = self.get_module(module)
 
+        # Define a method for each step of the module
         for id in module.get('stepIds', []):
             step = self.get_module_step(module, id)
 
-            name = '_{}_{}'.format(module.name, step.id)
+            # Method should have an argument for each parameter of the step
             arguments = [k['name'] for k in step.inputs]
             arg_types = [k['type'] for k in step.inputs]
+
+            # Format call to execute_module_step()
             call_params = ['{}={}'.format(i, i) for i in arguments]
+
+            # Set type hints for the function
             type_string = '    # type: ({})'.format(', '.join(arg_types))
 
-            code = ('def {}({}):'.format(name, ', '.join(arguments)),
+            # Method signature
+            signature = 'def _%s_%s(%s, **kwargs):' % (module.name,
+            step.id,
+                                                       ', '.join(a for a
+                                                                    in arguments))
+            # MAS always lower-cases variable names
+            # Since the original Python variables may have a different case,
+            # allow kwargs to be used to input alternative caps
+            arg_checks = ['for k in kwargs.keys():']
+            for arg in arguments:
+                arg_checks.append("    if k.lower() == '%s':" % arg.lower())
+                arg_checks.append("        %s = kwargs[k]" % arg)
+                arg_checks.append("        continue")
+
+            # Full method source code
+            # Drops 'rc' and 'msg' from return values
+            code = (signature,
                     type_string,
-                    '    """docstring"""',
-                    '    return execute_module_step(module, step, return_dict=False, {})'.format(', '.join(call_params))
+                    '    """Execute step %s of module %s."""' % (step, module),
+                    '\n'.join(['    %s' % a for a in arg_checks]),
+                    '    r = execute_module_step(module, step, {})'.format(', '.join(call_params)),
+                    '    r.pop("rc", None)',
+                    '    r.pop("msg", None)',
+                    '    if len(r) == 1:',
+                    '        return r.popitem()[1]',
+                    '    return tuple(v for v in r.values())'
                     )
 
             code = '\n'.join(code)
@@ -156,7 +196,9 @@ def define_steps(self, module):
                         'module': module,
                         'step': step})
 
-            func = types.FunctionType(compiled.co_consts[0], env)
+            func = types.FunctionType(compiled.co_consts[0],
+                                      env,
+                                      argdefs=tuple(None for x in arguments))
 
             setattr(module, step.id, func)
 

src/sasctl/core.py

@@ -33,7 +33,8 @@
     except ImportError:
         kerberos = None
 
-from sasctl.utils.cli import sasctl_command
+from .utils.cli import sasctl_command
+from . import exceptions
 
 logger = logging.getLogger(__name__)
 
@@ -491,7 +492,7 @@ def _get_token_with_password(self):
                                       auth=('sas.ec', ''))
 
         if r.status_code == 401:
-            raise AuthenticationError("Authentication failed for user '%s'." % username)
+            raise exceptions.AuthenticationError(username)
         else:
             r.raise_for_status()
 
@@ -902,6 +903,3 @@ class SasctlError(Exception):
 
 class TimeoutError(SasctlError):
     pass
-
-class AuthenticationError(SasctlError):
-    pass

src/sasctl/exceptions.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python
+# encoding: utf-8
+#
+# Copyright © 2019, SAS Institute Inc., Cary, NC, USA.  All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+
+class AuthenticationError(ValueError):
+    """A user could not be authenticated."""
+
+    def __init__(self, username, *args, **kwargs):
+        msg = "Authentication failed for user '%s'." % username
+        super(AuthenticationError, self).__init__(msg, *args, **kwargs)
+
+

src/sasctl/tasks.py

@@ -220,9 +220,10 @@ def publish_model(model, destination, code=None, max_retries=60, **kwargs):
     # A successfully submitted request doesn't mean a successfully published model.
     # Response for publish request includes link to check publish log
     job = mr._monitor_job(publish_req)
-    # log = mr._monitor_job(request_link(publish_req, 'publishingLog'),
-    #                       'self',
-    #                       lambda x: x.get('log', '').upper().startswith('SUCCESS==='))
+
+    if job.state.lower() == 'failed':
+        pass
+
     log = request_link(job, 'publishingLog')
     msg = log.get('log').lstrip('SUCCESS===')
 

test_requirements.txt

@@ -7,5 +7,4 @@ pandas
 swat
 sphinx == 1.8
 tox
-kerberos ; platform_system != "Windows"
-winkerberos ; platform_system == "Windows"
+kerberos ; platform_system != "Windows"