refactor: TYPE_CHECKING conventions for pylint + removal of mypy (bentoml#2034)

Author: aarnphm

.github/workflows/ci.yml

@@ -58,7 +58,6 @@ jobs:
         # TODO: after fix all pylint errors under bentoml uses `make ci-lint` instead
         run: make ci-flake8
       - name: Type check
-        # TODO: after fix all types errors uses `make ci-types` instead
         run: make ci-pyright
 
   documentation_spelling_check:

Makefile

@@ -1,3 +1,4 @@
+SHELL := /bin/bash
 .DEFAULT_GOAL := help
 
 GIT_ROOT ?= $(shell git rev-parse --show-toplevel)
@@ -17,25 +18,10 @@ endif
 CMD := docker run $(CNTR_ARGS)
 TTY := docker run -t $(CNTR_ARGS)
 
-check_defined = \
-    $(strip $(foreach 1,$1, \
-        $(call __check_defined,$1,$(strip $(value 2)))))
-__check_defined = \
-    $(if $(value $1),, \
-        $(error Undefined $1$(if $2, ($2))$(if $(value @), \
-                required by target `$@`)))
-
 __style_src := $(wildcard $(GIT_ROOT)/scripts/ci/style/*.sh)
 __style_name := ${__style_src:_check.sh=}
 tools := $(foreach t, $(__style_name), ci-$(shell basename $(t)))
 
-check-defined-% : __check_defined_FORCE
-	$(eval $@_target := $(subst check-defined-, ,$@))
-	@:$(call check_defined, $*, $@_target)
-
-.PHONY : __check_defined_FORCE
-__check_defined_FORCE:
-
 help: ## Show all Makefile targets
 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-30s\033[0m %s\n", $$1, $$2}'
 
@@ -57,14 +43,13 @@ format: pull-checker-img ## Running code formatter: black and isort
 	$(CMD) ./scripts/tools/formatter.sh
 lint: pull-checker-img ## Running lint checker: flake8 and pylint
 	$(CMD) ./scripts/tools/linter.sh
-type: pull-checker-img ## Running type checker: mypy and pyright
+type: pull-checker-img ## Running type checker: pyright
 	$(CMD) ./scripts/tools/type_checker.sh
 
-ci-all: $(tools) ## Running codestyle in CI: black, isort, flake8, pylint, mypy, pyright
+ci-all: $(tools) ## Running codestyle in CI: black, isort, flake8, pylint, pyright
 
 ci-%: chore
 	$(eval style := $(subst ci-, ,$@))
-	$(eval SHELL :=/bin/bash)
 	$(CMD) ./scripts/ci/style/$(style)_check.sh
 
 .PHONY: ci-format
@@ -74,21 +59,19 @@ ci-format: ci-black ci-isort ## Running format check in CI: black, isort
 ci-lint: ci-flake8 ci-pylint ## Running lint check in CI: flake8, pylint
 
 .PHONY: ci-type
-ci-type: ci-mypy ci-pyright ## Running type check in CI: mypy, pyright
+ci-type: ci-pyright ## Running type check in CI: pyright
 
 tests-%:
 	$(eval type :=$(subst tests-, , $@))
 	$(eval RUN_ARGS:=$(wordlist 2,$(words $(MAKECMDGOALS)),$(MAKECMDGOALS)))
 	$(eval __positional:=$(foreach t, $(RUN_ARGS), --$(t)))
-	$(eval SHELL :=/bin/bash)
 ifeq ($(USE_POETRY),true)
 	./scripts/ci/run_tests.sh -v --use-poetry $(type) $(__positional)
 else
 	./scripts/ci/run_tests.sh -v $(type) $(__positional)
 endif
 
 
-
 ifeq ($(USE_POETRY),true)
 install-local: ## Install BentoML with poetry
 	@./scripts/init.sh
@@ -139,3 +122,17 @@ endif
 
 hooks: ## Install pre-defined hooks
 	@./scripts/install_hooks.sh
+
+check_defined = \
+    $(strip $(foreach 1,$1, \
+        $(call __check_defined,$1,$(strip $(value 2)))))
+__check_defined = \
+    $(if $(value $1),, \
+        $(error Undefined $1$(if $2, ($2))$(if $(value @), \
+                required by target `$@`)))
+check-defined-% : __check_defined_FORCE
+	$(eval $@_target := $(subst check-defined-, ,$@))
+	@:$(call check_defined, $*, $@_target)
+
+.PHONY : __check_defined_FORCE
+__check_defined_FORCE:

bentoml/_internal/bento/bento.py

@@ -2,6 +2,7 @@
 import os
 import typing as t
 from datetime import datetime, timezone
+from typing import TYPE_CHECKING
 
 import attr
 import fs
@@ -22,7 +23,7 @@
 from ..utils import cached_property
 from .env import BentoEnv
 
-if t.TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from ..models.store import ModelInfo, ModelStore
     from ..service import Service
     from ..service.inference_api import InferenceAPI

bentoml/_internal/bento/pip_pkg.py

@@ -7,11 +7,12 @@
 import zipfile
 import zipimport
 from collections import defaultdict
+from typing import TYPE_CHECKING
 
 import importlib_metadata
 from packaging.requirements import Requirement
 
-if t.TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from ..service import Service
 
 EPP_NO_ERROR = 0

bentoml/_internal/configuration/containers.py

@@ -13,7 +13,7 @@
 from ..utils import get_free_port, validate_or_create_dir
 from . import expand_env_var
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from pyarrow._plasma import PlasmaClient
 
     from ..server.metrics.prometheus import PrometheusClient

bentoml/_internal/io_descriptors/image.py

@@ -1,6 +1,7 @@
 import io
 import sys
 import typing as t
+from typing import TYPE_CHECKING
 from urllib.parse import quote
 
 from multipart.multipart import parse_options_header
@@ -11,8 +12,7 @@
 from ..utils import LazyLoader
 from .base import IODescriptor
 
-if t.TYPE_CHECKING:  # pragma: no cover
-    # pylint: disable=unused-import
+if TYPE_CHECKING:  # pragma: no cover
     import numpy as np
     import PIL
     import PIL.Image

bentoml/_internal/io_descriptors/json.py

@@ -1,6 +1,7 @@
 import dataclasses
 import json
 import typing as t
+from typing import TYPE_CHECKING
 
 from starlette.requests import Request
 from starlette.responses import Response
@@ -9,7 +10,7 @@
 from ..utils.lazy_loader import LazyLoader
 from .base import IODescriptor
 
-if t.TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:  # pragma: no cover
     import numpy as np
     import pandas as pd
     import pydantic

bentoml/_internal/io_descriptors/multipart.py

@@ -1,4 +1,5 @@
 import typing as t
+from typing import TYPE_CHECKING
 
 from multipart.multipart import parse_options_header
 from starlette.requests import Request
@@ -11,8 +12,7 @@
 )
 from .base import IODescriptor
 
-if t.TYPE_CHECKING:  # pragma: no cover
-    # pylint: disable=unused-import
+if TYPE_CHECKING:  # pragma: no cover
     import numpy as np  # noqa
 
     from ..types import FileLike  # noqa

bentoml/_internal/io_descriptors/numpy.py

@@ -1,6 +1,7 @@
 import json
 import logging
 import typing as t
+from typing import TYPE_CHECKING
 
 from starlette.requests import Request
 from starlette.responses import Response
@@ -10,7 +11,7 @@
 from .base import IODescriptor
 from .json import MIME_TYPE_JSON
 
-if t.TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:  # pragma: no cover
     import numpy as np
 else:
     np = LazyLoader("np", globals(), "numpy")

bentoml/_internal/io_descriptors/pandas.py

@@ -1,5 +1,6 @@
 import logging
 import typing as t
+from typing import TYPE_CHECKING
 
 from starlette.requests import Request
 from starlette.responses import Response
@@ -10,7 +11,7 @@
 from .base import IODescriptor
 from .json import MIME_TYPE_JSON
 
-if t.TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:  # pragma: no cover
     import pandas as pd
 else:
     pd = LazyLoader("pd", globals(), "pandas")