Skip to content

NeuroVault/neurovault-python-sdk

BranchesTags

Repository files navigation

neurostore-sdk

All ur images r belong to us

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 2022.10.03
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >=3.7

Migration from other generators like python and python-legacy

Changes

  1. This generator uses spec case for all (object) property names and parameter names.
    • So if the spec has a property name like camelCase, it will use camelCase rather than camel_case
    • So you will need to update how you input and read properties to use spec case
  2. Endpoint parameters are stored in dictionaries to prevent collisions (explanation below)
    • So you will need to update how you pass data in to endpoints
  3. Endpoint responses now include the original response, the deserialized response body, and (todo)the deserialized headers
    • So you will need to update your code to use response.body to access deserialized data
  4. All validated data is instantiated in an instance that subclasses all validated Schema classes and Decimal/str/list/tuple/frozendict/NoneClass/BoolClass/bytes/io.FileIO
    • This means that you can use isinstance to check if a payload validated against a schema class
    • This means that no data will be of type None/True/False
      • ingested None will subclass NoneClass
      • ingested True will subclass BoolClass
      • ingested False will subclass BoolClass
      • So if you need to check is True/False/None, instead use instance.is_true_oapg()/.is_false_oapg()/.is_none_oapg()
  5. All validated class instances are immutable except for ones based on io.File
    • This is because if properties were changed after validation, that validation would no longer apply
    • So no changing values or property values after a class has been instantiated
  6. String + Number types with formats
    • String type data is stored as a string and if you need to access types based on its format like date, date-time, uuid, number etc then you will need to use accessor functions on the instance
    • type string + format: See .as_date_oapg, .as_datetime_oapg, .as_decimal_oapg, .as_uuid_oapg
    • type number + format: See .as_float_oapg, .as_int_oapg
    • this was done because openapi/json-schema defines constraints. string data may be type string with no format keyword in one schema, and include a format constraint in another schema
    • So if you need to access a string format based type, use as_date_oapg/as_datetime_oapg/as_decimal_oapg/as_uuid_oapg
    • So if you need to access a number format based type, use as_int_oapg/as_float_oapg
  7. Property access on AnyType(type unset) or object(dict) schemas
    • Only required keys with valid python names are properties like .someProp and have type hints
    • All optional keys may not exist, so properties are not defined for them
    • One can access optional values with dict_instance['optionalProp'] and KeyError will be raised if it does not exist
    • Use get_item_oapg if you need a way to always get a value whether or not the key exists
      • If the key does not exist, schemas.unset is returned from calling dict_instance.get_item_oapg('optionalProp')
      • All required and optional keys have type hints for this method, and @typing.overload is used
      • A type hint is also generated for additionalProperties accessed using this method
    • So you will need to update you code to use some_instance['optionalProp'] to access optional property and additionalProperty values
  8. The location of the api classes has changed
    • Api classes are located in your_package.apis.tags.some_api
    • This change was made to eliminate redundant code generation
    • Legacy generators generated the same endpoint twice if it had > 1 tag on it
    • This generator defines an endpoint in one class, then inherits that class to generate apis by tags and by paths
    • This change reduces code and allows quicker run time if you use the path apis
      • path apis are at your_package.apis.paths.some_path
    • Those apis will only load their needed models, which is less to load than all of the resources needed in a tag api
    • So you will need to update your import paths to the api classes

Why are Oapg and _oapg used in class and method names?

Classes can have arbitrarily named properties set on them Endpoints can have arbitrary operationId method names set For those reasons, I use the prefix Oapg and _oapg to greatly reduce the likelihood of collisions on protected + public classes/methods. oapg stands for OpenApi Python Generator.

Object property spec case

This was done because when payloads are ingested, they can be validated against N number of schemas. If the input signature used a different property name then that has mutated the payload. So SchemaA and SchemaB must both see the camelCase spec named variable. Also it is possible to send in two properties, named camelCase and camel_case in the same payload. That use case should be support so spec case is used.

Parameter spec case

Parameters can be included in different locations including:

  • query
  • path
  • header
  • cookie

Any of those parameters could use the same parameter names, so if every parameter was included as an endpoint parameter in a function signature, they would collide. For that reason, each of those inputs have been separated out into separate typed dictionaries:

  • query_params
  • path_params
  • header_params
  • cookie_params

So when updating your code, you will need to pass endpoint parameters in using those dictionaries.

Endpoint responses

Endpoint responses have been enriched to now include more information. Any response reom an endpoint will now include the following properties: response: urllib3.HTTPResponse body: typing.Union[Unset, Schema] headers: typing.Union[Unset, TODO] Note: response header deserialization has not yet been added

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import neurovault_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import neurovault_sdk

Getting Started

Please follow the installation procedure and then run the following:

