girder 3.2.9.dev10__tar.gz → 3.2.9.dev14__tar.gz

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/.circleci/Dockerfile

@@ -1,4 +1,4 @@
-FROM cimg/python:3.8
+FROM cimg/python:3.9
 LABEL maintainer="Kitware, Inc. <kitware@kitware.com>"
 
 # Don't use "sudo"

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/.circleci/config.yml

@@ -5,15 +5,15 @@ executors:
   py3:
     docker:
       # This image uses the newest version of many dependencies
-      - image: girder/girder_test:py38-node14
+      - image: girder/girder_test:py39-node14
     working_directory: /home/circleci/project
   py3-mongo:
     docker:
-      - image: girder/girder_test:py38-node14
+      - image: girder/girder_test:py39-node14
       # Use the oldest supported MongoDB
       # This is equivalent to the deprecated circleci/mongo:<version>-ram image
-      - image: mongo:3.6
-        command: bash -c "mkdir /dev/shm/mongo && mongod --storageEngine ephemeralForTest --nojournal --dbpath=/dev/shm/mongo --noauth --bind_ip_all"
+      - image: mongo:5.0
+        command: bash -c "mongod --noauth --bind_ip_all"
     working_directory: /home/circleci/project
   machine:
     machine:
@@ -28,7 +28,7 @@ commands:
           name: Generate python environment checksum file
           command: ./girder/.circleci/generatePyEnvChecksum.sh > girder/py-env-checksum
       - restore_cache:
-          key: venv-py3.8-{{ arch }}-{{ checksum "girder/py-env-checksum" }}-5
+          key: venv-py3.9-{{ arch }}-{{ checksum "girder/py-env-checksum" }}-5
       - run:
           name: Create virtual environment (if necessary)
           command: if [ ! -d girder_env ]; then python3 -m venv girder_env; fi
@@ -52,7 +52,7 @@ commands:
       - save_cache:
           paths:
             - girder_env
-          key: venv-py3.8-{{ arch }}-{{ checksum "girder/py-env-checksum" }}-5
+          key: venv-py3.9-{{ arch }}-{{ checksum "girder/py-env-checksum" }}-5
 
 jobs:
   server-lint-test:
@@ -107,7 +107,7 @@ jobs:
             --exclude-regex '^server_pytest_core$'
           environment:
             TEST_GROUP: python
-            PYTHON_VERSION: 3.8
+            PYTHON_VERSION: 3.9
             PYTHON_EXECUTABLE: /home/circleci/project/girder_env/bin/python
           working_directory: girder_build
       - persist_to_workspace:
@@ -149,7 +149,7 @@ jobs:
             --script "$CIRCLE_WORKING_DIRECTORY/girder/.circleci/ci_test.cmake"
           environment:
             TEST_GROUP: browser
-            PYTHON_VERSION: 3.8
+            PYTHON_VERSION: 3.9
             PYTHON_EXECUTABLE: /home/circleci/project/girder_env/bin/python
             JASMINE_TIMEOUT: 15000
           working_directory: girder_build
@@ -211,10 +211,11 @@ jobs:
           name: Allow Boto to work with Python 3
           command: sudo rm --force /etc/boto.cfg
       - run:
-          name: Set up Python 3.8
+          name: Set up Python 3.9
           command: |
-             pyenv install 3.8.12 || true
-             pyenv global 3.8.12
+             pyenv install --list
+             pyenv install 3.9.7 || true
+             pyenv global 3.9.7
       - run:
           name: Install system dependencies for Girder plugins
           command: sudo apt-get install -y libldap2-dev libsasl2-dev
@@ -233,7 +234,7 @@ jobs:
           command: >-
             cmake
             ../girder
-            -DPYTHON_VERSION=3.8
+            -DPYTHON_VERSION=3.9
             -DPYTHON_EXECUTABLE=$CIRCLE_WORKING_DIRECTORY/girder_env/bin/python
           working_directory: girder_build
       - run:
