dohq_teamcity package

Subpackages

Submodules

dohq_teamcity.api_client module

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 10.0

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

class dohq_teamcity.api_client.ApiClient(configuration=None, header_name=None, header_value=None, cookie=None)

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:
  • configuration – .Configuration object for this client
  • 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.
  • cookie – a cookie to include in the header when making calls to the API
NATIVE_TYPES_MAPPING = {'bool': <class 'bool'>, 'date': <class 'datetime.date'>, 'datetime': <class 'datetime.datetime'>, 'float': <class 'float'>, 'int': <class 'int'>, 'long': <class 'int'>, 'object': <class 'object'>, 'str': <class 'str'>}
PRIMITIVE_TYPES = (<class 'float'>, <class 'bool'>, <class 'bytes'>, <class 'str'>, <class 'int'>)
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, async_req=None, _return_http_data_only=None, collection_formats=None, _preload_content=True, _request_timeout=None)

Makes the HTTP request (synchronous) and returns deserialized data.

To make an async request, set the async_req parameter.

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.
  • bool (async_req) – execute request asynchronously
  • _return_http_data_only – response data without head status code and headers
  • collection_formats – dict of collection formats for path, query, header, and post parameters.
  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns:

If async_req parameter is True, the request will be called asynchronously. The method will return the request thread. If parameter async_req is False or missing, then the method will return the response directly.
deserialize(response, response_type)

Deserializes response into an object.

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

deserialized object.
parameters_to_tuples(params, collection_formats)

Get parameters as list of tuples, formatting collections.

Parameters:
  • params – Parameters as dict or list of two-tuples
  • collection_formats (dict) – Parameter collection formats
Returns:

Parameters as list of tuples, collections formatted
prepare_post_parameters(post_params=None, files=None)

Builds form parameters.

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

Form parameters with files.
request(method, url, query_params=None, headers=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)

Makes the HTTP request using RESTClient.

sanitize_for_serialization(obj)

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.
select_header_accept(accepts)

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)

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).
set_default_header(header_name, header_value)
update_params_for_auth(headers, querys, auth_settings)

Updates header and query params based on authentication setting.

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

User agent for this API client

dohq_teamcity.configuration module

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 10.0

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

class dohq_teamcity.configuration.Configuration

Bases: object

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.

auth_settings()

Gets Auth Settings dict for api client.

Returns:The Auth Settings information dict.
debug

Debug status

Parameters:value – The debug status, True or False.
Type:bool
get_api_key_with_prefix(identifier)

Gets API key (with prefix if set).

Parameters:identifier – The identifier of apiKey.
Returns:The token for api key authentication.
get_basic_auth_token()

Gets HTTP basic authentication header (string).

Returns:The token for basic HTTP authentication.
logger_file

The logger file.

If the logger_file is None, then add stream handler and remove file handler. Otherwise, add file handler and remove stream handler.

Parameters:value – The logger_file path.
Type:str
logger_format

The logger format.

The logger_formatter will be updated when sets logger_format.

Parameters:value – The format string.
Type:str
to_debug_report()

Gets the essential information for debugging.

Returns:The report for debugging.
class dohq_teamcity.configuration.TypeWithDefault(name, bases, dct)

Bases: type

set_default(default)

dohq_teamcity.rest module

TeamCity REST API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501

OpenAPI spec version: 10.0

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

exception dohq_teamcity.rest.ApiException(status=None, reason=None, http_resp=None)

Bases: Exception

class dohq_teamcity.rest.RESTClientObject(configuration, pools_size=4, maxsize=None)

Bases: object

DELETE(url, headers=None, query_params=None, body=None, _preload_content=True, _request_timeout=None)
GET(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)
HEAD(url, headers=None, query_params=None, _preload_content=True, _request_timeout=None)
OPTIONS(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
PATCH(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
POST(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
PUT(url, headers=None, query_params=None, post_params=None, body=None, _preload_content=True, _request_timeout=None)
request(method, url, query_params=None, headers=None, body=None, post_params=None, _preload_content=True, _request_timeout=None)

Perform requests.

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-urlencoded and multipart/form-data
  • _preload_content – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
class dohq_teamcity.rest.RESTResponse(resp)

Bases: io.IOBase

getheader(name, default=None)

Returns a given response header.

getheaders()

Returns a dictionary of the response headers.

Module contents