Python wrapper for the Windows Java Access Bridge
Project description
Introduction
Python wrapper around the Java Access Bridge / Windows Access Bridge.
Prerequisites
- 64-bit Windows
- Java >= 8 (https://docs.aws.amazon.com/corretto/latest/corretto-8-ug/downloads-list.html)
- If you are doing development install JDK, otherwise JRE is enough
- Python >= 3.7 (https://www.python.org/downloads/release/python-375/)
Enable the Java Access Bridge in windows
C:\path\to\java\bin\jabswitch -enable
Install
pip install java-access-bridge-wrapper
How to use
Import the Java Access Bridge (JAB) wrapper and optionally the context tree
from JABWrapper.jab_wrapper import JavaAccessBridgeWrapper
from JABWrapper.context_tree import ContextNode, ContextTree, SearchElement
The JAB creates an virtual GUI window when it is opened. For the JAB to operate and receive events from the GUI, the calling code needs to implement the windows message pump and call it in a loop. The JABWrapper object needs to be in the same thread.
This can be achieved for example by starting the message pump in a separate thread, where the JAB object is also initialized.
GetMessage = ctypes.windll.user32.GetMessageW
TranslateMessage = ctypes.windll.user32.TranslateMessage
DispatchMessage = ctypes.windll.user32.DispatchMessageW
def pump_background(pipe: queue.Queue):
try:
jab_wrapper = JavaAccessBridgeWrapper()
pipe.put(jab_wrapper)
message = byref(wintypes.MSG())
while GetMessage(message, 0, 0, 0) > 0:
TranslateMessage(message)
logging.debug("Dispatching msg={}".format(repr(message)))
DispatchMessage(message)
except Exception as err:
pipe.put(None)
def main():
pipe = queue.Queue()
thread = threading.Thread(target=pump_background, daemon=True, args=[pipe])
thread.start()
jab_wrapper = pipe.get()
if not jab_wrapper:
raise Exception("Failed to initialize Java Access Bridge Wrapper")
time.sleep(0.1) # Wait until the initial messages are parsed, before accessing frames
if __name__ == "__main__":
main()
Once the JABWrapper object is initialized, attach to some frame and optionally create the context tree to get the element tree of the application.
jab_wrapper.switch_window_by_title("Frame title")
context_tree = ContextTree(jab_wrapper)
Development
Development prerequisites
- Install poetry: https://python-poetry.org/docs/
Test
Run test script against simple Swing application
Set environment variable
set RC_JAVA_ACCESS_BRIDGE_DLL="C:\path\to\Java\bin\WindowsAccessBridge-64.dll"
Initialize poetry
poetry intall
Run test with poetry
poetry run python tests\test.py
Packaging
poetry build
poetry publish
TODO:
- Support for 32-bit Java Access Bridge version
- Implement rest of the utility functions to the JABWrapper
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file java_access_bridge_wrapper-0.14.0.tar.gz.
File metadata
- Download URL: java_access_bridge_wrapper-0.14.0.tar.gz
- Upload date:
- Size: 27.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.1 CPython/3.8.10 Windows/10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 353287ef3f7a8ca6808e09cb8a5ce11d753ad2fa4d0756a707c891edf40ace2c |
|
| MD5 | 207d5012e351da230e828b91226929c1 |
|
| BLAKE2b-256 | 3d9776ef21ef073b010d158c2aebe11d555403de7d40c8122a3210400e0df6fe |
Provenance
File details
Details for the file java_access_bridge_wrapper-0.14.0-py3-none-any.whl.
File metadata
- Download URL: java_access_bridge_wrapper-0.14.0-py3-none-any.whl
- Upload date:
- Size: 31.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.4.1 CPython/3.8.10 Windows/10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3fde916a77e5404cd7218fa91842daaa837570e09421323488a792987c1df53c |
|
| MD5 | 04fdbea77a4cceac9996ad73366c8db9 |
|
| BLAKE2b-256 | f11f33010055868bb61c80503ac0fbee5281c2548eb5c375cdce93257dd38648 |
