aiolifecycle 0.1.5

Micro-framework to effectively run asyncio functions in synchronous contexts

aiolifecycle

Safely use asyncio handlers in synchronous context.

Use case

If you want to run an asyncio-based program in a synchronous context - such as a command line invocation - you can use asyncio.run from the standard library. But it immediately spins up and terminates an event loop. What if you want to a continuous workflow, where you can initialise and re-use resources?

The original need for this project arose when adapting an asyncio-based system to AWS Lambda, which makes multiple synchronous function calls in the same interpreter environment.

Installation

Run pip install aiolifecycle, or add it to your package dependencies.

Usage

Handler

Define your handler as an async function, and add the sync annotation. Then it can safely be called synchronously. An event loop will automatically be initialised with its associated resources.

import asyncio

from aiolifecycle import sync


@sync()
async def my_handler() -> None:
    await asyncio.sleep(1)

By default, handlers are eager, meaning an event loop will be created and initialisation functions will be immediately run on module import.

If you want to initialise resources only when a handler is first called, do:

import asyncio

from aiolifecycle import sync


@sync(eager=False)
async def my_handler() -> None:
    await asyncio.sleep(1)

Initialisation

You can define async initialisation functions to prepare resources for use by handlers. These can be simple async defs returning nothing.

In the following example, my_init will be called exactly once, before any handlers run.

import asyncio

from aiolifecycle import sync, init


@init
async def my_init() -> None:
    print('Hello, world!')


@sync
async def my_handler() -> None:
    await asyncio.sleep(1)

Initialisation order can be controlled with the order parameter. In the following example, hello will be called before world. Functions with the same order (or undefined order) are called in the order they were defined.

import asyncio

from aiolifecycle import sync, init

@init(order=20)
async def world() -> None:
    print('World!')


@init(order=10)
async def hello() -> None:
    print('Hello!')


@sync()
async def my_handler() -> None:
    await asyncio.sleep(1)

Initialisation functions can manage resources. You can simply return the resource from an init function (if no finalisation is necessary), or define it as an asynccontextmanager

Or you can use AsyncContextManagers, and access the resources they create by refering to the handler function. Proper lifetime will be managed internally, such that the initialisation will happen once.

import json
from contextlib import asynccontextmanager
from typing import AsyncIterator

import aiofiles
from aiofiles.threadpool.text import AsyncTextIOWrapper

from aiolifecycle import sync
from aiolifecycle import init


@init
async def json_log_path() -> str:
    # Run complicated logic to determine path, only once!
    # ....
    return '/tmp/my-file.json'


@init()
@asynccontextmanager
async def json_log_file() -> AsyncIterator[AsyncTextIOWrapper]:
    log_path = await json_log_path()
    # File will be open before any handler is called, and cleaned up on shutdown
    async with aiofiles.open(log_path, mode='a') as f:
        yield f


@sync()
async def handler():
    log_file = await json_log_file()
    await log_file.write(json.dumps(event) + "\n")
    await log_file.flush()

Changelog

v0.1.5 (2022-05-11)

Fix

• init: Exit immediately on init failure (9652c7c)

v0.1.4 (2022-05-10)

Fix

• init: Fix threading atexit registration order (0a3a861)

v0.1.3 (2022-05-09)

Fix

• loop: Wait for loop on interpreter termination (e6b9825)

v0.1.2 (2022-05-09)

Fix