@@ -293,7 +294,7 @@ jobs:
 
   ansible-test:
     docker:
-      - image: cimg/python:3.8
+      - image: cimg/python:3.9
     working_directory: ~/project
     steps:
       - run:
@@ -327,7 +328,7 @@ jobs:
           name: Build the Girder test docker
           command: |
             cd .circleci
-            docker build --force-rm -t girder/girder_test:py38-node14 .
+            docker build --force-rm -t girder/girder_test:py39-node14 .
 
   publish-dockers:
     machine:
@@ -342,7 +343,7 @@ jobs:
           name: Build the Girder test docker
           command: |
             cd .circleci
-            docker build --force-rm -t girder/girder_test:py38-node14 .
+            docker build --force-rm -t girder/girder_test:py39-node14 .
       - run:
           name: Publish the images to Docker Hub
           command: |
@@ -356,11 +357,11 @@ jobs:
               docker tag girder/girder:latest "girder/girder:${CIRCLE_TAG}-py3"
               docker push "girder/girder:${CIRCLE_TAG}-py3"
               fi
-              docker push girder/girder_test:py38-node14
+              docker push girder/girder_test:py39-node14
 
   publish:
     docker:
-      - image: cimg/python:3.8
+      - image: cimg/python:3.9
     working_directory: ~/project
     steps:
       - checkout:

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: girder
-Version: 3.2.9.dev10
+Version: 3.2.9.dev14
 Summary: Web-based data management platform
 Home-page: https://girder.readthedocs.org
 Author: Kitware, Inc.
@@ -12,7 +12,7 @@ Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 License-File: LICENSE
 Requires-Dist: boto3
 Requires-Dist: botocore
@@ -24,6 +24,7 @@ Requires-Dist: filelock
 Requires-Dist: jsonschema
 Requires-Dist: Mako
 Requires-Dist: passlib[bcrypt,totp]
+Requires-Dist: packaging
 Requires-Dist: pymongo>=4
 Requires-Dist: PyYAML
 Requires-Dist: psutil
@@ -37,6 +38,17 @@ Provides-Extra: mount
 Requires-Dist: cachetools; extra == "mount"
 Requires-Dist: diskcache; extra == "mount"
 Requires-Dist: fusepy>=3.0; extra == "mount"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 |logo| Girder |build-status| |docs-status| |license-badge| |codecov-badge|
 ==========================================================================

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/clients/python/girder_client/__init__.py

@@ -1,8 +1,8 @@
-from pkg_resources import DistributionNotFound, get_distribution
+import importlib.metadata
 
 try:
-    __version__ = get_distribution(__name__).version
-except DistributionNotFound:
+    __version__ = importlib.metadata.version(__name__)
+except importlib.metadata.PackageNotFoundError:
     # package is not installed
     __version__ = None
 

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/docs/conf.py

@@ -1,20 +1,21 @@
-import pkg_resources
+import importlib.metadata
+import importlib.resources
 
+import packaging.requirements
 from sphinx.domains.python import PythonDomain
 
 # needs_sphinx = '1.6'
 
+
 # Get package imports and version
-# The 'girder' and "girder_client" packages must be installed at this point
-_girder_package = pkg_resources.get_distribution('girder')
-_girder_client_package = pkg_resources.get_distribution('girder_client')
+_girder_package = importlib.metadata.distribution('girder')
+_girder_client_package = importlib.metadata.distribution('girder_client')
 _girder_version = _girder_package.version
 _girder_imports = {
-    _requirement.project_name.lower()
+    packaging.requirements.Requirement(_requirement).name.lower()
     for _package in [_girder_package, _girder_client_package]
-    for _requirement in _package.requires(_package.extras)
+    for _requirement in _package.requires
 }
