fix: Tune mixin types, so linters could recognize them better (appium#536)

Author: mykola-mokhnach

appium/webdriver/extensions/action_helpers.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import TYPE_CHECKING, List, Optional, Tuple, TypeVar
+from typing import TYPE_CHECKING, List, Optional, Tuple, TypeVar, Union
 
 from selenium import webdriver
 
@@ -21,20 +21,21 @@
 from appium.webdriver.webelement import WebElement
 
 if TYPE_CHECKING:
+    # noinspection PyUnresolvedReferences
     from appium.webdriver.webdriver import WebDriver
 
-T = TypeVar('T', bound='WebDriver')
+T = TypeVar('T', bound=Union['WebDriver', 'ActionHelpers'])
 
 
 class ActionHelpers(webdriver.Remote):
 
-    def scroll(self, origin_el: WebElement, destination_el: WebElement, duration: Optional[int] = None) -> T:
+    def scroll(self: T, origin_el: WebElement, destination_el: WebElement, duration: Optional[int] = None) -> T:
         """Scrolls from one element to another
 
         Args:
-            originalEl (`appium.webdriver.webelement.WebElement`): the element from which to being scrolling
-            destinationEl (`appium.webdriver.webelement.WebElement`): the element to scroll to
-            duration (int): a duration after pressing originalEl and move the element to destinationEl.
+            origin_el: the element from which to being scrolling
+            destination_el: the element to scroll to
+            duration: a duration after pressing originalEl and move the element to destinationEl.
                 Default is 600 ms for W3C spec. Zero for MJSONWP.
 
         Usage:
@@ -55,12 +56,12 @@ def scroll(self, origin_el: WebElement, destination_el: WebElement, duration: Op
             action.press(origin_el).wait(duration).move_to(destination_el).release().perform()
         return self
 
-    def drag_and_drop(self, origin_el: WebElement, destination_el: WebElement) -> T:
+    def drag_and_drop(self: T, origin_el: WebElement, destination_el: WebElement) -> T:
         """Drag the origin element to the destination element
 
         Args:
-            originEl (`appium.webdriver.webelement.WebElement`): the element to drag
-            destinationEl (`appium.webdriver.webelement.WebElement`): the element to drag to
+            origin_el: the element to drag
+            destination_el: the element to drag to
 
         Returns:
             `appium.webdriver.webelement.WebElement`
@@ -69,7 +70,7 @@ def drag_and_drop(self, origin_el: WebElement, destination_el: WebElement) -> T:
         action.long_press(origin_el).move_to(destination_el).release().perform()
         return self
 
-    def tap(self, positions: List[Tuple[int, int]], duration: Optional[int] = None) -> T:
+    def tap(self: T, positions: List[Tuple[int, int]], duration: Optional[int] = None) -> T:
         """Taps on an particular place with up to five fingers, holding for a
         certain time
 
@@ -108,7 +109,7 @@ def tap(self, positions: List[Tuple[int, int]], duration: Optional[int] = None)
             ma.perform()
         return self
 
-    def swipe(self, start_x: int, start_y: int, end_x: int, end_y: int, duration: int = 0) -> T:
+    def swipe(self: T, start_x: int, start_y: int, end_x: int, end_y: int, duration: int = 0) -> T:
         """Swipe from one point to another point, for an optional duration.
 
         Args:
@@ -135,7 +136,7 @@ def swipe(self, start_x: int, start_y: int, end_x: int, end_y: int, duration: in
         action.perform()
         return self
 
-    def flick(self, start_x: int, start_y: int, end_x: int, end_y: int) -> T:
+    def flick(self: T, start_x: int, start_y: int, end_x: int, end_y: int) -> T:
         """Flick from one point to another point.
 
         Args:

appium/webdriver/extensions/android/activities.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import TYPE_CHECKING, TypeVar
+from typing import TYPE_CHECKING, TypeVar, Union
 
 from selenium import webdriver
 from selenium.common.exceptions import TimeoutException
@@ -21,13 +21,14 @@
 from appium.webdriver.mobilecommand import MobileCommand as Command
 
 if TYPE_CHECKING:
+    # noinspection PyUnresolvedReferences
     from appium.webdriver.webdriver import WebDriver
 
-T = TypeVar('T', bound='WebDriver')
+T = TypeVar('T', bound=Union['WebDriver', 'Activities'])
 
 
 class Activities(webdriver.Remote):
-    def start_activity(self, app_package: str, app_activity: str, **opts: str) -> T:
+    def start_activity(self: T, app_package: str, app_activity: str, **opts: str) -> T:
         """Opens an arbitrary activity during a test. If the activity belongs to
         another application, that application is started and the activity is opened.
 
@@ -66,15 +67,15 @@ def start_activity(self, app_package: str, app_activity: str, **opts: str) -> T:
         return self
 
     @property
-    def current_activity(self) -> str:
+    def current_activity(self: T) -> str:
         """Retrieves the current activity running on the device.
 
         Returns:
             str: The current activity name running on the device
         """
         return self.execute(Command.GET_CURRENT_ACTIVITY)['value']
 
-    def wait_activity(self, activity: str, timeout: int, interval: int = 1) -> bool:
+    def wait_activity(self: T, activity: str, timeout: int, interval: int = 1) -> bool:
         """Wait for an activity: block until target activity presents or time out.
 
         This is an Android-only method.
@@ -95,7 +96,7 @@ def wait_activity(self, activity: str, timeout: int, interval: int = 1) -> bool:
             return False
 
     # pylint: disable=protected-access
-
+    # noinspection PyProtectedMember
     def _addCommands(self) -> None:
         self.command_executor._commands[Command.GET_CURRENT_ACTIVITY] = \
             ('GET', '/session/$sessionId/appium/device/current_activity')

appium/webdriver/extensions/android/common.py

@@ -12,21 +12,22 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import TYPE_CHECKING, Any, TypeVar
+from typing import TYPE_CHECKING, Any, TypeVar, Union
 
 from selenium import webdriver
 
 from appium.webdriver.mobilecommand import MobileCommand as Command
 
 if TYPE_CHECKING:
+    # noinspection PyUnresolvedReferences
     from appium.webdriver.webdriver import WebDriver
 
-T = TypeVar('T', bound='WebDriver')
+T = TypeVar('T', bound=Union['WebDriver', 'Common'])
 
 
 class Common(webdriver.Remote):
 
-    def end_test_coverage(self, intent: str, path: str) -> Any:  # TODO Check return type
+    def end_test_coverage(self: T, intent: str, path: str) -> Any:  # TODO Check return type
         """Ends the coverage collection and pull the coverage.ec file from the device.
 
         Android only.
@@ -45,7 +46,7 @@ def end_test_coverage(self, intent: str, path: str) -> Any:  # TODO Check return
         }
         return self.execute(Command.END_TEST_COVERAGE, data)['value']
 
-    def open_notifications(self) -> T:
+    def open_notifications(self: T) -> T:
         """Open notification shade in Android (API Level 18 and above)
 
         Returns:
@@ -55,11 +56,12 @@ def open_notifications(self) -> T:
         return self
 
     @property
-    def current_package(self) -> str:
+    def current_package(self: T) -> str:
         """Retrieves the current package running on the device.
         """
         return self.execute(Command.GET_CURRENT_PACKAGE)['value']
 
+    # noinspection PyProtectedMember
     def _addCommands(self) -> None:
         self.command_executor._commands[Command.GET_CURRENT_PACKAGE] = \
             ('GET', '/session/$sessionId/appium/device/current_package')

appium/webdriver/extensions/android/display.py

@@ -12,14 +12,22 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import TYPE_CHECKING, TypeVar, Union
+
 from selenium import webdriver
 
 from appium.webdriver.mobilecommand import MobileCommand as Command
 
+if TYPE_CHECKING:
+    # noinspection PyUnresolvedReferences
+    from appium.webdriver.webdriver import WebDriver
+
+T = TypeVar('T', bound=Union['WebDriver', 'Display'])
+
 
 class Display(webdriver.Remote):
 
-    def get_display_density(self) -> int:
+    def get_display_density(self: T) -> int:
         """Get the display density, Android only
 
         Returns:
@@ -31,7 +39,7 @@ def get_display_density(self) -> int:
         return self.execute(Command.GET_DISPLAY_DENSITY)['value']
 
     # pylint: disable=protected-access
-
+    # noinspection PyProtectedMember
     def _addCommands(self) -> None:
         self.command_executor._commands[Command.GET_DISPLAY_DENSITY] = \
             ('GET', '/session/$sessionId/appium/device/display_density')

appium/webdriver/extensions/android/gsm.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import TYPE_CHECKING, TypeVar
+from typing import TYPE_CHECKING, TypeVar, Union
 
 from selenium import webdriver
 
@@ -21,8 +21,11 @@
 from appium.webdriver.mobilecommand import MobileCommand as Command
 
 if TYPE_CHECKING:
+    # noinspection PyUnresolvedReferences
     from appium.webdriver.webdriver import WebDriver
 
+T = TypeVar('T', bound=Union['WebDriver', 'Gsm'])
+
 
 class GsmCallActions:
     CALL = 'call'
@@ -49,12 +52,9 @@ class GsmVoiceState:
     ON = 'on'
 
 
-T = TypeVar('T', bound='WebDriver')
-
-
 class Gsm(webdriver.Remote):
 
-    def make_gsm_call(self, phone_number: str, action: str) -> T:
+    def make_gsm_call(self: T, phone_number: str, action: str) -> T:
         """Make GSM call (Emulator only)
 
         Android only.
@@ -70,11 +70,12 @@ def make_gsm_call(self, phone_number: str, action: str) -> T:
         constants = extract_const_attributes(GsmCallActions)
         if action not in constants.values():
             logger.warning(
-                f'{action} is unknown. Consider using one of {list(constants.keys())} constants. (e.g. {GsmCallActions.__name__}.CALL)')
+                f'{action} is unknown. Consider using one of {list(constants.keys())} constants. '
+                f'(e.g. {GsmCallActions.__name__}.CALL)')
         self.execute(Command.MAKE_GSM_CALL, {'phoneNumber': phone_number, 'action': action})
         return self
 
-    def set_gsm_signal(self, strength: int) -> T:
+    def set_gsm_signal(self: T, strength: int) -> T:
         """Set GSM signal strength (Emulator only)
 
         Android only.
@@ -89,11 +90,12 @@ def set_gsm_signal(self, strength: int) -> T:
         constants = extract_const_attributes(GsmSignalStrength)
         if strength not in constants.values():
             logger.warning(
-                f'{strength} is out of range. Consider using one of {list(constants.keys())} constants. (e.g. {GsmSignalStrength.__name__}.GOOD)')
+                f'{strength} is out of range. Consider using one of {list(constants.keys())} constants. '
+                f'(e.g. {GsmSignalStrength.__name__}.GOOD)')
         self.execute(Command.SET_GSM_SIGNAL, {'signalStrength': strength, 'signalStrengh': strength})
         return self
 
-    def set_gsm_voice(self, state: str) -> T:
+    def set_gsm_voice(self: T, state: str) -> T:
         """Set GSM voice state (Emulator only)
 
         Android only.
@@ -108,12 +110,13 @@ def set_gsm_voice(self, state: str) -> T:
         constants = extract_const_attributes(GsmVoiceState)
         if state not in constants.values():
             logger.warning(
-                f'{state} is unknown. Consider using one of {list(constants.keys())} constants. (e.g. {GsmVoiceState.__name__}.HOME)')
+                f'{state} is unknown. Consider using one of {list(constants.keys())} constants. '
+                f'(e.g. {GsmVoiceState.__name__}.HOME)')
         self.execute(Command.SET_GSM_VOICE, {'state': state})
         return self
 
     # pylint: disable=protected-access
-
+    # noinspection PyProtectedMember
     def _addCommands(self) -> None:
         self.command_executor._commands[Command.MAKE_GSM_CALL] = \
             ('POST', '/session/$sessionId/appium/device/gsm_call')

appium/webdriver/extensions/android/network.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import TYPE_CHECKING, TypeVar
+from typing import TYPE_CHECKING, TypeVar, Union
 
 from selenium import webdriver
 
@@ -21,9 +21,10 @@
 from appium.webdriver.mobilecommand import MobileCommand as Command
 
 if TYPE_CHECKING:
+    # noinspection PyUnresolvedReferences
     from appium.webdriver.webdriver import WebDriver
 
-T = TypeVar('T', bound='WebDriver')
+T = TypeVar('T', bound=Union['WebDriver', 'NetSpeed'])
 
 
 class NetSpeed:
@@ -41,15 +42,15 @@ class NetSpeed:
 class Network(webdriver.Remote):
 
     @property
-    def network_connection(self) -> int:
+    def network_connection(self: T) -> int:
         """Returns an integer bitmask specifying the network connection type.
 
         Android only.
         Possible values are available through the enumeration `appium.webdriver.ConnectionType`
         """
         return self.execute(Command.GET_NETWORK_CONNECTION, {})['value']
 
-    def set_network_connection(self, connection_type: int) -> int:
+    def set_network_connection(self: T, connection_type: int) -> int:
         """Sets the network connection type. Android only.
 
         Possible values:
