Implement typings in conda-smithy

.github/workflows/tests.yml

@@ -66,6 +66,11 @@ jobs:
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: run type check
+        run: |
+          mypy conda_smithy tests
+        continue-on-error: true # type check is optional
+
       - name: coveralls
         uses: coverallsapp/github-action@master
         with:

conda_smithy/anaconda_token_rotation.py

@@ -12,6 +12,7 @@
 import os
 import sys
 from contextlib import redirect_stderr, redirect_stdout
+from typing import Optional, Union
 
 import requests
 from github import Github
@@ -32,17 +33,17 @@ def _get_anaconda_token():
 
 
 def rotate_anaconda_token(
-    user,
-    project,
-    feedstock_config_path,
-    drone=True,
-    circle=True,
-    travis=True,
-    azure=True,
-    appveyor=True,
-    github_actions=True,
-    token_name="BINSTAR_TOKEN",
-    drone_endpoints=(),
+    user: str,
+    project: str,
+    feedstock_config_path: Optional[str],
+    drone: bool = True,
+    circle: bool = True,
+    travis: bool = True,
+    azure: bool = True,
+    appveyor: bool = True,
+    github_actions: bool = True,
+    token_name: str = "BINSTAR_TOKEN",
+    drone_endpoints: Union[list, tuple] = (),
 ):
     """Rotate the anaconda (binstar) token used by the CI providers
 

conda_smithy/ci_skeleton.py

@@ -8,11 +8,19 @@
 
 import os
 import sys
+from typing import Dict
+
+from jinja2.sandbox import SandboxedEnvironment
 
 from conda_smithy.configure_feedstock import make_jinja_env
 
 
-def _render_template(template_file, env, forge_dir, config):
+def _render_template(
+    template_file: str,
+    env: SandboxedEnvironment,
+    forge_dir: str,
+    config: Dict[str, str],
+):
     """Renders the template"""
     template = env.get_template(
         os.path.basename(template_file) + ".ci-skel.tmpl"
@@ -31,10 +39,10 @@ def _render_template(template_file, env, forge_dir, config):
 
 
 def _insert_into_gitignore(
-    feedstock_directory=".",
-    prefix="# conda smithy ci-skeleton start\n",
-    suffix="# conda smithy ci-skeleton end\n",
-):
+    feedstock_directory: str = ".",
+    prefix: str = "# conda smithy ci-skeleton start\n",
+    suffix: str = "# conda smithy ci-skeleton end\n",
+) -> str:
     """Places gitignore contents into gitignore."""
     # get current contents
     fname = os.path.join(feedstock_directory, ".gitignore")
@@ -57,7 +65,9 @@ def _insert_into_gitignore(
 
 
 def generate(
-    package_name="pkg", feedstock_directory=".", recipe_directory="recipe"
+    package_name: str = "pkg",
+    feedstock_directory: str = ".",
+    recipe_directory: str = "recipe",
 ):
     """Generates the CI skeleton."""
     forge_dir = os.path.abspath(feedstock_directory)

conda_smithy/cirun_utils.py

@@ -19,6 +19,7 @@ def get_cirun_installation_id(owner: str) -> int:
     else:
         gh = Github(gh_token())
         user = gh.get_user()
+        user_or_org: Any
         if user.login == owner:
             user_or_org = user
         else:
@@ -42,8 +43,8 @@ def add_repo_to_cirun_resource(
     owner: str,
     repo: str,
     resources: List[str],
-    teams: List,
-    roles: List,
+    teams: Optional[List],
+    roles: Optional[List],
     users_from_json: Optional[str] = None,
     cirun_policy_args: Optional[List[str]] = None,
 ) -> Dict[str, Any]:

conda_smithy/cli.py

@@ -6,7 +6,7 @@
 import tempfile
 import time
 from textwrap import dedent
-from typing import Optional, Union
+from typing import List, Optional, Union
 
 import conda  # noqa
 from conda_build.metadata import MetaData
@@ -27,12 +27,14 @@
 )
 
 
-def default_feedstock_config_path(feedstock_directory):
+def default_feedstock_config_path(feedstock_directory: str) -> str:
     return os.path.join(feedstock_directory, "conda-forge.yml")
 
 
 def generate_feedstock_content(
-    target_directory, source_recipe_dir, conda_build_tool: Optional[str] = None
+    target_directory: str,
+    source_recipe_dir: str,
+    conda_build_tool: Optional[str] = None,
 ):
     target_directory = os.path.abspath(target_directory)
     recipe_dir = "recipe"
@@ -81,10 +83,10 @@ def generate_feedstock_content(
 
 class Subcommand:
     #: The name of the subcommand
-    subcommand = None
-    aliases = []
+    subcommand: Optional[str] = None
+    aliases: List[str] = []
 
-    def __init__(self, parser, help=None):
+    def __init__(self, parser, help: Optional[str] = None):
         subcommand_parser = parser.add_parser(
             self.subcommand, help=help, description=help, aliases=self.aliases
         )