Upgrading arq 0.18 to 0.19
Unknown0.18.4 → 0.19.1
Fetching 2 releases from GitHub…0 / 2
UnknownUpgrade verdict
DepDelta is still reading the notes for this range, so breaking changes can't be ruled out yet.
In plain terms
- DepDelta is still reading the release notes in this range, so it can't rule out breaking changes yet.
- This page updates as the notes come in.
Must act Still reading release notes
DepDelta is still reading the release notes in this range. This updates as they come in.
API changes
Generated by DepDelta from published Python source. Not mixed with prose notes.
- added:
export VERSION
- changed:
async function watch_reload(path, worker_settings, loop) → async function watch_reload(path: str, worker_settings: WorkerSettingsType) -> None - changed:
function cli(*, worker_settings, burst, check, watch, verbose) → function cli(*, worker_settings: str, burst: bool, check: bool, watch: str, verbose: bool) -> None
- changed:
async function create_pool(settings: RedisSettings=…, *, retry: int=…, job_serializer: Optional[Serializer]=…, job_deserializer: Optional[Deserializer]=…) -> ArqRedis → async function create_pool(settings_: RedisSettings=…, *, retry: int=…, job_serializer: Optional[Serializer]=…, job_deserializer: Optional[Deserializer]=…, default_queue_name: str=…) -> ArqRedis - changed:
async function log_redis_info(redis, log_func) → async function log_redis_info(redis: Redis, log_func: Callable[[str], Any]) -> None - changed:
async method ArqRedis.enqueue_job(function: str, *args: Any, _job_id: Optional[str]=…, _queue_name: str=…, _defer_until: Optional[datetime]=…, _defer_by: Union[None, int, float, timedelta]=…, _expires: Union[None, int, float, timedelta]=…, _job_try: Optional[int]=…, **kwargs: Any) -> Optional[Job] → async method ArqRedis.enqueue_job(function: str, *args: Any, _job_id: Optional[str]=…, _queue_name: Optional[str]=…, _defer_until: Optional[datetime]=…, _defer_by: Union[None, int, float, timedelta]=…, _expires: Union[None, int, float, timedelta]=…, _job_try: Optional[int]=…, **kwargs: Any) -> Optional[Job] - changed:
constructor ArqRedis(pool_or_conn, job_serializer: Optional[Serializer]=…, job_deserializer: Optional[Deserializer]=…, **kwargs) -> None → constructor ArqRedis(pool_or_conn: Any, job_serializer: Optional[Serializer]=…, job_deserializer: Optional[Deserializer]=…, default_queue_name: str=…, **kwargs: Any) -> None - changed:
field RedisSettings.password: str → field RedisSettings.password: Optional[str] - changed:
field RedisSettings.ssl: [bool, None, SSLContext] → field RedisSettings.ssl: Union[bool, None, SSLContext] - added:
class SSLContext(ssl.SSLContext) - added:
static method RedisSettings.from_dsn(dsn: str) -> RedisSettings
- removed:
class D(str, Enum) - removed:
field D.day - removed:
field D.hour - removed:
field D.microsecond - removed:
field D.minute - removed:
field D.month - removed:
field D.second - removed:
field D.weekday - removed:
variable dt_fields - removed:
variable weekdays - changed:
field CronJob.coroutine: Callable → field CronJob.coroutine: WorkerCoroutine - changed:
field CronJob.day: Union[None, set, int] → field CronJob.day: OptionType - changed:
field CronJob.hour: Union[None, set, int] → field CronJob.hour: OptionType - changed:
field CronJob.minute: Union[None, set, int] → field CronJob.minute: OptionType - changed:
field CronJob.month: Union[None, set, int] → field CronJob.month: OptionType - changed:
field CronJob.next_run: datetime → field CronJob.next_run: Optional[datetime] - changed:
field CronJob.second: Union[None, set, int] → field CronJob.second: OptionType - changed:
field CronJob.weekday: Union[None, set, int, str] → field CronJob.weekday: WeekdayOptionType - changed:
function cron(coroutine: Union[str, Callable], *, name: Optional[str]=…, month: Union[None, set, int]=…, day: Union[None, set, int]=…, weekday: Union[None, set, int, str]=…, hour: Union[None, set, int]=…, minute: Union[None, set, int]=…, second: Union[None, set, int]=…, microsecond: int=…, run_at_startup: bool=…, unique: bool=…, timeout: Optional[SecondsTimedelta]=…, keep_result: Optional[float]=… → function cron(coroutine: Union[str, WorkerCoroutine], *, name: Optional[str]=…, month: OptionType=…, day: OptionType=…, weekday: WeekdayOptionType=…, hour: OptionType=…, minute: OptionType=…, second: OptionType=…, microsecond: int=…, run_at_startup: bool=…, unique: bool=…, timeout: Optional[SecondsTimedelta]=…, keep_result: Optional[float]=…, max_tries: Optional[int]=…) -> CronJob - changed:
function next_cron(previous_dt: datetime, *, month: Union[None, set, int]=…, day: Union[None, set, int]=…, weekday: Union[None, set, int, str]=…, hour: Union[None, set, int]=…, minute: Union[None, set, int]=…, second: Union[None, set, int]=…, microsecond: int=…) → function next_cron(previous_dt: datetime, *, month: OptionType=…, day: OptionType=…, weekday: WeekdayOptionType=…, hour: OptionType=…, minute: OptionType=…, second: OptionType=…, microsecond: int=…) -> datetime - changed:
method CronJob.set_next(dt: datetime) → method CronJob.set_next(dt: datetime) -> None - added:
class Options - added:
field Options.day: OptionType - added:
field Options.hour: OptionType - added:
field Options.microsecond: int - added:
field Options.minute: OptionType - added:
field Options.month: OptionType - added:
field Options.second: OptionType - added:
field Options.weekday: WeekdayOptionType
- changed:
constructor Job(job_id: str, redis, _queue_name: str=…, _deserializer: Optional[Deserializer]=…) → constructor Job(job_id: str, redis: Redis, _queue_name: str=…, _deserializer: Optional[Deserializer]=…) - changed:
field JobDef.args: tuple → field JobDef.args: Tuple[Any, ...] - changed:
field JobDef.kwargs: dict → field JobDef.kwargs: Dict[str, Any] - changed:
function deserialize_job_raw(r: bytes, *, deserializer: Optional[Deserializer]=…) -> tuple → function deserialize_job_raw(r: bytes, *, deserializer: Optional[Deserializer]=…) -> Tuple[str, Tuple[Any, ...], Dict[str, Any], int, int] - changed:
function serialize_job(function_name: str, args: tuple, kwargs: dict, job_try: int, enqueue_time_ms: int, *, serializer: Optional[Serializer]=…) -> Optional[bytes] → function serialize_job(function_name: str, args: Tuple[Any, ...], kwargs: Dict[str, Any], job_try: Optional[int], enqueue_time_ms: int, *, serializer: Optional[Serializer]=…) -> Optional[bytes] - changed:
function serialize_result(function: str, args: tuple, kwargs: dict, job_try: int, enqueue_time_ms: int, success: bool, result: Any, start_ms: int, finished_ms: int, ref: str, *, serializer: Optional[Serializer]=…) -> Optional[bytes] → function serialize_result(function: str, args: Tuple[Any, ...], kwargs: Dict[str, Any], job_try: int, enqueue_time_ms: int, success: bool, result: Any, start_ms: int, finished_ms: int, ref: str, *, serializer: Optional[Serializer]=…) -> Optional[bytes]
- changed:
function default_log_config(verbose: bool) -> dict → function default_log_config(verbose: bool) -> Dict[str, Any]
- added:
class StartupShutdown(Protocol) - added:
class WorkerCoroutine(Protocol) - added:
variable OptionType - added:
variable SecondsTimedelta - added:
variable WEEKDAYS - added:
variable WeekdayOptionType - added:
variable WorkerSettingsType
- removed:
variable SecondsTimedelta - removed:
variable epoch - removed:
variable epoch_tz - changed:
async function poll(step: float=…) → async function poll(step: float=…) -> AsyncGenerator[float, None] - changed:
function args_to_string(args, kwargs) → function args_to_string(args: Sequence[Any], kwargs: Dict[str, Any]) -> str - changed:
function to_ms(td: Optional[SecondsTimedelta]) -> Optional[int] → function to_ms(td: None) -> None | (td: SecondsTimedelta) -> int - changed:
function to_seconds(td: Optional[SecondsTimedelta]) -> Optional[float] → function to_seconds(td: None) -> None | (td: SecondsTimedelta) -> float
- removed:
async method Worker.run_jobs(job_ids) - changed:
async function async_check_health(redis_settings: Optional[RedisSettings], health_check_key: Optional[str]=…, queue_name: Optional[str]=…) → async function async_check_health(redis_settings: Optional[RedisSettings], health_check_key: Optional[str]=…, queue_name: Optional[str]=…) -> int - changed:
async method Worker.abort_job(job_id: str, result_data: Optional[bytes]) → async method Worker.abort_job(job_id: str, result_data: Optional[bytes]) -> None - changed:
async method Worker.close() → async method Worker.close() -> None - changed:
async method Worker.finish_job(job_id: str, finish: bool, result_data: bytes, result_timeout_s: Optional[int], incr_score: int) → async method Worker.finish_job(job_id: str, finish: bool, result_data: Optional[bytes], result_timeout_s: Optional[float], incr_score: Optional[int]) -> None - changed:
async method Worker.heart_beat() → async method Worker.heart_beat() -> None - changed:
async method Worker.main() → async method Worker.main() -> None - changed:
async method Worker.record_health() → async method Worker.record_health() -> None - changed:
async method Worker.run_cron() → async method Worker.run_cron() -> None - changed:
async method Worker.run_job(job_id, score) → async method Worker.run_job(job_id: str, score: int) -> None - changed:
constructor FailedJobs(count, job_results) → constructor FailedJobs(count: int, job_results: List[JobResult]) - changed:
constructor Worker(functions: Sequence[Function]=…, *, queue_name: str=…, cron_jobs: Optional[Sequence[CronJob]]=…, redis_settings: RedisSettings=…, redis_pool: ArqRedis=…, burst: bool=…, on_startup: Callable[[Dict], Awaitable]=…, on_shutdown: Callable[[Dict], Awaitable]=…, max_jobs: int=…, job_timeout: SecondsTimedelta=…, keep_result: SecondsTimedelta=…, poll_delay: SecondsTimedelta=…, queue_rea… → constructor Worker(functions: Sequence[Union[Function, WorkerCoroutine]]=…, *, queue_name: Optional[str]=…, cron_jobs: Optional[Sequence[CronJob]]=…, redis_settings: RedisSettings=…, redis_pool: ArqRedis=…, burst: bool=…, on_startup: Optional[StartupShutdown]=…, on_shutdown: Optional[StartupShutdown]=…, handle_signals: bool=…, max_jobs: int=…, job_timeout: SecondsTimedelta=…, keep_result: Seconds… - changed:
field Function.coroutine: Callable → field Function.coroutine: WorkerCoroutine - changed:
function check_health(settings_cls) -> int → function check_health(settings_cls: WorkerSettingsType) -> int - changed:
function create_worker(settings_cls, **kwargs) -> Worker → function create_worker(settings_cls: WorkerSettingsType, **kwargs: Any) -> Worker - changed:
function func(coroutine: Union[str, Function, Callable], *, name: Optional[str]=…, keep_result: Optional[SecondsTimedelta]=…, timeout: Optional[SecondsTimedelta]=…, max_tries: Optional[int]=…) -> Function → function func(coroutine: Union[str, Function, WorkerCoroutine], *, name: Optional[str]=…, keep_result: Optional[SecondsTimedelta]=…, timeout: Optional[SecondsTimedelta]=…, max_tries: Optional[int]=…) -> Function - changed:
function get_kwargs(settings_cls) → function get_kwargs(settings_cls: WorkerSettingsType) -> Dict[str, NameError] - changed:
function run_worker(settings_cls, **kwargs) -> Worker → function run_worker(settings_cls: WorkerSettingsType, **kwargs: Any) -> Worker - changed:
method Worker.handle_sig(signum) → method Worker.handle_sig(signum: Signals) -> None - added:
async method Worker.start_jobs(job_ids: List[str]) -> None - added:
class RetryJob(RuntimeError) - added:
property Worker.pool -> ArqRedis