flywheel-sdk 20.4.0rc1__py2.py3-none-any.whl → 20.5.0__py2.py3-none-any.whl

flywheel/__init__.py

@@ -75,6 +75,7 @@ from flywheel.models.access_type import AccessType
 from flywheel.models.accumulator import Accumulator
 from flywheel.models.acquisition import Acquisition
 from flywheel.models.acquisition_container_output import AcquisitionContainerOutput
+from flywheel.models.acquisition_copy_input import AcquisitionCopyInput
 from flywheel.models.acquisition_input import AcquisitionInput
 from flywheel.models.acquisition_list_output import AcquisitionListOutput
 from flywheel.models.acquisition_modify_input import AcquisitionModifyInput
@@ -669,6 +670,7 @@ from flywheel.models.structured_query_suggestions import StructuredQuerySuggesti
 from flywheel.models.structured_query_value_suggestion import StructuredQueryValueSuggestion
 from flywheel.models.subject import Subject
 from flywheel.models.subject_container_output import SubjectContainerOutput
+from flywheel.models.subject_copy_input import SubjectCopyInput
 from flywheel.models.subject_input import SubjectInput
 from flywheel.models.subject_modify import SubjectModify
 from flywheel.models.subject_node import SubjectNode

flywheel/api/acquisitions_api.py

@@ -31,6 +31,122 @@ class AcquisitionsApi(object):
             api_client = ApiClient()
         self.api_client = api_client
 
+    def acquisition_copy(self, acquisition_id, body, **kwargs):  # noqa: E501
+        """Smart copy an acquisition
+
+        Smart copy an acquisition
+        This method makes a synchronous HTTP request by default.
+
+        :param str acquisition_id: (required)
+        :param AcquisitionCopyInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Acquisition
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.acquisition_copy_with_http_info(acquisition_id, body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.acquisition_copy_with_http_info(acquisition_id, body, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def acquisition_copy_with_http_info(self, acquisition_id, body, **kwargs):  # noqa: E501
+        """Smart copy an acquisition
+
+        Smart copy an acquisition
+        This method makes a synchronous HTTP request by default.
+
+        :param str acquisition_id: (required)
+        :param AcquisitionCopyInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Acquisition
+        """
+
+        all_params = ['acquisition_id','body',]  # noqa: E501
+        all_params.append('async_')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+        all_params.append('_request_out')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method acquisition_copy" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'acquisition_id' is set
+        if ('acquisition_id' not in params or
+                params['acquisition_id'] is None):
+            raise ValueError("Missing the required parameter `acquisition_id` when calling `acquisition_copy`")  # noqa: E501
+        # verify the required parameter 'body' is set
+        if ('body' not in params or
+                params['body'] is None):
+            raise ValueError("Missing the required parameter `body` when calling `acquisition_copy`")  # noqa: E501
+        check_filename_params(params)
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'acquisition_id' in params:
+            path_params['acquisition_id'] = params['acquisition_id']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'body' in params:
+            if 'AcquisitionCopyInput'.startswith('union'):
+                body_type = type(params['body'])
+                if getattr(body_type, 'positional_to_model', None):
+                    body_params = body_type.positional_to_model(params['body'])
+                else:
+                    body_params = params['body']
+            else:
+                body_params = flywheel.models.AcquisitionCopyInput.positional_to_model(params['body'])
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['ApiKey']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/acquisitions/{acquisition_id}/copy', 'POST',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='Acquisition',  # noqa: E501
+            auth_settings=auth_settings,
+            async_=params.get('async_'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            _request_out=params.get('_request_out'),
+            collection_formats=collection_formats)
+
     def add_acquisition(self, body, **kwargs):  # noqa: E501
         """Create a new acquisition
 

flywheel/api/sessions_api.py

@@ -5014,7 +5014,7 @@ class SessionsApi(object):
         :param str session_id: (required)
         :param SessionCopyInput body: (required)
         :param bool async_: Perform the request asynchronously
-        :return: None
+        :return: Session
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -5041,7 +5041,7 @@ class SessionsApi(object):
         :param str session_id: (required)
         :param SessionCopyInput body: (required)
         :param bool async_: Perform the request asynchronously
-        :return: None
+        :return: Session
         """
 
         all_params = ['session_id','body',]  # noqa: E501
@@ -5112,7 +5112,7 @@ class SessionsApi(object):
             body=body_params,
             post_params=form_params,
             files=local_var_files,
-            response_type=None,  # noqa: E501
+            response_type='Session',  # noqa: E501
             auth_settings=auth_settings,
             async_=params.get('async_'),
             _return_http_data_only=params.get('_return_http_data_only'),

flywheel/api/subjects_api.py

@@ -4961,6 +4961,122 @@ class SubjectsApi(object):
             _request_out=params.get('_request_out'),
             collection_formats=collection_formats)
 
+    def subject_copy(self, subject_id, body, **kwargs):  # noqa: E501
+        """Smart copy a subject
+
+        Smart copy a subject
+        This method makes a synchronous HTTP request by default.
+
+        :param str subject_id: (required)
+        :param SubjectCopyInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Subject
+        """
+        ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
+        kwargs['_return_http_data_only'] = True
+
+        if kwargs.get('async_'):
+            return self.subject_copy_with_http_info(subject_id, body, **kwargs)  # noqa: E501
+        else:
+            (data) = self.subject_copy_with_http_info(subject_id, body, **kwargs)  # noqa: E501
+            if (
+                data
+                and hasattr(data, 'return_value')
+                and not ignore_simplified_return_value
+            ):
+                return data.return_value()
+            return data
+
+
+    def subject_copy_with_http_info(self, subject_id, body, **kwargs):  # noqa: E501
+        """Smart copy a subject
+
+        Smart copy a subject
+        This method makes a synchronous HTTP request by default.
+
+        :param str subject_id: (required)
+        :param SubjectCopyInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Subject
+        """
+
+        all_params = ['subject_id','body',]  # noqa: E501
+        all_params.append('async_')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+        all_params.append('_request_out')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method subject_copy" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'subject_id' is set
+        if ('subject_id' not in params or
+                params['subject_id'] is None):
+            raise ValueError("Missing the required parameter `subject_id` when calling `subject_copy`")  # noqa: E501
+        # verify the required parameter 'body' is set
+        if ('body' not in params or
+                params['body'] is None):
+            raise ValueError("Missing the required parameter `body` when calling `subject_copy`")  # noqa: E501
+        check_filename_params(params)
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'subject_id' in params:
+            path_params['subject_id'] = params['subject_id']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'body' in params:
+            if 'SubjectCopyInput'.startswith('union'):
+                body_type = type(params['body'])
+                if getattr(body_type, 'positional_to_model', None):
+                    body_params = body_type.positional_to_model(params['body'])
+                else:
+                    body_params = params['body']
+            else:
+                body_params = flywheel.models.SubjectCopyInput.positional_to_model(params['body'])
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['ApiKey']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/subjects/{subject_id}/copy', 'POST',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='Subject',  # noqa: E501
+            auth_settings=auth_settings,
+            async_=params.get('async_'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            _request_out=params.get('_request_out'),
+            collection_formats=collection_formats)
+
     def upload_file_to_subject(self, container_id, file, **kwargs):  # noqa: E501
         """Upload a file to a(n) subject.
 

flywheel/api_client.py

@@ -84,7 +84,7 @@ class ApiClient(object):
         self.default_query_params = []
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'Swagger-Codegen/20.4.0-rc1/python'
+        self.user_agent = 'Swagger-Codegen/20.5.0/python'
         self.last_response = None
         self._version_check_fn = None
         self._context = context

flywheel/configuration.py

@@ -253,8 +253,8 @@ class Configuration(six.with_metaclass(TypeWithDefault, object)):
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 20.4.0-rc1\n"\
-               "SDK Package Version: 20.4.0-rc1".\
+               "Version of the API: 20.5.0\n"\
+               "SDK Package Version: 20.5.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def enable_message_cutoff(self, message_cutoff):

flywheel/drone_login.py

@@ -1,4 +1,5 @@
 """Provides Drone-based login credentials"""
+
 import requests
 from .rest import ApiException
 from .client import Client
@@ -21,7 +22,7 @@ def create_drone_client(host, secret, method, name, port=443, **kwargs):
         util.set_verify_ssl(session)
 
         # Get auth status to determine device id
