annif.openapi.validation.CustomRequestBodyValidator._validate() - Code Metrics - Inspection of "Merge pull request #702 from NatLibFi/upgrade-to-c..." - NatLibFi/Annif - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — main ( 2e5e98...c3a86a )

by Juho

created 2024-04-19 09:15 UTC

CustomRequestBodyValidator._validate() A

↳ Parent: annif.openapi.validation

Complexity

Conditions

Size

Total Lines	16
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	14
nop	2
dl	0
loc	16
rs	9.7
c	0
b	0
f	0

"""Custom validator for the Annif API."""

from __future__ import annotations

import logging
from typing import Any

from connexion.exceptions import BadRequestProblem
from connexion.json_schema import format_error_with_path
from connexion.validators import JSONRequestBodyValidator
from jsonschema.exceptions import ValidationError

logger = logging.getLogger("openapi.validation")


class CustomRequestBodyValidator(JSONRequestBodyValidator):
    """Custom request body validator that overrides the default error message for the
    'maxItems' validator for the 'documents' property to prevent logging request body
    with the contents of all documents."""

    def __init__(self, *args, **kwargs) -> None:
        super().__init__(*args, **kwargs)

    def _validate(self, body: Any) -> dict | None:
        try:
            return self._validator.validate(body)
        except ValidationError as exception:
            if exception.validator == "maxItems" and list(exception.schema_path) == [
                "properties",
                "documents",
                "maxItems",
            ]:
                exception.message = "too many items"
            error_path_msg = format_error_with_path(exception=exception)
            logger.error(
                f"Validation error: {exception.message}{error_path_msg}",
                extra={"validator": "body"},
            )
            raise BadRequestProblem(detail=f"{exception.message}{error_path_msg}")


1			"""Custom validator for the Annif API."""
2
3			from __future__ import annotations
4
5			import logging
6			from typing import Any
7
8			from connexion.exceptions import BadRequestProblem
9			from connexion.json_schema import format_error_with_path
10			from connexion.validators import JSONRequestBodyValidator
11			from jsonschema.exceptions import ValidationError
12
13			logger = logging.getLogger("openapi.validation")
14
15
16			class CustomRequestBodyValidator(JSONRequestBodyValidator):
17			"""Custom request body validator that overrides the default error message for the
18			'maxItems' validator for the 'documents' property to prevent logging request body
19			with the contents of all documents."""
20
21			def __init__(self, args, *kwargs) -> None:
22			super().__init__(args, *kwargs)
23
24			def _validate(self, body: Any) -> dict \| None:
25			try:
26			return self._validator.validate(body)
27			except ValidationError as exception:
28			if exception.validator == "maxItems" and list(exception.schema_path) == [
29			"properties",
30			"documents",
31			"maxItems",
32			]:
33			exception.message = "too many items"
34			error_path_msg = format_error_with_path(exception=exception)
35			logger.error(
36			f"Validation error: {exception.message}{error_path_msg}",
37			extra={"validator": "body"},
38			)
39			raise BadRequestProblem(detail=f"{exception.message}{error_path_msg}")
40

NatLibFi / Annif

Push — main ( 2e5e98...c3a86a )

CustomRequestBodyValidator._validate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like