Merge pull request procrastinate-org#326 from peopledoc/ele_remove-old-jobs

Joachim Jablon · web-flow · commit ad02649c5cca · 2020-10-05T18:03:53.000+02:00
diff --git a/docs/howto/django.rst b/docs/howto/django.rst
@@ -34,7 +34,7 @@ Configure your procrastinate app from your Django settings::
         connector=procrastinate.Psycopg2Connector(**connector_params())
     )
 
-(See `connector` for more on how to instanciate your connector.)
+(See `connector` for more on how to instantiate your connector.)
 
 Procrastinate comes with its own migrations so don't forget to run ``./manage.py
 migrate``.
diff --git a/docs/howto/remove_old_jobs.rst b/docs/howto/remove_old_jobs.rst
@@ -45,3 +45,22 @@ For example, to use a queueing lock:
 
 The call to ``defer`` will raise an `AlreadyEnqueued` exception if there already is
 a "remove_old_jobs" job waiting in the queue, which you may want to catch and ignore.
+
+As mentioned in the previous section you may want to run ``remove_old_jobs``
+periodically. For that you may use a Unix cron, or rely on Procrastinate's "periodic
+tasks" functionality. This is how you can make ``remove_old_jobs`` periodic:
+
+.. code-block:: python
+
+    @app.periodic(cron="0 4 * * *")
+    @app.task(queueing_lock="remove_old_jobs", pass_context=True)
+    async def remove_old_jobs(context, timestamp):
+        return await app.builtin_tasks["remove_old_jobs"](
+            context=context,
+            max_hours=72,
+            remove_error=True,
+        )
+
+With this you define your own ``remove_old_jobs`` task, which relies on Procrastinate's
+builtin ``remove_old_jobs`` task function. The task is periodic, and configured to be
+deferred every day at 4 am.
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
@@ -3,6 +3,7 @@ app
 async
 asynchronicity
 attrs
+autogenerated
 backend
 backoff
 builtin
@@ -24,6 +25,8 @@ GitHub
 Godwin
 healthcheck
 healthchecks
+linter
+linters
 linting
 localhost
 middleware
diff --git a/procrastinate/contrib/django/utils.py b/procrastinate/contrib/django/utils.py
@@ -50,7 +50,7 @@ def connector_params(alias: str = "default") -> Dict[str, Any]:
     Returns
     -------
     ``Dict[str, Any]``
-        Provide these keyword arguments when instanciating your connector
+        Provide these keyword arguments when instantiating your connector
     """
     wrapper = connections[alias]
     return wrapper.get_connection_params()

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ Configure your procrastinate app from your Django settings::`
`34`	`34`	`connector=procrastinate.Psycopg2Connector(**connector_params())`
`35`	`35`	`)`
`36`	`36`
`37`		-(See `connector` for more on how to instanciate your connector.)
	`37`	+(See `connector` for more on how to instantiate your connector.)
`38`	`38`
`39`	`39`	Procrastinate comes with its own migrations so don't forget to run ``./manage.py
`40`	`40`	migrate``.