cpython/Tools/clinic/clinic_test.py at pythoncapi · pythoncapi/cpython · GitHub

History

791 lines (678 loc) · 20.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

# Argument Clinic

# Licensed to the PSF under a contributor agreement.

import clinic

from clinic import DSLParser

import collections

import inspect

from test import support

import sys

import unittest

from unittest import TestCase

class FakeConverter:

def __init__(self, name, args):

self.name = name

self.args = args

class FakeConverterFactory:

def __init__(self, name):

self.name = name

def __call__(self, name, default, **kwargs):

return FakeConverter(self.name, kwargs)

class FakeConvertersDict:

def __init__(self):

self.used_converters = {}

def get(self, name, default):

return self.used_converters.setdefault(name, FakeConverterFactory(name))

clinic.Clinic.presets_text = ''

c = clinic.Clinic(language='C')

class FakeClinic:

def __init__(self):

self.converters = FakeConvertersDict()

self.legacy_converters = FakeConvertersDict()

self.language = clinic.CLanguage(None)

self.filename = None

self.block_parser = clinic.BlockParser('', self.language)

self.modules = collections.OrderedDict()

self.classes = collections.OrderedDict()

clinic.clinic = self

self.name = "FakeClinic"

self.line_prefix = self.line_suffix = ''

self.destinations = {}

self.add_destination("block", "buffer")

self.add_destination("file", "buffer")

self.add_destination("suppress", "suppress")

d = self.destinations.get

self.field_destinations = collections.OrderedDict((

('docstring_prototype', d('suppress')),

('docstring_definition', d('block')),

('methoddef_define', d('block')),

('impl_prototype', d('block')),

('parser_prototype', d('suppress')),

('parser_definition', d('block')),

('impl_definition', d('block')),

))

def get_destination(self, name):

d = self.destinations.get(name)

if not d:

sys.exit("Destination does not exist: " + repr(name))

return d

def add_destination(self, name, type, *args):

if name in self.destinations:

sys.exit("Destination already exists: " + repr(name))

self.destinations[name] = clinic.Destination(name, type, self, *args)

def is_directive(self, name):

return name == "module"

def directive(self, name, args):

self.called_directives[name] = args

_module_and_class = clinic.Clinic._module_and_class

class ClinicWholeFileTest(TestCase):

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.

c = clinic.Clinic(clinic.CLanguage(None))

raw = "/*[clinic]\nfoo\n[clinic]*/"

cooked = c.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]*/")

class ClinicGroupPermuterTest(TestCase):

def _test(self, l, m, r, output):

computed = clinic.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_have_left_options_but_required_is_empty(self):

def fn():

clinic.permute_optional_groups(['a'], [], [])

self.assertRaises(AssertionError, fn)

class ClinicLinearFormatTest(TestCase):

def _test(self, input, output, **kwargs):

computed = clinic.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')

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 = clinic.CLanguage(None)

blocks = list(clinic.BlockParser(input, language))

writer = clinic.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 = clinic.CLanguage(None)

c = clinic.Clinic(language)

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 test_trivial(self):

parser = DSLParser(FakeClinic())

