filip.clients package

Clients to interact with FIWARE’s APIs

Subpackages

• filip.clients.mqtt package
  • Subpackages
    • filip.clients.mqtt.encoder package
      • Submodules
      • filip.clients.mqtt.encoder.base_encoder module
      • filip.clients.mqtt.encoder.json module
      • filip.clients.mqtt.encoder.ulralight module
  • Submodules
  • filip.clients.mqtt.client module
    • IoTAMQTTClient
      • IoTAMQTTClient.add_command_callback()
      • IoTAMQTTClient.add_device()
      • IoTAMQTTClient.add_encoder()
      • IoTAMQTTClient.add_service_group()
      • IoTAMQTTClient.delete_device()
      • IoTAMQTTClient.delete_service_group()
      • IoTAMQTTClient.devices
      • IoTAMQTTClient.get_device()
      • IoTAMQTTClient.get_encoder()
      • IoTAMQTTClient.get_service_group()
      • IoTAMQTTClient.publish()
      • IoTAMQTTClient.subscribe()
      • IoTAMQTTClient.update_device()
      • IoTAMQTTClient.update_service_group()
• filip.clients.ngsi_ld package
  • Submodules
  • filip.clients.ngsi_ld.cb module
    • ContextBrokerLDClient
      • ContextBrokerLDClient.GeometryShape
      • ContextBrokerLDClient.append_entity_attributes()
      • ContextBrokerLDClient.delete_attribute()
      • ContextBrokerLDClient.delete_entity_by_id()
      • ContextBrokerLDClient.delete_subscription()
      • ContextBrokerLDClient.entity_batch_operation()
      • ContextBrokerLDClient.get_entity()
      • ContextBrokerLDClient.get_entity_list()
      • ContextBrokerLDClient.get_statistics()
      • ContextBrokerLDClient.get_subscription()
      • ContextBrokerLDClient.get_subscription_list()
      • ContextBrokerLDClient.get_version()
      • ContextBrokerLDClient.handle_multi_status_response()
      • ContextBrokerLDClient.kwargs
      • ContextBrokerLDClient.log_multi_errors()
      • ContextBrokerLDClient.override_entities()
      • ContextBrokerLDClient.post_entity()
      • ContextBrokerLDClient.post_subscription()
      • ContextBrokerLDClient.replace_existing_attributes_of_entity()
      • ContextBrokerLDClient.update_entity_attribute()
      • ContextBrokerLDClient.update_subscription()
      • ContextBrokerLDClient.validate_relationship()
• filip.clients.ngsi_v2 package
  • Submodules
  • filip.clients.ngsi_v2.cb module
    • ContextBrokerClient
      • ContextBrokerClient.add_valid_relationships()
      • ContextBrokerClient.delete_entities()
      • ContextBrokerClient.delete_entity()
      • ContextBrokerClient.delete_entity_attribute()
      • ContextBrokerClient.delete_registration()
      • ContextBrokerClient.delete_subscription()
      • ContextBrokerClient.does_entity_exist()
      • ContextBrokerClient.get_attribute()
      • ContextBrokerClient.get_attribute_value()
      • ContextBrokerClient.get_entity()
      • ContextBrokerClient.get_entity_attributes()
      • ContextBrokerClient.get_entity_list()
      • ContextBrokerClient.get_entity_type()
      • ContextBrokerClient.get_entity_types()
      • ContextBrokerClient.get_registration()
      • ContextBrokerClient.get_registration_list()
      • ContextBrokerClient.get_resources()
      • ContextBrokerClient.get_statistics()
      • ContextBrokerClient.get_subscription()
      • ContextBrokerClient.get_subscription_list()
      • ContextBrokerClient.get_version()
      • ContextBrokerClient.notify()
      • ContextBrokerClient.override_entity()
      • ContextBrokerClient.patch_entity()
      • ContextBrokerClient.post_command()
      • ContextBrokerClient.post_entity()
      • ContextBrokerClient.post_registration()
      • ContextBrokerClient.post_subscription()
      • ContextBrokerClient.query()
      • ContextBrokerClient.remove_invalid_relationships()
      • ContextBrokerClient.replace_entity_attributes()
      • ContextBrokerClient.update()
      • ContextBrokerClient.update_attribute_value()
      • ContextBrokerClient.update_entity()
      • ContextBrokerClient.update_entity_attribute()
      • ContextBrokerClient.update_entity_properties()
      • ContextBrokerClient.update_entity_relationships()
      • ContextBrokerClient.update_existing_entity_attributes()
      • ContextBrokerClient.update_or_append_entity_attributes()
      • ContextBrokerClient.update_registration()
      • ContextBrokerClient.update_subscription()
      • ContextBrokerClient.validate_relationship()
  • filip.clients.ngsi_v2.client module
    • HttpClient
      • HttpClient.cert
      • HttpClient.config
      • HttpClient.secrets
    • HttpClientConfig
      • HttpClientConfig.auth
      • HttpClientConfig.cb_url
      • HttpClientConfig.iota_url
      • HttpClientConfig.ql_url
  • filip.clients.ngsi_v2.iota module
    • IoTAClient
      • IoTAClient.change_loglevel_of_agent()
      • IoTAClient.delete_device()
      • IoTAClient.delete_group()
      • IoTAClient.does_device_exists()
      • IoTAClient.get_device()
      • IoTAClient.get_device_list()
      • IoTAClient.get_group()
      • IoTAClient.get_group_list()
      • IoTAClient.get_loglevel_of_agent()
      • IoTAClient.get_version()
      • IoTAClient.patch_device()
      • IoTAClient.post_device()
      • IoTAClient.post_devices()
      • IoTAClient.post_group()
      • IoTAClient.post_groups()
      • IoTAClient.update_device()
      • IoTAClient.update_devices()
      • IoTAClient.update_group()
      • IoTAClient.update_groups()
  • filip.clients.ngsi_v2.quantumleap module
    • QuantumLeapClient
      • QuantumLeapClient.delete_entity()
      • QuantumLeapClient.delete_entity_type()
      • QuantumLeapClient.get_entities()
      • QuantumLeapClient.get_entity_attr_by_id()
      • QuantumLeapClient.get_entity_attr_by_type()
      • QuantumLeapClient.get_entity_attr_values_by_id()
      • QuantumLeapClient.get_entity_attr_values_by_type()
      • QuantumLeapClient.get_entity_by_attr_name()
      • QuantumLeapClient.get_entity_by_attrs()
      • QuantumLeapClient.get_entity_by_id()
      • QuantumLeapClient.get_entity_by_type()
      • QuantumLeapClient.get_entity_values_by_id()
      • QuantumLeapClient.get_entity_values_by_type()
      • QuantumLeapClient.get_health()
      • QuantumLeapClient.get_version()
      • QuantumLeapClient.post_config()
      • QuantumLeapClient.post_notification()
      • QuantumLeapClient.post_subscription()
      • QuantumLeapClient.transform_attr_response_model()

