clams-python 1.2.0__tar.gz → 1.2.2__tar.gz

{clams-python-1.2.0/clams_python.egg-info → clams_python-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clams-python
-Version: 1.2.0
+Version: 1.2.2
 Summary: A collection of APIs to develop CLAMS app for python
 Home-page: https://clams.ai
 Author: Brandeis Lab for Linguistics and Computation
@@ -14,7 +14,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: mmif-python==1.0.13
+Requires-Dist: mmif-python==1.0.14
 Requires-Dist: Flask>=2
 Requires-Dist: Flask-RESTful>=0.3.9
 Requires-Dist: gunicorn>=20

clams_python-1.2.2/VERSION

@@ -0,0 +1 @@
+1.2.2

{clams-python-1.2.0 → clams_python-1.2.2}/clams/app/__init__.py

@@ -122,7 +122,9 @@ class ClamsApp(ABC):
             if key not in self.annotate_param_spec:
                 issued_warnings.append(UserWarning(f'An undefined parameter "{key}" (value: "{runtime_params[key]}") is passed'))
         # this will do casting + refinement altogether
+        self.logger.debug(f"User parameters: {runtime_params}")
         refined = self._refine_params(**runtime_params)
+        self.logger.debug(f"Refined parameters: {refined}")
         pretty = refined.get('pretty', False)
         with warnings.catch_warnings(record=True) as ws:
             annotated = self._annotate(mmif, **refined)
@@ -176,7 +178,14 @@ class ClamsApp(ABC):
                     raise ValueError(f"Value for parameter \"{parameter.name}\" must be one of {parameter.choices}.")
                 refined[parameter.name] = casted[parameter.name]
             elif parameter.default is not None:
-                refined[parameter.name] = parameter.default
+                # have to cast the default values as well, since 
+                # 1. `map` type default values are not actually expected as a map (dict)
+                # 2. developers can use data type not matching the spec
+                if isinstance(parameter.default, list):
+                    casted_default = self.annotate_param_caster.cast({parameter.name: list(map(str, parameter.default))})
+                else:
+                    casted_default = self.annotate_param_caster.cast({parameter.name: [str(parameter.default)]})
+                refined.update(casted_default)
             else:
                 raise ValueError(f"Cannot find configuration for a required parameter \"{parameter.name}\".")
         # raw input params are hidden under a special key
@@ -202,11 +211,12 @@ class ClamsApp(ABC):
         :param runtime_conf: runtime configuration of the app as k-v pairs
         """
         view.metadata.app = self.metadata.identifier
+        params_map = {p.name: p for p in self.metadata.parameters}
         if self._RAW_PARAMS_KEY in runtime_conf:
             for k, v in runtime_conf.items():
                 if k == self._RAW_PARAMS_KEY:
                     for orik, oriv in v.items():
-                        if orik in self.metadata.parameters and self.metadata.parameters[orik].multivalued:
+                        if orik in params_map and params_map[orik].multivalued:
                             view.metadata.add_parameter(orik, str(oriv))
                         else:
                             view.metadata.add_parameter(orik, oriv[0])
@@ -215,7 +225,7 @@ class ClamsApp(ABC):
         else:
             # meaning the parameters directly from flask or argparser and values are in lists
             for k, v in runtime_conf.items():
-                if k in self.metadata.parameters and self.metadata.parameters[k].multivalued:
+                if k in params_map and params_map[k].multivalued:
                     view.metadata.add_parameter(k, str(v))
                 else:
                     view.metadata.add_parameter(k, v[0])
@@ -335,8 +345,8 @@ class ParameterCaster(object):
             assert isinstance(vs, list), f"Expected a list of values for key {k}, but got {vs} of type {type(vs)}"
             assert all(isinstance(v, str) for v in vs), f"Expected a list of strings for key {k}, but got {vs} of types {[type(v) for v in vs]}"
             if k in self.param_spec:
+                valuetype, multivalued = self.param_spec[k]
                 for v in vs:
-                    valuetype, multivalued = self.param_spec[k]
                     if multivalued or k not in casted:  # effectively only keeps the first value for non-multi params
                         if valuetype == bool:
                             v = self.bool_param(v)
@@ -355,11 +365,22 @@ class ParameterCaster(object):
                                 casted.setdefault(k, []).append(v)
                         else: 
                             casted[k] = v
+                # when an empty value is passed (usually as a default value)
+                # just add an empty list or dict as a placeholder
+                # explicit check for `len == 0` is required to prevent 
+                # empty values are set for params that don't have default values
+                if multivalued and len(vs) == 0:
+                    if valuetype == dict:
+                        casted.setdefault(k, {})
+                    else:
+                        casted.setdefault(k, [])
             else:
-                if len(vs) > 1:
-                    casted[k] = vs
-                else:
+                # if the parameter is not defined in the spec, there's no easy way to figure out 
+                # the user's intention whether it should be a list (multivalued) or a single value.
+                if len(vs) == 1:
                     casted[k] = vs[0]
+                else:
+                    casted[k] = vs
         return casted  # pytype: disable=bad-return-type
 
     @staticmethod

{clams-python-1.2.0 → clams_python-1.2.2}/clams/develop/templates/app/app.py.template

@@ -13,7 +13,6 @@ The app.py script does several things:
 
 import argparse
 import logging
-from typing import Union
 
 # Imports needed for Clams and MMIF.
 # Non-NLP Clams applications will require AnnotationTypes
@@ -36,7 +35,7 @@ class $APP_CLASS_NAME(ClamsApp):
         # When using the ``metadata.py`` leave this do-nothing "pass" method here. 
         pass
 
-    def _annotate(self, mmif: Union[str, dict, Mmif], **parameters) -> Mmif:
+    def _annotate(self, mmif: Mmif, **parameters) -> Mmif:
         # see https://sdk.clams.ai/autodoc/clams.app.html#clams.app.ClamsApp._annotate
         raise NotImplementedError
 

{clams-python-1.2.0 → clams_python-1.2.2}/clams/restify/__init__.py

@@ -124,7 +124,9 @@ class ClamsHTTPApi(Resource):
 
         :return: Returns app metadata in a HTTP response.
         """
-        return self.json_to_response(self.cla.appmetadata(**request.args))
+        # this will catch duplicate arguments with different values into a list under the key
+        raw_params = request.args.to_dict(flat=False)
+        return self.json_to_response(self.cla.appmetadata(**raw_params))
 
     def post(self) -> Response:
         """

clams_python-1.2.2/clams/ver/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.2.2"

{clams-python-1.2.0 → clams_python-1.2.2/clams_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clams-python
-Version: 1.2.0
+Version: 1.2.2
 Summary: A collection of APIs to develop CLAMS app for python
 Home-page: https://clams.ai
 Author: Brandeis Lab for Linguistics and Computation
@@ -14,7 +14,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: mmif-python==1.0.13
+Requires-Dist: mmif-python==1.0.14
 Requires-Dist: Flask>=2
 Requires-Dist: Flask-RESTful>=0.3.9
 Requires-Dist: gunicorn>=20

{clams-python-1.2.0 → clams_python-1.2.2}/clams_python.egg-info/requires.txt

@@ -1,4 +1,4 @@
-mmif-python==1.0.13
+mmif-python==1.0.14
 Flask>=2
 Flask-RESTful>=0.3.9
 gunicorn>=20

{clams-python-1.2.0 → clams_python-1.2.2}/requirements.txt

@@ -1,4 +1,4 @@
-mmif-python==1.0.13
+mmif-python==1.0.14
 
 Flask>=2
 Flask-RESTful>=0.3.9

{clams-python-1.2.0 → clams_python-1.2.2}/tests/test_clamsapp.py

@@ -236,8 +236,8 @@ class TestClamsApp(unittest.TestCase):
         self.assertEqual(v1.metadata.app, self.app.metadata.identifier)
         self.assertEqual(len(v1.metadata.parameters), 0)
         v2 = m.new_view()
-        raw_query_string_arguments = {'undefined_param1': ['value1']}  # values are lists as our restifier uses `to_dict(flat=False)`
-        self.app.sign_view(v2, self.app._refine_params(**raw_query_string_arguments))
+        args2 = {'undefined_param1': ['value1']}  # values are lists as our restifier uses `to_dict(flat=False)`
+        self.app.sign_view(v2, self.app._refine_params(**args2))
         self.assertEqual(v2.metadata.app, self.app.metadata.identifier)
         self.assertEqual(len(v2.metadata.parameters), 1)
         self.assertFalse(clams.ClamsApp._RAW_PARAMS_KEY in v2.metadata.appConfiguration)
@@ -245,8 +245,22 @@ class TestClamsApp(unittest.TestCase):
             # any parameter with defaults should be recorded
             if param.default is not None:
                 self.assertTrue(param.name in v2.metadata.appConfiguration)
-            elif param.name not in raw_query_string_arguments:
+            elif param.name not in args2:
                 self.assertFalse(param.name in v2.metadata.appConfiguration)
+        v3 = m.new_view()
+        self.app.metadata.add_parameter('multivalued_param', 'dummy parameter with multivalues', type='string', multivalued=True, default=[])
+        args3 = {'undefined_param1': ['value1']} 
+        self.app.sign_view(v3, self.app._refine_params(**args3))
+        self.assertEqual(len(v3.metadata.parameters), 1)
+        self.assertEqual(len(v3.metadata.appConfiguration), 3)  # universal (pretty) + `raise_error` in metadata.py + `multivalued_param`
+        self.assertEqual(v3.metadata.appConfiguration['multivalued_param'], [])
+        v4 = m.new_view()
+        multiple_values = ['value1', 'value2']
+        args4 = {'multivalued_param': multiple_values}
+        self.app.sign_view(v4, self.app._refine_params(**args4))
+        self.assertEqual(len(v4.metadata.parameters), 1)
+        self.assertEqual(len(v4.metadata.appConfiguration), 3)
+        self.assertEqual(len(v4.metadata.parameters['multivalued_param']), len(str(multiple_values)))
 
     def test_annotate(self):
         # The example app is hard-coded to **always** emit version mismatch warning
@@ -307,6 +321,10 @@ class TestClamsApp(unittest.TestCase):
                                         description='float +def +mv')
         self.app.metadata.add_parameter('param7', type='number', default=[], multivalued=True,
                                         description='float +def +empty +mv')
+        # need to manually rebuild caster object, because the metadata has updated after the app is initialized
+        for param_spec in self.app.metadata.parameters:
+            self.app.annotate_param_spec[param_spec.name] = (param_spec.type, param_spec.multivalued)
+        self.app.annotate_param_caster = ParameterCaster(self.app.annotate_param_spec)
         with self.assertRaises(ValueError):
             self.app._refine_params(**{})  # param1 is required, but not passed
         dummy_params = {'param1': ['okay'], 'non_parameter': ['should be ignored']}
@@ -375,7 +393,7 @@ class TestRestifier(unittest.TestCase):
     def test_can_put_as_json(self):
         put = self.app.put('/', data=ExampleInputMMIF.get_mmif(), headers={"Content-Type": "Application/json"})
         self.assertIsNotNone(put)
-        self.assertEqual(put.status_code, 200)
+        self.assertEqual(200, put.status_code)
         self.assertIsNotNone(Mmif(put.get_data(as_text=True)))
 
     def test_can_pass_params(self):

clams-python-1.2.0/VERSION

@@ -1 +0,0 @@
-1.2.0

clams-python-1.2.0/clams/ver/__init__.py

@@ -1 +0,0 @@
-__version__ = "1.2.0"