andreoliwa / nitpick / 454

pending completion

Build # 454

Build Type

push

travis-ci-com

Committed by

andreoliwa

Commit Message

feat(style): validate the [nitpick.files] section

Run Details

290 of 349 branches covered (83.09%)

Branch coverage included in aggregate %.

57 of 68 new or added lines in 7 files covered. (83.82%)

6 existing lines in 2 files now uncovered.

924 of 982 relevant lines covered (94.09%)

4.69 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

73.58

/src/nitpick/schemas.py

"""Marshmallow schemas."""
from typing import Dict

from marshmallow import Schema, fields
from marshmallow_polyfield import PolyField
from sortedcontainers import SortedDict

from nitpick.generic import flatten
from nitpick.validators import TrimmedLength


class NotEmptyString(fields.String):
    """A string field that must not be empty even after trimmed."""

    def __init__(self, **kwargs):
        super().__init__(validate=TrimmedLength(min=1), **kwargs)


def flatten_marshmallow_errors(errors: Dict) -> str:
    """Flatten Marshmallow errors to a string."""
    formatted = []
    for field, data in SortedDict(flatten(errors)).items():
        if isinstance(data, list):
            messages_per_field = ["{}: {}".format(field, ", ".join(data))]
        elif isinstance(data, dict):
            messages_per_field = [
                "{}[{}]: {}".format(field, index, ", ".join(messages)) for index, messages in data.items()
            ]
        else:
            # This should never happen; if it does, let's just convert to a string
            messages_per_field = [str(errors)]
        formatted.append("\n".join(messages_per_field))
    return "\n".join(formatted)


def string_or_list_field(object_dict, parent_object_dict):  # pylint: disable=unused-argument
    """Detect if the field is a string or a list."""
    if isinstance(object_dict, list):
        return fields.List(NotEmptyString(required=True, allow_none=False))
    return NotEmptyString()


def boolean_or_dict_field(object_dict, parent_object_dict):  # pylint: disable=unused-argument
    """Detect if the field is a boolean or a dict."""
    if isinstance(object_dict, dict):
        return fields.Dict
    return fields.Bool


class ToolNitpickSchema(Schema):
    """Validation schema for the ``[tool.nitpick]`` section on ``pyproject.toml``."""

    style = PolyField(deserialization_schema_selector=string_or_list_field)


class NitpickStylesSchema(Schema):
    """Validation schema for the ``[nitpick.styles]`` section on the style file."""

    include = PolyField(deserialization_schema_selector=string_or_list_field)


class NitpickJsonFileSchema(Schema):
    """Validation schema for the ``[nitpick.JsonFile]`` section on the style file."""

    file_names = fields.List(fields.String)


class NitpickSchema(Schema):
    """Validation schema for the ``[nitpick]`` section on the style file."""

    minimum_version = NotEmptyString()
    styles = fields.Nested(NitpickStylesSchema)
    # FIXME: validate=validate.OneOf(app.configured_file_names | {"present", "absent"})
    files = fields.Dict(fields.String(), fields.Dict())
    JsonFile = fields.Nested(NitpickJsonFileSchema)


class StyleFileSchema(Schema):
    """Validation schema for the merged style file."""

    # FIXME: Marshmallow: wrap on an envelope and merge schemas (NitpickSchema + StyleFileSchema = StyleSchema)
    nitpick = fields.Nested(NitpickSchema)

1	"""Marshmallow schemas."""
2	from typing import Dict	5✔
3
4	from marshmallow import Schema, fields	5✔
5	from marshmallow_polyfield import PolyField	5✔
6	from sortedcontainers import SortedDict	5✔
7
8	from nitpick.generic import flatten	5✔
9	from nitpick.validators import TrimmedLength	5✔
10
11
12	class NotEmptyString(fields.String):	5✔
13	"""A string field that must not be empty even after trimmed."""
14
15	def __init__(self, **kwargs):	5✔
16	super().__init__(validate=TrimmedLength(min=1), **kwargs)	5✔
17
18
19	def flatten_marshmallow_errors(errors: Dict) -> str:	5✔
20	"""Flatten Marshmallow errors to a string."""
21	formatted = []	5✔
22	for field, data in SortedDict(flatten(errors)).items():	5✔
23	if isinstance(data, list):	5!
24	messages_per_field = ["{}: {}".format(field, ", ".join(data))]	5✔
25	elif isinstance(data, dict):	×
26	messages_per_field = [	×
27	"{}[{}]: {}".format(field, index, ", ".join(messages)) for index, messages in data.items()
28	]
29	else:
30	# This should never happen; if it does, let's just convert to a string
31	messages_per_field = [str(errors)]	×
32	formatted.append("\n".join(messages_per_field))	5✔
33	return "\n".join(formatted)	5✔
34
35
36	def string_or_list_field(object_dict, parent_object_dict): # pylint: disable=unused-argument	5✔
37	"""Detect if the field is a string or a list."""
38	if isinstance(object_dict, list):	5✔
39	return fields.List(NotEmptyString(required=True, allow_none=False))	5✔
40	return NotEmptyString()	5✔
41
42
43	def boolean_or_dict_field(object_dict, parent_object_dict): # pylint: disable=unused-argument	5✔
44	"""Detect if the field is a boolean or a dict."""
UNCOV 45	if isinstance(object_dict, dict):	×
UNCOV 46	return fields.Dict	×
UNCOV 47	return fields.Bool	×
48
49
50	class ToolNitpickSchema(Schema):	5✔
51	"""Validation schema for the ``[tool.nitpick]`` section on ``pyproject.toml``."""
52
53	style = PolyField(deserialization_schema_selector=string_or_list_field)	5✔
54
55
56	class NitpickStylesSchema(Schema):	5✔
57	"""Validation schema for the ``[nitpick.styles]`` section on the style file."""
58
59	include = PolyField(deserialization_schema_selector=string_or_list_field)	5✔
60
61
62	class NitpickJsonFileSchema(Schema):	5✔
63	"""Validation schema for the ``[nitpick.JsonFile]`` section on the style file."""
64
65	file_names = fields.List(fields.String)	5✔
66
67
68	class NitpickSchema(Schema):	5✔
69	"""Validation schema for the ``[nitpick]`` section on the style file."""
70
71	minimum_version = NotEmptyString()	5✔
72	styles = fields.Nested(NitpickStylesSchema)	5✔
73	# FIXME: validate=validate.OneOf(app.configured_file_names \| {"present", "absent"})
74	files = fields.Dict(fields.String(), fields.Dict())	5✔
75	JsonFile = fields.Nested(NitpickJsonFileSchema)	5✔
76
77
78	class StyleFileSchema(Schema):	5✔
79	"""Validation schema for the merged style file."""
80
81	# FIXME: Marshmallow: wrap on an envelope and merge schemas (NitpickSchema + StyleFileSchema = StyleSchema)
82	nitpick = fields.Nested(NitpickSchema)	5✔

andreoliwa / nitpick / 454

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous