Skip to main content

Python wrapper for the Windows Java Access Bridge

Project description

Version License

Introduction

Python wrapper around the Java Access Bridge / Windows Access Bridge.

Prerequisites

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

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"

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

java-access-bridge-wrapper-0.9.3.tar.gz (30.9 kB view details)

Uploaded Source

Built Distribution

java_access_bridge_wrapper-0.9.3-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

Details for the file java-access-bridge-wrapper-0.9.3.tar.gz.

File metadata

File hashes

Hashes for java-access-bridge-wrapper-0.9.3.tar.gz
Algorithm Hash digest
SHA256 35056c6abf4f0e2dac21bbd7944985c797b8f03210f1f0f6694cacf1a2be8473
MD5 ad8537321f03df7a867b3063e8e7a927
BLAKE2b-256 11b7d3f6a59d8a895a827a840d6499b76888a15c75165d9321fd9238a0cff05f

See more details on using hashes here.

File details

Details for the file java_access_bridge_wrapper-0.9.3-py3-none-any.whl.

File metadata

File hashes

Hashes for java_access_bridge_wrapper-0.9.3-py3-none-any.whl
Algorithm Hash digest
SHA256 81d174115369a584c2aca9808cc2999e665eda745ff49278be01a5aa07e8820d
MD5 3685938b2823bb30ed35735b4d330096
BLAKE2b-256 2fde9db440b0e8f9a377e2284bc35b86a84a3d99937c765e4f6517a257ee9cb9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page