-        force_insecure = kwargs.pop("_force_insecure", False) == True
+        force_insecure = kwargs.pop("_force_insecure", False) is True
         if force_insecure:
             base_uri = "http://{}:{}/api".format(host, port)
         else:

flywheel/finder.py

@@ -89,15 +89,15 @@ class Finder(object):
 
             while True:
                 results = self._func(*self._args, **kwargs)
-                if 'results' in results:
-                    results = results.get('results', [])
+                if "results" in results:
+                    results = results.get("results", [])
 
                 if not results:
                     break
 
                 for item in results:
                     yield item
-                
+
                 if "file_id" in results[-1]:
                     kwargs["after_id"] = results[-1].file_id
                 else:
@@ -110,8 +110,8 @@ class Finder(object):
 
             while True:
                 results = self._func(*self._args, **kwargs)
-                if 'results' in results:
-                    results = results.get('results', [])
+                if "results" in results:
+                    results = results.get("results", [])
 
                 if not results:
                     break
@@ -128,15 +128,14 @@ class Finder(object):
         return self._fn
 
     def __find(self, filters, kwargs, find_first=False, find_one=False):
-
         if filters:
             kwargs["filter"] = ",".join(filters)
 
         if find_one:
             kwargs["limit"] = 2  # We only need one some get at most 2 for error case
             results = self._func(*self._args, **kwargs)
-            if 'results' in results:
-                results = results.get('results', [])
+            if "results" in results:
+                results = results.get("results", [])
             if len(results) > 1:
                 raise ValueError("Found more results than 1!")
             if len(results) == 0:
@@ -146,8 +145,8 @@ class Finder(object):
         if find_first:
             kwargs["limit"] = 1  # always return first so no need for more
             results = self._func(*self._args, **kwargs)
-            if 'results' in results:
-                results = results.get('results', [])
+            if "results" in results:
+                results = results.get("results", [])
             if results:
                 return results[0]
             return None
@@ -164,6 +163,6 @@ class Finder(object):
         # This will pull it to memory though so we should enforce a max limit
         # or deprecate this in favor of iter find
         results = self._func(*self._args, **kwargs)
-        if 'results' in results:
-            results = results.get('results', [])
+        if "results" in results:
+            results = results.get("results", [])
         return results

flywheel/flywheel.py

@@ -40,7 +40,7 @@ from flywheel.view_builder import ViewBuilder
 from flywheel.finder import Finder
 import flywheel.api
 
-SDK_VERSION = "20.4.0-rc1"
+SDK_VERSION = "20.5.0"
 
 def config_from_api_key(api_key):
     parts = api_key.split(':')
@@ -206,6 +206,19 @@ class Flywheel:
         self.api_client.configuration.disable_message_cutoff()
 
 
+    def acquisition_copy(self, acquisition_id, body, **kwargs):  # noqa: E501
+        """Smart copy an acquisition
+
+        Smart copy an acquisition
+
+        :param str acquisition_id: (required)
+        :param AcquisitionCopyInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Acquisition
+        """
+        return self.acquisitions_api.acquisition_copy(acquisition_id, body, **kwargs)
+
+
     def add_acquisition(self, body, **kwargs):  # noqa: E501
         """Create a new acquisition
 
@@ -6301,7 +6314,7 @@ class Flywheel:
         :param str session_id: (required)
         :param SessionCopyInput body: (required)
         :param bool async_: Perform the request asynchronously
-        :return: None
+        :return: Session
         """
         return self.sessions_api.session_copy(session_id, body, **kwargs)
 
@@ -7177,6 +7190,19 @@ class Flywheel:
         return self.subjects_api.rename_subject_tag(cid, value, body, **kwargs)
 
 
