| | |
- zymb.sched.Agent
-
- Readline
class Readline(zymb.sched.Agent) |
| |
Readline: An Agent which attends to the readline interface.
This agent WILL NOT WORK without a hacked-up Python readline module.
The standard Python readline module is missing some APIs which are
necessary for asynchronous operation. You can get my hacked-up source
from <http://www.eblong.com/zarf/zymb/>.
WARNING: Do not instantiate a Readline agent from a Python interactive
shell which is using readline! The results will make you sad.
As is common for agents, Readline does not actually do any work
until you start it and call mainloop(). Also, it does
not (by default) do anything with received data. Incoming data
triggers an 'input' event, but there is no preregistered handler for
this event. You can write your own, or install the basicinput()
handler. See below.
mainloop() -- main event loop.
The procedure for invoking zymb is slightly complicated when you are
using readline. Instead of calling zymb.sched.process in one of the
usual ways, you should call the mainloop() function provided in this
module. (The readline module's event hook is rigged to call
zymb.sched.process for you.)
Readline(ignoreempty=False) -- constructor.
If *ignoreempty* is true, empty inputs (just hitting Enter) will not
generate 'input' events. If it is false, they will generate 'input'
events containing empty strings.
You can only create one Readline agent, because it does not make sense
for more than one readline to be running in a single process.
Agent states and events:
state 'start': Initial state.
event 'input' (unicode): A line of input has been read. (Newline included.)
event 'interrupt': The user hit ctrl-C.
state 'end': The agent has shut down.
Public methods:
write(dat) -- print output.
basicinput(str) -- a simple event handler for 'input'.
getprompt() -- get the current readline prompt.
setprompt(str) -- change the readline prompt.
|
| |
Methods defined here:
- __init__(self, ignoreempty=False)
- basicinput(self, dat)
- basicinput(dat) -> None
A simple event handler for 'input'. This simply writes the
received data to stdout:
write(dat)
This handler is not installed by default. You can enable it by
calling:
readlnag.addhandler('input', fileag.basicinput)
- getprompt(self)
- getprompt() -> str
Return the current readline prompt. The default prompt is '> '.
- setprompt(self, st)
- setprompt(str) -> None
Change the readline prompt. The default prompt is '> '.
- write(self, dat)
- write(str) -> None
Print output. Since readline takes over the terminal, it is unwise
to print data directly, or write to sys.stdout -- that will confuse
the cursor position and the editing line.
Instead, you should call this method. The data you pass will be
printed tidily, without interrupting or corrupting the user's typing.
The edit line will be moved down if necessary.
This method only prints data in full lines. If the string you pass
does not end with a newline, the fractional line will be invisibly
buffered until you do write a newline.
Data and other attributes defined here:
- interruption = None
- quitnow = False
- received = []
- singleton = None
Methods inherited from zymb.sched.Agent:
- __str__(self)
- addcleanupaction(self, ac)
- addcleanupaction(action) -> None
Add *action* to the list of actions to be removed when the agent
stops (i.e., jumps to the 'end' state).
This is intended for actions that an agent adds as handlers to
other agents. For example:
ac = otheragent.addhandler('event', self.foreigneventhandler)
# Ensure that ac is removed when *self* shuts down.
addcleanupaction(ac)
You do not need to list pollers or socket-checkers as cleanup
actions. Nor do you need to list handlers that an agent adds
to itself. (All these are automatically removed when the agent
shuts down.) You also don't have to worry about the case of
*otheragent* shutting down; when that happens, all handlers added
to it are removed.
- addhandler(self, state, op, *args)
- addhandler(eventname, op, *args) -> action
Add a state or event handler. The *eventname* is a string naming
the state or event you want to handle. The *op* and *args* are
the operation to perform when that state or event occurs.
(See queueaction() for the use of *op* and *args*.)
Handlers are invoked in last-added-first-run order. If an agent
has a built-in handler, it is added first, so it runs last. Handlers
that you add on later run earlier.
Returns the Action. (You can cancel the handler by calling
ac.remove().)
- addtimer(self, op, *args, **dic)
- addtimer(op, *args, delay=num, when=num, periodic=bool) -> action
Add a timed event. You must supply exactly one of the keyword
arguments *delay* and *when*. A *when* is an absolute time,
expressed as a number of seconds since the epoch (e.g., the kind
of value returned by time.time()). A *delay* is a relative time,
expressed as a number of seconds in the future.
It is legal to give a time in the past (or a negative *delay*).
In that case, this is similar to queueaction() -- the operation
will occur very soon. (Although it's still a "low priority"
action.)
If you supply *periodic*=True, the event will occur repeatedly,
every *delay* seconds. (The interval is inferred if you give
*when*.) In this case, you may NOT give a negative *delay* or
a time in the past -- it is meaningless for a periodic event to
have a period less than or equal to zero.
You can also create a periodic timer by calling addtimer with
a PeriodicAction, which is a subclass of Action. This is slightly
more flexible; the interval between calls is specified when
you create the PeriodicAction, but the delay before the first
call may be specified with *delay* or *when*.
See queueaction() for the use of *op* and *args*.
Returns the Action. (You can cancel the timer by calling
ac.remove().)
- basicerror(self, exc, agent)
- basicerror(exc, agent) -> None
A simple event handler for 'error'. This simply writes the
received data to stdout:
sys.stdout.write('Error: ' + str(agent) + ': ' + str(exc) + '
')
This handler is not installed by default. You can enable it by
calling:
ag.addhandler('error', ag.basicerror)
- jump(self, st, *exargs)
- jump(state, *args) -> None
Jump to a different operating state. (If the agent is already
in the given state, nothing happens.)
This queues up all the state transition handlers registered
for the new state. If you provide *args*, they are passed to the
handlers when they are called.
- perform(self, name, *exargs)
- perform(eventname, *args) -> None
Trigger an event.
This queues up all the event handlers registered for the given
event. If you provide *args*, they are passed to the handlers when
they are called.
- queueaction(self, op, *args)
- queueaction(op, *args) -> action
Invoke an action. The action will be handed to the scheduler, which
will run it very soon.
("Very soon" means "before the next timed event or network message
is handled." However, if you queue several actions, they will be
handled in the order you queued them.)
You can pass any callable as *op*; the (optional) *args* will be
passed to it as arguments. You can also, if you like, create
an Action object and pass it as *op*. You can still pass *args*
in this case; they'll be appended to the arguments bound into
the Action.
Returns the Action.
- registerpoll(self, op, *args, **dic)
- registerpoll(op, *args, interval=num) -> action
Add a repeating activity check. *interval* is a (mandatory) keyword
argument; the scheduler will invoke your operation at least every
*interval* seconds. (And at least once per sched.process() call.)
See queueaction() for the use of *op* and *args*. Your operation
should not do any work except for absorbing input and queueing
actions. Typically, it will collect the input and then call
perform(), triggering an event, so that the agent's event
handlers can do something with the input.
Returns the Action. (You can cancel it by calling ac.remove().)
- registersocket(self, fileno, op, *args)
- registersocket(socket, op, *args) -> action
Add a socket-based activity check. The *socket* may be a socket
object, or a number representing a fileno, or any object which
provides a fileno() method.
See queueaction() for the use of *op* and *args*. Your operation
should not do any work except for absorbing input and queueing
actions. Typically, it will collect the input and then call
perform(), triggering an event, so that the agent's event
handlers can do something with the input.
Returns the Action. (You can cancel it by calling ac.remove().)
- shutdown(self)
- shutdown() -- internal 'end' state handler. Do not call.
This is the final 'end' handler. It removes the agent from the
scheduler, and cancels all its remaining actions, timed events,
etc.
- start(self)
- start() -> None
Begin activity. The agent adds itself to the scheduler and moves
to the 'start' state. It does not actually begin doing work in
this call; that happens the next time the scheduler is invoked
(sched.process).
You should only call this once per agent.
- stop(self)
- stop() -> None
Stop activity. The agent moves to the 'end' state. Its 'end'
state handlers will take care of shutting it down and removing
it from the scheduler.
It is safe to call this on an agent which is already in 'end',
or which is completely shut down. (Nothing further will happen.)
(Remember, state handlers are not called as part of the stop()
method. They are run by the scheduler "soon" after stop() is
called. If you want to be sure the agent is completely stopped,
you can check the agent.live field. However, it is better to
register your own 'end' state handler, and consider the agent
stopped when that it called.)
Data and other attributes inherited from zymb.sched.Agent:
- agentcounter = 1
- hidden = False
- logprefix = 'zymb.agent'
| |
