Chancy API

Subpackages

• Executors
  • Executors
    • Capabilities
      • ProcessExecutor (Default)
      • AsyncExecutor
      • ThreadedExecutor
      • SubInterpreterExecutor
      • Custom Executors
  • Submodules
    • Executor
      • ConcurrentExecutor
      • Executor
    • ProcessExecutor
      • ProcessExecutor
    • AsyncExecutor
      • AsyncExecutor
    • ThreadedExecutor
      • ThreadedExecutor
    • SubInterpreterExecutor
      • SubInterpreterExecutor
• Plugins
  • Default Plugins
  • Optional Plugins
  • Submodules
    • API/Dashboard
      • Api
      • AuthBackend
      • SimpleAuthBackend
      • ApiPlugin
      • RouteT
      • CoreApiPlugin
    • Cron
      • Cron
      • CronApiPlugin
    • Leadership
      • ImmediateLeadership
      • Leadership
    • Metrics
      • Metrics
    • Pruner
      • Pruner
    • Recovery
      • Recovery
    • Reprioritization
      • Reprioritize
    • Retry
      • RetryPlugin
    • Sentry
      • SentryPlugin
    • Triggers
      • Trigger
      • TriggerConfig
    • Workflows
      • WorkflowPlugin
      • Workflow
      • WorkflowStep
      • Sequence
      • WorkflowApiPlugin

Submodules

• chancy.app module
  • Chancy
    • Chancy.Executor
      • Chancy.Executor.Async
      • Chancy.Executor.Process
      • Chancy.Executor.SubInterpreter
      • Chancy.Executor.Threaded
    • Chancy.cancel_job()
    • Chancy.cancel_job_ex()
    • Chancy.declare()
    • Chancy.declare_ex()
    • Chancy.delete_queue()
    • Chancy.delete_queue_ex()
    • Chancy.dsn
    • Chancy.get_all_queues()
    • Chancy.get_all_workers()
    • Chancy.get_job()
    • Chancy.get_jobs()
    • Chancy.get_queue()
    • Chancy.is_up_to_date()
    • Chancy.log
    • Chancy.max_connection_pool_size
    • Chancy.migrate()
    • Chancy.min_connection_pool_size
    • Chancy.notifications
    • Chancy.notify()
    • Chancy.pause_queue()
    • Chancy.pause_queue_ex()
    • Chancy.plugins
    • Chancy.poll_reconnect_timeout
    • Chancy.pool
    • Chancy.prefix
    • Chancy.purge_jobs()
    • Chancy.purge_jobs_ex()
    • Chancy.push()
    • Chancy.push_ex()
    • Chancy.push_many()
    • Chancy.push_many_ex()
    • Chancy.resume_queue()
    • Chancy.resume_queue_ex()
    • Chancy.retry_jobs()
    • Chancy.retry_jobs_ex()
    • Chancy.sync_declare()
    • Chancy.sync_declare_ex()
    • Chancy.sync_get_job()
    • Chancy.sync_notify()
    • Chancy.sync_pool
    • Chancy.sync_push()
    • Chancy.sync_push_many()
    • Chancy.sync_push_many_ex()
    • Chancy.wait_for_job()
    • Chancy.wait_for_jobs()
  • setup_default_logger()
• chancy.job module
  • ErrorT
    • ErrorT.attempt
    • ErrorT.traceback
  • IsAJob
    • IsAJob.job
  • Job
    • Job.from_func()
    • Job.func
    • Job.kwargs
    • Job.limits
    • Job.max_attempts
    • Job.meta
    • Job.pack()
    • Job.priority
    • Job.queue
    • Job.scheduled_at
    • Job.unique_key
    • Job.unpack()
    • Job.with_kwargs()
    • Job.with_limits()
    • Job.with_max_attempts()
    • Job.with_meta()
    • Job.with_priority()
    • Job.with_queue()
    • Job.with_scheduled_at()
    • Job.with_unique_key()
  • Limit
    • Limit.Type
      • Limit.Type.MEMORY
      • Limit.Type.TIME
    • Limit.deserialize()
    • Limit.serialize()
    • Limit.type_
    • Limit.value
  • QueuedJob
    • QueuedJob.State
      • QueuedJob.State.FAILED
      • QueuedJob.State.PENDING
      • QueuedJob.State.RETRYING
      • QueuedJob.State.RUNNING
      • QueuedJob.State.SUCCEEDED
    • QueuedJob.attempts
    • QueuedJob.completed_at
    • QueuedJob.created_at
    • QueuedJob.errors
    • QueuedJob.id
    • QueuedJob.started_at
    • QueuedJob.state
    • QueuedJob.unpack()
  • Reference
    • Reference.identifier
  • job()