-# Add importable module names that are different from package names
 _girder_imports |= {
     'botocore',
     'bson',

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/docs/requirements-docs.txt

@@ -1,3 +1,4 @@
 # See tox.ini for documentation on this file.
 Sphinx
 sphinx_rtd_theme
+packaging

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/girder/__init__.py

@@ -1,8 +1,8 @@
-from pkg_resources import DistributionNotFound, get_distribution
+import importlib.metadata
 
 try:
-    __version__ = get_distribution(__name__).version
-except DistributionNotFound:
+    __version__ = importlib.metadata.version(__name__)
+except importlib.metadata.PackageNotFoundError:
     # package is not installed
     __version__ = None
 

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/girder/api/v1/assetstore.py

@@ -82,12 +82,15 @@ class Assetstore(Resource):
                'ignore accessKeyId and secret.', dataType='boolean', required=False)
         .param('serverSideEncryption', 'Whether to use S3 SSE to encrypt the objects uploaded to '
                'this bucket (for S3 type).', dataType='boolean', required=False, default=False)
+        .param('allowS3AcceleratedTransfer', 'Whether to allow clients to requests a data '
+               'transfer using S3 transfer acceleration.', dataType='boolean', required=False,
+               default=False)
         .errorResponse()
         .errorResponse('You are not an administrator.', 403)
     )
     def createAssetstore(self, name, type, root, perms, db, mongohost, replicaset, bucket,
                          prefix, accessKeyId, secret, service, readOnly, region, inferCredentials,
-                         serverSideEncryption):
+                         serverSideEncryption, allowS3AcceleratedTransfer):
         if type == AssetstoreType.FILESYSTEM:
             self.requireParams({'root': root})
             return self._model.createFilesystemAssetstore(
@@ -101,7 +104,8 @@ class Assetstore(Resource):
             return self._model.createS3Assetstore(
                 name=name, bucket=bucket, prefix=prefix, secret=secret,
                 accessKeyId=accessKeyId, service=service, readOnly=readOnly, region=region,
-                inferCredentials=inferCredentials, serverSideEncryption=serverSideEncryption)
+                inferCredentials=inferCredentials, serverSideEncryption=serverSideEncryption,
+                allowS3AcceleratedTransfer=allowS3AcceleratedTransfer)
         else:
             raise RestException('Invalid type parameter')
 
@@ -181,12 +185,16 @@ class Assetstore(Resource):
                'ignore accessKeyId and secret.', dataType='boolean', required=False)
         .param('serverSideEncryption', 'Whether to use S3 SSE to encrypt the objects uploaded to '
                'this bucket (for S3 type).', dataType='boolean', required=False, default=False)
+        .param('allowS3AcceleratedTransfer', 'Whether to allow clients to requests a data '
+               'transfer using S3 transfer acceleration.', dataType='boolean', required=False,
+               default=False)
         .errorResponse()
         .errorResponse('You are not an administrator.', 403)
     )
     def updateAssetstore(self, assetstore, name, root, perms, db, mongohost, replicaset,
                          bucket, prefix, accessKeyId, secret, service, readOnly, region, current,
-                         inferCredentials, serverSideEncryption, params):
+                         inferCredentials, serverSideEncryption, allowS3AcceleratedTransfer,
+                         params):
         assetstore['name'] = name
         assetstore['current'] = current
 
@@ -214,6 +222,7 @@ class Assetstore(Resource):
             assetstore['region'] = region
             assetstore['inferCredentials'] = inferCredentials
             assetstore['serverSideEncryption'] = serverSideEncryption
+            assetstore['allowS3AcceleratedTransfer'] = allowS3AcceleratedTransfer
             if readOnly is not None:
                 assetstore['readOnly'] = readOnly
         else:

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/girder/api/v1/file.py

@@ -73,12 +73,14 @@ class File(Resource):
                required=False)
         .param('assetstoreId', 'Direct the upload to a specific assetstore (admin-only).',
                required=False)
+        .jsonParam('uploadExtraParameters', 'Arbitrary data to send along with the upload request.',
+                   required=False)
         .errorResponse()
         .errorResponse('Write access was denied on the parent folder.', 403)
         .errorResponse('Failed to create upload.', 500)
     )
     def initUpload(self, parentType, parentId, name, size, mimeType, linkUrl, reference,
-                   assetstoreId):
+                   assetstoreId, uploadExtraParameters):
         """
         Before any bytes of the actual file are sent, a request should be made
         to initialize the upload. This creates the temporary record of the
@@ -120,7 +122,8 @@ class File(Resource):
                 # version upgrade.
                 upload = Upload().createUpload(
                     user=user, name=name, parentType=parentType, parent=parent, size=size,
-                    mimeType=mimeType, reference=reference, assetstore=assetstore)
+                    mimeType=mimeType, reference=reference, assetstore=assetstore,
+                    uploadExtraParameters=uploadExtraParameters)
             except OSError as exc:
                 if exc.errno == errno.EACCES:
                     raise GirderException(
@@ -128,7 +131,9 @@ class File(Resource):
                 raise
             if upload['size'] > 0:
                 if chunk:
-                    return Upload().handleChunk(upload, chunk, filter=True, user=user)
+                    return Upload().handleChunk(
+                        upload, chunk, filter=True, user=user,
+                        uploadExtraParameters=uploadExtraParameters)
 
                 return upload
             else:
@@ -195,13 +200,15 @@ class File(Resource):
         .modelParam('uploadId', paramType='formData', model=Upload)
         .param('offset', 'Offset of the chunk in the file.', dataType='integer',
                paramType='query', required=False, default=0)
+        .jsonParam('uploadExtraParameters', 'Arbitrary data to send along with the upload request.',
+                   required=False)
         .errorResponse(('ID was invalid.',
                         'Received too many bytes.',
                         'Chunk is smaller than the minimum size.'))
         .errorResponse('You are not the user who initiated the upload.', 403)
         .errorResponse('Failed to store upload.', 500)
     )
-    def readChunk(self, upload, offset, params):
+    def readChunk(self, upload, offset, uploadExtraParameters, params):
         """
         After the temporary upload record has been created (see initUpload),
         the bytes themselves should be passed up in ordered chunks. The user
@@ -231,7 +238,8 @@ class File(Resource):
                 'Server has received %s bytes, but client sent offset %s.' % (
                     upload['received'], offset))
         try:
-            return Upload().handleChunk(upload, chunk, filter=True, user=user)
+            return Upload().handleChunk(
+                upload, chunk, filter=True, user=user, uploadExtraParameters=uploadExtraParameters)
         except OSError as exc:
             if exc.errno == errno.EACCES:
                 raise Exception('Failed to store upload.')
@@ -254,8 +262,8 @@ class File(Resource):
         .param('contentDisposition', 'Specify the Content-Disposition response '
                'header disposition-type value.', required=False,
                enum=['inline', 'attachment'], default='attachment')
-        .param('extraParameters', 'Arbitrary data to send along with the download request.',
-               required=False)
+        .jsonParam('extraParameters', 'Arbitrary data to send along with the download request.',
+                   required=False)
         .errorResponse('ID was invalid.')
         .errorResponse('Read access was denied on the parent folder.', 403)
     )

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/girder/api/v1/item.py

@@ -272,9 +272,9 @@ class Item(Resource):
                'header disposition-type value, only applied for single file '
                'items.', required=False, enum=['inline', 'attachment'],
                default='attachment')
-        .param('extraParameters', 'Arbitrary data to send along with the '
-               'download request, only applied for single file '
-               'items.', required=False)
+        .jsonParam('extraParameters', 'Arbitrary data to send along with the '
+                   'download request, only applied for single file '
+                   'items.', required=False)
         # single file items could produce other types, too.
         .produces(['application/zip', 'application/octet-stream'])
         .errorResponse('ID was invalid.')

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/girder/cli/__init__.py

