From: Alexandre Detiste Date: Sun, 1 Sep 2024 19:42:50 +0100 Subject: dumb patch to disable not runnable tests Forwarded: no please --- tests/test_docs.py | 272 ----------------------------------------------------- 1 file changed, 272 deletions(-) delete mode 100644 tests/test_docs.py diff --git a/tests/test_docs.py b/tests/test_docs.py deleted file mode 100644 index e15b3c4..0000000 --- a/tests/test_docs.py +++ /dev/null @@ -1,272 +0,0 @@ -from __future__ import annotations as _annotations - -import os -import platform -import re -import subprocess -import sys -from datetime import datetime -from pathlib import Path -from tempfile import NamedTemporaryFile -from typing import Any - -import pytest -from pydantic_core import core_schema -from pytest_examples import CodeExample, EvalExample, find_examples - -from pydantic.errors import PydanticErrorCodes - -INDEX_MAIN = None -DOCS_ROOT = Path(__file__).parent.parent / 'docs' -SOURCES_ROOT = Path(__file__).parent.parent / 'pydantic' - - -def skip_docs_tests(): - if sys.platform not in {'linux', 'darwin'}: - return 'not in linux or macos' - - if platform.python_implementation() != 'CPython': - return 'not cpython' - - try: - import devtools # noqa: F401 - except ImportError: - return 'devtools not installed' - - try: - import sqlalchemy # noqa: F401 - except ImportError: - return 'sqlalchemy not installed' - - try: - import ansi2html # noqa: F401 - except ImportError: - return 'ansi2html not installed' - - -class GroupModuleGlobals: - def __init__(self) -> None: - self.name = None - self.module_dict: dict[str, str] = {} - - def get(self, name: str | None): - if name is not None and name == self.name: - return self.module_dict - - def set(self, name: str | None, module_dict: dict[str, str]): - self.name = name - if self.name is None: - self.module_dict = None - else: - self.module_dict = module_dict - - -group_globals = GroupModuleGlobals() - - -class MockedDatetime(datetime): - @classmethod - def now(cls, *args, tz=None, **kwargs): - return datetime(2032, 1, 2, 3, 4, 5, 6, tzinfo=tz) - - -skip_reason = skip_docs_tests() -LINE_LENGTH = 80 - - -def print_callback(print_statement: str) -> str: - return re.sub(r'(https://errors.pydantic.dev)/.+?/', r'\1/2/', print_statement) - - -def run_example(example: CodeExample, eval_example: EvalExample, mocker: Any) -> None: # noqa C901 - eval_example.print_callback = print_callback - - prefix_settings = example.prefix_settings() - test_settings = prefix_settings.get('test', '') - lint_settings = prefix_settings.get('lint', '') - if test_settings.startswith('skip') and lint_settings.startswith('skip'): - pytest.skip('both running code and lint skipped') - - requires_settings = prefix_settings.get('requires') - if requires_settings: - major, minor = map(int, requires_settings.split('.')) - if sys.version_info < (major, minor): - pytest.skip(f'requires python {requires_settings}') - - group_name = prefix_settings.get('group') - - eval_example.set_config(ruff_ignore=['D', 'T', 'B', 'C4', 'E721', 'Q001', 'PIE790'], line_length=LINE_LENGTH) - if '# ignore-above' in example.source: - eval_example.set_config(ruff_ignore=eval_example.config.ruff_ignore + ['E402'], line_length=LINE_LENGTH) - if group_name: - eval_example.set_config(ruff_ignore=eval_example.config.ruff_ignore + ['F821'], line_length=LINE_LENGTH) - - if not lint_settings.startswith('skip'): - if eval_example.update_examples: - eval_example.format(example) - else: - if example.in_py_file(): - # Ignore isort as double newlines will cause it to fail, but we remove them in py files - eval_example.set_config(ruff_ignore=eval_example.config.ruff_ignore + ['I001'], line_length=LINE_LENGTH) - eval_example.lint(example) - - if test_settings.startswith('skip'): - pytest.skip(test_settings[4:].lstrip(' -') or 'running code skipped') - - group_name = prefix_settings.get('group') - d = group_globals.get(group_name) - - mocker.patch('datetime.datetime', MockedDatetime) - mocker.patch('random.randint', return_value=3) - - xfail = None - if test_settings.startswith('xfail'): - xfail = test_settings[5:].lstrip(' -') - - rewrite_assertions = prefix_settings.get('rewrite_assert', 'true') == 'true' - - try: - if test_settings == 'no-print-intercept': - d2 = eval_example.run(example, module_globals=d, rewrite_assertions=rewrite_assertions) - elif eval_example.update_examples: - d2 = eval_example.run_print_update(example, module_globals=d, rewrite_assertions=rewrite_assertions) - else: - d2 = eval_example.run_print_check(example, module_globals=d, rewrite_assertions=rewrite_assertions) - except BaseException as e: # run_print_check raises a BaseException - if xfail: - pytest.xfail(f'{xfail}, {type(e).__name__}: {e}') - raise - else: - if xfail: - pytest.fail('expected xfail') - group_globals.set(group_name, d2) - - -@pytest.mark.thread_unsafe -@pytest.mark.filterwarnings('ignore:(parse_obj_as|schema_json_of|schema_of) is deprecated.*:DeprecationWarning') -@pytest.mark.skipif(bool(skip_reason), reason=skip_reason or 'not skipping') -@pytest.mark.parametrize('example', find_examples(str(SOURCES_ROOT), skip=sys.platform == 'win32'), ids=str) -def test_docstrings_examples(example: CodeExample, eval_example: EvalExample, tmp_path: Path, mocker): - if str(example.path).startswith(str(SOURCES_ROOT / 'v1')): - pytest.skip('skip v1 examples') - - run_example(example, eval_example, mocker) - - -@pytest.fixture(scope='module', autouse=True) -def set_cwd(): - # `test_docs_examples` needs to be run from this folder or relative paths will be wrong and some tests fail - execution_path = str(DOCS_ROOT.parent) - - cwd = os.getcwd() - os.chdir(execution_path) - try: - yield - finally: - os.chdir(cwd) - - -@pytest.mark.thread_unsafe -@pytest.mark.filterwarnings('ignore:(parse_obj_as|schema_json_of|schema_of) is deprecated.*:DeprecationWarning') -@pytest.mark.filterwarnings('ignore::pydantic.warnings.PydanticExperimentalWarning') -@pytest.mark.skipif(bool(skip_reason), reason=skip_reason or 'not skipping') -@pytest.mark.parametrize('example', find_examples(str(DOCS_ROOT), skip=sys.platform == 'win32'), ids=str) -def test_docs_examples(example: CodeExample, eval_example: EvalExample, tmp_path: Path, mocker): - global INDEX_MAIN - if example.path.name == 'index.md': - if INDEX_MAIN is None: - INDEX_MAIN = example.source - else: - (tmp_path / 'index_main.py').write_text(INDEX_MAIN) - sys.path.append(str(tmp_path)) - - if example.path.name == 'devtools.md': - pytest.skip('tested below') - - run_example(example, eval_example, mocker) - - -@pytest.mark.thread_unsafe -@pytest.mark.skipif(bool(skip_reason), reason=skip_reason or 'not skipping') -@pytest.mark.skipif(sys.version_info >= (3, 13), reason='python-devtools does not yet support python 3.13') -@pytest.mark.parametrize( - 'example', find_examples(str(DOCS_ROOT / 'integrations/devtools.md'), skip=sys.platform == 'win32'), ids=str -) -def test_docs_devtools_example(example: CodeExample, eval_example: EvalExample, tmp_path: Path): - from ansi2html import Ansi2HTMLConverter - - eval_example.set_config(ruff_ignore=['D', 'T', 'B', 'C4'], line_length=LINE_LENGTH) - - if eval_example.update_examples: - eval_example.format(example) - else: - eval_example.lint(example) - - with NamedTemporaryFile(mode='w', suffix='.py') as f: - f.write(example.source) - f.flush() - os.environ['PY_DEVTOOLS_HIGHLIGHT'] = 'true' - p = subprocess.run((sys.executable, f.name), stdout=subprocess.PIPE, check=True, encoding='utf8') - - conv = Ansi2HTMLConverter() - - # replace ugly file path with "devtools_example.py" - output = re.sub(r'/.+?\.py', 'devtools_example.py', p.stdout) - output_html = conv.convert(output, full=False) - output_html = ( - '\n' - f'{output_html}' - ) - output_file = DOCS_ROOT / 'plugins/devtools_output.html' - - if eval_example.update_examples: - output_file.write_text(output_html) - elif not output_file.exists(): - pytest.fail(f'output file {output_file} does not exist') - else: - assert output_html == output_file.read_text() - - -def test_error_codes(): - error_text = (DOCS_ROOT / 'errors/usage_errors.md').read_text() - - code_error_codes = PydanticErrorCodes.__args__ - - documented_error_codes = tuple(re.findall(r'^## .+ \{#(.+?)}$', error_text, flags=re.MULTILINE)) - - assert code_error_codes == documented_error_codes, 'Error codes in code and docs do not match' - - -def test_validation_error_codes(): - error_text = (DOCS_ROOT / 'errors/validation_errors.md').read_text() - - expected_validation_error_codes = set(core_schema.ErrorType.__args__) - # Remove codes that are not currently accessible from pydantic: - expected_validation_error_codes.remove('timezone_offset') # not currently exposed for configuration in pydantic - - test_failures = [] - - documented_validation_error_codes = [] - error_code_section = None - printed_error_code = None - for line in error_text.splitlines(): - section_match = re.fullmatch(r'## `(.+)`', line) - if section_match: - if error_code_section is not None and printed_error_code != error_code_section: - test_failures.append(f'Error code {error_code_section!r} is not printed in its example') - error_code_section = section_match.group(1) - if error_code_section not in expected_validation_error_codes: - test_failures.append(f'Documented error code {error_code_section!r} is not a member of ErrorType') - documented_validation_error_codes.append(error_code_section) - printed_error_code = None - continue - - printed_match = re.search("#> '(.+)'", line) - if printed_match: - printed_error_code = printed_match.group(1) - - assert test_failures == [] - - code_validation_error_codes = sorted(expected_validation_error_codes) - assert code_validation_error_codes == documented_validation_error_codes, 'Error codes in code and docs do not match'