testit-python-commons 3.12.4__tar.gz → 4.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/PKG-INFO +8 -2
  2. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/README.md +6 -0
  3. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/setup.py +2 -2
  4. testit_python_commons-4.1.0/src/api_client_syncstorage/__init__.py +27 -0
  5. testit_python_commons-4.1.0/src/api_client_syncstorage/api/__init__.py +3 -0
  6. testit_python_commons-4.1.0/src/api_client_syncstorage/api/completion_api.py +301 -0
  7. testit_python_commons-4.1.0/src/api_client_syncstorage/api/health_api.py +158 -0
  8. testit_python_commons-4.1.0/src/api_client_syncstorage/api/system_api.py +158 -0
  9. testit_python_commons-4.1.0/src/api_client_syncstorage/api/test_results_api.py +182 -0
  10. testit_python_commons-4.1.0/src/api_client_syncstorage/api/workers_api.py +308 -0
  11. testit_python_commons-4.1.0/src/api_client_syncstorage/api_client.py +898 -0
  12. testit_python_commons-4.1.0/src/api_client_syncstorage/apis/__init__.py +21 -0
  13. testit_python_commons-4.1.0/src/api_client_syncstorage/configuration.py +450 -0
  14. testit_python_commons-4.1.0/src/api_client_syncstorage/exceptions.py +158 -0
  15. testit_python_commons-4.1.0/src/api_client_syncstorage/model/__init__.py +5 -0
  16. testit_python_commons-4.1.0/src/api_client_syncstorage/model/health_status_response.py +267 -0
  17. testit_python_commons-4.1.0/src/api_client_syncstorage/model/register_request.py +267 -0
  18. testit_python_commons-4.1.0/src/api_client_syncstorage/model/register_response.py +279 -0
  19. testit_python_commons-4.1.0/src/api_client_syncstorage/model/set_worker_status_request.py +271 -0
  20. testit_python_commons-4.1.0/src/api_client_syncstorage/model/set_worker_status_response.py +267 -0
  21. testit_python_commons-4.1.0/src/api_client_syncstorage/model/shutdown_response.py +267 -0
  22. testit_python_commons-4.1.0/src/api_client_syncstorage/model/test_result_cut_api_model.py +279 -0
  23. testit_python_commons-4.1.0/src/api_client_syncstorage/model/test_result_save_response.py +267 -0
  24. testit_python_commons-4.1.0/src/api_client_syncstorage/model_utils.py +2058 -0
  25. testit_python_commons-4.1.0/src/api_client_syncstorage/models/__init__.py +19 -0
  26. testit_python_commons-4.1.0/src/api_client_syncstorage/rest.py +356 -0
  27. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit.py +1 -1
  28. testit_python_commons-4.1.0/src/testit_python_commons/app_properties.py +250 -0
  29. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/client/api_client.py +48 -12
  30. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/client/client_configuration.py +18 -14
  31. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/client/converter.py +50 -84
  32. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/client/helpers/bulk_autotest_helper.py +3 -3
  33. testit_python_commons-4.1.0/src/testit_python_commons/configurations/__init__.py +0 -0
  34. testit_python_commons-4.1.0/src/testit_python_commons/configurations/properties_names.py +48 -0
  35. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/decorators.py +31 -0
  36. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/dynamic_methods.py +48 -9
  37. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/models/link_type.py +3 -0
  38. testit_python_commons-4.1.0/src/testit_python_commons/models/status_type.py +6 -0
  39. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/models/test_result.py +11 -0
  40. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/services/__init__.py +12 -10
  41. testit_python_commons-4.1.0/src/testit_python_commons/services/adapter_manager.py +298 -0
  42. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/services/adapter_manager_configuration.py +8 -7
  43. testit_python_commons-4.1.0/src/testit_python_commons/services/sync_storage/__init__.py +9 -0
  44. testit_python_commons-4.1.0/src/testit_python_commons/services/sync_storage/sync_storage_runner.py +538 -0
  45. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/services/utils.py +1 -1
  46. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons.egg-info/PKG-INFO +8 -2
  47. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons.egg-info/SOURCES.txt +28 -0
  48. testit_python_commons-4.1.0/src/testit_python_commons.egg-info/requires.txt +3 -0
  49. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons.egg-info/top_level.txt +1 -0
  50. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/tests/test_html_escape_utils.py +1 -1
  51. testit_python_commons-3.12.4/src/testit_python_commons/app_properties.py +0 -323
  52. testit_python_commons-3.12.4/src/testit_python_commons/services/adapter_manager.py +0 -128
  53. testit_python_commons-3.12.4/src/testit_python_commons.egg-info/requires.txt +0 -3
  54. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/setup.cfg +0 -0
  55. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/__init__.py +0 -0
  56. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/client/__init__.py +0 -0
  57. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/client/helpers/__init__.py +0 -0
  58. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/client/helpers/threads_manager.py +0 -0
  59. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/client/models/__init__.py +0 -0
  60. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/client/models/threads_for_create_and_result.py +0 -0
  61. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/client/models/threads_for_update_and_result.py +0 -0
  62. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/models/__init__.py +0 -0
  63. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/models/adapter_mode.py +0 -0
  64. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/models/fixture.py +0 -0
  65. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/models/link.py +0 -0
  66. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/models/outcome_type.py +0 -0
  67. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/models/step_result.py +0 -0
  68. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/models/test_result_with_all_fixture_step_results_model.py +0 -0
  69. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/services/fixture_manager.py +0 -0
  70. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/services/fixture_storage.py +0 -0
  71. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/services/logger.py +0 -0
  72. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/services/plugin_manager.py +0 -0
  73. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/services/retry.py +0 -0
  74. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/services/step_manager.py +0 -0
  75. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/services/step_result_storage.py +0 -0
  76. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/step.py +0 -0
  77. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/utils/__init__.py +0 -0
  78. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons/utils/html_escape_utils.py +0 -0
  79. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/src/testit_python_commons.egg-info/dependency_links.txt +0 -0
  80. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/tests/test_app_properties.py +0 -0
  81. {testit_python_commons-3.12.4 → testit_python_commons-4.1.0}/tests/test_dynamic_methods.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: testit-python-commons
