Debian Codegraph @

aiosignal.egg-info/PKG-INFO

raw
1 Metadata-Version: 2.4
2 Name: aiosignal
3 Version: 1.4.0
4 Summary: aiosignal: a list of registered asynchronous callbacks
5 Home-page: https://github.com/aio-libs/aiosignal
6 Maintainer: aiohttp team <[email protected]>
7 Maintainer-email: [email protected]
8 License: Apache 2.0
9 Project-URL: Chat: Gitter, https://gitter.im/aio-libs/Lobby
10 Project-URL: CI: GitHub Actions, https://github.com/aio-libs/aiosignal/actions
11 Project-URL: Coverage: codecov, https://codecov.io/github/aio-libs/aiosignal
12 Project-URL: Docs: RTD, https://docs.aiosignal.org
13 Project-URL: GitHub: issues, https://github.com/aio-libs/aiosignal/issues
14 Project-URL: GitHub: repo, https://github.com/aio-libs/aiosignal
15 Classifier: License :: OSI Approved :: Apache Software License
16 Classifier: Intended Audience :: Developers
17 Classifier: Programming Language :: Python
18 Classifier: Programming Language :: Python :: 3
19 Classifier: Programming Language :: Python :: 3 :: Only
20 Classifier: Development Status :: 5 - Production/Stable
21 Classifier: Operating System :: POSIX
22 Classifier: Operating System :: MacOS :: MacOS X
23 Classifier: Operating System :: Microsoft :: Windows
24 Classifier: Framework :: AsyncIO
25 Requires-Python: >=3.9
26 Description-Content-Type: text/x-rst
27 License-File: LICENSE
28 Requires-Dist: frozenlist>=1.1.0
29 Requires-Dist: typing-extensions>=4.2; python_version < "3.13"
30 Dynamic: license-file
31
32 =========
33 aiosignal
34 =========
35
36 .. image:: https://github.com/aio-libs/aiosignal/workflows/CI/badge.svg
37 :target: https://github.com/aio-libs/aiosignal/actions?query=workflow%3ACI
38 :alt: GitHub status for master branch
39
40 .. image:: https://codecov.io/gh/aio-libs/aiosignal/branch/master/graph/badge.svg?flag=pytest
41 :target: https://codecov.io/gh/aio-libs/aiosignal?flags[0]=pytest
42 :alt: codecov.io status for master branch
43
44 .. image:: https://badge.fury.io/py/aiosignal.svg
45 :target: https://pypi.org/project/aiosignal
46 :alt: Latest PyPI package version
47
48 .. image:: https://readthedocs.org/projects/aiosignal/badge/?version=latest
49 :target: https://aiosignal.readthedocs.io/
50 :alt: Latest Read The Docs
51
52 .. image:: https://img.shields.io/discourse/topics?server=https%3A%2F%2Faio-libs.discourse.group%2F
53 :target: https://aio-libs.discourse.group/
54 :alt: Discourse group for io-libs
55
56 .. image:: https://badges.gitter.im/Join%20Chat.svg
57 :target: https://gitter.im/aio-libs/Lobby
58 :alt: Chat on Gitter
59
60 Introduction
61 ============
62
63 A project to manage callbacks in `asyncio` projects.
64
65 ``Signal`` is a list of registered asynchronous callbacks.
66
67 The signal's life-cycle has two stages: after creation its content
68 could be filled by using standard list operations: ``sig.append()``
69 etc.
70
71 After you call ``sig.freeze()`` the signal is *frozen*: adding, removing
72 and dropping callbacks is forbidden.
73
74 The only available operation is calling the previously registered
75 callbacks by using ``await sig.send(data)``.
76
77 For concrete usage examples see the `Signals
78 <https://docs.aiohttp.org/en/stable/web_advanced.html#aiohttp-web-signals>
79 section of the `Web Server Advanced
80 <https://docs.aiohttp.org/en/stable/web_advanced.html>` chapter of the `aiohttp
81 documentation`_.
82
83
84 Installation
85 ------------
86
87 ::
88
89 $ pip install aiosignal
90
91
92 Documentation
93 =============
94
95 https://aiosignal.readthedocs.io/
96
97 License
98 =======
99
100 ``aiosignal`` is offered under the Apache 2 license.
101
102 Source code
103 ===========
104
105 The project is hosted on GitHub_
106
107 Please file an issue in the `bug tracker
108 <https://github.com/aio-libs/aiosignal/issues>`_ if you have found a bug
109 or have some suggestions to improve the library.
110
111 .. _GitHub: https://github.com/aio-libs/aiosignal
112 .. _aiohttp documentation: https://docs.aiohttp.org/