In Appium Python, how to press key code by key name?

Question

I am writing Python Appium code. The code needs to press the HOME button. Right now I have

driver.press_keycode(3)

where 3 is mapped to KEYCODE_HOME according to keycode mapping.

Is there a way that I can refer KEYCODE_HOME in my code so that my code is more readable?

I could have done the following: adding a comment

# HOME Key is 3
driver.press_keycode(3)

or assigning a variable

home_keycode=3
driver.press_keycode(home_keycode)

But I'd more like to see something like

driver.press_keycode(AppiumKey.HOME)

Does such a thing exist?

Thank you

Dima Berezovskyi · Accepted Answer · 2022-12-21T12:30:52.100

2

So you can create Enum class and call variables like Keys.HOME etc

    class Keys(Enum):
        """
        List of keys
        """
        HOME = 3
    class PO(Base):
        press_key(Keys.HOME)

Or use an existing solution as well python-client nativekey.py

press_key(AndroidKey.HOME)

edited Dec 21 '22 at 12:30

answered Dec 21 '22 at 12:22

Dima Berezovskyi

91
5

the 2nd option is what I was looking for. it worked!!!. thank you. I will provide an example below – oldpride Dec 25 '22 at 03:01

score 1 · Answer 2 · answered Dec 25 '22 at 03:05

I use an example to substantiate Dmytro's answer

import appium.webdriver.extensions.android.nativekey as nativekey

androidkey = nativekey.AndroidKey
value = 'TAB' # use TAB key as an example

keycode = androidkey.__dict__.get(value, None)
print(f"key={value}, keycode={keycode}")

# driver init code is skipped
driver.press_keycode(keycode)

In Appium Python, how to press key code by key name?

2 Answers2