3
- Version: 3.12.4
3
+ Version: 4.1.0
4
4
  Summary: Python commons for Test IT
5
5
  Home-page: https://github.com/testit-tms/adapters-python/
6
6
  Author: Integration team
@@ -17,7 +17,7 @@ Classifier: Programming Language :: Python :: 3.12
17
17
  Description-Content-Type: text/markdown
18
18
  Requires-Dist: pluggy
19
19
  Requires-Dist: tomli
20
- Requires-Dist: testit-api-client==7.5.3
20
+ Requires-Dist: testit-api-client==7.5.5
21
21
  Dynamic: author
22
22
  Dynamic: author-email
23
23
  Dynamic: classifier
@@ -28,6 +28,12 @@ Dynamic: license
28
28
  Dynamic: requires-dist
29
29
  Dynamic: summary
30
30
 
31
+ # Sync Storage Integration
32
+
33
+ This library includes built-in support for Sync Storage, enabling coordinated test execution across multiple workers in distributed testing environments.
34
+
35
+ See [SYNC_STORAGE_INTEGRATION.md](SYNC_STORAGE_INTEGRATION.md) for detailed documentation on how the integration works.
36
+
31
37
  # How to enable debug logging?
32
38
  1. Add in **connection_config.ini** file from the root directory of the project:
33
39
  ```
@@ -1,3 +1,9 @@
1
+ # Sync Storage Integration
2
+
3
+ This library includes built-in support for Sync Storage, enabling coordinated test execution across multiple workers in distributed testing environments.
4
+
5
+ See [SYNC_STORAGE_INTEGRATION.md](SYNC_STORAGE_INTEGRATION.md) for detailed documentation on how the integration works.
6
+
1
7
  # How to enable debug logging?
2
8
  1. Add in **connection_config.ini** file from the root directory of the project:
3
9
  ```
@@ -1,6 +1,6 @@
1
1
  from setuptools import find_packages, setup
2
2
 
3
- VERSION = "3.12.4"
3
+ VERSION = "4.1.0"
4
4
 
