Make sure type checks pass with mypy as well

[plamut]

#500 added type annotation to the codebase, but we only checked that static type analysis passes under pytype. A lot of people, on the other hand, use mypy, but mypy currently reports 97 errors.

If we want users to leverage our type annotations, we should make sure that the checks pass with mypy as well, and then we can also add py.typed file to declare the library type-checked.

An additional requirement of this issue is that a new nox session named mypy needs to be added and enabled by default.

Acceptance criteria:

• A new nox session named mypy is added, and it runs on every PR.
  process: make sure type annoations pass with mypy #542
• The hand-written layer passes type checks.
  process: make sure type annoations pass with mypy #542
• The autogenerated part of the library is included in mypy checks and produces no errors.
  BLOCKED by Generated code for Pub/Sub does not pass type checks with mypy gapic-generator-python#1092
• Code samples are checked with mypy and the check runs on every PR (process: add mypy session for samples #551).
  • Refactor the manual client to inherit from the generated class instead of dynamically injecting the latter's methods. Mypy otherwise cannot know about the dynamically added methods.
• The library declares itself as type-checked by adding a marker py.typed file (requires all above items to be completed first)

[parthea]

I reviewed the mypy failures for the generated code and found that the warnings are specific to the customized portion of the generated code.

For example, for google/pubsub_v1/types/__init__.py:82 error: Name "google" is not defined, the specific replacement in owlbot.py is here:

python-pubsub/owlbot.py

Lines 273 to 288 in 8513f53

	s.replace(
	library / f"google/pubsub_{library.name}/types/__init__.py",
	r"__all__ = \(\n",
	textwrap.dedent(
	'''\
	TimeoutType = Union[
	int,
	float,
	"google.api_core.timeout.ConstantTimeout",
	"google.api_core.timeout.ExponentialTimeout",
	]
	"""The type of the timeout parameter of publisher client methods."""
	\g<0> "TimeoutType",'''
	),
	)

For another error google/pubsub_v1/services/subscriber/client.py:492: error: Incompatible types in assignment (expression has type "partial[SubscriberTransport]", variable has type "Type[SubscriberTransport]"), the specific replacement in owlbot.py is here:

python-pubsub/owlbot.py

Lines 108 to 122 in 8513f53

	count = s.replace(
	clients_to_patch,
	r"Transport = type\(self\)\.get_transport_class\(transport\)",
	"""\g<0>
	emulator_host = os.environ.get("PUBSUB_EMULATOR_HOST")
	if emulator_host:
	if issubclass(Transport, type(self)._transport_registry["grpc"]):
	channel = grpc.insecure_channel(target=emulator_host)
	else:
	channel = grpc.aio.insecure_channel(target=emulator_host)
	Transport = functools.partial(Transport, channel=channel)
	""",
	)

[kasium]

I'm not sure, but isn't the py.typed file missing in google/cloud/pubsub and google/cloud/pubsub_v1?

[ckcr4lyf]

FYI: If someone stumbles across this after struggling with mypy, you can just ignore it:

from google.cloud import pubsub_v1  # type: ignore[attr-defined]

[knifewine]

encountering this with google-cloud-pubsub 2.18.4 -- apologies for the reopen if it's been resolved in a newer version.