Function test_cli_out

tests/test_general.py:1073–1170

Check redirection of messages and log diagnostics with environment variables PYMUPDF_LOG and PYMUPDF_MESSAGE.

()

            f'expected/actual lines mismatch: {len(expected_regexes)=} {len(actual)=}.'

def test_cli_out():
    '''
    Check redirection of messages and log diagnostics with environment
    variables PYMUPDF_LOG and PYMUPDF_MESSAGE.
    '''
    if os.environ.get('PYODIDE_ROOT'):
        print('test_cli_out(): not running on Pyodide - cannot run child processes.')
        return
        
    import platform
    import re
    import subprocess
    log_prefix = None
    if os.environ.get('PYMUPDF_USE_EXTRA') == '0':
        log_prefix = f'.+Using non-default setting from PYMUPDF_USE_EXTRA: \'0\''
    
    sys.path.append(os.path.normpath(f'{__file__}/../..'))
    try:
        import pipcl
    finally:
        del sys.path[0]
    pipcl.show_system()
    def check(
            expect_out,
            expect_err,
            message=None,
            log=None,
            ):
        '''
        Sets PYMUPDF_MESSAGE to `message` and PYMUPDF_LOG to `log`, runs
        `pymupdf internal`, and checks lines stdout and stderr match regexes in
        `expect_out` and `expect_err`. Note that we enclose regexes in `^...$`.
        '''
        env = dict()
        if log:
            env['PYMUPDF_LOG'] = log
        if message:
            env['PYMUPDF_MESSAGE'] = message
        command = 'pymupdf internal'
        print(f'Running: {command}', flush=1)
        if env:
            print(f'with:')
            for key in sorted(env.keys()):
                print(f'    {key}={shlex.quote(env[key])}')
        env = os.environ | env
        cp = subprocess.run(command, shell=1, check=1, capture_output=1, env=env, text=True)
        
        check_lines(expect_out, cp.stdout)
        check_lines(expect_err, cp.stderr)
    
    print(f'test_cli_out(): {Py_GIL_DISABLED=}')
    print(f'test_cli_out(): {gil_enabled=}')
    
    print(f'Checking default, all output to stdout.')
    regex_gil_stderr = None
    if Py_GIL_DISABLED and gil_enabled:
        regex_gil_stderr = '.*The global interpreter lock.*'
    check(