Google Git Google Git
Sign in
chromium/external/github.com/python/cpython/b2b0a337098e60fa9f84df7b53d191fbd8d4fc67/./Lib/test/test_clinic.py
blob: 0274edd384da43978d55141f964721697bf8d455 [file]
# Argument Clinic
# Copyright 2012-2013 by Larry Hastings.
# Licensed to the PSF under a contributor agreement.
from functools import partial
from test import support, test_tools
from test.support import force_not_colorized_test_class
from test.support import os_helper
from test.support.os_helper import TESTFN, unlink, rmtree
from textwrap import dedent
from unittest import TestCase
import difflib
import inspect
import os.path
import re
import sys
import unittest
import warnings
test_tools.skip_if_missing('clinic')
with test_tools.imports_under_tool('clinic'):
import libclinic
from libclinic import ClinicError, unspecified, NULL, fail
from libclinic.converters import (
int_converter, object_converter, str_converter, self_converter)
from libclinic.function import (
Module, Class, Function, FunctionKind, Parameter,
permute_optional_groups, permute_right_option_groups,
permute_left_option_groups)
import clinic
from libclinic.clanguage import CLanguage
from libclinic.converter import converters, legacy_converters
from libclinic.return_converters import return_converters, int_return_converter
from libclinic.block_parser import Block, BlockParser
from libclinic.codegen import BlockPrinter, Destination
from libclinic.dsl_parser import DSLParser
from libclinic.cli import parse_file, Clinic
def repeat_fn(*functions):
def wrapper(test):
def wrapped(self):
for fn in functions:
with self.subTest(fn=fn):
test(self, fn)
return wrapped
return wrapper
def _make_clinic(*, filename='clinic_tests', limited_capi=False):
clang = CLanguage(filename)
c = Clinic(clang, filename=filename, limited_capi=limited_capi)
c.block_parser = BlockParser('', clang)
return c
def _expect_failure(tc, parser, code, errmsg, *, filename=None, lineno=None,
strip=True):
"""Helper for the parser tests.
tc: unittest.TestCase; passed self in the wrapper
parser: the clinic parser used for this test case
code: a str with input text (clinic code)
errmsg: the expected error message
filename: str, optional filename
lineno: int, optional line number
"""
code = dedent(code)
if strip:
code = code.strip()
errmsg = re.escape(errmsg)
with tc.assertRaisesRegex(ClinicError, errmsg) as cm:
parser(code)
if filename is not None:
tc.assertEqual(cm.exception.filename, filename)
if lineno is not None:
tc.assertEqual(cm.exception.lineno, lineno)
return cm.exception
def restore_dict(converters, old_converters):
converters.clear()
converters.update(old_converters)
def save_restore_converters(testcase):
testcase.addCleanup(restore_dict, converters,
converters.copy())
testcase.addCleanup(restore_dict, legacy_converters,
legacy_converters.copy())
testcase.addCleanup(restore_dict, return_converters,
return_converters.copy())
class ClinicWholeFileTest(TestCase):
maxDiff = None
def expect_failure(self, raw, errmsg, *, filename=None, lineno=None):
_expect_failure(self, self.clinic.parse, raw, errmsg,
filename=filename, lineno=lineno)
def setUp(self):
save_restore_converters(self)
self.clinic = _make_clinic(filename="test.c")
def test_eol(self):
# regression test:
# clinic's block parser didn't recognize
# the "end line" for the block if it
# didn't end in "\n" (as in, the last)
# byte of the file was '/'.
# so it would spit out an end line for you.
# and since you really already had one,
# the last line of the block got corrupted.
raw = "/*[clinic]\nfoo\n[clinic]*/"
cooked = self.clinic.parse(raw).splitlines()
end_line = cooked[2].rstrip()
# this test is redundant, it's just here explicitly to catch
# the regression test so we don't forget what it looked like
self.assertNotEqual(end_line, "[clinic]*/[clinic]*/")
self.assertEqual(end_line, "[clinic]*/")
def test_mangled_marker_line(self):
raw = """
/*[clinic input]
[clinic start generated code]*/
/*[clinic end generated code: foo]*/
"""
err = (
"Mangled Argument Clinic marker line: "
"'/*[clinic end generated code: foo]*/'"
)
self.expect_failure(raw, err, filename="test.c", lineno=3)
def test_checksum_mismatch(self):
raw = """
/*[clinic input]
[clinic start generated code]*/
/*[clinic end generated code: output=0123456789abcdef input=fedcba9876543210]*/
"""
err = ("Checksum mismatch! "
"Expected '0123456789abcdef', computed 'da39a3ee5e6b4b0d'")
self.expect_failure(raw, err, filename="test.c", lineno=3)
def test_garbage_after_stop_line(self):
raw = """
/*[clinic input]
[clinic start generated code]*/foobarfoobar!
"""
err = "Garbage after stop line: 'foobarfoobar!'"
self.expect_failure(raw, err, filename="test.c", lineno=2)
def test_whitespace_before_stop_line(self):
raw = """
/*[clinic input]
[clinic start generated code]*/
"""
err = (
"Whitespace is not allowed before the stop line: "
"' [clinic start generated code]*/'"
)
self.expect_failure(raw, err, filename="test.c", lineno=2)
def test_parse_with_body_prefix(self):
clang = CLanguage(None)
clang.body_prefix = "//"
clang.start_line = "//[{dsl_name} start]"
clang.stop_line = "//[{dsl_name} stop]"
cl = Clinic(clang, filename="test.c", limited_capi=False)
raw = dedent("""
//[clinic start]
//module test
//[clinic stop]
""").strip()
out = cl.parse(raw)
expected = dedent("""
//[clinic start]
//module test
//
//[clinic stop]
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=65fab8adff58cf08]*/
""").lstrip() # Note, lstrip() because of the newline
self.assertEqual(out, expected)
def test_cpp_monitor_fail_nested_block_comment(self):
raw = """
/* start
/* nested
*/
*/
"""
err = 'Nested block comment!'
self.expect_failure(raw, err, filename="test.c", lineno=2)
def test_cpp_monitor_fail_invalid_format_noarg(self):
raw = """
#if
a()
#endif
"""
err = 'Invalid format for #if line: no argument!'
self.expect_failure(raw, err, filename="test.c", lineno=1)
def test_cpp_monitor_fail_invalid_format_toomanyargs(self):
raw = """
#ifdef A B
a()
#endif
"""
err = 'Invalid format for #ifdef line: should be exactly one argument!'
self.expect_failure(raw, err, filename="test.c", lineno=1)
def test_cpp_monitor_fail_no_matching_if(self):
raw = '#else'
err = '#else without matching #if / #ifdef / #ifndef!'
self.expect_failure(raw, err, filename="test.c", lineno=1)
def test_directive_output_unknown_preset(self):
raw = """
/*[clinic input]
output preset nosuchpreset
[clinic start generated code]*/
"""
err = "Unknown preset 'nosuchpreset'"
self.expect_failure(raw, err)
def test_directive_output_cant_pop(self):
raw = """
/*[clinic input]
output pop
[clinic start generated code]*/
"""
err = "Can't 'output pop', stack is empty"
self.expect_failure(raw, err)
def test_directive_output_print(self):
raw = dedent("""
/*[clinic input]
output print 'I told you once.'
[clinic start generated code]*/
""")
out = self.clinic.parse(raw)
# The generated output will differ for every run, but we can check that
# it starts with the clinic block, we check that it contains all the
# expected fields, and we check that it contains the checksum line.
self.assertStartsWith(out, dedent("""
/*[clinic input]
output print 'I told you once.'
[clinic start generated code]*/
"""))
fields = {
"cpp_endif",
"cpp_if",
"docstring_definition",
"docstring_prototype",
"impl_definition",
"impl_prototype",
"methoddef_define",
"methoddef_ifndef",
"parser_definition",
"parser_prototype",
}
for field in fields:
with self.subTest(field=field):
self.assertIn(field, out)
last_line = out.rstrip().split("\n")[-1]
self.assertStartsWith(last_line, "/*[clinic end generated code: output=")
def test_directive_wrong_arg_number(self):
raw = dedent("""
/*[clinic input]
preserve foo bar baz eggs spam ham mushrooms
[clinic start generated code]*/
""")
err = "takes 1 positional argument but 8 were given"
self.expect_failure(raw, err)
def test_unknown_destination_command(self):
raw = """
/*[clinic input]
destination buffer nosuchcommand
[clinic start generated code]*/
"""
err = "unknown destination command 'nosuchcommand'"
self.expect_failure(raw, err)
def test_no_access_to_members_in_converter_init(self):
raw = """
/*[python input]
class Custom_converter(CConverter):
converter = "some_c_function"
def converter_init(self):
self.function.noaccess
[python start generated code]*/
/*[clinic input]
module test
test.fn
a: Custom
[clinic start generated code]*/
"""
err = (
"accessing self.function inside converter_init is disallowed!"
)
self.expect_failure(raw, err)
def test_clone_mismatch(self):
err = "'kind' of function and cloned function don't match!"
block = """
/*[clinic input]
module m
@classmethod
m.f1
a: object
[clinic start generated code]*/
/*[clinic input]
@staticmethod
m.f2 = m.f1
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=9)
def test_badly_formed_return_annotation(self):
err = "Badly formed annotation for 'm.f': 'Custom'"
block = """
/*[python input]
class Custom_return_converter(CReturnConverter):
def __init__(self):
raise ValueError("abc")
[python start generated code]*/
/*[clinic input]
module m
m.f -> Custom
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=8)
def test_ambiguous_group_and_optional_parameters(self):
err = ("Function 'my_test_func' has an ambiguous group configuration: "
"a call with 2 argument(s) can be parsed in more than one way.")
block = """
/*[clinic input]
my_test_func
[
a: object
b: object
]
c: object = None
d: object = None
/
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=2)
def test_star_after_vararg(self):
err = "'my_test_func' uses '*' more than once."
block = """
/*[clinic input]
my_test_func
pos_arg: object
*args: tuple
*
kw_arg: object
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=6)
def test_vararg_after_star(self):
err = "'my_test_func' uses '*' more than once."
block = """
/*[clinic input]
my_test_func
pos_arg: object
*
*args: tuple
kw_arg: object
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=6)
def test_parameter_after_var_keyword(self):
err = "parameters cannot follow var-keyword parameter: 'invalid_arg: object'"
block = """
/*[clinic input]
my_test_func
**kwds: dict
invalid_arg: object
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=5)
def test_double_star_without_name(self):
err = "Function 'my_test_func' has an invalid parameter declaration: '**'"
block = """
/*[clinic input]
my_test_func
pos_arg: object
**
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=5)
def test_module_already_got_one(self):
err = "Already defined module 'm'!"
block = """
/*[clinic input]
module m
module m
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=3)
def test_destination_already_got_one(self):
err = "Destination already exists: 'test'"
block = """
/*[clinic input]
destination test new buffer
destination test new buffer
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=3)
def test_destination_does_not_exist(self):
err = "Destination does not exist: '/dev/null'"
block = """
/*[clinic input]
output everything /dev/null
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=2)
def test_class_already_got_one(self):
err = "Already defined class 'C'!"
block = """
/*[clinic input]
class C "" ""
class C "" ""
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=3)
def test_cant_nest_module_inside_class(self):
err = "Can't nest a module inside a class!"
block = """
/*[clinic input]
class C "" ""
module C.m
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=3)
def test_dest_buffer_not_empty_at_eof(self):
expected_warning = ("Destination buffer 'buffer' not empty at "
"end of file, emptying.")
expected_generated = dedent("""
/*[clinic input]
output everything buffer
fn
a: object
/
[clinic start generated code]*/
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=1c4668687f5fd002]*/
/*[clinic input]
dump buffer
[clinic start generated code]*/
PyDoc_VAR(fn__doc__);
PyDoc_STRVAR(fn__doc__,
"fn($module, a, /)\\n"
"--\\n"
"\\n");
#define FN_METHODDEF \\
{"fn", (PyCFunction)fn, METH_O, fn__doc__},
static PyObject *
fn(PyObject *module, PyObject *a)
/*[clinic end generated code: output=be6798b148ab4e53 input=524ce2e021e4eba6]*/
""")
block = dedent("""
/*[clinic input]
output everything buffer
fn
a: object
/
[clinic start generated code]*/
""")
with support.captured_stdout() as stdout:
generated = self.clinic.parse(block)
self.assertIn(expected_warning, stdout.getvalue())
self.assertEqual(generated, expected_generated)
def test_dest_clear(self):
err = "Can't clear destination 'file': it's not of type 'buffer'"
block = """
/*[clinic input]
destination file clear
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=2)
def test_directive_set_misuse(self):
err = "unknown variable 'ets'"
block = """
/*[clinic input]
set ets tse
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=2)
def test_directive_set_prefix(self):
block = dedent("""
/*[clinic input]
set line_prefix '// '
output everything suppress
output docstring_prototype buffer
fn
a: object
/
[clinic start generated code]*/
/* We need to dump the buffer.
* If not, Argument Clinic will emit a warning */
/*[clinic input]
dump buffer
[clinic start generated code]*/
""")
generated = self.clinic.parse(block)
expected_docstring_prototype = "// PyDoc_VAR(fn__doc__);"
self.assertIn(expected_docstring_prototype, generated)
def test_directive_set_suffix(self):
block = dedent("""
/*[clinic input]
set line_suffix ' // test'
output everything suppress
output docstring_prototype buffer
fn
a: object
/
[clinic start generated code]*/
/* We need to dump the buffer.
* If not, Argument Clinic will emit a warning */
/*[clinic input]
dump buffer
[clinic start generated code]*/
""")
generated = self.clinic.parse(block)
expected_docstring_prototype = "PyDoc_VAR(fn__doc__); // test"
self.assertIn(expected_docstring_prototype, generated)
def test_directive_set_prefix_and_suffix(self):
block = dedent("""
/*[clinic input]
set line_prefix '{block comment start} '
set line_suffix ' {block comment end}'
output everything suppress
output docstring_prototype buffer
fn
a: object
/
[clinic start generated code]*/
/* We need to dump the buffer.
* If not, Argument Clinic will emit a warning */
/*[clinic input]
dump buffer
[clinic start generated code]*/
""")
generated = self.clinic.parse(block)
expected_docstring_prototype = "/* PyDoc_VAR(fn__doc__); */"
self.assertIn(expected_docstring_prototype, generated)
def test_directive_printout(self):
block = dedent("""
/*[clinic input]
output everything buffer
printout test
[clinic start generated code]*/
""")
expected = dedent("""
/*[clinic input]
output everything buffer
printout test
[clinic start generated code]*/
test
/*[clinic end generated code: output=4e1243bd22c66e76 input=898f1a32965d44ca]*/
""")
generated = self.clinic.parse(block)
self.assertEqual(generated, expected)
def test_directive_preserve_twice(self):
err = "Can't have 'preserve' twice in one block!"
block = """
/*[clinic input]
preserve
preserve
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=3)
def test_directive_preserve_input(self):
err = "'preserve' only works for blocks that don't produce any output!"
block = """
/*[clinic input]
preserve
fn
a: object
/
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=6)
def test_directive_preserve_output(self):
block = dedent("""
/*[clinic input]
output everything buffer
preserve
[clinic start generated code]*/
// Preserve this
/*[clinic end generated code: output=eaa49677ae4c1f7d input=559b5db18fddae6a]*/
/*[clinic input]
dump buffer
[clinic start generated code]*/
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=524ce2e021e4eba6]*/
""")
generated = self.clinic.parse(block)
self.assertEqual(generated, block)
def test_directive_output_invalid_command(self):
err = dedent("""
Invalid command or destination name 'cmd'. Must be one of:
- 'preset'
- 'push'
- 'pop'
- 'print'
- 'everything'
- 'cpp_if'
- 'docstring_prototype'
- 'docstring_definition'
- 'methoddef_define'
- 'impl_prototype'
- 'parser_prototype'
- 'parser_helper'
- 'parser_definition'
- 'vectorcall_definition'
- 'cpp_endif'
- 'methoddef_ifndef'
- 'impl_definition'
""").strip()
block = """
/*[clinic input]
output cmd buffer
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=2)
def test_validate_cloned_init(self):
block = """
/*[clinic input]
class C "void *" ""
C.meth
a: int
[clinic start generated code]*/
/*[clinic input]
@classmethod
C.__init__ = C.meth
[clinic start generated code]*/
"""
err = "'__init__' must be a normal method; got 'FunctionKind.CLASS_METHOD'!"
self.expect_failure(block, err, lineno=8)
def test_validate_cloned_new(self):
block = """
/*[clinic input]
class C "void *" ""
C.meth
a: int
[clinic start generated code]*/
/*[clinic input]
C.__new__ = C.meth
[clinic start generated code]*/
"""
err = "'__new__' must be a class method"
self.expect_failure(block, err, lineno=7)
def test_no_c_basename_cloned(self):
block = """
/*[clinic input]
foo2
[clinic start generated code]*/
/*[clinic input]
foo as = foo2
[clinic start generated code]*/
"""
err = "No C basename provided after 'as' keyword"
self.expect_failure(block, err, lineno=5)
def test_cloned_with_custom_c_basename(self):
raw = dedent("""
/*[clinic input]
# Make sure we don't create spurious clinic/ directories.
output everything suppress
foo2
[clinic start generated code]*/
/*[clinic input]
foo as foo1 = foo2
[clinic start generated code]*/
""")
self.clinic.parse(raw)
funcs = self.clinic.functions
self.assertEqual(len(funcs), 2)
self.assertEqual(funcs[1].name, "foo")
self.assertEqual(funcs[1].c_basename, "foo1")
def test_cloned_with_illegal_c_basename(self):
block = """
/*[clinic input]
class C "void *" ""
foo1
[clinic start generated code]*/
/*[clinic input]
foo2 as .illegal. = foo1
[clinic start generated code]*/
"""
err = "Illegal C basename: '.illegal.'"
self.expect_failure(block, err, lineno=7)
def test_cloned_forced_text_signature(self):
block = dedent("""
/*[clinic input]
@text_signature "($module, a[, b])"
src
a: object
param a
b: object = NULL
/
docstring
[clinic start generated code]*/
/*[clinic input]
dst = src
[clinic start generated code]*/
""")
self.clinic.parse(block)
self.addCleanup(rmtree, "clinic")
funcs = self.clinic.functions
self.assertEqual(len(funcs), 2)
src_docstring_lines = funcs[0].docstring.split("\n")
dst_docstring_lines = funcs[1].docstring.split("\n")
# Signatures are copied.
self.assertEqual(src_docstring_lines[0], "src($module, a[, b])")
self.assertEqual(dst_docstring_lines[0], "dst($module, a[, b])")
# Param docstrings are copied.
self.assertIn(" param a", src_docstring_lines)
self.assertIn(" param a", dst_docstring_lines)
# Docstrings are not copied.
self.assertIn("docstring", src_docstring_lines)
self.assertNotIn("docstring", dst_docstring_lines)
def test_cloned_forced_text_signature_illegal(self):
block = """
/*[clinic input]
@text_signature "($module, a[, b])"
src
a: object
b: object = NULL
/
[clinic start generated code]*/
/*[clinic input]
@text_signature "($module, a_override[, b])"
dst = src
[clinic start generated code]*/
"""
err = "Cannot use @text_signature when cloning a function"
self.expect_failure(block, err, lineno=11)
def test_ignore_preprocessor_in_comments(self):
for dsl in "clinic", "python":
raw = dedent(f"""\
/*[{dsl} input]
# CPP directives, valid or not, should be ignored in C comments.
#
[{dsl} start generated code]*/
""")
self.clinic.parse(raw)
def test_var_keyword_non_dict(self):
err = "'var_keyword_object' is not a valid converter"
block = """
/*[clinic input]
my_test_func
**kwds: object
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=4)
def test_getset_in_ifdef(self):
block = """
/*[clinic input]
output everything block
output methoddef_ifndef buffer
class Foo "FooObject *" "&Foo_Type"
[clinic start generated code]*/
#ifdef CONDITION
/*[clinic input]
@getter
Foo.property
[clinic start generated code]*/
/*[clinic input]
@setter
Foo.property
value: object
[clinic start generated code]*/
#endif
/*[clinic input]
dump buffer
[clinic start generated code]*/
"""
generated = self.clinic.parse(dedent(block))
self.assertIn("#if defined(CONDITION)", generated)
# The getset is undefined if the condition is false.
self.assertIn("#else\n"
"# define FOO_PROPERTY_GETSETDEF\n"
"#endif",
generated)
def test_getset_partially_in_ifdef(self):
block = """
/*[clinic input]
output everything block
output methoddef_ifndef buffer
class Foo "FooObject *" "&Foo_Type"
[clinic start generated code]*/
#ifdef CONDITION
/*[clinic input]
@getter
Foo.property
[clinic start generated code]*/
#endif
/*[clinic input]
@setter
Foo.property
value: object
[clinic start generated code]*/
/*[clinic input]
dump buffer
[clinic start generated code]*/
"""
generated = self.clinic.parse(dedent(block))
# Only the conditional getter announces itself.
self.assertIn("#if defined(CONDITION)\n"
"\n"
"#define FOO_PROPERTY_GETTER Foo_property_get\n",
generated)
self.assertIn("#define FOO_PROPERTY_SETTER Foo_property_set\n"
"#if defined(FOO_PROPERTY_GETTER) "
"|| defined(FOO_PROPERTY_SETTER)",
generated)
self.assertIn('# define FOO_PROPERTY_GETSETDEF {"property", '
'(getter)FOO_PROPERTY_GETTER, '
'(setter)FOO_PROPERTY_SETTER, FOO_PROPERTY_DOCSTR},',
generated)
def test_getset_several_implementations(self):
block = """
/*[clinic input]
output everything block
output methoddef_ifndef buffer
class Foo "FooObject *" "&Foo_Type"
[clinic start generated code]*/
#ifdef CONDITION
/*[clinic input]
@getter
Foo.property as foo_property_special
[clinic start generated code]*/
#else
/*[clinic input]
@getter
Foo.property as foo_property_generic
[clinic start generated code]*/
#endif
/*[clinic input]
dump buffer
[clinic start generated code]*/
"""
# Implementations guarded by preprocessor conditions can share the
# entry; which of them is compiled is only known to the preprocessor.
generated = self.clinic.parse(dedent(block))
self.assertIn("#if defined(CONDITION)\n"
"\n"
"#define FOO_PROPERTY_GETTER "
"foo_property_special_get\n",
generated)
self.assertIn("#if !defined(CONDITION)\n"
"\n"
"#define FOO_PROPERTY_GETTER "
"foo_property_generic_get\n",
generated)
def test_getset_after_dump(self):
block = """
/*[clinic input]
output everything block
output methoddef_ifndef buffer
class Foo "FooObject *" "&Foo_Type"
[clinic start generated code]*/
/*[clinic input]
@getter
Foo.property
[clinic start generated code]*/
/*[clinic input]
dump buffer
[clinic start generated code]*/
/*[clinic input]
@setter
Foo.property
value: object
[clinic start generated code]*/
"""
err = ("All accessors of 'Foo.property' must be defined before "
"its PyGetSetDef entry is dumped")
self.expect_failure(block, err, lineno=15)
def test_setter_deletion_check(self):
block = """
/*[clinic input]
output everything block
class Foo "FooObject *" "&Foo_Type"
[clinic start generated code]*/
/*[clinic input]
@setter
Foo.property
value: object
[clinic start generated code]*/
"""
generated = self.clinic.parse(dedent(block))
self.assertIn("if (arg == NULL) {", generated)
self.assertIn("\"attribute 'property' of '%.100s' objects "
"cannot be deleted\"", generated)
def test_deleter(self):
# @deleter means that the setter is called with NULL to delete
# the attribute, so it checks the value itself.
block = """
/*[clinic input]
output everything block
class Foo "FooObject *" "&Foo_Type"
[clinic start generated code]*/
/*[clinic input]
@setter
@deleter
Foo.property
value: object = NULL
[clinic start generated code]*/
"""
generated = self.clinic.parse(dedent(block))
self.assertNotIn("if (arg == NULL) {", generated)
def test_getset_duplicate(self):
# Only a setter defines the new value.
for annotation, parameter, err in (
("@getter", "", "Cannot apply @getter to 'Foo.property' twice"),
("@setter", "value: object",
"The setter of 'Foo.property' is already defined"),
):
with self.subTest(annotation=annotation):
self.clinic = _make_clinic(filename="test.c")
block = f"""
/*[clinic input]
class Foo "FooObject *" "&Foo_Type"
[clinic start generated code]*/
/*[clinic input]
{annotation}
Foo.property
{parameter}
[clinic start generated code]*/
/*[clinic input]
{annotation}
Foo.property
{parameter}
[clinic start generated code]*/
"""
self.expect_failure(block, err, lineno=11)
def test_getset_different_c_basename(self):
block = """
/*[clinic input]
output everything block
output methoddef_ifndef buffer
class Foo "FooObject *" "&Foo_Type"
[clinic start generated code]*/
/*[clinic input]
@getter
Foo.property as foo_get
[clinic start generated code]*/
/*[clinic input]
@setter
Foo.property as foo_set
value: object
[clinic start generated code]*/
/*[clinic input]
dump buffer
[clinic start generated code]*/
"""
# The accessors are identified by the Python name, not by the
# C basename.
generated = self.clinic.parse(dedent(block))
self.assertIn('#define FOO_PROPERTY_GETSETDEF {"property", '
'(getter)foo_get_get, (setter)foo_set_set, NULL},',
generated)
class ParseFileUnitTest(TestCase):
def expect_parsing_failure(
self, *, filename, expected_error, verify=True, output=None
):
errmsg = re.escape(dedent(expected_error).strip())
with self.assertRaisesRegex(ClinicError, errmsg):
parse_file(filename, limited_capi=False)
def test_parse_file_no_extension(self) -> None:
self.expect_parsing_failure(
filename="foo",
expected_error="Can't extract file type for file 'foo'"
)
def test_parse_file_strange_extension(self) -> None:
filenames_to_errors = {
"foo.rs": "Can't identify file type for file 'foo.rs'",
"foo.hs": "Can't identify file type for file 'foo.hs'",
"foo.js": "Can't identify file type for file 'foo.js'",
}
for filename, errmsg in filenames_to_errors.items():
with self.subTest(filename=filename):
self.expect_parsing_failure(filename=filename, expected_error=errmsg)
class ClinicGroupPermuterTest(TestCase):
def _test(self, l, m, r, output):
computed = permute_optional_groups(l, m, r)
self.assertEqual(output, computed)
def test_range(self):
self._test([[['start']]], ['stop'], [[['step']]],
(
('stop',),
('start', 'stop',),
('start', 'stop', 'step',),
))
def test_add_window(self):
self._test([[['x', 'y']]], ['ch'], [[['attr']]],
(
('ch',),
('ch', 'attr'),
('x', 'y', 'ch',),
('x', 'y', 'ch', 'attr'),
))
def test_ludicrous(self):
self._test([[['a1', 'a2', 'a3'], ['b1', 'b2']]], ['c1'],
[[['d1', 'd2'], ['e1', 'e2', 'e3']]],
(
('c1',),
('b1', 'b2', 'c1'),
('b1', 'b2', 'c1', 'd1', 'd2'),
('a1', 'a2', 'a3', 'b1', 'b2', 'c1'),
('a1', 'a2', 'a3', 'b1', 'b2', 'c1', 'd1', 'd2'),
('a1', 'a2', 'a3', 'b1', 'b2', 'c1', 'd1', 'd2', 'e1', 'e2', 'e3'),
))
def test_right_only(self):
self._test([], [], [[['a'],['b'],['c']]],
(
(),
('a',),
('a', 'b'),
('a', 'b', 'c')
))
def test_chgat(self):
# Two independent groups on the left.
self._test([[['y', 'x']], [['n']]], ['attr'], [],
(
('attr',),
('n', 'attr'),
('y', 'x', 'attr'),
('y', 'x', 'n', 'attr'),
))
def test_independent_groups_on_the_right(self):
self._test([], ['a'], [[['b']], [['c', 'd']]],
(
('a',),
('a', 'b'),
('a', 'c', 'd'),
('a', 'b', 'c', 'd'),
))
def test_have_left_options_but_required_is_empty(self):
def fn():
permute_optional_groups([[['a']]], [], [])
self.assertRaises(ValueError, fn)
class ClinicLinearFormatTest(TestCase):
def _test(self, input, output, **kwargs):
computed = libclinic.linear_format(input, **kwargs)
self.assertEqual(output, computed)
def test_empty_strings(self):
self._test('', '')
def test_solo_newline(self):
self._test('\n', '\n')
def test_no_substitution(self):
self._test("""
abc
""", """
abc
""")
def test_empty_substitution(self):
self._test("""
abc
{name}
def
""", """
abc
def
""", name='')
def test_single_line_substitution(self):
self._test("""
abc
{name}
def
""", """
abc
GARGLE
def
""", name='GARGLE')
def test_multiline_substitution(self):
self._test("""
abc
{name}
def
""", """
abc
bingle
bungle
def
""", name='bingle\nbungle\n')
def test_text_before_block_marker(self):
regex = re.escape("found before '{marker}'")
with self.assertRaisesRegex(ClinicError, regex):
libclinic.linear_format("no text before marker for you! {marker}",
marker="not allowed!")
def test_text_after_block_marker(self):
regex = re.escape("found after '{marker}'")
with self.assertRaisesRegex(ClinicError, regex):
libclinic.linear_format("{marker} no text after marker for you!",
marker="not allowed!")
class InertParser:
def __init__(self, clinic):
pass
def parse(self, block):
pass
class CopyParser:
def __init__(self, clinic):
pass
def parse(self, block):
block.output = block.input
class ClinicBlockParserTest(TestCase):
def _test(self, input, output):
language = CLanguage(None)
blocks = list(BlockParser(input, language))
writer = BlockPrinter(language)
for block in blocks:
writer.print_block(block)
output = writer.f.getvalue()
assert output == input, "output != input!\n\noutput " + repr(output) + "\n\n input " + repr(input)
def round_trip(self, input):
return self._test(input, input)
def test_round_trip_1(self):
self.round_trip("""
verbatim text here
lah dee dah
""")
def test_round_trip_2(self):
self.round_trip("""
verbatim text here
lah dee dah
/*[inert]
abc
[inert]*/
def
/*[inert checksum: 7b18d017f89f61cf17d47f92749ea6930a3f1deb]*/
xyz
""")
def _test_clinic(self, input, output):
language = CLanguage(None)
c = Clinic(language, filename="file", limited_capi=False)
c.parsers['inert'] = InertParser(c)
c.parsers['copy'] = CopyParser(c)
computed = c.parse(input)
self.assertEqual(output, computed)
def test_clinic_1(self):
self._test_clinic("""
verbatim text here
lah dee dah
/*[copy input]
def
[copy start generated code]*/
abc
/*[copy end generated code: output=03cfd743661f0797 input=7b18d017f89f61cf]*/
xyz
""", """
verbatim text here
lah dee dah
/*[copy input]
def
[copy start generated code]*/
def
/*[copy end generated code: output=7b18d017f89f61cf input=7b18d017f89f61cf]*/
xyz
""")
class ClinicParserTest(TestCase):
def parse(self, text):
c = _make_clinic()
parser = DSLParser(c)
block = Block(text)
parser.parse(block)
return block
def parse_function(self, text, signatures_in_block=2, function_index=1):
block = self.parse(text)
s = block.signatures
self.assertEqual(len(s), signatures_in_block)
assert isinstance(s[0], Module)
assert isinstance(s[function_index], Function)
return s[function_index]
def expect_failure(self, block, err, *,
filename=None, lineno=None, strip=True):
return _expect_failure(self, self.parse_function, block, err,
filename=filename, lineno=lineno, strip=strip)
def checkDocstring(self, fn, expected):
self.assertTrue(hasattr(fn, "docstring"))
self.assertEqual(dedent(expected).strip(),
fn.docstring.strip())
def test_trivial(self):
parser = DSLParser(_make_clinic())
block = Block("""
module os
os.access
""")
parser.parse(block)
module, function = block.signatures
self.assertEqual("access", function.name)
self.assertEqual("os", module.name)
def test_ignore_line(self):
block = self.parse(dedent("""
#
module os
os.access
"""))
module, function = block.signatures
self.assertEqual("access", function.name)
self.assertEqual("os", module.name)
def test_param(self):
function = self.parse_function("""
module os
os.access
path: int
""")
self.assertEqual("access", function.name)
self.assertEqual(2, len(function.parameters))
p = function.parameters['path']
self.assertEqual('path', p.name)
self.assertIsInstance(p.converter, int_converter)
def test_param_default(self):
function = self.parse_function("""
module os
os.access
follow_symlinks: bool = True
""")
p = function.parameters['follow_symlinks']
self.assertEqual(True, p.default)
def test_param_with_continuations(self):
function = self.parse_function(r"""
module os
os.access
follow_symlinks: \
bool \
= \
True
""")
p = function.parameters['follow_symlinks']
self.assertEqual(True, p.default)
def test_param_default_none(self):
function = self.parse_function(r"""
module test
test.func
obj: object = None
str: str(accept={str, NoneType}) = None
buf: Py_buffer(accept={str, buffer, NoneType}) = None
""")
p = function.parameters['obj']
self.assertIs(p.default, None)
self.assertEqual(p.converter.py_default, 'None')
self.assertEqual(p.converter.c_default, 'Py_None')
p = function.parameters['str']
self.assertIs(p.default, None)
self.assertEqual(p.converter.py_default, 'None')
self.assertEqual(p.converter.c_default, 'NULL')
p = function.parameters['buf']
self.assertIs(p.default, None)
self.assertEqual(p.converter.py_default, 'None')
self.assertEqual(p.converter.c_default, '{NULL, NULL}')
def test_param_default_null(self):
function = self.parse_function(r"""
module test
test.func
obj: object = NULL
str: str = NULL
buf: Py_buffer = NULL
fsencoded: unicode_fs_encoded = NULL
fsdecoded: unicode_fs_decoded = NULL
""")
p = function.parameters['obj']
self.assertIs(p.default, NULL)
self.assertEqual(p.converter.py_default, '<unrepresentable>')
self.assertEqual(p.converter.c_default, 'NULL')
p = function.parameters['str']
self.assertIs(p.default, NULL)
self.assertEqual(p.converter.py_default, '<unrepresentable>')
self.assertEqual(p.converter.c_default, 'NULL')
p = function.parameters['buf']
self.assertIs(p.default, NULL)
self.assertEqual(p.converter.py_default, '<unrepresentable>')
self.assertEqual(p.converter.c_default, '{NULL, NULL}')
p = function.parameters['fsencoded']
self.assertIs(p.default, NULL)
self.assertEqual(p.converter.py_default, '<unrepresentable>')
self.assertEqual(p.converter.c_default, 'NULL')
p = function.parameters['fsdecoded']
self.assertIs(p.default, NULL)
self.assertEqual(p.converter.py_default, '<unrepresentable>')
self.assertEqual(p.converter.c_default, 'NULL')
def test_param_default_str_literal(self):
function = self.parse_function(r"""
module test
test.func
str: str = ' \t\n\r\v\f\xa0'
buf: Py_buffer(accept={str, buffer}) = ' \t\n\r\v\f\xa0'
""")
p = function.parameters['str']
self.assertEqual(p.default, ' \t\n\r\v\f\xa0')
self.assertEqual(p.converter.py_default, r"' \t\n\r\x0b\x0c\xa0'")
self.assertEqual(p.converter.c_default, r'" \t\n\r\v\f\u00a0"')
p = function.parameters['buf']
self.assertEqual(p.default, ' \t\n\r\v\f\xa0')
self.assertEqual(p.converter.py_default, r"' \t\n\r\x0b\x0c\xa0'")
self.assertEqual(p.converter.c_default,
r'{.buf = " \t\n\r\v\f\302\240", .obj = NULL, .len = 8}')
def test_param_default_bytes_literal(self):
function = self.parse_function(r"""
module test
test.func
str: str(accept={robuffer}) = b' \t\n\r\v\f\xa0'
buf: Py_buffer = b' \t\n\r\v\f\xa0'
""")
p = function.parameters['str']
self.assertEqual(p.default, b' \t\n\r\v\f\xa0')
self.assertEqual(p.converter.py_default, r"b' \t\n\r\x0b\x0c\xa0'")
self.assertEqual(p.converter.c_default, r'" \t\n\r\v\f\240"')
p = function.parameters['buf']
self.assertEqual(p.default, b' \t\n\r\v\f\xa0')
self.assertEqual(p.converter.py_default, r"b' \t\n\r\x0b\x0c\xa0'")
self.assertEqual(p.converter.c_default,
r'{.buf = " \t\n\r\v\f\240", .obj = NULL, .len = 7}')
def test_param_default_byte_literal(self):
function = self.parse_function(r"""
module test
test.func
zero: char = b'\0'
one: char = b'\1'
lf: char = b'\n'
nbsp: char = b'\xa0'
""")
p = function.parameters['zero']
self.assertEqual(p.default, b'\0')
self.assertEqual(p.converter.py_default, r"b'\x00'")
self.assertEqual(p.converter.c_default, r"'\0'")
p = function.parameters['one']
self.assertEqual(p.default, b'\1')
self.assertEqual(p.converter.py_default, r"b'\x01'")
self.assertEqual(p.converter.c_default, r"'\001'")
p = function.parameters['lf']
self.assertEqual(p.default, b'\n')
self.assertEqual(p.converter.py_default, r"b'\n'")
self.assertEqual(p.converter.c_default, r"'\n'")
p = function.parameters['nbsp']
self.assertEqual(p.default, b'\xa0')
self.assertEqual(p.converter.py_default, r"b'\xa0'")
self.assertEqual(p.converter.c_default, r"'\240'")
def test_param_default_unicode_char(self):
function = self.parse_function(r"""
module test
test.func
zero: int(accept={str}) = '\0'
one: int(accept={str}) = '\1'
lf: int(accept={str}) = '\n'
nbsp: int(accept={str}) = '\xa0'
snake: int(accept={str}) = '\U0001f40d'
""")
p = function.parameters['zero']
self.assertEqual(p.default, '\0')
self.assertEqual(p.converter.py_default, r"'\x00'")
self.assertEqual(p.converter.c_default, '0')
p = function.parameters['one']
self.assertEqual(p.default, '\1')
self.assertEqual(p.converter.py_default, r"'\x01'")
self.assertEqual(p.converter.c_default, '0x01')
p = function.parameters['lf']
self.assertEqual(p.default, '\n')
self.assertEqual(p.converter.py_default, r"'\n'")
self.assertEqual(p.converter.c_default, r"'\n'")
p = function.parameters['nbsp']
self.assertEqual(p.default, '\xa0')
self.assertEqual(p.converter.py_default, r"'\xa0'")
self.assertEqual(p.converter.c_default, '0xa0')
p = function.parameters['snake']
self.assertEqual(p.default, '\U0001f40d')
self.assertEqual(p.converter.py_default, "'\U0001f40d'")
self.assertEqual(p.converter.c_default, '0x1f40d')
def test_param_default_bool(self):
function = self.parse_function(r"""
module test
test.func
bool: bool = True
intbool: bool(accept={int}) = True
intbool2: bool(accept={int}) = 2
""")
p = function.parameters['bool']
self.assertIs(p.default, True)
self.assertEqual(p.converter.py_default, 'True')
self.assertEqual(p.converter.c_default, '1')
p = function.parameters['intbool']
self.assertIs(p.default, True)
self.assertEqual(p.converter.py_default, 'True')
self.assertEqual(p.converter.c_default, '1')
p = function.parameters['intbool2']
self.assertEqual(p.default, 2)
self.assertEqual(p.converter.py_default, '2')
self.assertEqual(p.converter.c_default, '2')
def test_param_default_expr_named_constant(self):
function = self.parse_function("""
module os
os.access
follow_symlinks: int(c_default='MAXSIZE') = sys.maxsize
""")
p = function.parameters['follow_symlinks']
self.assertEqual(sys.maxsize, p.default)
self.assertEqual("MAXSIZE", p.converter.c_default)
err = (
"When you specify a named constant ('sys.maxsize') as your default value, "
"you MUST specify a valid c_default."
)
block = """
module os
os.access
follow_symlinks: int = sys.maxsize
"""
self.expect_failure(block, err, lineno=2)
def test_param_with_bizarre_default_fails_correctly(self):
template = """
module os
os.access
follow_symlinks: int = {default}
"""
err = "Unsupported expression as default value"
for bad_default_value in (
"{1, 2, 3}",
"3 if bool() else 4",
"[x for x in range(42)]"
):
with self.subTest(bad_default=bad_default_value):
block = template.format(default=bad_default_value)
self.expect_failure(block, err, lineno=2)
def test_unspecified_not_allowed_as_default_value(self):
block = """
module os
os.access
follow_symlinks: int(c_default='MAXSIZE') = unspecified
"""
err = "'unspecified' is not a legal default value!"
exc = self.expect_failure(block, err, lineno=2)
self.assertNotIn('Malformed expression given as default value', str(exc))
def test_malformed_expression_as_default_value(self):
block = """
module os
os.access
follow_symlinks: int(c_default='MAXSIZE') = 1/0
"""
err = "Malformed expression given as default value"
self.expect_failure(block, err, lineno=2)
def test_param_default_expr_binop(self):
err = (
"When you specify an expression ('a + b') as your default value, "
"you MUST specify a valid c_default."
)
block = """
fn
follow_symlinks: int = a + b
"""
self.expect_failure(block, err, lineno=1)
def test_param_no_docstring(self):
function = self.parse_function("""
module os
os.access
follow_symlinks: bool = True
something_else: str = ''
""")
self.assertEqual(3, len(function.parameters))
conv = function.parameters['something_else'].converter
self.assertIsInstance(conv, str_converter)
def test_param_default_parameters_out_of_order(self):
err = (
"Can't have a parameter without a default ('something_else') "
"after a parameter with a default!"
)
block = """
module os
os.access
follow_symlinks: bool = True
something_else: str
"""
self.expect_failure(block, err, lineno=3)
def disabled_test_converter_arguments(self):
function = self.parse_function("""
module os
os.access
path: path_t(allow_fd=1)
""")
p = function.parameters['path']
self.assertEqual(1, p.converter.args['allow_fd'])
def test_function_docstring(self):
function = self.parse_function("""
module os
os.stat as os_stat_fn
path: str
Path to be examined
Ensure that multiple lines are indented correctly.
Perform a stat system call on the given path.
Ensure that multiple lines are indented correctly.
Ensure that multiple lines are indented correctly.
""")
self.checkDocstring(function, """
stat($module, /, path)
--
Perform a stat system call on the given path.
path
Path to be examined
Ensure that multiple lines are indented correctly.
Ensure that multiple lines are indented correctly.
Ensure that multiple lines are indented correctly.
""")
def test_docstring_trailing_whitespace(self):
function = self.parse_function(
"module t\n"
"t.s\n"
" a: object\n"
" Param docstring with trailing whitespace \n"
"Func docstring summary with trailing whitespace \n"
" \n"
"Func docstring body with trailing whitespace \n"
)
self.checkDocstring(function, """
s($module, /, a)
--
Func docstring summary with trailing whitespace
a
Param docstring with trailing whitespace
Func docstring body with trailing whitespace
""")
def test_explicit_parameters_in_docstring(self):
function = self.parse_function(dedent("""
module foo
foo.bar
x: int
Documentation for x.
y: int
This is the documentation for foo.
Okay, we're done here.
"""))
self.checkDocstring(function, """
bar($module, /, x, y)
--
This is the documentation for foo.
x
Documentation for x.
Okay, we're done here.
""")
def test_docstring_with_comments(self):
function = self.parse_function(dedent("""
module foo
foo.bar
x: int
# We're about to have
# the documentation for x.
Documentation for x.
# We've just had
# the documentation for x.
y: int
# We're about to have
# the documentation for foo.
This is the documentation for foo.
# We've just had
# the documentation for foo.
Okay, we're done here.
"""))
self.checkDocstring(function, """
bar($module, /, x, y)
--
This is the documentation for foo.
x
Documentation for x.
Okay, we're done here.
""")
def test_parser_regression_special_character_in_parameter_column_of_docstring_first_line(self):
function = self.parse_function(dedent("""
module os
os.stat
path: str
This/used to break Clinic!
"""))
self.checkDocstring(function, """
stat($module, /, path)
--
This/used to break Clinic!
""")
def test_c_name(self):
function = self.parse_function("""
module os
os.stat as os_stat_fn
""")
self.assertEqual("os_stat_fn", function.c_basename)
def test_base_invalid_syntax(self):
block = """
module os
os.stat
invalid syntax: int = 42
"""
err = "Function 'stat' has an invalid parameter declaration: 'invalid syntax: int = 42'"
self.expect_failure(block, err, lineno=2)
def test_param_default_invalid_syntax(self):
block = """
module os
os.stat
x: int = invalid syntax
"""
err = "Function 'stat' has an invalid parameter declaration:"
self.expect_failure(block, err, lineno=2)
def test_cloning_nonexistent_function_correctly_fails(self):
block = """
cloned = fooooooooooooooooo
This is trying to clone a nonexistent function!!
"""
err = "Couldn't find existing function 'fooooooooooooooooo'!"
with support.captured_stderr() as stderr:
self.expect_failure(block, err, lineno=0)
expected_debug_print = dedent("""\
cls=None, module=<clinic.Clinic object>, existing='fooooooooooooooooo'
(cls or module).functions=[]
""")
stderr = stderr.getvalue()
self.assertIn(expected_debug_print, stderr)
def test_return_converter(self):
function = self.parse_function("""
module os
os.stat -> int
""")
self.assertIsInstance(function.return_converter, int_return_converter)
def test_return_converter_invalid_syntax(self):
block = """
module os
os.stat -> invalid syntax
"""
err = "Badly formed annotation for 'os.stat': 'invalid syntax'"
self.expect_failure(block, err)
def test_legacy_converter_disallowed_in_return_annotation(self):
block = """
module os
os.stat -> "s"
"""
err = "Legacy converter 's' not allowed as a return converter"
self.expect_failure(block, err)
def test_unknown_return_converter(self):
block = """
module os
os.stat -> fooooooooooooooooooooooo
"""
err = "No available return converter called 'fooooooooooooooooooooooo'"
self.expect_failure(block, err)
def test_star(self):
function = self.parse_function("""
module os
os.access
*
follow_symlinks: bool = True
""")
p = function.parameters['follow_symlinks']
self.assertEqual(inspect.Parameter.KEYWORD_ONLY, p.kind)
self.assertEqual(0, p.group)
def test_group(self):
function = self.parse_function("""
module window
window.border
[
ls: int
]
/
""")
p = function.parameters['ls']
self.assertEqual(1, p.group)
def test_left_group(self):
function = self.parse_function("""
module curses
curses.addch
[
y: int
Y-coordinate.
x: int
X-coordinate.
]
ch: char
Character to add.
[
attr: long
Attributes for the character.
]
/
""")
dataset = (
('y', -1), ('x', -1),
('ch', 0),
('attr', 1),
)
for name, group in dataset:
with self.subTest(name=name, group=group):
p = function.parameters[name]
self.assertEqual(p.group, group)
self.assertEqual(p.kind, inspect.Parameter.POSITIONAL_ONLY)
self.checkDocstring(function, """
addch([y, x,] ch, [attr])
y
Y-coordinate.
x
X-coordinate.
ch
Character to add.
attr
Attributes for the character.
""")
def test_nested_groups(self):
function = self.parse_function("""
module curses
curses.imaginary
[
[
y1: int
Y-coordinate.
y2: int
Y-coordinate.
]
x1: int
X-coordinate.
x2: int
X-coordinate.
]
ch: char
Character to add.
[
attr1: long
Attributes for the character.
attr2: long
Attributes for the character.
attr3: long
Attributes for the character.
[
attr4: long
Attributes for the character.
attr5: long
Attributes for the character.
attr6: long
Attributes for the character.
]
]
/
""")
dataset = (
('y1', -2), ('y2', -2),
('x1', -1), ('x2', -1),
('ch', 0),
('attr1', 1), ('attr2', 1), ('attr3', 1),
('attr4', 2), ('attr5', 2), ('attr6', 2),
)
for name, group in dataset:
with self.subTest(name=name, group=group):
p = function.parameters[name]
self.assertEqual(p.group, group)
self.assertEqual(p.kind, inspect.Parameter.POSITIONAL_ONLY)
self.checkDocstring(function, """
imaginary([[y1, y2,] x1, x2,] ch, [attr1, attr2, attr3, [attr4, attr5,
attr6]])
y1
Y-coordinate.
y2
Y-coordinate.
x1
X-coordinate.
x2
X-coordinate.
ch
Character to add.
attr1
Attributes for the character.
attr2
Attributes for the character.
attr3
Attributes for the character.
attr4
Attributes for the character.
attr5
Attributes for the character.
attr6
Attributes for the character.
""")
def test_two_top_groups_on_left(self):
function = self.parse_function("""
module curses
curses.chgat
[
y: int
Y-coordinate.
x: int
X-coordinate.
]
[
num: int
Number of characters.
]
attr: long
Attributes for the characters.
/
""")
dataset = (
('y', -1), ('x', -1),
('num', -2),
('attr', 0),
)
for name, group in dataset:
with self.subTest(name=name, group=group):
p = function.parameters[name]
self.assertEqual(p.group, group)
self.assertEqual(p.kind, inspect.Parameter.POSITIONAL_ONLY)
self.checkDocstring(function, """
chgat([y, x,] [num,] attr)
y
Y-coordinate.
x
X-coordinate.
num
Number of characters.
attr
Attributes for the characters.
""")
def test_two_top_groups_on_right(self):
function = self.parse_function("""
module foo
foo.two_top_groups_on_right
param: int
[
group1: int
]
[
group2: int
]
/
""")
dataset = (
('param', 0),
('group1', 1),
('group2', 2),
)
for name, group in dataset:
with self.subTest(name=name, group=group):
p = function.parameters[name]
self.assertEqual(p.group, group)
self.assertEqual(p.kind, inspect.Parameter.POSITIONAL_ONLY)
self.checkDocstring(function, """
two_top_groups_on_right(param, [group1,] [group2])
""")
def test_disallowed_grouping__parameter_after_group_on_right(self):
block = """
module foo
foo.parameter_after_group_on_right
param: int
[
[
group1 : int
]
group2 : int
]
"""
err = (
"Function parameter_after_group_on_right has an unsupported group "
"configuration. (Unexpected state 6.a)"
)
self.expect_failure(block, err)
def test_disallowed_grouping__group_after_parameter_on_left(self):
block = """
module foo
foo.group_after_parameter_on_left
[
group2 : int
[
group1 : int
]
]
param: int
"""
err = (
"Function 'group_after_parameter_on_left' has an unsupported group "
"configuration. (Unexpected state 2.b)"
)
self.expect_failure(block, err)
def test_disallowed_grouping__empty_group_on_left(self):
block = """
module foo
foo.empty_group
[
[
]
group2 : int
]
param: int
"""
err = (
"Function 'empty_group' has an empty group. "
"All groups must contain at least one parameter."
)
self.expect_failure(block, err)
def test_disallowed_grouping__empty_group_on_right(self):
block = """
module foo
foo.empty_group
param: int
[
[
]
group2 : int
]
"""
err = (
"Function 'empty_group' has an empty group. "
"All groups must contain at least one parameter."
)
self.expect_failure(block, err)
def test_disallowed_grouping__no_matching_bracket(self):
block = """
module foo
foo.empty_group
param: int
]
group2: int
]
"""
err = "Function 'empty_group' has a ']' without a matching '['"
self.expect_failure(block, err)
def test_disallowed_grouping__varpos(self):
err = "cannot use optional groups with a var-positional parameter"
block = """
module foo
foo.bar
[
a: int
]
*args: tuple
"""
self.expect_failure(block, err, lineno=5)
block = """
module foo
foo.bar
a: int
*args: tuple
[
b: int
]
"""
self.expect_failure(block, err, lineno=4)
def test_disallowed_grouping__parameter_after_group(self):
# Only positional-only parameters can follow an optional group.
group_err = ("You cannot use optional groups ('[' and ']') unless all "
"parameters are positional-only ('/')")
kwds_err = ("cannot use a var-keyword parameter with pos-or-keyword "
"or keyword-only parameters")
dataset = (("""
module foo
foo.bar
[
a: int
b: int
]
y: int
""", group_err), ("""
module foo
foo.bar
[
a: int
b: int
]
*
y: int
""", group_err), ("""
module foo
foo.bar
[
a: int
b: int
]
**kwds: dict
""", kwds_err))
for block, err in dataset:
with self.subTest(block=block):
self.expect_failure(block, err)
def test_disallowed_grouping__must_be_position_only(self):
dataset = ("""
with_kwds
[
*
a: object
]
""", """
with_kwds
[
a: object
]
""")
err = (
"You cannot use optional groups ('[' and ']') unless all "
"parameters are positional-only ('/')"
)
for block in dataset:
with self.subTest(block=block):
self.expect_failure(block, err)
def test_no_parameters(self):
function = self.parse_function("""
module foo
foo.bar
Docstring
""")
self.assertEqual("bar($module, /)\n--\n\nDocstring", function.docstring)
self.assertEqual(1, len(function.parameters)) # self!
def test_init_with_no_parameters(self):
function = self.parse_function("""
module foo
class foo.Bar "unused" "notneeded"
foo.Bar.__init__
Docstring
""", signatures_in_block=3, function_index=2)
# self is not in the signature
self.assertEqual("Bar()\n--\n\nDocstring", function.docstring)
# but it *is* a parameter
self.assertEqual(1, len(function.parameters))
def test_illegal_module_line(self):
block = """
module foo
foo.bar => int
/
"""
err = "Illegal function name: 'foo.bar => int'"
self.expect_failure(block, err)
def test_illegal_c_basename(self):
block = """
module foo
foo.bar as 935
/
"""
err = "Illegal C basename: '935'"
self.expect_failure(block, err)
def test_no_c_basename(self):
block = "foo as "
err = "No C basename provided after 'as' keyword"
self.expect_failure(block, err, strip=False)
def test_single_star(self):
block = """
module foo
foo.bar
*
*
"""
err = "Function 'bar' uses '*' more than once."
self.expect_failure(block, err)
def test_parameters_required_after_star(self):
dataset = (
"module foo\nfoo.bar\n *",
"module foo\nfoo.bar\n *\nDocstring here.",
"module foo\nfoo.bar\n this: int\n *",
"module foo\nfoo.bar\n this: int\n *\nDocstring.",
)
err = "Function 'bar' specifies '*' without following parameters."
for block in dataset:
with self.subTest(block=block):
self.expect_failure(block, err)
def test_fulldisplayname_class(self):
dataset = (
("T", """
class T "void *" ""
T.__init__
"""),
("m.T", """
module m
class m.T "void *" ""
@classmethod
m.T.__new__
"""),
("m.T.C", """
module m
class m.T "void *" ""
class m.T.C "void *" ""
m.T.C.__init__
"""),
)
for name, code in dataset:
with self.subTest(name=name, code=code):
block = self.parse(code)
func = block.signatures[-1]
self.assertEqual(func.fulldisplayname, name)
def test_fulldisplayname_meth(self):
dataset = (
("func", "func"),
("m.func", """
module m
m.func
"""),
("T.meth", """
class T "void *" ""
T.meth
"""),
("m.T.meth", """
module m
class m.T "void *" ""
m.T.meth
"""),
("m.T.C.meth", """
module m
class m.T "void *" ""
class m.T.C "void *" ""
m.T.C.meth
"""),
)
for name, code in dataset:
with self.subTest(name=name, code=code):
block = self.parse(code)
func = block.signatures[-1]
self.assertEqual(func.fulldisplayname, name)
def test_depr_star_invalid_format_1(self):
block = """
module foo
foo.bar
this: int
* [from 3]
Docstring.
"""
err = (
"Function 'bar': expected format '[from major.minor]' "
"where 'major' and 'minor' are integers; got '3'"
)
self.expect_failure(block, err, lineno=3)
def test_depr_star_invalid_format_2(self):
block = """
module foo
foo.bar
this: int
* [from a.b]
Docstring.
"""
err = (
"Function 'bar': expected format '[from major.minor]' "
"where 'major' and 'minor' are integers; got 'a.b'"
)
self.expect_failure(block, err, lineno=3)
def test_depr_star_invalid_format_3(self):
block = """
module foo
foo.bar
this: int
* [from 1.2.3]
Docstring.
"""
err = (
"Function 'bar': expected format '[from major.minor]' "
"where 'major' and 'minor' are integers; got '1.2.3'"
)
self.expect_failure(block, err, lineno=3)
def test_parameters_required_after_depr_star(self):
block = """
module foo
foo.bar
this: int
* [from 3.14]
Docstring.
"""
err = (
"Function 'bar' specifies '* [from ...]' without "
"following parameters."
)
self.expect_failure(block, err, lineno=4)
def test_parameters_required_after_depr_star2(self):
block = """
module foo
foo.bar
a: int
* [from 3.14]
*
b: int
Docstring.
"""
err = (
"Function 'bar' specifies '* [from ...]' without "
"following parameters."
)
self.expect_failure(block, err, lineno=4)
def test_parameters_required_after_depr_star3(self):
block = """
module foo
foo.bar
a: int
* [from 3.14]
*args: tuple
b: int
Docstring.
"""
err = (
"Function 'bar' specifies '* [from ...]' without "
"following parameters."
)
self.expect_failure(block, err, lineno=4)
def test_depr_star_must_come_before_star(self):
block = """
module foo
foo.bar
a: int
*
* [from 3.14]
b: int
Docstring.
"""
err = "Function 'bar': '* [from ...]' must precede '*'"
self.expect_failure(block, err, lineno=4)
def test_depr_star_must_come_before_vararg(self):
block = """
module foo
foo.bar
a: int
*args: tuple
* [from 3.14]
b: int
Docstring.
"""
err = "Function 'bar': '* [from ...]' must precede '*'"
self.expect_failure(block, err, lineno=4)
def test_depr_star_duplicate(self):
block = """
module foo
foo.bar
a: int
* [from 3.14]
b: int
* [from 3.14]
c: int
Docstring.
"""
err = "Function 'bar' uses '* [from 3.14]' more than once."
self.expect_failure(block, err, lineno=5)
def test_depr_star_duplicate2(self):
block = """
module foo
foo.bar
a: int
* [from 3.14]
b: int
* [from 3.15]
c: int
Docstring.
"""
err = "Function 'bar': '* [from 3.15]' must precede '* [from 3.14]'"
self.expect_failure(block, err, lineno=5)
def test_depr_slash_duplicate(self):
block = """
module foo
foo.bar
a: int
/ [from 3.14]
b: int
/ [from 3.14]
c: int
Docstring.
"""
err = "Function 'bar' uses '/ [from 3.14]' more than once."
self.expect_failure(block, err, lineno=5)
def test_depr_slash_duplicate2(self):
block = """
module foo
foo.bar
a: int
/ [from 3.15]
b: int
/ [from 3.14]
c: int
Docstring.
"""
err = "Function 'bar': '/ [from 3.14]' must precede '/ [from 3.15]'"
self.expect_failure(block, err, lineno=5)
def test_alias(self):
function = self.parse_function("""
module foo
foo.bar
a: int
*
b as a: int = 0
Docstring.
""")
_, a, b = function.parameters.values()
self.assertIsNone(a.converter.alias_of)
self.assertIs(b.converter.alias_of, a)
self.assertEqual(function.docstring.splitlines()[0],
"bar($module, /, a)")
def test_alias_must_be_keyword_only(self):
block = """
module foo
foo.bar
a: int
b as a: int = 0
Docstring.
"""
err = "Alias 'b' of the parameter 'a' must be keyword-only."
self.expect_failure(block, err, lineno=3)
def test_alias_must_have_default(self):
block = """
module foo
foo.bar
a: int
*
b as a: int
Docstring.
"""
err = "Alias 'b' of the parameter 'a' must have a default value."
self.expect_failure(block, err, lineno=4)
def test_alias_deprecated(self):
function = self.parse_function("""
module foo
foo.bar
a: int
*
[until 3.14] b as a: int = 0
Docstring.
""")
_, a, b = function.parameters.values()
self.assertIsNone(a.deprecated_until)
self.assertEqual(b.deprecated_until, (3, 14))
def test_deprecated_last_positional_only_parameters(self):
function = self.parse_function("""
module foo
foo.bar
a: int = 0
[until 3.14] b: int = 0
[until 3.14] c: int = 0
/
d: int = 0
Docstring.
""")
_, a, b, c, d = function.parameters.values()
self.assertIsNone(a.deprecated_until)
self.assertEqual(b.deprecated_until, (3, 14))
self.assertEqual(c.deprecated_until, (3, 14))
self.assertIsNone(d.deprecated_until)
def test_deprecated_non_last_positional_only_parameter(self):
block = """
module foo
foo.bar
[until 3.14] a: int = 0
b: int = 0
/
Docstring.
"""
err = ("Parameter 'b' cannot follow the deprecated parameter 'a': "
"only the last positional-only parameters can be deprecated.")
self.expect_failure(block, err, lineno=4)
def test_deprecated_non_positional_only_parameters(self):
# The following parameters can still be passed by keyword.
function = self.parse_function("""
module foo
foo.bar
[until 3.14] a: int = 0
b: int = 0
*
[until 3.14] c: int = 0
d: int = 0
Docstring.
""")
_, a, b, c, d = function.parameters.values()
self.assertEqual(a.deprecated_until, (3, 14))
self.assertIsNone(b.deprecated_until)
self.assertEqual(c.deprecated_until, (3, 14))
self.assertIsNone(d.deprecated_until)
def test_deprecated_parameter_without_default(self):
block = """
module foo
foo.bar
[until 3.14] a: int
Docstring.
"""
err = "Deprecated parameter 'a' must have a default value."
self.expect_failure(block, err, lineno=2)
def test_deprecated_invalid_format(self):
block = """
module foo
foo.bar
[until 3] a: int = 0
Docstring.
"""
err = (
"Function 'bar': expected format '[until major.minor]' "
"where 'major' and 'minor' are integers; got '3'"
)
self.expect_failure(block, err, lineno=2)
def test_single_slash(self):
block = """
module foo
foo.bar
/
/
"""
err = (
"Function 'bar' has an unsupported group configuration. "
"(Unexpected state 0.d)"
)
self.expect_failure(block, err)
def test_parameters_required_before_depr_slash(self):
block = """
module foo
foo.bar
/ [from 3.14]
Docstring.
"""
err = (
"Function 'bar' specifies '/ [from ...]' without "
"preceding parameters."
)
self.expect_failure(block, err, lineno=2)
def test_parameters_required_before_depr_slash2(self):
block = """
module foo
foo.bar
a: int
/
/ [from 3.14]
Docstring.
"""
err = (
"Function 'bar' specifies '/ [from ...]' without "
"preceding parameters."
)
self.expect_failure(block, err, lineno=4)
def test_double_slash(self):
block = """
module foo
foo.bar
a: int
/
b: int
/
"""
err = "Function 'bar' uses '/' more than once."
self.expect_failure(block, err)
def test_slash_after_star(self):
block = """
module foo
foo.bar
x: int
y: int
*
z: int
/
"""
err = "Function 'bar': '/' must precede '*'"
self.expect_failure(block, err)
def test_slash_after_vararg(self):
block = """
module foo
foo.bar
x: int
y: int
*args: tuple
z: int
/
"""
err = "Function 'bar': '/' must precede '*'"
self.expect_failure(block, err)
def test_slash_after_var_keyword(self):
block = """
module foo
foo.bar
**kwds: dict
/
"""
err = "parameters cannot follow var-keyword parameter: '/'"
self.expect_failure(block, err)
def test_star_after_var_keyword(self):
block = """
module foo
foo.bar
**kwds: dict
*
"""
err = "parameters cannot follow var-keyword parameter: '*'"
self.expect_failure(block, err)
def test_parameter_after_var_keyword(self):
block = """
module foo
foo.bar
**kwds: dict
z: int
"""
err = "parameters cannot follow var-keyword parameter: 'z: int'"
self.expect_failure(block, err)
def test_group_with_var_keyword(self):
block = """
with_kwds
[
**kwds: dict
]
"""
err = "A var-keyword parameter cannot be in an optional group."
self.expect_failure(block, err)
def test_group_with_var_positional(self):
block = """
with_varpos
[
*args: tuple
]
"""
err = "A var-positional parameter cannot be in an optional group."
self.expect_failure(block, err)
def test_depr_star_must_come_after_slash(self):
block = """
module foo
foo.bar
a: int
* [from 3.14]
/
b: int
Docstring.
"""
err = "Function 'bar': '/' must precede '* [from ...]'"
self.expect_failure(block, err, lineno=4)
def test_depr_star_must_come_after_depr_slash(self):
block = """
module foo
foo.bar
a: int
* [from 3.14]
/ [from 3.14]
b: int
Docstring.
"""
err = "Function 'bar': '/ [from ...]' must precede '* [from ...]'"
self.expect_failure(block, err, lineno=4)
def test_star_must_come_after_depr_slash(self):
block = """
module foo
foo.bar
a: int
*
/ [from 3.14]
b: int
Docstring.
"""
err = "Function 'bar': '/ [from ...]' must precede '*'"
self.expect_failure(block, err, lineno=4)
def test_vararg_must_come_after_depr_slash(self):
block = """
module foo
foo.bar
a: int
*args: tuple
/ [from 3.14]
b: int
Docstring.
"""
err = "Function 'bar': '/ [from ...]' must precede '*'"
self.expect_failure(block, err, lineno=4)
def test_depr_slash_must_come_after_slash(self):
block = """
module foo
foo.bar
a: int
/ [from 3.14]
/
b: int
Docstring.
"""
err = "Function 'bar': '/' must precede '/ [from ...]'"
self.expect_failure(block, err, lineno=4)
def test_parameters_not_permitted_after_slash_for_now(self):
block = """
module foo
foo.bar
/
x: int
"""
err = (
"Function 'bar' has an unsupported group configuration. "
"(Unexpected state 0.d)"
)
self.expect_failure(block, err)
def test_parameters_no_more_than_one_vararg(self):
err = "Function 'bar' uses '*' more than once."
block = """
module foo
foo.bar
*vararg1: tuple
*vararg2: tuple
"""
self.expect_failure(block, err, lineno=3)
def test_parameters_no_more_than_one_var_keyword(self):
err = "parameters cannot follow var-keyword parameter: '**var_keyword_2: dict'"
block = """
module foo
foo.bar
**var_keyword_1: dict
**var_keyword_2: dict
"""
self.expect_failure(block, err, lineno=3)
def test_function_not_at_column_0(self):
function = self.parse_function("""
module foo
foo.bar
x: int
Nested docstring here, goeth.
*
y: str
Not at column 0!
""")
self.checkDocstring(function, """
bar($module, /, x, *, y)
--
Not at column 0!
x
Nested docstring here, goeth.
""")
def test_docstring_only_summary(self):
function = self.parse_function("""
module m
m.f
summary
""")
self.checkDocstring(function, """
f($module, /)
--
summary
""")
def test_docstring_empty_lines(self):
function = self.parse_function("""
module m
m.f
""")
self.checkDocstring(function, """
f($module, /)
--
""")
def test_docstring_explicit_params_placement(self):
function = self.parse_function("""
module m
m.f
a: int
Param docstring for 'a' will be included
b: int
c: int
Param docstring for 'c' will be included
This is the summary line.
We'll now place the params section here:
{parameters}
And now for something completely different!
(Note the added newline)
""")
self.checkDocstring(function, """
f($module, /, a, b, c)
--
This is the summary line.
We'll now place the params section here:
a
Param docstring for 'a' will be included
c
Param docstring for 'c' will be included
And now for something completely different!
(Note the added newline)
""")
def test_indent_stack_no_tabs(self):
block = """
module foo
foo.bar
*vararg1: tuple
\t*vararg2: tuple
"""
err = ("Tab characters are illegal in the Clinic DSL: "
r"'\t*vararg2: tuple'")
self.expect_failure(block, err)
def test_indent_stack_illegal_outdent(self):
block = """
module foo
foo.bar
a: object
b: object
"""
err = "Illegal outdent"
self.expect_failure(block, err)
def test_directive(self):
parser = DSLParser(_make_clinic())
parser.flag = False
parser.directives['setflag'] = lambda : setattr(parser, 'flag', True)
block = Block("setflag")
parser.parse(block)
self.assertTrue(parser.flag)
def test_legacy_converters(self):
block = self.parse('module os\nos.access\n path: "s"')
module, function = block.signatures
conv = (function.parameters['path']).converter
self.assertIsInstance(conv, str_converter)
def test_legacy_converters_non_string_constant_annotation(self):
err = "Annotations must be either a name, a function call, or a string"
dataset = (
'module os\nos.access\n path: 42',
'module os\nos.access\n path: 42.42',
'module os\nos.access\n path: 42j',
'module os\nos.access\n path: b"42"',
)
for block in dataset:
with self.subTest(block=block):
self.expect_failure(block, err, lineno=2)
def test_other_bizarre_things_in_annotations_fail(self):
err = "Annotations must be either a name, a function call, or a string"
dataset = (
'module os\nos.access\n path: {"some": "dictionary"}',
'module os\nos.access\n path: ["list", "of", "strings"]',
'module os\nos.access\n path: (x for x in range(42))',
)
for block in dataset:
with self.subTest(block=block):
self.expect_failure(block, err, lineno=2)
def test_kwarg_splats_disallowed_in_function_call_annotations(self):
err = "Cannot use a kwarg splat in a function-call annotation"
dataset = (
'module fo\nfo.barbaz\n o: bool(**{None: "bang!"})',
'module fo\nfo.barbaz -> bool(**{None: "bang!"})',
'module fo\nfo.barbaz -> bool(**{"bang": 42})',
'module fo\nfo.barbaz\n o: bool(**{"bang": None})',
)
for block in dataset:
with self.subTest(block=block):
self.expect_failure(block, err)
def test_self_param_placement(self):
err = (
"A 'self' parameter, if specified, must be the very first thing "
"in the parameter block."
)
block = """
module foo
foo.func
a: int
self: self(type="PyObject *")
"""
self.expect_failure(block, err, lineno=3)
def test_self_param_cannot_be_optional(self):
err = "A 'self' parameter cannot be marked optional."
block = """
module foo
foo.func
self: self(type="PyObject *") = None
"""
self.expect_failure(block, err, lineno=2)
def test_defining_class_param_placement(self):
err = (
"A 'defining_class' parameter, if specified, must either be the "
"first thing in the parameter block, or come just after 'self'."
)
block = """
module foo
foo.func
self: self(type="PyObject *")
a: int
cls: defining_class
"""
self.expect_failure(block, err, lineno=4)
def test_defining_class_param_cannot_be_optional(self):
err = "A 'defining_class' parameter cannot be marked optional."
block = """
module foo
foo.func
cls: defining_class(type="PyObject *") = None
"""
self.expect_failure(block, err, lineno=2)
def test_slot_methods_cannot_access_defining_class(self):
block = """
module foo
class Foo "" ""
Foo.__init__
cls: defining_class
a: object
"""
err = "Slot methods cannot access their defining class."
with self.assertRaisesRegex(ValueError, err):
self.parse_function(block)
def test_new_must_be_a_class_method(self):
err = "'__new__' must be a class method!"
block = """
module foo
class Foo "" ""
Foo.__new__
"""
self.expect_failure(block, err, lineno=2)
def test_init_must_be_a_normal_method(self):
err_template = "'__init__' must be a normal method; got 'FunctionKind.{}'!"
annotations = {
"@classmethod": "CLASS_METHOD",
"@staticmethod": "STATIC_METHOD",
"@getter": "GETTER",
}
for annotation, invalid_kind in annotations.items():
with self.subTest(annotation=annotation, invalid_kind=invalid_kind):
block = f"""
module foo
class Foo "" ""
{annotation}
Foo.__init__
"""
expected_error = err_template.format(invalid_kind)
self.expect_failure(block, expected_error, lineno=3)
def test_init_cannot_define_a_return_type(self):
block = """
class Foo "" ""
Foo.__init__ -> long
"""
expected_error = "__init__ methods cannot define a return type"
self.expect_failure(block, expected_error, lineno=1)
def test_invalid_getset(self):
block = """
module foo
class Foo "" ""
@setter
Foo.property -> int
"""
expected_error = "@setter methods cannot define a return type"
self.expect_failure(block, expected_error, lineno=3)
block = """
module foo
class Foo "" ""
@getter
Foo.property
obj: int
/
"""
expected_error = "@getter methods cannot define parameters"
self.expect_failure(block, expected_error)
block = """
module foo
class Foo "" ""
@setter
Foo.property
obj: int
value: int
/
"""
expected_error = "@setter methods must define exactly one parameter"
self.expect_failure(block, expected_error)
def test_setter_value_default(self):
block = """
module m
class Foo "" ""
@setter
Foo.property
value: object = None
"""
expected_error = "the value of @setter cannot have a default value"
self.expect_failure(block, expected_error)
block = """
module m
class Foo "" ""
@setter
@deleter
Foo.property
value: object
"""
expected_error = ("the value of @setter with @deleter must have "
"a default value, used to delete the attribute")
self.expect_failure(block, expected_error)
block = """
module m
class Foo "" ""
@setter
@deleter
Foo.property
value: object = None
"""
expected_error = ("the value of @setter with @deleter can only have "
"NULL as a default value")
self.expect_failure(block, expected_error)
def test_setter_value_kind(self):
expected_error = "the value of @setter must be a positional parameter"
block = """
module m
class Foo "" ""
@setter
Foo.property
*
value: object
"""
self.expect_failure(block, expected_error)
for parameter in "*args: tuple", "**kwargs: dict":
with self.subTest(parameter=parameter):
block = f"""
module m
class Foo "" ""
@setter
Foo.property
{parameter}
"""
self.expect_failure(block, expected_error)
def test_setter_implicit_parameter(self):
function = self.parse_function("""
module foo
class Foo "" ""
@setter
Foo.property
""", signatures_in_block=3, function_index=2)
self.assertEqual(function.kind, FunctionKind.SETTER)
value = function.parameters['value']
self.assertIsInstance(value.converter, object_converter)
self.assertIs(value.default, unspecified)
def test_setter_and_deleter_implicit_parameter(self):
function = self.parse_function("""
module foo
class Foo "" ""
@setter
@deleter
Foo.property
""", signatures_in_block=3, function_index=2)
self.assertEqual(function.kind, FunctionKind.SETTER_AND_DELETER)
value = function.parameters['value']
self.assertIsInstance(value.converter, object_converter)
self.assertIs(value.default, NULL)
def test_getter_return_converter(self):
function = self.parse_function("""
module foo
class Foo "" ""
@getter
Foo.property -> int
""", signatures_in_block=3, function_index=2)
self.assertEqual(function.return_converter.type, "int")
def test_setter_docstring(self):
block = """
module foo
class Foo "" ""
@setter
Foo.property
foo
bar
[clinic start generated code]*/
"""
expected_error = "docstrings are only supported for @getter"
self.expect_failure(block, expected_error)
def test_duplicate_getset(self):
annotations = ["@getter", "@setter"]
for annotation in annotations:
with self.subTest(annotation=annotation):
block = f"""
module foo
class Foo "" ""
{annotation}
{annotation}
Foo.property -> int
"""
expected_error = f"Cannot apply {annotation} twice to the same function!"
self.expect_failure(block, expected_error, lineno=3)
def test_getter_and_setter_disallowed_on_same_function(self):
dup_annotations = [("@getter", "@setter"), ("@setter", "@getter")]
for dup in dup_annotations:
with self.subTest(dup=dup):
block = f"""
module foo
class Foo "" ""
{dup[0]}
{dup[1]}
Foo.property -> int
"""
expected_error = (f"Can't set {dup[1]}, function is not "
f"a normal callable")
self.expect_failure(block, expected_error, lineno=3)
def test_deleter_without_setter(self):
block = """
module foo
class Foo "" ""
@deleter
Foo.property
"""
expected_error = "Can't set @deleter, @setter is not applied"
self.expect_failure(block, expected_error, lineno=2)
block = """
module foo
class Foo "" ""
@deleter
@setter
Foo.property
"""
self.expect_failure(block, expected_error, lineno=2)
def test_deleter_twice(self):
block = """
module foo
class Foo "" ""
@setter
@deleter
@deleter
Foo.property
"""
expected_error = "Cannot apply @deleter twice to the same function!"
self.expect_failure(block, expected_error, lineno=4)
def test_getset_no_class(self):
for annotation in "@getter", "@setter":
with self.subTest(annotation=annotation):
block = f"""
module m
{annotation}
m.func
"""
expected_error = "@getter and @setter must be methods"
self.expect_failure(block, expected_error, lineno=2)
def test_duplicate_coexist(self):
err = "Called @coexist twice"
block = """
module m
@coexist
@coexist
m.fn
"""
self.expect_failure(block, err, lineno=2)
def test_duplicate_vectorcall(self):
err = "Called @vectorcall twice"
block = """
module m
class Foo "FooObject *" ""
@vectorcall
@vectorcall
Foo.__init__
"""
self.expect_failure(block, err, lineno=3)
def test_vectorcall_on_regular_method(self):
err = "@vectorcall can only be used with __init__ and __new__ methods"
block = """
module m
class Foo "FooObject *" ""
@vectorcall
Foo.some_method
"""
self.expect_failure(block, err, lineno=3)
def test_vectorcall_on_module_function(self):
err = "@vectorcall can only be used with __init__ and __new__ methods"
block = """
module m
@vectorcall
m.fn
"""
self.expect_failure(block, err, lineno=2)
def test_vectorcall_on_init(self):
block = """
module m
class Foo "FooObject *" "Foo_Type"
@vectorcall
Foo.__init__
iterable: object = NULL
/
"""
func = self.parse_function(block, signatures_in_block=3,
function_index=2)
self.assertTrue(func.vectorcall)
def test_vectorcall_on_new(self):
block = """
module m
class Foo "FooObject *" "Foo_Type"
@classmethod
@vectorcall
Foo.__new__
x: object = NULL
/
"""
func = self.parse_function(block, signatures_in_block=3,
function_index=2)
self.assertTrue(func.vectorcall)
def test_vectorcall_takes_no_arguments(self):
err = "at_vectorcall() takes 1 positional argument but 2 were given"
block = """
module m
class Foo "FooObject *" "Foo_Type"
@vectorcall bogus=True
Foo.__init__
"""
self.expect_failure(block, err, lineno=2)
def test_vectorcall_without_type_object(self):
err = "@vectorcall requires the type object of 'Foo'"
block = """
module m
class Foo "FooObject *" ""
@vectorcall
Foo.__init__
"""
self.expect_failure(block, err, lineno=3)
def test_vectorcall_unsupported_converter(self):
# str(encoding=...) has no parse_arg() implementation.
err = ("@vectorcall requires all converters to support "
"parse_arg(); parameter 's' does not")
block = """
module m
class Foo "FooObject *" "Foo_Type"
@classmethod
@vectorcall
Foo.__new__
s: str(encoding="utf-8")
/
"""
self.expect_failure(block, err, lineno=6)
def test_vectorcall_with_option_groups(self):
err = "@vectorcall does not support optional groups"
block = """
module m
class Foo "FooObject *" "Foo_Type"
@vectorcall
Foo.__init__
[
a: object
]
/
"""
self.expect_failure(block, err, lineno=7)
def test_unused_param(self):
block = self.parse("""
module foo
foo.func
fn: object
k: float
i: float(unused=True)
/
*
flag: bool(unused=True) = False
""")
sig = block.signatures[1] # Function index == 1
params = sig.parameters
conv = lambda fn: params[fn].converter
dataset = (
{"name": "fn", "unused": False},
{"name": "k", "unused": False},
{"name": "i", "unused": True},
{"name": "flag", "unused": True},
)
for param in dataset:
name, unused = param.values()
with self.subTest(name=name, unused=unused):
p = conv(name)
# Verify that the unused flag is parsed correctly.
self.assertEqual(unused, p.unused)
# Now, check that we'll produce correct code.
decl = p.simple_declaration(in_parser=False)
if unused:
self.assertIn("Py_UNUSED", decl)
else:
self.assertNotIn("Py_UNUSED", decl)
# Make sure the Py_UNUSED macro is not used in the parser body.
parser_decl = p.simple_declaration(in_parser=True)
self.assertNotIn("Py_UNUSED", parser_decl)
def test_scaffolding(self):
# test repr on special values
self.assertEqual(repr(unspecified), '<Unspecified>')
self.assertEqual(repr(NULL), '<Null>')
# test that fail fails
with support.captured_stdout() as stdout:
errmsg = 'The igloos are melting'
with self.assertRaisesRegex(ClinicError, errmsg) as cm:
fail(errmsg, filename='clown.txt', line_number=69)
exc = cm.exception
self.assertEqual(exc.filename, 'clown.txt')
self.assertEqual(exc.lineno, 69)
self.assertEqual(stdout.getvalue(), "")
def test_non_ascii_character_in_docstring(self):
block = """
module test
test.fn
a: int
á param docstring
docstring fü bár baß
"""
with support.captured_stdout() as stdout:
self.parse(block)
# The line numbers are off; this is a known limitation.
expected = dedent("""\
Warning:
Non-ascii characters are not allowed in docstrings: 'á'
Warning:
Non-ascii characters are not allowed in docstrings: 'ü', 'á', 'ß'
""")
self.assertEqual(stdout.getvalue(), expected)
def test_illegal_c_identifier(self):
err = "Illegal C identifier: 17a"
block = """
module test
test.fn
a as 17a: int
"""
self.expect_failure(block, err, lineno=2)
def test_cannot_convert_special_method(self):
err = "'__len__' is a special method and cannot be converted"
block = """
class T "" ""
T.__len__
"""
self.expect_failure(block, err, lineno=1)
def test_cannot_specify_pydefault_without_default(self):
err = "You can't specify py_default without specifying a default value!"
block = """
fn
a: object(py_default='NULL')
"""
self.expect_failure(block, err, lineno=1)
def test_vararg_cannot_take_default_value(self):
err = "Function 'fn' has an invalid parameter declaration:"
block = """
fn
*args: tuple = None
"""
self.expect_failure(block, err, lineno=1)
def test_var_keyword_cannot_take_default_value(self):
err = "Function 'fn' has an invalid parameter declaration:"
block = """
fn
**kwds: dict = None
"""
self.expect_failure(block, err, lineno=1)
def test_default_is_not_of_correct_type(self):
err = ("int_converter: default value 2.5 for field 'a' "
"is not of type 'int'")
block = """
fn
a: int = 2.5
"""
self.expect_failure(block, err, lineno=1)
def test_invalid_legacy_converter(self):
err = "'fhi' is not a valid legacy converter"
block = """
fn
a: 'fhi'
"""
self.expect_failure(block, err, lineno=1)
def test_parent_class_or_module_does_not_exist(self):
err = "Parent class or module 'baz' does not exist"
block = """
module m
baz.func
"""
self.expect_failure(block, err, lineno=1)
def test_duplicate_param_name(self):
err = "You can't have two parameters named 'a'"
block = """
module m
m.func
a: int
a: float
"""
self.expect_failure(block, err, lineno=3)
def test_param_requires_custom_c_name(self):
err = "Parameter 'module' requires a custom C name"
block = """
module m
m.func
module: int
"""
self.expect_failure(block, err, lineno=2)
def test_state_func_docstring_assert_no_group(self):
err = "Function 'func' has a ']' without a matching '['"
block = """
module m
m.func
]
docstring
"""
self.expect_failure(block, err, lineno=2)
def test_state_func_docstring_no_summary(self):
err = "Docstring for 'm.func' does not have a summary line!"
block = """
module m
m.func
docstring1
docstring2
docstring3
"""
# The line which should have been left blank.
self.expect_failure(block, err, lineno=3)
def test_state_func_docstring_long_summary(self):
err = "Summary line for 'm.func' is too long!"
block = f"""
module m
m.func
{'x' * 100}
Body.
"""
self.expect_failure(block, err, lineno=2)
def test_state_func_docstring_only_one_param_template(self):
err = "You may not specify {parameters} more than once in a docstring!"
block = """
module m
m.func
docstring summary
these are the params:
{parameters}
these are the params again:
{parameters}
and this is the end of the docstring
"""
self.expect_failure(block, err, lineno=7)
def test_kind_defining_class(self):
function = self.parse_function("""
module m
class m.C "PyObject *" ""
m.C.meth
cls: defining_class
""", signatures_in_block=3, function_index=2)
p = function.parameters['cls']
self.assertEqual(p.kind, inspect.Parameter.POSITIONAL_ONLY)
def test_disallow_defining_class_at_module_level(self):
err = "A 'defining_class' parameter cannot be defined at module level."
block = """
module m
m.func
cls: defining_class
"""
self.expect_failure(block, err, lineno=2)
def test_var_keyword_with_pos_or_kw(self):
block = """
module foo
foo.bar
x: int
**kwds: dict
"""
err = ("Function 'bar' cannot use a var-keyword parameter with "
"pos-or-keyword or keyword-only parameters.")
self.expect_failure(block, err)
def test_var_keyword_with_kw_only(self):
block = """
module foo
foo.bar
x: int
/
*
y: int
**kwds: dict
"""
err = ("Function 'bar' cannot use a var-keyword parameter with "
"pos-or-keyword or keyword-only parameters.")
self.expect_failure(block, err)
def test_var_keyword_with_pos_or_kw_and_kw_only(self):
block = """
module foo
foo.bar
x: int
/
y: int
*
z: int
**kwds: dict
"""
err = ("Function 'bar' cannot use a var-keyword parameter with "
"pos-or-keyword or keyword-only parameters.")
self.expect_failure(block, err)
def test_allow_negative_accepted_by_py_ssize_t_converter_only(self):
errmsg = re.escape("converter_init() got an unexpected keyword argument 'allow_negative'")
unsupported_converters = [converter_name for converter_name in converters.keys()
if converter_name != "Py_ssize_t"]
for converter in unsupported_converters:
with self.subTest(converter=converter):
block = f"""
module m
m.func
a: {converter}(allow_negative=True)
"""
with self.assertRaisesRegex((AssertionError, TypeError), errmsg):
self.parse_function(block)
@force_not_colorized_test_class
class ClinicExternalTest(TestCase):
maxDiff = None
def setUp(self):
save_restore_converters(self)
def run_clinic(self, *args):
with (
support.captured_stdout() as out,
support.captured_stderr() as err,
self.assertRaises(SystemExit) as cm
):
clinic.main(args)
return out.getvalue(), err.getvalue(), cm.exception.code
def expect_success(self, *args):
out, err, code = self.run_clinic(*args)
if code != 0:
self.fail("\n".join([f"Unexpected failure: {args=}", out, err]))
self.assertEqual(err, "")
return out
def expect_failure(self, *args):
out, err, code = self.run_clinic(*args)
self.assertNotEqual(code, 0, f"Unexpected success: {args=}")
return out, err
def test_external(self):
CLINIC_TEST = 'clinic.test.c'
source = support.findfile(CLINIC_TEST)
with open(source, encoding='utf-8') as f:
orig_contents = f.read()
# Run clinic CLI and verify that it does not complain.
self.addCleanup(unlink, TESTFN)
out = self.expect_success("-f", "-o", TESTFN, source)
self.assertEqual(out, "")
with open(TESTFN, encoding='utf-8') as f:
new_contents = f.read()
self.assertEqual(new_contents, orig_contents)
def test_no_change(self):
# bpo-42398: Test that the destination file is left unchanged if the
# content does not change. Moreover, check also that the file
# modification time does not change in this case.
code = dedent("""
/*[clinic input]
[clinic start generated code]*/
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=da39a3ee5e6b4b0d]*/
""")
with os_helper.temp_dir() as tmp_dir:
fn = os.path.join(tmp_dir, "test.c")
with open(fn, "w", encoding="utf-8") as f:
f.write(code)
pre_mtime = os.stat(fn).st_mtime_ns
self.expect_success(fn)
post_mtime = os.stat(fn).st_mtime_ns
# Don't change the file modification time
# if the content does not change
self.assertEqual(pre_mtime, post_mtime)
TOUCH_CODE = dedent("""
/*[clinic input]
module m
[clinic start generated code]*/
/*[clinic input]
output everything file
m.func
a: int
/
Docstring.
[clinic start generated code]*/
""")
def test_touch_source(self):
# gh-64595: The build system does not know that the source file
# depends on the file generated from it, so the modification
# times are updated to force the recompilation.
def mtimes():
return os.stat(fn).st_mtime_ns, os.stat(dest).st_mtime_ns
def set_mtimes(source, generated):
os.utime(fn, ns=(source, source))
os.utime(dest, ns=(generated, generated))
with os_helper.temp_dir() as tmp_dir:
fn = os.path.join(tmp_dir, "test.c")
with open(fn, "w", encoding="utf-8") as f:
f.write(self.TOUCH_CODE)
dest = self.dest_file(fn)
self.expect_success(fn)
source_mtime, generated_mtime = mtimes()
self.assertGreaterEqual(generated_mtime, source_mtime)
# The generated file is changed, so both files are touched.
os.unlink(dest)
old = source_mtime - 10**10
os.utime(fn, ns=(old, old))
self.expect_success(fn)
source_mtime, generated_mtime = mtimes()
self.assertGreater(source_mtime, old)
self.assertGreaterEqual(generated_mtime, source_mtime)
# Nothing is changed, but the source file is newer, so only
# the generated file is touched.
set_mtimes(source_mtime - 10**10, source_mtime - 2 * 10**10)
old_source_mtime = os.stat(fn).st_mtime_ns
self.expect_success(fn)
source_mtime, generated_mtime = mtimes()
self.assertEqual(source_mtime, old_source_mtime)
self.assertGreaterEqual(generated_mtime, source_mtime)
# Nothing is changed and the generated file is newer,
# so no file is touched.
self.expect_success(fn)
self.assertEqual(mtimes(), (source_mtime, generated_mtime))
def test_cli_force(self):
invalid_input = dedent("""
/*[clinic input]
output preset block
module test
test.fn
a: int
[clinic start generated code]*/
const char *hand_edited = "output block is overwritten";
/*[clinic end generated code: output=bogus input=bogus]*/
""")
fail_msg = (
"Checksum mismatch! Expected 'bogus', computed '2ed19'. "
"Suggested fix: remove all generated code including the end marker, "
"or use the '-f' option.\n"
)
with os_helper.temp_dir() as tmp_dir:
fn = os.path.join(tmp_dir, "test.c")
with open(fn, "w", encoding="utf-8") as f:
f.write(invalid_input)
# First, run the CLI without -f and expect failure.
# Note, we cannot check the entire fail msg, because the path to
# the tmp file will change for every run.
_, err = self.expect_failure(fn)
self.assertEndsWith(err, fail_msg)
# Then, force regeneration; success expected.
out = self.expect_success("-f", fn)
self.assertEqual(out, "")
# Verify by checking the checksum.
checksum = (
"/*[clinic end generated code: "
"output=a2957bc4d43a3c2f input=9543a8d2da235301]*/\n"
)
with open(fn, encoding='utf-8') as f:
generated = f.read()
self.assertEndsWith(generated, checksum)
DRY_RUN_CODE = dedent("""
/*[clinic input]
func
a: int
/
Docstring.
[clinic start generated code]*/
""")
def make_dry_run_file(self, tmp_dir):
fn = os.path.join(tmp_dir, "test.c")
with open(fn, "w", encoding="utf-8") as f:
f.write(self.DRY_RUN_CODE)
return fn
@staticmethod
def dest_file(fn):
# The default destination for the generated code. Its path is
# built from the "{dirname}/clinic/{basename}.h" template, so it
# always uses forward slashes, even on Windows.
dirname, basename = os.path.split(fn)
return f"{dirname}/clinic/{basename}.h"
def check_unchanged(self, tmp_dir, fn, pre_mtime):
# Neither the source file nor the destination file
# nor its directory is created or modified.
with open(fn, encoding="utf-8") as f:
self.assertEqual(f.read(), self.DRY_RUN_CODE)
self.assertEqual(os.stat(fn).st_mtime_ns, pre_mtime)
self.assertEqual(os.listdir(tmp_dir), ["test.c"])
def test_cli_dry_run(self):
with os_helper.temp_dir() as tmp_dir:
fn = self.make_dry_run_file(tmp_dir)
pre_mtime = os.stat(fn).st_mtime_ns
out = self.expect_success("--dry-run", fn)
self.assertEqual(out.splitlines(), [
f"would create {self.dest_file(fn)}",
f"would update {fn}",
])
self.check_unchanged(tmp_dir, fn, pre_mtime)
def test_cli_dry_run_no_change(self):
with os_helper.temp_dir() as tmp_dir:
fn = self.make_dry_run_file(tmp_dir)
self.expect_success(fn)
self.assertEqual(self.expect_success("--dry-run", fn), "")
self.assertEqual(self.expect_success("--diff", fn), "")
def test_cli_dry_run_no_clinic_block(self):
with os_helper.temp_dir() as tmp_dir:
fn = os.path.join(tmp_dir, "test.c")
with open(fn, "w", encoding="utf-8") as f:
f.write("int x;\n")
self.assertEqual(self.expect_success("--dry-run", fn), "")
def test_cli_dry_run_output(self):
with os_helper.temp_dir() as tmp_dir:
fn = self.make_dry_run_file(tmp_dir)
out_fn = os.path.join(tmp_dir, "output.c")
out = self.expect_success("--dry-run", "-o", out_fn, fn)
self.assertIn(f"would create {out_fn}", out)
self.assertNotIn(f"would update {fn}", out)
self.assertFalse(os.path.exists(out_fn))
def test_cli_dry_run_make(self):
with os_helper.temp_dir() as tmp_dir:
fn = self.make_dry_run_file(tmp_dir)
pre_mtime = os.stat(fn).st_mtime_ns
out = self.expect_success("--dry-run", "--make", "--srcdir", tmp_dir)
self.assertIn(f"would update {fn}", out)
self.check_unchanged(tmp_dir, fn, pre_mtime)
def test_cli_dry_run_verbose(self):
with os_helper.temp_dir() as tmp_dir:
fn = self.make_dry_run_file(tmp_dir)
out, err, code = self.run_clinic("-v", "--dry-run", fn)
self.assertEqual(code, 0)
# The progress goes to stderr, so that the standard output
# contains only the report.
self.assertEqual(err.splitlines(), [fn])
self.assertEqual(out.splitlines(), [
f"would create {self.dest_file(fn)}",
f"would update {fn}",
])
def test_cli_dry_run_checksum_mismatch(self):
invalid_input = dedent("""
/*[clinic input]
output preset block
module test
test.fn
a: int
[clinic start generated code]*/
/*[clinic end generated code: output=bogus input=bogus]*/
""")
with os_helper.temp_dir() as tmp_dir:
fn = os.path.join(tmp_dir, "test.c")
with open(fn, "w", encoding="utf-8") as f:
f.write(invalid_input)
pre_mtime = os.stat(fn).st_mtime_ns
# The dry run does not disable the checksum verification.
_, err = self.expect_failure("--dry-run", fn)
self.assertIn("Checksum mismatch!", err)
# With -f the change is reported, but still not written.
out = self.expect_success("--dry-run", "-f", fn)
self.assertIn(f"would update {fn}", out)
with open(fn, encoding="utf-8") as f:
self.assertEqual(f.read(), invalid_input)
self.assertEqual(os.stat(fn).st_mtime_ns, pre_mtime)
def test_cli_diff(self):
with os_helper.temp_dir() as tmp_dir:
fn = self.make_dry_run_file(tmp_dir)
pre_mtime = os.stat(fn).st_mtime_ns
out = self.expect_success("--diff", fn)
self.check_unchanged(tmp_dir, fn, pre_mtime)
# A new file is created by the patch.
dest_fn = self.dest_file(fn)
self.assertStartsWith(out, f"--- /dev/null\n+++ {dest_fn}\n@@ -0,0 +1,")
self.assertIn(f"--- {fn}\n+++ {fn}\n", out)
self.assertIn("+/*[clinic end generated code:", out)
# The patch is what clinic would have written.
self.expect_success(fn)
with open(fn, encoding="utf-8") as f:
new_contents = f.read()
expected = "".join(difflib.unified_diff(
self.DRY_RUN_CODE.splitlines(keepends=True),
new_contents.splitlines(keepends=True),
fromfile=fn, tofile=fn))
self.assertEndsWith(out, expected)
def test_cli_fail_converters_and_dry_run(self):
for opt in "--dry-run", "--diff":
with self.subTest(opt=opt):
_, err = self.expect_failure("--converters", opt)
msg = "can't use --dry-run or --diff with --converters"
self.assertIn(msg, err)
def test_cli_make(self):
c_code = dedent("""
/*[clinic input]
[clinic start generated code]*/
""")
py_code = "pass"
c_files = "file1.c", "file2.c"
py_files = "file1.py", "file2.py"
def create_files(files, srcdir, code):
for fn in files:
path = os.path.join(srcdir, fn)
with open(path, "w", encoding="utf-8") as f:
f.write(code)
with os_helper.temp_dir() as tmp_dir:
# add some folders, some C files and a Python file
create_files(c_files, tmp_dir, c_code)
create_files(py_files, tmp_dir, py_code)
# create C files in externals/ dir
ext_path = os.path.join(tmp_dir, "externals")
with os_helper.temp_dir(path=ext_path) as externals:
create_files(c_files, externals, c_code)
# run clinic in verbose mode with --make on tmpdir
out = self.expect_success("-v", "--make", "--srcdir", tmp_dir)
# expect verbose mode to only mention the C files in tmp_dir
for filename in c_files:
with self.subTest(filename=filename):
path = os.path.join(tmp_dir, filename)
self.assertIn(path, out)
for filename in py_files:
with self.subTest(filename=filename):
path = os.path.join(tmp_dir, filename)
self.assertNotIn(path, out)
# don't expect C files from the externals dir
for filename in c_files:
with self.subTest(filename=filename):
path = os.path.join(ext_path, filename)
self.assertNotIn(path, out)
def test_cli_make_exclude(self):
code = dedent("""
/*[clinic input]
[clinic start generated code]*/
""")
with os_helper.temp_dir(quiet=False) as tmp_dir:
# add some folders, some C files and a Python file
for fn in "file1.c", "file2.c", "file3.c", "file4.c":
path = os.path.join(tmp_dir, fn)
with open(path, "w", encoding="utf-8") as f:
f.write(code)
# Run clinic in verbose mode with --make on tmpdir.
# Exclude file2.c and file3.c.
out = self.expect_success(
"-v", "--make", "--srcdir", tmp_dir,
"--exclude", os.path.join(tmp_dir, "file2.c"),
# The added ./ should be normalised away.
"--exclude", os.path.join(tmp_dir, "./file3.c"),
# Relative paths should also work.
"--exclude", "file4.c"
)
# expect verbose mode to only mention the C files in tmp_dir
self.assertIn("file1.c", out)
self.assertNotIn("file2.c", out)
self.assertNotIn("file3.c", out)
self.assertNotIn("file4.c", out)
def test_cli_verbose(self):
with os_helper.temp_dir() as tmp_dir:
fn = os.path.join(tmp_dir, "test.c")
with open(fn, "w", encoding="utf-8") as f:
f.write("")
out = self.expect_success("-v", fn)
self.assertEqual(out.strip(), fn)
@support.force_not_colorized
def test_cli_help(self):
out = self.expect_success("-h")
self.assertIn("usage: clinic.py", out)
def test_cli_converters(self):
prelude = dedent("""
Legacy converters:
B C D L O S U Y Z Z#
b c d f h i l p s s# s* u u# w* y y# y* z z# z*
Converters:
""")
expected_converters = (
"bool",
"BOOL",
"byte",
"char",
"defining_class",
"double",
"DWORD",
"fildes",
"float",
"gid_t",
"HANDLE",
"int",
"long",
"long_long",
"object",
"pid_t",
"Py_buffer",
"Py_complex",
"Py_off_t",
"Py_ssize_t",
"Py_UNICODE",
"PyByteArrayObject",
"PyBytesObject",
"self",
"short",
"size_t",
"slice_index",
"str",
"uid_t",
"uint16",
"uint32",
"uint64",
"uint8",
"unicode",
"unicode_fs_decoded",
"unicode_fs_encoded",
"unsigned_char",
"unsigned_int",
"unsigned_long",
"unsigned_long_long",
"unsigned_short",
)
finale = dedent("""
Return converters:
bool()
double()
float()
int()
long()
object()
Py_ssize_t()
size_t()
unsigned_int()
unsigned_long()
All converters also accept (c_default=None, py_default=None, annotation=None).
All return converters also accept (py_default=None).
""")
out = self.expect_success("--converters")
# We cannot simply compare the output, because the repr of the *accept*
# param may change (it's a set, thus unordered). So, let's compare the
# start and end of the expected output, and then assert that the
# converters appear lined up in alphabetical order.
self.assertStartsWith(out, prelude)
self.assertEndsWith(out, finale)
out = out.removeprefix(prelude)
out = out.removesuffix(finale)
lines = out.split("\n")
for converter, line in zip(expected_converters, lines):
line = line.lstrip()
with self.subTest(converter=converter):
self.assertStartsWith(line, converter)
def test_cli_converters_file(self):
code = dedent("""
/*[python input]
class my_type_converter(CConverter):
type = 'my_type'
converter = 'my_type_converter'
def converter_init(self, *, strict=False):
pass
class my_result_return_converter(CReturnConverter):
type = 'my_result'
[python start generated code]*/
""")
with os_helper.temp_dir() as tmp_dir:
fn = os.path.join(tmp_dir, "test.c")
with open(fn, "w", encoding="utf-8") as f:
f.write(code)
out = self.expect_success("--converters", fn)
self.assertIn("Converters:\n my_type(strict=False)\n", out)
self.assertIn("Return converters:\n my_result()\n", out)
# Only the converters defined in the file are listed.
self.assertNotIn("Legacy converters:", out)
self.assertNotIn("bool(", out)
# Listing the converters does not write anything.
with open(fn, encoding="utf-8") as f:
self.assertEqual(f.read(), code)
self.assertEqual(os.listdir(tmp_dir), ["test.c"])
def test_cli_converters_make(self):
code = dedent("""
/*[python input]
class my_type_converter(CConverter):
type = 'my_type'
converter = 'my_type_converter'
[python start generated code]*/
""")
with os_helper.temp_dir() as tmp_dir:
fn = os.path.join(tmp_dir, "test.c")
with open(fn, "w", encoding="utf-8") as f:
f.write(code)
out = self.expect_success("--converters", "--make",
"--srcdir", tmp_dir)
self.assertIn("Converters:\n my_type()\n", out)
with open(fn, encoding="utf-8") as f:
self.assertEqual(f.read(), code)
def test_cli_converters_no_converters(self):
with os_helper.temp_dir() as tmp_dir:
fn = os.path.join(tmp_dir, "test.c")
with open(fn, "w", encoding="utf-8") as f:
f.write("/*[clinic input]\n[clinic start generated code]*/\n")
self.assertEqual(self.expect_success("--converters", fn), "")
LIST_CODE = dedent("""
/*[clinic input]
func
a: int
/
Docstring.
[clinic start generated code]*/
/*[clinic input]
cloned = func
[clinic start generated code]*/
/*[clinic input]
module m
class m.C "void *" ""
class m.C.D "void *" ""
[clinic start generated code]*/
/*[clinic input]
m.C.meth
self: self(type="void *")
a: object
[
b: object
]
/
Docstring.
[clinic start generated code]*/
/*[clinic input]
@classmethod
m.C.__new__
a: object
Docstring.
[clinic start generated code]*/
/*[clinic input]
@getter
m.C.prop
[clinic start generated code]*/
/*[clinic input]
@setter
m.C.prop
[clinic start generated code]*/
/*[clinic input]
m.C.D.meth
self: self(type="void *")
Docstring.
[clinic start generated code]*/
""")
def make_list_file(self, tmp_dir):
fn = os.path.join(tmp_dir, "test.c")
with open(fn, "w", encoding="utf-8") as f:
f.write(self.LIST_CODE)
return fn
LIST_OUTPUT = [
" func($module, a, /)",
" cloned($module, a, /)",
" module m",
" class m.C",
# A signature with an option group is only for the docstring.
" m.C.meth(a, [b])",
" m.C(a)",
" getter m.C.prop",
" setter m.C.prop",
" class m.C.D",
" m.C.D.meth($self, /)",
]
def test_cli_list(self):
with os_helper.temp_dir() as tmp_dir:
fn = self.make_list_file(tmp_dir)
pre_mtime = os.stat(fn).st_mtime_ns
out = self.expect_success("--list", fn)
self.assertEqual(out.splitlines(), [fn] + self.LIST_OUTPUT)
# Nothing is written.
with open(fn, encoding="utf-8") as f:
self.assertEqual(f.read(), self.LIST_CODE)
self.assertEqual(os.stat(fn).st_mtime_ns, pre_mtime)
self.assertEqual(os.listdir(tmp_dir), ["test.c"])
def test_cli_list_no_clinic_block(self):
with os_helper.temp_dir() as tmp_dir:
fn = os.path.join(tmp_dir, "test.c")
with open(fn, "w", encoding="utf-8") as f:
f.write("int x;\n")
self.assertEqual(self.expect_success("--list", fn), "")
def test_cli_list_no_definitions(self):
with os_helper.temp_dir() as tmp_dir:
fn = os.path.join(tmp_dir, "test.c")
with open(fn, "w", encoding="utf-8") as f:
f.write("/*[clinic input]\n[clinic start generated code]*/\n")
self.assertEqual(self.expect_success("--list", fn), "")
def test_cli_list_make(self):
with os_helper.temp_dir() as tmp_dir:
fn = self.make_list_file(tmp_dir)
out = self.expect_success("--list", "--make", "--srcdir", tmp_dir)
self.assertEqual(out.splitlines(), [fn] + self.LIST_OUTPUT)
self.assertEqual(os.listdir(tmp_dir), ["test.c"])
def test_cli_list_verbose(self):
with os_helper.temp_dir() as tmp_dir:
fn = self.make_list_file(tmp_dir)
# The progress does not mix with the report.
out, err, code = self.run_clinic("-v", "--list", fn)
self.assertEqual(code, 0)
self.assertEqual(err.splitlines(), [fn])
self.assertEqual(out.splitlines(), [fn] + self.LIST_OUTPUT)
def test_cli_list_checksum_mismatch(self):
with os_helper.temp_dir() as tmp_dir:
fn = self.make_list_file(tmp_dir)
with open(fn, "a", encoding="utf-8") as f:
f.write("/*[clinic end generated code: "
"output=0123456789abcdef input=fedcba9876543210]*/\n")
_, err = self.expect_failure("--list", fn)
self.assertIn("Checksum mismatch!", err)
# The check is skipped with --force.
out = self.expect_success("-f", "--list", fn)
self.assertEqual(out.splitlines(), [fn] + self.LIST_OUTPUT)
self.assertEqual(os.listdir(tmp_dir), ["test.c"])
def test_cli_list_external(self):
# A file which uses getters, setters and nested classes.
source = support.findfile('clinic.test.c')
out = self.expect_success("--list", source)
lines = out.splitlines()
self.assertEqual(lines[0], source)
for line in (" class Test",
" getter Test.property",
" setter Test.property",
" Test.class_method($type, /)",
" module m",
" class m.T"):
with self.subTest(line=line):
self.assertIn(line, lines)
def test_cli_fail_list_and_dry_run(self):
for opt in "--dry-run", "--diff":
with self.subTest(opt=opt):
_, err = self.expect_failure("--list", opt, "test.c")
self.assertIn("can't use --dry-run or --diff with --list", err)
def test_cli_fail_list_and_converters(self):
_, err = self.expect_failure("--list", "--converters", "test.c")
self.assertIn("can't use --converters with --list", err)
def test_cli_fail_directory(self):
with os_helper.temp_dir() as tmp_dir:
subdir = os.path.join(tmp_dir, "test.c")
os.mkdir(subdir)
_, err = self.expect_failure(subdir)
self.assertIn(f"Can't read file {subdir!r}: it is a directory", err)
def test_cli_fail_no_filename(self):
_, err = self.expect_failure()
self.assertIn("no input files", err)
def test_cli_fail_output_and_multiple_files(self):
_, err = self.expect_failure("-o", "out.c", "input.c", "moreinput.c")
msg = "error: can't use -o with multiple filenames"
self.assertIn(msg, err)
def test_cli_fail_filename_or_output_and_make(self):
msg = "can't use -o or filenames with --make"
for opts in ("-o", "out.c"), ("filename.c",):
with self.subTest(opts=opts):
_, err = self.expect_failure("--make", *opts)
self.assertIn(msg, err)
def test_cli_fail_make_without_srcdir(self):
_, err = self.expect_failure("--make", "--srcdir", "")
msg = "error: --srcdir must not be empty with --make"
self.assertIn(msg, err)
def test_file_dest(self):
block = dedent("""
/*[clinic input]
destination test new file {path}.h
output everything test
func
a: object
/
[clinic start generated code]*/
""")
expected_checksum_line = (
"/*[clinic end generated code: "
"output=da39a3ee5e6b4b0d input=b602ab8e173ac3bd]*/\n"
)
expected_output = dedent("""\
/*[clinic input]
preserve
[clinic start generated code]*/
PyDoc_VAR(func__doc__);
PyDoc_STRVAR(func__doc__,
"func($module, a, /)\\n"
"--\\n"
"\\n");
#define FUNC_METHODDEF \\
{"func", (PyCFunction)func, METH_O, func__doc__},
static PyObject *
func(PyObject *module, PyObject *a)
/*[clinic end generated code: output=3dde2d13002165b9 input=a9049054013a1b77]*/
""")
with os_helper.temp_dir() as tmp_dir:
in_fn = os.path.join(tmp_dir, "test.c")
out_fn = os.path.join(tmp_dir, "test.c.h")
with open(in_fn, "w", encoding="utf-8") as f:
f.write(block)
with open(out_fn, "w", encoding="utf-8") as f:
f.write("") # Write an empty output file!
# Clinic should complain about the empty output file.
_, err = self.expect_failure(in_fn)
expected_err = (f"Modified destination file {out_fn!r}; "
"not overwriting!")
self.assertIn(expected_err, err)
# Run clinic again, this time with the -f option.
_ = self.expect_success("-f", in_fn)
# Read back the generated output.
with open(in_fn, encoding="utf-8") as f:
data = f.read()
expected_block = f"{block}{expected_checksum_line}"
self.assertEqual(data, expected_block)
with open(out_fn, encoding="utf-8") as f:
data = f.read()
self.assertEqual(data, expected_output)
try:
import _testclinic as ac_tester
except ImportError:
ac_tester = None
@unittest.skipIf(ac_tester is None, "_testclinic is missing")
class ClinicFunctionalTest(unittest.TestCase):
locals().update((name, getattr(ac_tester, name))
for name in dir(ac_tester) if name.startswith('test_'))
def check_depr(self, regex, fn, /, *args, **kwds):
with self.assertWarnsRegex(DeprecationWarning, regex) as cm:
# Record the line number, so we're sure we've got the correct stack
# level on the deprecation warning.
_, lineno = fn(*args, **kwds), sys._getframe().f_lineno
self.assertEqual(cm.filename, __file__)
self.assertEqual(cm.lineno, lineno)
def check_depr_star(self, pnames, fn, /, *args, name=None, **kwds):
if name is None:
name = fn.__qualname__
if isinstance(fn, type):
name = f'{fn.__module__}.{name}'
regex = (
fr"Passing( more than)?( [0-9]+)? positional argument(s)? to "
fr"{re.escape(name)}\(\) is deprecated. Parameters? {pnames} will "
fr"become( a)? keyword-only parameters? in Python 3\.14"
)
self.check_depr(regex, fn, *args, **kwds)
def check_depr_kwd(self, pnames, fn, *args, name=None, **kwds):
if name is None:
name = fn.__qualname__
if isinstance(fn, type):
name = f'{fn.__module__}.{name}'
pl = 's' if ' ' in pnames else ''
regex = (
fr"Passing keyword argument{pl} {pnames} to "
fr"{re.escape(name)}\(\) is deprecated. Parameter{pl} {pnames} "
fr"will become positional-only in Python 3\.14."
)
self.check_depr(regex, fn, *args, **kwds)
def test_objects_converter(self):
with self.assertRaises(TypeError):
ac_tester.objects_converter()
self.assertEqual(ac_tester.objects_converter(1, 2), (1, 2))
self.assertEqual(ac_tester.objects_converter([], 'whatever class'), ([], 'whatever class'))
self.assertEqual(ac_tester.objects_converter(1), (1, None))
def test_bytes_object_converter(self):
with self.assertRaises(TypeError):
ac_tester.bytes_object_converter(1)
self.assertEqual(ac_tester.bytes_object_converter(b'BytesObject'), (b'BytesObject',))
def test_byte_array_object_converter(self):
with self.assertRaises(TypeError):
ac_tester.byte_array_object_converter(1)
byte_arr = bytearray(b'ByteArrayObject')
self.assertEqual(ac_tester.byte_array_object_converter(byte_arr), (byte_arr,))
def test_unicode_converter(self):
with self.assertRaises(TypeError):
ac_tester.unicode_converter(1)
self.assertEqual(ac_tester.unicode_converter('unicode'), ('unicode',))
def test_bool_converter(self):
with self.assertRaises(TypeError):
ac_tester.bool_converter(False, False, 'not a int')
self.assertEqual(ac_tester.bool_converter(), (True, True, True))
self.assertEqual(ac_tester.bool_converter('', [], 5), (False, False, True))
self.assertEqual(ac_tester.bool_converter(('not empty',), {1: 2}, 0), (True, True, False))
def test_bool_converter_c_default(self):
self.assertEqual(ac_tester.bool_converter_c_default(), (1, 0, -2, -3))
self.assertEqual(ac_tester.bool_converter_c_default(False, True, False, True),
(0, 1, 0, 1))
def test_char_converter(self):
with self.assertRaises(TypeError):
ac_tester.char_converter(1)
with self.assertRaises(TypeError):
ac_tester.char_converter(b'ab')
chars = [b'A', b'\a', b'\b', b'\t', b'\n', b'\v', b'\f', b'\r', b'"', b"'", b'?', b'\\', b'\000', b'\377']
expected = tuple(ord(c) for c in chars)
self.assertEqual(ac_tester.char_converter(), expected)
chars = [b'1', b'2', b'3', b'4', b'5', b'6', b'7', b'8', b'9', b'0', b'a', b'b', b'c', b'd']
expected = tuple(ord(c) for c in chars)
self.assertEqual(ac_tester.char_converter(*chars), expected)
def test_unsigned_char_converter(self):
from _testcapi import UCHAR_MAX
SCHAR_MAX = UCHAR_MAX // 2
SCHAR_MIN = SCHAR_MAX - UCHAR_MAX
with self.assertRaises(OverflowError):
ac_tester.unsigned_char_converter(-1)
with self.assertRaises(OverflowError):
ac_tester.unsigned_char_converter(UCHAR_MAX + 1)
with self.assertRaises(OverflowError):
ac_tester.unsigned_char_converter(0, UCHAR_MAX + 1)
with self.assertRaises(TypeError):
ac_tester.unsigned_char_converter([])
self.assertEqual(ac_tester.unsigned_char_converter(), (12, 34, 56))
with self.assertWarns(DeprecationWarning):
self.assertEqual(ac_tester.unsigned_char_converter(0, 0, UCHAR_MAX + 1), (0, 0, 0))
self.assertEqual(ac_tester.unsigned_char_converter(0, 0, SCHAR_MIN), (0, 0, SCHAR_MAX + 1))
with self.assertWarns(DeprecationWarning):
self.assertEqual(ac_tester.unsigned_char_converter(0, 0, SCHAR_MIN - 1), (0, 0, SCHAR_MAX))
with self.assertWarns(DeprecationWarning):
self.assertEqual(ac_tester.unsigned_char_converter(0, 0, (UCHAR_MAX + 1) * 3 + 123), (0, 0, 123))
def test_short_converter(self):
from _testcapi import SHRT_MIN, SHRT_MAX
with self.assertRaises(OverflowError):
ac_tester.short_converter(SHRT_MIN - 1)
with self.assertRaises(OverflowError):
ac_tester.short_converter(SHRT_MAX + 1)
with self.assertRaises(TypeError):
ac_tester.short_converter([])
self.assertEqual(ac_tester.short_converter(-1234), (-1234,))
self.assertEqual(ac_tester.short_converter(4321), (4321,))
def test_unsigned_short_converter(self):
from _testcapi import SHRT_MIN, SHRT_MAX, USHRT_MAX
with self.assertRaises(ValueError):
ac_tester.unsigned_short_converter(-1)
with self.assertRaises(OverflowError):
ac_tester.unsigned_short_converter(USHRT_MAX + 1)
with self.assertRaises(OverflowError):
ac_tester.unsigned_short_converter(0, USHRT_MAX + 1)
with self.assertRaises(TypeError):
ac_tester.unsigned_short_converter([])
self.assertEqual(ac_tester.unsigned_short_converter(), (12, 34, 56))
with self.assertWarns(DeprecationWarning):
self.assertEqual(ac_tester.unsigned_short_converter(0, 0, USHRT_MAX + 1), (0, 0, 0))
self.assertEqual(ac_tester.unsigned_short_converter(0, 0, SHRT_MIN), (0, 0, SHRT_MAX + 1))
with self.assertWarns(DeprecationWarning):
self.assertEqual(ac_tester.unsigned_short_converter(0, 0, SHRT_MIN - 1), (0, 0, SHRT_MAX))
with self.assertWarns(DeprecationWarning):
self.assertEqual(ac_tester.unsigned_short_converter(0, 0, (USHRT_MAX + 1) * 3 + 123), (0, 0, 123))
def test_int_converter(self):
from _testcapi import INT_MIN, INT_MAX
with self.assertRaises(OverflowError):
ac_tester.int_converter(INT_MIN - 1)
with self.assertRaises(OverflowError):
ac_tester.int_converter(INT_MAX + 1)
with self.assertRaises(TypeError):
ac_tester.int_converter(1, 2, 3)
with self.assertRaises(TypeError):
ac_tester.int_converter([])
self.assertEqual(ac_tester.int_converter(), (12, 34, 45))
self.assertEqual(ac_tester.int_converter(1, 2, '3'), (1, 2, ord('3')))
def test_unsigned_int_converter(self):
from _testcapi import INT_MIN, INT_MAX, UINT_MAX
with self.assertRaises(ValueError):
ac_tester.unsigned_int_converter(-1)
with self.assertRaises(OverflowError):
ac_tester.unsigned_int_converter(UINT_MAX + 1)
with self.assertRaises(OverflowError):
ac_tester.unsigned_int_converter(0, UINT_MAX + 1)
with self.assertRaises(TypeError):
ac_tester.unsigned_int_converter([])
self.assertEqual(ac_tester.unsigned_int_converter(), (12, 34, 56))
with self.assertWarns(DeprecationWarning):
self.assertEqual(ac_tester.unsigned_int_converter(0, 0, UINT_MAX + 1), (0, 0, 0))
self.assertEqual(ac_tester.unsigned_int_converter(0, 0, INT_MIN), (0, 0, INT_MAX + 1))
with self.assertWarns(DeprecationWarning):
self.assertEqual(ac_tester.unsigned_int_converter(0, 0, INT_MIN - 1), (0, 0, INT_MAX))
with self.assertWarns(DeprecationWarning):
self.assertEqual(ac_tester.unsigned_int_converter(0, 0, (UINT_MAX + 1) * 3 + 123), (0, 0, 123))
def test_long_converter(self):
from _testcapi import LONG_MIN, LONG_MAX
with self.assertRaises(OverflowError):
ac_tester.long_converter(LONG_MIN - 1)
with self.assertRaises(OverflowError):
ac_tester.long_converter(LONG_MAX + 1)
with self.assertRaises(TypeError):
ac_tester.long_converter([])
self.assertEqual(ac_tester.long_converter(), (12,))
self.assertEqual(ac_tester.long_converter(-1234), (-1234,))
def test_unsigned_long_converter(self):
from _testcapi import LONG_MIN, LONG_MAX, ULONG_MAX
with self.assertRaises(ValueError):
ac_tester.unsigned_long_converter(-1)
with self.assertRaises(OverflowError):
ac_tester.unsigned_long_converter(ULONG_MAX + 1)
with self.assertRaises(OverflowError):
ac_tester.unsigned_long_converter(0, ULONG_MAX + 1)
with self.assertRaises(TypeError):
ac_tester.unsigned_long_converter([])
self.assertEqual(ac_tester.unsigned_long_converter(), (12, 34, 56))
with self.assertWarns(DeprecationWarning):
self.assertEqual(ac_tester.unsigned_long_converter(0, 0, ULONG_MAX + 1), (0, 0, 0))
self.assertEqual(ac_tester.unsigned_long_converter(0, 0, LONG_MIN), (0, 0, LONG_MAX + 1))
with self.assertWarns(DeprecationWarning):
self.assertEqual(ac_tester.unsigned_long_converter(0, 0, LONG_MIN - 1), (0, 0, LONG_MAX))
with self.assertWarns(DeprecationWarning):
self.assertEqual(ac_tester.unsigned_long_converter(0, 0, (ULONG_MAX + 1) * 3 + 123), (0, 0, 123))
def test_long_long_converter(self):
from _testcapi import LLONG_MIN, LLONG_MAX
with self.assertRaises(OverflowError):
ac_tester.long_long_converter(LLONG_MIN - 1)
with self.assertRaises(OverflowError):
ac_tester.long_long_converter(LLONG_MAX + 1)
with self.assertRaises(TypeError):
ac_tester.long_long_converter([])
self.assertEqual(ac_tester.long_long_converter(), (12,))
self.assertEqual(ac_tester.long_long_converter(-1234), (-1234,))
def test_unsigned_long_long_converter(self):
from _testcapi import LLONG_MIN, LLONG_MAX, ULLONG_MAX
with self.assertRaises(ValueError):
ac_tester.unsigned_long_long_converter(-1)
with self.assertRaises(OverflowError):
ac_tester.unsigned_long_long_converter(ULLONG_MAX + 1)
with self.assertRaises(OverflowError):
ac_tester.unsigned_long_long_converter(0, ULLONG_MAX + 1)
with self.assertRaises(TypeError):
ac_tester.unsigned_long_long_converter([])
self.assertEqual(ac_tester.unsigned_long_long_converter(), (12, 34, 56))
with self.assertWarns(DeprecationWarning):
self.assertEqual(ac_tester.unsigned_long_long_converter(0, 0, ULLONG_MAX + 1), (0, 0, 0))
self.assertEqual(ac_tester.unsigned_long_long_converter(0, 0, LLONG_MIN), (0, 0, LLONG_MAX + 1))
with self.assertWarns(DeprecationWarning):
self.assertEqual(ac_tester.unsigned_long_long_converter(0, 0, LLONG_MIN - 1), (0, 0, LLONG_MAX))
with self.assertWarns(DeprecationWarning):
self.assertEqual(ac_tester.unsigned_long_long_converter(0, 0, (ULLONG_MAX + 1) * 3 + 123), (0, 0, 123))
def test_py_ssize_t_converter(self):
from _testcapi import PY_SSIZE_T_MIN, PY_SSIZE_T_MAX
with self.assertRaises(OverflowError):
ac_tester.py_ssize_t_converter(PY_SSIZE_T_MIN - 1)
with self.assertRaises(OverflowError):
ac_tester.py_ssize_t_converter(PY_SSIZE_T_MAX + 1)
with self.assertRaises(TypeError):
ac_tester.py_ssize_t_converter([])
with self.assertRaises(ValueError):
ac_tester.py_ssize_t_converter(12, 34, 56, -1)
with self.assertRaises(ValueError):
ac_tester.py_ssize_t_converter(12, 34, 56, 78, -1)
self.assertEqual(ac_tester.py_ssize_t_converter(), (12, 34, 56, 78, 90, -12, -34))
self.assertEqual(ac_tester.py_ssize_t_converter(1, 2, None, 3, None, 4, None), (1, 2, 56, 3, 90, 4, -34))
def test_slice_index_converter(self):
from _testcapi import PY_SSIZE_T_MIN, PY_SSIZE_T_MAX
with self.assertRaises(TypeError):
ac_tester.slice_index_converter([])
self.assertEqual(ac_tester.slice_index_converter(), (12, 34, 56))
self.assertEqual(ac_tester.slice_index_converter(1, 2, None), (1, 2, 56))
self.assertEqual(ac_tester.slice_index_converter(PY_SSIZE_T_MAX, PY_SSIZE_T_MAX + 1, PY_SSIZE_T_MAX + 1234),
(PY_SSIZE_T_MAX, PY_SSIZE_T_MAX, PY_SSIZE_T_MAX))
self.assertEqual(ac_tester.slice_index_converter(PY_SSIZE_T_MIN, PY_SSIZE_T_MIN - 1, PY_SSIZE_T_MIN - 1234),
(PY_SSIZE_T_MIN, PY_SSIZE_T_MIN, PY_SSIZE_T_MIN))
def test_size_t_converter(self):
with self.assertRaises(ValueError):
ac_tester.size_t_converter(-1)
with self.assertRaises(TypeError):
ac_tester.size_t_converter([])
self.assertEqual(ac_tester.size_t_converter(), (12,))
def test_float_converter(self):
with self.assertRaises(TypeError):
ac_tester.float_converter([])
self.assertEqual(ac_tester.float_converter(), (12.5,))
self.assertEqual(ac_tester.float_converter(-0.5), (-0.5,))
def test_double_converter(self):
with self.assertRaises(TypeError):
ac_tester.double_converter([])
self.assertEqual(ac_tester.double_converter(), (12.5,))
self.assertEqual(ac_tester.double_converter(-0.5), (-0.5,))
def test_py_complex_converter(self):
with self.assertRaises(TypeError):
ac_tester.py_complex_converter([])
self.assertEqual(ac_tester.py_complex_converter(complex(1, 2)), (complex(1, 2),))
self.assertEqual(ac_tester.py_complex_converter(complex('-1-2j')), (complex('-1-2j'),))
self.assertEqual(ac_tester.py_complex_converter(-0.5), (-0.5,))
self.assertEqual(ac_tester.py_complex_converter(10), (10,))
def test_str_converter(self):
with self.assertRaises(TypeError):
ac_tester.str_converter(1)
with self.assertRaises(TypeError):
ac_tester.str_converter('a', 'b', 'c')
with self.assertRaises(ValueError):
ac_tester.str_converter('a', b'b\0b', 'c')
self.assertEqual(ac_tester.str_converter('a', b'b', 'c'), ('a', 'b', 'c'))
self.assertEqual(ac_tester.str_converter('a', b'b', b'c'), ('a', 'b', 'c'))
self.assertEqual(ac_tester.str_converter('a', b'b', 'c\0c'), ('a', 'b', 'c\0c'))
def test_str_converter_encoding(self):
with self.assertRaises(TypeError):
ac_tester.str_converter_encoding(1)
self.assertEqual(ac_tester.str_converter_encoding('a', 'b', 'c'), ('a', 'b', 'c'))
with self.assertRaises(TypeError):
ac_tester.str_converter_encoding('a', b'b\0b', 'c')
self.assertEqual(ac_tester.str_converter_encoding('a', b'b', bytearray([ord('c')])), ('a', 'b', 'c'))
self.assertEqual(ac_tester.str_converter_encoding('a', b'b', bytearray([ord('c'), 0, ord('c')])),
('a', 'b', 'c\x00c'))
self.assertEqual(ac_tester.str_converter_encoding('a', b'b', b'c\x00c'), ('a', 'b', 'c\x00c'))
def test_py_buffer_converter(self):
with self.assertRaises(TypeError):
ac_tester.py_buffer_converter('a', 'b')
self.assertEqual(ac_tester.py_buffer_converter('abc', bytearray([1, 2, 3])), (b'abc', b'\x01\x02\x03'))
def test_keywords(self):
self.assertEqual(ac_tester.keywords(1, 2), (1, 2))
self.assertEqual(ac_tester.keywords(1, b=2), (1, 2))
self.assertEqual(ac_tester.keywords(a=1, b=2), (1, 2))
def test_keywords_kwonly(self):
with self.assertRaises(TypeError):
ac_tester.keywords_kwonly(1, 2)
self.assertEqual(ac_tester.keywords_kwonly(1, b=2), (1, 2))
self.assertEqual(ac_tester.keywords_kwonly(a=1, b=2), (1, 2))
def test_keywords_opt(self):
self.assertEqual(ac_tester.keywords_opt(1), (1, None, None))
self.assertEqual(ac_tester.keywords_opt(1, 2), (1, 2, None))
self.assertEqual(ac_tester.keywords_opt(1, 2, 3), (1, 2, 3))
self.assertEqual(ac_tester.keywords_opt(1, b=2), (1, 2, None))
self.assertEqual(ac_tester.keywords_opt(1, 2, c=3), (1, 2, 3))
self.assertEqual(ac_tester.keywords_opt(a=1, c=3), (1, None, 3))
self.assertEqual(ac_tester.keywords_opt(a=1, b=2, c=3), (1, 2, 3))
def test_keywords_opt_kwonly(self):
self.assertEqual(ac_tester.keywords_opt_kwonly(1), (1, None, None, None))
self.assertEqual(ac_tester.keywords_opt_kwonly(1, 2), (1, 2, None, None))
with self.assertRaises(TypeError):
ac_tester.keywords_opt_kwonly(1, 2, 3)
self.assertEqual(ac_tester.keywords_opt_kwonly(1, b=2), (1, 2, None, None))
self.assertEqual(ac_tester.keywords_opt_kwonly(1, 2, c=3), (1, 2, 3, None))
self.assertEqual(ac_tester.keywords_opt_kwonly(a=1, c=3), (1, None, 3, None))
self.assertEqual(ac_tester.keywords_opt_kwonly(a=1, b=2, c=3, d=4), (1, 2, 3, 4))
def test_keywords_kwonly_opt(self):
self.assertEqual(ac_tester.keywords_kwonly_opt(1), (1, None, None))
with self.assertRaises(TypeError):
ac_tester.keywords_kwonly_opt(1, 2)
self.assertEqual(ac_tester.keywords_kwonly_opt(1, b=2), (1, 2, None))
self.assertEqual(ac_tester.keywords_kwonly_opt(a=1, c=3), (1, None, 3))
self.assertEqual(ac_tester.keywords_kwonly_opt(a=1, b=2, c=3), (1, 2, 3))
def test_posonly_keywords(self):
with self.assertRaises(TypeError):
ac_tester.posonly_keywords(1)
with self.assertRaises(TypeError):
ac_tester.posonly_keywords(a=1, b=2)
self.assertEqual(ac_tester.posonly_keywords(1, 2), (1, 2))
self.assertEqual(ac_tester.posonly_keywords(1, b=2), (1, 2))
def test_posonly_kwonly(self):
with self.assertRaises(TypeError):
ac_tester.posonly_kwonly(1)
with self.assertRaises(TypeError):
ac_tester.posonly_kwonly(1, 2)
with self.assertRaises(TypeError):
ac_tester.posonly_kwonly(a=1, b=2)
self.assertEqual(ac_tester.posonly_kwonly(1, b=2), (1, 2))
def test_posonly_keywords_kwonly(self):
with self.assertRaises(TypeError):
ac_tester.posonly_keywords_kwonly(1)
with self.assertRaises(TypeError):
ac_tester.posonly_keywords_kwonly(1, 2, 3)
with self.assertRaises(TypeError):
ac_tester.posonly_keywords_kwonly(a=1, b=2, c=3)
self.assertEqual(ac_tester.posonly_keywords_kwonly(1, 2, c=3), (1, 2, 3))
self.assertEqual(ac_tester.posonly_keywords_kwonly(1, b=2, c=3), (1, 2, 3))
def test_posonly_keywords_opt(self):
with self.assertRaises(TypeError):
ac_tester.posonly_keywords_opt(1)
self.assertEqual(ac_tester.posonly_keywords_opt(1, 2), (1, 2, None, None))
self.assertEqual(ac_tester.posonly_keywords_opt(1, 2, 3), (1, 2, 3, None))
self.assertEqual(ac_tester.posonly_keywords_opt(1, 2, 3, 4), (1, 2, 3, 4))
self.assertEqual(ac_tester.posonly_keywords_opt(1, b=2), (1, 2, None, None))
self.assertEqual(ac_tester.posonly_keywords_opt(1, 2, c=3), (1, 2, 3, None))
with self.assertRaises(TypeError):
ac_tester.posonly_keywords_opt(a=1, b=2, c=3, d=4)
self.assertEqual(ac_tester.posonly_keywords_opt(1, b=2, c=3, d=4), (1, 2, 3, 4))
def test_posonly_opt_keywords_opt(self):
self.assertEqual(ac_tester.posonly_opt_keywords_opt(1), (1, None, None, None))
self.assertEqual(ac_tester.posonly_opt_keywords_opt(1, 2), (1, 2, None, None))
self.assertEqual(ac_tester.posonly_opt_keywords_opt(1, 2, 3), (1, 2, 3, None))
self.assertEqual(ac_tester.posonly_opt_keywords_opt(1, 2, 3, 4), (1, 2, 3, 4))
with self.assertRaises(TypeError):
ac_tester.posonly_opt_keywords_opt(1, b=2)
self.assertEqual(ac_tester.posonly_opt_keywords_opt(1, 2, c=3), (1, 2, 3, None))
self.assertEqual(ac_tester.posonly_opt_keywords_opt(1, 2, c=3, d=4), (1, 2, 3, 4))
with self.assertRaises(TypeError):
ac_tester.posonly_opt_keywords_opt(a=1, b=2, c=3, d=4)
def test_posonly_kwonly_opt(self):
with self.assertRaises(TypeError):
ac_tester.posonly_kwonly_opt(1)
with self.assertRaises(TypeError):
ac_tester.posonly_kwonly_opt(1, 2)
self.assertEqual(ac_tester.posonly_kwonly_opt(1, b=2), (1, 2, None, None))
self.assertEqual(ac_tester.posonly_kwonly_opt(1, b=2, c=3), (1, 2, 3, None))
self.assertEqual(ac_tester.posonly_kwonly_opt(1, b=2, c=3, d=4), (1, 2, 3, 4))
with self.assertRaises(TypeError):
ac_tester.posonly_kwonly_opt(a=1, b=2, c=3, d=4)
def test_posonly_opt_kwonly_opt(self):
self.assertEqual(ac_tester.posonly_opt_kwonly_opt(1), (1, None, None, None))
self.assertEqual(ac_tester.posonly_opt_kwonly_opt(1, 2), (1, 2, None, None))
with self.assertRaises(TypeError):
ac_tester.posonly_opt_kwonly_opt(1, 2, 3)
with self.assertRaises(TypeError):
ac_tester.posonly_opt_kwonly_opt(1, b=2)
self.assertEqual(ac_tester.posonly_opt_kwonly_opt(1, 2, c=3), (1, 2, 3, None))
self.assertEqual(ac_tester.posonly_opt_kwonly_opt(1, 2, c=3, d=4), (1, 2, 3, 4))
def test_posonly_keywords_kwonly_opt(self):
with self.assertRaises(TypeError):
ac_tester.posonly_keywords_kwonly_opt(1)
with self.assertRaises(TypeError):
ac_tester.posonly_keywords_kwonly_opt(1, 2)
with self.assertRaises(TypeError):
ac_tester.posonly_keywords_kwonly_opt(1, b=2)
with self.assertRaises(TypeError):
ac_tester.posonly_keywords_kwonly_opt(1, 2, 3)
with self.assertRaises(TypeError):
ac_tester.posonly_keywords_kwonly_opt(a=1, b=2, c=3)
self.assertEqual(ac_tester.posonly_keywords_kwonly_opt(1, 2, c=3), (1, 2, 3, None, None))
self.assertEqual(ac_tester.posonly_keywords_kwonly_opt(1, b=2, c=3), (1, 2, 3, None, None))
self.assertEqual(ac_tester.posonly_keywords_kwonly_opt(1, 2, c=3, d=4), (1, 2, 3, 4, None))
self.assertEqual(ac_tester.posonly_keywords_kwonly_opt(1, 2, c=3, d=4, e=5), (1, 2, 3, 4, 5))
def test_posonly_keywords_opt_kwonly_opt(self):
with self.assertRaises(TypeError):
ac_tester.posonly_keywords_opt_kwonly_opt(1)
self.assertEqual(ac_tester.posonly_keywords_opt_kwonly_opt(1, 2), (1, 2, None, None, None))
self.assertEqual(ac_tester.posonly_keywords_opt_kwonly_opt(1, b=2), (1, 2, None, None, None))
with self.assertRaises(TypeError):
ac_tester.posonly_keywords_opt_kwonly_opt(1, 2, 3, 4)
with self.assertRaises(TypeError):
ac_tester.posonly_keywords_opt_kwonly_opt(a=1, b=2)
self.assertEqual(ac_tester.posonly_keywords_opt_kwonly_opt(1, 2, c=3), (1, 2, 3, None, None))
self.assertEqual(ac_tester.posonly_keywords_opt_kwonly_opt(1, b=2, c=3), (1, 2, 3, None, None))
self.assertEqual(ac_tester.posonly_keywords_opt_kwonly_opt(1, 2, 3, d=4), (1, 2, 3, 4, None))
self.assertEqual(ac_tester.posonly_keywords_opt_kwonly_opt(1, 2, c=3, d=4), (1, 2, 3, 4, None))
self.assertEqual(ac_tester.posonly_keywords_opt_kwonly_opt(1, 2, 3, d=4, e=5), (1, 2, 3, 4, 5))
self.assertEqual(ac_tester.posonly_keywords_opt_kwonly_opt(1, 2, c=3, d=4, e=5), (1, 2, 3, 4, 5))
def test_posonly_opt_keywords_opt_kwonly_opt(self):
self.assertEqual(ac_tester.posonly_opt_keywords_opt_kwonly_opt(1), (1, None, None, None))
self.assertEqual(ac_tester.posonly_opt_keywords_opt_kwonly_opt(1, 2), (1, 2, None, None))
with self.assertRaises(TypeError):
ac_tester.posonly_opt_keywords_opt_kwonly_opt(1, b=2)
self.assertEqual(ac_tester.posonly_opt_keywords_opt_kwonly_opt(1, 2, 3), (1, 2, 3, None))
self.assertEqual(ac_tester.posonly_opt_keywords_opt_kwonly_opt(1, 2, c=3), (1, 2, 3, None))
self.assertEqual(ac_tester.posonly_opt_keywords_opt_kwonly_opt(1, 2, 3, d=4), (1, 2, 3, 4))
self.assertEqual(ac_tester.posonly_opt_keywords_opt_kwonly_opt(1, 2, c=3, d=4), (1, 2, 3, 4))
with self.assertRaises(TypeError):
ac_tester.posonly_opt_keywords_opt_kwonly_opt(1, 2, 3, 4)
def test_keyword_only_parameter(self):
with self.assertRaises(TypeError):
ac_tester.keyword_only_parameter()
with self.assertRaises(TypeError):
ac_tester.keyword_only_parameter(1)
self.assertEqual(ac_tester.keyword_only_parameter(a=1), (1,))
if ac_tester is not None:
@repeat_fn(ac_tester.varpos,
ac_tester.varpos_array,
ac_tester.TestClass.varpos_no_fastcall,
ac_tester.TestClass.varpos_array_no_fastcall)
def test_varpos(self, fn):
# fn(*args)
self.assertEqual(fn(), ())
self.assertEqual(fn(1, 2), (1, 2))
@repeat_fn(ac_tester.posonly_varpos,
ac_tester.posonly_varpos_array,
ac_tester.TestClass.posonly_varpos_no_fastcall,
ac_tester.TestClass.posonly_varpos_array_no_fastcall)
def test_posonly_varpos(self, fn):
# fn(a, b, /, *args)
self.assertRaises(TypeError, fn)
self.assertRaises(TypeError, fn, 1)
self.assertRaises(TypeError, fn, 1, b=2)
self.assertEqual(fn(1, 2), (1, 2, ()))
self.assertEqual(fn(1, 2, 3, 4), (1, 2, (3, 4)))
@repeat_fn(ac_tester.posonly_req_opt_varpos,
ac_tester.posonly_req_opt_varpos_array,
ac_tester.TestClass.posonly_req_opt_varpos_no_fastcall,
ac_tester.TestClass.posonly_req_opt_varpos_array_no_fastcall)
def test_posonly_req_opt_varpos(self, fn):
# fn(a, b=False, /, *args)
self.assertRaises(TypeError, fn)
self.assertRaises(TypeError, fn, a=1)
self.assertEqual(fn(1), (1, False, ()))
self.assertEqual(fn(1, 2), (1, 2, ()))
self.assertEqual(fn(1, 2, 3, 4), (1, 2, (3, 4)))
@repeat_fn(ac_tester.posonly_poskw_varpos,
ac_tester.posonly_poskw_varpos_array,
ac_tester.TestClass.posonly_poskw_varpos_no_fastcall,
ac_tester.TestClass.posonly_poskw_varpos_array_no_fastcall)
def test_posonly_poskw_varpos(self, fn):
# fn(a, /, b, *args)
self.assertRaises(TypeError, fn)
self.assertEqual(fn(1, 2), (1, 2, ()))
self.assertEqual(fn(1, b=2), (1, 2, ()))
self.assertEqual(fn(1, 2, 3, 4), (1, 2, (3, 4)))
self.assertRaises(TypeError, fn, b=4)
errmsg = re.escape("given by name ('b') and position (2)")
self.assertRaisesRegex(TypeError, errmsg, fn, 1, 2, 3, b=4)
def test_poskw_varpos(self):
# fn(a, *args)
fn = ac_tester.poskw_varpos
self.assertRaises(TypeError, fn)
self.assertRaises(TypeError, fn, 1, b=2)
self.assertEqual(fn(a=1), (1, ()))
errmsg = re.escape("given by name ('a') and position (1)")
self.assertRaisesRegex(TypeError, errmsg, fn, 1, a=2)
self.assertEqual(fn(1), (1, ()))
self.assertEqual(fn(1, 2, 3, 4), (1, (2, 3, 4)))
def test_poskw_varpos_kwonly_opt(self):
# fn(a, *args, b=False)
fn = ac_tester.poskw_varpos_kwonly_opt
self.assertRaises(TypeError, fn)
errmsg = re.escape("given by name ('a') and position (1)")
self.assertRaisesRegex(TypeError, errmsg, fn, 1, a=2)
self.assertEqual(fn(1, b=2), (1, (), True))
self.assertEqual(fn(1, 2, 3, 4), (1, (2, 3, 4), False))
self.assertEqual(fn(1, 2, 3, 4, b=5), (1, (2, 3, 4), True))
self.assertEqual(fn(a=1), (1, (), False))
self.assertEqual(fn(a=1, b=2), (1, (), True))
def test_poskw_varpos_kwonly_opt2(self):
# fn(a, *args, b=False, c=False)
fn = ac_tester.poskw_varpos_kwonly_opt2
self.assertRaises(TypeError, fn)
errmsg = re.escape("given by name ('a') and position (1)")
self.assertRaisesRegex(TypeError, errmsg, fn, 1, a=2)
self.assertEqual(fn(1, b=2), (1, (), 2, False))
self.assertEqual(fn(1, b=2, c=3), (1, (), 2, 3))
self.assertEqual(fn(1, 2, 3), (1, (2, 3), False, False))
self.assertEqual(fn(1, 2, 3, b=4), (1, (2, 3), 4, False))
self.assertEqual(fn(1, 2, 3, b=4, c=5), (1, (2, 3), 4, 5))
self.assertEqual(fn(a=1), (1, (), False, False))
self.assertEqual(fn(a=1, b=2), (1, (), 2, False))
self.assertEqual(fn(a=1, b=2, c=3), (1, (), 2, 3))
def test_varpos_kwonly_opt(self):
# fn(*args, b=False)
fn = ac_tester.varpos_kwonly_opt
self.assertEqual(fn(), ((), False))
self.assertEqual(fn(b=2), ((), 2))
self.assertEqual(fn(1, b=2), ((1, ), 2))
self.assertEqual(fn(1, 2, 3, 4), ((1, 2, 3, 4), False))
self.assertEqual(fn(1, 2, 3, 4, b=5), ((1, 2, 3, 4), 5))
def test_varpos_kwonly_req_opt(self):
fn = ac_tester.varpos_kwonly_req_opt
self.assertRaises(TypeError, fn)
self.assertEqual(fn(a=1), ((), 1, False, False))
self.assertEqual(fn(a=1, b=2), ((), 1, 2, False))
self.assertEqual(fn(a=1, b=2, c=3), ((), 1, 2, 3))
self.assertRaises(TypeError, fn, 1)
self.assertEqual(fn(1, a=2), ((1,), 2, False, False))
self.assertEqual(fn(1, a=2, b=3), ((1,), 2, 3, False))
self.assertEqual(fn(1, a=2, b=3, c=4), ((1,), 2, 3, 4))
def test_only_group(self):
# fn([a])
fn = ac_tester.only_group
self.assertEqual(fn(), (False, None))
self.assertEqual(fn(1), (True, 1))
self.assertRaises(TypeError, fn, 1, 2)
self.assertRaises(TypeError, fn, a=1)
def test_group_and_opt(self):
# fn([a, b,] c=None)
fn = ac_tester.group_and_opt
self.assertEqual(fn(), (False, None, None, None))
self.assertEqual(fn(1), (False, None, None, 1))
self.assertEqual(fn(1, 2), (True, 1, 2, None))
self.assertEqual(fn(1, 2, 3), (True, 1, 2, 3))
self.assertRaises(TypeError, fn, 1, 2, 3, 4)
self.assertRaises(TypeError, fn, c=1)
def test_group_and_two_opt(self):
# fn([a, b, c,] d=None, e=None)
fn = ac_tester.group_and_two_opt
self.assertEqual(fn(), (False, None, None, None, None, None))
self.assertEqual(fn(1), (False, None, None, None, 1, None))
self.assertEqual(fn(1, 2), (False, None, None, None, 1, 2))
self.assertEqual(fn(1, 2, 3), (True, 1, 2, 3, None, None))
self.assertEqual(fn(1, 2, 3, 4), (True, 1, 2, 3, 4, None))
self.assertEqual(fn(1, 2, 3, 4, 5), (True, 1, 2, 3, 4, 5))
self.assertRaises(TypeError, fn, 1, 2, 3, 4, 5, 6)
def test_two_groups_on_left(self):
# fn([a, b,] [c,] d)
fn = ac_tester.two_groups_on_left
self.assertRaises(TypeError, fn)
self.assertEqual(fn(1), (False, None, None, False, None, 1))
self.assertEqual(fn(1, 2), (False, None, None, True, 1, 2))
self.assertEqual(fn(1, 2, 3), (True, 1, 2, False, None, 3))
self.assertEqual(fn(1, 2, 3, 4), (True, 1, 2, True, 3, 4))
self.assertRaises(TypeError, fn, 1, 2, 3, 4, 5)
def test_two_groups_on_right(self):
# fn(a, [b,] [c, d])
fn = ac_tester.two_groups_on_right
self.assertRaises(TypeError, fn)
self.assertEqual(fn(1), (1, False, None, False, None, None))
self.assertEqual(fn(1, 2), (1, True, 2, False, None, None))
self.assertEqual(fn(1, 2, 3), (1, False, None, True, 2, 3))
self.assertEqual(fn(1, 2, 3, 4), (1, True, 2, True, 3, 4))
self.assertRaises(TypeError, fn, 1, 2, 3, 4, 5)
def test_gh_32092_oob(self):
ac_tester.gh_32092_oob(1, 2, 3, 4, kw1=5, kw2=6)
def test_gh_32092_kw_pass(self):
ac_tester.gh_32092_kw_pass(1, 2, 3)
def test_gh_99233_refcount(self):
arg = '*A unique string is not referenced by anywhere else.*'
arg_refcount_origin = sys.getrefcount(arg)
ac_tester.gh_99233_refcount(arg)
arg_refcount_after = sys.getrefcount(arg)
self.assertEqual(arg_refcount_origin, arg_refcount_after)
def test_gh_99240_double_free(self):
err = re.escape(
"gh_99240_double_free() argument 2 must be encoded string "
"without null bytes, not str"
)
with self.assertRaisesRegex(TypeError, err):
ac_tester.gh_99240_double_free('a', '\0b')
def test_null_or_tuple_for_varargs(self):
# fn(name, *constraints, covariant=False)
fn = ac_tester.null_or_tuple_for_varargs
# All of these should not crash:
self.assertEqual(fn('a'), ('a', (), False))
self.assertEqual(fn('a', 1, 2, 3, covariant=True), ('a', (1, 2, 3), True))
self.assertEqual(fn(name='a'), ('a', (), False))
self.assertEqual(fn(name='a', covariant=True), ('a', (), True))
self.assertEqual(fn(covariant=True, name='a'), ('a', (), True))
self.assertRaises(TypeError, fn, covariant=True)
errmsg = re.escape("given by name ('name') and position (1)")
self.assertRaisesRegex(TypeError, errmsg, fn, 1, name='a')
self.assertRaisesRegex(TypeError, errmsg, fn, 1, 2, 3, name='a', covariant=True)
self.assertRaisesRegex(TypeError, errmsg, fn, 1, 2, 3, covariant=True, name='a')
def test_cloned_func_exception_message(self):
incorrect_arg = -1 # f1() and f2() accept a single str
with self.assertRaisesRegex(TypeError, "clone_f1"):
ac_tester.clone_f1(incorrect_arg)
with self.assertRaisesRegex(TypeError, "clone_f2"):
ac_tester.clone_f2(incorrect_arg)
def test_cloned_func_with_converter_exception_message(self):
for name in "clone_with_conv_f1", "clone_with_conv_f2":
with self.subTest(name=name):
func = getattr(ac_tester, name)
self.assertEqual(func(), name)
def test_get_defining_class(self):
obj = ac_tester.TestClass()
meth = obj.get_defining_class
self.assertIs(obj.get_defining_class(), ac_tester.TestClass)
# 'defining_class' argument is a positional only argument
with self.assertRaises(TypeError):
obj.get_defining_class_arg(cls=ac_tester.TestClass)
check = partial(self.assertRaisesRegex, TypeError, "no arguments")
check(meth, 1)
check(meth, a=1)
def test_get_defining_class_capi(self):
from _testcapi import pyobject_vectorcall
obj = ac_tester.TestClass()
meth = obj.get_defining_class
pyobject_vectorcall(meth, None, None)
pyobject_vectorcall(meth, (), None)
pyobject_vectorcall(meth, (), ())
pyobject_vectorcall(meth, None, ())
self.assertIs(pyobject_vectorcall(meth, (), ()), ac_tester.TestClass)
check = partial(self.assertRaisesRegex, TypeError, "no arguments")
check(pyobject_vectorcall, meth, (1,), None)
check(pyobject_vectorcall, meth, (1,), ("a",))
def test_get_defining_class_arg(self):
obj = ac_tester.TestClass()
self.assertEqual(obj.get_defining_class_arg("arg"),
(ac_tester.TestClass, "arg"))
self.assertEqual(obj.get_defining_class_arg(arg=123),
(ac_tester.TestClass, 123))
# 'defining_class' argument is a positional only argument
with self.assertRaises(TypeError):
obj.get_defining_class_arg(cls=ac_tester.TestClass, arg="arg")
# wrong number of arguments
with self.assertRaises(TypeError):
obj.get_defining_class_arg()
with self.assertRaises(TypeError):
obj.get_defining_class_arg("arg1", "arg2")
def test_defclass_varpos(self):
# fn(*args)
cls = ac_tester.TestClass
obj = cls()
fn = obj.defclass_varpos
self.assertEqual(fn(), (cls, ()))
self.assertEqual(fn(1, 2), (cls, (1, 2)))
fn = cls.defclass_varpos
self.assertRaises(TypeError, fn)
self.assertEqual(fn(obj), (cls, ()))
self.assertEqual(fn(obj, 1, 2), (cls, (1, 2)))
def test_defclass_posonly_varpos(self):
# fn(a, b, /, *args)
cls = ac_tester.TestClass
obj = cls()
fn = obj.defclass_posonly_varpos
errmsg = 'expected at least 2 arguments'
self.assertRaisesRegex(TypeError, errmsg, fn)
self.assertRaisesRegex(TypeError, errmsg, fn, 1)
self.assertEqual(fn(1, 2), (cls, 1, 2, ()))
self.assertEqual(fn(1, 2, 3, 4), (cls, 1, 2, (3, 4)))
fn = cls.defclass_posonly_varpos
self.assertRaises(TypeError, fn)
self.assertRaisesRegex(TypeError, errmsg, fn, obj)
self.assertRaisesRegex(TypeError, errmsg, fn, obj, 1)
self.assertEqual(fn(obj, 1, 2), (cls, 1, 2, ()))
self.assertEqual(fn(obj, 1, 2, 3, 4), (cls, 1, 2, (3, 4)))
def test_depr_star_new(self):
cls = ac_tester.DeprStarNew
cls()
cls(a=None)
self.check_depr_star("'a'", cls, None)
def test_depr_star_new_cloned(self):
fn = ac_tester.DeprStarNew().cloned
fn()
fn(a=None)
self.check_depr_star("'a'", fn, None, name='_testclinic.DeprStarNew.cloned')
def test_depr_star_init(self):
cls = ac_tester.DeprStarInit
cls()
cls(a=None)
self.check_depr_star("'a'", cls, None)
def test_depr_star_init_cloned(self):
fn = ac_tester.DeprStarInit().cloned
fn()
fn(a=None)
self.check_depr_star("'a'", fn, None, name='_testclinic.DeprStarInit.cloned')
def test_depr_star_init_noinline(self):
cls = ac_tester.DeprStarInitNoInline
self.assertRaises(TypeError, cls, "a")
cls(a="a", b="b")
cls(a="a", b="b", c="c")
cls("a", b="b")
cls("a", b="b", c="c")
check = partial(self.check_depr_star, "'b' and 'c'", cls)
check("a", "b")
check("a", "b", "c")
check("a", "b", c="c")
self.assertRaises(TypeError, cls, "a", "b", "c", "d")
def test_depr_kwd_new(self):
cls = ac_tester.DeprKwdNew
cls()
cls(None)
self.check_depr_kwd("'a'", cls, a=None)
def test_depr_kwd_init(self):
cls = ac_tester.DeprKwdInit
cls()
cls(None)
self.check_depr_kwd("'a'", cls, a=None)
def test_depr_kwd_init_noinline(self):
cls = ac_tester.DeprKwdInitNoInline
cls = ac_tester.depr_star_noinline
self.assertRaises(TypeError, cls, "a")
cls(a="a", b="b")
cls(a="a", b="b", c="c")
cls("a", b="b")
cls("a", b="b", c="c")
check = partial(self.check_depr_star, "'b' and 'c'", cls)
check("a", "b")
check("a", "b", "c")
check("a", "b", c="c")
self.assertRaises(TypeError, cls, "a", "b", "c", "d")
def test_depr_star_pos0_len1(self):
fn = ac_tester.depr_star_pos0_len1
fn(a=None)
self.check_depr_star("'a'", fn, "a")
def test_depr_star_pos0_len2(self):
fn = ac_tester.depr_star_pos0_len2
fn(a=0, b=0)
check = partial(self.check_depr_star, "'a' and 'b'", fn)
check("a", b=0)
check("a", "b")
def test_depr_star_pos0_len3_with_kwd(self):
fn = ac_tester.depr_star_pos0_len3_with_kwd
fn(a=0, b=0, c=0, d=0)
check = partial(self.check_depr_star, "'a', 'b' and 'c'", fn)
check("a", b=0, c=0, d=0)
check("a", "b", c=0, d=0)
check("a", "b", "c", d=0)
def test_depr_star_pos1_len1_opt(self):
fn = ac_tester.depr_star_pos1_len1_opt
fn(a=0, b=0)
fn("a", b=0)
fn(a=0) # b is optional
check = partial(self.check_depr_star, "'b'", fn)
check("a", "b")
def test_depr_star_pos1_len1(self):
fn = ac_tester.depr_star_pos1_len1
fn(a=0, b=0)
fn("a", b=0)
check = partial(self.check_depr_star, "'b'", fn)
check("a", "b")
def test_depr_star_pos1_len2_with_kwd(self):
fn = ac_tester.depr_star_pos1_len2_with_kwd
fn(a=0, b=0, c=0, d=0),
fn("a", b=0, c=0, d=0),
check = partial(self.check_depr_star, "'b' and 'c'", fn)
check("a", "b", c=0, d=0),
check("a", "b", "c", d=0),
def test_depr_star_pos2_len1(self):
fn = ac_tester.depr_star_pos2_len1
fn(a=0, b=0, c=0)
fn("a", b=0, c=0)
fn("a", "b", c=0)
check = partial(self.check_depr_star, "'c'", fn)
check("a", "b", "c")
def test_depr_star_pos2_len2(self):
fn = ac_tester.depr_star_pos2_len2
fn(a=0, b=0, c=0, d=0)
fn("a", b=0, c=0, d=0)
fn("a", "b", c=0, d=0)
check = partial(self.check_depr_star, "'c' and 'd'", fn)
check("a", "b", "c", d=0)
check("a", "b", "c", "d")
def test_depr_star_pos2_len2_with_kwd(self):
fn = ac_tester.depr_star_pos2_len2_with_kwd
fn(a=0, b=0, c=0, d=0, e=0)
fn("a", b=0, c=0, d=0, e=0)
fn("a", "b", c=0, d=0, e=0)
check = partial(self.check_depr_star, "'c' and 'd'", fn)
check("a", "b", "c", d=0, e=0)
check("a", "b", "c", "d", e=0)
def test_depr_star_noinline(self):
fn = ac_tester.depr_star_noinline
self.assertRaises(TypeError, fn, "a")
fn(a="a", b="b")
fn(a="a", b="b", c="c")
fn("a", b="b")
fn("a", b="b", c="c")
check = partial(self.check_depr_star, "'b' and 'c'", fn)
check("a", "b")
check("a", "b", "c")
check("a", "b", c="c")
self.assertRaises(TypeError, fn, "a", "b", "c", "d")
def test_depr_star_multi(self):
fn = ac_tester.depr_star_multi
self.assertRaises(TypeError, fn, "a")
fn("a", b="b", c="c", d="d", e="e", f="f", g="g", h="h")
errmsg = (
"Passing more than 1 positional argument to depr_star_multi() is deprecated. "
"Parameter 'b' will become a keyword-only parameter in Python 3.16. "
"Parameters 'c' and 'd' will become keyword-only parameters in Python 3.15. "
"Parameters 'e', 'f' and 'g' will become keyword-only parameters in Python 3.14.")
check = partial(self.check_depr, re.escape(errmsg), fn)
check("a", "b", c="c", d="d", e="e", f="f", g="g", h="h")
check("a", "b", "c", d="d", e="e", f="f", g="g", h="h")
check("a", "b", "c", "d", e="e", f="f", g="g", h="h")
check("a", "b", "c", "d", "e", f="f", g="g", h="h")
check("a", "b", "c", "d", "e", "f", g="g", h="h")
check("a", "b", "c", "d", "e", "f", "g", h="h")
self.assertRaises(TypeError, fn, "a", "b", "c", "d", "e", "f", "g", "h")
def test_depr_kwd_required_1(self):
fn = ac_tester.depr_kwd_required_1
fn("a", "b")
self.assertRaises(TypeError, fn, "a")
self.assertRaises(TypeError, fn, "a", "b", "c")
check = partial(self.check_depr_kwd, "'b'", fn)
check("a", b="b")
self.assertRaises(TypeError, fn, a="a", b="b")
def test_depr_kwd_required_2(self):
fn = ac_tester.depr_kwd_required_2
fn("a", "b", "c")
self.assertRaises(TypeError, fn, "a", "b")
self.assertRaises(TypeError, fn, "a", "b", "c", "d")
check = partial(self.check_depr_kwd, "'b' and 'c'", fn)
check("a", "b", c="c")
check("a", b="b", c="c")
self.assertRaises(TypeError, fn, a="a", b="b", c="c")
def test_depr_kwd_optional_1(self):
fn = ac_tester.depr_kwd_optional_1
fn("a")
fn("a", "b")
self.assertRaises(TypeError, fn)
self.assertRaises(TypeError, fn, "a", "b", "c")
check = partial(self.check_depr_kwd, "'b'", fn)
check("a", b="b")
self.assertRaises(TypeError, fn, a="a", b="b")
def test_depr_kwd_optional_2(self):
fn = ac_tester.depr_kwd_optional_2
fn("a")
fn("a", "b")
fn("a", "b", "c")
self.assertRaises(TypeError, fn)
self.assertRaises(TypeError, fn, "a", "b", "c", "d")
check = partial(self.check_depr_kwd, "'b' and 'c'", fn)
check("a", b="b")
check("a", c="c")
check("a", b="b", c="c")
check("a", c="c", b="b")
check("a", "b", c="c")
self.assertRaises(TypeError, fn, a="a", b="b", c="c")
def test_depr_kwd_optional_3(self):
fn = ac_tester.depr_kwd_optional_3
fn()
fn("a")
fn("a", "b")
fn("a", "b", "c")
self.assertRaises(TypeError, fn, "a", "b", "c", "d")
check = partial(self.check_depr_kwd, "'a', 'b' and 'c'", fn)
check("a", "b", c="c")
check("a", b="b")
check(a="a")
def test_depr_kwd_required_optional(self):
fn = ac_tester.depr_kwd_required_optional
fn("a", "b")
fn("a", "b", "c")
self.assertRaises(TypeError, fn)
self.assertRaises(TypeError, fn, "a")
self.assertRaises(TypeError, fn, "a", "b", "c", "d")
check = partial(self.check_depr_kwd, "'b' and 'c'", fn)
check("a", b="b")
check("a", b="b", c="c")
check("a", c="c", b="b")
check("a", "b", c="c")
self.assertRaises(TypeError, fn, "a", c="c")
self.assertRaises(TypeError, fn, a="a", b="b", c="c")
def test_depr_kwd_noinline(self):
fn = ac_tester.depr_kwd_noinline
fn("a", "b")
fn("a", "b", "c")
self.assertRaises(TypeError, fn, "a")
check = partial(self.check_depr_kwd, "'b' and 'c'", fn)
check("a", b="b")
check("a", b="b", c="c")
check("a", c="c", b="b")
check("a", "b", c="c")
self.assertRaises(TypeError, fn, "a", c="c")
self.assertRaises(TypeError, fn, a="a", b="b", c="c")
def test_depr_kwd_multi(self):
fn = ac_tester.depr_kwd_multi
fn("a", "b", "c", "d", "e", "f", "g", h="h")
errmsg = (
"Passing keyword arguments 'b', 'c', 'd', 'e', 'f' and 'g' to depr_kwd_multi() is deprecated. "
"Parameter 'b' will become positional-only in Python 3.14. "
"Parameters 'c' and 'd' will become positional-only in Python 3.15. "
"Parameters 'e', 'f' and 'g' will become positional-only in Python 3.16.")
check = partial(self.check_depr, re.escape(errmsg), fn)
check("a", "b", "c", "d", "e", "f", g="g", h="h")
check("a", "b", "c", "d", "e", f="f", g="g", h="h")
check("a", "b", "c", "d", e="e", f="f", g="g", h="h")
check("a", "b", "c", d="d", e="e", f="f", g="g", h="h")
check("a", "b", c="c", d="d", e="e", f="f", g="g", h="h")
check("a", b="b", c="c", d="d", e="e", f="f", g="g", h="h")
self.assertRaises(TypeError, fn, a="a", b="b", c="c", d="d", e="e", f="f", g="g", h="h")
def test_depr_multi(self):
fn = ac_tester.depr_multi
self.assertRaises(TypeError, fn, "a", "b", "c", "d", "e", "f", "g")
errmsg = (
"Passing more than 4 positional arguments to depr_multi() is deprecated. "
"Parameter 'e' will become a keyword-only parameter in Python 3.15. "
"Parameter 'f' will become a keyword-only parameter in Python 3.14.")
check = partial(self.check_depr, re.escape(errmsg), fn)
check("a", "b", "c", "d", "e", "f", g="g")
check("a", "b", "c", "d", "e", f="f", g="g")
fn("a", "b", "c", "d", e="e", f="f", g="g")
fn("a", "b", "c", d="d", e="e", f="f", g="g")
errmsg = (
"Passing keyword arguments 'b' and 'c' to depr_multi() is deprecated. "
"Parameter 'b' will become positional-only in Python 3.14. "
"Parameter 'c' will become positional-only in Python 3.15.")
check = partial(self.check_depr, re.escape(errmsg), fn)
check("a", "b", c="c", d="d", e="e", f="f", g="g")
check("a", b="b", c="c", d="d", e="e", f="f", g="g")
self.assertRaises(TypeError, fn, a="a", b="b", c="c", d="d", e="e", f="f", g="g")
def test_alias_pos(self):
fn = ac_tester.alias_pos
self.assertIsNone(fn())
self.assertEqual(fn(1), 1)
self.assertEqual(fn(a=1), 1)
self.assertEqual(fn(b=1), 1)
self.assertEqual(fn.__text_signature__, "($module, /, a=None)")
errmsg = re.escape(
"argument for alias_pos() given by name ('b') and position (1)")
self.assertRaisesRegex(TypeError, errmsg, fn, 1, b=2)
errmsg = re.escape(
"argument for alias_pos() given by name ('b') and name ('a')")
self.assertRaisesRegex(TypeError, errmsg, fn, a=1, b=2)
def test_alias_kwonly(self):
fn = ac_tester.alias_kwonly
self.assertIsNone(fn())
self.assertEqual(fn(a=1), 1)
self.assertEqual(fn(b=1), 1)
self.assertEqual(fn.__text_signature__, "($module, /, *, a=None)")
self.assertRaises(TypeError, fn, 1)
errmsg = re.escape(
"argument for alias_kwonly() given by name ('b') and name ('a')")
self.assertRaisesRegex(TypeError, errmsg, fn, a=1, b=2)
def test_depr_alias(self):
fn = ac_tester.depr_alias
self.assertEqual(fn(1), 1)
self.assertEqual(fn(a=1), 1)
errmsg = ("Passing the argument 'b' to depr_alias() is deprecated. "
"Use 'a' instead. It will be removed in Python 3.14.")
self.check_depr(re.escape(errmsg), fn, b=1)
def test_depr_param(self):
fn = ac_tester.depr_param
self.assertEqual(fn(), (None, None, None, None))
self.assertEqual(fn(1), (1, None, None, None))
def errmsg(name):
return re.escape(f"Passing the argument {name!r} to depr_param() "
f"is deprecated. "
f"It will be removed in Python 3.14.")
self.check_depr(errmsg('b'), fn, 1, 2)
self.check_depr(errmsg('d'), fn, 1, d=4)
# Each deprecated parameter is reported on its own.
with warnings.catch_warnings(record=True) as caught:
warnings.simplefilter("always")
self.assertEqual(fn(1, 2, 3), (1, 2, 3, None))
self.assertEqual(len(caught), 2)
for warning, name in zip(caught, 'bc'):
self.assertIs(warning.category, DeprecationWarning)
self.assertRegex(str(warning.message), errmsg(name))
def test_lone_kwds(self):
with self.assertRaises(TypeError):
ac_tester.lone_kwds(1, 2)
self.assertEqual(ac_tester.lone_kwds(), ({},))
self.assertEqual(ac_tester.lone_kwds(y='y'), ({'y': 'y'},))
kwds = {'y': 'y', 'z': 'z'}
self.assertEqual(ac_tester.lone_kwds(y='y', z='z'), (kwds,))
self.assertEqual(ac_tester.lone_kwds(**kwds), (kwds,))
def test_kwds_with_pos_only(self):
with self.assertRaises(TypeError):
ac_tester.kwds_with_pos_only()
with self.assertRaises(TypeError):
ac_tester.kwds_with_pos_only(y='y')
with self.assertRaises(TypeError):
ac_tester.kwds_with_pos_only(1, y='y')
self.assertEqual(ac_tester.kwds_with_pos_only(1, 2), (1, 2, {}))
self.assertEqual(ac_tester.kwds_with_pos_only(1, 2, y='y'), (1, 2, {'y': 'y'}))
kwds = {'y': 'y', 'z': 'z'}
self.assertEqual(ac_tester.kwds_with_pos_only(1, 2, y='y', z='z'), (1, 2, kwds))
self.assertEqual(ac_tester.kwds_with_pos_only(1, 2, **kwds), (1, 2, kwds))
def test_kwds_with_optional_pos_only(self):
with self.assertRaises(TypeError):
ac_tester.kwds_with_optional_pos_only()
with self.assertRaises(TypeError):
ac_tester.kwds_with_optional_pos_only(y='y')
self.assertEqual(ac_tester.kwds_with_optional_pos_only(1), (1, None, {}))
self.assertEqual(ac_tester.kwds_with_optional_pos_only(1, 2), (1, 2, {}))
self.assertEqual(ac_tester.kwds_with_optional_pos_only(1, y='y'),
(1, None, {'y': 'y'}))
self.assertEqual(ac_tester.kwds_with_optional_pos_only(1, 2, y='y'),
(1, 2, {'y': 'y'}))
def test_kwds_with_stararg(self):
self.assertEqual(ac_tester.kwds_with_stararg(), ((), {}))
self.assertEqual(ac_tester.kwds_with_stararg(1, 2), ((1, 2), {}))
self.assertEqual(ac_tester.kwds_with_stararg(y='y'), ((), {'y': 'y'}))
args = (1, 2)
kwds = {'y': 'y', 'z': 'z'}
self.assertEqual(ac_tester.kwds_with_stararg(1, 2, y='y', z='z'), (args, kwds))
self.assertEqual(ac_tester.kwds_with_stararg(*args, **kwds), (args, kwds))
def test_kwds_with_pos_only_and_stararg(self):
with self.assertRaises(TypeError):
ac_tester.kwds_with_pos_only_and_stararg()
with self.assertRaises(TypeError):
ac_tester.kwds_with_pos_only_and_stararg(y='y')
self.assertEqual(ac_tester.kwds_with_pos_only_and_stararg(1, 2), (1, 2, (), {}))
self.assertEqual(ac_tester.kwds_with_pos_only_and_stararg(1, 2, y='y'), (1, 2, (), {'y': 'y'}))
args = ('lobster', 'thermidor')
kwds = {'y': 'y', 'z': 'z'}
self.assertEqual(ac_tester.kwds_with_pos_only_and_stararg(1, 2, 'lobster', 'thermidor', y='y', z='z'), (1, 2, args, kwds))
self.assertEqual(ac_tester.kwds_with_pos_only_and_stararg(1, 2, *args, **kwds), (1, 2, args, kwds))
@unittest.skipIf(ac_tester is None, "_testclinic is missing")
class VectorcallFunctionalTest(unittest.TestCase):
"""Runtime tests for @vectorcall exemplar types."""
def test_vc_new(self):
self.assertIsInstance(ac_tester.VcNew(), ac_tester.VcNew)
self.assertIsInstance(ac_tester.VcNew(1), ac_tester.VcNew)
self.assertIsInstance(ac_tester.VcNew(a=1), ac_tester.VcNew)
def test_vc_new_rejects_extra_args(self):
with self.assertRaises(TypeError):
ac_tester.VcNew(1, 2)
def test_vc_init(self):
self.assertIsInstance(ac_tester.VcInit(1), ac_tester.VcInit)
self.assertIsInstance(ac_tester.VcInit(1, 2), ac_tester.VcInit)
self.assertIsInstance(ac_tester.VcInit(1, b=2), ac_tester.VcInit)
def test_vc_init_missing_required(self):
with self.assertRaises(TypeError):
ac_tester.VcInit()
def test_vc_init_rejects_a_as_keyword(self):
# 'a' is positional-only
with self.assertRaises(TypeError):
ac_tester.VcInit(a=1)
def test_vc_new_base(self):
self.assertIsInstance(ac_tester.VcNewBase(1), ac_tester.VcNewBase)
self.assertIsInstance(ac_tester.VcNewBase(1, 2), ac_tester.VcNewBase)
self.assertIsInstance(ac_tester.VcNewBase(1, b=2), ac_tester.VcNewBase)
def test_vc_new_base_missing_required(self):
with self.assertRaises(TypeError):
ac_tester.VcNewBase()
def test_vc_new_base_subclass(self):
# tp_vectorcall is not inherited, so the subclass is constructed
# through tp_new. The generated vectorcall asserts on that, so a
# debug build aborts here if that ever stops holding.
Sub = type('Sub', (ac_tester.VcNewBase,), {})
obj = Sub(1)
self.assertIsInstance(obj, Sub)
self.assertIsInstance(obj, ac_tester.VcNewBase)
def test_vc_kwonly(self):
# keyword-only 'b': vectorcall has no kwnames==NULL fast path,
# so every call goes through the helper.
self.assertIsInstance(ac_tester.VcKwOnly(1), ac_tester.VcKwOnly)
self.assertIsInstance(ac_tester.VcKwOnly(1, b=2), ac_tester.VcKwOnly)
self.assertIsInstance(ac_tester.VcKwOnly(a=1, b=2), ac_tester.VcKwOnly)
def test_vc_kwonly_b_as_positional(self):
with self.assertRaises(TypeError):
ac_tester.VcKwOnly(1, 2)
def test_vc_kwonly_missing_required(self):
with self.assertRaises(TypeError):
ac_tester.VcKwOnly()
def test_parse_errors_match_slot(self):
# tp_vectorcall and tp_new/tp_init slot should match in argument parsing
# error messages. Explicit calls to __new__ and __init__, as well as
# subtype calls, will not hit the vectorcall slot. Test errors match.
def error(func, args, kwargs):
try:
func(*args, **kwargs)
except TypeError as exc:
return str(exc)
return None
def through_new(cls):
return cls, partial(cls.__new__, cls)
def through_init(cls):
# Not subclassable, and tp_new is PyType_GenericNew, so reach
# tp_init through the __init__ slot wrapper on an instance.
return cls, partial(cls.__init__, cls(1))
entry_points = [
through_new(enumerate),
through_new(float),
through_new(ac_tester.VcNew),
through_new(ac_tester.VcNewBase),
through_new(ac_tester.VcKwOnly),
through_init(ac_tester.VcInit),
]
invalid_calls = [
((), {}), # too few positional arguments
((1, 2, 3), {}), # too many positional arguments
((), {'zz': 1}), # unknown keyword argument
]
for direct, slot in entry_points:
for args, kwargs in invalid_calls:
with self.subTest(cls=direct, args=args, kwargs=kwargs):
self.assertEqual(error(direct, args, kwargs),
error(slot, args, kwargs))
class LimitedCAPIOutputTests(unittest.TestCase):
def setUp(self):
self.clinic = _make_clinic(limited_capi=True)
@staticmethod
def wrap_clinic_input(block):
return dedent(f"""
/*[clinic input]
output everything buffer
{block}
[clinic start generated code]*/
/*[clinic input]
dump buffer
[clinic start generated code]*/
""")
def test_limited_capi_float(self):
block = self.wrap_clinic_input("""
func
f: float
/
""")
generated = self.clinic.parse(block)
self.assertNotIn("PyFloat_AS_DOUBLE", generated)
self.assertIn("float f;", generated)
self.assertIn("f = (float) PyFloat_AsDouble", generated)
def test_limited_capi_double(self):
block = self.wrap_clinic_input("""
func
f: double
/
""")
generated = self.clinic.parse(block)
self.assertNotIn("PyFloat_AS_DOUBLE", generated)
self.assertIn("double f;", generated)
self.assertIn("f = PyFloat_AsDouble", generated)
def test_limited_capi_alias(self):
block = self.wrap_clinic_input("""
func
a: object = None
*
b as a: object = None
""")
err = ("Parameter 'b' cannot be an alias: "
"the arguments are not parsed one by one.")
_expect_failure(self, self.clinic.parse, block, err)
def test_limited_capi_deprecated(self):
block = self.wrap_clinic_input("""
func
[until 3.14] a: object = None
""")
err = ("Parameter 'a' cannot be deprecated: "
"the arguments are not parsed one by one.")
_expect_failure(self, self.clinic.parse, block, err)
try:
import _testclinic_limited
except ImportError:
_testclinic_limited = None
@unittest.skipIf(_testclinic_limited is None, "_testclinic_limited is missing")
class LimitedCAPIFunctionalTest(unittest.TestCase):
locals().update((name, getattr(_testclinic_limited, name))
for name in dir(_testclinic_limited) if name.startswith('test_'))
def test_my_int_func(self):
with self.assertRaises(TypeError):
_testclinic_limited.my_int_func()
self.assertEqual(_testclinic_limited.my_int_func(3), 3)
with self.assertRaises(TypeError):
_testclinic_limited.my_int_func(1.0)
with self.assertRaises(TypeError):
_testclinic_limited.my_int_func("xyz")
def test_my_int_sum(self):
with self.assertRaises(TypeError):
_testclinic_limited.my_int_sum()
with self.assertRaises(TypeError):
_testclinic_limited.my_int_sum(1)
self.assertEqual(_testclinic_limited.my_int_sum(1, 2), 3)
with self.assertRaises(TypeError):
_testclinic_limited.my_int_sum(1.0, 2)
with self.assertRaises(TypeError):
_testclinic_limited.my_int_sum(1, "str")
def test_my_double_sum(self):
for func in (
_testclinic_limited.my_float_sum,
_testclinic_limited.my_double_sum,
):
with self.subTest(func=func.__name__):
self.assertEqual(func(1.0, 2.5), 3.5)
with self.assertRaises(TypeError):
func()
with self.assertRaises(TypeError):
func(1)
with self.assertRaises(TypeError):
func(1., "2")
def test_get_file_descriptor(self):
# test 'file descriptor' converter: call PyObject_AsFileDescriptor()
get_fd = _testclinic_limited.get_file_descriptor
class MyInt(int):
pass
class MyFile:
def __init__(self, fd):
self._fd = fd
def fileno(self):
return self._fd
for fd in (0, 1, 2, 5, 123_456):
self.assertEqual(get_fd(fd), fd)
myint = MyInt(fd)
self.assertEqual(get_fd(myint), fd)
myfile = MyFile(fd)
self.assertEqual(get_fd(myfile), fd)
with self.assertRaises(OverflowError):
get_fd(2**256)
with self.assertWarnsRegex(RuntimeWarning,
"bool is used as a file descriptor"):
get_fd(True)
with self.assertRaises(TypeError):
get_fd(1.0)
with self.assertRaises(TypeError):
get_fd("abc")
with self.assertRaises(TypeError):
get_fd(None)
class PermutationTests(unittest.TestCase):
"""Test permutation support functions."""
def test_permute_left_option_groups(self):
expected = (
(),
(3,),
(2, 3),
(1, 2, 3),
)
data = list(zip([1, 2, 3])) # Generate a list of 1-tuples.
actual = tuple(permute_left_option_groups(data))
self.assertEqual(actual, expected)
def test_permute_right_option_groups(self):
expected = (
(),
(1,),
(1, 2),
(1, 2, 3),
)
data = list(zip([1, 2, 3])) # Generate a list of 1-tuples.
actual = tuple(permute_right_option_groups(data))
self.assertEqual(actual, expected)
def test_permute_optional_groups(self):
empty = {
"left": (), "required": (), "right": (),
"expected": ((),),
}
noleft1 = {
"left": (), "required": ("b",), "right": (("c",),),
"expected": (
("b",),
("b", "c"),
),
}
noleft2 = {
"left": (), "required": ("b", "c",), "right": (("d",),),
"expected": (
("b", "c"),
("b", "c", "d"),
),
}
noleft3 = {
"left": (), "required": ("b", "c",), "right": (("d", "e"),),
"expected": (
("b", "c"),
("b", "c", "d"),
("b", "c", "d", "e"),
),
}
noright1 = {
"left": (("a",),), "required": ("b",), "right": (),
"expected": (
("b",),
("a", "b"),
),
}
noright2 = {
"left": (("a",),), "required": ("b", "c"), "right": (),
"expected": (
("b", "c"),
("a", "b", "c"),
),
}
noright3 = {
"left": (("a", "b"),), "required": ("c",), "right": (),
"expected": (
("c",),
("b", "c"),
("a", "b", "c"),
),
}
leftandright1 = {
"left": (("a",),), "required": ("b",), "right": (("c",),),
"expected": (
("b",),
("a", "b"), # Prefer left.
("a", "b", "c"),
),
}
leftandright2 = {
"left": (("a", "b"),), "required": ("c", "d"), "right": (("e", "f"),),
"expected": (
("c", "d"),
("b", "c", "d"), # Prefer left.
("a", "b", "c", "d"), # Prefer left.
("a", "b", "c", "d", "e"),
("a", "b", "c", "d", "e", "f"),
),
}
independentleft = {
"left": (("a",), ("b",)), "required": ("c",), "right": (),
"expected": (
("c",),
("b", "c"),
("a", "b", "c"),
),
}
independentright = {
"left": (), "required": ("a",), "right": (("b",), ("c",)),
"expected": (
("a",),
("a", "b"),
("a", "b", "c"),
),
}
dataset = (
empty,
noleft1, noleft2, noleft3,
noright1, noright2, noright3,
leftandright1, leftandright2,
independentleft, independentright,
)
for params in dataset:
with self.subTest(**params):
left, required, right, expected = params.values()
permutations = permute_optional_groups(left, required, right)
actual = tuple(permutations)
self.assertEqual(actual, expected)
class FormatHelperTests(unittest.TestCase):
def test_strip_leading_and_trailing_blank_lines(self):
dataset = (
# Input lines, expected output.
("a\nb", "a\nb"),
("a\nb\n", "a\nb"),
("a\nb ", "a\nb"),
("\na\nb\n\n", "a\nb"),
("\n\na\nb\n\n", "a\nb"),
("\n\na\n\nb\n\n", "a\n\nb"),
# Note, leading whitespace is preserved:
(" a\nb", " a\nb"),
(" a\nb ", " a\nb"),
(" \n \n a\nb \n \n ", " a\nb"),
)
for lines, expected in dataset:
with self.subTest(lines=lines, expected=expected):
out = libclinic.normalize_snippet(lines)
self.assertEqual(out, expected)
def test_normalize_snippet(self):
snippet = """
one
two
three
"""
# Expected outputs:
zero_indent = (
"one\n"
"two\n"
"three"
)
four_indent = (
" one\n"
" two\n"
" three"
)
eight_indent = (
" one\n"
" two\n"
" three"
)
expected_outputs = {0: zero_indent, 4: four_indent, 8: eight_indent}
for indent, expected in expected_outputs.items():
with self.subTest(indent=indent):
actual = libclinic.normalize_snippet(snippet, indent=indent)
self.assertEqual(actual, expected)
def test_escaped_docstring(self):
dataset = (
# input, expected
(r"abc", r'"abc"'),
(r"\abc", r'"\\abc"'),
(r"\a\bc", r'"\\a\\bc"'),
(r"\a\\bc", r'"\\a\\\\bc"'),
(r'"abc"', r'"\"abc\""'),
(r"'a'", r'"\'a\'"'),
)
for line, expected in dataset:
with self.subTest(line=line, expected=expected):
out = libclinic.docstring_for_c_string(line)
self.assertEqual(out, expected)
def test_format_escape(self):
line = "{}, {a}"
expected = "{{}}, {{a}}"
out = libclinic.format_escape(line)
self.assertEqual(out, expected)
def test_c_bytes_repr(self):
c_bytes_repr = libclinic.c_bytes_repr
self.assertEqual(c_bytes_repr(b''), '""')
self.assertEqual(c_bytes_repr(b'abc'), '"abc"')
self.assertEqual(c_bytes_repr(b'\a\b\f\n\r\t\v'), r'"\a\b\f\n\r\t\v"')
self.assertEqual(c_bytes_repr(b' \0\x7f'), r'" \000\177"')
self.assertEqual(c_bytes_repr(b'"'), r'"\""')
self.assertEqual(c_bytes_repr(b"'"), r'''"'"''')
self.assertEqual(c_bytes_repr(b'\\'), r'"\\"')
self.assertEqual(c_bytes_repr(b'??/'), r'"?\?/"')
self.assertEqual(c_bytes_repr(b'???/'), r'"?\?\?/"')
self.assertEqual(c_bytes_repr(b'/*****/ /*/ */*'), r'"/\*****\/ /\*\/ *\/\*"')
self.assertEqual(c_bytes_repr(b'\xa0'), r'"\240"')
self.assertEqual(c_bytes_repr(b'\xff'), r'"\377"')
def test_c_str_repr(self):
c_str_repr = libclinic.c_str_repr
self.assertEqual(c_str_repr(''), '""')
self.assertEqual(c_str_repr('abc'), '"abc"')
self.assertEqual(c_str_repr('\a\b\f\n\r\t\v'), r'"\a\b\f\n\r\t\v"')
self.assertEqual(c_str_repr(' \0\x7f'), r'" \000\177"')
self.assertEqual(c_str_repr('"'), r'"\""')
self.assertEqual(c_str_repr("'"), r'''"'"''')
self.assertEqual(c_str_repr('\\'), r'"\\"')
self.assertEqual(c_str_repr('??/'), r'"?\?/"')
self.assertEqual(c_str_repr('???/'), r'"?\?\?/"')
self.assertEqual(c_str_repr('/*****/ /*/ */*'), r'"/\*****\/ /\*\/ *\/\*"')
self.assertEqual(c_str_repr('\xa0'), r'"\u00a0"')
self.assertEqual(c_str_repr('\xff'), r'"\u00ff"')
self.assertEqual(c_str_repr('\u20ac'), r'"\u20ac"')
self.assertEqual(c_str_repr('\U0001f40d'), r'"\U0001f40d"')
def test_c_unichar_repr(self):
c_unichar_repr = libclinic.c_unichar_repr
self.assertEqual(c_unichar_repr('a'), "'a'")
self.assertEqual(c_unichar_repr('\n'), r"'\n'")
self.assertEqual(c_unichar_repr('\b'), r"'\b'")
self.assertEqual(c_unichar_repr('\0'), '0')
self.assertEqual(c_unichar_repr('\1'), '0x01')
self.assertEqual(c_unichar_repr('\x7f'), '0x7f')
self.assertEqual(c_unichar_repr(' '), "' '")
self.assertEqual(c_unichar_repr('"'), """'"'""")
self.assertEqual(c_unichar_repr("'"), r"'\''")
self.assertEqual(c_unichar_repr('\\'), r"'\\'")
self.assertEqual(c_unichar_repr('?'), "'?'")
self.assertEqual(c_unichar_repr('\xa0'), '0xa0')
self.assertEqual(c_unichar_repr('\xff'), '0xff')
self.assertEqual(c_unichar_repr('\u20ac'), '0x20ac')
self.assertEqual(c_unichar_repr('\U0001f40d'), '0x1f40d')
def test_indent_all_lines(self):
# Blank lines are expected to be unchanged.
self.assertEqual(libclinic.indent_all_lines("", prefix="bar"), "")
lines = (
"one\n"
"two" # The missing newline is deliberate.
)
expected = (
"barone\n"
"bartwo"
)
out = libclinic.indent_all_lines(lines, prefix="bar")
self.assertEqual(out, expected)
# If last line is empty, expect it to be unchanged.
lines = (
"\n"
"one\n"
"two\n"
""
)
expected = (
"bar\n"
"barone\n"
"bartwo\n"
""
)
out = libclinic.indent_all_lines(lines, prefix="bar")
self.assertEqual(out, expected)
def test_suffix_all_lines(self):
# Blank lines are expected to be unchanged.
self.assertEqual(libclinic.suffix_all_lines("", suffix="foo"), "")
lines = (
"one\n"
"two" # The missing newline is deliberate.
)
expected = (
"onefoo\n"
"twofoo"
)
out = libclinic.suffix_all_lines(lines, suffix="foo")
self.assertEqual(out, expected)
# If last line is empty, expect it to be unchanged.
lines = (
"\n"
"one\n"
"two\n"
""
)
expected = (
"foo\n"
"onefoo\n"
"twofoo\n"
""
)
out = libclinic.suffix_all_lines(lines, suffix="foo")
self.assertEqual(out, expected)
class ClinicReprTests(unittest.TestCase):
def test_Block_repr(self):
block = Block("foo")
expected_repr = "<clinic.Block 'text' input='foo' output=None>"
self.assertEqual(repr(block), expected_repr)
block2 = Block("bar", "baz", [], "eggs", "spam")
expected_repr_2 = "<clinic.Block 'baz' input='bar' output='eggs'>"
self.assertEqual(repr(block2), expected_repr_2)
block3 = Block(
input="longboi_" * 100,
dsl_name="wow_so_long",
signatures=[],
output="very_long_" * 100,
indent=""
)
expected_repr_3 = (
"<clinic.Block 'wow_so_long' input='longboi_longboi_longboi_l...' output='very_long_very_long_very_...'>"
)
self.assertEqual(repr(block3), expected_repr_3)
def test_Destination_repr(self):
c = _make_clinic()
destination = Destination(
"foo", type="file", clinic=c, args=("eggs",)
)
self.assertEqual(
repr(destination), "<clinic.Destination 'foo' type='file' file='eggs'>"
)
destination2 = Destination("bar", type="buffer", clinic=c)
self.assertEqual(repr(destination2), "<clinic.Destination 'bar' type='buffer'>")
def test_Module_repr(self):
module = Module("foo", _make_clinic())
self.assertRegex(repr(module), r"<clinic.Module 'foo' at \d+>")
def test_Class_repr(self):
cls = Class("foo", _make_clinic(), None, 'some_typedef', 'some_type_object')
self.assertRegex(repr(cls), r"<clinic.Class 'foo' at \d+>")
def test_FunctionKind_repr(self):
self.assertEqual(
repr(FunctionKind.CLASS_METHOD), "<clinic.FunctionKind.CLASS_METHOD>"
)
def test_Function_and_Parameter_reprs(self):
function = Function(
name='foo',
module=_make_clinic(),
cls=None,
c_basename=None,
full_name='foofoo',
return_converter=int_return_converter(),
kind=FunctionKind.METHOD_INIT,
coexist=False
)
self.assertEqual(repr(function), "<clinic.Function 'foo'>")
converter = self_converter('bar', 'bar', function)
parameter = Parameter(
"bar",
kind=inspect.Parameter.POSITIONAL_OR_KEYWORD,
function=function,
converter=converter
)
self.assertEqual(repr(parameter), "<clinic.Parameter 'bar'>")
def test_Monitor_repr(self):
monitor = libclinic.cpp.Monitor("test.c")
self.assertRegex(repr(monitor), r"<clinic.Monitor \d+ line=0 condition=''>")
monitor.line_number = 42
monitor.stack.append(("token1", "condition1"))
self.assertRegex(
repr(monitor), r"<clinic.Monitor \d+ line=42 condition='condition1'>"
)
monitor.stack.append(("token2", "condition2"))
self.assertRegex(
repr(monitor),
r"<clinic.Monitor \d+ line=42 condition='condition1 && condition2'>"
)
if __name__ == "__main__":
unittest.main()