Thanks to visit codestin.com
Credit goes to github.com

Skip to content

gh-76785: Add More Tests to test_interpreters.test_api #117662

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericsnowcurrently merged 28 commits into from
Apr 11, 2024
Merged

gh-76785: Add More Tests to test_interpreters.test_api #117662

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
bdd8d70
InterpreterError inherits from Exception.
ericsnowcurrently Apr 8, 2024
940f24d
Add _PyInterpreterState_GetIDObject().
ericsnowcurrently Apr 5, 2024
528c6e3
Add _PyXI_NewInterpreter() and _PyXI_EndInterpreter().
ericsnowcurrently Apr 5, 2024
0bd2e6b
Add _testinternalcapi.next_interpreter_id().
ericsnowcurrently Apr 1, 2024
76e32cd
Add _testinternalcapi.exec_interpreter().
ericsnowcurrently Apr 8, 2024
9b7bdc4
Sketch out tests.
ericsnowcurrently Mar 22, 2024
fa28f9b
Flesh out the tests.
ericsnowcurrently Mar 27, 2024
5e31f6e
Add PipeEnd.
ericsnowcurrently Mar 28, 2024
9111a83
Refactor _captured_script().
ericsnowcurrently Mar 28, 2024
0c24e5c
Finish the tests.
ericsnowcurrently Mar 28, 2024
611fa31
Add missing tests.
ericsnowcurrently Apr 1, 2024
bdc09f9
Add more capture/exec helpers.
ericsnowcurrently Apr 8, 2024
be85ff5
Fill out the tests.
ericsnowcurrently Apr 8, 2024
51f18f8
Adjust the tests.
ericsnowcurrently Apr 8, 2024
b1f96d2
Fix clean_up_interpreters().
ericsnowcurrently Apr 9, 2024
cd61643
Fix test_capi.test_misc.
ericsnowcurrently Apr 9, 2024
7de523d
external/unmanaged -> from_capi
ericsnowcurrently Apr 9, 2024
11d38ab
Add a missing decorator.
ericsnowcurrently Apr 9, 2024
1cf31b6
Fix other tests.
ericsnowcurrently Apr 9, 2024
4421169
Fix test_capi.
ericsnowcurrently Apr 9, 2024
c75a115
Add _interpreters.capture_exception().
ericsnowcurrently Apr 9, 2024
b00476d
Raise ExecutionFailed when possible.
ericsnowcurrently Apr 9, 2024
6a82a33
Handle OSError in the _running() script.
ericsnowcurrently Apr 9, 2024
11dae3d
Add PyInterpreterState._whence.
ericsnowcurrently Apr 10, 2024
7c9a2b9
Fix up _testinternalcapi.
ericsnowcurrently Apr 10, 2024
e68654c
Add PyInterpreterState.initialized.
ericsnowcurrently Apr 10, 2024
175080c
Add tests for whence.
ericsnowcurrently Apr 10, 2024
9db5a2b
Set interp-_ready on the main interpreter.
ericsnowcurrently Apr 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Raise ExecutionFailed when possible.
  • Loading branch information
@ericsnowcurrently
ericsnowcurrently committed Apr 9, 2024
commit b00476d579a4d3d26e87c3a15ea5dd03fa7c4dc5
53 changes: 25 additions & 28 deletions Lib/test/test_interpreters/test_api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,12 +169,11 @@ def test_created_with_capi(self):
for id, *_ in _interpreters.list_all():
last = max(last, id)
expected = _testinternalcapi.next_interpreter_id()
err, text = self.run_temp_from_capi(f"""
text = self.run_temp_from_capi(f"""
import {interpreters.__name__} as interpreters
interp = interpreters.get_current()
print(interp.id)
""")
assert err is None, err
interpid = eval(text)
self.assertEqual(interpid, expected)

Expand Down Expand Up @@ -236,13 +235,12 @@ def test_created_with_capi(self):
(interpid5,),
]
expected2 = expected[:-2]
err, text = self.run_temp_from_capi(f"""
text = self.run_temp_from_capi(f"""
import {interpreters.__name__} as interpreters
interp = interpreters.create()
print(
[(i.id,) for i in interpreters.list_all()])
""")
assert err is None, err
res = eval(text)
res2 = [(i.id,) for i in interpreters.list_all()]
self.assertEqual(res, expected)
Expand Down Expand Up @@ -393,8 +391,7 @@ def test_created_with_capi(self):
interp = interpreters.get_current()
print(interp.is_running())
""")
def resolve_results(err, text):
assert err is None, err
def parse_results(text):
self.assertNotEqual(text, "")
try:
return eval(text)
Expand All @@ -403,13 +400,13 @@ def resolve_results(err, text):

with self.subTest('running __main__ (from self)'):
with self.interpreter_from_capi() as interpid:
err, text = self.run_from_capi(interpid, script, main=True)
running = resolve_results(err, text)
text = self.run_from_capi(interpid, script, main=True)
running = parse_results(text)
self.assertTrue(running)

with self.subTest('running, but not __main__ (from self)'):
err, text = self.run_temp_from_capi(script)
running = resolve_results(err, text)
text = self.run_temp_from_capi(script)
running = parse_results(text)
self.assertFalse(running)

with self.subTest('running __main__ (from other)'):
Expand Down Expand Up @@ -566,20 +563,17 @@ def test_created_with_capi(self):
interp = interpreters.get_current()
interp.close()
""")
def check_results(err, text):
self.assertIsNot(err, None)
self.assertEqual(err.type.__name__, 'InterpreterError')
self.assertIn('current', err.msg)
self.assertEqual(text, '')

