Skip to content

Commit

Permalink
fix: black formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
@maximeflya
maximeflya committed Jun 4, 2024
1 parent e43f534 commit f1e42a8
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 83 deletions.
10 changes: 6 additions & 4 deletions .github/workflows/black-lint.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ on:
branches:
- master
paths:
- 'schema.py'
- 'schema/**'
- 'pyproject.toml'
pull_request:
branches:
- master
paths:
- 'schema.py'
- 'schema/**'
- 'pyproject.toml'

jobs:
lint:
Expand All @@ -28,5 +30,5 @@ jobs:
- name: Install Black
run: pip install black

- name: Run Black on schema.py
run: black --check schema.py
- name: Run Black on schema package
run: black --check schema
104 changes: 25 additions & 79 deletions schema/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -165,9 +165,7 @@ def _build_schemas(self) -> List[TSchema]:

def _build_schema(self, arg: Any) -> TSchema:
# Assume self._schema_class(arg, ...) returns an instance of TSchema
return self._schema_class(
arg, error=self._error, ignore_extra_keys=self._ignore_extra_keys
)
return self._schema_class(arg, error=self._error, ignore_extra_keys=self._ignore_extra_keys)


class Or(And[TSchema]):
Expand All @@ -193,9 +191,7 @@ def reset(self) -> None:
failed: bool = self.match_count > 1 and self.only_one
self.match_count = 0
if failed:
raise SchemaOnlyOneAllowedError(
["There are multiple keys present from the %r condition" % self]
)
raise SchemaOnlyOneAllowedError(["There are multiple keys present from the %r condition" % self])

def validate(self, data: Any, **kwargs: Any) -> Any:
"""
Expand Down Expand Up @@ -240,13 +236,9 @@ class Regex:
"re.TEMPLATE",
]

def __init__(
self, pattern_str: str, flags: int = 0, error: Union[str, None] = None
) -> None:
def __init__(self, pattern_str: str, flags: int = 0, error: Union[str, None] = None) -> None:
self._pattern_str: str = pattern_str
flags_list = [
Regex.NAMES[i] for i, f in enumerate(f"{flags:09b}") if f != "0"
] # Name for each bit
flags_list = [Regex.NAMES[i] for i, f in enumerate(f"{flags:09b}") if f != "0"] # Name for each bit

self._flags_names: str = ", flags=" + "|".join(flags_list) if flags_list else ""
self._pattern: re.Pattern = re.compile(pattern_str, flags=flags)
Expand All @@ -272,16 +264,10 @@ def validate(self, data: str, **kwargs: Any) -> str:
if self._pattern.search(data):
return data
else:
error_message = (
e.format(data)
if e
else f"{data!r} does not match {self._pattern_str!r}"
)
error_message = e.format(data) if e else f"{data!r} does not match {self._pattern_str!r}"
raise SchemaError(error_message)
except TypeError:
error_message = (
e.format(data) if e else f"{data!r} is not string nor buffer"
)
error_message = e.format(data) if e else f"{data!r} is not string nor buffer"
raise SchemaError(error_message)


Expand All @@ -291,9 +277,7 @@ class Use:
the data while it is being validated.
"""

def __init__(
self, callable_: Callable[[Any], Any], error: Union[str, None] = None
) -> None:
def __init__(self, callable_: Callable[[Any], Any], error: Union[str, None] = None) -> None:
if not callable(callable_):
raise TypeError(f"Expected a callable, not {callable_!r}")
self._callable: Callable[[Any], Any] = callable_
Expand Down Expand Up @@ -451,9 +435,7 @@ def validate(self, data: Any, **kwargs: Dict[str, Any]) -> Any:

