Skip to content

warnings

This submodule implements the possible warnings that can be omitted by an OPTIMADE API.

FieldValueNotRecognized (OptimadeWarning)

A field or value used in the request is not recognised by this implementation.

Source code in optimade/warnings.py 
class FieldValueNotRecognized(OptimadeWarning):
    """A field or value used in the request is not recognised by this implementation."""

LocalOptimadeWarning (OptimadeWarning)

A warning that is specific to a local implementation of the OPTIMADE API and should not appear in the server log or response.

Source code in optimade/warnings.py 
class LocalOptimadeWarning(OptimadeWarning):
    """A warning that is specific to a local implementation of the OPTIMADE API
    and should not appear in the server log or response.
    """

MissingExpectedField (LocalOptimadeWarning)

A field was provided with a null value when a related field was provided with a value.

Source code in optimade/warnings.py 
class MissingExpectedField(LocalOptimadeWarning):
    """A field was provided with a null value when a related field was provided
    with a value."""

OptimadeWarning (Warning)

Base Warning for the optimade package

Source code in optimade/warnings.py 
class OptimadeWarning(Warning):
    """Base Warning for the `optimade` package"""

    def __init__(
        self, detail: Optional[str] = None, title: Optional[str] = None, *args
    ) -> None:
        detail = detail if detail else self.__doc__
        super().__init__(detail, *args)
        self.detail = detail
        self.title = title if title else self.__class__.__name__

    def __repr__(self) -> str:
        attrs = {"detail": self.detail, "title": self.title}
        return "<{:s}({:s})>".format(
            self.__class__.__name__,
            " ".join(
                [
                    f"{attr}={value!r}"
                    for attr, value in attrs.items()
                    if value is not None
                ]
            ),
        )

    def __str__(self) -> str:
        return self.detail if self.detail is not None else ""

QueryParamNotUsed (OptimadeWarning)

A query parameter is not used in this request.

Source code in optimade/warnings.py 
class QueryParamNotUsed(OptimadeWarning):
    """A query parameter is not used in this request."""

TimestampNotRFCCompliant (OptimadeWarning)

A timestamp has been used in a filter that contains microseconds and is thus not RFC 3339 compliant. This may cause undefined behaviour in the query results.

Source code in optimade/warnings.py 
class TimestampNotRFCCompliant(OptimadeWarning):
    """A timestamp has been used in a filter that contains microseconds and is thus not
    RFC 3339 compliant. This may cause undefined behaviour in the query results.

    """

TooManyValues (OptimadeWarning)

A field or query parameter has too many values to be handled by this implementation.

Source code in optimade/warnings.py 
class TooManyValues(OptimadeWarning):
    """A field or query parameter has too many values to be handled by this implementation."""

UnknownProviderProperty (OptimadeWarning)

A provider-specific property has been requested via response_fields or as in a filter that is not recognised by this implementation.

Source code in optimade/warnings.py 
class UnknownProviderProperty(OptimadeWarning):
    """A provider-specific property has been requested via `response_fields` or as in a `filter` that is not
    recognised by this implementation.

    """

UnknownProviderQueryParameter (OptimadeWarning)

A provider-specific query parameter has been requested in the query with a prefix not recognised by this implementation.

Source code in optimade/warnings.py 
class UnknownProviderQueryParameter(OptimadeWarning):
    """A provider-specific query parameter has been requested in the query with a prefix not
    recognised by this implementation.

    """