kombu/docs/reference/index.rst

===========================
 API Reference
===========================

:Release: |version|
:Date: |today|

Kombu Core
==========

.. toctree::
    :maxdepth: 1

    kombu
    kombu.common
    kombu.matcher
    kombu.mixins
    kombu.simple
    kombu.clocks
    kombu.compat
    kombu.pidbox
    kombu.exceptions
    kombu.log
    kombu.connection
    kombu.message
    kombu.compression
    kombu.pools
    kombu.abstract
    kombu.resource
    kombu.serialization
    kombu.native_delayed_delivery

Kombu Transports
================

.. toctree::
    :maxdepth: 1

    kombu.transport
    kombu.transport.base
    kombu.transport.virtual
    kombu.transport.virtual.exchange
    kombu.transport.azurestoragequeues
    kombu.transport.azureservicebus
    kombu.transport.pyamqp
    kombu.transport.librabbitmq
    kombu.transport.qpid
    kombu.transport.memory
    kombu.transport.redis
    kombu.transport.mongodb
    kombu.transport.consul
    kombu.transport.etcd
    kombu.transport.zookeeper
    kombu.transport.filesystem
    kombu.transport.sqlalchemy
    kombu.transport.SQS
    kombu.transport.SLMQ
    kombu.transport.pyro


Kombu Asynchronous
==================

.. toctree::
    :maxdepth: 1

    kombu.asynchronous
    kombu.asynchronous.hub
    kombu.asynchronous.semaphore
    kombu.asynchronous.timer
    kombu.asynchronous.debug
    kombu.asynchronous.http
    kombu.asynchronous.http.base
    kombu.asynchronous.http.urllib3_client
    kombu.asynchronous.aws
    kombu.asynchronous.aws.connection
    kombu.asynchronous.aws.sqs
    kombu.asynchronous.aws.sqs.connection
    kombu.asynchronous.aws.sqs.message
    kombu.asynchronous.aws.sqs.queue

Kombu utils
===========

.. toctree::
    :maxdepth: 1

    kombu.utils.amq_manager
    kombu.utils.collections
    kombu.utils.compat
    kombu.utils.debug
    kombu.utils.div
    kombu.utils.encoding
    kombu.utils.eventio
    kombu.utils.functional
    kombu.utils.imports
    kombu.utils.json
    kombu.utils.limits
    kombu.utils.objects
    kombu.utils.scheduling
    kombu.utils.text
    kombu.utils.time
    kombu.utils.url
    kombu.utils.uuid
Added Sphinx Documentation 2010-07-23 12:43:33 +00:00			`===========================`
			`API Reference`
			`===========================`

			`:Release: \|version\|`
			`:Date: \|today\|`

Split reference guide into sections 2020-10-08 18:10:00 +00:00			`Kombu Core`
			`==========`