with self.subTest('running __main__ (from self)'):
with self.interpreter_from_capi() as interpid:
err, text = self.run_from_capi(interpid, script, main=True)
check_results(err, text)
with self.assertRaisesRegex(ExecutionFailed,
'InterpreterError.*current'):
self.run_from_capi(interpid, script, main=True)

with self.subTest('running, but not __main__ (from self)'):
err, text = self.run_temp_from_capi(script)
check_results(err, text)
with self.assertRaisesRegex(ExecutionFailed,
'InterpreterError.*current'):
self.run_temp_from_capi(script)

with self.subTest('running __main__ (from other)'):
with self.interpreter_obj_from_capi() as (interp, interpid):
Expand Down Expand Up @@ -691,7 +685,9 @@ def test_success(self):
script, results = _captured_script('print("it worked!", end="")')
with results:
interp.exec(script)
out = results.stdout()
results = results.final()
results.raise_if_failed()
out = results.stdout

self.assertEqual(out, 'it worked!')

Expand Down Expand Up @@ -758,7 +754,9 @@ def f():
t = threading.Thread(target=f)
t.start()
t.join()
out = results.stdout()
results = results.final()
results.raise_if_failed()
out = results.stdout

self.assertEqual(out, 'it worked!')

Expand Down Expand Up @@ -1278,8 +1276,7 @@ def parse_stdout(text):
for id, *_ in _interpreters.list_all():
last = max(last, id)
expected = last + 1
err, text = self.run_temp_from_capi(script)
assert err is None, err
text = self.run_temp_from_capi(script)
interpid, = parse_stdout(text)
self.assertEqual(interpid, expected)