• chancy.queue module
  • Queue
    • Queue.State
      • Queue.State.ACTIVE
      • Queue.State.PAUSED
    • Queue.concurrency
    • Queue.eager_polling
    • Queue.executor
    • Queue.executor_options
    • Queue.name
    • Queue.pack()
    • Queue.polling_interval
    • Queue.rate_limit
    • Queue.rate_limit_window
    • Queue.resume_at
    • Queue.state
    • Queue.tags
    • Queue.unpack()
• chancy.worker module
  • Worker
    • Worker.announce_worker()
    • Worker.chancy
    • Worker.executors
    • Worker.fetch_jobs()
    • Worker.heartbeat_poll_interval
    • Worker.heartbeat_timeout
    • Worker.hub
    • Worker.is_leader
    • Worker.manager
    • Worker.on_job_completed()
    • Worker.on_signal()
    • Worker.outgoing
    • Worker.queue_change_poll_interval
    • Worker.queue_update()
    • Worker.queue_wake_events
    • Worker.register_signal_handlers
    • Worker.send_outgoing_interval
    • Worker.shutdown_event
    • Worker.shutdown_timeout
    • Worker.start()
    • Worker.stop()
    • Worker.wait_for_shutdown()
    • Worker.worker_id
    • Worker.worker_tags()
• chancy.plugin module
  • Plugin
    • Plugin.api_plugin()
    • Plugin.cleanup()
    • Plugin.get_dependencies()
    • Plugin.get_identifier()
    • Plugin.get_scope()
    • Plugin.get_tables()
    • Plugin.migrate()
    • Plugin.migrate_key()
    • Plugin.migrate_package()
    • Plugin.migrator()
    • Plugin.on_job_completed()
    • Plugin.on_job_starting()
    • Plugin.on_job_updated()
    • Plugin.run()
    • Plugin.sleep()
    • Plugin.wait_for_leader()
    • Plugin.wake_up()
    • Plugin.wakeup_signal
  • PluginScope
    • PluginScope.WORKER
• chancy.migrate module
  • Migration
    • Migration.down()
    • Migration.up()
  • MigrationError
  • Migrator
    • Migrator.discover_all_migrations()
    • Migrator.get_current_version()
    • Migrator.is_migration_required()
    • Migrator.migrate()
    • Migrator.set_current_version()
    • Migrator.upsert_version_table()
• chancy.hub module
  • Event
    • Event.body
    • Event.name
  • Hub
    • Hub.clear()
    • Hub.emit()
    • Hub.on()
    • Hub.on_any()
    • Hub.remove()
    • Hub.remove_on_any()
    • Hub.wait_for()
• chancy.plugins.rule module
  • AndCondition
    • AndCondition.to_sql()
  • Condition
    • Condition.to_sql()
  • JobRules
    • JobRules.Age
      • JobRules.Age.to_sql()
    • JobRules.CreatedAt
    • JobRules.ID
    • JobRules.Job
    • JobRules.Queue
    • JobRules.ScheduledAt
    • JobRules.State
  • OrCondition
    • OrCondition.to_sql()
  • Rule
    • Rule.contains()
    • Rule.to_sql()
  • SQLAble
    • SQLAble.to_sql()
• chancy.utils module
  • DatabaseConnection
    • DatabaseConnection.ENGINE
    • DatabaseConnection.HOST
    • DatabaseConnection.NAME
    • DatabaseConnection.OPTIONS
    • DatabaseConnection.PASSWORD
    • DatabaseConnection.PORT
    • DatabaseConnection.USER
  • TaskManager
    • TaskManager.add()
    • TaskManager.cancel()
    • TaskManager.cancel_all()
    • TaskManager.wait_for_shutdown()
  • chancy_uuid()
  • chunked()
  • get_database_dsn()
  • import_string()
  • importable_name()
  • json_dumps()
  • sleep()
  • timed_block()
• chancy.errors module
  • MigrationsNeededError