loader.py

import os
import yaml

notes_dirs = [
    os.path.join(os.path.dirname(__file__), 'esr'),
    os.path.join(os.path.dirname(__file__), 'release'),
    os.path.join(os.path.dirname(__file__), 'beta'),
    os.path.join(os.path.dirname(__file__), 'archive'),
]

BUG_MKDOWN_T = "[{}](https://bugzilla.mozilla.org/show_bug.cgi?id={})"


def mk_bug_links(bugs_list):
    """Used for the release notes preview to create a string of links to
    the relevant bugs in Bugzilla."""
    links_list = []
    bugs_list.sort()
    for bug_no in bugs_list:
        md = BUG_MKDOWN_T.format(bug_no, bug_no)
        links_list.append(md)
    return ' '.join(links_list)


class ReleaseNotes(object):
    def __init__(self):
        self.settings = {}
        with open(os.path.join(os.path.dirname(__file__), "settings.yml"), "r") as f:
            self.settings = yaml.safe_load(f)

        # Copy notes into the same dict for imports. Release version notes overwrite beta version notes if any
        # version numbers are shared.
        self.notes = self.load_dirs(notes_dirs)

    def organize(self, notelist):
        """Organize the data from the .yml format into the variables that the template context expects."""
        organized_notelist = {}
        for k, n in notelist.items():
            n["new_features"] = []
            n["known_issues"] = []
            n["version"] = k
            n["release"]["version"] = n["version"]
            # Always need at least one unnamed group.
            if "groups" not in n["release"]:
                n["release"]["groups"] = [None]
            # Import system requirements from major version
            if not n["release"].get("system_requirements"):
                import_version = n["release"].get("import_system_requirements")
                if import_version:
                    n["release"]["system_requirements"] = notelist[import_version]["release"]["system_requirements"]
                else:
                    n["release"]["system_requirements"] = ""
            # Push unresolved tags to separate "Known Issues" list.
            for note in n["notes"]:
                if "bugs" in note:
                    note["bug_links"] = mk_bug_links(note["bugs"])
                if note["tag"] == "unresolved":
                    n["known_issues"].append(note)
                else:
                    n["new_features"].append(note)
            organized_notelist[k] = n
        return organized_notelist

    def load_dirs(self, paths):
        """Load release notes from a list of paths."""
        notes = {}
        for path in paths:
            notefiles = os.listdir(path)
            for notefile in notefiles:
                if notefile.endswith(".yml"):
                    with open(os.path.join(path, notefile), "r") as f:
                        doc = yaml.safe_load(f)
                        notes[os.path.splitext(notefile)[0]] = doc
        sorted_notes = self.organize(notes)
        return sorted_notes


releasenotes = ReleaseNotes()