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 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
|
# This file is part of Hypothesis, which may be found at
# https://github.com/HypothesisWorks/hypothesis/
#
# Copyright the Hypothesis Authors.
# Individual contributors are listed in AUTHORS.rst and the git log.
#
# This Source Code Form is subject to the terms of the Mozilla Public License,
# v. 2.0. If a copy of the MPL was not distributed with this file, You can
# obtain one at https://mozilla.org/MPL/2.0/.
"""
'Golden master' tests for the ghostwriter.
To update the recorded outputs, run `pytest --hypothesis-update-outputs ...`.
"""
import ast
import base64
import builtins
import operator
import pathlib
import re
import sys
from typing import Optional, Sequence, Union
import numpy
import pytest
from example_code.future_annotations import (
add_custom_classes,
invalid_types,
merge_dicts,
)
import hypothesis
from hypothesis.extra import ghostwriter
from hypothesis.utils.conventions import not_set
@pytest.fixture
def update_recorded_outputs(request):
return request.config.getoption("--hypothesis-update-outputs")
def get_recorded(name, actual=""):
file_ = pathlib.Path(__file__).parent / "recorded" / f"{name}.txt"
if actual:
file_.write_text(actual)
return file_.read_text()
def timsort(seq: Sequence[int]) -> Sequence[int]:
return sorted(seq)
def with_docstring(a, b, c, d=int, e=lambda x: f"xx{x}xx") -> None:
"""Demonstrates parsing params from the docstring
:param a: sphinx docstring style
:type a: sequence of integers
b (list, tuple, or None): Google docstring style
c : {"foo", "bar", or None}
Numpy docstring style
"""
class A_Class:
@classmethod
def a_classmethod(cls, arg: int):
pass
@staticmethod
def a_staticmethod(arg: int):
pass
def add(a: float, b: float) -> float:
return a + b
def divide(a: int, b: int) -> float:
"""This is a RST-style docstring for `divide`.
:raises ZeroDivisionError: if b == 0
"""
return a / b
def optional_parameter(a: float, b: Optional[float]) -> float:
return optional_union_parameter(a, b)
def optional_union_parameter(a: float, b: Optional[Union[float, int]]) -> float:
return a if b is None else a + b
if sys.version_info[:2] >= (3, 10):
def union_sequence_parameter(items: Sequence[float | int]) -> float:
return sum(items)
else:
def union_sequence_parameter(items: Sequence[Union[float, int]]) -> float:
return sum(items)
# Note: for some of the `expected` outputs, we replace away some small
# parts which vary between minor versions of Python.
@pytest.mark.parametrize(
"data",
[
("fuzz_sorted", ghostwriter.fuzz(sorted)),
("fuzz_sorted_with_annotations", ghostwriter.fuzz(sorted, annotate=True)),
("fuzz_with_docstring", ghostwriter.fuzz(with_docstring)),
("fuzz_classmethod", ghostwriter.fuzz(A_Class.a_classmethod)),
("fuzz_staticmethod", ghostwriter.fuzz(A_Class.a_staticmethod)),
("fuzz_ufunc", ghostwriter.fuzz(numpy.add)),
("magic_gufunc", ghostwriter.magic(numpy.matmul)),
pytest.param(
("optional_parameter", ghostwriter.magic(optional_parameter)),
marks=pytest.mark.skipif("sys.version_info[:2] < (3, 9)"),
),
pytest.param(
("optional_parameter_pre_py_3_9", ghostwriter.magic(optional_parameter)),
marks=pytest.mark.skipif("sys.version_info[:2] >= (3, 9)"),
),
("optional_union_parameter", ghostwriter.magic(optional_union_parameter)),
("union_sequence_parameter", ghostwriter.magic(union_sequence_parameter)),
pytest.param(
("add_custom_classes", ghostwriter.magic(add_custom_classes)),
marks=pytest.mark.skipif("sys.version_info[:2] < (3, 10)"),
),
pytest.param(
("merge_dicts", ghostwriter.magic(merge_dicts)),
marks=pytest.mark.skipif("sys.version_info[:2] < (3, 10)"),
),
pytest.param(
("invalid_types", ghostwriter.magic(invalid_types)),
marks=pytest.mark.skipif("sys.version_info[:2] < (3, 10)"),
),
("magic_base64_roundtrip", ghostwriter.magic(base64.b64encode)),
(
"magic_base64_roundtrip_with_annotations",
ghostwriter.magic(base64.b64encode, annotate=True),
),
("re_compile", ghostwriter.fuzz(re.compile)),
(
"re_compile_except",
ghostwriter.fuzz(re.compile, except_=re.error)
# re.error fixed it's __module__ in Python 3.7
.replace("import sre_constants\n", "").replace("sre_constants.", "re."),
),
("re_compile_unittest", ghostwriter.fuzz(re.compile, style="unittest")),
pytest.param(
("base64_magic", ghostwriter.magic(base64)),
marks=pytest.mark.skipif("sys.version_info[:2] >= (3, 10)"),
),
("sorted_idempotent", ghostwriter.idempotent(sorted)),
("timsort_idempotent", ghostwriter.idempotent(timsort)),
(
"timsort_idempotent_asserts",
ghostwriter.idempotent(timsort, except_=AssertionError),
),
("eval_equivalent", ghostwriter.equivalent(eval, ast.literal_eval)),
("sorted_self_equivalent", ghostwriter.equivalent(sorted, sorted, sorted)),
(
"sorted_self_equivalent_with_annotations",
ghostwriter.equivalent(sorted, sorted, sorted, annotate=True),
),
("addition_op_magic", ghostwriter.magic(add)),
("addition_op_multimagic", ghostwriter.magic(add, operator.add, numpy.add)),
("division_fuzz_error_handler", ghostwriter.fuzz(divide)),
(
"division_binop_error_handler",
ghostwriter.binary_operation(divide, identity=1),
),
(
"division_roundtrip_error_handler",
ghostwriter.roundtrip(divide, operator.mul),
),
(
"division_roundtrip_error_handler_without_annotations",
ghostwriter.roundtrip(divide, operator.mul, annotate=False),
),
(
"division_roundtrip_arithmeticerror_handler",
ghostwriter.roundtrip(divide, operator.mul, except_=ArithmeticError),
),
(
"division_roundtrip_typeerror_handler",
ghostwriter.roundtrip(divide, operator.mul, except_=TypeError),
),
(
"division_operator",
ghostwriter.binary_operation(
operator.truediv, associative=False, commutative=False
),
),
(
"division_operator_with_annotations",
ghostwriter.binary_operation(
operator.truediv, associative=False, commutative=False, annotate=True
),
),
(
"multiplication_operator",
ghostwriter.binary_operation(
operator.mul, identity=1, distributes_over=operator.add
),
),
(
"multiplication_operator_unittest",
ghostwriter.binary_operation(
operator.mul,
identity=1,
distributes_over=operator.add,
style="unittest",
),
),
(
"sorted_self_error_equivalent_simple",
ghostwriter.equivalent(sorted, sorted, allow_same_errors=True),
),
(
"sorted_self_error_equivalent_threefuncs",
ghostwriter.equivalent(sorted, sorted, sorted, allow_same_errors=True),
),
(
"sorted_self_error_equivalent_1error",
ghostwriter.equivalent(
sorted,
sorted,
allow_same_errors=True,
except_=ValueError,
),
),
(
"sorted_self_error_equivalent_2error_unittest",
ghostwriter.equivalent(
sorted,
sorted,
allow_same_errors=True,
except_=(TypeError, ValueError),
style="unittest",
),
),
("magic_class", ghostwriter.magic(A_Class)),
pytest.param(
("magic_builtins", ghostwriter.magic(builtins)),
marks=[
pytest.mark.skipif(
sys.version_info[:2] not in [(3, 8), (3, 9)],
reason="compile arg new in 3.8, aiter and anext new in 3.10",
)
],
),
],
ids=lambda x: x[0],
)
def test_ghostwriter_example_outputs(update_recorded_outputs, data):
name, actual = data
expected = get_recorded(name, actual * update_recorded_outputs)
assert actual == expected # We got the expected source code
exec(expected, {}) # and there are no SyntaxError or NameErrors
def test_ghostwriter_on_hypothesis(update_recorded_outputs):
actual = ghostwriter.magic(hypothesis).replace("Strategy[+Ex]", "Strategy")
expected = get_recorded("hypothesis_module_magic", actual * update_recorded_outputs)
if sys.version_info[:2] < (3, 10):
assert actual == expected
exec(expected, {"not_set": not_set})
|