Submodules

filip.clients.base_http_client module

Base http client module

class filip.clients.base_http_client.BaseHttpClient(url: Url | str | None = None, *, session: Session | None = None, fiware_header: Dict | FiwareHeader | FiwareLDHeader | None = None, **kwargs)

Bases: object

Base client for all derived api-clients.

Parameters:

• session – request session object. This is required for reusing the same connection

• reuse_session (bool) –

• fiware_header – Fiware header object required for multi tenancy

• **kwargs – Optional arguments that request takes.

close() → None

Close http session :returns: None

delete(url: str, **kwargs) → Response

Sends a DELETE request either using the provided session or the single session.

Parameters:

• url (str) – URL for the new Request object.

• **kwargs – Optional arguments that request takes.

Returns:

request.Response

property fiware_headers: FiwareHeader

Get fiware header

Returns:

FiwareHeader

property fiware_service: str

Get current fiware service :returns: str

property fiware_service_path: str

Get current fiware service path :returns: str

get(url: str, params: Dict | List[Tuple] | ByteString | None = None, **kwargs) → Response

Sends a GET request either using the provided session or the single session.

Parameters:

• url (str) – URL for the new Request object.

• params (optional) – (optional) Dictionary, list of tuples or bytes to send in the query string for the Request.

• **kwargs – Optional arguments that request takes.

Returns:

requests.Response

head(url: str, params: Dict | List[Tuple] | ByteString | None = None, **kwargs) → Response

Sends a HEAD request either using the provided session or the single session.

Parameters:

• url (str) – URL for the new Request object.

• params (optional) – Dictionary, list of tuples or bytes to send in the query string for the Request.

• **kwargs – Optional arguments that request takes.

Returns:

requests.Response

property headers

Return current session headers :returns: dict with headers

log_error(err: RequestException, msg: str | None = None) → None

Outputs the error messages from the client request function. If additional information is available in the server response this will be forwarded to the logging output.

Note

The user is responsible to setup the logging system

Parameters:

• err – Request Error

• msg – error message from calling function

Returns:

None

options(url: str, **kwargs) → Response

Sends an OPTIONS request either using the provided session or the single session.

Parameters:

• url (str) –

• **kwargs – Optional arguments that request takes.

Returns:

requests.Response

patch(url: str, data: Dict | ByteString | List[Tuple] | IO | str | None = None, json: Dict | None = None, **kwargs) → Response

Sends a PATCH request either using the provided session or the single session.

Parameters:

• url – URL for the new Request object.

• data (Union[Dict, ByteString, List[Tuple], IO]) – Dictionary, list of tuples, bytes, or file-like object to send in the body of the Request.

• json (Dict) – A JSON serializable Python object to send in the body of the Request..

• **kwargs – Optional arguments that request takes.

Returns:

request.Response

post(url: str, data: Dict | ByteString | List[Tuple] | IO | str | None = None, json: Dict | None = None, **kwargs) → Response

Sends a POST request either using the provided session or the single session.

Parameters:

• url – URL for the new Request object.

• data – Dictionary, list of tuples, bytes, or file-like object to send in the body of the Request.

• json – A JSON serializable Python object to send in the body of the Request.

• **kwargs – Optional arguments that request takes.

Returns:

put(url: str, data: Dict | ByteString | List[Tuple] | IO | str | None = None, json: Dict | None = None, **kwargs) → Response

Sends a PUT request either using the provided session or the single session.

Parameters:

• url – URL for the new Request object.

• data (Union[Dict, ByteString, List[Tuple], IO]) – Dictionary, list of tuples, bytes, or file-like object to send in the body of the Request.

• json (Dict) – A JSON serializable Python object to send in the body of the Request..

• **kwargs – Optional arguments that request takes.

Returns:

request.Response

class filip.clients.base_http_client.NgsiURLVersion(value)

Bases: str, Enum

URL part that defines the NGSI version for the API.

ld_url = 'ngsi-ld/v1'

v2_url = 'v2'

filip.clients.exceptions module

Module for client specific exceptions

exception filip.clients.exceptions.BaseHttpClientException(message: str, response: Response)

Bases: RequestException

Base exception class for all HTTP clients. The response of a request will be available in the exception.

Parameters:

• message (str) – Error message

• response (Response) – Response object