+    def subject_copy(self, subject_id, body, **kwargs):  # noqa: E501
+        """Smart copy a subject
+
+        Smart copy a subject
+
+        :param str subject_id: (required)
+        :param SubjectCopyInput body: (required)
+        :param bool async_: Perform the request asynchronously
+        :return: Subject
+        """
+        return self.subjects_api.subject_copy(subject_id, body, **kwargs)
+
+
     def upload_file_to_subject(self, container_id, file, signed=True, **kwargs):  # noqa: E501
         """Upload a file to a(n) subject.
 

flywheel/gear_context.py

@@ -1,4 +1,5 @@
 """Provides gear helper functions"""
+
 import copy
 import json
 import logging
@@ -23,7 +24,7 @@ class GearContext(object):
     def __init__(self, gear_path=None):
         warnings.warn(
             "Please use the Flywheel Gear Toolkit instead: https://flywheel-io.gitlab.io/public/gear-toolkit/index.html",
-            DeprecationWarning
+            DeprecationWarning,
         )
         self._path = os.path.abspath(gear_path or DEFAULT_GEAR_PATH)
         self._client = None
@@ -198,9 +199,7 @@ class GearContext(object):
         if not inp:
             return None
         if inp["base"] != "context":
-            raise ValueError(
-                "The specified input {} is not a context input".format(name)
-            )
+            raise ValueError("The specified input {} is not a context input".format(name))
         return inp.get("value")
 
     def update_container_metadata(self, container_type, *args, **kwargs):
@@ -257,9 +256,7 @@ class GearContext(object):
         with self.open_output(".metadata.json") as f:
             json.dump(self._metadata, f, indent=2)
 
-    def download_session_bids(
-        self, target_dir="work/bids", src_data=False, folders=None, **kwargs
-    ):
+    def download_session_bids(self, target_dir="work/bids", src_data=False, folders=None, **kwargs):
         """Download the session in bids format to target_dir.
 
         :param str target_dir: The destination directory (otherwise work/bids will be used)
@@ -274,13 +271,7 @@ class GearContext(object):
         return self._download_bids("session", target_dir, kwargs)
 
     def download_project_bids(
-        self,
-        target_dir="work/bids",
-        src_data=False,
-        subjects=None,
-        sessions=None,
-        folders=None,
-        **kwargs
+        self, target_dir="work/bids", src_data=False, subjects=None, sessions=None, folders=None, **kwargs
     ):
         """Download the project in bids format to target_dir.
 
@@ -343,9 +334,7 @@ class GearContext(object):
         except ImportError:
             self.log.error("Cannot load flywheel-bids package.")
             self.log.error('Make sure it is installed with "pip install flywheel-bids"')
-            raise RuntimeError(
-                "Unable to load flywheel-bids package, make sure it is installed!"
-            )
+            raise RuntimeError("Unable to load flywheel-bids package, make sure it is installed!")
 
     def _get_invocation(self):
         """Load the invocation"""

flywheel/models/__init__.py

@@ -6,7 +6,7 @@
 
     Flywheel: API for data import, automated curation, image processing, machine learning workflows, and secure collaboration.  # noqa: E501
 
-    OpenAPI spec version: 20.4.0-rc1
+    OpenAPI spec version: 20.5.0
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
@@ -22,6 +22,7 @@ from flywheel.models.access_type import AccessType
 from flywheel.models.accumulator import Accumulator
 from flywheel.models.acquisition import Acquisition
 from flywheel.models.acquisition_container_output import AcquisitionContainerOutput
+from flywheel.models.acquisition_copy_input import AcquisitionCopyInput
 from flywheel.models.acquisition_input import AcquisitionInput
 from flywheel.models.acquisition_list_output import AcquisitionListOutput
 from flywheel.models.acquisition_modify_input import AcquisitionModifyInput
@@ -616,6 +617,7 @@ from flywheel.models.structured_query_suggestions import StructuredQuerySuggesti
 from flywheel.models.structured_query_value_suggestion import StructuredQueryValueSuggestion
 from flywheel.models.subject import Subject
 from flywheel.models.subject_container_output import SubjectContainerOutput
+from flywheel.models.subject_copy_input import SubjectCopyInput
 from flywheel.models.subject_input import SubjectInput
 from flywheel.models.subject_modify import SubjectModify
 from flywheel.models.subject_node import SubjectNode

flywheel/models/acquisition_container_output.py

@@ -19,6 +19,7 @@ import re  # noqa: F401
 import six
 
 from flywheel.models.acquisition_parents import AcquisitionParents  # noqa: F401,E501
+from flywheel.models.copy_status import CopyStatus  # noqa: F401,E501
 from flywheel.models.file_output import FileOutput  # noqa: F401,E501
 from flywheel.models.join_origins import JoinOrigins  # noqa: F401,E501
 from flywheel.models.note import Note  # noqa: F401,E501