Skip to content

Clienthelper

clienthelper

client helper for all clients.

ClientHelper

Helper methods for client processing.

invalid_security_type(provider: DataSourceID, identifier: SecurityIdentifier, raise_object: type[ClientResponseError] | None = None) -> None staticmethod

Called when the provider is called with invalid security type.

Source code in src/equities_classifier/clients/clienthelper.py
@staticmethod
def invalid_security_type(
    provider: DataSourceID,
    identifier: SecurityIdentifier,
    raise_object: type[ClientResponseError] | None = None,
) -> None:
    """Called when the provider is called with invalid security type."""

    message = f"Identifier type '{identifier.type}' invalid or invalid for source '{provider}' (value was '{identifier.value}')."
    logger_equities_classifier.warning(message)

    if raise_object:
        raise raise_object(message)

missing_provider_attribute(provider: DataSourceID, identifier: SecurityIdentifier, attribute: str, raise_object: type[ClientResponseError] | None = None) -> None staticmethod

Called when the provider returns an unmapped JSON attribute.

Source code in src/equities_classifier/clients/clienthelper.py
@staticmethod
def missing_provider_attribute(
    provider: DataSourceID,
    identifier: SecurityIdentifier,
    attribute: str,
    raise_object: type[ClientResponseError] | None = None,
) -> None:
    """Called when the provider returns an unmapped JSON attribute."""

    message = f"Missing provider attribute '{attribute}' from source '{provider}' for ({identifier.type}, {identifier.value})."
    logger_equities_classifier.warning(message)

    if raise_object:
        raise raise_object(message)

missing_record_attribute(provider: DataSourceID, attribute: str, value: Any, context: str, raise_object: type[ClientResponseError] | None = None) -> None staticmethod

Called when the mapping points to a record attribute that does not exist.

Source code in src/equities_classifier/clients/clienthelper.py
@staticmethod
def missing_record_attribute(
    provider: DataSourceID,
    attribute: str,
    value: Any,
    context: str,
    raise_object: type[ClientResponseError] | None = None,
) -> None:
    """Called when the mapping points to a record attribute that does not exist."""

    message = f"Unknown/not handled provider attribute '{attribute}' with value '{value}' in response from '{provider}', not mapped in '{context}'."
    logger_equities_classifier.warning(message)

    if raise_object:
        raise raise_object(message)

other_error_with_message(provider: DataSourceID, message: str, raise_object: type[ClientResponseError] | None = None) -> None staticmethod

Called when the provider is called with invalid security type.

Source code in src/equities_classifier/clients/clienthelper.py
@staticmethod
def other_error_with_message(
    provider: DataSourceID,
    message: str,
    raise_object: type[ClientResponseError] | None = None
) -> None:
    """Called when the provider is called with invalid security type."""

    logger_equities_classifier.error(message)

    if raise_object:
        raise raise_object(message)

search_result_counter_issue(provider: DataSourceID, identifier: SecurityIdentifier, count_provider: int, count_found: int, raise_object: type[ClientResponseError] | None = None) -> None staticmethod

Called when the provider delivers inconsistent number of data records.

Source code in src/equities_classifier/clients/clienthelper.py
@staticmethod
def search_result_counter_issue(
    provider: DataSourceID,
    identifier: SecurityIdentifier,
    count_provider: int,
    count_found: int,
    raise_object: type[ClientResponseError] | None = None,
) -> None:
    """Called when the provider delivers inconsistent number of data records."""

    message = f"Search result from source '{provider}' for ({identifier.type}, {identifier.value}) contains inconsistent counter value, expected {count_provider} vs {count_found} found."
    logger_equities_classifier.warning(message)

    if raise_object:
        raise raise_object(message)

search_result_not_unique(provider: DataSourceID, identifier: SecurityIdentifier, raise_object: type[ClientResponseError] | None = None) -> None staticmethod

Called when the provider cannot find unique dataset.

Source code in src/equities_classifier/clients/clienthelper.py
@staticmethod
def search_result_not_unique(
    provider: DataSourceID,
    identifier: SecurityIdentifier,
    raise_object: type[ClientResponseError] | None = None,
) -> None:
    """Called when the provider cannot find unique dataset."""

    message = f"Search result from source '{provider}' for ({identifier.type}, {identifier.value}) is not unique. Processing first match."
    logger_equities_classifier.warning(message)

    if raise_object:
        raise raise_object(message)

unknown_provider_attribute(provider: DataSourceID, identifier: SecurityIdentifier, attribute: str, value: str, context: str, raise_object: type[ClientResponseError] | None = None) -> None staticmethod

Called when the provider returns an unmapped JSON attribute.

Source code in src/equities_classifier/clients/clienthelper.py
@staticmethod
def unknown_provider_attribute(
    provider: DataSourceID,
    identifier: SecurityIdentifier,
    attribute: str,
    value: str,
    context: str,
    raise_object: type[ClientResponseError] | None = None,
) -> None:
    """Called when the provider returns an unmapped JSON attribute."""

    message = f"Provider attribute {attribute}, value '{value}' from source '{provider}' for ({identifier.type}, {identifier.value}) not mapped in '{context}'."
    logger_equities_classifier.warning(message)

    if raise_object:
        raise raise_object(message)

unknown_provider_attributes(provider: DataSourceID, identifier: SecurityIdentifier, attributes: set[tuple[str, ...]], context: str, raise_object: type[ClientResponseError] | None = None) -> None staticmethod

Called when the provider returns unmapped JSON attributes.

Source code in src/equities_classifier/clients/clienthelper.py
@staticmethod
def unknown_provider_attributes(
    provider: DataSourceID,
    identifier: SecurityIdentifier,
    attributes: set[tuple[str, ...]],
    context: str,
    raise_object: type[ClientResponseError] | None = None,
) -> None:
    """Called when the provider returns unmapped JSON attributes."""

    message = f"Provider attributes {attributes} from source '{provider}' for ({identifier.type}, {identifier.value}) not mapped in '{context}'."
    logger_equities_classifier.warning(message)

    if raise_object:
        raise raise_object(message)