import time
import neurovault_sdk
from pprint import pprint
from neurovault_sdk.apis import atlases_api
from neurovault_sdk.model.atlas import Atlas
from neurovault_sdk.model.paginated_atlas_list import PaginatedAtlasList
from neurovault_sdk.model.patched_atlas import PatchedAtlas
# Defining the host is optional and defaults to https://neurovault.org/api
# See configuration.py for a list of all supported configuration parameters.
configuration = neurovault_sdk.Configuration(
    host = "https://neurovault.org/api"
)


# Enter a context with an instance of the API client
with neurovault_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = atlases_api.AtlasesApi(api_client)
    
    try:
        api_response = api_instance.atlases_atlas_query_region_retrieve()
        pprint(api_response)
    except neurovault_sdk.ApiException as e:
        print("Exception when calling AtlasesApi->atlases_atlas_query_region_retrieve: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://neurovault.org/api

Class Method HTTP request Description
AtlasesApi atlases_atlas_query_region_retrieve get /api/atlases/atlas_query_region/
AtlasesApi atlases_atlas_query_voxel_retrieve get /api/atlases/atlas_query_voxel/
AtlasesApi atlases_datatable_retrieve get /api/atlases/{id}/datatable/
AtlasesApi atlases_destroy delete /api/atlases/{id}/
AtlasesApi atlases_list get /api/atlases/
AtlasesApi atlases_partial_update patch /api/atlases/{id}/
AtlasesApi atlases_regions_table_retrieve get /api/atlases/{id}/regions_table/
AtlasesApi atlases_retrieve get /api/atlases/{id}/
AtlasesApi atlases_update put /api/atlases/{id}/
CollectionsApi collections_atlases_create post /api/collections/{id}/atlases/
CollectionsApi collections_atlases_retrieve get /api/collections/{id}/atlases/
CollectionsApi collections_create post /api/collections/
CollectionsApi collections_datatable_retrieve get /api/collections/{id}/datatable/
CollectionsApi collections_destroy delete /api/collections/{id}/
CollectionsApi collections_images_create post /api/collections/{id}/images/
CollectionsApi collections_images_retrieve get /api/collections/{id}/images/
CollectionsApi collections_list get /api/collections/
CollectionsApi collections_nidm_results_create post /api/collections/{id}/nidm_results/
CollectionsApi collections_nidm_results_retrieve get /api/collections/{id}/nidm_results/
CollectionsApi collections_partial_update patch /api/collections/{id}/
CollectionsApi collections_retrieve get /api/collections/{id}/
CollectionsApi collections_update put /api/collections/{id}/
ImagesApi images_datatable_retrieve get /api/images/{id}/datatable/
ImagesApi images_destroy delete /api/images/{id}/
ImagesApi images_list get /api/images/
ImagesApi images_partial_update patch /api/images/{id}/
ImagesApi images_retrieve get /api/images/{id}/
ImagesApi images_update put /api/images/{id}/
MyCollectionsApi my_collections_atlases_create post /api/my_collections/{id}/atlases/
MyCollectionsApi my_collections_atlases_retrieve get /api/my_collections/{id}/atlases/
MyCollectionsApi my_collections_create post /api/my_collections/
MyCollectionsApi my_collections_datatable_retrieve get /api/my_collections/{id}/datatable/
MyCollectionsApi my_collections_destroy delete /api/my_collections/{id}/
MyCollectionsApi my_collections_images_create post /api/my_collections/{id}/images/
MyCollectionsApi my_collections_images_retrieve get /api/my_collections/{id}/images/
MyCollectionsApi my_collections_list get /api/my_collections/
MyCollectionsApi my_collections_nidm_results_create post /api/my_collections/{id}/nidm_results/
MyCollectionsApi my_collections_nidm_results_retrieve get /api/my_collections/{id}/nidm_results/
MyCollectionsApi my_collections_partial_update patch /api/my_collections/{id}/
MyCollectionsApi my_collections_retrieve get /api/my_collections/{id}/
MyCollectionsApi my_collections_update put /api/my_collections/{id}/
NidmResultsApi nidm_results_destroy delete /api/nidm_results/{id}/
NidmResultsApi nidm_results_list get /api/nidm_results/
NidmResultsApi nidm_results_partial_update patch /api/nidm_results/{id}/
NidmResultsApi nidm_results_retrieve get /api/nidm_results/{id}/
NidmResultsApi nidm_results_update put /api/nidm_results/{id}/
UserApi user_retrieve get /api/user/

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in neurovault_sdk.apis and neurovault_sdk.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

  • from neurovault_sdk.apis.default_api import DefaultApi
  • from neurovault_sdk.model.pet import Pet

Solution 1: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import neurovault_sdk
from neurovault_sdk.apis import *
from neurovault_sdk.models import *

About

automatically generated SDK code

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

8 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages