Skip to content

middleware

ASGI app middleware.

These are in addition to the middleware available in OPTIMADE Python tools. For more information see https://www.optimade.org/optimade-python-tools/api_reference/server/middleware/.

CheckWronglyVersionedBaseUrlsGateways

Bases: BaseHTTPMiddleware

If a non-supported versioned base URL is supplied to a gateway return 553 Version Not Supported.

Source code in optimade_gateway/middleware.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
class CheckWronglyVersionedBaseUrlsGateways(BaseHTTPMiddleware):
    """If a non-supported versioned base URL is supplied to a gateway
    return `553 Version Not Supported`."""

    @staticmethod
    async def check_url(url: URL):
        """Check URL path for versioned part.

        Parameters:
            url: A complete `urllib`-parsed raw URL.

        Raises:
            VersionNotSupported: If the URL represents an OPTIMADE versioned base URL
                and the version part is not supported by the implementation.

        """
        base_url = get_base_url(url)
        optimade_path = f"{url.scheme}://{url.netloc}{url.path}"[len(base_url) :]
        match = re.match(
            r"^/gateways/[^/\s]+(?P<version>/v[0-9]+(\.[0-9]+){0,2}).*", optimade_path
        )
        if (
            match is not None
            and match.group("version") not in BASE_URL_PREFIXES.values()
        ):
            raise VersionNotSupported(
                detail=(
                    f"The parsed versioned base URL {match.group('version')!r} "
                    f"from {url} is not supported by this implementation. "
                    "Supported versioned base URLs are: "
                    f"{', '.join(BASE_URL_PREFIXES.values())}"
                )
            )

    async def dispatch(self, request: Request, call_next):
        if request.url.path:
            await self.check_url(request.url)
        return await call_next(request)

check_url(url) async staticmethod

Check URL path for versioned part.

Parameters:

Name Type Description Default
url URL

A complete urllib-parsed raw URL.

 required

Raises:

Type Description
VersionNotSupported

If the URL represents an OPTIMADE versioned base URL and the version part is not supported by the implementation.
Source code in optimade_gateway/middleware.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
@staticmethod
async def check_url(url: URL):
    """Check URL path for versioned part.

    Parameters:
        url: A complete `urllib`-parsed raw URL.

    Raises:
        VersionNotSupported: If the URL represents an OPTIMADE versioned base URL
            and the version part is not supported by the implementation.

    """
    base_url = get_base_url(url)
    optimade_path = f"{url.scheme}://{url.netloc}{url.path}"[len(base_url) :]
    match = re.match(
        r"^/gateways/[^/\s]+(?P<version>/v[0-9]+(\.[0-9]+){0,2}).*", optimade_path
    )
    if (
        match is not None
        and match.group("version") not in BASE_URL_PREFIXES.values()
    ):
        raise VersionNotSupported(
            detail=(
                f"The parsed versioned base URL {match.group('version')!r} "
                f"from {url} is not supported by this implementation. "
                "Supported versioned base URLs are: "
                f"{', '.join(BASE_URL_PREFIXES.values())}"
            )
        )