Refactoring updateinfo.py (#50)

  - Added config for autopep8
  - Changed max_line_length: 80 -> 120
  - Added some type hints and docstrings
  - Fixed only a few Pylance reportArgumentType diagnostics
  - New helper functions
    - collect_branches_tags
    - normalize_version
    - new_libentry
  - Added test for normalize_version

Author: AnHeuermann

.github/workflows/format.yml

@@ -27,9 +27,9 @@ jobs:
 
       - name: autopep8
         run: |
-          autopep8 --in-place --aggressive --recursive ompackagemanager/ tests/
+          autopep8 ompackagemanager/ tests/
           if ! git diff --exit-code; then
-            echo "❌ Code not formatted. Please run 'autopep8 --in-place --aggressive --recursive ompackagemanager/ tests/' locally."
+            echo "❌ Code not formatted. Please run 'autopep8 ompackagemanager/ tests/' locally."
             exit 1
           else
             echo "✅ Code is properly formatted."

README.md

@@ -174,11 +174,11 @@ All Python code is formatted with
 [autopep8](https://pypi.org/project/autopep8/):
 
 ```bash
-autopep8 --in-place --aggressive --recursive ompackagemanager/ tests/
+autopep8 ompackagemanager/ tests/
 ```
 
 Unit tests can be run with:
 
 ```bash
-python -m unittest discover -s test
+python -m unittest discover -s tests
 ```

ompackagemanager/check_uses.py

@@ -10,24 +10,19 @@ def main():
         versionsWeHave[lib] = set()
         versions = data["libs"][lib]["versions"]
         for version in versions.keys():
-            versionsWeHave[lib].add(
-                semantic_version.Version.coerce(version).truncate())
+            versionsWeHave[lib].add(semantic_version.Version.coerce(version).truncate())
             for provide in versions[version].get("provides", []):
-                versionsWeHave[lib].add(
-                    semantic_version.Version.coerce(provide).truncate())
+                versionsWeHave[lib].add(semantic_version.Version.coerce(provide).truncate())
     print(versionsWeHave)
     for lib in data["libs"].keys():
         versions = data["libs"][lib]["versions"]
         for version in versions.keys():
             uses = versions[version].get("uses", {})
             for use in uses.keys():
                 if use not in versionsWeHave:
-                    print(
-                        "%s %s uses unknown library %s %s" %
-                        (lib, version, use, uses[use]))
+                    print("%s %s uses unknown library %s %s" % (lib, version, use, uses[use]))
                     continue
-                if semantic_version.Version.coerce(
-                        uses[use]).truncate() not in versionsWeHave[use]:
+                if semantic_version.Version.coerce(uses[use]).truncate() not in versionsWeHave[use]:
                     print("%s %s uses %s %s" % (lib, version, use, uses[use]))
                 else:
                     pass  # print("Have %s %s" % (use, uses[use]))

ompackagemanager/common.py

@@ -1,27 +1,24 @@
 import semantic_version
 
 
-def VersionNumber(s):
+def VersionNumber(s: str) -> semantic_version.Version:
     if s.startswith("v"):
         s = s[1:]
     if s == "":
         return semantic_version.Version(major=0, minor=0, patch=0)
     try:
         return semantic_version.Version.coerce(s)
     except BaseException:
-        return semantic_version.Version(
-            major=0, minor=0, patch=0, prerelease=(s,))
+        return semantic_version.Version(major=0, minor=0, patch=0, prerelease=(s,))
 
 
-def findMatchingLevel(s, levels):
+def findMatchingLevel(s: str, levels: list[str]) -> str | None:
     try:
         vn = VersionNumber(s)
     except BaseException:
-        return
+        return None
     for level in levels:
-        matched = False
-        if level[0].startswith(
-                "+") and len(vn.build) > 0 and level[0][1:] == ".".join(vn.build):
+        if level[0].startswith("+") and len(vn.build) > 0 and level[0][1:] == ".".join(vn.build):
             return level[1]
         if level[0] == "prerelease" and len(vn.prerelease) > 0:
             return level[1]
@@ -31,10 +28,10 @@ def findMatchingLevel(s, levels):
             return level[1]
         elif level[0] == s:
             return level[1]
-    return
+    return None
 
 
-def getSupportLevel(tagName, levels):
+def getSupportLevel(tagName: str, levels: list[str]) -> str:
     res = findMatchingLevel(tagName, levels)
     if res is None:
         return "noSupport"

ompackagemanager/genindex.py

@@ -71,8 +71,11 @@ def checkProvides2(worklist, visited, origLibName, origVisited, indexdata):
                 lst = []
                 for ver in versionsThatProvideTheUses:
                     try:
-                        res = checkProvides2(worklist.copy(
-                        ) + [(usesName, ver)], visited.copy(), origLibName, origVisited.copy(), indexdata)
+                        res = checkProvides2(worklist.copy() + [(usesName, ver)],
+                                             visited.copy(),
+                                             origLibName,
+                                             origVisited.copy(),
+                                             indexdata)
                         lst += [res]
                     except DuplicateVersions:
                         pass
@@ -81,8 +84,8 @@ def checkProvides2(worklist, visited, origLibName, origVisited, indexdata):
                 if not lst:
                     raise MissingUses(
                         "%d/%d provides worked for %s: %s with visited %s" %
-                        (len(lst), len(versionsThatProvideTheUses), usesName, [
-                            v["version"] for v in versionsThatProvideTheUses], visited))
+                        (len(lst), len(versionsThatProvideTheUses), usesName,
+                            [v["version"] for v in versionsThatProvideTheUses], visited))
                 noConflict = False
                 for l in lst:
                     if not l:
@@ -98,18 +101,10 @@ def checkProvides(libName, lib, indexdata):
     worklist = [(libName, lib)]
     visited = []
     origVisited = set()
-    origVisited = checkProvides2(
-        worklist,
-        visited,
-        libName,
-        origVisited,
-        indexdata)
+    origVisited = checkProvides2(worklist, visited, libName, origVisited, indexdata)
     if origVisited:
-        print(
-            "Found cycle. Changing provides to convertFromVersion: %s %s %s" %
-            (libName, lib['version'], origVisited))
-        lib['convertFromVersion'] = lib.get(
-            "convertFromVersion", []) + lib['provides']
+        print("Found cycle. Changing provides to convertFromVersion: %s %s %s" % (libName, lib['version'], origVisited))
+        lib['convertFromVersion'] = lib.get("convertFromVersion", []) + lib['provides']
         del lib['provides']
 
 
@@ -121,8 +116,7 @@ def main():
     with open("rawdata.json", "r") as f:
         rawdata = json.load(f)
 
-    indexdata = {"libs": {}, "mirrors": [
-        "https://libraries.openmodelica.org/cache/"]}
+    indexdata = {"libs": {}, "mirrors": ["https://libraries.openmodelica.org/cache/"]}
     for firstKey in rawdata.keys():
         data = rawdata[firstKey]
         for refKey in data["refs"].keys():
@@ -133,45 +127,42 @@ def main():
                 raise Exception(firstKey + " " + refKey)
             for libName in r["libs"]:
                 lib = r["libs"][libName]
+                isgit = False
                 if libName not in indexdata["libs"]:
                     if "github" in repos[firstKey]:
                         indexdata["libs"][libName] = {
                             "git": "https://github.com/%s.git" %
                             repos[firstKey]["github"], "versions": {}}
                         isgit = True
                     elif "git" in repos[firstKey]:
-                        indexdata["libs"][libName] = {
-                            "git": repos[firstKey]["git"], "versions": {}}
+                        indexdata["libs"][libName] = {"git": repos[firstKey]["git"], "versions": {}}
                         isgit = True
                     else:
                         indexdata["libs"][libName] = {"versions": {}}
-                        isgit = False
                 libdict = indexdata["libs"][libName]["versions"]
                 if lib['version'] in libdict.keys():
                     if len(common.VersionNumber(refKey).prerelease) > 0:
                         continue
-                    print(
-                        'Duplicate entry for %s %s (%s)' %
-                        (libName, lib['version'], refKey))
+                    print('Duplicate entry for %s %s (%s)' % (libName, lib['version'], refKey))
                 entry = {}
 
                 if isgit:
-                    if "sha" in r or "zip" not in r:  # If we have zip-file but no sha, we might use a releases zip for a tag we don't know the SHA of
+                    # If we have zip-file but no sha, we might use a releases zip for a tag we don't know the SHA of
+                    if "sha" in r or "zip" not in r:
                         entry['sha'] = r['sha']
                 entry['path'] = lib['path']
                 entry['version'] = lib['version']
                 if "zip" in r:
                     entry['zipfile'] = r["zip"]
                 elif "github" in repos[firstKey]:
-                    entry['zipfile'] = "https://github.com/%s/archive/%s.zip" % (
-                        repos[firstKey]["github"], r['sha'])
+                    entry['zipfile'] = "https://github.com/%s/archive/%s.zip" % (repos[firstKey]["github"], r['sha'])
                 elif "zipfile" in repos[firstKey]:
-                    entry['zipfile'] = repos[firstKey]["zipfile"].format(
-                        r['sha'])
+                    entry['zipfile'] = repos[firstKey]["zipfile"].format(r['sha'])
                 else:
                     raise Exception(
-                        "Entry does not list an entry \"zip\" (manually added zip-file), \"github\" (project name), or \"zipfile\" URL from where to download the git hash (gitlab/etc):\n" +
-                        str(r))
+                        "Entry does not list an entry \"zip\" (manually added zip-file), "
+                        "\"github\" (project name), or \"zipfile\" URL from where to download "
+                        "the git hash (gitlab/etc):\n" + str(r))
                 if 'provides' in lib:
                     entry['provides'] = lib['provides']
                 if 'uses' in lib:
@@ -180,8 +171,7 @@ def main():
                     entry['convertFromVersion'] = lib['convertFromVersion']
                 if repos[firstKey].get('singleFileStructureCopyAllFiles'):
                     entry['singleFileStructureCopyAllFiles'] = True
-                entry['support'] = common.getSupportLevel(
-                    lib['version'], repos[firstKey]['support'])
+                entry['support'] = common.getSupportLevel(lib['version'], repos[firstKey]['support'])
 
                 libdict[lib['version']] = entry
                 # print(entry)