1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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
61
62
63
64
|
# Copyright 2023 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""# Ordered"""
# This is just a stub so doc generation is nicer.
def _ordered_in_order():
"""Checks that the values were in order."""
IN_ORDER = struct(
in_order = _ordered_in_order,
)
def _ordered_incorrectly_new(format_problem, format_actual, meta):
"""Creates a new `Ordered` object that fails due to incorrectly ordered values.
This creates an [`Ordered`] object that always fails. If order is correct,
use the `_IN_ORDER` constant.
Args:
format_problem: (callable) accepts no args and returns string (the
reported problem description).
format_actual: (callable) accepts not args and returns tring (the
reported actual description).
meta: ([`ExpectMeta`]) used to report the failure.
Returns:
[`Ordered`] object.
"""
self = struct(
meta = meta,
format_problem = format_problem,
format_actual = format_actual,
)
public = struct(
in_order = lambda *a, **k: _ordered_incorrectly_in_order(self, *a, **k),
)
return public
def _ordered_incorrectly_in_order(self):
"""Checks that the values were in order.
Args:
self: implicitly added.
"""
self.meta.add_failure(self.format_problem(), self.format_actual())
# We use this name so it shows up nice in docs.
# buildifier: disable=name-conventions
OrderedIncorrectly = struct(
new = _ordered_incorrectly_new,
in_order = _ordered_incorrectly_in_order,
)
|
