clams-python 1.2.3__tar.gz → 1.2.5__tar.gz

{clams_python-1.2.3/clams_python.egg-info → clams_python-1.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clams-python
-Version: 1.2.3
+Version: 1.2.5
 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.15
+Requires-Dist: mmif-python==1.0.17
 Requires-Dist: Flask>=2
 Requires-Dist: Flask-RESTful>=0.3.9
 Requires-Dist: gunicorn>=20

clams_python-1.2.5/VERSION

@@ -0,0 +1 @@
+1.2.5

{clams_python-1.2.3 → clams_python-1.2.5}/clams/app/__init__.py

@@ -142,7 +142,7 @@ class ClamsApp(ABC):
                 issued_warnings.extend(ws)
         if issued_warnings:
             warnings_view = annotated.new_view()
-            self.sign_view(warnings_view, runtime_params)
+            self.sign_view(warnings_view, refined)
             warnings_view.metadata.warnings = issued_warnings
         return annotated.serialize(pretty=pretty, sanitize=True)
 
@@ -260,7 +260,7 @@ class ClamsApp(ABC):
                 break
         if error_view is None:
             error_view = mmif.new_view()
-            self.sign_view(error_view, runtime_conf)
+            self.sign_view(error_view, self._refine_params(**runtime_conf))
         exc_info = sys.exc_info()
         error_view.set_error(f'{exc_info[0]}: {exc_info[1]}',
                              '\t\n'.join(traceback.format_tb(exc_info[2])))

{clams_python-1.2.3 → clams_python-1.2.5}/clams/develop/__init__.py

@@ -171,6 +171,7 @@ def prep_argparser(**kwargs):
     parser.add_argument(
         '-u', '--update',
         action='count',
+        default=0,  #  > Note, the default will be None unless explicitly set to 0. (https://docs.python.org/3/library/argparse.html#action)
         help=f'Set update level by passing this flag multiple times. This is EXPERIMENTAL, and developers MUST NOT'
              f'rely on the update results, and should conduct manual checks afterward. LEVEL 0: does not update and '
              f'raise an error when existing directory found. LEVEL 1: generate non-existing files and generate '

{clams_python-1.2.3 → clams_python-1.2.5}/clams/develop/templates/app/Containerfile.template

@@ -1,11 +1,11 @@
 # Use the same base image version as the clams-python python library version
 FROM ghcr.io/clamsproject/clams-python:$CLAMS_VERSION
 # See https://github.com/orgs/clamsproject/packages?tab=packages&q=clams-python for more base images
-# IF you want to automatically publish this image to the clamsproject organization, 
+# IF you want to automatically publish this image to the clamsproject organization,
 # 1. you should have generated this template without --no-github-actions flag
-# 1. to add arm64 support, change relevant line in .github/workflows/container.yml 
-#     * NOTE that a lots of software doesn't install/compile or run on arm64 architecture out of the box 
-#     * make sure you locally test the compatibility of all software dependencies before using arm64 support 
+# 1. to add arm64 support, change relevant line in .github/workflows/container.yml
+#     * NOTE that a lots of software doesn't install/compile or run on arm64 architecture out of the box
+#     * make sure you locally test the compatibility of all software dependencies before using arm64 support
 # 1. use a git tag to trigger the github action. You need to use git tag to properly set app version anyway
 
 ################################################################################
@@ -15,17 +15,17 @@ ENV CLAMS_APP_VERSION ${CLAMS_APP_VERSION}
 ################################################################################
 
 ################################################################################
-# This is duplicate from the base image Containerfile 
+# This is duplicate from the base image Containerfile
 # but makes sure the cache directories are consistent across all CLAMS apps
 
 # https://github.com/openai/whisper/blob/ba3f3cd54b0e5b8ce1ab3de13e32122d0d5f98ab/whisper/__init__.py#L130
-ENV XDG_CACHE_HOME='/cache'  
+ENV XDG_CACHE_HOME='/cache'
 # https://huggingface.co/docs/huggingface_hub/main/en/package_reference/environment_variables#hfhome
 ENV HF_HOME="/cache/huggingface"
 # https://pytorch.org/docs/stable/hub.html#where-are-my-downloaded-models-saved
 ENV TORCH_HOME="/cache/torch"
 
-RUN mkdir /cache && rm -rf /root/.cache && ln -s /cache /root/.cache
+RUN mkdir /cache ; rm -rf /root/.cache && ln -s /cache /root/.cache
 ################################################################################
 
 ################################################################################
@@ -37,8 +37,8 @@ RUN mkdir /cache && rm -rf /root/.cache && ln -s /cache /root/.cache
 # main app installation
 COPY ./ /app
 WORKDIR /app
-RUN pip3 install -r requirements.txt
+RUN pip3 install --no-cache-dir -r requirements.txt
 
-# default command to run the CLAMS app in a production server 
+# default command to run the CLAMS app in a production server
 CMD ["python3", "app.py", "--production"]
 ################################################################################

{clams_python-1.2.3 → clams_python-1.2.5}/clams/develop/templates/app/README.md.template

@@ -1,33 +1,33 @@
 # TO_DEVS: BURN AFTER READING
 
-Delete this section of the document once the app development is done, before publishing the repository. 
+Delete this section of the document once the app development is done, before publishing the repository.
 
 ---
-This skeleton code is a scaffolding for Python-based CLAMS app development. Specifically, it contains 
+This skeleton code is a scaffolding for Python-based CLAMS app development. Specifically, it contains
 
-1. `app.py` and `metadata.py` to write the app 
+1. `app.py` and `metadata.py` to write the app
 1. `requirements.txt` to specify python dependencies
 1. `Containerfile` to containerize the app and specify system dependencies
 1. `.gitignore` and `.dockerignore` files listing commonly ignored files
 1. an empty `LICENSE` file to replace with an actual license information of the app
 1. This `README.md` file for additional information not specified in the general user manual at https://apps.clams.ai/clamsapp
-1. A number of GitHub Actions workflows for issue/bug-report management 
+1. A number of GitHub Actions workflows for issue/bugreport management
 1. A GHA workflow to publish app images upon any push of a git tag
    * **NOTE**: All GHA workflows included are designed to only work in repositories under `clamsproject` organization.
 
 Before pushing your first commit, please make sure to delete this section of the document.
 
-Then use the following section to document any additional information specific to this app. If your app works significantly different from what's described in the generic readme file, be as specific as possible. 
+Then use the following section to document any additional information specific to this app. If your app works significantly different from what's described in the generic readme file, be as specific as possible.
 
 
-> **warning** 
+> **warning**
 > TO_DEVS: Delete these `TO_DEVS` notes and warnings before publishing the repository.
 
 ---
 
 # $APP_NAME
 
-> **warning** 
+> **warning**
 > TO_DEVS: Again, delete these `TO_DEVS` notes and warnings before publishing the repository.
 
 ## Description
@@ -37,11 +37,11 @@ Then use the following section to document any additional information specific t
 
 ## User instruction
 
-General user instructions for CLAMS apps is available at [CLAMS Apps documentation](https://apps.clams.ai/clamsapp).
+General user instructions for CLAMS apps are available at [CLAMS Apps documentation](https://apps.clams.ai/clamsapp).
 
 Below is a list of additional information specific to this app.
 
-> **note** 
+> **note**
 > TO_DEVS: Below is a list of additional information specific to this app.
 
 
@@ -57,7 +57,7 @@ Below is a list of additional information specific to this app.
 
 ### Configurable runtime parameter
 
-For the full list of parameters, please refer to the app metadata from [CLAMS App Directory](https://apps.clams.ai) or [`metadata.py`](metadata.py) file in this repository.
+For the full list of parameters, please refer to the app metadata from the [CLAMS App Directory](https://apps.clams.ai) or the [`metadata.py`](metadata.py) file in this repository.
 
 > **warning**
 > TO_DEVS: If you're not developing this app for publishing on the CLAMS App Directory, the above paragraph is not applicable. Feel free to delete or change it.

{clams_python-1.2.3 → clams_python-1.2.5}/clams/develop/templates/app/app.py.template

@@ -6,7 +6,7 @@ app.py Template
 The app.py script does several things:
 - import the necessary code
 - create a subclass of ClamsApp that defines the metadata and provides a method to run the wrapped NLP tool
-- provide a way to run the code as a RESTful Flask service 
+- provide a way to run the code as a RESTful Flask service
 
 
 """
@@ -31,8 +31,8 @@ class $APP_CLASS_NAME(ClamsApp):
 
     def _appmetadata(self):
         # see https://sdk.clams.ai/autodoc/clams.app.html#clams.app.ClamsApp._load_appmetadata
-        # Also check out ``metadata.py`` in this directory. 
-        # When using the ``metadata.py`` leave this do-nothing "pass" method here. 
+        # Also check out ``metadata.py`` in this directory.
+        # When using the ``metadata.py`` leave this do-nothing "pass" method here.
         pass
 
     def _annotate(self, mmif: Mmif, **parameters) -> Mmif:
@@ -41,14 +41,14 @@ class $APP_CLASS_NAME(ClamsApp):
 
 def get_app():
     """
-    This function effectively creates an instance of the app class, without any arguments passed in, meaning, any 
+    This function effectively creates an instance of the app class, without any arguments passed in, meaning, any
     external information such as initial app configuration should be set without using function arguments. The easiest
-    way to do this is to set global variables before calling this. 
+    way to do this is to set global variables before calling this.
     """
-    # for example: 
+    # for example:
     # return $APP_CLASS_NAME(create, from, global, params)
     raise NotImplementedError
-    
+
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser()

{clams_python-1.2.3 → clams_python-1.2.5}/clams/develop/templates/app/cli.py.template

@@ -57,7 +57,7 @@ def metadata_to_argparser(app_metadata: AppMetadata) -> argparse.ArgumentParser:
                              'open.',
                         # will check if stdin is a keyboard, and return None if it is
                         default=None if sys.stdin.isatty() else sys.stdin)
-    parser.add_argument('OUT_MMIF_FILE', nargs='?', type=argparse.FileType('w'), 
+    parser.add_argument('OUT_MMIF_FILE', nargs='?', type=argparse.FileType('w'),
                         help='output MMIF file path, or STDOUT if `-` or not provided. NOTE: When this is set to '
                              'STDOUT, any print statements in the app code will be redirected to stderr.',
                         default=sys.stdout)

{clams_python-1.2.3 → clams_python-1.2.5}/clams/develop/templates/app/metadata.py.template

@@ -1,5 +1,5 @@
 """
-The purpose of this file is to define the metadata of the app with minimal imports. 
+The purpose of this file is to define the metadata of the app with minimal imports.
 
 DO NOT CHANGE the name of the file
 """
@@ -10,12 +10,12 @@ from clams.app import ClamsApp
 from clams.appmetadata import AppMetadata
 
 
-# DO NOT CHANGE the function name 
+# DO NOT CHANGE the function name
 def appmetadata() -> AppMetadata:
     """
     Function to set app-metadata values and return it as an ``AppMetadata`` obj.
     Read these documentations before changing the code below
-    - https://sdk.clams.ai/appmetadata.html metadata specification. 
+    - https://sdk.clams.ai/appmetadata.html metadata specification.
     - https://sdk.clams.ai/autodoc/clams.appmetadata.html python API
     
     :return: AppMetadata object holding all necessary information.
@@ -26,7 +26,7 @@ def appmetadata() -> AppMetadata:
         name="$APP_NAME",
         description="",  # briefly describe what the purpose and features of the app
         app_license="",  # short name for a software license like MIT, Apache2, GPL, etc.
-        identifier="$APP_IDENTIFIER",  # should be a single string without whitespaces. If you don't intent to publish this app to the CLAMS app-directory, please use a full IRI format. 
+        identifier="$APP_IDENTIFIER",  # should be a single string without whitespaces. If you don't intent to publish this app to the CLAMS app-directory, please use a full IRI format.
         url="https://fakegithub.com/some/repository",  # a website where the source code and full documentation of the app is hosted
         # (if you are on the CLAMS team, this MUST be "https://github.com/clamsproject/app-$APP_IDENTIFIER"
         # (see ``.github/README.md`` file in this directory for the reason)

clams_python-1.2.5/clams/ver/__init__.py

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

{clams_python-1.2.3 → clams_python-1.2.5/clams_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: clams-python
-Version: 1.2.3
+Version: 1.2.5
 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.15
+Requires-Dist: mmif-python==1.0.17
 Requires-Dist: Flask>=2
 Requires-Dist: Flask-RESTful>=0.3.9
 Requires-Dist: gunicorn>=20

{clams_python-1.2.3 → clams_python-1.2.5}/clams_python.egg-info/requires.txt

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

{clams_python-1.2.3 → clams_python-1.2.5}/requirements.txt

@@ -1,4 +1,4 @@
-mmif-python==1.0.15
+mmif-python==1.0.17
 
 Flask>=2
 Flask-RESTful>=0.3.9

{clams_python-1.2.3 → clams_python-1.2.5}/tests/test_clamsapp.py

@@ -10,6 +10,7 @@ from typing import Union
 import jsonschema
 import pytest
 from mmif import Mmif, Document, DocumentTypes, AnnotationTypes, View, __specver__
+from mmif.serialize.mmif import ViewsList
 
 import clams.app
 import clams.restify
@@ -352,14 +353,16 @@ class TestClamsApp(unittest.TestCase):
             self.app._refine_params(param1=['p1'], param4=['4'])
             
     def test_error_handling(self):
-        params = {'raise_error': 'true', 'pretty': 'true'}
+        params = {'raise_error': ['true'], 'pretty': ['true']}
         in_mmif = Mmif(self.in_mmif)
         try: 
             out_mmif = self.app.annotate(in_mmif, **params)
         except Exception as e:
             out_mmif_from_str = self.app.set_error_view(self.in_mmif, **params)
             out_mmif_from_mmif = self.app.set_error_view(in_mmif, **params)
-            self.assertEqual(out_mmif_from_mmif.views, out_mmif_from_str.views)
+            self.assertEqual(
+                out_mmif_from_mmif.views.get_last(),
+                out_mmif_from_str.views.get_last())
             out_mmif = out_mmif_from_str
         self.assertIsNotNone(out_mmif)
         last_view: View = next(reversed(out_mmif.views))

clams_python-1.2.3/VERSION

@@ -1 +0,0 @@
-1.2.3

clams_python-1.2.3/clams/ver/__init__.py

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