Added Sphinx Documentation 2010-07-23 12:43:33 +00:00			`.. toctree::`
Doc fixes 2016-10-27 23:15:40 +00:00			`:maxdepth: 1`
Added Sphinx Documentation 2010-07-23 12:43:33 +00:00
Refs to kombu top level symbols now resolve, and there's a kombu reference page 2012-10-23 15:20:32 +00:00			`kombu`
Adds missing reference pages 2011-09-07 13:13:11 +00:00			`kombu.common`
Control pattern matching (#997) * Added pattern/matcher to Mailbox * pattern/match for kombu 4 * Ensure kombu.matcher is covered by our documentation. * Adds test_matcher & pidbox unit tests. * Added tests to ensure exception is raised when matcher is not registered. * Adds to test for destination passed in to process. 2019-02-27 14:23:12 +00:00			`kombu.matcher`
PEP8ify + pyflakes 2011-09-22 16:10:13 +00:00			`kombu.mixins`
Refs to kombu top level symbols now resolve, and there's a kombu reference page 2012-10-23 15:20:32 +00:00			`kombu.simple`
Adds missing reference pages 2011-09-07 13:13:11 +00:00			`kombu.clocks`
Added Sphinx Documentation 2010-07-23 12:43:33 +00:00			`kombu.compat`
Added missing autodoc files 2010-10-21 13:35:04 +00:00			`kombu.pidbox`
Added Sphinx Documentation 2010-07-23 12:43:33 +00:00			`kombu.exceptions`
Adds missing reference files 2012-01-09 16:50:12 +00:00			`kombu.log`
Refs to kombu top level symbols now resolve, and there's a kombu reference page 2012-10-23 15:20:32 +00:00			`kombu.connection`
Adds kombu.async.timer (+ accidentally staged documentation fixes) 2013-10-01 16:30:26 +00:00			`kombu.message`
Refs to kombu top level symbols now resolve, and there's a kombu reference page 2012-10-23 15:20:32 +00:00			`kombu.compression`
			`kombu.pools`
			`kombu.abstract`
[dist] Use apicheck from sphinx_celery 2016-04-08 21:03:29 +00:00			`kombu.resource`
Split reference guide into sections 2020-10-08 18:10:00 +00:00			`kombu.serialization`
Add native delayed delivery API to kombu (#2128) * Adjust flake8 configuration to match Celery's configuration. * Add native delayed delivery API. * Add documentation. * Fix linter errors. * Fix pydocstyle errors. * Fix apicheck linter. * Address code review. 2024-10-12 18:17:55 +00:00			`kombu.native_delayed_delivery`
Split reference guide into sections 2020-10-08 18:10:00 +00:00
			`Kombu Transports`
			`================`

			`.. toctree::`
			`:maxdepth: 1`

All occurences of the term Backend has been replaced with Transport. kombu.backends -> kombu.transport BrokerConnection(backend_cls="pika") -> BrokerConnection(transport="pika") kombu.backends.base.BaseBackend -> kombu.transport.base.Transport kombu.backends.pyredis.RedisBackend -> kombu.transport.pyredis.Transport etc, etc. 2010-08-04 11:46:10 +00:00			`kombu.transport`
Split reference guide into sections 2020-10-08 18:10:00 +00:00			`kombu.transport.base`
			`kombu.transport.virtual`
			`kombu.transport.virtual.exchange`
Add transports based on Azure PaaS (#891) * Add transports based on Azure PaaS This pull request adds two new transport implementations: - `azurestoragequeues` is implemented on top of Azure Storage Queues [1]. This offers a simple but scalable and low-cost PaaS transport for Celery users in Azure. The transport is intended to be used in conjunction with the Azure Block Blob Storage backend [2]. - `azureservicebus` is implemented on top of Azure Service Bus [3] and offers PaaS support for more demanding Celery workloads in Azure. The transport is intended to be used in conjunction with the Azure CosmosDB backend [4]. This pull request was created together with @ankurokok, @dkisselev, @evandropaula, @martinpeck and @michaelperel. [1] https://azure.microsoft.com/en-us/services/storage/queues/ [2] https://github.com/celery/celery/pull/4685 [3] https://azure.microsoft.com/en-us/services/service-bus/ [4] https://github.com/celery/celery/pull/4720 * Exclude Azure transports from code coverage There is test coverage for the transports but the tests require Azure credentials to run (passed via environment variables) so codecov doesn't exercise them. * Remove env vars to configure transport * Remove abbreviations 2018-08-30 17:34:52 +00:00			`kombu.transport.azurestoragequeues`
			`kombu.transport.azureservicebus`
Adds reference API for kombu.transport.pyamqp 2012-07-24 15:21:42 +00:00			`kombu.transport.pyamqp`
py-amqp replaces amqplib as the default transport 2012-11-05 13:27:07 +00:00			`kombu.transport.librabbitmq`
Adding reference .rst files 2014-03-17 21:11:53 +00:00			`kombu.transport.qpid`
All occurences of the term Backend has been replaced with Transport. kombu.backends -> kombu.transport BrokerConnection(backend_cls="pika") -> BrokerConnection(transport="pika") kombu.backends.base.BaseBackend -> kombu.transport.base.Transport kombu.backends.pyredis.RedisBackend -> kombu.transport.pyredis.Transport etc, etc. 2010-08-04 11:46:10 +00:00			`kombu.transport.memory`
Adds missing reference files 2012-01-09 16:50:12 +00:00			`kombu.transport.redis`
Ported CouchDB transport from ghettoq 2010-10-27 12:22:29 +00:00			`kombu.transport.mongodb`
Use Google-style docstrings 2016-07-16 18:51:23 +00:00			`kombu.transport.consul`
Doc fixes 2016-10-27 23:15:40 +00:00			`kombu.transport.etcd`
Adds support for Apache Zookeeper as a transport. Closes #134 2012-06-07 12:08:41 +00:00			`kombu.transport.zookeeper`
Adds missing reference pages 2012-07-05 14:46:13 +00:00			`kombu.transport.filesystem`
Re-Adding support for sqlalchemy as it is needed by Apache project Airflow (#687) * Re-Adding support for sqlalchemy as it is needed by Apache project Airflow * Re-Adding support for sqlalchemy as it is needed by Apache project Airflow 2017-05-17 08:17:47 +00:00			`kombu.transport.sqlalchemy`
Fixes Sphinx errors 2011-09-05 12:09:39 +00:00			`kombu.transport.SQS`
Adds kombu.async.timer (+ accidentally staged documentation fixes) 2013-10-01 16:30:26 +00:00			`kombu.transport.SLMQ`
Adds missing reference pages 2013-09-12 16:32:19 +00:00			`kombu.transport.pyro`
Split reference guide into sections 2020-10-08 18:10:00 +00:00

			`Kombu Asynchronous`
			`==================`

			`.. toctree::`
			`:maxdepth: 1`

			`kombu.asynchronous`
			`kombu.asynchronous.hub`
			`kombu.asynchronous.semaphore`
			`kombu.asynchronous.timer`
			`kombu.asynchronous.debug`
			`kombu.asynchronous.http`
			`kombu.asynchronous.http.base`
Feature: urllib3 instead of curl (#2134) * feature(urllib3): add urllib3 client * test(urllib3): test urllib3 client * test(urllib3): update http test for urllib3 * test(urllib3): use urllib3 client instead of curl * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * style(urllib3): remove unused imports * style(urllib3): fix pre-commit errors * ci(urllib3): remove pycurl dependency * docs(urllib3): add docs * style(urllib3): fix failing gh-workflow py3.8 * style(urllib3): add mention of ProxyManager * style(urllib3): fix pre-commit issues * style(pycurl): remove curl-related code * feat(urllib3): add missing request features (header, auth, ssl, proxy, redirects) * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fix(urllib3): improve styling * test(urllib3): add new tests * fix(urllib3): fix request auth * fix(aws): validate certificate on request * style(): add missing exports * feat(aws): add ssl certificate verification from boto * feat(urllib): try to use certifi.where() if request.ca_certs are not provided * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * ci(pydocstyle): add missing docstring in public class * test(urllib3): improve test case * ci(pydocstyle): fix multi-line docstring summary should start at the first line * feat(urllib3): remove assert_hostname * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * test(boto): add test for get_cert_path returning .pem file path * test(urllib3): add test for _get_pool_key_parts method * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Asif Saif Uddin <auvipy@gmail.com> Co-authored-by: Tomer Nosrati <tomer.nosrati@gmail.com> 2024-10-14 11:01:25 +00:00			`kombu.asynchronous.http.urllib3_client`
Split reference guide into sections 2020-10-08 18:10:00 +00:00			`kombu.asynchronous.aws`
			`kombu.asynchronous.aws.connection`
			`kombu.asynchronous.aws.sqs`
			`kombu.asynchronous.aws.sqs.connection`
			`kombu.asynchronous.aws.sqs.message`
			`kombu.asynchronous.aws.sqs.queue`

			`Kombu utils`
			`===========`

			`.. toctree::`
			`:maxdepth: 1`

Reorganizes kombu.utils.__init__ package 2016-07-16 20:33:32 +00:00			`kombu.utils.amq_manager`
			`kombu.utils.collections`
			`kombu.utils.compat`
Fixes Sphinx errors 2011-09-05 12:09:39 +00:00			`kombu.utils.debug`
Reorganizes kombu.utils.__init__ package 2016-07-16 20:33:32 +00:00			`kombu.utils.div`
Adds missing reference for kombu.utils.encoding 2011-09-05 11:59:26 +00:00			`kombu.utils.encoding`
Reorganizes kombu.utils.__init__ package 2016-07-16 20:33:32 +00:00			`kombu.utils.eventio`
Added missing autodoc files 2010-10-21 13:35:04 +00:00			`kombu.utils.functional`
Reorganizes kombu.utils.__init__ package 2016-07-16 20:33:32 +00:00			`kombu.utils.imports`
[dist] Use apicheck from sphinx_celery 2016-04-08 21:03:29 +00:00			`kombu.utils.json`
Reorganizes kombu.utils.__init__ package 2016-07-16 20:33:32 +00:00			`kombu.utils.limits`
			`kombu.utils.objects`
			`kombu.utils.scheduling`
Use fuzzy matching to suggest alternatives to typos in transport name 2013-03-22 12:39:43 +00:00			`kombu.utils.text`
Adds kombu.utils.time to API Reference 2016-10-15 00:01:45 +00:00			`kombu.utils.time`
Reorganizes kombu.utils.__init__ package 2016-07-16 20:33:32 +00:00			`kombu.utils.url`
			`kombu.utils.uuid`