Prefer "close" method instead of old "disconnect"

Author: DraTeots

python/rcdb/app_context.py

@@ -28,7 +28,7 @@ def close(self):
         Python 3.13+ leaks a ``ResourceWarning: unclosed database``).
         """
         if self._db_instance is not None:
-            self._db_instance.disconnect()
+            self._db_instance.close()
             self._db_instance = None
 
     def require_connected_db(self) -> RCDBProvider:

python/rcdb/cli/db.py

@@ -24,7 +24,7 @@ def db_command(ctx):
             print("ERROR connection string is missing.")
             exit(1)
         provider.connect(connection_str, check_version=False)
-        ctx.call_on_close(provider.disconnect)
+        ctx.call_on_close(provider.close)
         query = select(SchemaVersion).order_by(SchemaVersion.version.desc())
         schema_version, = provider.session.execute(query).first()
         print("Schema version: {} - '{}'".format(schema_version.version, schema_version.comment))
@@ -89,7 +89,7 @@ def _print_sqlite_table_sizes(engine):
 @pass_rcdb_context
 def update(context):
     provider = RCDBProvider(context.connection_str, check_version=False)
-    click.get_current_context().call_on_close(provider.disconnect)
+    click.get_current_context().call_on_close(provider.close)
 
     # Check something exists
     if not sqlalchemy.inspect(provider.engine).has_table(SchemaVersion.__tablename__):
@@ -119,7 +119,7 @@ def update(context):
         return
 
     provider = RCDBProvider(context.connection_str, check_version=False)
-    click.get_current_context().call_on_close(provider.disconnect)
+    click.get_current_context().call_on_close(provider.close)
 
     # Create alias table
     Alias.__table__.create(provider.engine)
@@ -184,7 +184,7 @@ def init(context, drop_all, no_defaults, confirm, add_tests, add_cpp_tests):
     # That we will need for DB
     metadata = rcdb.model.Base.metadata
     provider = RCDBProvider(context.connection_str, check_version=False)
-    click.get_current_context().call_on_close(provider.disconnect)
+    click.get_current_context().call_on_close(provider.close)
 
     # Drop all if needed
     if drop_all:

python/rcdb/cli/rp.py

@@ -55,7 +55,7 @@ def add(context, name, description, run_min, run_max, start_date, end_date):
 
     provider = RCDBProvider()
     provider.connect(connection_str, check_version=False)
-    click.get_current_context().call_on_close(provider.disconnect)
+    click.get_current_context().call_on_close(provider.close)
     session = provider.session
 
     # Convert date strings to Date objects if provided
@@ -105,7 +105,7 @@ def rm(context, period_id, yes):
 
     provider = RCDBProvider()
     provider.connect(connection_str, check_version=False)
-    click.get_current_context().call_on_close(provider.disconnect)
+    click.get_current_context().call_on_close(provider.close)
     session = provider.session
 
     rp_item = session.query(RunPeriod).filter(RunPeriod.id == period_id).one_or_none()
@@ -144,7 +144,7 @@ def update(context, period_id, name, description, run_min, run_max, start_date,
 
     provider = RCDBProvider()
     provider.connect(connection_str, check_version=False)
-    click.get_current_context().call_on_close(provider.disconnect)
+    click.get_current_context().call_on_close(provider.close)
     session = provider.session
 
     rp_item = session.query(RunPeriod).filter(RunPeriod.id == period_id).one_or_none()

python/rcdb/provider.py

@@ -153,13 +153,13 @@ def connect(self, connection_string="mysql+pymysql://rcdb@127.0.0.1/rcdb", check
                                    "Update your RCDB installation to match the database."
                     raise rcdb.errors.SqlSchemaVersionError(message)
             except Exception:
-                self.disconnect()
+                self.close()
                 raise
 
     # ------------------------------------------------
     # Closes connection to data
     # ------------------------------------------------
-    def disconnect(self):
+    def close(self):
         """Closes connection to database.
 
         Closes the ORM session and disposes the SQLAlchemy engine so the
@@ -174,10 +174,10 @@ def disconnect(self):
         if self.engine is not None:
             self.engine.dispose()
 
-    # ``close`` is an alias for ``disconnect``: a lot of calling code (and other
-    # resource-holding objects) expects a ``close()`` method, while existing
-    # RCDB code and users rely on the historical ``disconnect()`` name. Keep both.
-    close = disconnect
+    # ``disconnect`` is the historical name for ``close``; kept as an alias so
+    # existing RCDB code and users keep working while new code standardizes on
+    # ``close()`` (the conventional name other resource-holding objects use).
+    disconnect = close
 
     # -------------------------------------------------
     # indicates ether the connection is open or not

python/rcdb/web/__init__.py

@@ -154,7 +154,7 @@ def _render_db_error(connection_string):
     broken = getattr(g, "tdb", None)
     if broken is not None:
         try:
-            broken.disconnect()
+            broken.close()
         except Exception:
             logger.debug("Ignoring error while disposing failed DB engine.",
                          exc_info=True)
@@ -183,7 +183,7 @@ def handle_db_error(error):
 def teardown_request(exception):
     tdb = getattr(g, 'tdb', None)
     if tdb is not None:
-        tdb.disconnect()
+        tdb.close()
 
 
 @app.errorhandler(404)