pytan3.api_objects.
ApiObjects
(module_file, adhoc_warn=True)[source]¶Bases: object
Encapsulation object for an API Object module.
_module
= None¶pytan3.api_objects
– Imported API Objects module.
_models
= None¶pytan3.api_models
– API Models module.
control_adhoc_warnings
(enable=False)[source]¶Enable or disable warnings about adhoc added simple attributes.
Parameters: | enable (bool , optional) – Enable warnings. Defaults to: True. |
---|
ApiModel
¶Get the ApiModel.
Returns: | pytan3.api_models.ApiModel |
---|
ApiItem
¶Get the ApiItem.
Returns: | pytan3.api_models.ApiItem |
---|
ApiList
¶Get the ApiList.
Returns: | pytan3.api_models.ApiList |
---|
module_dt_format
(dt)[source]¶Format a datetime string using module_dt
.
Parameters: | dt (str ) – String to format. |
---|---|
Returns: | datetime.datetime |
cls_item
¶Get all of the ApiItem classes.
Returns: | list of pytan3.api_models.ApiItem |
---|
cls_list
¶Get all of the ApiItem classes.
Returns: | list of pytan3.api_models.ApiList |
---|
cls_all
¶Get all of the ApiItem and ApiList classes.
Returns: | list of pytan3.api_models.ApiModel |
---|
cls_name_map_all
¶Get a map of API key name to class for all ApiItem and ApiList classes.
Returns: | dict |
---|
cls_item_by_name
(name)[source]¶Get an ApiItem class by API name.
Parameters: | name (str ) – Name of object used in API calls. |
---|---|
Returns: | pytan3.api_models.ApiItem |
cls_list_by_name
(name)[source]¶Get an ApiList class by API name.
Parameters: | name (str ) – Name of object used in API calls. |
---|---|
Returns: | pytan3.api_models.ApiList |
cls_by_name
(name)[source]¶Get an ApiItem or ApiList by API name.
Parameters: | name (str ) – Name of object used in API calls. |
---|---|
Returns: | pytan3.api_models.ApiModel |
load
(api_type='soap', veq='', vmax='', vmin='', vshrink=True)[source]¶Import an API module for version and type.
Parameters: |
|
---|---|
Raises: |
|
Returns: |