ModuleApiBase¶
- class ModuleApiBase[source]¶
Bases:
supervisely.api.module_api._JsonConvertibleModule
ModuleApiBase
Methods
Get information about an entity by its ID from the Supervisely server.
Get list of all or limited quantity entities from the Supervisely server.
This generator function retrieves a list of all or a limited quantity of entities from the Supervisely server, yielding batches of entities as they are retrieved
Get list of all class field names.
Get string name of NamedTuple.
Attributes
Maximum number of attempts that will be made to wait for a certain condition to be met.
Number of seconds for intervals between attempts.
- get_info_by_id(id)[source]¶
Get information about an entity by its ID from the Supervisely server.
- Parameters
- id : int
ID of the entity.
-
get_list_all_pages(method, data, progress_cb=
None
, convert_json_info_cb=None
, limit=None
, return_first_response=False
)[source]¶ Get list of all or limited quantity entities from the Supervisely server.
- Parameters
- method : str
Request method name
- data : dict
Dictionary with request body info
- progress_cb : Progress, optional
Function for tracking download progress.
- convert_json_info_cb : Callable, optional
Function for convert json info
- limit : int, optional
Number of entity to retrieve
- return_first_response : bool, optional
Specify if return first response
-
get_list_all_pages_generator(method, data, progress_cb=
None
, convert_json_info_cb=None
, limit=None
, return_first_response=False
)[source]¶ This generator function retrieves a list of all or a limited quantity of entities from the Supervisely server, yielding batches of entities as they are retrieved
- Parameters
- method : str
Request method name
- data : dict
Dictionary with request body info
- progress_cb : Progress, optional
Function for tracking download progress.
- convert_json_info_cb : Callable, optional
Function for convert json info
- limit : int, optional
Number of entity to retrieve
- return_first_response : bool, optional
Specify if return first response
-
MAX_WAIT_ATTEMPTS =
999
¶ Maximum number of attempts that will be made to wait for a certain condition to be met.
-
WAIT_ATTEMPT_TIMEOUT_SEC =
1
¶ Number of seconds for intervals between attempts.