@@ -1,9 +1,13 @@
 from click_plugins import with_plugins
-from pkg_resources import iter_entry_points
 import click
+import importlib.metadata
 
 
-@with_plugins(iter_entry_points('girder.cli_plugins'))
+@with_plugins(
+    importlib.metadata.entry_points().select(group='girder.cli_plugins')
+    if hasattr(importlib.metadata.entry_points(), 'select') else
+    importlib.metadata.entry_points().get('girder.cli_plugins', [])
+)
 @click.group(help='Girder: data management platform for the web.',
              context_settings=dict(help_option_names=['-h', '--help']))
 @click.version_option(message='%(version)s')

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/girder/cli/build.py

@@ -1,9 +1,9 @@
+import importlib.resources
 import json
 import os
-from pkg_resources import resource_filename
-from subprocess import check_call
 import shutil
 import sys
+from subprocess import check_call
 
 import click
 
@@ -12,8 +12,7 @@ from girder.constants import STATIC_ROOT_DIR, ServerMode
 from girder.plugin import allPlugins, getPlugin
 from girder.utility import server
 
-
-_GIRDER_BUILD_ASSETS_PATH = os.path.realpath(resource_filename('girder', 'web_client'))
+_GIRDER_BUILD_ASSETS_PATH = str(importlib.resources.files('girder') / 'web_client')
 
 
 @click.command(name='build', help='Build web client static assets.')

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/girder/models/assetstore.py

@@ -132,7 +132,7 @@ class Assetstore(Model):
 
     def createS3Assetstore(self, name, bucket, accessKeyId, secret, prefix='',
                            service='', readOnly=False, region=None, inferCredentials=False,
-                           serverSideEncryption=False):
+                           serverSideEncryption=False, allowS3AcceleratedTransfer=False):
         return self.save({
             'type': AssetstoreType.S3,
             'created': datetime.datetime.utcnow(),
@@ -145,7 +145,8 @@ class Assetstore(Model):
             'service': service,
             'region': region,
             'inferCredentials': inferCredentials,
-            'serverSideEncryption': serverSideEncryption
+            'serverSideEncryption': serverSideEncryption,
+            'allowS3AcceleratedTransfer': allowS3AcceleratedTransfer
         })
 
     def getCurrent(self):

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/girder/models/file.py

@@ -86,7 +86,7 @@ class File(acl_mixin.AccessControlMixin, Model):
         :param contentDisposition: Content-Disposition response header
             disposition-type value.
         :type contentDisposition: str or None
-        :type extraParameters: str or None
+        :type extraParameters: dict or None
         """
         events.trigger('model.file.download.request', info={
             'file': file,

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/girder/models/upload.py

@@ -106,7 +106,7 @@ class Upload(Model):
 
         return doc
 
-    def handleChunk(self, upload, chunk, filter=False, user=None):
+    def handleChunk(self, upload, chunk, filter=False, user=None, uploadExtraParameters=None):
         """
         When a chunk is uploaded, this should be called to process the chunk.
         If this is the final chunk of the upload, this method will finalize
@@ -126,6 +126,9 @@ class Upload(Model):
         :type filter: bool
         :param user: The current user. Only affects behavior if filter=True.
         :type user: dict or None