Expand Down Expand Up @@ -1319,13 +1316,12 @@ def test_list_all(self):
expected3 = expected + [
(interpid5,),
]
err, text = self.run_temp_from_capi(f"""
text = self.run_temp_from_capi(f"""
import {_interpreters.__name__} as _interpreters
_interpreters.create()
print(
_interpreters.list_all())
""")
assert err is None, err
res2 = eval(text)
res3 = _interpreters.list_all()
self.assertEqual(res2, expected2)
Expand Down Expand Up @@ -1483,8 +1479,9 @@ def test_exec(self):
script, results = _captured_script('print("it worked!", end="")')
with results:
exc = _interpreters.exec(interpid, script)
out = results.stdout()
self.assertIs(exc, None)
results = results.final()
results.raise_if_failed()
out = results.stdout
self.assertEqual(out, 'it worked!')

with self.subTest('uncaught exception'):
Expand All @@ -1497,7 +1494,7 @@ def test_exec(self):
exc = _interpreters.exec(interpid, script)
out = results.stdout()
self.assertEqual(out, '')
self.assertEqual(exc, types.SimpleNamespace(
self.assert_ns_equal(exc, types.SimpleNamespace(
type=types.SimpleNamespace(
__name__='Exception',
__qualname__='Exception',
Expand Down
75 changes: 45 additions & 30 deletions Lib/test/test_interpreters/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,28 @@ def _close_file(file):
# It was closed already.


def pack_exception(exc=None):
captured = _interpreters.capture_exception(exc)
data = dict(captured.__dict__)
data['type'] = dict(captured.type.__dict__)
return json.dumps(data)


def unpack_exception(packed):
try:
data = json.loads(packed)
except json.decoder.JSONDecodeError:
warnings.warn('incomplete exception data', RuntimeWarning)
print(packed if isinstance(packed, str) else packed.decode('utf-8'))
return None
exc = types.SimpleNamespace(**data)
exc.type = types.SimpleNamespace(**exc.type)
return exc;


class CapturingResults:

STDIO = dedent("""\
import contextlib, io
with open({w_pipe}, 'wb', buffering=0) as _spipe_{stream}:
_captured_std{stream} = io.StringIO()
with contextlib.redirect_std{stream}(_captured_std{stream}):
Expand All @@ -74,7 +92,6 @@ class CapturingResults:
_spipe_{stream}.write(text.encode('utf-8'))
""")[:-1]
EXC = dedent("""\
import json, traceback
with open({w_pipe}, 'wb', buffering=0) as _spipe_exc:
try:
#########################
Expand All @@ -85,23 +102,16 @@ class CapturingResults:
# end wrapped script
#########################
except Exception as exc:
# This matches what _interpreters.exec() returns.
text = json.dumps(dict(
type=dict(
__name__=type(exc).__name__,
__qualname__=type(exc).__qualname__,
__module__=type(exc).__module__,
),
msg=str(exc),
formatted=traceback.format_exception_only(exc),
errdisplay=traceback.format_exception(exc),
))
text = _interp_utils.pack_exception(exc)
_spipe_exc.write(text.encode('utf-8'))
""")[:-1]

@classmethod
def wrap_script(cls, script, *, stdout=True, stderr=False, exc=False):
script = dedent(script).strip(os.linesep)
imports = [
f'import {__name__} as _interp_utils',
]
wrapped = script

# Handle exc.
Expand All @@ -118,6 +128,9 @@ def wrap_script(cls, script, *, stdout=True, stderr=False, exc=False):

# Handle stdout.
if stdout:
imports.extend([
'import contextlib, io',
])
stdout = os.pipe()
r_out, w_out = stdout
indented = wrapped.replace('\n', '\n ')
Expand All @@ -133,6 +146,10 @@ def wrap_script(cls, script, *, stdout=True, stderr=False, exc=False):
if stderr == 'stdout':
stderr = None
elif stderr:
if not stdout:
imports.extend([
'import contextlib, io',
])
stderr = os.pipe()
r_err, w_err = stderr
indented = wrapped.replace('\n', '\n ')
Expand All @@ -146,6 +163,10 @@ def wrap_script(cls, script, *, stdout=True, stderr=False, exc=False):

if wrapped == script:
raise NotImplementedError
else:
for line in imports:
wrapped = f'{line}{os.linesep}{wrapped}'

results = cls(stdout, stderr, exc)
return wrapped, results

Expand Down Expand Up @@ -246,14 +267,7 @@ def _unpack_exc(self):
return self._exc
if not self._buf_exc:
return None
try:
data = json.loads(self._buf_exc)
except json.decoder.JSONDecodeError:
warnings.warn('incomplete exception data', RuntimeWarning)
print(self._buf_exc.decode('utf-8'))
return None
self._exc = exc = types.SimpleNamespace(**data)
exc.type = types.SimpleNamespace(**exc.type)
self._exc = unpack_exception(self._buf_exc)
return self._exc

def stdout(self):
Expand Down Expand Up @@ -313,6 +327,10 @@ def __getattr__(self, name):
raise AttributeError(name)
return getattr(self._final, name)

def raise_if_failed(self):
if self.exc is not None:
raise interpreters.ExecutionFailed(self.exc)


def _captured_script(script, *, stdout=True, stderr=False, exc=False):
return CapturingResults.wrap_script(
Expand Down Expand Up @@ -487,11 +505,7 @@ def _run_string(self, interp, script):
def run_and_capture(self, interp, script):
text, err = self._run_string(interp, script)
if err is not None:
print()
if not err.errdisplay.startswith('Traceback '):
print('Traceback (most recent call last):')
print(err.errdisplay, file=sys.stderr)
raise Exception(f'subinterpreter failed: {err.formatted}')
raise interpreters.ExecutionFailed(err)
else:
return text

Expand Down Expand Up @@ -526,7 +540,8 @@ def run_from_capi(self, interpid, script, *, main=False):
with self.capturing(script) as (wrapped, results):
rc = _testinternalcapi.exec_interpreter(interpid, wrapped, main=main)
assert rc == 0, rc
return results.exc, results.stdout
results.raise_if_failed()
return results.stdout

@contextlib.contextmanager
def _running(self, run_interp, exec_interp):
Expand Down Expand Up @@ -604,8 +619,7 @@ def exec_interp(script):
@contextlib.contextmanager
def running_from_capi(self, interpid, *, main=False):
def run_interp(script):
err, text = self.run_from_capi(interpid, script, main=main)
assert err is None, err
text = self.run_from_capi(interpid, script, main=main)
assert text == '', repr(text)
def exec_interp(script):
rc = _testinternalcapi.exec_interpreter(interpid, script)
Expand All @@ -620,4 +634,5 @@ def run_temp_from_capi(self, script, config='legacy'):
with self.capturing(script) as (wrapped, results):
rc = run_in_interpreter(wrapped, config)
assert rc == 0, rc
return results.exc, results.stdout
results.raise_if_failed()
return results.stdout