• init: Add missing reset for context var (#1) (fc7f654)

v0.1.1 (2022-05-05)

Fix

• license: Update copyright (588e5a3)

v0.1.0 (2022-05-05)

Feature

• all: Remove remaining lambda references (c003c73)

v0.0.4 (2022-05-05)

Fix

• handlers: Cycle detection (018ba95)
• handlers: Rename handlers to remove lambda references (de9643b)
• tests: For new resource management (5f30e6d)
• metadata: Use Markdown version of Apache License [skip ci] (bfaf82e)

v0.0.3 (2022-05-04)

Fix

• cd: Fix long_description Markdown content type (b3479ee)

v0.0.2 (2022-05-04)

Fix

• cd: Don't release on new tags (581d5ff)

v0.0.1 (2022-05-04)

Fix

• cd: Force release (7bbac93)
• cd: Force release (dd9f209)
• cd: Force release (e621555)

Copyright 2022 Daniel Miranda and contributors.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

-------------------------------------------------------------------------
                              Apache License
                        Version 2.0, January 2004
                     http://www.apache.org/licenses/


TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

   "License" shall mean the terms and conditions for use, reproduction,
   and distribution as defined by Sections 1 through 9 of this document.

   "Licensor" shall mean the copyright owner or entity authorized by
   the copyright owner that is granting the License.

   "Legal Entity" shall mean the union of the acting entity and all
   other entities that control, are controlled by, or are under common
   control with that entity. For the purposes of this definition,
   "control" means (i) the power, direct or indirect, to cause the
   direction or management of such entity, whether by contract or
   otherwise, or (ii) ownership of fifty percent (50%) or more of the
   outstanding shares, or (iii) beneficial ownership of such entity.

   "You" (or "Your") shall mean an individual or Legal Entity
   exercising permissions granted by this License.

   "Source" form shall mean the preferred form for making modifications,
   including but not limited to software source code, documentation
   source, and configuration files.

   "Object" form shall mean any form resulting from mechanical
   transformation or translation of a Source form, including but
   not limited to compiled object code, generated documentation,
   and conversions to other media types.

   "Work" shall mean the work of authorship, whether in Source or
   Object form, made available under the License, as indicated by a
   copyright notice that is included in or attached to the work
   (an example is provided in the Appendix below).

   "Derivative Works" shall mean any work, whether in Source or Object
   form, that is based on (or derived from) the Work and for which the
   editorial revisions, annotations, elaborations, or other modifications
   represent, as a whole, an original work of authorship. For the purposes
   of this License, Derivative Works shall not include works that remain
   separable from, or merely link (or bind by name) to the interfaces of,
   the Work and Derivative Works thereof.

   "Contribution" shall mean any work of authorship, including
   the original version of the Work and any modifications or additions
   to that Work or Derivative Works thereof, that is intentionally
   submitted to Licensor for inclusion in the Work by the copyright owner
   or by an individual or Legal Entity authorized to submit on behalf of
   the copyright owner. For the purposes of this definition, "submitted"
   means any form of electronic, verbal, or written communication sent
   to the Licensor or its representatives, including but not limited to
   communication on electronic mailing lists, source code control systems,
   and issue tracking systems that are managed by, or on behalf of, the
   Licensor for the purpose of discussing and improving the Work, but
   excluding communication that is conspicuously marked or otherwise
   designated in writing by the copyright owner as "Not a Contribution."

   "Contributor" shall mean Licensor and any individual or Legal Entity
   on behalf of whom a Contribution has been received by Licensor and
   subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   copyright license to reproduce, prepare Derivative Works of,
   publicly display, publicly perform, sublicense, and distribute the
   Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   (except as stated in this section) patent license to make, have made,
   use, offer to sell, sell, import, and otherwise transfer the Work,
   where such license applies only to those patent claims licensable
   by such Contributor that are necessarily infringed by their
   Contribution(s) alone or by combination of their Contribution(s)
   with the Work to which such Contribution(s) was submitted. If You
   institute patent litigation against any entity (including a
   cross-claim or counterclaim in a lawsuit) alleging that the Work
   or a Contribution incorporated within the Work constitutes direct
   or contributory patent infringement, then any patent licenses
   granted to You under this License for that Work shall terminate
   as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
   Work or Derivative Works thereof in any medium, with or without
   modifications, and in Source or Object form, provided that You
   meet the following conditions:

   (a) You must give any other recipients of the Work or
       Derivative Works a copy of this License; and

   (b) You must cause any modified files to carry prominent notices
       stating that You changed the files; and

   (c) You must retain, in the Source form of any Derivative Works
       that You distribute, all copyright, patent, trademark, and
       attribution notices from the Source form of the Work,
       excluding those notices that do not pertain to any part of
       the Derivative Works; and

   (d) If the Work includes a "NOTICE" text file as part of its
       distribution, then any Derivative Works that You distribute must
       include a readable copy of the attribution notices contained
       within such NOTICE file, excluding those notices that do not
       pertain to any part of the Derivative Works, in at least one
       of the following places: within a NOTICE text file distributed
       as part of the Derivative Works; within the Source form or
       documentation, if provided along with the Derivative Works; or,
       within a display generated by the Derivative Works, if and
       wherever such third-party notices normally appear. The contents
       of the NOTICE file are for informational purposes only and
       do not modify the License. You may add Your own attribution
       notices within Derivative Works that You distribute, alongside
       or as an addendum to the NOTICE text from the Work, provided
       that such additional attribution notices cannot be construed
       as modifying the License.

   You may add Your own copyright statement to Your modifications and
   may provide additional or different license terms and conditions
   for use, reproduction, or distribution of Your modifications, or
   for any such Derivative Works as a whole, provided Your use,
   reproduction, and distribution of the Work otherwise complies with
   the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
   any Contribution intentionally submitted for inclusion in the Work
   by You to the Licensor shall be under the terms and conditions of
   this License, without any additional terms or conditions.
   Notwithstanding the above, nothing herein shall supersede or modify
   the terms of any separate license agreement you may have executed
   with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
   names, trademarks, service marks, or product names of the Licensor,
   except as required for reasonable and customary use in describing the
   origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
   agreed to in writing, Licensor provides the Work (and each
   Contributor provides its Contributions) on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
   implied, including, without limitation, any warranties or conditions
   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
   PARTICULAR PURPOSE. You are solely responsible for determining the
   appropriateness of using or redistributing the Work and assume any
   risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
   whether in tort (including negligence), contract, or otherwise,
   unless required by applicable law (such as deliberate and grossly
   negligent acts) or agreed to in writing, shall any Contributor be
   liable to You for damages, including any direct, indirect, special,
   incidental, or consequential damages of any character arising as a
   result of this License or out of the use or inability to use the
   Work (including but not limited to damages for loss of goodwill,
   work stoppage, computer failure or malfunction, or any and all
   other commercial damages or losses), even if such Contributor
   has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
   the Work or Derivative Works thereof, You may choose to offer,
   and charge a fee for, acceptance of support, warranty, indemnity,
   or other liability obligations and/or rights consistent with this
   License. However, in accepting such obligations, You may act only
   on Your own behalf and on Your sole responsibility, not on behalf
   of any other Contributor, and only if You agree to indemnify,
   defend, and hold each Contributor harmless for any liability
   incurred by, or claims asserted against, such Contributor by reason
   of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS