seqann.feature_client package

Submodules

seqann.feature_client.api_client module

Copyright 2016 SmartBear Software

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

ref: https://github.com/swagger-api/swagger-codegen

class seqann.feature_client.api_client.ApiClient(host=None, header_name=None, header_value=None, cookie=None)[source]

Bases: object

Generic API client for Swagger client library builds.

Swagger generic API client. This client handles the client- server communication, and is invariant across implementations. Specifics of the methods and models for each application are generated from the Swagger templates.

NOTE: This class is auto generated by the swagger code generator program. Ref: https://github.com/swagger-api/swagger-codegen Do not edit the class manually.

Parameters:
  • host – The base path for the server to call.
  • header_name – a header to pass when making calls to the API.
  • header_value – a header value to pass when making calls to the API.
user_agent

Gets user agent.

set_default_header(header_name, header_value)[source]
to_path_value(obj)[source]

Takes value and turn it into a string suitable for inclusion in the path, by url-encoding.

Parameters:obj – object or string value.
Return string:quoted value.
sanitize_for_serialization(obj)[source]

Builds a JSON POST object.

If obj is None, return None. If obj is str, int, long, float, bool, return directly. If obj is datetime.datetime, datetime.date

convert to string in iso8601 format.

If obj is list, sanitize each element in the list. If obj is dict, return the dict. If obj is swagger model, return the properties dict.

Parameters:obj – The data to serialize.
Returns:The serialized form of data.
deserialize(response, response_type)[source]

Deserializes response into an object.

Parameters:
  • response – RESTResponse object to be deserialized.
  • response_type – class literal for deserialzied object, or string of class name.
Returns:

deserialized object.

call_api(resource_path, method, path_params=None, query_params=None, header_params=None, body=None, post_params=None, files=None, response_type=None, auth_settings=None, callback=None, _return_http_data_only=None)[source]

Makes the HTTP request (synchronous) and return the deserialized data. To make an async request, define a function for callback.

Parameters:
  • resource_path – Path to method endpoint.
  • method – Method to call.
  • path_params – Path parameters in the url.
  • query_params – Query parameters in the url.
  • header_params – Header parameters to be placed in the request header.
  • body – Request body.
  • dict (files) – Request post form parameters, for application/x-www-form-urlencoded, multipart/form-data.
  • list (auth_settings) – Auth Settings names for the request.
  • response – Response data type.
  • dict – key -> filename, value -> filepath, for multipart/form-data.
  • function (callback) – Callback function for asynchronous request. If provide this parameter, the request will be called asynchronously.
  • _return_http_data_only – response data without head status code and headers
Returns:

If provide parameter callback, the request will be called asynchronously. The method will return the request thread. If parameter callback is None, then the method will return the response directly.

request(method, url, query_params=None, headers=None, post_params=None, body=None)[source]

Makes the HTTP request using RESTClient.

prepare_post_parameters(post_params=None, files=None)[source]

Builds form parameters.

Parameters:
  • post_params – Normal form parameters.
  • files – File parameters.
Returns:

Form parameters with files.

select_header_accept(accepts)[source]

Returns Accept based on an array of accepts provided.

Parameters:accepts – List of headers.
Returns:Accept (e.g. application/json).
select_header_content_type(content_types)[source]

Returns Content-Type based on an array of content_types provided.

Parameters:content_types – List of content-types.
Returns:Content-Type (e.g. application/json).
update_params_for_auth(headers, querys, auth_settings)[source]

Updates header and query params based on authentication setting.

Parameters:
  • headers – Header parameters dict to be updated.
  • querys – Query parameters dict to be updated.
  • auth_settings – Authentication setting identifiers list.

seqann.feature_client.configuration module

No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

seqann.feature_client.configuration.singleton(cls, *args, **kw)[source]
seqann.feature_client.configuration.Configuration()[source]

seqann.feature_client.rest module

No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class seqann.feature_client.rest.RESTResponse(resp)[source]

Bases: io.IOBase

getheaders()[source]

Returns a dictionary of the response headers.

getheader(name, default=None)[source]

Returns a given response header.

class seqann.feature_client.rest.RESTClientObject(pools_size=4)[source]

Bases: object

request(method, url, query_params=None, headers=None, body=None, post_params=None)[source]
Parameters:
  • method – http request method
  • url – http request url
  • query_params – query parameters in the url
  • headers – http request headers
  • body – request json body, for application/json
  • post_params – request post parameters, application/x-www-form-urlencode and multipart/form-data
GET(url, headers=None, query_params=None)[source]
HEAD(url, headers=None, query_params=None)[source]
OPTIONS(url, headers=None, query_params=None, post_params=None, body=None)[source]
DELETE(url, headers=None, query_params=None, body=None)[source]
POST(url, headers=None, query_params=None, post_params=None, body=None)[source]
PUT(url, headers=None, query_params=None, post_params=None, body=None)[source]
PATCH(url, headers=None, query_params=None, post_params=None, body=None)[source]
exception seqann.feature_client.rest.ApiException(status=None, reason=None, http_resp=None)[source]

Bases: Exception

Module contents

No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 1.0

Generated by: https://github.com/swagger-api/swagger-codegen.git

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.