+        :param uploadExtraParameters: A dict of parameters that will be given to the assetstore
+            adapter for customization of the upload request.
+        :type uploadExtraParameters: Optional[dict]
         """
         from .assetstore import Assetstore
         from .file import File
@@ -134,7 +137,7 @@ class Upload(Model):
         assetstore = Assetstore().load(upload['assetstoreId'])
         adapter = assetstore_utilities.getAssetstoreAdapter(assetstore)
 
-        upload = adapter.uploadChunk(upload, chunk)
+        upload = adapter.uploadChunk(upload, chunk, uploadExtraParameters)
         if '_id' in upload or upload['received'] != upload['size']:
             upload = self.save(upload)
 
@@ -319,12 +322,12 @@ class Upload(Model):
             }
         if reference is not None:
             upload['reference'] = reference
-        upload = adapter.initUpload(upload)
+        upload = adapter.initUpload(upload, uploadExtraParameters=None)
         return self.save(upload)
 
     def createUpload(self, user, name, parentType, parent, size, mimeType=None,
                      reference=None, assetstore=None, attachParent=False,
-                     save=True):
+                     save=True, uploadExtraParameters=None):
         """
         Creates a new upload record, and creates its temporary file
         that the chunks will be written into. Chunks should then be sent
@@ -392,7 +395,7 @@ class Upload(Model):
         else:
             upload['userId'] = None
 
-        upload = adapter.initUpload(upload)
+        upload = adapter.initUpload(upload, uploadExtraParameters)
         if save:
             upload = self.save(upload)
         return upload

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/girder/plugin.py

@@ -2,17 +2,15 @@
 This module defines functions for registering, loading, and querying girder plugins.
 """
 
-import distutils.dist
-from functools import wraps
-import io
+import importlib.metadata
+import importlib.resources
 import json
 import os
-from pkg_resources import iter_entry_points, resource_filename
+from functools import wraps
 
 from girder import logprint
 from girder.exceptions import GirderException
 
-
 _NAMESPACE = 'girder.plugin'
 _pluginRegistry = None
 _pluginLoadOrder = []
@@ -95,7 +93,9 @@ class GirderPlugin(metaclass=_PluginMeta):
     def __init__(self, entrypoint):
         self._name = entrypoint.name
         self._loaded = False
-        self._dist = entrypoint.dist
+        self._dist = (
+            entrypoint.dist if hasattr(entrypoint, 'dist') else
+            importlib.metadata.distribution(entrypoint.value.split(':')[0].split('.')[0]))
         self._metadata = _readPackageMetadata(self._dist)
 
     def npmPackages(self):
@@ -108,10 +108,9 @@ class GirderPlugin(metaclass=_PluginMeta):
         if self.CLIENT_SOURCE_PATH is None:
             return {}
 
-        packageJsonFile = resource_filename(
-            self.__module__,
-            os.path.join(self.CLIENT_SOURCE_PATH, 'package.json')
-        )
+        packageJsonFile = (
+            importlib.resources.files(self.__module__)
+            / self.CLIENT_SOURCE_PATH / 'package.json')
         if not os.path.isfile(packageJsonFile):
             raise Exception('Invalid web client path provided: %s' % packageJsonFile)
 
@@ -134,17 +133,17 @@ class GirderPlugin(metaclass=_PluginMeta):
     @property
     def description(self):
         """Return the plugin description defaulting to the classes docstring."""
-        return self._metadata.description
+        return self._metadata.get('description', self._metadata.get('Summary', ''))
 
     @property
     def url(self):
         """Return a url reference to the plugin (usually a readthedocs page)."""
-        return self._metadata.url
+        return self._metadata.get('url', self._metadata.get('Home-page', ''))
 
     @property
     def version(self):
         """Return the version of the plugin automatically determined from setup.py."""
-        return self._metadata.version
+        return self._dist.version
 
     @property
     def loaded(self):
@@ -157,10 +156,13 @@ class GirderPlugin(metaclass=_PluginMeta):
 
 def _readPackageMetadata(distribution):
     """Get a metadata object associated with a python package."""
-    metadata_string = distribution.get_metadata(distribution.PKG_INFO)
-    metadata = distutils.dist.DistributionMetadata()
-    metadata.read_pkg_file(io.StringIO(metadata_string))
-    return metadata
+    return distribution.metadata
+
+
+def _listPluginEntryPoints():
+    if hasattr(importlib.metadata.entry_points(), 'select'):
+        return importlib.metadata.entry_points().select(group=_NAMESPACE)
+    return importlib.metadata.entry_points().get(_NAMESPACE, [])
 
 
 def _getPluginRegistry():
@@ -175,7 +177,7 @@ def _getPluginRegistry():
         return _pluginRegistry
 
     _pluginRegistry = {}
-    for entryPoint in iter_entry_points(_NAMESPACE):
+    for entryPoint in _listPluginEntryPoints():
         pluginClass = entryPoint.load()
         plugin = pluginClass(entryPoint)
         _pluginRegistry[plugin.name] = plugin

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/girder/utility/abstract_assetstore_adapter.py

@@ -154,7 +154,7 @@ class AbstractAssetstoreAdapter:
             'total': None
         }
 
-    def initUpload(self, upload):
+    def initUpload(self, upload, uploadExtraParameters):
         """
         This must be called before any chunks are uploaded to do any
         additional behavior and optionally augment the upload document. The
