Replace PyGithub with ghapi (has better license) (#375)

Signed-off-by: Ziv Nevo <[email protected]>

Author: zivnevo

nca/FileScanners/GenericTreeScanner.py

@@ -43,19 +43,15 @@ def is_yaml_file(file_name):
         extension = os.path.splitext(file_name)[1]
         return extension in {'.yaml', '.yml', '.json'}
 
-    def _yield_yaml_file(self, path, stream, from_repo=False):
+    def _yield_yaml_file(self, path, stream):
         """
         yields the yaml file for its data
         :param str path: the path of the file
         :param stream: an IO-Text stream or Union of the file contents, depends on the scanner's type
-        :param bool from_repo: indicates if the given path is from a repository
         """
-        decoded_stream = stream
-        if from_repo:
-            decoded_stream = stream.decoded_content
         yaml = YAML(typ="rt") if self.rt_load else YAML(typ="safe")
         try:
-            yield YamlFile(yaml.load_all(decoded_stream), path)
+            yield YamlFile(yaml.load_all(stream), path)
         except error.MarkedYAMLError as parse_error:
             print(f'{parse_error.problem_mark.name}:{parse_error.problem_mark.line}:{parse_error.problem_mark.column}:',
                   'Parse Error:', parse_error.problem, file=stderr)

nca/FileScanners/GitScanner.py

@@ -6,7 +6,7 @@
 import os
 from urllib.parse import urlparse
 from urllib.request import urlopen
-from github import Github, GithubException
+from ghapi.all import GhApi
 from .GenericTreeScanner import GenericTreeScanner
 
 
@@ -33,37 +33,15 @@ def __init__(self, url, rt_load=False):
             self.url_path = parsed_url.path.split('/', maxsplit=5)
             if len(self.url_path) < 3:
                 raise Exception(f'Bad GitHub URL: {url}')
-            self.ghe = Github(base_url=ghe_base_url, login_or_token=os.environ.get('GHE_TOKEN'))
-            self.repo = self._get_repo()
-            self.ref = self.url_path[4] if len(self.url_path) >= 5 else 'master'
-
-    def _get_repo(self):
-        """
-        :return: An instance of the Repository API class matching the repository in the url
-        :rtype: github.Repository.Repository
-        """
-        try:
-            org = self.ghe.get_organization(str(self.url_path[1]))
-        except GithubException:
-            try:
-                org = self.ghe.get_user(self.url_path[1])
-            except GithubException:
-                org = None
-        if org is None:
-            raise Exception(f'GitHub URL {self.url} does not point to a valid repository')
-
-        try:
-            repo = org.get_repo(str(self.url_path[2]))
-        except GithubException:
-            repo = None
-        if repo is None:
-            raise Exception(f'GitHub URL {self.url} does not point to a valid repository')
-        return repo
+            self.ghe = GhApi(gh_host=ghe_base_url, owner=self.url_path[1], repo=self.url_path[2],
+                             token=os.environ.get('GHE_TOKEN'))
+            self.ref = 'heads/' + (self.url_path[4] if len(self.url_path) >= 5 else 'master')
 
     def _scan_dir_in_repo(self, path, recursive):
         if path and not path.endswith('/'):
             path += '/'
-        git_tree = self.repo.get_git_tree(self.ref, True)
+        ref = self.ghe.git.get_ref(ref=self.ref)
+        git_tree = self.ghe.git.get_tree(tree_sha=ref.object.sha, recursive='True')
         for element in git_tree.tree:
             if element.type != 'blob':
                 continue
@@ -74,7 +52,7 @@ def _scan_dir_in_repo(self, path, recursive):
             if not recursive and element.path.count('/') != path.count('/'):
                 continue
 
-            yield from self._yield_yaml_file(element.path, self.repo.get_contents(element.path, self.ref), True)
+            yield from self._yield_yaml_file(element.path, self.ghe.get_content(path=element.path))
 
     def get_yamls(self):
         """
@@ -94,7 +72,7 @@ def get_yamls(self):
             path_in_repo = '' if len(self.url_path) == 5 else self.url_path[5]
 
         if is_file:
-            return self._yield_yaml_file(path_in_repo, self.repo.get_contents(path_in_repo, self.ref), True)
+            return self._yield_yaml_file(path_in_repo, self.ghe.get_content(path_in_repo))
         if path_in_repo.endswith('**'):
             return self._scan_dir_in_repo(path_in_repo[:-2], True)  # path_in_repo without **
         return self._scan_dir_in_repo(path_in_repo, False)

requirements.txt

@@ -1,4 +1,4 @@
-PyGithub==1.57
+ghapi==1.0.3
 ruamel.yaml==0.17.21
 Flask==2.2.2
 PyYAML==6.0

setup.cfg

@@ -18,7 +18,7 @@ classifiers =
 [options]
 packages = find:
 install_requires =
-    PyGithub==1.57
+    ghapi==1.0.3
     ruamel.yaml==0.17.21
     Flask==2.2.2
     PyYAML==6.0