Support PGAPPNAME (#1444)

The application_name to be used when connecting to a database can now be specified as a command line argument (--application-name) or be taken directly from environment variables (PGAPPNAME). It still defaults to 'pgcli' when not specified. Closes #1421.
dbcli · Dec 9, 2023 · e2ff38d · e2ff38d
1 parent f2156b3
commit e2ff38d
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 1 deletion.
diff --git a/AUTHORS b/AUTHORS
@@ -131,6 +131,7 @@ Contributors:
     * Rob Berry (rob-b)
     * Sharon Yogev (sharonyogev)
     * Hollis Wu (holi0317)
+    * Antonio Aguilar (crazybolillo)
 
 Creator:
 --------

diff --git a/changelog.rst b/changelog.rst
@@ -1,6 +1,10 @@
 Upcoming
 ========
 
+Features:
+---------
+* Support `PGAPPNAME` as an environment variable and `--application-name` as a command line argument.
+
 Bug fixes:
 ----------
 

diff --git a/pgcli/main.py b/pgcli/main.py
@@ -165,6 +165,7 @@ def __init__(
         pgexecute=None,
         pgclirc_file=None,
         row_limit=None,
+        application_name="pgcli",
         single_connection=False,
         less_chatty=None,
         prompt=None,
@@ -210,6 +211,8 @@ def __init__(
         else:
             self.row_limit = c["main"].as_int("row_limit")
 
+        self.application_name = application_name
+
         # if not specified, set to DEFAULT_MAX_FIELD_WIDTH
         # if specified but empty, set to None to disable truncation
         # ellipsis will take at least 3 symbols, so this can't be less than 3 if specified and > 0
@@ -568,7 +571,7 @@ def connect(
         if not database:
             database = user
 
-        kwargs.setdefault("application_name", "pgcli")
+        kwargs.setdefault("application_name", self.application_name)
 
         # If password prompt is not forced but no password is provided, try
         # getting it from environment variable.
@@ -1337,6 +1340,12 @@ def echo_via_pager(self, text, color=None):
     type=click.INT,
     help="Set threshold for row limit prompt. Use 0 to disable prompt.",
 )
+@click.option(
+    "--application-name",
+    default="pgcli",
+    envvar="PGAPPNAME",
+    help="Application name for the connection.",
+)
 @click.option(
     "--less-chatty",
     "less_chatty",
@@ -1387,6 +1396,7 @@ def cli(
     pgclirc,
     dsn,
     row_limit,
+    application_name,
     less_chatty,
     prompt,
     prompt_dsn,
@@ -1445,6 +1455,7 @@ def cli(
         never_prompt,
         pgclirc_file=pgclirc,
         row_limit=row_limit,
+        application_name=application_name,
         single_connection=single_connection,
         less_chatty=less_chatty,
         prompt=prompt,

diff --git a/tests/test_application_name.py b/tests/test_application_name.py
@@ -0,0 +1,17 @@
+from unittest.mock import patch
+
+from click.testing import CliRunner
+
+from pgcli.main import cli
+from pgcli.pgexecute import PGExecute
+
+
+def test_application_name_in_env():
+    runner = CliRunner()
+    app_name = "wonderful_app"
+    with patch.object(PGExecute, "__init__") as mock_pgxecute:
+        runner.invoke(
+            cli, ["127.0.0.1:5432/hello", "user"], env={"PGAPPNAME": app_name}
+        )
+        kwargs = mock_pgxecute.call_args.kwargs
+        assert kwargs.get("application_name") == app_name