Pyro - Python Remote Objects - 5.16.dev0

Manual Index

What is Pyro?

A library that enables you to build applications in which objects can talk to each other over the network, with minimal programming effort. You can just use normal Python method calls to call objects running on other machines. Pyro is a pure Python library and runs on many different platforms and Python versions.

Pyro is copyright © Irmen de Jong (irmen@razorvine.net | http://www.razorvine.net). Please read Software License and Disclaimer.

Pyro can be found on Pypi as Pyro5. Source is on Github: https://github.com/irmen/Pyro5

Pyro5 is the current version of Pyro. Pyro4 is the predecessor that only gets important bugfixes and security fixes, but is otherwise no longer being improved. New code should use Pyro5 if at all possible.

Contents of this manual:

• Intro and Example
  • Features
  • What can you use Pyro for?
  • Upgrading from Pyro4
  • Simple Example
  • Performance
• Installing Pyro
  • Compatibility
  • Obtaining and installing Pyro
  • Third party libraries that Pyro5 uses
  • Interesting stuff that is extra in the source distribution archive and not with packaged versions
• Tutorial
  • Warm-up
  • Pyro concepts and tools
  • Not using the Name server
  • Tutorial examples
• Command line tools
  • Test echo server
  • Configuration check
• Clients: Calling remote objects
  • Object discovery
  • Calling methods
  • Accessing remote attributes
  • Serialization
  • Proxies, connections, threads and cleaning up
  • Oneway calls
  • Batched calls
  • Remote iterators/generators
  • Pyro Callbacks
  • Miscellaneous features
• Servers: hosting Pyro objects
  • Creating a Pyro class and exposing its methods and properties
  • Exposing classes and methods without changing existing source code
  • Pyro Daemon: publishing Pyro objects
  • Controlling Instance modes and Instance creation
  • Autoproxying
  • Server types and Concurrency model
  • Serialization
  • Other features
• Name Server
  • Starting the Name Server
  • Starting the Name Server from within your own code
  • Configuration items
  • Name server control tool
  • Locating the Name Server and using it in your code
  • The PYRONAME protocol type
  • The PYROMETA protocol type
  • Resolving object names
  • Registering object names
  • Free connections to the NS quickly
  • Yellow-pages ability of the Name Server (metadata tags)
  • Other methods in the Name Server API
• Security
  • Network interface binding
  • Running Pyro servers with different credentials/user id
  • Secure communication via SSL/TLS
  • Dotted names (object traversal)
  • Environment variables overriding config items
  • Preventing arbitrary connections
• Exceptions and remote tracebacks
  • Pyro exceptions
  • Remote exceptions
  • Detailed traceback information
• Tips & Tricks
  • Best practices
  • Logging
  • Multiple network interfaces
  • Wire protocol version
  • Pyro behind a NAT router/firewall
  • ‘Failed to locate the nameserver’ or ‘Connection refused’ error, what now?
  • Binary data transfer / file transfer
  • IPV6 support
  • Pyro and Numpy
  • Pyro via HTTP and JSON
  • Client information on the current_context, correlation id
  • Automatically freeing resources when client connection gets closed
  • Message annotations
  • Connection handshake
  • Efficient dispatchers or gateways that don’t de/reserialize messages
  • Hooking onto existing connected sockets such as from socketpair()
• Configuring Pyro
  • Resetting the config to default values
  • Inspecting current config
  • Overview of Config Items
• Pyro5 library API
  • Pyro5.api — Main API package
  • Pyro5.config — Configuration items
  • Pyro5.client — Client code logic
  • Pyro5.core — core Pyro logic
  • Pyro5.server — Server (daemon) logic
  • Pyro5.errors — Exception classes
  • Pyro5.nameserver — Pyro name server
  • Pyro5.callcontext — Call context handling
  • Pyro5.protocol — Pyro wire protocol
  • Pyro5.socketutil — Socket related utilities
  • Pyro5.compatibility.Pyro4 — Pyro4 backward compatibility layer
  • Pyro5.utils.echoserver — Built-in echo server for testing purposes
  • Pyro5.utils.httpgateway — HTTP to Pyro gateway
  • Socket server API contract
• Pyrolite - client library for Java and .NET
• Change Log
• Software License and Disclaimer

Index

• Index

• Search Page