Commit 42a86cc

committed

refactor(changelog): better typing, yield

1 parent 9420b44 commit 42a86ccCopy full SHA for 42a86cc

File tree

2 files changed

+20

-20

lines changed

commitizen
- changelog.py
tests
- test_changelog.py

2 files changed

+20

-20

lines changed

`‎commitizen/changelog.py‎`

Lines changed: 15 additions & 15 deletions

Original file line number	Diff line number	Diff line change
`@@ -29,10 +29,10 @@`
`29`	`29`
`30`	`30`	`import re`
`31`	`31`	`from collections import OrderedDict, defaultdict`
`32`		`-from collections.abc import Iterable`
	`32`	`+from collections.abc import Generator, Iterable, Mapping`
`33`	`33`	`from dataclasses import dataclass`
`34`	`34`	`from datetime import date`
`35`		`-from typing import TYPE_CHECKING`
	`35`	`+from typing import TYPE_CHECKING, Any`
`36`	`36`
`37`	`37`	`from jinja2 import (`
`38`	`38`	`BaseLoader,`
`@@ -84,7 +84,7 @@ def generate_tree_from_commits(`
`84`	`84`	`changelog_message_builder_hook: MessageBuilderHook \| None = None,`
`85`	`85`	`changelog_release_hook: ChangelogReleaseHook \| None = None,`
`86`	`86`	`rules: TagRules \| None = None,`
`87`		`-) -> Iterable[dict]:`
	`87`	`+) -> Generator[dict[str, Any], None, None]:`
`88`	`88`	`pat = re.compile(changelog_pattern)`
`89`	`89`	`map_pat = re.compile(commit_parser, re.MULTILINE)`
`90`	`90`	`body_map_pat = re.compile(commit_parser, re.MULTILINE \| re.DOTALL)`
`@@ -187,24 +187,24 @@ def process_commit_message(`
`187`	`187`	`changes[change_type].append(msg)`
`188`	`188`
`189`	`189`
`190`		`-def order_changelog_tree(tree: Iterable, change_type_order: list[str]) -> Iterable:`
	`190`	`+def order_changelog_tree(`
	`191`	`+ tree: Iterable[Mapping[str, Any]], change_type_order: list[str]`
	`192`	`+) -> Generator[dict[str, Any], None, None]:`
`191`	`193`	`if len(set(change_type_order)) != len(change_type_order):`
`192`	`194`	`raise InvalidConfigurationError(`
`193`	`195`	`f"Change types contain duplicates types ({change_type_order})"`
`194`	`196`	`)`
`195`	`197`
`196`		`- sorted_tree = []`
`197`	`198`	`for entry in tree:`
`198`		`- ordered_change_types = change_type_order + sorted(`
`199`		`- set(entry["changes"].keys()) - set(change_type_order)`
`200`		`- )`
`201`		`- changes = [`
`202`		`- (ct, entry["changes"][ct])`
`203`		`- for ct in ordered_change_types`
`204`		`- if ct in entry["changes"]`
`205`		`- ]`
`206`		`- sorted_tree.append({entry, {"changes": OrderedDict(changes)}})`
`207`		`- return sorted_tree`
	`199`	`+ yield {`
	`200`	`+ **entry,`
	`201`	`+ "changes": OrderedDict(`
	`202`	`+ (ct, entry["changes"][ct])`
	`203`	`+ for ct in change_type_order`
	`204`	`+ + sorted(set(entry["changes"].keys()) - set(change_type_order))`
	`205`	`+ if ct in entry["changes"]`
	`206`	`+ ),`
	`207`	`+ }`
`208`	`208`
`209`	`209`
`210`	`210`	`def get_changelog_template(loader: BaseLoader, template: str) -> Template:`

`‎tests/test_changelog.py‎`

Lines changed: 5 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -1219,22 +1219,22 @@ def test_order_changelog_tree(change_type_order, expected_reordering):`
`1219`	`1219`	`tree = changelog.order_changelog_tree(COMMITS_TREE, change_type_order)`
`1220`	`1220`
`1221`	`1221`	`for index, entry in enumerate(tuple(tree)):`
`1222`		`- version = tree[index]["version"]`
	`1222`	`+ version = entry["version"]`
`1223`	`1223`	`if version in expected_reordering:`
`1224`	`1224`	`# Verify that all keys are present`
`1225`		`- assert [tree[index].keys()] == [COMMITS_TREE[index].keys()]`
	`1225`	`+ assert [entry.keys()] == [COMMITS_TREE[index].keys()]`
`1226`	`1226`	`# Verify that the reorder only impacted the returned dict and not the original`
`1227`	`1227`	`expected = expected_reordering[version]`
`1228`		`- assert [*tree[index]["changes"].keys()] == expected["sorted"]`
	`1228`	`+ assert [*entry["changes"].keys()] == expected["sorted"]`
`1229`	`1229`	`assert [*COMMITS_TREE[index]["changes"].keys()] == expected["original"]`
`1230`	`1230`	`else:`
`1231`		`- assert [entry["changes"].keys()] == [tree[index]["changes"].keys()]`
	`1231`	`+ assert [entry["changes"].keys()] == [entry["changes"].keys()]`
`1232`	`1232`
`1233`	`1233`
`1234`	`1234`	`def test_order_changelog_tree_raises():`
`1235`	`1235`	`change_type_order = ["BREAKING CHANGE", "feat", "refactor", "feat"]`
`1236`	`1236`	`with pytest.raises(InvalidConfigurationError) as excinfo:`
`1237`		`- changelog.order_changelog_tree(COMMITS_TREE, change_type_order)`
	`1237`	`+ list(changelog.order_changelog_tree(COMMITS_TREE, change_type_order))`
`1238`	`1238`
`1239`	`1239`	`assert "Change types contain duplicates types" in str(excinfo)`
`1240`	`1240`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Commit 42a86cc

File tree

2 files changed

2 files changed

`‎commitizen/changelog.py‎`

`‎tests/test_changelog.py‎`

0 commit comments