Skip to content

refactor(ChangelogFormat): refactor get_metadata_from_file for better readability and type#1596

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

Draft
bearomorphism wants to merge 1 commit into
base:master
Choose a base branch
from
Draft

refactor(ChangelogFormat): refactor get_metadata_from_file for better readability and type #1596

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
48 changes: 27 additions & 21 deletions commitizen/changelog_formats/base.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

import os
from abc import ABCMeta
from typing import IO, Any, ClassVar
from typing import IO, ClassVar

from commitizen.changelog import Metadata
from commitizen.config.base_config import BaseConfig
Expand DownExpand Up@@ -40,34 +40,40 @@ def get_metadata(self, filepath: str) -> Metadata:
with open(filepath, encoding=self.encoding) as changelog_file:
return self.get_metadata_from_file(changelog_file)

def get_metadata_from_file(self, file: IO[Any]) -> Metadata:
meta = Metadata()
def get_metadata_from_file(self, file: IO[str]) -> Metadata:
out_metadata = Metadata()
unreleased_level: int | None = None
for index, line in enumerate(file):
line = line.strip().lower()

unreleased: int | None = None
if "unreleased" in line:
unreleased = self.parse_title_level(line)
lines = [line.strip().lower() for line in file.readlines()]

@Lee-WLee-WNov 8, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

loop through it twice, probably not worth it?

for index, line in enumerate(lines):
parsed_unreleased_level = self.parse_title_level(line)

@bearomorphismbearomorphismSep 12, 2025•
edited
Loading

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can assume that self.parse_title_level is always a pure function? Then we don't have to call it twice here.

@Lee-WLee-WNov 8, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we want to make this assumption, we'll need to make this a static method instead, which makes sense but could be seen as a breaking change.

@Lee-WLee-WNov 8, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

but making that a static method is a good idea

current_unreleased_level = (
parsed_unreleased_level if "unreleased" in line else None
)

# Try to find beginning and end lines of the unreleased block
if unreleased:
meta.unreleased_start = index
unreleased_level = unreleased
if current_unreleased_level:
out_metadata.unreleased_start = index
unreleased_level = current_unreleased_level
continue
elif unreleased_level and self.parse_title_level(line) == unreleased_level:
meta.unreleased_end = index

if unreleased_level and parsed_unreleased_level == unreleased_level:
out_metadata.unreleased_end = index

# Try to find the latest release done
parsed = self.parse_version_from_title(line)
if parsed:
meta.latest_version = parsed.version
meta.latest_version_tag = parsed.tag
meta.latest_version_position = index
if parsed_version_tag := self.parse_version_from_title(line):
out_metadata.latest_version = parsed_version_tag.version
out_metadata.latest_version_tag = parsed_version_tag.tag
out_metadata.latest_version_position = index
break # there's no need for more info
if meta.unreleased_start is not None and meta.unreleased_end is None:
meta.unreleased_end = index

@bearomorphismbearomorphismSep 12, 2025•
edited
Loading

Copy link
Copy Markdown
CollaboratorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This index is unbounded if the file is empty, although this never happens for all code paths


return meta
if (
out_metadata.unreleased_start is not None
and out_metadata.unreleased_end is None
):
out_metadata.unreleased_end = len(lines) - 1

return out_metadata

def parse_version_from_title(self, line: str) -> VersionTag | None:
"""
Expand Down
Loading