aiosignal


Nameaiosignal JSON
Version 1.3.2 PyPI version JSON
download
home_pagehttps://github.com/aio-libs/aiosignal
Summaryaiosignal: a list of registered asynchronous callbacks
upload_time2024-12-13 17:10:40
maintaineraiohttp team <team@aiohttp.org>
docs_urlNone
authorNone
requires_python>=3.9
licenseApache 2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =========
aiosignal
=========

.. image:: https://github.com/aio-libs/aiosignal/workflows/CI/badge.svg
   :target: https://github.com/aio-libs/aiosignal/actions?query=workflow%3ACI
   :alt: GitHub status for master branch

.. image:: https://codecov.io/gh/aio-libs/aiosignal/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/aio-libs/aiosignal
   :alt: codecov.io status for master branch

.. image:: https://badge.fury.io/py/aiosignal.svg
   :target: https://pypi.org/project/aiosignal
   :alt: Latest PyPI package version

.. image:: https://readthedocs.org/projects/aiosignal/badge/?version=latest
   :target: https://aiosignal.readthedocs.io/
   :alt: Latest Read The Docs

.. image:: https://img.shields.io/discourse/topics?server=https%3A%2F%2Faio-libs.discourse.group%2F
   :target: https://aio-libs.discourse.group/
   :alt: Discourse group for io-libs

.. image:: https://badges.gitter.im/Join%20Chat.svg
   :target: https://gitter.im/aio-libs/Lobby
   :alt: Chat on Gitter

Introduction
============

A project to manage callbacks in `asyncio` projects.

``Signal`` is a list of registered asynchronous callbacks.

The signal's life-cycle has two stages: after creation its content
could be filled by using standard list operations: ``sig.append()``
etc.

After you call ``sig.freeze()`` the signal is *frozen*: adding, removing
and dropping callbacks is forbidden.

The only available operation is calling the previously registered
callbacks by using ``await sig.send(data)``.

For concrete usage examples see the `Signals
<https://docs.aiohttp.org/en/stable/web_advanced.html#aiohttp-web-signals>
section of the `Web Server Advanced
<https://docs.aiohttp.org/en/stable/web_advanced.html>` chapter of the `aiohttp
documentation`_.


Installation
------------

::

   $ pip install aiosignal

The library requires Python 3.8 or newer.


Documentation
=============

https://aiosignal.readthedocs.io/

Communication channels
======================

*gitter chat* https://gitter.im/aio-libs/Lobby

Requirements
============

- Python >= 3.8
- frozenlist >= 1.0.0

License
=======

``aiosignal`` is offered under the Apache 2 license.

Source code
===========

The project is hosted on GitHub_

Please file an issue in the `bug tracker
<https://github.com/aio-libs/aiosignal/issues>`_ if you have found a bug
or have some suggestions to improve the library.

