fixed issue with pebble imports (#810)

Author: PietroPasotti

ops/model.py

@@ -55,6 +55,15 @@
 from ops.jujuversion import JujuVersion
 
 if typing.TYPE_CHECKING:
+    from pebble import (  # pyright: reportMissingTypeStubs=false
+        CheckInfo,
+        CheckLevel,
+        Client,
+        ExecProcess,
+        FileInfo,
+        Plan,
+        ServiceInfo,
+    )
     from typing_extensions import TypedDict
 
     _StorageDictType = Dict[str, Optional[List['Storage']]]
@@ -1247,16 +1256,16 @@ class Container:
     """
 
     def __init__(self, name: str, backend: '_ModelBackend',
-                 pebble_client: Optional['pebble.Client'] = None):
+                 pebble_client: Optional['Client'] = None):
         self.name = name
 
         if pebble_client is None:
             socket_path = '/charm/containers/{}/pebble.socket'.format(name)
             pebble_client = backend.get_pebble(socket_path)
-        self._pebble = pebble_client  # type: 'pebble.Client'
+        self._pebble = pebble_client  # type: 'Client'
 
     @property
-    def pebble(self) -> 'pebble.Client':
+    def pebble(self) -> 'Client':
         """The low-level :class:`ops.pebble.Client` instance for this container."""
         return self._pebble
 
@@ -1362,7 +1371,7 @@ def add_layer(self, label: str, layer: '_Layer', *, combine: bool = False):
         # fixme: remove ignore once pebble.py is typed
         self._pebble.add_layer(label, layer, combine=combine)  # type: ignore
 
-    def get_plan(self) -> 'pebble.Plan':
+    def get_plan(self) -> 'Plan':
         """Get the current effective pebble configuration."""
         return self._pebble.get_plan()
 
@@ -1377,7 +1386,7 @@ def get_services(self, *service_names: str) -> '_ServiceInfoMapping':
         services = self._pebble.get_services(names)   # type: ignore
         return ServiceInfoMapping(services)
 
-    def get_service(self, service_name: str) -> 'pebble.ServiceInfo':
+    def get_service(self, service_name: str) -> 'ServiceInfo':
         """Get status information for a single named service.
 
         Raises :class:`ModelError` if service_name is not found.
@@ -1392,7 +1401,7 @@ def get_service(self, service_name: str) -> 'pebble.ServiceInfo':
     def get_checks(
             self,
             *check_names: str,
-            level: Optional['pebble.CheckLevel'] = None) -> 'CheckInfoMapping':
+            level: Optional['CheckLevel'] = None) -> 'CheckInfoMapping':
         """Fetch and return a mapping of check information indexed by check name.
 
         Args:
@@ -1405,7 +1414,7 @@ def get_checks(
         checks = self._pebble.get_checks(names=check_names or None, level=level)  # type: ignore
         return CheckInfoMapping(checks)
 
-    def get_check(self, check_name: str) -> 'pebble.CheckInfo':
+    def get_check(self, check_name: str) -> 'CheckInfo':
         """Get check information for a single named check.
 
         Raises :class:`ModelError` if check_name is not found.
@@ -1471,7 +1480,7 @@ def push(self,
                           group_id=group_id, group=group)   # type: ignore
 
     def list_files(self, path: StrOrPath, *, pattern: Optional[str] = None,
-                   itself: bool = False) -> List['pebble.FileInfo']:
+                   itself: bool = False) -> List['FileInfo']:
         """Return list of directory entries from given path on remote system.
 
         Despite the name, this method returns a list of files *and*
@@ -1644,7 +1653,7 @@ def pull_path(self,
             raise MultiPushPullError('failed to pull one or more files', errors)
 
     @staticmethod
-    def _build_fileinfo(path: StrOrPath) -> 'pebble.FileInfo':
+    def _build_fileinfo(path: StrOrPath) -> 'FileInfo':
         """Constructs a FileInfo object by stat'ing a local path."""
         path = Path(path)
         if path.is_symlink():
@@ -1673,8 +1682,8 @@ def _build_fileinfo(path: StrOrPath) -> 'pebble.FileInfo':
 
     @staticmethod
     def _list_recursive(list_func: Callable[[Path],
-                        Iterable['pebble.FileInfo']],
-                        path: Path) -> Generator['pebble.FileInfo', None, None]:
+                        Iterable['FileInfo']],
+                        path: Path) -> Generator['FileInfo', None, None]:
         """Recursively lists all files under path using the given list_func.
 
         Args:
@@ -1788,7 +1797,7 @@ def exec(
         stderr: Optional[Union[TextIO, BinaryIO]] = None,
         encoding: str = 'utf-8',
         combine_stderr: bool = False
-    ) -> 'pebble.ExecProcess':
+    ) -> 'ExecProcess':
         """Execute the given command on the remote system.
 
         See :meth:`ops.pebble.Client.exec` for documentation of the parameters
@@ -1853,14 +1862,14 @@ def __repr__(self):
         return repr(self._containers)
 
 
-class ServiceInfoMapping(Mapping[str, 'pebble.ServiceInfo']):
+class ServiceInfoMapping(Mapping[str, 'ServiceInfo']):
     """Map of service names to :class:`ops.pebble.ServiceInfo` objects.
 
     This is done as a mapping object rather than a plain dictionary so that we
     can extend it later, and so it's not mutable.
     """
 
-    def __init__(self, services: Iterable['pebble.ServiceInfo']):
+    def __init__(self, services: Iterable['ServiceInfo']):
         self._services = {s.name: s for s in services}
 
     def __getitem__(self, key: str):
@@ -1876,14 +1885,14 @@ def __repr__(self):
         return repr(self._services)
 
 
-class CheckInfoMapping(Mapping[str, 'pebble.CheckInfo']):
+class CheckInfoMapping(Mapping[str, 'CheckInfo']):
     """Map of check names to :class:`ops.pebble.CheckInfo` objects.
 
     This is done as a mapping object rather than a plain dictionary so that we
     can extend it later, and so it's not mutable.
     """
 
-    def __init__(self, checks: Iterable['pebble.CheckInfo']):
+    def __init__(self, checks: Iterable['CheckInfo']):
         self._checks = {c.name: c for c in checks}
 
     def __getitem__(self, key: str):
@@ -2344,7 +2353,7 @@ def add_metrics(self, metrics: Mapping[str, 'Numerical'],
         cmd.extend(metric_args)
         self._run(*cmd)
 
-    def get_pebble(self, socket_path: str) -> 'pebble.Client':
+    def get_pebble(self, socket_path: str) -> 'Client':
         """Create a pebble.Client instance from given socket path."""
         return pebble.Client(socket_path=socket_path)