Browse Source

added some return type hint to public methods / properties

Fabian Peter Hammerle 4 years ago
parent
commit
76c2734c95
1 changed files with 6 additions and 6 deletions
  1. 6 6
      rescriptoon/__init__.py

+ 6 - 6
rescriptoon/__init__.py

@@ -112,7 +112,7 @@ class Overlay:
         self._engine_windows = None
 
     @property
-    def xdisplay(self):
+    def xdisplay(self) -> Xlib.display.Display:
         return self._xdisplay
 
     @property
@@ -173,7 +173,7 @@ class Overlay:
     def _toggle_keysym_name(self) -> str:
         return XK.keysym_to_string(self._toggle_keysym)
 
-    def enable(self):
+    def enable(self) -> None:
         for keysym in self._keysym_mappings.keys():
             if keysym != self._toggle_keysym:
                 self._grab_key(self.xdisplay.keysym_to_keycode(keysym),)
@@ -183,13 +183,13 @@ class Overlay:
             self._toggle_keysym_name,
         )
 
-    def _disable(self):
+    def _disable(self) -> None:
         for keysym in self._keysym_mappings.keys():
             if keysym != self._toggle_keysym:
                 self._ungrab_key(self.xdisplay.keysym_to_keycode(keysym),)
         self._enabled = False
 
-    def disable(self):
+    def disable(self) -> None:
         self._disable()
         logging.info(
             "rescriptoon is now disabled. press %s to enable.",
@@ -197,10 +197,10 @@ class Overlay:
         )
 
     @property
-    def enabled(self):
+    def enabled(self) -> bool:
         return self._enabled
 
-    def toggle(self):
+    def toggle(self) -> None:
         if self.enabled:
             self.disable()
         else: