Implement connection service file functionality (#1223)

AndrewJackson2020 · web-flow · commit 1d63bb1597f5 · 2025-10-10T22:14:14.000-07:00
diff --git a/asyncpg/connect_utils.py b/asyncpg/connect_utils.py
@@ -7,6 +7,7 @@
 from __future__ import annotations
 
 import asyncio
+import configparser
 import collections
 from collections.abc import Callable
 import enum
@@ -87,6 +88,9 @@ class SSLNegotiation(compat.StrEnum):
 PGPASSFILE = '.pgpass'
 
 
+PG_SERVICEFILE = '.pg_service.conf'
+
+
 def _read_password_file(passfile: pathlib.Path) \
 -> typing.List[typing.Tuple[str, ...]]:
 
@@ -271,6 +275,7 @@ def _dot_postgresql_path(filename) -> typing.Optional[pathlib.Path]:
 
 def _parse_connect_dsn_and_args(*, dsn, host, port, user,
 password, passfile, database, ssl,
+ service, servicefile,
 direct_tls, server_settings,
 target_session_attrs, krbsrvname, gsslib):
 # `auth_hosts` is the version of host information for the purposes
@@ -283,6 +288,32 @@ def _parse_connect_dsn_and_args(*, dsn, host, port, user,
 if dsn:
 parsed = urllib.parse.urlparse(dsn)
 
+ query = None
+ if parsed.query:
+ query = urllib.parse.parse_qs(parsed.query, strict_parsing=True)
+ for key, val in query.items():
+ if isinstance(val, list):
+ query[key] = val[-1]
+
+ if 'service' in query:
+ val = query.pop('service')
+ if not service and val:
+ service = val
+
+ connection_service_file = servicefile
+
+ if connection_service_file is None:
+ connection_service_file = os.getenv('PGSERVICEFILE')
+
+ if connection_service_file is None:
+ homedir = compat.get_pg_home_directory()
+ if homedir:
+ connection_service_file = homedir / PG_SERVICEFILE
+ else:
+ connection_service_file = None
+ else:
+ connection_service_file = pathlib.Path(connection_service_file)
+
 if parsed.scheme not in{'postgresql', 'postgres'}:
 raise exceptions.ClientConfigurationError(
 'invalid DSN: scheme is expected to be either '
@@ -317,11 +348,7 @@ def _parse_connect_dsn_and_args(*, dsn, host, port, user,
 if password is None and dsn_password:
 password = urllib.parse.unquote(dsn_password)
 
- if parsed.query:
- query = urllib.parse.parse_qs(parsed.query, strict_parsing=True)
- for key, val in query.items():
- if isinstance(val, list):
- query[key] = val[-1]
+ if query:
 
 if 'port' in query:
 val = query.pop('port')
@@ -408,12 +435,124 @@ def _parse_connect_dsn_and_args(*, dsn, host, port, user,
 if gsslib is None:
 gsslib = val
 
+ if 'service' in query:
+ val = query.pop('service')
+ if service is None:
+ service = val
+
 if query:
 if server_settings is None:
 server_settings = query
 else:
 server_settings ={**query, **server_settings}
 
+ if connection_service_file is not None and service is not None:
+ pg_service = configparser.ConfigParser()
+ pg_service.read(connection_service_file)
+ if service in pg_service.sections():
+ service_params = pg_service[service]
+ if 'port' in service_params:
+ val = service_params.pop('port')
+ if not port and val:
+ port = [int(p) for p in val.split(',')]
+
+ if 'host' in service_params:
+ val = service_params.pop('host')
+ if not host and val:
+ host, port = _parse_hostlist(val, port)
+
+ if 'dbname' in service_params:
+ val = service_params.pop('dbname')
+ if database is None:
+ database = val
+
+ if 'database' in service_params:
+ val = service_params.pop('database')
+ if database is None:
+ database = val
+
+ if 'user' in service_params:
+ val = service_params.pop('user')
+ if user is None:
+ user = val
+
+ if 'password' in service_params:
+ val = service_params.pop('password')
+ if password is None:
+ password = val
+
+ if 'passfile' in service_params:
+ val = service_params.pop('passfile')
+ if passfile is None:
+ passfile = val
+
+ if 'sslmode' in service_params:
+ val = service_params.pop('sslmode')
+ if ssl is None:
+ ssl = val
+
+ if 'sslcert' in service_params:
+ val = service_params.pop('sslcert')
+ if sslcert is None:
+ sslcert = val
+
+ if 'sslkey' in service_params:
+ val = service_params.pop('sslkey')
+ if sslkey is None:
+ sslkey = val
+
+ if 'sslrootcert' in service_params:
+ val = service_params.pop('sslrootcert')
+ if sslrootcert is None:
+ sslrootcert = val
+
+ if 'sslnegotiation' in service_params:
+ val = service_params.pop('sslnegotiation')
+ if sslnegotiation is None:
+ sslnegotiation = val
+
+ if 'sslcrl' in service_params:
+ val = service_params.pop('sslcrl')
+ if sslcrl is None:
+ sslcrl = val
+
+ if 'sslpassword' in service_params:
+ val = service_params.pop('sslpassword')
+ if sslpassword is None:
+ sslpassword = val
+
+ if 'ssl_min_protocol_version' in service_params:
+ val = service_params.pop(
+ 'ssl_min_protocol_version'
+ )
+ if ssl_min_protocol_version is None:
+ ssl_min_protocol_version = val
+
+ if 'ssl_max_protocol_version' in service_params:
+ val = service_params.pop(
+ 'ssl_max_protocol_version'
+ )
+ if ssl_max_protocol_version is None:
+ ssl_max_protocol_version = val
+
+ if 'target_session_attrs' in service_params:
+ dsn_target_session_attrs = service_params.pop(
+ 'target_session_attrs'
+ )
+ if target_session_attrs is None:
+ target_session_attrs = dsn_target_session_attrs
+
+ if 'krbsrvname' in service_params:
+ val = service_params.pop('krbsrvname')
+ if krbsrvname is None:
+ krbsrvname = val
+
+ if 'gsslib' in service_params:
+ val = service_params.pop('gsslib')
+ if gsslib is None:
+ gsslib = val
+ if not service:
+ service = os.environ.get('PGSERVICE')
 if not host:
 hostspec = os.environ.get('PGHOST')
 if hostspec:
@@ -726,7 +865,8 @@ def _parse_connect_arguments(*, dsn, host, port, user, password, passfile,
 max_cached_statement_lifetime,
 max_cacheable_statement_size,
 ssl, direct_tls, server_settings,
- target_session_attrs, krbsrvname, gsslib):
+ target_session_attrs, krbsrvname, gsslib,
+ service, servicefile):
 local_vars = locals()
 for var_name in{'max_cacheable_statement_size',
 'max_cached_statement_lifetime',
@@ -756,7 +896,8 @@ def _parse_connect_arguments(*, dsn, host, port, user, password, passfile,
 direct_tls=direct_tls, database=database,
 server_settings=server_settings,
 target_session_attrs=target_session_attrs,
- krbsrvname=krbsrvname, gsslib=gsslib)
+ krbsrvname=krbsrvname, gsslib=gsslib,
+ service=service, servicefile=servicefile)
 
 config = _ClientConfiguration(
 command_timeout=command_timeout,
diff --git a/asyncpg/connection.py b/asyncpg/connection.py
@@ -2083,6 +2083,8 @@ async def _do_execute(
 async def connect(dsn=None, *,
 host=None, port=None,
 user=None, password=None, passfile=None,
+ service=None,
+ servicefile=None,
 database=None,
 loop=None,
 timeout=60,
@@ -2192,6 +2194,14 @@ async def connect(dsn=None, *,
 (defaults to ``~/.pgpass``, or ``%APPDATA%\postgresql\pgpass.conf``
 on Windows).
 
+ :param service:
+ The name of the postgres connection service stored in the postgres
+ connection service file.
+
+ :param servicefile:
+ The location of the connnection service file used to store
+ connection parameters.
+
 :param loop:
 An asyncio event loop instance. If ``None``, the default
 event loop will be used.
@@ -2404,6 +2414,9 @@ async def connect(dsn=None, *,
 .. versionchanged:: 0.30.0
 Added the *krbsrvname* and *gsslib* parameters.
 
+ .. versionchanged:: 0.31.0
+ Added the *servicefile* and *service* parameters.
+
 .. _SSLContext: https://docs.python.org/3/library/ssl.html#ssl.SSLContext
 .. _create_default_context:
 https://docs.python.org/3/library/ssl.html#ssl.create_default_context
@@ -2437,6 +2450,8 @@ async def connect(dsn=None, *,
 user=user,
 password=password,
 passfile=passfile,
+ service=service,
+ servicefile=servicefile,
 ssl=ssl,
 direct_tls=direct_tls,
 database=database,
diff --git a/tests/test_connect.py b/tests/test_connect.py

-Original file line number
+Diff line change
 from __future__ importannotations
 importasyncio
 +importconfigparser
 importcollections
 fromcollections.abcimportCallable
 importenum
 PGPASSFILE='.pgpass'
 +PG_SERVICEFILE='.pg_service.conf'
++
++
 def_read_password_file(passfile: pathlib.Path) \
 ->typing.List[typing.Tuple[str, ...]]:
 def_parse_connect_dsn_and_args(*, dsn, host, port, user,
 password, passfile, database, ssl,
 +service, servicefile,
 direct_tls, server_settings,
 target_session_attrs, krbsrvname, gsslib):
 # `auth_hosts` is the version of host information for the purposes
 ifdsn:
 parsed=urllib.parse.urlparse(dsn)
 +query=None
 +ifparsed.query:
 +query=urllib.parse.parse_qs(parsed.query, strict_parsing=True)
 +forkey, valinquery.items():
 +ifisinstance(val, list):
 +query[key] =val[-1]
++
 +if'service'inquery:
 +val=query.pop('service')
 +ifnotserviceandval:
 +service=val
++
 +connection_service_file=servicefile
++
 +ifconnection_service_fileisNone:
 +connection_service_file=os.getenv('PGSERVICEFILE')
++
 +ifconnection_service_fileisNone:
 +homedir=compat.get_pg_home_directory()
 +ifhomedir:
 +connection_service_file=homedir/PG_SERVICEFILE
 +else:
 +connection_service_file=None
 +else:
 +connection_service_file=pathlib.Path(connection_service_file)
++
 ifparsed.schemenotin{'postgresql', 'postgres'}:
 raiseexceptions.ClientConfigurationError(
 'invalid DSN: scheme is expected to be either '
 ifpasswordisNoneanddsn_password:
 password=urllib.parse.unquote(dsn_password)
 -ifparsed.query:
 -query=urllib.parse.parse_qs(parsed.query, strict_parsing=True)
 -forkey, valinquery.items():
 -ifisinstance(val, list):
 -query[key] =val[-1]
 +ifquery:
 if'port'inquery:
 val=query.pop('port')
 ifgsslibisNone:
 gsslib=val
 +if'service'inquery:
 +val=query.pop('service')
 +ifserviceisNone:
 +service=val
++
 ifquery:
 ifserver_settingsisNone:
 server_settings=query
 else:
 server_settings={**query, **server_settings}
 +ifconnection_service_fileisnotNoneandserviceisnotNone:
 +pg_service=configparser.ConfigParser()
 +pg_service.read(connection_service_file)
 +ifserviceinpg_service.sections():
 +service_params=pg_service[service]
 +if'port'inservice_params:
 +val=service_params.pop('port')
 +ifnotportandval:
 +port= [int(p) forpinval.split(',')]
++
 +if'host'inservice_params:
 +val=service_params.pop('host')
 +ifnothostandval:
 +host, port=_parse_hostlist(val, port)
++
 +if'dbname'inservice_params:
 +val=service_params.pop('dbname')
 +ifdatabaseisNone:
 +database=val
++
 +if'database'inservice_params:
 +val=service_params.pop('database')
 +ifdatabaseisNone:
 +database=val
++
 +if'user'inservice_params:
 +val=service_params.pop('user')
 +ifuserisNone:
 +user=val
++
 +if'password'inservice_params:
 +val=service_params.pop('password')
 +ifpasswordisNone:
 +password=val
++
 +if'passfile'inservice_params:
 +val=service_params.pop('passfile')
 +ifpassfileisNone:
 +passfile=val
++
 +if'sslmode'inservice_params:
 +val=service_params.pop('sslmode')
 +ifsslisNone:
 +ssl=val
++
 +if'sslcert'inservice_params:
 +val=service_params.pop('sslcert')
 +ifsslcertisNone:
 +sslcert=val
++
 +if'sslkey'inservice_params:
 +val=service_params.pop('sslkey')
 +ifsslkeyisNone:
 +sslkey=val
++
 +if'sslrootcert'inservice_params:
 +val=service_params.pop('sslrootcert')
 +ifsslrootcertisNone:
 +sslrootcert=val
++
 +if'sslnegotiation'inservice_params:
 +val=service_params.pop('sslnegotiation')
 +ifsslnegotiationisNone:
 +sslnegotiation=val
++
 +if'sslcrl'inservice_params:
 +val=service_params.pop('sslcrl')
 +ifsslcrlisNone:
 +sslcrl=val
++
 +if'sslpassword'inservice_params:
 +val=service_params.pop('sslpassword')
 +ifsslpasswordisNone:
 +sslpassword=val
++
 +if'ssl_min_protocol_version'inservice_params:
 +val=service_params.pop(
 +'ssl_min_protocol_version'
 + )
 +ifssl_min_protocol_versionisNone:
 +ssl_min_protocol_version=val
++
 +if'ssl_max_protocol_version'inservice_params:
 +val=service_params.pop(
 +'ssl_max_protocol_version'
 + )
 +ifssl_max_protocol_versionisNone:
 +ssl_max_protocol_version=val
++
 +if'target_session_attrs'inservice_params:
 +dsn_target_session_attrs=service_params.pop(
 +'target_session_attrs'
 + )
 +iftarget_session_attrsisNone:
 +target_session_attrs=dsn_target_session_attrs
++
 +if'krbsrvname'inservice_params:
 +val=service_params.pop('krbsrvname')
 +ifkrbsrvnameisNone:
 +krbsrvname=val
++
 +if'gsslib'inservice_params:
 +val=service_params.pop('gsslib')
 +ifgsslibisNone:
 +gsslib=val
 +ifnotservice:
 +service=os.environ.get('PGSERVICE')
 ifnothost:
 hostspec=os.environ.get('PGHOST')
 ifhostspec:
 max_cached_statement_lifetime,
 max_cacheable_statement_size,
 ssl, direct_tls, server_settings,
 -target_session_attrs, krbsrvname, gsslib):
 +target_session_attrs, krbsrvname, gsslib,
 +service, servicefile):
 local_vars=locals()
 forvar_namein{'max_cacheable_statement_size',
 'max_cached_statement_lifetime',
 direct_tls=direct_tls, database=database,
 server_settings=server_settings,
 target_session_attrs=target_session_attrs,
 -krbsrvname=krbsrvname, gsslib=gsslib)
 +krbsrvname=krbsrvname, gsslib=gsslib,
 +service=service, servicefile=servicefile)
 config=_ClientConfiguration(
 command_timeout=command_timeout,