Added accessor for current configuration.

- `get_config()` will instantiate a new configuration or return the existing configuration.

Author: coordt

generate_changelog/cli.py

@@ -6,7 +6,7 @@
 import typer
 from git import Repo
 
-from generate_changelog.configuration import DEFAULT_CONFIG_FILE_NAMES, get_default_config, write_default_config
+from generate_changelog.configuration import DEFAULT_CONFIG_FILE_NAMES, write_default_config
 
 app = typer.Typer()
 
@@ -46,10 +46,11 @@ def main(
 ):
     """Generate a change  log from git commits."""
     from generate_changelog import templating
+    from generate_changelog.configuration import get_config
     from generate_changelog.pipeline import pipeline_factory
 
     # Load default configuration
-    config = get_default_config()
+    config = get_config()
 
     if user_config := config_file or next(
         (Path.cwd() / Path(name) for name in DEFAULT_CONFIG_FILE_NAMES if (Path.cwd() / Path(name)).exists()), None

generate_changelog/configuration.py

@@ -1,4 +1,4 @@
-"""Configuration setup for CLGen."""
+"""Configuration for generate_changelog."""
 from typing import Callable, Optional, Union
 
 from dataclasses import asdict, dataclass, field
@@ -98,7 +98,7 @@
 
 @dataclass
 class Configuration:
-    """Configuration for CLGen."""
+    """Configuration for generate_changelog."""
 
     variables: dict = field(default_factory=dict)
     """User variables for reference in other parts of the configuration."""
@@ -171,6 +171,7 @@ def get_default_config() -> Configuration:
         subject_pipeline=DEFAULT_SUBJECT_PIPELINE,
         starting_tag_pipeline=DEFAULT_STARTING_TAG_PIPELINE,
         output_pipeline=DEFAULT_OUTPUT_PIPELINE,
+        valid_author_tokens=VALID_AUTHOR_TOKENS,
     )
 
 
@@ -182,4 +183,13 @@ def write_default_config(filename: Path):
         yaml.safe_dump(config, f, sort_keys=False)
 
 
-CONFIG = get_default_config()
+_CONFIG = None
+
+
+def get_config() -> Configuration:
+    """Return the current configuration."""
+    global _CONFIG
+
+    if _CONFIG is None:
+        _CONFIG = get_default_config()
+    return _CONFIG

generate_changelog/git_ops.py

@@ -9,7 +9,7 @@
 
 from git import Repo
 
-from generate_changelog.configuration import CONFIG
+from generate_changelog.configuration import get_config
 
 GIT_FORMAT_KEYS = {
     "sha1": "%H",
@@ -76,7 +76,7 @@ def parse_commits(repository: Repo, starting_rev: Optional[str] = None, ending_r
 
     log_opts = ["-z", "--topo-order", "--pretty=tformat:%H"]
 
-    if CONFIG.include_merges:
+    if get_config().include_merges:
         log_opts.append("--no-merges")
 
     log_opts.append(revs)

test/test_configuration.py

@@ -12,15 +12,15 @@
 def test_update_from_file():
     """A configuration file should update the default configuration."""
     config_file_path = FIXTURES_DIR / "sample_config.yml"
-    configuration.CONFIG.update_from_file(config_file_path)
-    assert configuration.CONFIG.unreleased_label == "Not Done Yet"
-    assert not hasattr(configuration.CONFIG, "not_valid")
+    configuration.get_config().update_from_file(config_file_path)
+    assert configuration.get_config().unreleased_label == "Not Done Yet"
+    assert not hasattr(configuration.get_config(), "not_valid")
 
     with pytest.raises(click.exceptions.Exit):
-        configuration.CONFIG.update_from_file(FIXTURES_DIR / "missing.yml")
+        configuration.get_config().update_from_file(FIXTURES_DIR / "missing.yml")
 
     with pytest.raises(click.exceptions.Exit):
-        configuration.CONFIG.update_from_file(FIXTURES_DIR)
+        configuration.get_config().update_from_file(FIXTURES_DIR)
 
 
 def test_write_default_config(tmp_path):

test/test_git_ops.py

@@ -4,7 +4,7 @@
 from pytest import param
 
 from generate_changelog import git_ops
-from generate_changelog.configuration import CONFIG
+from generate_changelog.configuration import get_config
 
 
 @pytest.mark.parametrize(
@@ -37,7 +37,7 @@ def test_get_tags(default_repo):
 
 def test_get_commits_by_all_tags(default_repo):
     """Commits should be grouped by tags and filtered."""
-    grouping = git_ops.get_commits_by_tags(default_repo, CONFIG.tag_pattern)
+    grouping = git_ops.get_commits_by_tags(default_repo, get_config().tag_pattern)
 
     assert len(grouping) == 4
 
@@ -49,7 +49,7 @@ def test_get_commits_by_all_tags(default_repo):
 
 def test_get_commits_since_tag(default_repo):
     """Commits should be grouped by tags and filtered since tag."""
-    grouping = git_ops.get_commits_by_tags(default_repo, CONFIG.tag_pattern, "0.0.2")
+    grouping = git_ops.get_commits_by_tags(default_repo, get_config().tag_pattern, "0.0.2")
 
     assert len(grouping) == 2
 

test/test_templating.py

@@ -9,7 +9,7 @@
 from pytest import param
 
 from generate_changelog import configuration, templating
-from generate_changelog.configuration import CONFIG, DEFAULT_SECTION_PATTERNS
+from generate_changelog.configuration import DEFAULT_SECTION_PATTERNS, get_config
 
 FIXTURES_DIR = Path(__file__).parent / "fixtures"
 fake = Faker()
@@ -70,11 +70,11 @@ def test_commit_with_no_email():
 
 def test_get_context_from_tags(default_repo):
     """Get context from tags should return gits correctly filtered."""
-    context = templating.get_context_from_tags(default_repo, CONFIG)
+    context = templating.get_context_from_tags(default_repo, get_config())
     assert len(context) == 4
 
     v = context[0]
-    assert v.label == CONFIG.unreleased_label
+    assert v.label == get_config().unreleased_label
     assert v.date_time.date() == datetime.date(2022, 1, 6)
     assert len(v.sections) == 1
     assert v.sections[0].label == "Updates"