with exitstack:
# Evaluate dictionaries last
data_items = sorted(
data.items(), key=lambda value: isinstance(value[1], dict)
)
data_items = sorted(data.items(), key=lambda value: isinstance(value[1], dict))
for key, value in data_items:
for skey in sorted_skeys:
svalue = s[skey]
Expand All @@ -472,17 +454,13 @@ def validate(self, data: Any, **kwargs: Dict[str, Any]) -> Any:
# value has a certain type, and allowing Forbidden to
# work well in combination with Optional.
try:
nvalue = Schema(svalue, error=e).validate(
value, **kwargs
)
nvalue = Schema(svalue, error=e).validate(value, **kwargs)
except SchemaError:
continue
skey.handler(nkey, data, e)
else:
try:
nvalue = Schema(
svalue, error=e, ignore_extra_keys=i
).validate(value, **kwargs)
nvalue = Schema(svalue, error=e, ignore_extra_keys=i).validate(value, **kwargs)
except SchemaError as x:
k = "Key '%s' error:" % nkey
message = self._prepend_schema_name(k)
Expand All @@ -497,9 +475,7 @@ def validate(self, data: Any, **kwargs: Dict[str, Any]) -> Any:
required = set(k for k in s if not self._is_optional_type(k))
if not required.issubset(coverage):
missing_keys = required - coverage
s_missing_keys = ", ".join(
repr(k) for k in sorted(missing_keys, key=repr)
)
s_missing_keys = ", ".join(repr(k) for k in sorted(missing_keys, key=repr))
message = "Missing key%s: %s" % (
_plural_s(missing_keys),
s_missing_keys,
Expand All @@ -518,10 +494,7 @@ def validate(self, data: Any, **kwargs: Dict[str, Any]) -> Any:
raise SchemaWrongKeyError(message, e.format(data) if e else None)

# Apply default-having optionals that haven't been used:
defaults = (
set(k for k in s if isinstance(k, Optional) and hasattr(k, "default"))
- coverage
)
defaults = set(k for k in s if isinstance(k, Optional) and hasattr(k, "default")) - coverage
for default in defaults:
new[default.key] = (
_invoke_with_optional_kwargs(default.default, **kwargs)
Expand All @@ -541,9 +514,7 @@ def validate(self, data: Any, **kwargs: Dict[str, Any]) -> Any:
try:
return s.validate(data, **kwargs)
except SchemaError as x:
raise SchemaError(
[None] + x.autos, [e.format(data) if e else None] + x.errors
)
raise SchemaError([None] + x.autos, [e.format(data) if e else None] + x.errors)
except BaseException as x:
message = "%r.validate(%r) raised %r" % (s, data, x)
message = self._prepend_schema_name(message)
Expand All @@ -554,9 +525,7 @@ def validate(self, data: Any, **kwargs: Dict[str, Any]) -> Any:
if s(data):
return data
except SchemaError as x:
raise SchemaError(
[None] + x.autos, [e.format(data) if e else None] + x.errors
)
raise SchemaError([None] + x.autos, [e.format(data) if e else None] + x.errors)
except BaseException as x:
message = "%s(%r) raised %r" % (f, data, x)
message = self._prepend_schema_name(message)
Expand All @@ -571,9 +540,7 @@ def validate(self, data: Any, **kwargs: Dict[str, Any]) -> Any:
message = self._prepend_schema_name(message)
raise SchemaError(message, e.format(data) if e else None)

def json_schema(
self, schema_id: str, use_refs: bool = False, **kwargs: Any
) -> Dict[str, Any]:
def json_schema(self, schema_id: str, use_refs: bool = False, **kwargs: Any) -> Dict[str, Any]:
"""Generate a draft-07 JSON schema dict representing the Schema.
This method must be called with a schema_id.
Expand Down Expand Up @@ -658,9 +625,7 @@ def _to_schema(s: Any, ignore_extra_keys: bool) -> Schema:
if allow_reference and schema.as_reference:
# Generate sub schema if not already done
if schema.name not in definitions_by_name:
definitions_by_name[
cast(str, schema.name)
] = {} # Avoid infinite loop
definitions_by_name[cast(str, schema.name)] = {} # Avoid infinite loop
definitions_by_name[cast(str, schema.name)] = _json_schema(
schema, is_main_schema=False, allow_reference=False
)
Expand All @@ -675,24 +640,15 @@ def _to_schema(s: Any, ignore_extra_keys: bool) -> Schema:

return_schema["type"] = "array"
if len(s) == 1:
return_schema["items"] = _json_schema(
_to_schema(s[0], i), is_main_schema=False
)
return_schema["items"] = _json_schema(_to_schema(s[0], i), is_main_schema=False)
elif len(s) > 1:
return_schema["items"] = _json_schema(
Schema(Or(*s)), is_main_schema=False
)
return_schema["items"] = _json_schema(Schema(Or(*s)), is_main_schema=False)
elif isinstance(s, Or):
# Handle Or values

# Check if we can use an enum
if all(
priority == COMPARABLE
for priority in [_priority(value) for value in s.args]
):
or_values = [
str(s) if isinstance(s, Literal) else s for s in s.args
]
if all(priority == COMPARABLE for priority in [_priority(value) for value in s.args]):
or_values = [str(s) if isinstance(s, Literal) else s for s in s.args]
# All values are simple, can use enum or const
if len(or_values) == 1:
return_schema["const"] = _to_json_type(or_values[0])
Expand All @@ -702,9 +658,7 @@ def _to_schema(s: Any, ignore_extra_keys: bool) -> Schema:
# No enum, let's go with recursive calls
any_of_values = []
for or_key in s.args:
new_value = _json_schema(
_to_schema(or_key, i), is_main_schema=False
)
new_value = _json_schema(_to_schema(or_key, i), is_main_schema=False)
if new_value != {} and new_value not in any_of_values:
any_of_values.append(new_value)
if len(any_of_values) == 1:
Expand All @@ -716,9 +670,7 @@ def _to_schema(s: Any, ignore_extra_keys: bool) -> Schema:
# Handle And values
all_of_values = []
for and_key in s.args:
new_value = _json_schema(
_to_schema(and_key, i), is_main_schema=False
)
new_value = _json_schema(_to_schema(and_key, i), is_main_schema=False)
if new_value != {} and new_value not in all_of_values:
all_of_values.append(new_value)
if len(all_of_values) == 1:
Expand Down Expand Up @@ -772,10 +724,7 @@ def _get_key_name(key: Any) -> Any:

return key

additional_properties = (
additional_properties
or _key_allows_additional_properties(key)
)
additional_properties = additional_properties or _key_allows_additional_properties(key)
sub_schema = _to_schema(s[key], ignore_extra_keys=i)
key_name = _get_key_name(key)

Expand Down Expand Up @@ -857,8 +806,7 @@ def __hash__(self) -> int:
def __eq__(self, other: Any) -> bool:
return (
self.__class__ is other.__class__
and getattr(self, "default", self._MARKER)
== getattr(other, "default", self._MARKER)
and getattr(self, "default", self._MARKER) == getattr(other, "default", self._MARKER)
and self._schema == other._schema
)

Expand All @@ -881,9 +829,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:

@staticmethod
def _default_function(nkey: Any, data: Any, error: Any) -> NoReturn:
raise SchemaForbiddenKeyError(
f"Forbidden key encountered: {nkey!r} in {data!r}", error
)
raise SchemaForbiddenKeyError(f"Forbidden key encountered: {nkey!r} in {data!r}", error)


class Literal:
Expand Down

0 comments on commit f1e42a8

Please sign in to comment.