cleaning up

Author: emanuel-schmid

.github/scripts/make_release.py

@@ -1,4 +1,10 @@
 #!/usr/bin/env python3
+"""This script is part of the GitHub CI make-release pipeline
+
+It reads the version number from climada/_version.py and then uses the `gh` cli
+to create the new release.
+
+"""
 import glob
 import re
 import subprocess
@@ -7,8 +13,8 @@
 def get_version() -> str:
     """Return the current version number, based on the _version.py file."""
     [version_file] = glob.glob("climada*/_version.py")
-    with open(version_file) as vf:
-        content = vf.read()
+    with open(version_file, 'r', encoding="UTF-8") as vfp:
+        content = vfp.read()
     regex = r'^__version__\s*=\s*[\'\"](.*)[\'\"]\s*$'
     mtch = re.match(regex, content)
     return mtch.group(1)

.github/scripts/prepare_release.py

@@ -1,4 +1,16 @@
 #!/usr/bin/env python3
+"""This script is part of the GitHub CI make-release pipeline
+
+The following preparation steps are executed:
+
+- update version numbers in _version.py and setup.py
+- purge the "Unreleased" section of CHANGELOG.md and rename it to the new version number
+- copy the README.md file to doc/misc/README.md, 
+  but without the badges as they interfere with the sphinx doc builder
+
+All changes are immediately commited to the repository.
+"""
+
 import glob
 import json
 import re
@@ -36,71 +48,71 @@ def bump_version_number(version_number: str, level: str) -> str:
     return ".".join([major, minor, patch])
 
 
-def update_readme(nvn):
+def update_readme(_nvn):
     """align doc/misc/README.md with ./README.md but remove the non-markdown header lines from """
-    with open("README.md", 'r') as rmin:
+    with open("README.md", 'r', encoding="UTF-8") as rmin:
         lines = [line for line in rmin.readlines() if not line.startswith('[![')]
     while not lines[0].strip():
         lines = lines[1:]
-    with open("doc/misc/README.md", 'w') as rmout:
+    with open("doc/misc/README.md", 'w', encoding="UTF-8") as rmout:
         rmout.writelines(lines)
     return GitFile('doc/misc/README.md')
 
 
 def update_changelog(nvn):
     """Rename the "Unreleased" section, remove unused subsections and the code-freeze date,
     set the release date to today"""
-    r = [] 
-    crn = None
-    cr = [] 
-    ctn = None
-    ct = []
-    with open("CHANGELOG.md", 'r') as cl:
-        for line in cl.readlines():
+    releases = []
+    release_name = None
+    release = []
+    section_name = None
+    section = []
+    with open("CHANGELOG.md", 'r', encoding="UTF-8") as changelog:
+        for line in changelog.readlines():
             if line.startswith('#'):
                 if line.startswith('### '):
-                    if ct:
-                        cr.append((ctn, ct))
-                    ctn = line[4:].strip()
-                    ct = []
-                    #print("tag:", ctn)
+                    if section:
+                        release.append((section_name, section))
+                    section_name = line[4:].strip()
+                    section = []
+                    #print("tag:", section_name)
                 elif line.startswith('## '):
-                    if ct:
-                        cr.append((ctn, ct))
-                    if cr:
-                        r.append((crn, cr))
-                    crn = line[3:].strip()
-                    cr = []
-                    ctn = None
-                    ct = []
-                    #print("release:", crn)
+                    if section:
+                        release.append((section_name, section))
+                    if release:
+                        releases.append((release_name, release))
+                    release_name = line[3:].strip()
+                    release = []
+                    section_name = None
+                    section = []
+                    #print("release:", release_name)
             else:
-                ct.append(line)
-        if ct:
-            cr.append((ctn, ct))
-        if cr:
-            r.append((crn, cr))
-
-    with open("CHANGELOG.md", 'w') as cl:
-        cl.write("# Changelog\n\n")
-        for crn, cr in r:
-            if crn:
-                if crn.lower() == "unreleased":
-                    crn = nvn
-                cl.write(f"## {crn}\n")
-            for ctn, ct in cr:
-                if any(ln.strip() for ln in ct):
-                    if ctn:
-                        cl.write(f"### {ctn}\n")
-                    lines = [ln.strip() for ln in ct if "code freeze date: " not in ln.lower()]
-                    if not ctn and crn.lower() == nvn:
+                section.append(line)
+        if section:
+            release.append((section_name, section))
+        if release:
+            releases.append((release_name, release))
+
+    with open("CHANGELOG.md", 'w', encoding="UTF-8") as changelog:
+        changelog.write("# Changelog\n\n")
+        for release_name, release in releases:
+            if release_name:
+                if release_name.lower() == "unreleased":
+                    release_name = nvn
+                changelog.write(f"## {release_name}\n")
+            for section_name, section in release:
+                if any(ln.strip() for ln in section):
+                    if section_name:
+                        changelog.write(f"### {section_name}\n")
+                    lines = [ln.strip() for ln in section if "code freeze date: " not in ln.lower()]
+                    if not section_name and release_name.lower() == nvn:
                         print("setting date")
                         for i, line in enumerate(lines):
                             if "release date: " in line.lower():
                                 today = time.strftime("%Y-%m-%d")
                                 lines[i] = f"Release date: {today}"
-                    cl.write("\n".join(lines).replace("\n\n", "\n"))
-                    cl.write("\n")
+                    changelog.write("\n".join(lines).replace("\n\n", "\n"))
+                    changelog.write("\n")
     return GitFile('CHANGELOG.md')
 
 
@@ -120,17 +132,17 @@ def update_setup(new_version_number):
 
 def update_file(file_with_version, regex, new_version_number):
     """Replace the version number(s) in a file, based on a rgular expression."""
-    with open(file_with_version, 'r') as curf:
+    with open(file_with_version, 'r', encoding="UTF-8") as curf:
         lines = curf.readlines()
     successfully_updated = False
     for i, line in enumerate(lines):
-        m = re.match(regex, line)
-        if m:
-            lines[i] = f"{m.group(1)}{new_version_number}{m.group(2)}"
+        mtch = re.match(regex, line)
+        if mtch:
+            lines[i] = f"{mtch.group(1)}{new_version_number}{mtch.group(2)}"
             successfully_updated = True
     if not successfully_updated:
-        raise Exception(f"cannot determine version of {file_with_version}")
-    with open(file_with_version, 'w') as newf:
+        raise RuntimeError(f"cannot determine version of {file_with_version}")
+    with open(file_with_version, 'w', encoding="UTF-8") as newf:
         for line in lines:
             newf.write(line)
     return GitFile(file_with_version)
@@ -140,16 +152,15 @@ class GitFile():
     """Helper class for `git add`."""
     def __init__(self, path):
         self.path = path
-    
+
     def gitadd(self):
         """run `git add`"""
-        answer = subprocess.run(
+        _gitadd = subprocess.run(
             ["git", "add", self.path],
             check=True,
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE,
         ).stdout.decode("utf8")
-        #print(answer)
 
 
 class Git():
@@ -186,10 +197,10 @@ def commit(self, new_version):
         except subprocess.CalledProcessError as err:
             message = err.stdout.decode("utf8")
             print("message:", message)
-            if ("nothing to commit" in message):
+            if "nothing to commit" in message:
                 print("repo already up to date with new version number")
             else:
-                raise Exception(f"failed to run: {message}") from err
+                raise RuntimeError(f"failed to run: {message}") from err
 
 
 def prepare_new_release(level):
@@ -215,8 +226,7 @@ def prepare_new_release(level):
 if __name__ == "__main__":
     from sys import argv
     try:
-        level = argv[1]
+        LEVEL = argv[1]
     except IndexError:
-        level = "patch"
-    prepare_new_release(level)
-
+        LEVEL = "patch"
+    prepare_new_release(LEVEL)

.github/scripts/setup_devbranch.py

@@ -1,4 +1,14 @@
 #!/usr/bin/env python3
+"""This script is part of the GitHub CI postrelease-setup-devbranch pipeline
+
+The following preparation steps are executed:
+
+- update version numbers in _version.py and setup.py: append a -dev suffix
+- insert a vanilla "unreleased" section on top of CHANGELOG.md
+
+The changes are not commited to the repository. This is dealt with in the bash script
+`setup_devbranch.sh` (which is also the caller of this script).
+"""
 import glob
 import json
 import re
@@ -23,14 +33,14 @@ def get_last_version() -> str:
 
 def update_changelog():
     """Insert a vanilla "Unreleased" section on top."""
-    with open("CHANGELOG.md", 'r') as cl:
-        lines = cl.readlines()
+    with open("CHANGELOG.md", 'r', encoding="UTF-8") as changelog:
+        lines = changelog.readlines()
 
     if "## Unreleased" in lines:
         return
 
-    with open("CHANGELOG.md", 'w') as cl:
-        cl.write("""# Changelog
+    with open("CHANGELOG.md", 'w', encoding="UTF-8") as changelog:
+        changelog.write("""# Changelog
 
 ## Unreleased
 
@@ -53,7 +63,7 @@ def update_changelog():
 ### Removed
 
 """)
-        cl.writelines(lines[2:])
+        changelog.writelines(lines[2:])
 
 
 def update_version(nvn):
@@ -72,17 +82,17 @@ def update_setup(new_version_number):
 
 def update_file(file_with_version, regex, new_version_number):
     """Replace the version number(s) in a file, based on a rgular expression."""
-    with open(file_with_version, 'r') as curf:
+    with open(file_with_version, 'r', encoding="UTF-8") as curf:
         lines = curf.readlines()
     successfully_updated = False
     for i, line in enumerate(lines):
-        m = re.match(regex, line)
-        if m:
-            lines[i] = f"{m.group(1)}{new_version_number}{m.group(2)}"
+        mtch = re.match(regex, line)
+        if mtch:
+            lines[i] = f"{mtch.group(1)}{new_version_number}{mtch.group(2)}"
             successfully_updated = True
     if not successfully_updated:
-        raise Exception(f"cannot determine version of {file_with_version}")
-    with open(file_with_version, 'w') as newf:
+        raise RuntimeError(f"cannot determine version of {file_with_version}")
+    with open(file_with_version, 'w', encoding="UTF-8") as newf:
         for line in lines:
             newf.write(line)
 
@@ -94,7 +104,7 @@ def setup_devbranch():
     Just changes files, all `git` commands are in the setup_devbranch.sh file.
     """
     main_version = get_last_version().strip('v')
-    
+
     dev_version = f"{main_version}-dev"
 
     update_setup(dev_version)
@@ -106,4 +116,3 @@ def setup_devbranch():
 
 if __name__ == "__main__":
     setup_devbranch()
-