Merge pull request #2877 from SchoolGuy/add_typing_hints

Add typing hints

docs/pkglistgen.md

@@ -1,25 +1,25 @@
 # Package List Generator
 
-pkglistgen.py is a self contained script to generate and update OBS products for openSUSE and SLE. 
+pkglistgen.py is a self contained script to generate and update OBS products for openSUSE and SLE.
 It works on the products and its staging projects and ports.
 
 The main input is a package named 000package-groups and it will update the content of other packages
 from that. For that it will read [YAML](https://en.wikipedia.org/wiki/YAML) input from e.g. 000package-groups/groups.yml and generate .group files into 000product. The rest of 000package-groups is copied into 000product as well and it runs the OBS product converter service (See [OBS Documentation](https://en.opensuse.org/openSUSE:Build_Service_product_definition) for details)
-The generated release spec files are split into 000release-packages to avoid needless rebuilds. 
+The generated release spec files are split into 000release-packages to avoid needless rebuilds.
 
 ## Input
 
-The package list generator reads several files. The most important are group*.yml (tradionally only groups.yml) within 000package-groups.
+The package list generator reads several files. The most important are group*.yml (traditionally only groups.yml) within 000package-groups.
 
 ### supportstatus.txt
 The file lists the packages and their support level. It's only necessary to list packages here that have a different level than the default level specificied in the groups. The format is plain text: <package name> <level> - the level is handed over 1:1 to KIWI file. Currently used values are: unsupported, l2 and l3
- 
+
 ### group*.yml
 The file is a list of package lists and the special hash 'OUTPUT'. OUTPUT contains an entry for every group file that needs to be written out. The group name of it needs to exist as package list as well. OUTPUT also contains flags for the groups.
 
 We currently support:
  * default-support
- Sets the support level in case there is no explicitly entry in [supportstatus.txt](#supportstatus.txt), defaults to 'unsupported'
+ Sets the support level in case there is no explicitly entry in [supportstatus.txt](#supportstatustxt), defaults to 'unsupported'
  * recommends
  If the solver should take recommends into account when solving the package list, defaults to false.
  * includes
@@ -31,7 +31,7 @@ We currently support:
 
 Be aware that group names must not contain a '-'.
 
-You can also adapt the solving on a package level by putting a hash into the package list. Normally the package name is a string, in case it's a hash the key needs to be the package name and the value is a list of following modifiers: 
+You can also adapt the solving on a package level by putting a hash into the package list. Normally the package name is a string, in case it's a hash the key needs to be the package name and the value is a list of following modifiers:
 
  * recommended
  Evaluate also 'Recommends' in package to determine dependencies. Otherwise only 'required' are considered. Used mainly for patterns in SLE. It can not be combined with platforms, For architecture specific recommends, use patterns.
@@ -46,7 +46,7 @@ You can also adapt the solving on a package level by putting a hash into the pac
  * required
  If the package is missing or is uninstallable, don't leave a comment but put the error as package entry for OBS to create unresolvable error to avoid building a DVD
 
-Note that you can write yaml lists in 2 ways. You can put the modifier lists as multiple lines starting with -, but it's recommended to put them as [M1,M2] behind the package name. See the difference between pkg4 and pkg5 in the example. 
+Note that you can write yaml lists in 2 ways. You can put the modifier lists as multiple lines starting with -, but it's recommended to put them as [M1,M2] behind the package name. See the difference between pkg4 and pkg5 in the example.
 
 #### Example:
 
@@ -68,32 +68,32 @@ OUTPUT:
   - group3:
     includes:
     - list2
-    
+
 group1:
   - pkg1
-  
+
 group2:
   - pkg2: [locked]
   - pkg3
-  
+
 group3:
   - pkg4: [x86_64]
-  
+
 list1:
   - pkg5:
     - x86_64
-  
+
 list2:
   - pkg6: [recommended]
-``` 
+```
 
-## Overlap calculcation
+## Overlap calculation
- TODO 
+ TODO
 
 ## Handling in staging workflow
-If 000package-groups contains a file named summary-staging.txt, the bot will trigger a diff mode on staging projects. 
+If 000package-groups contains a file named summary-staging.txt, the bot will trigger a diff mode on staging projects.
 It will create an equal summary-staging.txt in 000product and create a comment with a human readable diff in the staging
 project. This comment can be replied to. If the reply starts with 'approve', staging accept will apply the diff to this
 txt file. If the reply starts with 'ignore', the bot will continue with the pipeline and do nothing on staging accept.
 
-This way simple changes to the summary can be accepted without a submit request (of which there can only be one at a time).
+This way simple changes to the summary can be accepted without a submit request (of which there can only be one at a time).

osclib/core.py

@@ -6,6 +6,7 @@ import socket
 import logging
 from lxml import etree as ET
 from urllib.error import HTTPError
+from typing import Optional
 
 from osc.core import create_submit_request
 from osc.core import get_binarylist
@@ -413,7 +414,7 @@ def package_list_kind_filtered(apiurl, project, kinds_allowed=['source']):
         yield package
 
 
-def attribute_value_load(apiurl, project, name, namespace='OSRT', package=None):
+def attribute_value_load(apiurl: str, project: str, name: str, namespace='OSRT', package: Optional[str] = None):
     path = list(filter(None, ['source', project, package, '_attribute', namespace + ':' + name]))
     url = makeurl(apiurl, path)
 
@@ -444,7 +445,14 @@ def attribute_value_load(apiurl, project, name, namespace='OSRT', package=None):
 # Remember to create for both OBS and IBS as necessary.
 
 
-def attribute_value_save(apiurl, project, name, value, namespace='OSRT', package=None):
+def attribute_value_save(
+    apiurl: str,
+    project: str,
+    name: str,
+    value: str,
+    namespace='OSRT',
+    package: Optional[str] = None
+):
     root = ET.Element('attributes')
 
     attribute = ET.SubElement(root, 'attribute')
@@ -463,13 +471,13 @@ def attribute_value_save(apiurl, project, name, value, namespace='OSRT', package
         raise e
 
 
-def attribute_value_delete(apiurl, project, name, namespace='OSRT', package=None):
+def attribute_value_delete(apiurl: str, project: str, name: str, namespace='OSRT', package: Optional[str] = None):
     http_DELETE(makeurl(
         apiurl, list(filter(None, ['source', project, package, '_attribute', namespace + ':' + name]))))
 
 
 @memoize(session=True)
-def repository_path_expand(apiurl, project, repo, visited_repos=None):
+def repository_path_expand(apiurl: str, project: str, repo: str, visited_repos: Optional[set] = None):
     """Recursively list underlying projects."""
     if visited_repos is None:
         visited_repos = set()

osclib/pkglistgen_comments.py

@@ -1,27 +1,58 @@
 import datetime
-import textwrap
+import enum
-import re
-import tempfile
 import logging
 import os
+import re
 import sys
+import tempfile
+import textwrap
+from typing import Dict, List, Optional
+
 from lxml import etree as ET
+from osc.core import Package, checkout_package, http_GET, makeurl
 
 from osclib.comments import CommentAPI
-from osc.core import checkout_package, http_GET, makeurl
-from osc.core import Package
 
 MARKER = 'PackageListDiff'
 
 
-class PkglistComments(object):
+class PkglistSectionCommend(enum.Enum):
+    ADD = "add"
+    REMOVE = "remove"
+    MOVE = "move"
+
+
+class PkglistSection:
+    def __init__(
+        self,
+        command: PkglistSectionCommend,
+        pkgs: Optional[List[str]] = None,
+        to_module: Optional[List[str]] = None,
+        from_module: Optional[List[str]] = None
+    ):
+        self.command = command
+        if pkgs is None:
+            self.pkgs = []
+        else:
+            self.pkgs = pkgs
+        if pkgs is None:
+            self.to_module = []
+        else:
+            self.to_module = to_module
+        if pkgs is None:
+            self.from_module = []
+        else:
+            self.from_module = from_module
+
+
+class PkglistComments:
     """Handling staging comments of diffs"""
 
-    def __init__(self, apiurl):
+    def __init__(self, apiurl: str):
         self.apiurl = apiurl
         self.comment = CommentAPI(apiurl)
 
-    def read_summary_file(self, file):
+    def read_summary_file(self, file: str) -> Dict[str, List[str]]:
         ret = dict()
         with open(file, 'r') as f:
             for line in f:
@@ -30,7 +61,7 @@ class PkglistComments(object):
                 ret[pkg].append(group)
         return ret
 
-    def write_summary_file(self, file, content):
+    def write_summary_file(self, file: str, content: dict):
         output = []
         for pkg in sorted(content):
             for group in sorted(content[pkg]):
@@ -40,7 +71,7 @@ class PkglistComments(object):
             for line in sorted(output):
                 f.write(line + '\n')
 
-    def calculcate_package_diff(self, old_file, new_file):
+    def calculcate_package_diff(self, old_file: str, new_file: str):
         old_file = self.read_summary_file(old_file)
         new_file = self.read_summary_file(new_file)
 
@@ -102,7 +133,7 @@ class PkglistComments(object):
 
         return report.strip()
 
-    def handle_package_diff(self, project, old_file, new_file):
+    def handle_package_diff(self, project: str, old_file: str, new_file: str):
         comments = self.comment.get_comments(project_name=project)
         comment, _ = self.comment.comment_find(comments, MARKER)
 
@@ -134,7 +165,7 @@ class PkglistComments(object):
 
         return 1
 
-    def is_approved(self, comment, comments):
+    def is_approved(self, comment, comments: dict) -> str | None:
         if not comment:
             return None
 
@@ -145,19 +176,28 @@ class PkglistComments(object):
                     return c['who']
         return None
 
-    def parse_title(self, line):
+    def parse_title(self, line: str) -> Optional[PkglistSection]:
         m = re.match(r'\*\*Add to (.*)\*\*', line)
         if m:
-            return {'cmd': 'add', 'to': m.group(1).split(','), 'pkgs': []}
+            return PkglistSection(PkglistSectionCommend.ADD, pkgs=[], to_module=m.group(1).split(','))
         m = re.match(r'\*\*Move from (.*) to (.*)\*\*', line)
         if m:
-            return {'cmd': 'move', 'from': m.group(1).split(','), 'to': m.group(2).split(','), 'pkgs': []}
+            return PkglistSection(
+                PkglistSectionCommend.MOVE,
+                pkgs=[],
+                from_module=m.group(1).split(','),
+                to_module=m.group(2).split(','),
+            )
         m = re.match(r'\*\*Remove from (.*)\*\*', line)
         if m:
-            return {'cmd': 'remove', 'from': m.group(1).split(','), 'pkgs': []}
+            return PkglistSection(
+                PkglistSectionCommend.REMOVE,
+                pkgs=[],
+                from_module=m.group(1).split(','),
+            )
         return None
 
-    def parse_sections(self, comment):
+    def parse_sections(self, comment: str) -> List[PkglistSection]:
         current_section = None
         sections = []
         in_quote = False
@@ -174,33 +214,33 @@ class PkglistComments(object):
                 for pkg in line.split(','):
                     pkg = pkg.strip()
                     if pkg:
-                        current_section['pkgs'].append(pkg)
+                        current_section.pkgs.append(pkg)
         if current_section:
             sections.append(current_section)
         return sections
 
-    def apply_move(self, content, section):
+    def apply_move(self, content: Dict[str, List[str]], section: PkglistSection):
-        for pkg in section['pkgs']:
+        for pkg in section.pkgs:
             pkg_content = content[pkg]
-            for group in section['from']:
+            for group in section.from_module:
                 try:
                     pkg_content.remove(group)
                 except ValueError:
                     logging.error(f"Can't remove {pkg} from {group}, not there. Mismatch.")
                     sys.exit(1)
-            for group in section['to']:
+            for group in section.to_module:
                 pkg_content.append(group)
             content[pkg] = pkg_content
 
-    def apply_add(self, content, section):
+    def apply_add(self, content: Dict[str, List[str]], section: PkglistSection):
-        for pkg in section['pkgs']:
+        for pkg in section.pkgs:
             content.setdefault(pkg, [])
-            content[pkg] += section['to']
+            content[pkg] += section.to_module
 
-    def apply_remove(self, content, section):
+    def apply_remove(self, content: Dict[str, List[str]], section: PkglistSection):
-        for pkg in section['pkgs']:
+        for pkg in section.pkgs:
             pkg_content = content[pkg]
-            for group in section['from']:
+            for group in section.from_module:
                 try:
                     pkg_content.remove(group)
                 except ValueError:
@@ -208,38 +248,38 @@ class PkglistComments(object):
                     sys.exit(1)
             content[pkg] = pkg_content
 
-    def apply_commands(self, filename, sections):
+    def apply_commands(self, filename: str, sections: List[PkglistSection]):
         content = self.read_summary_file(filename)
         for section in sections:
-            if section['cmd'] == 'move':
+            if section.command == PkglistSectionCommend.MOVE:
                 self.apply_move(content, section)
-            elif section['cmd'] == 'add':
+            elif section.command == PkglistSectionCommend.ADD:
                 self.apply_add(content, section)
-            elif section['cmd'] == 'remove':
+            elif section.command == PkglistSectionCommend.REMOVE:
                 self.apply_remove(content, section)
         self.write_summary_file(filename, content)
 
-    def format_pkgs(self, pkgs):
+    def format_pkgs(self, pkgs: List[str]):
         text = ', '.join(pkgs)
         return "  " + "\n  ".join(textwrap.wrap(text, width=68, break_long_words=False, break_on_hyphens=False)) + "\n\n"
 
-    def format_move(self, section):
+    def format_move(self, section: PkglistSection):
-        gfrom = ','.join(section['from'])
+        gfrom = ','.join(section.from_module)
-        gto = ','.join(section['to'])
+        gto = ','.join(section.to_module)
         text = f"  * Move from {gfrom} to {gto}:\n"
-        return text + self.format_pkgs(section['pkgs'])
+        return text + self.format_pkgs(section.pkgs)
 
-    def format_add(self, section):
+    def format_add(self, section: PkglistSection):
-        gto = ','.join(section['to'])
+        gto = ','.join(section.to_module)
         text = f"  * Add to {gto}:\n"
-        return text + self.format_pkgs(section['pkgs'])
+        return text + self.format_pkgs(section.pkgs)
 
-    def format_remove(self, section):
+    def format_remove(self, section: PkglistSection):
-        gfrom = ','.join(section['from'])
+        gfrom = ','.join(section.from_module)
         text = f"  * Remove from {gfrom}:\n"
-        return text + self.format_pkgs(section['pkgs'])
+        return text + self.format_pkgs(section.pkgs)
 
-    def apply_changes(self, filename, sections, approver):
+    def apply_changes(self, filename: str, sections: List[PkglistSection], approver: str):
         text = "-------------------------------------------------------------------\n"
         now = datetime.datetime.utcnow()
         date = now.strftime("%a %b %d %H:%M:%S UTC %Y")
@@ -249,11 +289,11 @@ class PkglistComments(object):
         email = root.find('email').text
         text += f"{date} - {realname} <{email}>\n\n- Approved changes to summary-staging.txt\n"
         for section in sections:
-            if section['cmd'] == 'move':
+            if section.command == PkglistSectionCommend.MOVE:
                 text += self.format_move(section)
-            elif section['cmd'] == 'add':
+            elif section.command == PkglistSectionCommend.ADD:
                 text += self.format_add(section)
-            elif section['cmd'] == 'remove':
+            elif section.command == PkglistSectionCommend.REMOVE:
                 text += self.format_remove(section)
         with open(filename + '.new', 'w') as writer:
             writer.write(text)
@@ -262,7 +302,7 @@ class PkglistComments(object):
                     writer.write(line)
         os.rename(filename + '.new', filename)
 
-    def check_staging_accept(self, project, target):
+    def check_staging_accept(self, project: str, target: str):
         comments = self.comment.get_comments(project_name=project)
         comment, _ = self.comment.comment_find(comments, MARKER)
         approver = self.is_approved(comment, comments)

osclib/stagingapi.py

@@ -1,5 +1,6 @@
 from io import StringIO
 from datetime import datetime
+from typing import List
 import dateutil.parser
 import logging
 import textwrap
@@ -52,7 +53,7 @@ class StagingAPI(object):
     Class containing various api calls to work with staging projects.
     """
 
-    def __init__(self, apiurl, project):
+    def __init__(self, apiurl: str, project: str):
         """Initialize instance variables."""
 
         self.apiurl = apiurl
@@ -149,7 +150,7 @@ class StagingAPI(object):
         xpath = f'repository[@name="{repo_name}"]'
         return len(meta.xpath(xpath)) > 0
 
-    def makeurl(self, paths, query=None):
+    def makeurl(self, paths: List[str], query=None) -> str:
         """
         Wrapper around osc's makeurl passing our apiurl
         :return url made for l and query

pkglistgen/cli.py

@@ -86,7 +86,7 @@ class CommandLineInterface(ToolBase.CommandLineInterface):
         if apiurl.find('opensuse.org') > 0:
             os.environ['OBS_NAME'] = 'build.opensuse.org'
 
-        def solve_project(project, scope):
+        def solve_project(project, scope: str):
             try:
                 self.tool.reset()
                 self.tool.dry_run = self.options.dry

pkglistgen/tool.py

@@ -8,6 +8,8 @@ import shutil
 import subprocess
 import yaml
 
+from typing import Any, Mapping, Optional
+
 from lxml import etree as ET
 
 from osc.core import checkout_package
@@ -175,7 +177,7 @@ class PkgListGen(ToolBase.ToolBase):
                     if package[0] not in g.solved_packages['*']:
                         self.logger.error(f'Missing {package[0]} in {groupname} for {arch}')
 
-    def expand_repos(self, project, repo='standard'):
+    def expand_repos(self, project: str, repo='standard'):
         return repository_path_expand(self.apiurl, project, repo)
 
     def _check_supplements(self):
@@ -506,7 +508,13 @@ class PkgListGen(ToolBase.ToolBase):
                 print('%endif', file=output)
         output.flush()
 
-    def solve_project(self, ignore_unresolvable=False, ignore_recommended=False, locale=None, locales_from=None):
+    def solve_project(
+        self,
+        ignore_unresolvable=False,
+        ignore_recommended=False,
+        locale: Optional[str] = None,
+        locales_from: Optional[str] = None
+    ):
         self.load_all_groups()
         if not self.output:
             self.logger.error('OUTPUT not defined')
@@ -601,9 +609,19 @@ class PkgListGen(ToolBase.ToolBase):
             new_lines.append(line.replace('<version></version>', product_version))
         open(product_file, 'w').write(''.join(new_lines))
 
-    def update_and_solve_target(self, api, target_project, target_config, main_repo,
+    def update_and_solve_target(
-                                project, scope, force, no_checkout,
+        self,
-                                only_release_packages, stop_after_solve):
+        api,
+        target_project: str,
+        target_config: Mapping[str, Any],
+        main_repo: str,
+        project: str,
+        scope: str,
+        force: bool,
+        no_checkout: bool,
+        only_release_packages: bool,
+        stop_after_solve: bool
+    ):
         self.all_architectures = target_config.get('pkglistgen-archs').split(' ')
         self.use_newest_version = str2bool(target_config.get('pkglistgen-use-newest-version', 'False'))
         self.repos = self.expand_repos(project, main_repo)
@@ -682,11 +700,12 @@ class PkgListGen(ToolBase.ToolBase):
             self.load_all_groups()
             self.write_group_stubs()
         else:
-            summary = self.solve_project(ignore_unresolvable=str2bool(target_config.get('pkglistgen-ignore-unresolvable')),
+            summary = self.solve_project(
-                                         ignore_recommended=str2bool(
+                ignore_unresolvable=str2bool(target_config.get('pkglistgen-ignore-unresolvable')),
-                                             target_config.get('pkglistgen-ignore-recommended')),
+                ignore_recommended=str2bool(target_config.get('pkglistgen-ignore-recommended')),
-                                         locale=target_config.get('pkglistgen-locale'),
+                locale=target_config.get('pkglistgen-locale'),
-                                         locales_from=target_config.get('pkglistgen-locales-from'))
+                locales_from=target_config.get('pkglistgen-locales-from')
+            )
 
         if stop_after_solve:
             return