block = clinic.Block("module os\nos.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("#\nmodule os\nos.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\nos.access\n 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, clinic.int_converter)

def test_param_default(self):

function = self.parse_function("module os\nos.access\n follow_symlinks: bool = True")

p = function.parameters['follow_symlinks']

self.assertEqual(True, p.default)

def test_param_with_continuations(self):

function = self.parse_function("module os\nos.access\n follow_symlinks: \\\n bool \\\n =\\\n True")

p = function.parameters['follow_symlinks']

self.assertEqual(True, p.default)

def test_param_default_expression(self):

function = self.parse_function("module os\nos.access\n 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)

s = self.parse_function_should_fail("module os\nos.access\n follow_symlinks: int = sys.maxsize")

self.assertEqual(s, "Error on line 0:\nWhen you specify a named constant ('sys.maxsize') as your default value,\nyou MUST specify a valid c_default.\n")

def test_param_no_docstring(self):

function = self.parse_function("""

module os

os.access

follow_symlinks: bool = True

something_else: str = ''""")

p = function.parameters['follow_symlinks']

self.assertEqual(3, len(function.parameters))

self.assertIsInstance(function.parameters['something_else'].converter, clinic.str_converter)

def test_param_default_parameters_out_of_order(self):

s = self.parse_function_should_fail("""

module os

os.access

follow_symlinks: bool = True

something_else: str""")

self.assertEqual(s, """Error on line 0:

Can't have a parameter without a default ('something_else')

after a parameter with a default!

""")

def disabled_test_converter_arguments(self):

function = self.parse_function("module os\nos.access\n 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

Perform a stat system call on the given path.""")

self.assertEqual("""

stat($module, /, path)

Perform a stat system call on the given path.

path

Path to be examined

""".strip(), function.docstring)

def test_explicit_parameters_in_docstring(self):

function = self.parse_function("""

module foo

foo.bar

x: int

Documentation for x.

y: int

This is the documentation for foo.

Okay, we're done here.

""")

self.assertEqual("""

bar($module, /, x, y)

This is the documentation for foo.

Documentation for x.

Okay, we're done here.

""".strip(), function.docstring)

def test_parser_regression_special_character_in_parameter_column_of_docstring_first_line(self):

function = self.parse_function("""

module os

os.stat

path: str

This/used to break Clinic!

""")

self.assertEqual("stat($module, /, path)\n--\n\nThis/used to break Clinic!", function.docstring)

def test_c_name(self):

function = self.parse_function("module os\nos.stat as os_stat_fn")

self.assertEqual("os_stat_fn", function.c_basename)

def test_return_converter(self):

function = self.parse_function("module os\nos.stat -> int")

self.assertIsInstance(function.return_converter, clinic.int_return_converter)

def test_star(self):

function = self.parse_function("module os\nos.access\n *\n 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\nwindow.border\n [\n ls : int\n ]\n /\n")

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.

]

""")

for name, group in (

('y', -1), ('x', -1),

('ch', 0),

('attr', 1),

p = function.parameters[name]

self.assertEqual(p.group, group)

self.assertEqual(p.kind, inspect.Parameter.POSITIONAL_ONLY)

self.assertEqual(function.docstring.strip(), """

addch([y, x,] ch, [attr])

Y-coordinate.

X-coordinate.

Character to add.

attr

Attributes for the character.

""".strip())

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.

]

""")

for name, group in (

('y1', -2), ('y2', -2),

('x1', -1), ('x2', -1),

('ch', 0),

('attr1', 1), ('attr2', 1), ('attr3', 1),

('attr4', 2), ('attr5', 2), ('attr6', 2),

p = function.parameters[name]

self.assertEqual(p.group, group)

self.assertEqual(p.kind, inspect.Parameter.POSITIONAL_ONLY)

self.assertEqual(function.docstring.strip(), """

imaginary([[y1, y2,] x1, x2,] ch, [attr1, attr2, attr3, [attr4, attr5,

attr6]])

Y-coordinate.

X-coordinate.

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.

""".strip())

def parse_function_should_fail(self, s):

with support.captured_stdout() as stdout:

with self.assertRaises(SystemExit):

self.parse_function(s)

return stdout.getvalue()

def test_disallowed_grouping__two_top_groups_on_left(self):

s = self.parse_function_should_fail("""

module foo

foo.two_top_groups_on_left

[

group1 : int

]

[

group2 : int

]

param: int

""")

self.assertEqual(s,

('Error on line 0:\n'

'Function two_top_groups_on_left has an unsupported group configuration. (Unexpected state 2.b)\n'))

def test_disallowed_grouping__two_top_groups_on_right(self):

self.parse_function_should_fail("""

module foo

foo.two_top_groups_on_right

param: int

[

group1 : int

]

[

group2 : int

]

""")

def test_disallowed_grouping__parameter_after_group_on_right(self):

self.parse_function_should_fail("""

module foo

foo.parameter_after_group_on_right

param: int

[

group1 : int

]

group2 : int

]

""")

def test_disallowed_grouping__group_after_parameter_on_left(self):

self.parse_function_should_fail("""

module foo

foo.group_after_parameter_on_left

[

group2 : int

[

group1 : int

]

param: int

""")

def test_disallowed_grouping__empty_group_on_left(self):

self.parse_function_should_fail("""

module foo

foo.empty_group

[

]

group2 : int

]

param: int

""")

def test_disallowed_grouping__empty_group_on_right(self):

self.parse_function_should_fail("""

module foo

foo.empty_group

param: int

[

]

group2 : int

]

""")

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):

self.parse_function_should_fail("""

module foo

foo.bar => int

""")

def test_illegal_c_basename(self):

self.parse_function_should_fail("""

module foo

foo.bar as 935

""")

def test_single_star(self):

self.parse_function_should_fail("""

module foo

foo.bar

""")

def test_parameters_required_after_star_without_initial_parameters_or_docstring(self):

self.parse_function_should_fail("""

module foo

foo.bar

""")

def test_parameters_required_after_star_without_initial_parameters_with_docstring(self):

self.parse_function_should_fail("""

module foo

foo.bar

Docstring here.

""")

def test_parameters_required_after_star_with_initial_parameters_without_docstring(self):

self.parse_function_should_fail("""

module foo

foo.bar

this: int

""")

def test_parameters_required_after_star_with_initial_parameters_and_docstring(self):

self.parse_function_should_fail("""

module foo

foo.bar

this: int

Docstring.

""")

def test_single_slash(self):

self.parse_function_should_fail("""

module foo

foo.bar

""")

def test_mix_star_and_slash(self):

self.parse_function_should_fail("""

module foo

foo.bar

x: int

y: int

z: int

""")

def test_parameters_not_permitted_after_slash_for_now(self):

self.parse_function_should_fail("""

module foo

foo.bar

x: int

""")

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.assertEqual("""

bar($module, /, x, *, y)

Not at column 0!

Nested docstring here, goeth.

""".strip(), function.docstring)

def test_directive(self):

c = FakeClinic()

parser = DSLParser(c)

parser.flag = False

parser.directives['setflag'] = lambda : setattr(parser, 'flag', True)

block = clinic.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

self.assertIsInstance((function.parameters['path']).converter, clinic.str_converter)

def parse(self, text):

c = FakeClinic()

parser = DSLParser(c)

block = clinic.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], clinic.Module)

assert isinstance(s[function_index], clinic.Function)

return s[function_index]

def test_scaffolding(self):

# test repr on special values

self.assertEqual(repr(clinic.unspecified), '<Unspecified>')

self.assertEqual(repr(clinic.NULL), '<Null>')

# test that fail fails

with support.captured_stdout() as stdout:

with self.assertRaises(SystemExit):

clinic.fail('The igloos are melting!', filename='clown.txt', line_number=69)

self.assertEqual(stdout.getvalue(), 'Error in file "clown.txt" on line 69:\nThe igloos are melting!\n')

if __name__ == "__main__":

unittest.main()

cpython/Tools/clinic/clinic_test.py at pythoncapi · pythoncapi/cpython · GitHub

Uh oh!

Expand file tree

Breadcrumbs

clinic_test.py

Latest commit

History

Breadcrumbs

clinic_test.py

File metadata and controls