flywheel-sdk 18.5.0rc0__py2.py3-none-any.whl → 19.0.0rc0__py2.py3-none-any.whl

flywheel/__init__.py

@@ -199,8 +199,8 @@ from flywheel.models.container_uidcheck import ContainerUidcheck
 from flywheel.models.container_update import ContainerUpdate
 from flywheel.models.context_input import ContextInput
 from flywheel.models.core_models_api_key_api_key_input import CoreModelsApiKeyApiKeyInput
+from flywheel.models.core_models_common_source import CoreModelsCommonSource
 from flywheel.models.core_models_jobs_api_key_input import CoreModelsJobsApiKeyInput
-from flywheel.models.core_models_source_source import CoreModelsSourceSource
 from flywheel.models.create_report_input import CreateReportInput
 from flywheel.models.creds import Creds
 from flywheel.models.curator import Curator
@@ -475,7 +475,7 @@ from flywheel.models.output_user_page import OutputUserPage
 from flywheel.models.packfile_cleanup_output import PackfileCleanupOutput
 from flywheel.models.packfile_removed_output import PackfileRemovedOutput
 from flywheel.models.page import Page
-from flywheel.models.page_file_output_ import PageFileOutput_
+from flywheel.models.page_generic_file_output import PageGenericFileOutput
 from flywheel.models.parent_type import ParentType
 from flywheel.models.parsed_query_response import ParsedQueryResponse
 from flywheel.models.permission_access_permission import PermissionAccessPermission

flywheel/api/files_api.py

@@ -363,7 +363,7 @@ class FilesApi(object):
         :param int page:
         :param str after_id:
         :param bool async_: Perform the request asynchronously
-        :return: PageFileOutput_
+        :return: PageGenericFileOutput
         """
         ignore_simplified_return_value = kwargs.pop('_ignore_simplified_return_value', False)
         kwargs['_return_http_data_only'] = True
@@ -394,7 +394,7 @@ class FilesApi(object):
         :param int page:
         :param str after_id:
         :param bool async_: Perform the request asynchronously
-        :return: PageFileOutput_
+        :return: PageGenericFileOutput
         """
 
         all_params = ['filter','sort','limit','skip','page','after_id',]  # noqa: E501
@@ -453,7 +453,7 @@ class FilesApi(object):
             body=body_params,
             post_params=form_params,
             files=local_var_files,
-            response_type='PageFileOutput_',  # noqa: E501
+            response_type='PageGenericFileOutput',  # noqa: E501
             auth_settings=auth_settings,
             async_=params.get('async_'),
             _return_http_data_only=params.get('_return_http_data_only'),

flywheel/api/projects_api.py

@@ -7513,6 +7513,7 @@ class ProjectsApi(object):
 
         :param str project_id: (required)
         :param ProjectHierarchyInput body: (required)
+        :param str uid_scope:
         :param bool async_: Perform the request asynchronously
         :return: ProjectHierarchyOutput
         """
@@ -7540,11 +7541,12 @@ class ProjectsApi(object):
 
         :param str project_id: (required)
         :param ProjectHierarchyInput body: (required)
+        :param str uid_scope:
         :param bool async_: Perform the request asynchronously
         :return: ProjectHierarchyOutput
         """
 
-        all_params = ['project_id','body',]  # noqa: E501
+        all_params = ['project_id','body','uid_scope',]  # noqa: E501
         all_params.append('async_')
         all_params.append('_return_http_data_only')
         all_params.append('_preload_content')
@@ -7576,6 +7578,8 @@ class ProjectsApi(object):
             path_params['project_id'] = params['project_id']  # noqa: E501
 
         query_params = []
+        if 'uid_scope' in params:
+            query_params.append(('uid_scope', params['uid_scope']))  # noqa: E501
 
         header_params = {}
 

flywheel/api_client.py

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

flywheel/configuration.py

@@ -252,6 +252,6 @@ class Configuration(six.with_metaclass(TypeWithDefault, object)):
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: 18.5.0-rc0\n"\
-               "SDK Package Version: 18.5.0-rc0".\
+               "Version of the API: 19.0.0-rc0\n"\
+               "SDK Package Version: 19.0.0-rc0".\
                format(env=sys.platform, pyversion=sys.version)

flywheel/flywheel.py

@@ -27,6 +27,7 @@ import io
 import platform
 import logging
 import mimetypes
+import warnings
 from packaging import version
 from urllib.parse import urlparse, parse_qs
 
@@ -39,7 +40,7 @@ from flywheel.view_builder import ViewBuilder
 from flywheel.finder import Finder
 import flywheel.api
 
-SDK_VERSION = "18.5.0-rc0"
+SDK_VERSION = "19.0.0-rc0"
 
 def config_from_api_key(api_key):
     parts = api_key.split(':')
@@ -72,9 +73,27 @@ def config_from_api_key(api_key):
 
 
 class Flywheel:
+    """Main client class for the Python SDK.
+
+    Normally initialized via a call to `flywheel.Client` rather than by directly
+    calling this class.
+
+    :param str api_key: The API key to authenticate with.
+    :param int minimum_supported_major_version: Minimum major version of the SDK the
+        caller accepts.
+    :param bool root: Sets default parameter for requests to return a complete list
+        regardless of permissions - for site admin users. Deprecated - use `exhaustive`
+        instead.
+    :param bool skip_version_check: Deprecated--does nothing.
+    :param bool subjects_in_resolver: Deprecated--does nothing.
+    :param int request_timeout: The client timeout for making requests, in seconds.
+    :param int connect_timeout: The client timeout for making connections, in seconds.
+    :param bool exhaustive: Sets default parameter for requests to return a complete
+        list regardless of permissions - for site admin users.
+    """
     def __init__(self, api_key, minimum_supported_major_version=0, root=False,
-                 skip_version_check=True, subjects_in_resolver=None,
-                 request_timeout=None, connect_timeout=None):
+                 skip_version_check=None, subjects_in_resolver=None,
+                 request_timeout=None, connect_timeout=None, exhaustive=False):
 
         # Check that the client caller is expecting the minimum supported version
         if minimum_supported_major_version < 11:
@@ -91,9 +110,24 @@ class Flywheel:
             connect_timeout=connect_timeout
         )
 
+        # skip_version_check (Deprecated)
+        if skip_version_check is not None:
+            log.warning('The skip_version_check parameter is deprecated')
+            warnings.warn('The skip_version_check parameter is deprecated', DeprecationWarning)
+
+        # subjects in resolver (deprecated)
+        if subjects_in_resolver is not None:
+            log.warning('The subjects_in_resolver parameter is deprecated')
+            warnings.warn('The subjects_in_resolver parameter is deprecated', DeprecationWarning)
+
         # Root mode (Deprecated)
         if root:
             log.warning('Root mode is deprecated')