.. _GitHub: https://github.com/aio-libs/aiosignal
.. _aiohttp documentation: https://docs.aiohttp.org/

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/aio-libs/aiosignal",
    "name": "aiosignal",
    "maintainer": "aiohttp team <team@aiohttp.org>",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "team@aiohttp.org",
    "keywords": null,
    "author": null,
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/ba/b5/6d55e80f6d8a08ce22b982eafa278d823b541c925f11ee774b0b9c43473d/aiosignal-1.3.2.tar.gz",
    "platform": null,
    "description": "=========\naiosignal\n=========\n\n.. image:: https://github.com/aio-libs/aiosignal/workflows/CI/badge.svg\n   :target: https://github.com/aio-libs/aiosignal/actions?query=workflow%3ACI\n   :alt: GitHub status for master branch\n\n.. image:: https://codecov.io/gh/aio-libs/aiosignal/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/aio-libs/aiosignal\n   :alt: codecov.io status for master branch\n\n.. image:: https://badge.fury.io/py/aiosignal.svg\n   :target: https://pypi.org/project/aiosignal\n   :alt: Latest PyPI package version\n\n.. image:: https://readthedocs.org/projects/aiosignal/badge/?version=latest\n   :target: https://aiosignal.readthedocs.io/\n   :alt: Latest Read The Docs\n\n.. image:: https://img.shields.io/discourse/topics?server=https%3A%2F%2Faio-libs.discourse.group%2F\n   :target: https://aio-libs.discourse.group/\n   :alt: Discourse group for io-libs\n\n.. image:: https://badges.gitter.im/Join%20Chat.svg\n   :target: https://gitter.im/aio-libs/Lobby\n   :alt: Chat on Gitter\n\nIntroduction\n============\n\nA project to manage callbacks in `asyncio` projects.\n\n``Signal`` is a list of registered asynchronous callbacks.\n\nThe signal's life-cycle has two stages: after creation its content\ncould be filled by using standard list operations: ``sig.append()``\netc.\n\nAfter you call ``sig.freeze()`` the signal is *frozen*: adding, removing\nand dropping callbacks is forbidden.\n\nThe only available operation is calling the previously registered\ncallbacks by using ``await sig.send(data)``.\n\nFor concrete usage examples see the `Signals\n<https://docs.aiohttp.org/en/stable/web_advanced.html#aiohttp-web-signals>\nsection of the `Web Server Advanced\n<https://docs.aiohttp.org/en/stable/web_advanced.html>` chapter of the `aiohttp\ndocumentation`_.\n\n\nInstallation\n------------\n\n::\n\n   $ pip install aiosignal\n\nThe library requires Python 3.8 or newer.\n\n\nDocumentation\n=============\n\nhttps://aiosignal.readthedocs.io/\n\nCommunication channels\n======================\n\n*gitter chat* https://gitter.im/aio-libs/Lobby\n\nRequirements\n============\n\n- Python >= 3.8\n- frozenlist >= 1.0.0\n\nLicense\n=======\n\n``aiosignal`` is offered under the Apache 2 license.\n\nSource code\n===========\n\nThe project is hosted on GitHub_\n\nPlease file an issue in the `bug tracker\n<https://github.com/aio-libs/aiosignal/issues>`_ if you have found a bug\nor have some suggestions to improve the library.\n\n.. _GitHub: https://github.com/aio-libs/aiosignal\n.. _aiohttp documentation: https://docs.aiohttp.org/\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "aiosignal: a list of registered asynchronous callbacks",
    "version": "1.3.2",
    "project_urls": {
        "CI: GitHub Actions": "https://github.com/aio-libs/aiosignal/actions",
        "Chat: Gitter": "https://gitter.im/aio-libs/Lobby",
        "Coverage: codecov": "https://codecov.io/github/aio-libs/aiosignal",
        "Docs: RTD": "https://docs.aiosignal.org",
        "GitHub: issues": "https://github.com/aio-libs/aiosignal/issues",
        "GitHub: repo": "https://github.com/aio-libs/aiosignal",
        "Homepage": "https://github.com/aio-libs/aiosignal"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ec6abc7e17a3e87a2985d3e8f4da4cd0f481060eb78fb08596c42be62c90a4d9",
                "md5": "1cebd65b57dfca568ff8ea624497f30d",
                "sha256": "45cde58e409a301715980c2b01d0c28bdde3770d8290b5eb2173759d9acb31a5"
            },
            "downloads": -1,
            "filename": "aiosignal-1.3.2-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1cebd65b57dfca568ff8ea624497f30d",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.9",
            "size": 7597,
            "upload_time": "2024-12-13T17:10:38",
            "upload_time_iso_8601": "2024-12-13T17:10:38.469982Z",
            "url": "https://files.pythonhosted.org/packages/ec/6a/bc7e17a3e87a2985d3e8f4da4cd0f481060eb78fb08596c42be62c90a4d9/aiosignal-1.3.2-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bab56d55e80f6d8a08ce22b982eafa278d823b541c925f11ee774b0b9c43473d",
                "md5": "b40f0e0d5d442b6c1bc79e4e4c8eb7a6",
                "sha256": "a8c255c66fafb1e499c9351d0bf32ff2d8a0321595ebac3b93713656d2436f54"
            },
            "downloads": -1,
            "filename": "aiosignal-1.3.2.tar.gz",
            "has_sig": false,
            "md5_digest": "b40f0e0d5d442b6c1bc79e4e4c8eb7a6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 19424,
            "upload_time": "2024-12-13T17:10:40",
            "upload_time_iso_8601": "2024-12-13T17:10:40.860114Z",
            "url": "https://files.pythonhosted.org/packages/ba/b5/6d55e80f6d8a08ce22b982eafa278d823b541c925f11ee774b0b9c43473d/aiosignal-1.3.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-13 17:10:40",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "aio-libs",
    "github_project": "aiosignal",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "aiosignal"
}
        
Elapsed time: 0.39243s