zc.monitor 0.4.0.post1

监控服务器

监控服务器是一个提供命令行界面的服务器，用于请求各种信息。该服务器基于zc.ngi，因此我们可以使用zc.ngi测试基础设施来展示它。

>>> import zc.ngi.testing
>>> import zc.monitor

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)

服务器支持一组可扩展的命令。它通过命名zc.monitor.interfaces.IMonitorPlugin“实用程序”查找命令，这些实用程序由zope.component包定义。

为了展示这一点，我们将创建一个hello插件

>>> def hello(connection, name='world'):
...     """Say hello
...
...     Provide a name if you're not the world.
...     """
...     connection.write("Hi %s, nice to meet ya!\n" % name)

并将其注册

>>> zc.monitor.register(hello)

当注册命令时，我们可以提供一个名称。为了展示这一点，我们将再次注册hello

>>> zc.monitor.register(hello, 'hi')

现在我们可以将hello命令提供给服务器

>>> connection.test_input('hi\n')
Hi world, nice to meet ya!
-> CLOSE

我们可以传递一个名称

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)
>>> connection.test_input('hello Jim\n')
Hi Jim, nice to meet ya!
-> CLOSE

服务器附带了一些基本的命令。让我们注册它们，以便我们可以看到它们的作用。我们将使用简化的注册接口

>>> zc.monitor.register_basics()

首先是帮助命令。不输入帮助，会列出可用的命令

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)
>>> connection.test_input('help\n')
Supported commands:
  hello -- Say hello
  help -- Get help about server commands
  hi -- Say hello
  interactive -- Turn on monitor's interactive mode
  quit -- Quit the monitor
-> CLOSE

我们可以通过指定命令名称来获取详细帮助

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)
>>> connection.test_input('help help\n')
Help for help:
<BLANKLINE>
Get help about server commands
<BLANKLINE>
    By default, a list of commands and summaries is printed.  Provide
    a command name to get detailed documentation for a command.
<BLANKLINE>
-> CLOSE

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)
>>> connection.test_input('help hello\n')
Help for hello:
<BLANKLINE>
Say hello
<BLANKLINE>
    Provide a name if you're not the world.
<BLANKLINE>
-> CLOSE

interactive命令将监控器切换到交互模式。如上所示，监控器通常响应单个命令然后关闭连接。在“交互模式”下，连接不会关闭，直到使用quit命令。当通过telnet进行诊断访问监控器时，这可能很有用。

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)
>>> connection.test_input('interactive\n')
Interactive mode on.  Use "quit" To exit.
>>> connection.test_input('help interactive\n')
Help for interactive:
<BLANKLINE>
Turn on monitor's interactive mode
<BLANKLINE>
    Normally, the monitor releases the connection after a single command.
    By entering the interactive mode, the monitor will not end the connection
    until you enter the "quit" command.
<BLANKLINE>
    In interactive mode, an empty line repeats the last command.
<BLANKLINE>
>>> connection.test_input('help quit\n')
Help for quit:
<BLANKLINE>
Quit the monitor
<BLANKLINE>
    This is only really useful in interactive mode (see the "interactive"
    command).
<BLANKLINE>

请注意，命令的结果并没有以“-> CLOSE”结束，这将表示连接已关闭。

请注意，交互模式允许你重复命令。

>>> connection.test_input('hello\n')
Hi world, nice to meet ya!
>>> connection.test_input('\n')
Hi world, nice to meet ya!
>>> connection.test_input('hello Jim\n')
Hi Jim, nice to meet ya!
>>> connection.test_input('\n')
Hi Jim, nice to meet ya!

现在我们将使用quit来关闭连接。

>>> connection.test_input('quit\n')
Goodbye.
-> CLOSE

最后，值得注意的是，异常将在连接上生成跟踪输出。

>>> connection = zc.ngi.testing.TextConnection()
>>> server = zc.monitor.Server(connection)
>>> connection.test_input('hello Jim 42\n') # doctest: +ELLIPSIS
Traceback (most recent call last):
...
TypeError: hello() takes at most 2 arguments (3 given)
<BLANKLINE>
-> CLOSE

变更历史