5
5
  setup(
6
6
  name='testit-python-commons',
@@ -25,5 +25,5 @@ setup(
25
25
  py_modules=['testit', 'testit_python_commons'],
26
26
  packages=find_packages(where='src'),
27
27
  package_dir={'': 'src'},
28
- install_requires=['pluggy', 'tomli', 'testit-api-client==7.5.3']
28
+ install_requires=['pluggy', 'tomli', 'testit-api-client==7.5.5']
29
29
  )
@@ -0,0 +1,27 @@
1
+ # flake8: noqa
2
+
3
+ """
4
+ Sync Storage Service API
5
+
6
+ This is a sync storage service for coordinating test workers. # noqa: E501
7
+
8
+ The version of the OpenAPI document: 1.0
9
+ Generated by: https://openapi-generator.tech
10
+ """
11
+
12
+
13
+ __version__ = "1.0.0"
14
+
15
+ # import ApiClient
16
+ from api_client_syncstorage.api_client import ApiClient
17
+
18
+ # import Configuration
19
+ from api_client_syncstorage.configuration import Configuration
20
+
21
+ # import exceptions
22
+ from api_client_syncstorage.exceptions import OpenApiException
23
+ from api_client_syncstorage.exceptions import ApiAttributeError
24
+ from api_client_syncstorage.exceptions import ApiTypeError
25
+ from api_client_syncstorage.exceptions import ApiValueError
26
+ from api_client_syncstorage.exceptions import ApiKeyError
27
+ from api_client_syncstorage.exceptions import ApiException
@@ -0,0 +1,3 @@
1
+ # do not import all apis into this module because that uses a lot of memory and stack frames
2
+ # if you need the ability to import all apis from one package, import them with
3
+ # from api_client_syncstorage.apis import CompletionApi
@@ -0,0 +1,301 @@
1
+ """
2
+ Sync Storage Service API
3
+
4
+ This is a sync storage service for coordinating test workers. # noqa: E501
5
+
6
+ The version of the OpenAPI document: 1.0
7
+ Generated by: https://openapi-generator.tech
8
+ """
9
+
10
+
11
+ import re # noqa: F401
12
+ import sys # noqa: F401
13
+
14
+ from api_client_syncstorage.api_client import ApiClient, Endpoint as _Endpoint
15
+ from api_client_syncstorage.model_utils import ( # noqa: F401
16
+ check_allowed_values,
17
+ check_validations,
18
+ date,
19
+ datetime,
20
+ file_type,
21
+ none_type,
22
+ validate_and_convert_types
23
+ )
24
+
25
+
26
+ class CompletionApi(object):
27
+ """NOTE: This class is auto generated by OpenAPI Generator
28
+ Ref: https://openapi-generator.tech
29
+
30
+ Do not edit the class manually.
31
+ """
32
+
33
+ def __init__(self, api_client=None):
34
+ if api_client is None:
35
+ api_client = ApiClient()
36
+ self.api_client = api_client
37
+ self.force_completion_get_endpoint = _Endpoint(
38
+ settings={
39
+ 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,),
40
+ 'auth': [],
41
+ 'endpoint_path': '/force-completion',
42
+ 'operation_id': 'force_completion_get',
43
+ 'http_method': 'GET',
44
+ 'servers': None,
45
+ },
46
+ params_map={
47
+ 'all': [
48
+ 'test_run_id',
49
+ ],
50
+ 'required': [
51
+ 'test_run_id',
52
+ ],
53
+ 'nullable': [
54
+ ],
55
+ 'enum': [
56
+ ],
57
+ 'validation': [
58
+ ]
59
+ },
60
+ root_map={
61
+ 'validations': {
62
+ },
63
+ 'allowed_values': {
64
+ },
65
+ 'openapi_types': {
66
+ 'test_run_id':
67
+ (str,),
68
+ },
69
+ 'attribute_map': {
70
+ 'test_run_id': 'testRunId',
71
+ },
72
+ 'location_map': {
73
+ 'test_run_id': 'query',
74
+ },
75
+ 'collection_format_map': {
76
+ }
77
+ },
78
+ headers_map={
79
+ 'accept': [
80
+ 'application/json'
81
+ ],
82
+ 'content_type': [],
83
+ },
84
+ api_client=api_client
85
+ )
86
+ self.wait_completion_get_endpoint = _Endpoint(
87
+ settings={
88
+ 'response_type': (bool, date, datetime, dict, float, int, list, str, none_type,),
89
+ 'auth': [],
90
+ 'endpoint_path': '/wait-completion',
91
+ 'operation_id': 'wait_completion_get',
92
+ 'http_method': 'GET',
93
+ 'servers': None,
94
+ },
95
+ params_map={
96
+ 'all': [
97
+ 'test_run_id',
98
+ ],
99
+ 'required': [
100
+ 'test_run_id',
101
+ ],
102
+ 'nullable': [
103
+ ],
104
+ 'enum': [
105
+ ],
106
+ 'validation': [
107
+ ]
108
+ },
109
+ root_map={
110
+ 'validations': {
111
+ },
112
+ 'allowed_values': {
113
+ },
114
+ 'openapi_types': {
115
+ 'test_run_id':
116
+ (str,),
117
+ },
118
+ 'attribute_map': {
119
+ 'test_run_id': 'testRunId',
120
+ },
121
+ 'location_map': {
122
+ 'test_run_id': 'query',
123
+ },
124
+ 'collection_format_map': {
125
+ }
126
+ },
127
+ headers_map={
128
+ 'accept': [
129
+ 'application/json'
130
+ ],
131
+ 'content_type': [],
132
+ },
133
+ api_client=api_client
134
+ )
135
+
136
+ def force_completion_get(
137
+ self,
138
+ test_run_id,
139
+ **kwargs
140
+ ):
141
+ """Force completion of a test run # noqa: E501
142
+
143
+ Force processing completion for a specific test run. # noqa: E501
144
+ This method makes a synchronous HTTP request by default. To make an
145
+ asynchronous HTTP request, please pass async_req=True
146
+
147
+ >>> thread = api.force_completion_get(test_run_id, async_req=True)
148
+ >>> result = thread.get()
149
+
150
+ Args:
151
+ test_run_id (str): Test Run ID
152
+
153
+ Keyword Args:
154
+ _return_http_data_only (bool): response data without head status
155
+ code and headers. Default is True.
156
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
157
+ will be returned without reading/decoding response data.
158
+ Default is True.
159
+ _request_timeout (int/float/tuple): timeout setting for this request. If
160
+ one number provided, it will be total request timeout. It can also
161
+ be a pair (tuple) of (connection, read) timeouts.
162
+ Default is None.
163
+ _check_input_type (bool): specifies if type checking
164
+ should be done one the data sent to the server.
165
+ Default is True.
166
+ _check_return_type (bool): specifies if type checking
167
+ should be done one the data received from the server.
168
+ Default is True.
169
+ _spec_property_naming (bool): True if the variable names in the input data
170
+ are serialized names, as specified in the OpenAPI document.
171
+ False if the variable names in the input data
172
+ are pythonic names, e.g. snake case (default)
173
+ _content_type (str/None): force body content-type.
174
+ Default is None and content-type will be predicted by allowed
175
+ content-types and body.
176
+ _host_index (int/None): specifies the index of the server
177
+ that we want to use.
178
+ Default is read from the configuration.
179
+ _request_auths (list): set to override the auth_settings for an a single
180
+ request; this effectively ignores the authentication
181
+ in the spec for a single request.
182
+ Default is None
183
+ async_req (bool): execute request asynchronously
184
+
185
+ Returns:
186
+ bool, date, datetime, dict, float, int, list, str, none_type
187
+ If the method is called asynchronously, returns the request
188
+ thread.
189
+ """
190
+ kwargs['async_req'] = kwargs.get(
191
+ 'async_req', False
192
+ )
193
+ kwargs['_return_http_data_only'] = kwargs.get(
194
+ '_return_http_data_only', True
195
+ )
196
+ kwargs['_preload_content'] = kwargs.get(
197
+ '_preload_content', True
198
+ )
199
+ kwargs['_request_timeout'] = kwargs.get(
200
+ '_request_timeout', None
201
+ )
202
+ kwargs['_check_input_type'] = kwargs.get(
203
+ '_check_input_type', True
204
+ )
205
+ kwargs['_check_return_type'] = kwargs.get(
206
+ '_check_return_type', True
207
+ )
208
+ kwargs['_spec_property_naming'] = kwargs.get(
209
+ '_spec_property_naming', False
210
+ )
211
+ kwargs['_content_type'] = kwargs.get(
212
+ '_content_type')
213
+ kwargs['_host_index'] = kwargs.get('_host_index')
214
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
215
+ kwargs['test_run_id'] = \
216
+ test_run_id
217
+ return self.force_completion_get_endpoint.call_with_http_info(**kwargs)
218
+
219
+ def wait_completion_get(
220
+ self,
221
+ test_run_id,
222
+ **kwargs
223
+ ):
224
+ """Wait for completion # noqa: E501
225
+
226
+ Wait until processing is completed for a test run. # noqa: E501
227
+ This method makes a synchronous HTTP request by default. To make an
228
+ asynchronous HTTP request, please pass async_req=True
229
+
230
+ >>> thread = api.wait_completion_get(test_run_id, async_req=True)
231
+ >>> result = thread.get()
232
+
233
+ Args:
234
+ test_run_id (str): Test Run ID
235
+
236
+ Keyword Args:
237
+ _return_http_data_only (bool): response data without head status
238
+ code and headers. Default is True.
239
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
240
+ will be returned without reading/decoding response data.
241
+ Default is True.
242
+ _request_timeout (int/float/tuple): timeout setting for this request. If
243
+ one number provided, it will be total request timeout. It can also
244
+ be a pair (tuple) of (connection, read) timeouts.
245
+ Default is None.
246
+ _check_input_type (bool): specifies if type checking
247
+ should be done one the data sent to the server.
248
+ Default is True.
249
+ _check_return_type (bool): specifies if type checking
250
+ should be done one the data received from the server.
251
+ Default is True.
252
+ _spec_property_naming (bool): True if the variable names in the input data
253
+ are serialized names, as specified in the OpenAPI document.
254
+ False if the variable names in the input data
255
+ are pythonic names, e.g. snake case (default)
256
+ _content_type (str/None): force body content-type.
257
+ Default is None and content-type will be predicted by allowed
258
+ content-types and body.
259
+ _host_index (int/None): specifies the index of the server
260
+ that we want to use.
261
+ Default is read from the configuration.
262
+ _request_auths (list): set to override the auth_settings for an a single
263
+ request; this effectively ignores the authentication
264
+ in the spec for a single request.
265
+ Default is None
266
+ async_req (bool): execute request asynchronously
267
+
268
+ Returns:
269
+ bool, date, datetime, dict, float, int, list, str, none_type
270
+ If the method is called asynchronously, returns the request
271
+ thread.
272
+ """
273
+ kwargs['async_req'] = kwargs.get(
274
+ 'async_req', False
275
+ )
276
+ kwargs['_return_http_data_only'] = kwargs.get(
277
+ '_return_http_data_only', True
278
+ )
279
+ kwargs['_preload_content'] = kwargs.get(
280
+ '_preload_content', True
281
+ )
282
+ kwargs['_request_timeout'] = kwargs.get(
283
+ '_request_timeout', None
284
+ )
285
+ kwargs['_check_input_type'] = kwargs.get(
286
+ '_check_input_type', True
287
+ )
288
+ kwargs['_check_return_type'] = kwargs.get(
289
+ '_check_return_type', True
290
+ )
291
+ kwargs['_spec_property_naming'] = kwargs.get(
292
+ '_spec_property_naming', False
293
+ )
294
+ kwargs['_content_type'] = kwargs.get(
295
+ '_content_type')
296
+ kwargs['_host_index'] = kwargs.get('_host_index')
297
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
298
+ kwargs['test_run_id'] = \
299
+ test_run_id
300
+ return self.wait_completion_get_endpoint.call_with_http_info(**kwargs)
301
+
@@ -0,0 +1,158 @@
1
+ """
2
+ Sync Storage Service API
3
+
4
+ This is a sync storage service for coordinating test workers. # noqa: E501
5
+
6
+ The version of the OpenAPI document: 1.0
7
+ Generated by: https://openapi-generator.tech
8
+ """
9
+
10
+
11
+ import re # noqa: F401
12
+ import sys # noqa: F401
13
+
14
+ from api_client_syncstorage.api_client import ApiClient, Endpoint as _Endpoint
15
+ from api_client_syncstorage.model_utils import ( # noqa: F401
16
+ check_allowed_values,
17
+ check_validations,
18
+ date,
19
+ datetime,
20
+ file_type,
21
+ none_type,
22
+ validate_and_convert_types
23
+ )
24
+ from api_client_syncstorage.model.health_status_response import HealthStatusResponse
25
+
26
+
27
+ class HealthApi(object):
28
+ """NOTE: This class is auto generated by OpenAPI Generator
29
+ Ref: https://openapi-generator.tech
30
+
31
+ Do not edit the class manually.
32
+ """
33
+
34
+ def __init__(self, api_client=None):
35
+ if api_client is None:
36
+ api_client = ApiClient()
37
+ self.api_client = api_client
38
+ self.health_get_endpoint = _Endpoint(
39
+ settings={
40
+ 'response_type': (HealthStatusResponse,),
41
+ 'auth': [],
42
+ 'endpoint_path': '/health',
43
+ 'operation_id': 'health_get',
44
+ 'http_method': 'GET',
45
+ 'servers': None,
46
+ },
47
+ params_map={
48
+ 'all': [
49
+ ],
50
+ 'required': [],
51
+ 'nullable': [
52
+ ],
53
+ 'enum': [
54
+ ],
55
+ 'validation': [
56
+ ]
57
+ },
58
+ root_map={
59
+ 'validations': {
60
+ },
61
+ 'allowed_values': {
62
+ },
63
+ 'openapi_types': {
64
+ },
65
+ 'attribute_map': {
66
+ },
67
+ 'location_map': {
68
+ },
69
+ 'collection_format_map': {
70
+ }
71
+ },
72
+ headers_map={
73
+ 'accept': [
74
+ 'application/json'
75
+ ],
76
+ 'content_type': [],
77
+ },
78
+ api_client=api_client
79
+ )
80
+
81
+ def health_get(
82
+ self,
83
+ **kwargs
84
+ ):
85
+ """Health check # noqa: E501
86
+
87
+ Get the current health status of the service. # noqa: E501
88
+ This method makes a synchronous HTTP request by default. To make an
89
+ asynchronous HTTP request, please pass async_req=True
90
+
91
+ >>> thread = api.health_get(async_req=True)
92
+ >>> result = thread.get()
93
+
94
+
95
+ Keyword Args:
96
+ _return_http_data_only (bool): response data without head status
97
+ code and headers. Default is True.
98
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
99
+ will be returned without reading/decoding response data.
100
+ Default is True.
101
+ _request_timeout (int/float/tuple): timeout setting for this request. If
102
+ one number provided, it will be total request timeout. It can also
103
+ be a pair (tuple) of (connection, read) timeouts.
104
+ Default is None.
105
+ _check_input_type (bool): specifies if type checking
106
+ should be done one the data sent to the server.
107
+ Default is True.
108
+ _check_return_type (bool): specifies if type checking
109
+ should be done one the data received from the server.
110
+ Default is True.
111
+ _spec_property_naming (bool): True if the variable names in the input data
112
+ are serialized names, as specified in the OpenAPI document.
113
+ False if the variable names in the input data
114
+ are pythonic names, e.g. snake case (default)
115
+ _content_type (str/None): force body content-type.
116
+ Default is None and content-type will be predicted by allowed
117
+ content-types and body.
118
+ _host_index (int/None): specifies the index of the server
119
+ that we want to use.
120
+ Default is read from the configuration.
121
+ _request_auths (list): set to override the auth_settings for an a single
122
+ request; this effectively ignores the authentication
123
+ in the spec for a single request.
124
+ Default is None
125
+ async_req (bool): execute request asynchronously
126
+
127
+ Returns:
128
+ HealthStatusResponse
129
+ If the method is called asynchronously, returns the request
130
+ thread.
131
+ """
132
+ kwargs['async_req'] = kwargs.get(
133
+ 'async_req', False
134
+ )
135
+ kwargs['_return_http_data_only'] = kwargs.get(
136
+ '_return_http_data_only', True
137
+ )
138
+ kwargs['_preload_content'] = kwargs.get(
139
+ '_preload_content', True
140
+ )
141
+ kwargs['_request_timeout'] = kwargs.get(
142
+ '_request_timeout', None
143
+ )
144
+ kwargs['_check_input_type'] = kwargs.get(
145
+ '_check_input_type', True
146
+ )
147
+ kwargs['_check_return_type'] = kwargs.get(
148
+ '_check_return_type', True
149
+ )
150
+ kwargs['_spec_property_naming'] = kwargs.get(
151
+ '_spec_property_naming', False
152
+ )
153
+ kwargs['_content_type'] = kwargs.get(
154
+ '_content_type')
155
+ kwargs['_host_index'] = kwargs.get('_host_index')
156
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
157
+ return self.health_get_endpoint.call_with_http_info(**kwargs)
158
+