From 6705df1b3be7279a7bf294fcfa4b939ba1e30850 Mon Sep 17 00:00:00 2001 From: Nicola Soranzo Date: Tue, 31 Oct 2023 09:55:43 +0000 Subject: [PATCH] Format with black and lint with ruff and mypy Add continuous integration for linting. --- .github/workflows/lint.yaml | 20 +++ bin/extract_galaxy_tools.py | 272 +++++++++++++++++++----------------- mypy.ini | 11 ++ pyproject.toml | 19 +++ tox.ini | 18 +++ 5 files changed, 209 insertions(+), 131 deletions(-) create mode 100644 .github/workflows/lint.yaml create mode 100644 mypy.ini create mode 100644 pyproject.toml create mode 100644 tox.ini diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml new file mode 100644 index 00000000..23a9ec05 --- /dev/null +++ b/.github/workflows/lint.yaml @@ -0,0 +1,20 @@ +name: Lint +on: [push, pull_request] +concurrency: + group: lint-${{ github.ref }} + cancel-in-progress: true +jobs: + lint: + runs-on: ubuntu-latest + strategy: + matrix: + python-version: ['3.8', '3.11'] + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + - name: Install tox + run: python -m pip install 'tox>=1.8.0' + - name: Lint + run: tox -e lint diff --git a/bin/extract_galaxy_tools.py b/bin/extract_galaxy_tools.py index c25c51ae..11cbd2d5 100644 --- a/bin/extract_galaxy_tools.py +++ b/bin/extract_galaxy_tools.py @@ -5,65 +5,67 @@ import time import xml.etree.ElementTree as et from pathlib import Path -from unicodedata import category +from typing import List import pandas as pd import requests import yaml from github import Github +from github.ContentFile import ContentFile +from github.Repository import Repository -# config variables - +# Config variables # BIOTOOLS_API_URL = "https://bio.tools" BIOTOOLS_API_URL = "https://130.226.25.21" + def read_file(filepath): - ''' + """ Read an optional file with 1 element per line :param filepath: path to a file - ''' + """ if filepath is None: return [] fp = Path(filepath) if fp.is_file(): - with fp.open('r') as f: + with fp.open("r") as f: return [x.rstrip() for x in f.readlines()] else: return [] def get_string_content(cf): - ''' + """ Get string of the content from a ContentFile :param cf: GitHub ContentFile object - ''' - return base64.b64decode(cf.content).decode('utf-8') + """ + return base64.b64decode(cf.content).decode("utf-8") -def get_tool_github_repositories(g): - ''' +def get_tool_github_repositories(g: Github) -> List[str]: + """ Get list of tool GitHub repositories to parse :param g: GitHub instance - ''' + """ repo = g.get_user("galaxyproject").get_repo("planemo-monitor") - repo_list = [] + repo_list: List[str] = [] for i in range(1, 5): repo_f = repo.get_contents(f"repositories0{i}.list") repo_l = get_string_content(repo_f).rstrip() repo_list += repo_l.split("\n") - return(repo_list) + return repo_list -def get_github_repo(url, g): - ''' +def get_github_repo(url: str, g: Github) -> Repository: + """ Get a GitHub Repository object from an URL :param url: URL to a GitHub repository :param g: GitHub instance - ''' + """ if not url.startswith("https://github.com/"): raise ValueError if url.endswith("/"): @@ -75,13 +77,13 @@ def get_github_repo(url, g): def get_shed_attribute(attrib, shed_content, empty_value): - ''' + """ Get a shed attribute :param attrib: attribute to extract :param shed_content: content of the .shed.yml :param empty_value: value to return if attribute not found - ''' + """ if attrib in shed_content: return shed_content[attrib] else: @@ -89,30 +91,31 @@ def get_shed_attribute(attrib, shed_content, empty_value): def get_biotools(el): - ''' + """ Get bio.tools information :param el: Element object - ''' - xrefs = el.find('xrefs') + """ + xrefs = el.find("xrefs") if xrefs is not None: - xref = xrefs.find('xref') - if xref is not None and xref.attrib['type'] == 'bio.tools': + xref = xrefs.find("xref") + if xref is not None and xref.attrib["type"] == "bio.tools": return xref.text return None + def get_conda_package(el): - ''' + """ Get conda package information :param el: Element object - ''' - reqs = el.find('requirements') + """ + reqs = el.find("requirements") if reqs is not None: - req = reqs.find('requirement') + req = reqs.find("requirement") if req is not None: return req.text - #for req in reqs.findall('requirement'): + # for req in reqs.findall('requirement'): # if 'version' in req.attrib: # if req.attrib['version'] == '@VERSION@' or req.attrib['version'] == '@TOOL_VERSION@': # return req.text @@ -125,12 +128,12 @@ def get_conda_package(el): def check_categories(ts_categories, ts_cat): - ''' + """ Check if tool fit in ToolShed categories to keep :param ts_categories: tool ToolShed categories :param ts_cat: list of ToolShed categories to keep in the extraction - ''' + """ if ts_categories is not None and len(ts_cat) > 0: to_keep = False for cat in ts_categories: @@ -141,7 +144,7 @@ def check_categories(ts_categories, ts_cat): def get_tool_metadata(tool, repo, ts_cat, excluded_tools, keep_tools): - ''' + """ Get tool information - Check the `.shed.yaml` file - Extract metadata from the `.shed.yaml` @@ -154,108 +157,109 @@ def get_tool_metadata(tool, repo, ts_cat, excluded_tools, keep_tools): :param ts_cat: list of ToolShed categories to keep in the extraction :param excluded_tools: list of tools to skip :param keep_tools: list of tools to keep - ''' - if tool.type != 'dir': + """ + if tool.type != "dir": return None metadata = { - 'Galaxy wrapper id': tool.name, - 'Galaxy tool ids': [], - 'Description': None, - 'bio.tool id': None, - 'bio.tool name': None, - 'bio.tool description': None, - 'EDAM operation': [], - 'EDAM topic': [], - 'Status': "To update", - 'Source': None, - 'ToolShed categories': [], - 'ToolShed id': None, - 'Galaxy wrapper owner': None, - 'Galaxy wrapper source': None, - 'Galaxy wrapper version': None, - 'bio.tool id': None, - 'Conda id': None, - 'Conda version': None, - 'Reviewed': tool.name in keep_tools or tool.name in excluded_tools, - 'To keep':'' + "Galaxy wrapper id": tool.name, + "Galaxy tool ids": [], + "Description": None, + "bio.tool id": None, + "bio.tool name": None, + "bio.tool description": None, + "EDAM operation": [], + "EDAM topic": [], + "Status": "To update", + "Source": None, + "ToolShed categories": [], + "ToolShed id": None, + "Galaxy wrapper owner": None, + "Galaxy wrapper source": None, + "Galaxy wrapper version": None, + "Conda id": None, + "Conda version": None, + "Reviewed": tool.name in keep_tools or tool.name in excluded_tools, + "To keep": "", } if tool.name in keep_tools: - metadata['To keep'] = True + metadata["To keep"] = True elif tool.name in excluded_tools: - metadata['To keep'] = False + metadata["To keep"] = False # extract .shed.yml information and check macros.xml try: shed = repo.get_contents(f"{tool.path}/.shed.yml") - except: + except Exception: return None else: file_content = get_string_content(shed) yaml_content = yaml.load(file_content, Loader=yaml.FullLoader) - metadata['Description'] = get_shed_attribute('description', yaml_content, None) - if metadata['Description'] is None: - metadata['Description'] = get_shed_attribute('long_description', yaml_content, None) - if metadata['Description'] is not None: - metadata['Description'] = metadata['Description'].replace("\n","") - metadata['ToolShed id'] = get_shed_attribute('name', yaml_content, None) - metadata['Galaxy wrapper owner'] = get_shed_attribute('owner', yaml_content, None) - metadata['Galaxy wrapper source'] = get_shed_attribute('remote_repository_url', yaml_content, None) - if 'homepage_url' in yaml_content: - metadata['Source'] = yaml_content['homepage_url'] - metadata['ToolShed categories'] = get_shed_attribute('categories', yaml_content, []) - if metadata['ToolShed categories'] is None: - metadata['ToolShed categories'] = [] + metadata["Description"] = get_shed_attribute("description", yaml_content, None) + if metadata["Description"] is None: + metadata["Description"] = get_shed_attribute("long_description", yaml_content, None) + if metadata["Description"] is not None: + metadata["Description"] = metadata["Description"].replace("\n", "") + metadata["ToolShed id"] = get_shed_attribute("name", yaml_content, None) + metadata["Galaxy wrapper owner"] = get_shed_attribute("owner", yaml_content, None) + metadata["Galaxy wrapper source"] = get_shed_attribute("remote_repository_url", yaml_content, None) + if "homepage_url" in yaml_content: + metadata["Source"] = yaml_content["homepage_url"] + metadata["ToolShed categories"] = get_shed_attribute("categories", yaml_content, []) + if metadata["ToolShed categories"] is None: + metadata["ToolShed categories"] = [] # filter ToolShed categories and leave function if not in expected categories - if not check_categories(metadata['ToolShed categories'], ts_cat): + if not check_categories(metadata["ToolShed categories"], ts_cat): return None # find and parse macro file for file in repo.get_contents(tool.path): - if 'macro' in file.name and file.name.endswith('xml'): + if "macro" in file.name and file.name.endswith("xml"): file_content = get_string_content(file) root = et.fromstring(file_content) for child in root: - if 'name' in child.attrib: - if child.attrib['name'] == '@TOOL_VERSION@' or child.attrib['name'] == '@VERSION@': - metadata['Galaxy wrapper version'] = child.text - elif child.attrib['name'] == 'requirements': - metadata['Conda id'] = get_conda_package(child) + if "name" in child.attrib: + if child.attrib["name"] == "@TOOL_VERSION@" or child.attrib["name"] == "@VERSION@": + metadata["Galaxy wrapper version"] = child.text + elif child.attrib["name"] == "requirements": + metadata["Conda id"] = get_conda_package(child) biotools = get_biotools(child) if biotools is not None: - metadata['bio.tool id'] = biotools + metadata["bio.tool id"] = biotools # parse XML file and get meta data from there, also tool ids for file in repo.get_contents(tool.path): - if file.name.endswith('xml') and 'macro' not in file.name: + if file.name.endswith("xml") and "macro" not in file.name: file_content = get_string_content(file) try: root = et.fromstring(file_content) - except: + except Exception: print(file_content) else: # version - if metadata['Galaxy wrapper version'] is None: - if 'version' in root.attrib: - version = root.attrib['version'] - if 'VERSION@' not in version: - metadata['Galaxy wrapper version'] = version + if metadata["Galaxy wrapper version"] is None: + if "version" in root.attrib: + version = root.attrib["version"] + if "VERSION@" not in version: + metadata["Galaxy wrapper version"] = version else: - macros = root.find('macros') + macros = root.find("macros") if macros is not None: for child in macros: - if 'name' in child.attrib and (child.attrib['name'] == '@TOOL_VERSION@' or child.attrib['name'] == '@VERSION@'): - metadata['Galaxy wrapper version'] = child.text + if "name" in child.attrib and ( + child.attrib["name"] == "@TOOL_VERSION@" or child.attrib["name"] == "@VERSION@" + ): + metadata["Galaxy wrapper version"] = child.text # bio.tools - if metadata['bio.tool id'] is None: + if metadata["bio.tool id"] is None: biotools = get_biotools(root) if biotools is not None: - metadata['bio.tool id'] = biotools + metadata["bio.tool id"] = biotools # conda package - if metadata['Conda id'] is None: + if metadata["Conda id"] is None: reqs = get_conda_package(root) if reqs is not None: - metadata['Conda id'] = reqs + metadata["Conda id"] = reqs # tool ids - if 'id' in root.attrib: - metadata['Galaxy tool ids'].append(root.attrib['id']) + if "id" in root.attrib: + metadata["Galaxy tool ids"].append(root.attrib["id"]) # get latest conda version and compare to the wrapper version if metadata["Conda id"] is not None: @@ -263,54 +267,56 @@ def get_tool_metadata(tool, repo, ts_cat, excluded_tools, keep_tools): if r.status_code == requests.codes.ok: conda_info = r.json() if "latest_version" in conda_info: - metadata['Conda version'] = conda_info['latest_version'] - if metadata['Conda version'] == metadata['Galaxy wrapper version']: - metadata['Status'] = 'Up-to-date' + metadata["Conda version"] = conda_info["latest_version"] + if metadata["Conda version"] == metadata["Galaxy wrapper version"]: + metadata["Status"] = "Up-to-date" # get bio.tool information if metadata["bio.tool id"] is not None: r = requests.get(f'{BIOTOOLS_API_URL}/api/tool/{metadata["bio.tool id"]}/?format=json') if r.status_code == requests.codes.ok: biotool_info = r.json() if "function" in biotool_info: - for func in biotool_info['function']: - if 'operation' in func: - for op in func['operation']: - metadata['EDAM operation'].append(op['term']) + for func in biotool_info["function"]: + if "operation" in func: + for op in func["operation"]: + metadata["EDAM operation"].append(op["term"]) if "topic" in biotool_info: - for t in biotool_info['topic']: - metadata['EDAM topic'].append(t['term']) + for t in biotool_info["topic"]: + metadata["EDAM topic"].append(t["term"]) if "name" in biotool_info: - metadata['bio.tool name'] = biotool_info['name'] + metadata["bio.tool name"] = biotool_info["name"] if "description" in biotool_info: - metadata['bio.tool description'] = biotool_info['description'].replace("\n","") + metadata["bio.tool description"] = biotool_info["description"].replace("\n", "") return metadata -def parse_tools(repo, ts_cat=[], excluded_tools=[], keep_tools=[]): - ''' +def parse_tools(repo: Repository, ts_cat, excluded_tools, keep_tools): + """ Parse tools in a GitHub repository to expact :param repo: GitHub Repository object :param ts_cat: list of ToolShed categories to keep in the extraction :param excluded_tools: list of tools to skip :param keep_tools: list of tools to keep - ''' + """ # get tool folders - tool_folders = [] + tool_folders: List[List[ContentFile]] = [] try: repo_tools = repo.get_contents("tools") - except: + except Exception: try: repo_tools = repo.get_contents("wrappers") - except: + except Exception: print("No tool folder found") return [] + assert isinstance(repo_tools, list) tool_folders.append(repo_tools) try: repo_tools = repo.get_contents("tool_collections") - except: + except Exception: pass else: + assert isinstance(repo_tools, list) tool_folders.append(repo_tools) # parse folders tools = [] @@ -320,14 +326,16 @@ def parse_tools(repo, ts_cat=[], excluded_tools=[], keep_tools=[]): if g.get_rate_limit().core.remaining < 200: print("WAITING for 1 hour to retrieve GitHub API request access !!!") print() - time.sleep(60*60) + time.sleep(60 * 60) # parse tool try: - shed = repo.get_contents(f"{tool.path}/.shed.yml") - except: - if tool.type != 'dir': + repo.get_contents(f"{tool.path}/.shed.yml") + except Exception: + if tool.type != "dir": continue - for content in repo.get_contents(tool.path): + file_list = repo.get_contents(tool.path) + assert isinstance(file_list, list) + for content in file_list: metadata = get_tool_metadata(content, repo, ts_cat, excluded_tools, keep_tools) if metadata is not None: tools.append(metadata) @@ -338,28 +346,30 @@ def parse_tools(repo, ts_cat=[], excluded_tools=[], keep_tools=[]): return tools -def export_tools(tools, output_fp): - ''' +def export_tools(tools: list, output_fp: str) -> None: + """ Export tool metadata to tsv output file :param tools: dictionary with tools :param output_fp: path to output file - ''' + """ df = pd.DataFrame(tools) - df['ToolShed categories'] = df['ToolShed categories'].apply(lambda x: ', '.join([str(i) for i in x])) - df['EDAM operation'] = df['EDAM operation'].apply(lambda x: ', '.join([str(i) for i in x])) - df['EDAM topic'] = df['EDAM topic'].apply(lambda x: ', '.join([str(i) for i in x])) - df['Galaxy tool ids'] = df['Galaxy tool ids'].apply(lambda x: ', '.join([str(i) for i in x])) + df["ToolShed categories"] = df["ToolShed categories"].apply(lambda x: ", ".join([str(i) for i in x])) + df["EDAM operation"] = df["EDAM operation"].apply(lambda x: ", ".join([str(i) for i in x])) + df["EDAM topic"] = df["EDAM topic"].apply(lambda x: ", ".join([str(i) for i in x])) + df["Galaxy tool ids"] = df["Galaxy tool ids"].apply(lambda x: ", ".join([str(i) for i in x])) df.to_csv(output_fp, sep="\t", index=False) -if __name__ == '__main__': - parser = argparse.ArgumentParser(description='Extract a GitHub project to CSV') - parser.add_argument('--api', '-a', required=True, help="GitHub access token") - parser.add_argument('--output', '-o', required=True, help="Output filepath") - parser.add_argument('--categories', '-c', help="Path to a file with ToolShed category to keep in the extraction (one per line)") - parser.add_argument('--exclude', '-e', help="Path to a file with ToolShed ids of tools to exclude (one per line)") - parser.add_argument('--keep', '-ek', help="Path to a file with ToolShed ids of tools to keep (one per line)") +if __name__ == "__main__": + parser = argparse.ArgumentParser(description="Extract a GitHub project to CSV") + parser.add_argument("--api", "-a", required=True, help="GitHub access token") + parser.add_argument("--output", "-o", required=True, help="Output filepath") + parser.add_argument( + "--categories", "-c", help="Path to a file with ToolShed category to keep in the extraction (one per line)" + ) + parser.add_argument("--exclude", "-e", help="Path to a file with ToolShed ids of tools to exclude (one per line)") + parser.add_argument("--keep", "-ek", help="Path to a file with ToolShed ids of tools to keep (one per line)") args = parser.parse_args() # connect to GitHub diff --git a/mypy.ini b/mypy.ini new file mode 100644 index 00000000..180dae24 --- /dev/null +++ b/mypy.ini @@ -0,0 +1,11 @@ +[mypy] +check_untyped_defs = True +ignore_missing_imports = True +pretty = True +no_implicit_optional = True +no_implicit_reexport = True +show_error_codes = True +strict_equality = True +warn_redundant_casts = True +warn_unused_ignores = True +warn_unreachable = True diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 00000000..ca4018da --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,19 @@ +[tool.black] +line-length = 120 +target-version = ['py38'] +include = '\.pyi?$' + +[tool.darker] +isort = true + +[tool.ruff] +# Enable: pycodestyle errors (E), Pyflakes (F), flake8-bugbear (B), +# flake8-logging-format (G) and pyupgrade (UP) +select = ["E", "F", "B", "G", "UP"] +target-version = "py38" +# Exceptions: +# B008 Do not perform function calls in argument defaults (for FastAPI Depends and Body) +# B9 flake8-bugbear opinionated warnings +# E501 is line length (delegated to black) +# G* are TODOs +ignore = ["B008", "B9", "E501", "G001", "G002", "G004"] diff --git a/tox.ini b/tox.ini new file mode 100644 index 00000000..9ffdce31 --- /dev/null +++ b/tox.ini @@ -0,0 +1,18 @@ +[tox] +envlist = lint + +[testenv:lint] +commands = + ruff . + black --check --diff . + isort --check --diff . + mypy . +deps = + black + isort + mypy + pandas-stubs + ruff + types-PyYAML + types-requests +skip_install = true