Pool API reference

The Pool is one of the most important elements in sardana.

This chapter explains the generic pool API in the context of sardana. In sardana there are, in fact, two Pool APIs. To better explain why, let’s consider the case were sardana server is running as a Sardana Tango device server:

Every pool in sardana is represented in the sardana kernel as a Pool. The Pool API is not directly accessible from outside the sardana server. This is a low level API that is only accessible to someone writing a server extension to sardana. At the time of writing, the only available sardana server extension is Tango.

The second pool interface consists on the one provided by the server extension, which is in this case the one provided by the Tango pool device interface: Pool. The Tango pool interface tries to mimic the as closely as possible the Pool API.

See also

Pool overview

the pool overview


the pool tango device API

Each pool has the following attributes:

pool path

Pool may load user macros and this are discoverable by scanning the file system directories configured in macro path.

python path

Macros may need to access to third party Python modules. When these are not available to the Python interpreter i.e. exported to the PYTHONPATH, one can configure the file system directories where the Pool should look for these modules.