aiomisc - miscellaneous utils for asyncio

Miscellaneous utils for asyncio.

Installation

Installing from PyPI:

pip3 install aiomisc

With uvloop:

pip3 install "aiomisc[uvloop]"

With aiohttp:

pip3 install "aiomisc[aiohttp]"

Installing from github.com:

pip3 install git+https://github.com/aiokitchen/aiomisc.git
pip3 install \
    https://github.com/aiokitchen/aiomisc/archive/refs/heads/master.zip

Quick Start

Complete the Tutorial or see this quick start.

Async entrypoint with logging and useful arguments:

import asyncio
import logging

import aiomisc

log = logging.getLogger(__name__)

async def main():
    log.info('Starting')
    await asyncio.sleep(3)
    log.info('Exiting')


if __name__ == '__main__':
    with entrypoint(
        log_level="info", log_format="color"
    ) as loop:
        loop.run_until_complete(main())

Install event loop on program start:

import asyncio
import aiomisc

# Installing uvloop event loop
# and set `aiomisc.thread_pool.ThreadPoolExecutor`
# as default executor
aiomisc.new_event_loop()

async def main():
    await asyncio.sleep(1)

if __name__ == '__main__':
    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

Close current event loop and install a new one:

import asyncio
import aiomisc

async def main():
    await asyncio.sleep(3)

if __name__ == '__main__':
    loop = aiomisc.new_event_loop()
    loop.run_until_complete(main())

Versioning

This software follows Semantic Versioning

How to develop?

Should be installed:

• virtualenv

• GNU Make as make

• Python 3.5+ as python3

For setting up developer environment just type

make develop

Table Of Contents

• 1. Tutorial
  • 1.1. Services
  • 1.2. Service configuration
  • 1.3. dependency injection
  • 1.4. entrypoint
  • 1.5. Executing code in thread or process-pools
    • 1.5.1. @aiomisc.threaded decorator
    • 1.5.2. @aiomisc.threaded_separate decorator
    • 1.5.3. @aiomisc.threaded_iterable decorator
• 2. Modules
  • 2.1. entrypoint
    • 2.1.1. Configuration from environment
  • 2.2. run() shortcut
  • 2.3. Services
    • 2.3.1. TCPServer
    • 2.3.2. UDPServer
    • 2.3.3. TLSServer
    • 2.3.4. TCPClient
    • 2.3.5. TLSClient
    • 2.3.6. RobustTCPClient
    • 2.3.7. RobustTLSClient
    • 2.3.8. PeriodicService
    • 2.3.9. CronService
    • 2.3.10. Multiple services
    • 2.3.11. Configuration
    • 2.3.12. aiohttp service
    • 2.3.13. asgi service
    • 2.3.14. Memory Tracer
    • 2.3.15. Profiler
    • 2.3.16. Raven service
    • 2.3.17. SDWatchdogService
    • 2.3.18. ProcessService
    • 2.3.19. RespawningProcessService
  • 2.4. Abstract connection pool
  • 2.5. Context
  • 2.6. @aiomisc.timeout
  • 2.7. @aiomisc.asyncbackoff
  • 2.8. asyncretry
  • 2.9. Circuit Breaker
  • 2.10. cutout
  • 2.11. @aiomisc.aggregate
  • 2.12. asynchronous file operations
  • 2.13. Working with threads
    • 2.13.1. contextvars support
    • 2.13.2. @aiomisc.threaded
    • 2.13.3. @aiomisc.threaded_separate
    • 2.13.4. Threaded iterator decorator
    • 2.13.5. aiomisc.IteratorWrapper
    • 2.13.6. aiomisc.IteratorWrapperSeparate
    • 2.13.7. aiomisc.ThreadPoolExecutor
    • 2.13.8. aiomisc.sync_wait_coroutine
  • 2.14. ProcessPoolExecutor
  • 2.15. Utilities
    • 2.15.1. select
    • 2.15.2. cancel_tasks
    • 2.15.3. awaitable
    • 2.15.4. bind_socket
    • 2.15.5. RecurringCallback
    • 2.15.6. PeriodicCallback
    • 2.15.7. CronCallback
  • 2.16. WorkerPool
    • 2.16.1. Example
  • 2.17. Logging configuration
    • 2.17.1. Color
    • 2.17.2. JSON
    • 2.17.3. JournalD
    • 2.17.4. Rich
    • 2.17.5. Buffered log handler
  • 2.18. Pytest plugin
    • 2.18.1. Basic usage
    • 2.18.2. pytest markers
    • 2.18.3. Passing default context
    • 2.18.4. Testing services
    • 2.18.5. Event loop policy overriding
    • 2.18.6. Thread pool overriding
    • 2.18.7. entrypoint arguments
    • 2.18.8. aiohttp test client
    • 2.18.9. TCPProxy
  • 2.19. Signal
    • 2.19.1. pre_start
    • 2.19.2. post_start
    • 2.19.3. pre_stop
    • 2.19.4. post_stop
  • 2.20. Plugins
  • 2.21. Statistic counters
• API Reference
  • 1. aiomisc module
    • 1.1. aiomisc.aggregate module
    • 1.2. aiomisc.backoff module
    • 1.3. aiomisc.circuit_breaker module
    • 1.4. aiomisc.compat module
    • 1.5. aiomisc.context module
    • 1.6. aiomisc.counters module
    • 1.7. aiomisc.cron module
    • 1.8. aiomisc.entrypoint module
    • 1.9. aiomisc.io module
    • 1.10. aiomisc.iterator_wrapper module
    • 1.11. aiomisc.log module
    • 1.12. aiomisc.periodic module
    • 1.13. aiomisc.plugins module
    • 1.14. aiomisc.pool module
    • 1.15. aiomisc.process_pool module
    • 1.16. aiomisc.recurring module
    • 1.17. aiomisc.signal module
    • 1.18. aiomisc.thread_pool module
    • 1.19. aiomisc.timeout module
    • 1.20. aiomisc.utils module
    • 1.21. aiomisc.worker_pool module
  • 2. aiomisc_log module
    • 2.1. aiomisc_log.formatter.color module
    • 2.2. aiomisc_log.formatter.journald module
    • 2.3. aiomisc_log.formatter.json module
    • 2.4. aiomisc_log.formatter.rich.py module
    • 2.5. aiomisc_log.enum module
  • 3. aiomisc_pytest module
  • 4. aiomisc_worker module
    • 4.1. aiomisc_worker.forking module
    • 4.2. aiomisc_worker.process module
    • 4.3. aiomisc_worker.process_inner module
    • 4.4. aiomisc_worker.protocol module
    • 4.5. aiomisc_worker.worker module