@@ -83,7 +84,7 @@ def set_network_connection(self, connection_type: int) -> int:
         }
         return self.execute(Command.SET_NETWORK_CONNECTION, data)['value']
 
-    def toggle_wifi(self) -> T:
+    def toggle_wifi(self: T) -> T:
         """Toggle the wifi on the device, Android only.
 
         Returns:
@@ -92,7 +93,7 @@ def toggle_wifi(self) -> T:
         self.execute(Command.TOGGLE_WIFI, {})
         return self
 
-    def set_network_speed(self, speed_type: str) -> T:
+    def set_network_speed(self: T, speed_type: str) -> T:
         """Set the network speed emulation.
 
         Android Emulator only.
@@ -110,13 +111,14 @@ def set_network_speed(self, speed_type: str) -> T:
         constants = extract_const_attributes(NetSpeed)
         if speed_type not in constants.values():
             logger.warning(
-                f'{speed_type} is unknown. Consider using one of {list(constants.keys())} constants. (e.g. {NetSpeed.__name__}.LTE)')
+                f'{speed_type} is unknown. Consider using one of {list(constants.keys())} constants. '
+                f'(e.g. {NetSpeed.__name__}.LTE)')
 
         self.execute(Command.SET_NETWORK_SPEED, {'netspeed': speed_type})
         return self
 
     # pylint: disable=protected-access
-
+    # noinspection PyProtectedMember
     def _addCommands(self) -> None:
         self.command_executor._commands[Command.TOGGLE_WIFI] = \
             ('POST', '/session/$sessionId/appium/device/toggle_wifi')