Skip to content

typing: relax ChangelogSourceDict / ChangelogChangeSectionsDict to allow arbitrary section keys #4500

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

Closed
Copilot wants to merge 2 commits into from
Closed

typing: relax ChangelogSourceDict / ChangelogChangeSectionsDict to allow arbitrary section keys #4500

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c0d037c
Initial plan
Copilot May 11, 2026
49056c2
typing: relax ChangelogSourceDict/ChangelogChangeSectionsDict/Changel…
Copilot May 11, 2026
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
25 changes: 4 additions & 21 deletions py/envoy.base.utils/envoy/base/utils/typing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

import pathlib
from typing import TypedDict
from typing import Any, TypedDict

from packaging import version as _version

Expand Down Expand Up @@ -31,30 +31,13 @@ class BaseChangelogDict(TypedDict):
date: str


class ChangelogSourceDict(BaseChangelogDict, total=False):
# This should match envoy:changelogs/sections.yaml
changes: SourceChangeList | None
behavior_changes: SourceChangeList | None
minor_behavior_changes: SourceChangeList | None
bug_fixes: SourceChangeList | None
removed_config_or_runtime: SourceChangeList | None
new_features: SourceChangeList | None
deprecated: SourceChangeList | None
ChangelogSourceDict = dict[str, Any]


class ChangelogChangeSectionsDict(TypedDict, total=False):
# This should match envoy:changelogs/sections.yaml
changes: ChangeList | None
behavior_changes: ChangeList | None
minor_behavior_changes: ChangeList | None
bug_fixes: ChangeList | None
removed_config_or_runtime: ChangeList | None
new_features: ChangeList | None
deprecated: ChangeList | None
ChangelogChangeSectionsDict = dict[str, ChangeList]


class ChangelogDict(BaseChangelogDict, ChangelogChangeSectionsDict):
pass
ChangelogDict = dict[str, Any]


ChangelogPathsDict = dict[_version.Version, pathlib.Path]
Expand Down