+            warnings.warn('Root mode is deprecated', DeprecationWarning)
+            self.api_client.set_default_query_param('exhaustive', 'true')
+
+        # exhaustive mode
+        if exhaustive:
             self.api_client.set_default_query_param('exhaustive', 'true')
 
         self.api_client.user_agent = 'Flywheel SDK/{} (Python {}; {})'.format(SDK_VERSION,
@@ -155,10 +189,6 @@ class Flywheel:
         catalog_list._func
         self.catalog_list = catalog_list
 
-        # Enable subjects in resolver by default
-        if subjects_in_resolver is None:
-            subjects_in_resolver = os.environ.get('FLYWHEEL_SDK_SUBJECTS_IN_RESOLVER', '').lower() not in ['0', 'false']
-
         self.enable_feature('Safe-Redirect')
         self.enable_feature('multipart_signed_url')
 
@@ -2996,7 +3026,7 @@ class Flywheel:
         :param int page:
         :param str after_id:
         :param bool async_: Perform the request asynchronously
-        :return: PageFileOutput_
+        :return: PageGenericFileOutput
         """
         return self.files_api.get_all_files(**kwargs)
 
@@ -4968,6 +4998,7 @@ class Flywheel:
 
         :param str project_id: (required)
         :param ProjectHierarchyInput body: (required)
+        :param str uid_scope:
         :param bool async_: Perform the request asynchronously
         :return: ProjectHierarchyOutput
         """

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: 18.5.0-rc0
+    OpenAPI spec version: 19.0.0-rc0
     
     Generated by: https://github.com/swagger-api/swagger-codegen.git
 """
@@ -147,8 +147,8 @@ from flywheel.models.container_uidcheck import ContainerUidcheck
 from flywheel.models.container_update import ContainerUpdate
 from flywheel.models.context_input import ContextInput
 from flywheel.models.core_models_api_key_api_key_input import CoreModelsApiKeyApiKeyInput
+from flywheel.models.core_models_common_source import CoreModelsCommonSource
 from flywheel.models.core_models_jobs_api_key_input import CoreModelsJobsApiKeyInput
-from flywheel.models.core_models_source_source import CoreModelsSourceSource
 from flywheel.models.create_report_input import CreateReportInput
 from flywheel.models.creds import Creds
 from flywheel.models.curator import Curator
@@ -423,7 +423,7 @@ from flywheel.models.output_user_page import OutputUserPage
 from flywheel.models.packfile_cleanup_output import PackfileCleanupOutput
 from flywheel.models.packfile_removed_output import PackfileRemovedOutput
 from flywheel.models.page import Page
-from flywheel.models.page_file_output_ import PageFileOutput_
+from flywheel.models.page_generic_file_output import PageGenericFileOutput
 from flywheel.models.parent_type import ParentType
 from flywheel.models.parsed_query_response import ParsedQueryResponse
 from flywheel.models.permission_access_permission import PermissionAccessPermission

flywheel/models/acquisition_list_output.py

@@ -102,7 +102,7 @@ class AcquisitionListOutput(AcquisitionMixin):
         'original_copy_of': 'original_copy_of'
     }
 
-    def __init__(self, id=None, parents=None, label=None, session=None, info=None, info_exists=None, metadata=None, uid=None, timestamp=None, timezone=None, created=None, tags=None, modified=None, revision=1, permissions=None, notes=None, analyses=None, collections=None, join_origin=None, files=None, copy_of=None, original_copy_of=None):  # noqa: E501
+    def __init__(self, id=None, parents=None, label=None, session=None, info=None, info_exists=False, metadata=None, uid=None, timestamp=None, timezone=None, created=None, tags=None, modified=None, revision=1, permissions=None, notes=None, analyses=None, collections=None, join_origin=None, files=None, copy_of=None, original_copy_of=None):  # noqa: E501
         """AcquisitionListOutput - a model defined in Swagger"""
         super(AcquisitionListOutput, self).__init__()
 
@@ -137,7 +137,8 @@ class AcquisitionListOutput(AcquisitionMixin):
             self.label = label
         self.session = session
         self.info = info
-        self.info_exists = info_exists
+        if info_exists is not None:
+            self.info_exists = info_exists
         if metadata is not None:
             self.metadata = metadata
         if uid is not None:

flywheel/models/acquisition_upsert_input.py

@@ -18,7 +18,7 @@ import pprint
 import re  # noqa: F401
 import six
 
-from flywheel.models.core_models_source_source import CoreModelsSourceSource  # noqa: F401,E501
+from flywheel.models.core_models_common_source import CoreModelsCommonSource  # noqa: F401,E501
 
 class AcquisitionUpsertInput(object):
 
@@ -27,7 +27,7 @@ class AcquisitionUpsertInput(object):
         'uid': 'str',
         'routing_field': 'str',
         'label': 'str',
-        'source': 'CoreModelsSourceSource',
+        'source': 'CoreModelsCommonSource',
         'timestamp': 'datetime',
         'timezone': 'str',
         'info': 'object'
@@ -177,7 +177,7 @@ class AcquisitionUpsertInput(object):
 
 
         :return: The source of this AcquisitionUpsertInput.
-        :rtype: CoreModelsSourceSource
+        :rtype: CoreModelsCommonSource
         """
         return self._source
 
@@ -187,7 +187,7 @@ class AcquisitionUpsertInput(object):
 
 
         :param source: The source of this AcquisitionUpsertInput.  # noqa: E501
-        :type: CoreModelsSourceSource
+        :type: CoreModelsCommonSource
         """
 
         self._source = source

flywheel/models/analysis_list_output.py

@@ -145,10 +145,8 @@ class AnalysisListOutput(AnalysisMixin):
             self.compute_provider_id = compute_provider_id
         if join_origin is not None:
             self.join_origin = join_origin
-        if copy_of is not None:
-            self.copy_of = copy_of
-        if original_copy_of is not None:
-            self.original_copy_of = original_copy_of
+        self.copy_of = copy_of
+        self.original_copy_of = original_copy_of
         if timestamp is not None:
             self.timestamp = timestamp
         if info is not None:

flywheel/models/analysis_list_output_inflated_job.py

@@ -142,10 +142,8 @@ class AnalysisListOutputInflatedJob(object):
             self.compute_provider_id = compute_provider_id
         if join_origin is not None:
             self.join_origin = join_origin
-        if copy_of is not None:
-            self.copy_of = copy_of
-        if original_copy_of is not None:
-            self.original_copy_of = original_copy_of
+        self.copy_of = copy_of
+        self.original_copy_of = original_copy_of
 
     @property
     def id(self):

flywheel/models/analysis_output.py

@@ -148,10 +148,8 @@ class AnalysisOutput(AnalysisMixin):
             self.compute_provider_id = compute_provider_id
         if join_origin is not None:
             self.join_origin = join_origin
-        if copy_of is not None:
-            self.copy_of = copy_of
-        if original_copy_of is not None:
-            self.original_copy_of = original_copy_of
+        self.copy_of = copy_of
+        self.original_copy_of = original_copy_of
 
     @property
     def id(self):

flywheel/models/analysis_output_inflated_job.py

@@ -148,10 +148,8 @@ class AnalysisOutputInflatedJob(object):
             self.compute_provider_id = compute_provider_id
         if join_origin is not None:
             self.join_origin = join_origin
-        if copy_of is not None:
-            self.copy_of = copy_of
-        if original_copy_of is not None:
-            self.original_copy_of = original_copy_of
+        self.copy_of = copy_of
+        self.original_copy_of = original_copy_of
 
     @property
     def id(self):

flywheel/models/classic_batch_proposal_input.py

@@ -20,6 +20,7 @@ import six
 
 from flywheel.models.batch_job_analysis_input import BatchJobAnalysisInput  # noqa: F401,E501
 from flywheel.models.container_reference import ContainerReference  # noqa: F401,E501
+from flywheel.models.optional_input_policy import OptionalInputPolicy  # noqa: F401,E501
 
 class ClassicBatchProposalInput(object):
 
@@ -245,7 +246,6 @@ class ClassicBatchProposalInput(object):
     def optional_input_policy(self):
         """Gets the optional_input_policy of this ClassicBatchProposalInput.
 
-        ignored: Ignore all optional inputs, flexible: match a file if it's there, otherwise still match the container, required: treat all optional inputs as required inputs.
 
         :return: The optional_input_policy of this ClassicBatchProposalInput.
         :rtype: OptionalInputPolicy
@@ -256,7 +256,6 @@ class ClassicBatchProposalInput(object):
     def optional_input_policy(self, optional_input_policy):
         """Sets the optional_input_policy of this ClassicBatchProposalInput.
 
-        ignored: Ignore all optional inputs, flexible: match a file if it's there, otherwise still match the container, required: treat all optional inputs as required inputs.
 
         :param optional_input_policy: The optional_input_policy of this ClassicBatchProposalInput.  # noqa: E501
         :type: OptionalInputPolicy

flywheel/models/classic_batch_proposal_output.py

@@ -19,6 +19,7 @@ import re  # noqa: F401
 import six
 
 from flywheel.models.job_state import JobState  # noqa: F401,E501
+from flywheel.models.optional_input_policy import OptionalInputPolicy  # noqa: F401,E501
 from flywheel.models.origin import Origin  # noqa: F401,E501
 
 from .mixins import BatchProposalMixin
@@ -102,8 +103,7 @@ class ClassicBatchProposalOutput(BatchProposalMixin):
             self.created = created
         if modified is not None:
             self.modified = modified
-        if optional_input_policy is not None:
-            self.optional_input_policy = optional_input_policy
+        self.optional_input_policy = optional_input_policy
         self.ambiguous = ambiguous
         self.not_matched = not_matched
         self.matched = matched
@@ -267,7 +267,6 @@ class ClassicBatchProposalOutput(BatchProposalMixin):
     def optional_input_policy(self):
         """Gets the optional_input_policy of this ClassicBatchProposalOutput.
 
-        ignored: Ignore all optional inputs, flexible: match a file if it's there, otherwise still match the container, required: treat all optional inputs as required inputs.
 
         :return: The optional_input_policy of this ClassicBatchProposalOutput.
         :rtype: OptionalInputPolicy
@@ -278,7 +277,6 @@ class ClassicBatchProposalOutput(BatchProposalMixin):
     def optional_input_policy(self, optional_input_policy):
         """Sets the optional_input_policy of this ClassicBatchProposalOutput.
 
-        ignored: Ignore all optional inputs, flexible: match a file if it's there, otherwise still match the container, required: treat all optional inputs as required inputs.
 
         :param optional_input_policy: The optional_input_policy of this ClassicBatchProposalOutput.  # noqa: E501
         :type: OptionalInputPolicy

flywheel/models/column.py

@@ -18,6 +18,9 @@ import pprint
 import re  # noqa: F401
 import six
 
+from flywheel.models.accumulator import Accumulator  # noqa: F401,E501
+from flywheel.models.type_str import TypeStr  # noqa: F401,E501
+
 class Column(object):
 
     swagger_types = {
@@ -116,7 +119,6 @@ class Column(object):
     def type(self):
         """Gets the type of this Column.
 
-        The type that this value should be translated to (for typed output)
 
         :return: The type of this Column.
         :rtype: TypeStr
@@ -127,7 +129,6 @@ class Column(object):
     def type(self, type):
         """Sets the type of this Column.
 
-        The type that this value should be translated to (for typed output)
 
         :param type: The type of this Column.  # noqa: E501
         :type: TypeStr
@@ -162,7 +163,6 @@ class Column(object):
     def accumulator(self):
         """Gets the accumulator of this Column.
 
-        Accumulation operator for an a group by aggregation
 
         :return: The accumulator of this Column.
         :rtype: Accumulator
@@ -173,7 +173,6 @@ class Column(object):
     def accumulator(self, accumulator):
         """Sets the accumulator of this Column.
 
-        Accumulation operator for an a group by aggregation
 
         :param accumulator: The accumulator of this Column.  # noqa: E501
         :type: Accumulator

flywheel/models/container_pipeline_input.py

@@ -19,6 +19,7 @@ import re  # noqa: F401
 import six
 
 from flywheel.models.column import Column  # noqa: F401,E501
+from flywheel.models.data_strategy import DataStrategy  # noqa: F401,E501
 from flywheel.models.data_view_file_spec import DataViewFileSpec  # noqa: F401,E501
 from flywheel.models.group_by import GroupBy  # noqa: F401,E501
 from flywheel.models.origin import Origin  # noqa: F401,E501
@@ -350,7 +351,6 @@ class ContainerPipelineInput(object):
     def missing_data_strategy(self):
         """Gets the missing_data_strategy of this ContainerPipelineInput.
 
-        What to do if missing data are encountered. Default is none, which is to say replace with an empty or null value.
 
         :return: The missing_data_strategy of this ContainerPipelineInput.
         :rtype: DataStrategy
@@ -361,7 +361,6 @@ class ContainerPipelineInput(object):
     def missing_data_strategy(self, missing_data_strategy):
         """Sets the missing_data_strategy of this ContainerPipelineInput.
 
-        What to do if missing data are encountered. Default is none, which is to say replace with an empty or null value.
 
         :param missing_data_strategy: The missing_data_strategy of this ContainerPipelineInput.  # noqa: E501
         :type: DataStrategy

flywheel/models/{core_models_source_source.py → core_models_common_source.py}

@@ -18,7 +18,7 @@ import pprint
 import re  # noqa: F401
 import six
 
-class CoreModelsSourceSource(object):
+class CoreModelsCommonSource(object):
 
     swagger_types = {
         'type': 'str',
@@ -36,8 +36,8 @@ class CoreModelsSourceSource(object):
     }
 
     def __init__(self, type=None, id=None):  # noqa: E501
-        """CoreModelsSourceSource - a model defined in Swagger"""
-        super(CoreModelsSourceSource, self).__init__()
+        """CoreModelsCommonSource - a model defined in Swagger"""
+        super(CoreModelsCommonSource, self).__init__()
 
         self._type = None
         self._id = None
@@ -49,20 +49,20 @@ class CoreModelsSourceSource(object):
 
     @property
     def type(self):
-        """Gets the type of this CoreModelsSourceSource.
+        """Gets the type of this CoreModelsCommonSource.
 
 
-        :return: The type of this CoreModelsSourceSource.
+        :return: The type of this CoreModelsCommonSource.
         :rtype: str
         """
         return self._type
 
     @type.setter
     def type(self, type):
-        """Sets the type of this CoreModelsSourceSource.
+        """Sets the type of this CoreModelsCommonSource.
 
 
-        :param type: The type of this CoreModelsSourceSource.  # noqa: E501
+        :param type: The type of this CoreModelsCommonSource.  # noqa: E501
         :type: str
         """
 
@@ -70,20 +70,20 @@ class CoreModelsSourceSource(object):
 
     @property
     def id(self):
-        """Gets the id of this CoreModelsSourceSource.
+        """Gets the id of this CoreModelsCommonSource.
 
 
-        :return: The id of this CoreModelsSourceSource.
+        :return: The id of this CoreModelsCommonSource.
         :rtype: str
         """
         return self._id
 
     @id.setter
     def id(self, id):
-        """Sets the id of this CoreModelsSourceSource.
+        """Sets the id of this CoreModelsCommonSource.
 
 
-        :param id: The id of this CoreModelsSourceSource.  # noqa: E501
+        :param id: The id of this CoreModelsCommonSource.  # noqa: E501
         :type: str
         """
 
@@ -133,7 +133,7 @@ class CoreModelsSourceSource(object):
 
     def __eq__(self, other):
         """Returns true if both objects are equal"""
-        if not isinstance(other, CoreModelsSourceSource):
+        if not isinstance(other, CoreModelsCommonSource):
             return False
 
         return self.__dict__ == other.__dict__

flywheel/models/data_view_column_alias.py

@@ -18,6 +18,8 @@ import pprint
 import re  # noqa: F401
 import six
 
+from flywheel.models.column_type import ColumnType  # noqa: F401,E501
+
 class DataViewColumnAlias(object):
 
     swagger_types = {
@@ -173,7 +175,6 @@ class DataViewColumnAlias(object):
     def type(self):
         """Gets the type of this DataViewColumnAlias.
 
-        The type that this value should be translated to (for typed output)
 
         :return: The type of this DataViewColumnAlias.
         :rtype: ColumnType
@@ -184,7 +185,6 @@ class DataViewColumnAlias(object):
     def type(self, type):
         """Sets the type of this DataViewColumnAlias.
 
-        The type that this value should be translated to (for typed output)
 
         :param type: The type of this DataViewColumnAlias.  # noqa: E501
         :type: ColumnType

flywheel/models/data_view_execution.py

@@ -18,6 +18,8 @@ import pprint
 import re  # noqa: F401
 import six
 
+from flywheel.models.data_view_execution_state import DataViewExecutionState  # noqa: F401,E501
+
 class DataViewExecution(object):
 
     swagger_types = {
@@ -251,7 +253,6 @@ class DataViewExecution(object):
     def state(self):
         """Gets the state of this DataViewExecution.
 
-        The expected data file format, default is auto-detect
 
         :return: The state of this DataViewExecution.
         :rtype: DataViewExecutionState
@@ -262,7 +263,6 @@ class DataViewExecution(object):
     def state(self, state):
         """Sets the state of this DataViewExecution.
 
-        The expected data file format, default is auto-detect
 
         :param state: The state of this DataViewExecution.  # noqa: E501
         :type: DataViewExecutionState