feat: replace python-dateutil with stdlib datetime.fromisoformat#1429
Open
splch wants to merge 1 commit intoopenapi-generators:mainfrom
Open
feat: replace python-dateutil with stdlib datetime.fromisoformat#1429splch wants to merge 1 commit intoopenapi-generators:mainfrom
splch wants to merge 1 commit intoopenapi-generators:mainfrom
Conversation
Drop the python-dateutil dependency from both the generator and all
generated client code. Date/datetime parsing now uses the stdlib:
- datetime fields: datetime.datetime.fromisoformat(v.replace("Z", "+00:00"))
- date fields: datetime.date.fromisoformat(v)
The .replace("Z", "+00:00") call is needed because Python 3.10's
fromisoformat() does not accept the Z timezone suffix (added in 3.11).
It is a no-op on strings that do not contain Z.
Default values in OpenAPI specs are normalized at generation time
(Z replaced with +00:00), so the generated default expressions are
clean datetime.datetime.fromisoformat("...") calls without the
replace.
This removes one runtime dependency from every generated client
package, reducing install size and eliminating a dependency that is
in maintenance-only mode upstream.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Drop the
python-dateutildependency from both the generator and all generated client packages. Date/datetime parsing now uses Python's built-indatetime.fromisoformat()instead ofdateutil.parser.isoparse().This removes one runtime dependency from every generated client, reducing install size and eliminating a dependency that is unmaintained upstream and being deprecated by Fedora 45 (no releases since March 2024).
Changes
Generator source (
openapi_python_client/parser/properties/):datetime.py: Validate defaults withdatetime.datetime.fromisoformat()instead ofisoparse(). NormalizeZto+00:00at generation time so the emitted Python code is clean.date.py: Validate defaults withdatetime.date.fromisoformat()instead ofisoparse().date()."from dateutil.parser import isoparse"from the import set returned byget_imports().Jinja templates (
openapi_python_client/templates/property_templates/):datetime_property.py.jinja:isoparse(x)->datetime.datetime.fromisoformat(x.replace("Z", "+00:00"))date_property.py.jinja:isoparse(x).date()->datetime.date.fromisoformat(x)Dependency removal (all 4 metadata formats):
pyproject_uv.toml.jinja,pyproject_poetry.toml.jinja,pyproject_pdm.toml.jinja,setup.py.jinja: Removepython-dateutilfrom generated dependencies.pyproject.toml(generator): Removepython-dateutilfrom runtime deps andtypes-python-dateutilfrom dev deps.integration-tests/pyproject.toml: Remove both as well.Tests & golden records: All regenerated. Unit tests pass (283 passed, 4 skipped).
Python 3.10 compatibility
datetime.fromisoformat()gained full ISO 8601 support (including theZsuffix) in Python 3.11. On Python 3.10, theZsuffix raises aValueError:The generated datetime parsing code uses
.replace("Z", "+00:00")to normalizeZto an explicit UTC offset before callingfromisoformat(), which works on both 3.10 and 3.11+. This is a no-op on strings withoutZ. Date parsing does not need this since date strings have no timezone component.Default values in OpenAPI specs are normalized at generation time (Z -> +00:00), so the emitted default expressions are clean
datetime.datetime.fromisoformat("...")calls.