@@ -166,7 +166,7 @@ class AbstractAssetstoreAdapter:
         """
         return upload
 
-    def uploadChunk(self, upload, chunk):
+    def uploadChunk(self, upload, chunk, uploadExtraParameters):
         """
         Call this method to process each chunk of an upload.
 
@@ -174,6 +174,9 @@ class AbstractAssetstoreAdapter:
         :type upload: dict
         :param chunk: The file object representing the chunk that was uploaded.
         :type chunk: file
+        :param uploadExtraParameters: A dict of parameters that will be given to the assetstore
+            adapter for customization of the upload request.
+        :type uploadExtraParameters: Optional[dict]
         :returns: Must return the upload document with any optional changes.
         """
         raise NotImplementedError('Must override processChunk in %s.' %
@@ -272,7 +275,7 @@ class AbstractAssetstoreAdapter:
         :param contentDisposition: Value for Content-Disposition response
             header disposition-type value.
         :type contentDisposition: str or None
-        :type extraParameters: str or None
+        :type extraParameters: dict or None
         """
         raise NotImplementedError('Must override downloadFile in %s.' %
                                   self.__class__.__name__)

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/girder/utility/filesystem_assetstore_adapter.py

@@ -121,7 +121,7 @@ class FilesystemAssetstoreAdapter(AbstractAssetstoreAdapter):
             'total': None
         }
 
-    def initUpload(self, upload):
+    def initUpload(self, upload, uploadExtraParameters):
         """
         Generates a temporary file and sets its location in the upload document
         as tempFile. This is the file that the chunks will be appended to.
@@ -132,7 +132,7 @@ class FilesystemAssetstoreAdapter(AbstractAssetstoreAdapter):
         upload['sha512state'] = _hash_state.serializeHex(sha512())
         return upload
 
-    def uploadChunk(self, upload, chunk):
+    def uploadChunk(self, upload, chunk, uploadExtraParameters):
         """
         Appends the chunk into the temporary file.
         """

{girder-3.2.9.dev10 → girder-3.2.9.dev14}/girder/utility/gridfs_assetstore_adapter.py

@@ -111,7 +111,7 @@ class GridFsAssetstoreAdapter(AbstractAssetstoreAdapter):
             self.chunkColl = 'Failed to configure'
             self.unavailable = True
 
-    def initUpload(self, upload):
+    def initUpload(self, upload, uploadExtraParameters):
         """
         Creates a UUID that will be used to uniquely link each chunk to
         """
@@ -119,7 +119,7 @@ class GridFsAssetstoreAdapter(AbstractAssetstoreAdapter):
         upload['sha512state'] = _hash_state.serializeHex(sha512())
         return upload
 
-    def uploadChunk(self, upload, chunk):
+    def uploadChunk(self, upload, chunk, uploadExtraParameters):
         """
         Stores the uploaded chunk in fixed-sized pieces in the chunks
         collection of this assetstore's database.