معرفی شرکت ها
aio.app-0.1.8
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Aio application runner
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | aio.app-0.1.8 |
| نام | aio.app |
| نسخه کتابخانه | 0.1.8 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Ryan Northey |
| ایمیل نویسنده | ryan@3ca.org.uk |
| آدرس صفحه اصلی | http://github.com/phlax/aio.app |
| آدرس اینترنتی | https://pypi.org/project/aio.app/ |
| مجوز | GPL |
Detailed documentation
**********************
aio.app
=======
Application runner for the aio_ asyncio framework
.. _aio: https://github.com/phlax/aio
Build status
------------
.. image:: https://travis-ci.org/phlax/aio.app.svg?branch=master
:target: https://travis-ci.org/phlax/aio.app
Installation
------------
Requires python >= 3.4
Install with:
.. code:: bash
pip install aio.app
Quick start - hello world scheduler
-----------------------------------
Save the following into a file "hello.conf"
.. code:: ini
[schedule/EXAMPLE]
every = 2
func = my_example.schedule_handler
And save the following into a file named "my_example.py"
.. code:: python
import asyncio
def schedule_handler(event):
yield from asyncio.sleep(1)
print ("Received scheduled: %s" % event.name)
Run with the aio run command
.. code:: bash
aio run -c hello.conf
The *aio config* command
------------------------
When saving or reading configuration options, configuration files are searched for in order from the following locations
- aio.conf
- etc/aio.conf
- /etc/aio/aio.conf
To dump the system configuration you can run
.. code:: bash
aio config
To dump a configuration section you can use -g or --get with the section name
.. code:: bash
aio config -g aio
aio config --get aio/commands
To get a configuration option, you can use -g with the section name and option
.. code:: bash
aio config -g aio:log_level
aio config --get listen/example:example-signal
You can set a configuration option with -s or --set
Options containing interpolation should be enclosed in single quotes
Multi-line options should be enclosed in " and separated with "\\n"
.. code:: bash
aio config --set aio:log_level DEBUG
aio config -s aio/otherapp:log_level '${aio:log_level}'
aio config -s listen/example:example-signal "my.listener\nmy.listener2"
If no configuration files are present in the standard locations, aio will attempt to save in "aio.conf" in the current working directory
To get or set an option in a particular file you can use the -f flag
.. code:: bash
aio config -g aio:modules -f custom.conf
aio config -s aio:log_level DEBUG -f custom.conf
When getting config values with the -f flag, ExtendedInterpolation_ is not used, and you therefore see the raw values
the *aio run* command
---------------------
You can run an aio app as follows:
.. code:: bash
aio run
Or with a custom configuration file
.. code:: bash
aio -c custom.conf run
On startup aio run sets up the following
- Configuration - system-wide configuration
- Modules - initialization and configuration of modules
- Logging - system logging policies
- Schedulers - functions called at set times
- Servers - listening on tcp/udp or other type of socket
- Signals - functions called in response to events
Configuration
~~~~~~~~~~~~~
Configuration is in ini syntax
.. code:: ini
[aio]
foo = eggs
spam
While the app is running the system configuration is importable from aio.app
.. code:: python
from aio.app import config
Configuration is parsed using ExtendedInterpolation_ as follows
- aio.app defaults read
- user configuration read to initialize modules
- "aio.conf" read from initialized modules where present
- user configuration read again
Logging
~~~~~~~
Logging policies can be placed in the configuration file, following pythons fileConfig_ format
.. _fileConfig: https://docs.python.org/3/library/logging.config.html#logging-config-fileformat
As the configuration is parsed with ExtendedInterpolation_ you can use options from other sections
.. code:: ini
[logger_root]
level=${aio:log_level}
handlers=consoleHandler
qualname=aio
The default aio:log_level is INFO
Any sections that begin with handler, logger, or formatter will automattically be added to the relevant logging section
So by adding a section such as
.. code:: ini
[logger_custom]
level=${aio:log_level}
handlers=consoleHandler
qualname=custom
"logger_custom" will automatically be added to the logger keys:
.. code:: ini
[loggers]
keys=root,custom
Modules
~~~~~~~
You can list any modules that should be imported at runtime in the configuration
.. code:: ini
[aio]
modules = aio.web.server
aio.manhole.server
Configuration for each module is read from a file named "aio.conf" in the module's path, if it exists.
The initialized modules can be accessed from aio.app
.. code:: python
from aio.app import modules
Schedulers
~~~~~~~~~~
Schedule definition sections are in the following format
.. code:: ini
[schedule/SCHEDULE_NAME]
Specify the frequency and the function to call. The function will be wrapped in a coroutine if it isnt one already
.. code:: ini
[schedule/example]
every = 2
func = my.scheduler.example_scheduler
The scheduler function receives a ScheduledEvent object
.. code:: python
def example_scheduler(event):
yield from asyncio.sleep(2)
# do something
print(event.name)
pass
Servers
~~~~~~~
Server definition sections are in the following format
.. code:: ini
[server/SERVER_NAME]
The server requires either a factory or a protocol to start
Protocol configuration example:
.. code:: ini
[server/example]
protocol = my.example.MyServerProtocol
port = 8888
Protocol example code:
.. code:: python
class MyServerProtocol(asyncio.Protocol):
def connection_made(self, transport):
self.transport = transport
def data_received(self, data):
# do stuff
self.transport.close()
For the protocol option you can either specify a subclass of asyncio.Protocol or you can use a function decorated with aio.app.server.protocol
.. code:: ini
[server/example]
protocol = my.example.protocol
port = 8888
Example code for a server protocol function
.. code:: python
import asyncio
import aio.app
@aio.app.server.protocol
def server_protocol():
yield from asyncio.sleep(1)
# do something
return MyServerProtocol
If you need further control over how the protocol is attached you can specify a factory method
Factory configuration example:
.. code:: ini
[server/example]
factory = my.example.server_factory
port = 8080
The factory method must be wrapped in aio.app.server.factory, and is called in a coroutine
.. code:: python
@aio.app.server.factory
def server_factory(name, protocol, address, port):
yield from asyncio.sleep(1)
# do something
loop = asyncio.get_event_loop()
return (
yield from loop.create_server(
MyServerProtocol, address, port))
Signals
~~~~~~~
Signal definition sections are in the following format
.. code:: ini
[signal/SIGNAL_NAME]
An example listen configuration section
.. code:: ini
[listen/example]
example-signal = my.example.listener
And an example listener function. The listener function will be called as a coroutine
.. code:: python
def listener(signal):
yield from asyncio.sleep(2)
print(signal.data)
Signals are emitted in a coroutine
.. code:: python
yield from app.signals.emit(
'example-signal', "BOOM!")
You can add multiple subscriptions within each configuration section
You can also subscribe multiple functions to a signal, and you can have multiple "listen/" sections
.. code:: ini
[listen/example]
example-signal = my.example.listener
example-signal-2 = my.example.listener2
my.example.listener
[listen/example-2]
example-signal-3 = my.example.listener2
The *aio test* command
----------------------
You can test the modules set in the aio:modules configuration option
.. code:: ini
[aio]
modules = aio.config
aio.core
aio.signals
By default the aio test command will test all of your test modules
.. code:: bash
aio test
You can also specify a module, or modules
.. code:: bash
aio test aio.app
aio test aio.app aio.core
If you want to specify a set of modules for testing other than your app modules, you can list them in aio/testing:modules
.. code:: ini
[aio/testing]
modules = aio.config
aio.core
These can include the app modules
.. code:: ini
[aio/testing]
modules = ${aio:modules}
aio.web.page
aio.web.server
Dependencies
------------
aio.app depends on the following packages
- aio.core_
- aio.signals_
- aio.config_
Related software
----------------
- aio.testing_
- aio.http.server_
- aio.web.server_
- aio.manhole.server_
.. _aio.testing: https://github.com/phlax/aio.testing
.. _aio.core: https://github.com/phlax/aio.core
.. _aio.signals: https://github.com/phlax/aio.signals
.. _aio.config: https://github.com/phlax/aio.config
.. _aio.http.server: https://github.com/phlax/aio.http.server
.. _aio.web.server: https://github.com/phlax/aio.web.server
.. _aio.manhole.server: https://github.com/phlax/aio.manhole.server
.. _ExtendedInterpolation: https://docs.python.org/3/library/configparser.html#interpolation-of-values
aio.app usage
-------------
The aio command can be run with any commands listed in the [aio/commands] section of its configuration
There are also 3 builtin commands - run, config and test
Initially aio.app does not have any config, signals, modules or servers
>>> import aio.app
>>> print(aio.app.signals, aio.app.config, aio.app.modules, aio.app.servers)
None None () {}
Lets start the app runner in a test loop with the default configuration and print out the signals and config objects
>>> import aio.testing
>>> from aio.app.runner import runner
>>> @aio.testing.run_until_complete
... def run_app():
... runner(['run'])
...
... print(aio.app.signals)
... print(aio.app.config)
... print(aio.app.modules)
... print(aio.app.servers)
>>> run_app()
<aio.signals.Signals object ...>
<configparser.ConfigParser ...>
(<module 'aio.app' from ...>,)
{}
Clear the app
-------------
We can clear the app vars.
This will also close any socket servers that are currently running
>>> aio.app.clear()
>>> print(aio.app.signals, aio.app.config, aio.app.modules, aio.app.servers)
None None () {}
Adding a signal listener
------------------------
We can add a signal listener in the app config
>>> config = """
... [listen/testlistener]
... test-signal = aio.app.tests._example_listener
... """
Lets create a test listener and make it importable
The listener needs to be wrapped with aio.app.signal.listener and is called in a coroutine
>>> import asyncio
>>> @aio.app.signal.listener
... def listener(signal):
... yield from asyncio.sleep(1)
... print("Listener received: %s" % signal.data)
>>> aio.app.tests._example_listener = listener
Running the test...
>>> @aio.testing.run_until_complete
... def run_app(message):
... runner(['run'], config_string=config)
... yield from aio.app.signals.emit('test-signal', message)
... aio.app.clear()
>>> run_app('BOOM!')
Listener received: BOOM!
We can also add listeners programatically
>>> @aio.testing.run_until_complete
... def run_app(message):
... runner(['run'])
...
... aio.app.signals.listen('test-signal-2', aio.app.signal.listener(listener))
... yield from aio.app.signals.emit('test-signal-2', message)
... aio.app.clear()
>>> run_app('BOOM AGAIN!')
Listener received: BOOM AGAIN!
Adding app modules
------------------
When you run the app with the default configuration, the only module listed is aio.app
>>> @aio.testing.run_until_complete
... def run_app(config_string=None):
... runner(['run'], config_string=config_string)
... print(aio.app.modules)
... aio.app.clear()
>>> run_app()
(<module 'aio.app' from ...>,)
We can make the app runner aware of any modules that we want to include, these are imported at runtime
>>> config = """
... [aio]
... modules = aio.app
... aio.core
... """
>>> run_app(config_string=config)
(<module 'aio.app' from ...>, <module 'aio.core' from ...>)
Running a scheduler
-------------------
A basic configuration for a scheduler
>>> config = """
... [schedule/test-scheduler]
... every: 2
... func: aio.app.tests._example_scheduler
... """
Lets create a scheduler function and make it importable.
The scheduler function is wrapped in a coroutine
>>> def scheduler(event):
... print('HIT: %s' % event.name)
>>> aio.app.tests._example_scheduler = scheduler
We need to use a aio.testing.run_forever to wait for the scheduled events to occur
>>> @aio.testing.run_forever(timeout=5)
... def run_app():
... runner(['run'], config_string=config)
...
... return aio.app.clear
Running the test for 5 seconds we get 3 hits
>>> run_app()
HIT: test-scheduler
HIT: test-scheduler
HIT: test-scheduler
Running a server
----------------
Lets set up and run an addition server
At a minimum we should provide a protocol and a port to listen on
>>> config_server_protocol = """
... [server/additiontest]
... protocol: aio.app.tests._example_AdditionServerProtocol
... port: 8888
... """
Lets create the server protocol and make it importable
>>> class AdditionServerProtocol(asyncio.Protocol):
...
... def connection_made(self, transport):
... self.transport = transport
...
... def data_received(self, data):
... nums = [
... int(x.strip())
... for x in
... data.decode("utf-8").split("+")]
... self.transport.write(str(sum(nums)).encode())
... self.transport.close()
>>> aio.app.tests._example_AdditionServerProtocol = AdditionServerProtocol
After the server is set up, let's call it with a simple addition
>>> @aio.testing.run_forever
... def run_addition_server(config_string, addition):
... runner(['run'], config_string=config_string)
...
... def call_addition_server():
... reader, writer = yield from asyncio.open_connection(
... '127.0.0.1', 8888)
... writer.write(addition.encode())
... yield from writer.drain()
... result = yield from reader.read()
... aio.app.clear()
...
... print(int(result))
...
... return call_addition_server
>>> run_addition_server(
... config_server_protocol,
... '2 + 2 + 3')
7
If you need more control over how the server protocol is created you can specify a factory instead
>>> config_server_factory = """
... [server/additiontest]
... factory = aio.app.tests._example_addition_server_factory
... port: 8888
... """
The factory method must be decorated with aio.app.server.factory
>>> @aio.app.server.factory
... def addition_server_factory(name, protocol, address, port):
... loop = asyncio.get_event_loop()
... return (
... yield from loop.create_server(
... AdditionServerProtocol,
... address, port))
>>> aio.app.tests._example_addition_server_factory = addition_server_factory
>>> run_addition_server(
... config_server_protocol,
... '17 + 5 + 1')
23
نحوه نصب
نصب پکیج whl aio.app-0.1.8:
pip install aio.app-0.1.8.whl
نصب پکیج tar.gz aio.app-0.1.8:
pip install aio.app-0.1.8.tar.gz