patch pydantic v1.10.9 conflict with py3.12

[luca-knaack-webcom]

There are errors in pipelines that run the testing configuration python=3.12 and pydantic=1.10.9. The error is something like:

| ________________ ERROR collecting tests/parser/test_openapi.py _________________
| tests/parser/test_openapi.py:10: in <module>
|     from datamodel_code_generator import OpenAPIScope, PythonVersion
| datamodel_code_generator/__init__.py:35: in <module>
|     from datamodel_code_generator.parser.base import Parser
| datamodel_code_generator/parser/base.py:37: in <module>
|     from datamodel_code_generator.model import pydantic as pydantic_model
| datamodel_code_generator/model/__init__.py:5: in <module>
|     from ..types import DataTypeManager as DataTypeManagerABC
| datamodel_code_generator/types.py:240: in <module>
|     class DataType(_BaseModel):
| .venv/lib/python3.12/site-packages/pydantic/main.py:286: in __new__
|     cls.__try_update_forward_refs__()
| .venv/lib/python3.12/site-packages/pydantic/main.py:808: in __try_update_forward_refs__
|     update_model_forward_refs(cls, cls.__fields__.values(), cls.__config__.json_encoders, localns, (NameError,))
| .venv/lib/python3.12/site-packages/pydantic/typing.py:554: in update_model_forward_refs
|     update_field_forward_refs(f, globalns=globalns, localns=localns)
| .venv/lib/python3.12/site-packages/pydantic/typing.py:520: in update_field_forward_refs
|     field.type_ = evaluate_forwardref(field.type_, globalns, localns or None)
| .venv/lib/python3.12/site-packages/pydantic/typing.py:66: in evaluate_forwardref
|     return cast(Any, type_)._evaluate(globalns, localns, set())
| E   TypeError: ForwardRef._evaluate() missing 1 required keyword-only argument: 'recursive_guard'

and results in a massive amount of errors like:

ERROR tests/test_format.py - TypeError: ForwardRef._evaluate() missing 1 required keyword-only argument: 'recursive_guard'

To patch the missing recursive_guard keyword argument, I created a pydantic_patch file that gets imported early in datamodel_code_generator.__init__.py and that patches the underlying evaluate_forwardref function.

This PR is should fix most of the broken tests in the pipelines for pull requests #2013, #2009 and #2008.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@28be37d). Learn more about missing BASE report.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2014   +/-   ##
=======================================
  Coverage        ?   98.81%           
=======================================
  Files           ?       38           
  Lines           ?     4215           
  Branches        ?      981           
=======================================
  Hits            ?     4165           
  Misses          ?       31           
  Partials        ?       19           

Flag	Coverage Δ
unittests	98.48% <100.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[luca-knaack-webcom]

While there is still one failing pipeline, this is the godspeed-benchmark, that isn't able to run on any PR's pipeline.

[codspeed-hq]

CodSpeed Performance Report

Merging #2014 will not alter performance

_{Comparing luca-knaack-webcom:fix/pydantic-1-10-9-with-py-3-12 (611d070) with main (28be37d)}

Summary

✅ 29 untouched benchmarks

[luca-knaack-webcom]

@koxudaxi, I had to change the codspeed-benchmark action to always install the dependencies, as the cached virtual environment seems to lack the pytest-xdist package. Once the cache is refreshed, the commented out line could be reintroduced.

[koxudaxi]

Is this a problem that also occurs in, for example, Python 3.13?

[luca-knaack-webcom]

I checked this now with python v3.13.0-beta.2 and pydantic v2.8.0b1 (earliest version supporting python 3.13) and the problem does not occur. It seems like the broken ForwardRef is really only happening for python 3.12

[cclauss]

https://www.python.org/download/pre-releases/ --> Beta 3 (Python 3.13.0b3)

[koxudaxi]

@cclauss
Thank you for spending so much time on this difficult issue.
I was commenting on the code, but I am concerned about the support for other versions, but I don't think it is a problem now, so I will merge it.
Thank you very much.

[koxudaxi]

For performance reasons, you may also want to include a version check on the pydantic side.