kombu の API リファレンス
kombu (celery/kombu) の公開 API 343 件 —— クラス 164、関数 69、メソッド 110。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。
リポジトリ: celery/kombu
| 種別 | 件数 |
|---|---|
| クラス | 164 |
| 関数 | 69 |
| メソッド | 110 |
API 一覧
class
kombu.abstract.MaybeChannelBoundMixin for classes that can be bound to an AMQP channel.
method
kombu.abstract.MaybeChannelBound.bind(channel:Channel | Connection) -> _MaybeChannelBoundTypeCreate copy of the instance that is bound to a channel.
method
kombu.abstract.MaybeChannelBound.channel() -> ChannelCurrent channel if the object is bound.
method
kombu.abstract.MaybeChannelBound.is_bound() -> boolFlag set if the channel is bound.
method
kombu.abstract.MaybeChannelBound.maybe_bind(channel:Channel | Connection) -> _MaybeChannelBoundTypeBind instance to channel if not already bound.
method
kombu.abstract.MaybeChannelBound.revive(channel:Channel) -> NoneRevive channel after the connection has been re-established.
method
kombu.abstract.MaybeChannelBound.when_bound() -> NoneCallback called when the class is bound.
class
kombu.abstract.ObjectCommon base class.
func
kombu.asynchronous.aws.connect_sqs(aws_access_key_id:str | None=None, aws_secret_access_key:str | None=None, **kwargs:Any) -> AsyncSQSConnectionReturn async connection to Amazon SQS.
class
kombu.asynchronous.aws.connection.AsyncAWSQueryConnectionAsync AWS Query Connection.
class
kombu.asynchronous.aws.connection.AsyncConnectionAsync AWS Connection.
class
kombu.asynchronous.aws.connection.AsyncHTTPResponseAsync HTTP Response.
class
kombu.asynchronous.aws.connection.AsyncHTTPSConnectionAsync HTTP Connection.
class
kombu.asynchronous.aws.sqs.connection.AsyncSQSConnectionAsync SQS Connection.
class
kombu.asynchronous.aws.sqs.message.AsyncMessageSerialized message.
method
kombu.asynchronous.aws.sqs.message.AsyncMessage.encode(value)Encode/decode the value using Base64 encoding.
class
kombu.asynchronous.aws.sqs.message.AsyncRawMessageRaw Message.
class
kombu.asynchronous.aws.sqs.message.BaseAsyncMessageBase class for messages received on async client.
class
kombu.asynchronous.aws.sqs.queue.AsyncQueueAsync SQS Queue.
func
kombu.asynchronous.debug.repr_flag(flag)Return description of event loop flag.
func
kombu.asynchronous.debug.repr_readers(h)Return description of pending readers.
func
kombu.asynchronous.debug.repr_writers(h)Return description of pending writers.
func
kombu.asynchronous.http.Client(hub:Hub | None=None, **kwargs:int) -> CurlClientCreate new HTTP client.
class
kombu.asynchronous.http.base.HeadersRepresents a mapping of HTTP headers.
class
kombu.asynchronous.http.base.RequestA HTTP Request.
class
kombu.asynchronous.http.base.ResponseHTTP Response.
method
kombu.asynchronous.http.base.Response.body()The full contents of the response body.
class
kombu.asynchronous.http.curl.CurlClientCurl HTTP Client.
func
kombu.asynchronous.http.get_client(hub:Hub | None=None, **kwargs:int) -> CurlClientGet or create HTTP client bound to the current event loop.
class
kombu.asynchronous.hub.HubEvent loop object.
class
kombu.asynchronous.hub.StopStops the event loop.
func
kombu.asynchronous.hub.get_event_loop() -> Hub | NoneGet current event loop object.
func
kombu.asynchronous.hub.set_event_loop(loop:Hub | None) -> Hub | NoneSet the current event loop object.
class
kombu.asynchronous.semaphore.DummyLockPretending to be a lock.
class
kombu.asynchronous.semaphore.LaxBoundedSemaphoreAsynchronous Bounded Semaphore.
method
kombu.asynchronous.semaphore.LaxBoundedSemaphore.acquire(callback:Callable[P, None], *partial_args:P.args, **partial_kwargs:P.kwargs) -> boolAcquire semaphore.
method
kombu.asynchronous.semaphore.LaxBoundedSemaphore.grow(n:int=1) -> NoneChange the size of the semaphore to accept more users.
method
kombu.asynchronous.semaphore.LaxBoundedSemaphore.release() -> NoneRelease semaphore.
method
kombu.asynchronous.semaphore.LaxBoundedSemaphore.shrink(n:int=1) -> NoneChange the size of the semaphore to accept less users.
class
kombu.asynchronous.timer.EntrySchedule Entry.
class
kombu.asynchronous.timer.TimerAsync timer implementation.
method
kombu.asynchronous.timer.Timer.queue(_pop=heapq.heappop)Snapshot of underlying datastructure.
func
kombu.asynchronous.timer.to_timestamp(d, default_timezone=ZoneInfo('UTC'), time=monotonic)Convert datetime to timestamp.
class
kombu.clocks.LamportClockLamport's logical clock.
method
kombu.clocks.LamportClock.sort_heap(h:list[tuple[int, str]]) -> tuple[int, str]Sort heap of events.
class
kombu.clocks.timetupleTuple of event clock information.
class
kombu.common.BroadcastBroadcast queue.
class
kombu.common.QoSThread safe increment/decrement of a channels prefetch_count.
method
kombu.common.QoS.set(pcount)Set channel prefetch_count setting.
method
kombu.common.QoS.update()Update prefetch count with current value.
func
kombu.common.ignore_errors(conn, fun=None, *args, **kwargs)Ignore connection and channel errors.
func
kombu.common.itermessages(conn, channel, queue, limit=1, timeout=None, callbacks=None, **kwargs)Iterator over messages.
func
kombu.common.maybe_declare(entity, channel=None, retry=False, **retry_policy)Declare entity (cached).
func
kombu.common.send_reply(exchange, req, msg, producer=None, retry=False, retry_policy=None, **props)Send reply for request.
class
kombu.compat.ConsumerCarrot compatible consumer.
class
kombu.compat.PublisherCarrot compatible producer.
func
kombu.compression.compress(body, content_type)Compress text.
func
kombu.compression.decompress(body, content_type)Decompress compressed text.
func
kombu.compression.get_decoder(t)Get decoder by alias name.
func
kombu.compression.get_encoder(t)Get encoder by alias name.
func
kombu.compression.register(encoder, decoder, content_type, aliases=None)Register new compression method.
class
kombu.connection.ChannelPoolPool of channels.
class
kombu.connection.ConnectionA connection to the broker.
method
kombu.connection.Connection.ChannelPool(limit=None, **kwargs)Pool of channels.
method
kombu.connection.Connection.Pool(limit=None, **kwargs)Pool of connections.
method
kombu.connection.Connection.channel()Create and return a new channel.
method
kombu.connection.Connection.connection()The underlying connection object.
method
kombu.connection.Connection.default_channel() -> ChannelDefault channel.
method
kombu.connection.Connection.get_transport_cls()Get the currently used transport class.
method
kombu.connection.Connection.heartbeat_check(rate=2)Check heartbeats.
method
kombu.connection.Connection.info()Get connection info.
method
kombu.connection.Connection.manager()AMQP Management API.
method
kombu.connection.Connection.recoverable_channel_errors()Recoverable channel errors.
method
kombu.connection.Connection.recoverable_connection_errors()Recoverable connection errors.
method
kombu.connection.Connection.release()Close the connection (if open).
class
kombu.connection.ConnectionPoolPool of connections.
class
kombu.connection.PooledConnectionWraps :class:`kombu.Connection`.
func
kombu.connection.maybe_channel(channel:Channel | Connection) -> ChannelGet channel from object.
class
kombu.entity.ExchangeAn Exchange declaration.
method
kombu.entity.Exchange.Message(body, delivery_mode=None, properties=None, **kwargs)Create message instance to be sent with :meth:`publish`.
method
kombu.entity.Exchange.declare(nowait=False, passive=None, channel=None)Declare the exchange.
method
kombu.entity.Exchange.publish(message, routing_key=None, mandatory=False, immediate=False, exchange=None)Publish message.
class
kombu.entity.QueueA Queue declaration.
method
kombu.entity.Queue.cancel(consumer_tag)Cancel a consumer by consumer tag.
method
kombu.entity.Queue.consume(consumer_tag='', callback=None, no_ack=None, nowait=False, on_cancel=None)Start a queue consumer.
method
kombu.entity.Queue.delete(if_unused=False, if_empty=False, nowait=False)Delete the queue.
method
kombu.entity.Queue.get(no_ack=None, accept=None)Poll the server for a new message.
method
kombu.entity.Queue.purge(nowait=False)Remove all ready messages from the queue.
method
kombu.entity.Queue.queue_declare(nowait=False, passive=False, channel=None)Declare queue on the server.
class
kombu.entity.bindingRepresents a queue or exchange binding.
method
kombu.entity.binding.bind(entity, nowait=False, channel=None)Bind entity to this binding.
method
kombu.entity.binding.declare(channel, nowait=False)Declare destination exchange.
method
kombu.entity.binding.unbind(entity, nowait=False, channel=None)Unbind entity from this binding.
func
kombu.entity.maybe_delivery_mode(v, modes=None, default=PERSISTENT_DELIVERY_MODE)Get delivery mode by name (or none if undefined).
class
kombu.exceptions.ChannelLimitExceededMaximum number of simultaneous channels exceeded.
class
kombu.exceptions.ConnectionLimitExceededMaximum number of simultaneous connections exceeded.
class
kombu.exceptions.ContentDisallowedConsumer does not allow this content-type.
class
kombu.exceptions.DecodeErrorCannot decode object.
class
kombu.exceptions.EncodeErrorCannot encode object.
class
kombu.exceptions.HttpErrorHTTP Client Error.
class
kombu.exceptions.InconsistencyErrorData or environment has been found to be inconsistent.
class
kombu.exceptions.KombuErrorCommon subclass for all Kombu exceptions.
class
kombu.exceptions.LimitExceededLimit exceeded.
class
kombu.exceptions.MessageStateErrorThe message has already been acknowledged.
class
kombu.exceptions.NotBoundErrorTrying to call channel dependent method on unbound entity.
class
kombu.exceptions.OperationalErrorRecoverable message transport connection error.
class
kombu.exceptions.SerializationErrorFailed to serialize/deserialize content.
class
kombu.exceptions.SerializerNotInstalledSupport for the requested serialization type is not installed.
class
kombu.exceptions.VersionMismatchLibrary dependency version mismatch.
func
kombu.exceptions.reraise(tp:type[BaseExceptionType], value:BaseExceptionType, tb:TracebackType | None=None) -> BaseExceptionTypeReraise exception.
class
kombu.log.LogMixinMixin that adds severity methods to any class.
func
kombu.log.get_logger(logger:str | Logger)Get logger by name.
func
kombu.log.get_loglevel(level)Get loglevel by name.
func
kombu.log.setup_logging(loglevel=None, logfile=None)Setup logging.
class
kombu.matcher.MatcherNotInstalledMatcher not installed/found.
class
kombu.matcher.MatcherRegistryPattern matching function registry.
method
kombu.matcher.MatcherRegistry.match(data:bytes, pattern:bytes, matcher:str | None=None, matcher_kwargs:dict[str, str] | None=None) -> boolCall the matcher.
method
kombu.matcher.MatcherRegistry.register(name:str, matcher:MatcherFunction) -> NoneAdd matcher by name to the registry.
method
kombu.matcher.MatcherRegistry.unregister(name:str) -> NoneRemove matcher by name from the registry.
func
kombu.matcher.register_glob() -> NoneRegister glob into default registry.
func
kombu.matcher.register_pcre() -> NoneRegister pcre into default registry.
class
kombu.message.MessageBase class for received messages.
method
kombu.message.Message.decode()Deserialize the message body.
method
kombu.message.Message.payload()The decoded message body.
method
kombu.message.Message.reject(requeue=False)Reject this message.
class
kombu.messaging.ConsumerMessage consumer.
method
kombu.messaging.Consumer.cancel()End all active queue consumers.
method
kombu.messaging.Consumer.cancel_by_queue(queue)Cancel consumer by queue name.
method
kombu.messaging.Consumer.consume(no_ack=None)Start consuming messages.
method
kombu.messaging.Consumer.declare()Declare queues, exchanges and bindings.
method
kombu.messaging.Consumer.flow(active)Enable/disable flow from peer.
method
kombu.messaging.Consumer.purge()Purge messages from all queues.
method
kombu.messaging.Consumer.qos(prefetch_size=0, prefetch_count=0, apply_global=False)Specify quality of service.
method
kombu.messaging.Consumer.receive(body, message)Method called when a message is received.
method
kombu.messaging.Consumer.recover(requeue=False)Redeliver unacknowledged messages.
method
kombu.messaging.Consumer.revive(channel)Revive consumer after connection loss.
class
kombu.messaging.ProducerMessage Producer.
method
kombu.messaging.Producer.declare()Declare the exchange.
class
kombu.mixins.ConsumerMixinConvenience mixin for implementing consumer programs.
class
kombu.mixins.ConsumerProducerMixinConsumer and Producer mixin.
class
kombu.moduleCustomized Python module.
class
kombu.pidbox.MailboxProcess Mailbox.
class
kombu.pidbox.NodeMailbox node.
class
kombu.pools.ConnectionsCollection of connection pools.
class
kombu.pools.PoolGroupCollection of resource pools.
class
kombu.pools.ProducerPoolPool of :class:`kombu.Producer` instances.
class
kombu.pools.ProducersCollection of producer pools.
func
kombu.pools.get_limit()Get current connection pool limit.
func
kombu.pools.register_group(group)Register group (can be used as decorator).
func
kombu.pools.reset(*args, **kwargs)Reset all pools by closing open resources.
func
kombu.pools.set_limit(limit, force=False, reset_after=False, ignore_errors=False)Set new connection pool limit.
class
kombu.resource.ResourcePool of resources.
method
kombu.resource.Resource.acquire(block=False, timeout=None)Acquire resource.
method
kombu.resource.Resource.replace(resource)Replace existing resource with a new instance.
class
kombu.serialization.SerializerRegistryThe registry keeps track of serialization methods.
method
kombu.serialization.SerializerRegistry.dumps(data, serializer=None)Encode data.
func
kombu.serialization.disable_insecure_serializers(allowed=NOTSET)Disable untrusted serializers.
func
kombu.serialization.not_available(*args, **kwargs)Raise SerializerNotInstalled.
func
kombu.serialization.raw_encode(data)Special case serializer.
func
kombu.serialization.register_msgpack()Register msgpack serializer.
func
kombu.serialization.register_pickle()Register pickle serializer.
class
kombu.simple.SimpleBufferSimple API for ephemeral queues.
class
kombu.simple.SimpleQueueSimple API for persistent queues.
class
kombu.transport.SLMQ.ChannelSLMQ Channel.
class
kombu.transport.SLMQ.TransportSLMQ Transport.
class
kombu.transport.SQS.ChannelSQS Channel.
method
kombu.transport.SQS.Channel.fanout() -> SnsFanoutProvides SNS fanout functionality.
method
kombu.transport.SQS.Channel.get_message_attributes() -> dict[str, Any]Get the message attributes to be fetched from SQS.
method
kombu.transport.SQS.Channel.is_sts_token_refresh_required(name:Any, client_map:dict[str, BaseClient], expire_time:datetime | None=None) -> boolChecks if the STS token needs renewing.
method
kombu.transport.SQS.Channel.new_sqs_client(region, access_key_id, secret_access_key, session_token=None)Create a new SQS client.
method
kombu.transport.SQS.Channel.remove_stale_sns_subscriptions(exchange_name:str) -> NoneRemoves any stale SNS topic subscriptions.
class
kombu.transport.SQS.QoSQuality of Service guarantees implementation for SQS.
method
kombu.transport.SQS.SNS.SNS.get_client(exchange_name:str | None=None)Get or create a Boto SNS client.
method
kombu.transport.SQS.SNS.SNS.initialise_exchange(exchange_name:str) -> NoneInitialise SNS topic for a fanout exchange.
method
kombu.transport.SQS.SNS.SNS.serialise_message_attributes(message_attributes:dict | None) -> dictSerialises SQS message attributes into SNS format.
class
kombu.transport.SQS.TransportSQS Transport.
class
kombu.transport.SQS.exceptions.AccessDeniedQueueExceptionRaised when access to the AWS queue is denied.
class
kombu.transport.SQS.exceptions.DoesNotExistQueueExceptionThe specified queue doesn't exist.
class
kombu.transport.azureservicebus.ChannelAzure Service Bus channel.
method
kombu.transport.azureservicebus.Channel.entity_name(name:str, table:dict[int, int] | None=None) -> strFormat AMQP queue name into a valid ServiceBus queue name.
class
kombu.transport.azureservicebus.SendReceiveContainer for Sender and Receiver.
class
kombu.transport.azureservicebus.TransportAzure Service Bus transport.
class
kombu.transport.azurestoragequeues.ChannelAzure Storage Queues channel.
class
kombu.transport.azurestoragequeues.TransportAzure Storage Queues transport.
class
kombu.transport.base.ImplementsHelper class used to define transport features.
class
kombu.transport.base.ManagementAMQP Management API (incomplete).
class
kombu.transport.base.StdChannelStandard channel base class.
class
kombu.transport.base.TransportBase class for transports.
method
kombu.transport.base.Transport.as_uri(uri:str, include_password=False, mask='**') -> strCustomise the display format of the URI.
class
kombu.transport.confluentkafka.ChannelKafka Channel.
class
kombu.transport.confluentkafka.MessageMessage object.
class
kombu.transport.confluentkafka.NoBrokersAvailableKafka broker is not available exception.
class
kombu.transport.confluentkafka.QoSQuality of Service guarantees.
method
kombu.transport.confluentkafka.QoS.reject(delivery_tag, requeue=False)Reject a message by delivery tag.
class
kombu.transport.confluentkafka.TransportKafka Transport.
class
kombu.transport.consul.ChannelConsul Channel class which talks to the Consul Key/Value store.
class
kombu.transport.consul.LockErrorAn error occurred while trying to acquire the lock.
class
kombu.transport.consul.TransportConsul K/V storage Transport for Kombu.
class
kombu.transport.etcd.ChannelEtcd Channel class which talks to the Etcd.
class
kombu.transport.etcd.TransportEtcd storage Transport for Kombu.
method
kombu.transport.etcd.Transport.verify_connection(connection)Verify the connection works.
class
kombu.transport.filesystem.ChannelFilesystem Channel.
class
kombu.transport.filesystem.TransportFilesystem Transport.
func
kombu.transport.filesystem.lock(file, flags)Create file lock.
func
kombu.transport.filesystem.unlock(file)Remove file lock.
class
kombu.transport.gcpubsub.AtomicCounterThreadsafe counter.
class
kombu.transport.gcpubsub.ChannelGCP Pub/Sub channel.
method
kombu.transport.gcpubsub.Channel.basic_ack(delivery_tag, multiple=False)Acknowledge one message.
method
kombu.transport.gcpubsub.Channel.close()Close the channel.
method
kombu.transport.gcpubsub.Channel.entity_name(name:str, table=CHARS_REPLACE_TABLE) -> strFormat AMQP queue name into a valid Pub/Sub queue name.
class
kombu.transport.gcpubsub.QueueDescriptorPub/Sub queue descriptor.
class
kombu.transport.gcpubsub.TransportGCP Pub/Sub transport.
class
kombu.transport.gcpubsub.UnackedIdsThreadsafe list of ack_ids.
func
kombu.transport.get_transport_cls(transport:str | None=None) -> type | NoneGet transport class by name.
class
kombu.transport.librabbitmq.ChannelAMQP Channel (librabbitmq).
class
kombu.transport.librabbitmq.ConnectionAMQP Connection (librabbitmq).
class
kombu.transport.librabbitmq.MessageAMQP Message (librabbitmq).
class
kombu.transport.librabbitmq.TransportAMQP Transport (librabbitmq).
class
kombu.transport.memory.ChannelIn-memory Channel.
class
kombu.transport.memory.TransportIn-memory Transport.
class
kombu.transport.mongodb.BroadcastCursorCursor for broadcast queues.
class
kombu.transport.mongodb.ChannelMongoDB Channel.
method
kombu.transport.mongodb.Channel.get_now()Return current time in UTC.
class
kombu.transport.mongodb.TransportMongoDB Transport.
func
kombu.transport.native_delayed_delivery.level_name(level:int, prefix:str | None=None) -> strGenerates the delayed queue/exchange name based on the level.
class
kombu.transport.pyamqp.ChannelAMQP Channel.
class
kombu.transport.pyamqp.ConnectionAMQP Connection.
class
kombu.transport.pyamqp.MessageAMQP Message.
class
kombu.transport.pyamqp.SSLTransportAMQP SSL Transport.
class
kombu.transport.pyamqp.TransportAMQP Transport.
method
kombu.transport.pyamqp.Transport.close_connection(connection)Close the AMQP broker connection.
class
kombu.transport.pyro.ChannelPyro Channel.
class
kombu.transport.pyro.KombuBrokerKombu Broker used by the Pyro transport.
class
kombu.transport.pyro.TransportPyro Transport.
class
kombu.transport.qpid.AuthenticationFailureCannot authenticate with Qpid.
class
kombu.transport.qpid.ChannelSupports broker configuration and messaging send and receive.
method
kombu.transport.qpid.Channel.basic_cancel(consumer_tag)Cancel consumer by consumer tag.
method
kombu.transport.qpid.Channel.basic_get(queue, no_ack=False, **kwargs)Non-blocking single message get and ACK from a queue by name.
method
kombu.transport.qpid.Channel.basic_reject(delivery_tag, requeue=False)Reject a message by delivery_tag.
method
kombu.transport.qpid.Channel.exchange_declare(exchange='', type='direct', durable=False, **kwargs)Create a new exchange.
method
kombu.transport.qpid.Channel.qos():class:`QoS` manager for this channel.
method
kombu.transport.qpid.Channel.queue_delete(queue, if_unused=False, if_empty=False, **kwargs)Delete a queue by name.
method
kombu.transport.qpid.Channel.typeof(exchange, default='direct')Get the exchange type.
class
kombu.transport.qpid.ConnectionQpid Connection.
method
kombu.transport.qpid.Connection.close()Close the connection.
method
kombu.transport.qpid.Connection.close_channel(channel)Close a Channel.
class
kombu.transport.qpid.QoSA helper object for message prefetch and ACKing purposes.
method
kombu.transport.qpid.QoS.ack(delivery_tag)Acknowledge a message by delivery_tag.
method
kombu.transport.qpid.QoS.get(delivery_tag)Get an un-ACKed message by delivery_tag.
method
kombu.transport.qpid.QoS.reject(delivery_tag, requeue=False)Reject a message by delivery_tag.
class
kombu.transport.qpid.TransportKombu native transport for a Qpid broker.
method
kombu.transport.qpid.Transport.establish_connection()Establish a Connection object.
class
kombu.transport.redis.ChannelRedis Channel.
class
kombu.transport.redis.GlobalKeyPrefixMixinMixin to provide common logic for global key prefixing.
class
kombu.transport.redis.MultiChannelPollerAsync I/O poller for Redis transport.
func
kombu.transport.redis.Mutex(client, name, expire)Acquire redis lock in non blocking way.
class
kombu.transport.redis.MutexHeldRaised when another party holds the lock.
class
kombu.transport.redis.PrefixedRedisPipelineCustom Redis pipeline that takes global_keyprefix into consideration.
class
kombu.transport.redis.QoSRedis Ack Emulation.
class
kombu.transport.redis.SentinelChannelChannel with explicit Redis Sentinel knowledge.
class
kombu.transport.redis.SentinelManagedSSLConnectionConnect to a Redis server using Sentinel + TLS.
class
kombu.transport.redis.SentinelTransportRedis Sentinel Transport.
class
kombu.transport.redis.TransportRedis Transport.
func
kombu.transport.redis.get_redis_error_classes()Return tuple of redis error classes.
func
kombu.transport.resolve_transport(transport:str | None=None) -> type | NoneGet transport by name.
class
kombu.transport.sqlalchemy.ChannelThe channel class.
class
kombu.transport.sqlalchemy.TransportThe transport class.
class
kombu.transport.sqlalchemy.models.MessageThe message class.
class
kombu.transport.sqlalchemy.models.QueueThe queue class.
func
kombu.transport.supports_librabbitmq() -> bool | NoneReturn true if :pypi:`librabbitmq` can be used.
class
kombu.transport.virtual.base.AbstractChannelAbstract channel interface.
class
kombu.transport.virtual.base.Base64Base64 codec.
class
kombu.transport.virtual.base.BrokerStateBroker state holds exchanges, queues and bindings.
class
kombu.transport.virtual.base.ChannelVirtual channel.
method
kombu.transport.virtual.base.Channel.basic_ack(delivery_tag, multiple=False)Acknowledge message.
method
kombu.transport.virtual.base.Channel.basic_cancel(consumer_tag)Cancel consumer by consumer tag.
method
kombu.transport.virtual.base.Channel.basic_consume(queue, no_ack, callback, consumer_tag, **kwargs)Consume from `queue`.
method
kombu.transport.virtual.base.Channel.basic_publish(message, exchange, routing_key, **kwargs)Publish message.
method
kombu.transport.virtual.base.Channel.basic_recover(requeue=False)Recover unacked messages.
method
kombu.transport.virtual.base.Channel.basic_reject(delivery_tag, requeue=False)Reject message.
method
kombu.transport.virtual.base.Channel.close()Close channel.
method
kombu.transport.virtual.base.Channel.flow(active=True)Enable/disable message flow.
method
kombu.transport.virtual.base.Channel.qos():class:`QoS` manager for this channel.
method
kombu.transport.virtual.base.Channel.queue_declare(queue=None, passive=False, **kwargs)Declare queue.
method
kombu.transport.virtual.base.Channel.queue_delete(queue, if_unused=False, if_empty=False, **kwargs)Delete queue.
class
kombu.transport.virtual.base.ManagementBase class for the AMQP management API.
class
kombu.transport.virtual.base.MessageMessage object.
class
kombu.transport.virtual.base.QoSQuality of Service guarantees.
method
kombu.transport.virtual.base.QoS.append(message, delivery_tag)Append message to transactional state.
method
kombu.transport.virtual.base.QoS.restore_unacked()Restore all unacknowledged messages.
class
kombu.transport.virtual.base.TransportVirtual transport.
class
kombu.transport.virtual.base.UndeliverableWarningThe message could not be delivered to a queue.
class
kombu.transport.virtual.exchange.DirectExchangeDirect exchange.
class
kombu.transport.virtual.exchange.ExchangeTypeBase class for exchanges.
method
kombu.transport.virtual.exchange.ExchangeType.prepare_bind(queue, exchange, routing_key, arguments)Prepare queue-binding.
class
kombu.transport.virtual.exchange.FanoutExchangeFanout exchange.
class
kombu.transport.virtual.exchange.TopicExchangeTopic exchange.
class
kombu.transport.zookeeper.ChannelZookeeper Channel.
class
kombu.transport.zookeeper.TransportZookeeper Transport.
func
kombu.utils.amq_manager.get_manager(client, hostname=None, port=None, userid=None, password=None)Get pyrabbit manager.
class
kombu.utils.collections.EqualityDictDict using the eq operator for keying.
class
kombu.utils.collections.HashedSeqHashed Sequence.
func
kombu.utils.collections.eqhash(o)Call ``obj.__eqhash__``.
func
kombu.utils.compat.coro(gen)Decorator to mark generator as co-routine.
func
kombu.utils.compat.fileno(f)Get fileno from file-like object.
func
kombu.utils.compat.nested(*managers)Nest context managers.
class
kombu.utils.debug.LogwrappedWrap all object methods, to log on call.
func
kombu.utils.debug.setup_logging(loglevel:int | None=logging.DEBUG, loggers:list[str] | None=None) -> NoneSetup logging to stdout.
func
kombu.utils.encoding.bytes_to_str(s)Convert bytes to str.
func
kombu.utils.encoding.default_encode(obj)Encode using default encoding.
func
kombu.utils.encoding.default_encoding(file=None)Get default encoding.
func
kombu.utils.encoding.ensure_bytes(s)Ensure s is bytes, not str.
func
kombu.utils.encoding.from_utf8(s, *args, **kwargs)Get str from utf-8 encoding.
func
kombu.utils.encoding.safe_repr(o, errors='replace')Safe form of repr, void of Unicode errors.
func
kombu.utils.encoding.safe_str(s, errors='replace')Safe form of str(), void of unicode errors.
func
kombu.utils.encoding.str_to_bytes(s)Convert str to bytes.
func
kombu.utils.eventio.poll(*args, **kwargs)Create new poller instance.
func
kombu.utils.functional.clear()Clear the cache and reset cache statistics.
class
kombu.utils.functional.lazyHolds lazy evaluation.
func
kombu.utils.imports.symbol_by_name(name, aliases=None, imp=None, package=None, sep='.', default=None, **kwargs)Get symbol by qualified name.
class
kombu.utils.json.JSONEncoderKombu custom json encoder.
func
kombu.utils.json.loads(s, _loads=json.loads, decode_bytes=True, object_hook=object_hook)Deserialize json from string.
func
kombu.utils.json.object_hook(o:dict)Hook function to perform custom deserialization.
class
kombu.utils.limits.TokenBucketToken Bucket Algorithm.
class
kombu.utils.objects.cached_propertyImplementation of Cached property.
class
kombu.utils.scheduling.FairCycleCycle between resources.
method
kombu.utils.scheduling.FairCycle.close()Close cycle.
method
kombu.utils.scheduling.FairCycle.get(callback, **kwargs)Get from next resource.
func
kombu.utils.scheduling.cycle_by_name(name)Get cycle class by name.
class
kombu.utils.scheduling.priority_cycleCycle that repeats items in order.
method
kombu.utils.scheduling.priority_cycle.rotate(last_used)Unused in this implementation.
class
kombu.utils.scheduling.round_robin_cycleIterator that cycles between items in round-robin.
method
kombu.utils.scheduling.round_robin_cycle.consume(n)Consume n items.
method
kombu.utils.scheduling.round_robin_cycle.update(it)Update items from iterable.
class
kombu.utils.scheduling.sorted_cycleCycle in sorted order.
method
kombu.utils.scheduling.sorted_cycle.consume(n)Consume n items.
func
kombu.utils.text.fmatch_best(needle:str, haystack:Iterable[str], min_ratio:float=0.6) -> str | NoneFuzzy match - Find best match (scalar).
func
kombu.utils.text.fmatch_iter(needle:str, haystack:Iterable[str], min_ratio:float=0.6) -> Iterator[tuple[float, str]]Fuzzy match: iteratively.
func
kombu.utils.text.version_string_as_tuple(s:str) -> version_info_tConvert version string to version info tuple.
func
kombu.utils.time.maybe_s_to_ms(v:int | float | None) -> int | NoneConvert seconds to milliseconds, but return None for None.
func
kombu.utils.url.parse_url(url)Parse URL into mapping of components.
class
kombu.utils.url.urlpartsNamed tuple representing parts of the URL.
func
kombu.utils.uuid.uuid(_uuid:Callable[[], UUID]=uuid4) -> strGenerate unique id in UUID4 format.
この情報について
掲載しているシグネチャは celery/kombu の公開ソースコードを
Python の ast モジュールで静的解析し、引数名・デフォルト値・
型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。
詳しくは仕組みの解説をご覧ください。