4. Py4J Python API

Using Py4J is usually as simple as creating a JavaGateway object:

java_gateway = JavaGateway()
# you are now connected to the JVM
# and you can call any method defined on the Java side.

You can still customize and extend Py4J in many ways (e.g., you can choose the port to which you want to connect). The following modules are documented. Note that users are expected to only use py4j.java_gateway or py4j.clientserver.

• 4.1. py4j.java_gateway — Py4J Main API
  • 4.1.1. JavaGateway
    • JavaGateway
      • JavaGateway.close()
      • JavaGateway.close_callback_server()
      • JavaGateway.detach()
      • JavaGateway.get_callback_server()
      • JavaGateway.help()
      • JavaGateway.launch_gateway()
      • JavaGateway.new_array()
      • JavaGateway.new_jvm_view()
      • JavaGateway.restart_callback_server()
      • JavaGateway.set_gateway_client()
      • JavaGateway.shutdown()
      • JavaGateway.shutdown_callback_server()
      • JavaGateway.start_callback_server()
    • 4.1.1.1. Examples
  • 4.1.2. GatewayParameters
    • GatewayParameters
  • 4.1.3. CallbackServerParameters
    • CallbackServerParameters
  • 4.1.4. GatewayClient
    • GatewayClient
      • GatewayClient.close()
      • GatewayClient.garbage_collect_object()
      • GatewayClient.send_command()
      • GatewayClient.shutdown_gateway()
  • 4.1.5. GatewayConnection
    • GatewayConnection
      • GatewayConnection.close()
      • GatewayConnection.send_command()
      • GatewayConnection.shutdown_gateway()
      • GatewayConnection.start()
  • 4.1.6. JVMView
    • JVMView
  • 4.1.7. JavaObject
  • 4.1.8. JavaMember
  • 4.1.9. JavaClass
    • JavaClass
      • JavaClass._java_lang_class
  • 4.1.10. JavaPackage
    • JavaPackage
  • 4.1.11. PythonProxyPool
    • PythonProxyPool
      • PythonProxyPool.clear()
      • PythonProxyPool.put()
  • 4.1.12. CallbackServer
    • CallbackServer
      • CallbackServer.close()
      • CallbackServer.get_listening_address()
      • CallbackServer.get_listening_port()
      • CallbackServer.run()
      • CallbackServer.shutdown()
      • CallbackServer.start()
  • 4.1.13. CallbackConnection
    • CallbackConnection
      • CallbackConnection.close()
      • CallbackConnection.run()
  • 4.1.14. Py4J Core Signals
    • server_connection_stopped
    • server_connection_started
    • server_connection_error
    • server_started
    • server_stopped
    • pre_server_shutdown
    • post_server_shutdown
  • 4.1.15. Py4J Functions
    • java_import()
    • launch_gateway()
    • get_field()
    • set_field()
    • get_method()
    • is_instance_of()
    • get_java_class()
• 4.2. py4j.clientserver — Py4J Single Threading Model Implementation
  • 4.2.1. ClientServer
    • ClientServer
    • 4.2.1.1. Examples
  • 4.2.2. JavaParameters
    • JavaParameters
  • 4.2.3. PythonParameters
    • PythonParameters
  • 4.2.4. JavaClient
    • JavaClient
      • JavaClient.garbage_collect_object()
      • JavaClient.get_thread_connection()
      • JavaClient.set_thread_connection()
      • JavaClient.shutdown_gateway()
  • 4.2.5. PythonServer
    • PythonServer
  • 4.2.6. ClientServerConnection
    • ClientServerConnection
      • ClientServerConnection.close()
      • ClientServerConnection.connect_to_java_server()
      • ClientServerConnection.init_socket_from_python_server()
      • ClientServerConnection.run()
      • ClientServerConnection.send_command()
      • ClientServerConnection.shutdown_gateway()
      • ClientServerConnection.shutdown_socket()
      • ClientServerConnection.start()
      • ClientServerConnection.wait_for_commands()
• 4.3. py4j.protocol — Py4J Protocol
  • 4.3.1. Py4JError
    • Py4JError
  • 4.3.2. Py4JJavaError
    • Py4JJavaError
  • 4.3.3. Py4JNetworkError
    • Py4JNetworkError
  • 4.3.4. Py4JAuthenticationError
    • Py4JAuthenticationError
  • 4.3.5. Py4J Protocol Functions
    • escape_new_line()
    • unescape_new_line()
    • get_command_part()
    • get_return_value()
    • register_output_converter()
    • register_input_converter()
• 4.4. py4j.java_collections — Py4J Collections API
  • 4.4.1. JavaIterator
    • JavaIterator
      • JavaIterator.next()
  • 4.4.2. JavaList
    • JavaList
      • JavaList.append()
      • JavaList.count()
      • JavaList.extend()
      • JavaList.index()
      • JavaList.insert()
      • JavaList.pop()
      • JavaList.remove()
      • JavaList.reverse()
      • JavaList.sort()
  • 4.4.3. JavaMap
    • JavaMap
  • 4.4.4. JavaSet
    • JavaSet
      • JavaSet.add()
      • JavaSet.clear()
      • JavaSet.discard()
      • JavaSet.remove()
  • 4.4.5. JavaArray
    • JavaArray
• 4.5. py4j.finalizer — Py4J Finalizer API
  • 4.5.1. ThreadSafeFinalizer
    • ThreadSafeFinalizer
      • ThreadSafeFinalizer.add_finalizer()
      • ThreadSafeFinalizer.clear_finalizers()
      • ThreadSafeFinalizer.finalizers
      • ThreadSafeFinalizer.lock
      • ThreadSafeFinalizer.remove_finalizer()
  • 4.5.2. Finalizer
    • Finalizer
      • Finalizer.add_finalizer()
      • Finalizer.clear_finalizers()
      • Finalizer.finalizers
      • Finalizer.remove_finalizer()
  • 4.5.3. Py4J Finalizer Functions
    • clear_finalizers()
• 4.6. py4j.signals — Py4J Signals API
  • 4.6.1. Signal
    • Signal
      • Signal.connect()
      • Signal.disconnect()
      • Signal.send()