Changelog History
Page 2
-
v2.1.2 Changes
September 04, 2019- Allow
AsyncResult
object used inMiniHuey
to support the__call__()
method to block and resolve the task result. - When running the django
run_huey
management command, the huey loggers will not be configured if another logging handler is already registered to the huey namespace. - โ Added experimental contrib storage engine using
kyoto tycoon <http://fallabs.com/kyototycoon>
_ which supports task priority and the option to do automatic result expiration. Requires theukt <https://github.com/coleifer/ukt>
_ python package and a custom kyototycoon lua script. - ๐ Allow the Sqlite storage engine busy timeout to be configured when
instantiating
SqliteHuey
.
- Allow
-
v2.1.1 Changes
August 07, 2019- ๐ Ensure that
task()
-decorated functions retain their docstrings. - ๐ Fix logger setup so that the consumer log configuration is only applied to
the
huey
namespace, rather than the root logger. - ๐ฆ Expose
result
,signal
anddisconnect_signal
in the Django huey extension. - โ Add
SignedSerializer
, which signs and validates task messages. - ๐จ Refactor the
SqliteStorage
so that it can be more easily extended to support other databases.
- ๐ Ensure that
-
v2.1.0 Changes
June 06, 2019- Added new contrib module
sql_huey
, which usespeewee <https://github.com/coleifer/peewee>
_ to provide storage layer using any of the supported databases (sqlite, mysql or postgresql). - โ Added
RedisExpireHuey
, which modifies the usual Redis result storage logic to use an expire time for task result values. A consequence of this is that this storage implementation must keep all result keys at the top-level Redis keyspace. There are some small changes to the storage APIs as well, but will only possibly affect maintainers of alternative storage layers. - Also added a
PriorityRedisExpireHuey
which combines the priority-queue support fromPriorityRedisHuey
with the result-store expiration mechanism ofRedisExpireHuey
. - ๐ Fix gzip compatibility issue when using Python 2.x.
- โ Add option to
Huey
to usezlib
as the compression method instead of gzip. - โ Added
FileStorageMethods
storage mixin, which uses the filesystem for task result-store APIs (put, peek, pop). - The storage-specific
Huey
implementations (e.g.RedisHuey
) are no longer subclasses, but instead are partial applications of theHuey
constructor.
- Added new contrib module
-
v2.0.1 Changes
April 03, 2019- โฑ Small fixes, fixed typo in Exception class being caught by scheduler.
-
v2.0.0 Changes
April 02, 2019๐ This section describes the changes in the 2.0.0 release. A detailed list of
๐ changes can be found here: https://huey.readthedocs.io/en/latest/changes.htmlOverview of changes:
always_eager
mode has been renamed toimmediate
mode. Unlike previous
๐ versions,immediate
mode involves the same code paths used by the consumer
โ process. This makes it easier to test features like task revocation and task
โฑ scheduling without needing to run a dedicated consumer process. Immediate
๐ง mode uses an in-memory storage layer by default, but can be configured to use
"live" storage like Redis or Sqlite.- ๐ The events stream API has been removed in favor of simpler callback-driven
๐ฆ signals APIs. These
๐ callbacks are executed synchronously within the huey consumer process. - A new serialization format is used in 2.0.0, however consumers running 2.0
will continue to be able to read and deserialize messages enqueued by Huey
๐ version 1.11.0 for backwards compatibility. - ๐ Support for task priorities.
- ๐ New
Serializer
abstraction allows users to customize the serialization
format used when reading and writing tasks. - โฑ Huey consumer and scheduler can be more easily run within the application
๐จ process, if you prefer not to run a separate consumer process. - Tasks can now specify an
on_error
handler, in addition to the
๐ previously-supportedon_complete
handler. - Task pipelines return a special
ResultGroup
object which simplifies reading
the results of a sequence of task executions. SqliteHuey
has been promoted out ofcontrib
, onto an equal footing with
๐RedisHuey
. To simplify deployment, the dependency on
๐ peewee was removed and the Sqlite
storage engine uses the Pythonsqlite3
driver directly.
-
v1.11.0 Changes
February 16, 2019Backwards-incompatible changes
Previously, it was possible for certain tasks to be silently ignored if a task with that name already existed in the registry. To fix this, I have made two changes:
- The task-name, when serialized, now consists of the task module and the name of the decorated function. So, "queue_task_foo" becomes "myapp.tasks.foo". ๐ป 2. An exception will be raised when attempting to register a task function with the same module + name.
Together, these changes are intended to fix problems described in #386.
โฌ๏ธ Because these changes will impact the serialization (and deserialization) of messages, it is important that you consume all tasks (including scheduled tasks) before upgrading.
Always-eager mode changes
In order to provide a more consistent API, tasks enqueued using
always_eager
mode will now return a dummyTaskResultWrapper
implementation that wraps the return value of the task. This change is designed to provide the same API for reading task result values, regardless of whether you are using always-eager mode or not.Previously, tasks executed with
always_eager
would return the Python value directly from the task. When using Huey with the consumer, though, task results are not available immediately, so a special wrapperTaskResultWrapper
is returned, which provides helper methods for retrieving the return value of the task. Going forward,always_eager
tasks will returnEagerTaskResultWrapper
, which implements the sameget()
API that is typically used to retrieve task return values. -
v1.10.5 Changes
December 19, 2018- โก๏ธ Compatibility with redis-py 3.0, updated requirements / dependencies.
- โ Add pre-/post- hooks into the djhuey namespace.
-
v1.10.4 Changes
November 14, 2018- 0๏ธโฃ Log time taken to execute tasks at default log level.
- ๐ Fix missing import in SQLite storage backend.
- ๐จ Small refactoring in Redis storage backend to make it easier to override the driver / client implementation.
- ๐ Fix failing tests for simpledb storage backend.
-
v1.10.3 Changes
October 10, 2018- Fixed regression where in always eager mode exceptions within tasks were being swallowed instead of raised.
- โ Added an API for registering hooks to run when each worker process starts-up. This simplifies creating global/process-wide shared resources, such as a connection pool or database client. Documentation.
-
v1.10.2 Changes
October 10, 2018- More granular "extras" installation options.