Merge pull request #39 from uktrade/feat/better-user-facing-name

feat: rename termination_thread_timeout to cleanup_timeout

README.md

@@ -43,15 +43,17 @@ with \
 
 The API a single context manager `pg_force_execute`.
 
-`pg_force_execute`(conn, delay=datetime.timedelta(minutes=5), check_interval=datetime.timedelta(seconds=1), termination_thread_timeout=datetime.timedelta(seconds=10), logger=logging.getLogger("pg_force_execute"))
+`pg_force_execute`(conn, delay=datetime.timedelta(minutes=5), check_interval=datetime.timedelta(seconds=1), cleanup_timeout=datetime.timedelta(seconds=10), logger=logging.getLogger("pg_force_execute"))
 
 - `conn` - A [SQLAlchemy connection](https://docs.sqlalchemy.org/en/20/core/connections.html#sqlalchemy.engine.Connection) that will be unblocked
 
 - `delay` (optional) - How long to wait before attempting to terminate backends blocking `conn`
 
-- `check_interval` (optional) - The interval between repeated attempted to terminate backends blocking `conn`
+- `check_interval` (optional) - The interval between repeated attempts to terminate backends blocking `conn`
 
-- `termination_thread_timeout` (optional) - How long to wait for the termination to complete
+- `cleanup_timeout` (optional) - How long to wait for resources to be cleaned up before allowing exit of the context manager
+
+    For usual operation this parameter shouldn't need to be changed.
 
 - `logger` (optional) The Python logger instance through which to log
 

pg_force_execute.py

@@ -10,7 +10,7 @@
 def pg_force_execute(conn,
                      delay=datetime.timedelta(minutes=5),
                      check_interval=datetime.timedelta(seconds=1),
-                     termination_thread_timeout=datetime.timedelta(seconds=10),
+                     cleanup_timeout=datetime.timedelta(seconds=10),
                      logger=logging.getLogger("pg_force_execute"),
 ):
     cancel_exception = None
@@ -62,6 +62,6 @@ def force_unblock(pid, exit):
         yield
     finally:
         exit.set()
-        t.join(timeout=termination_thread_timeout.total_seconds())
+        t.join(timeout=cleanup_timeout.total_seconds())
         if cancel_exception is not None:
             raise cancel_exception