Typing framework.py (#772)

ops/__init__.py

@@ -40,5 +40,5 @@
 """
 
 # Import here the bare minimum to break the circular import between modules
-from . import charm  # noqa: F401 (imported but unused)
-from .version import version as __version__  # noqa: F401 (imported but unused)
+from . import charm  # type: ignore # noqa
+from .version import version as __version__  # type: ignore # noqa

ops/charm.py

@@ -18,6 +18,7 @@
 import os
 import pathlib
 import typing
+from typing import TYPE_CHECKING
 
 from ops import model
 from ops._private import yaml
@@ -669,8 +670,12 @@ def __init__(self, *args):
 
     # note that without the #: below, sphinx will copy the whole of CharmEvents
     # docstring inline which is less than ideal.
-    #: Used to set up event handlers; see :class:`CharmEvents`.
+    # Used to set up event handlers; see :class:`CharmEvents`.
     on = CharmEvents()
+    if TYPE_CHECKING:
+        # to help the type checker and IDEs:
+        @property
+        def on(self) -> CharmEvents: ... # noqa
 
     def __init__(self, framework: Framework, key: typing.Optional = None):
         super().__init__(framework, None)