199 lines
6.6 KiB
Python
199 lines
6.6 KiB
Python
"""
|
|
Various functionalities to make easier to work with the libpq.
|
|
"""
|
|
|
|
# Copyright (C) 2020 The Psycopg Team
|
|
|
|
from __future__ import annotations
|
|
|
|
import os
|
|
import re
|
|
import sys
|
|
import logging
|
|
import ctypes.util
|
|
from typing import NamedTuple
|
|
from pathlib import Path
|
|
from functools import cache
|
|
|
|
from . import abc
|
|
from ._enums import ConnStatus, PipelineStatus, TransactionStatus
|
|
|
|
logger = logging.getLogger("psycopg.pq")
|
|
|
|
OK = ConnStatus.OK
|
|
|
|
|
|
class PGnotify(NamedTuple):
|
|
relname: bytes
|
|
be_pid: int
|
|
extra: bytes
|
|
|
|
|
|
class ConninfoOption(NamedTuple):
|
|
keyword: bytes
|
|
envvar: bytes | None
|
|
compiled: bytes | None
|
|
val: bytes | None
|
|
label: bytes
|
|
dispchar: bytes
|
|
dispsize: int
|
|
|
|
|
|
class PGresAttDesc(NamedTuple):
|
|
name: bytes
|
|
tableid: int
|
|
columnid: int
|
|
format: int
|
|
typid: int
|
|
typlen: int
|
|
atttypmod: int
|
|
|
|
|
|
@cache
|
|
def find_libpq_full_path() -> str | None:
|
|
if sys.platform == "win32":
|
|
if (libname := ctypes.util.find_library("libpq.dll")) is None:
|
|
return None
|
|
libname = str(Path(libname).resolve())
|
|
elif sys.platform == "darwin":
|
|
libname = ctypes.util.find_library("libpq.dylib")
|
|
# (hopefully) temporary hack: libpq not in a standard place
|
|
# https://github.com/orgs/Homebrew/discussions/3595
|
|
# If pg_config is available and agrees, let's use its indications.
|
|
if not libname:
|
|
try:
|
|
import subprocess as sp
|
|
|
|
libdir = sp.check_output(["pg_config", "--libdir"]).strip().decode()
|
|
if not os.path.exists(libname := os.path.join(libdir, "libpq.dylib")):
|
|
libname = None
|
|
except Exception as ex:
|
|
logger.debug("couldn't use pg_config to find libpq: %s", ex)
|
|
|
|
else:
|
|
libname = ctypes.util.find_library("pq")
|
|
|
|
return libname
|
|
|
|
|
|
def error_message(
|
|
obj: abc.PGconn | abc.PGresult | abc.PGcancelConn, encoding: str = ""
|
|
) -> str:
|
|
"""
|
|
Return an error message from a `PGconn`, `PGresult`, `PGcancelConn`.
|
|
|
|
The return value is a `!str` (unlike pq data which is usually `!bytes`):
|
|
use the connection encoding if available, otherwise the `!encoding`
|
|
parameter as a fallback for decoding. Don't raise exceptions on decoding
|
|
errors.
|
|
"""
|
|
# Note: this function is exposed by the pq module and was documented, therefore
|
|
# we are not going to remove it, but we don't use it internally.
|
|
|
|
# Don't pass the encoding if not specified, because different classes have
|
|
# different defaults (conn has its own encoding. others default to utf8).
|
|
return obj.get_error_message(encoding) if encoding else obj.get_error_message()
|
|
|
|
|
|
# Possible prefixes to strip for error messages, in the known localizations.
|
|
# This regular expression is generated from PostgreSQL sources using the
|
|
# `tools/update_error_prefixes.py` script
|
|
PREFIXES = re.compile(
|
|
# autogenerated: start
|
|
r"""
|
|
^ (?:
|
|
DEBUG | INFO | HINWEIS | WARNUNG | FEHLER | LOG | FATAL | PANIK # de
|
|
| DEBUG | INFO | NOTICE | WARNING | ERROR | LOG | FATAL | PANIC # en
|
|
| DEBUG | INFO | NOTICE | WARNING | ERROR | LOG | FATAL | PANIC # es
|
|
| DEBUG | INFO | NOTICE | ATTENTION | ERREUR | LOG | FATAL | PANIC # fr
|
|
| DEBUG | INFO | NOTICE | PERINGATAN | ERROR | LOG | FATAL | PANIK # id
|
|
| DEBUG | INFO | NOTIFICA | ATTENZIONE | ERRORE | LOG | FATALE | PANICO # it
|
|
| DEBUG | INFO | NOTICE | WARNING | ERROR | LOG | FATAL | PANIC # ja
|
|
| 디버그 | 정보 | 알림 | 경고 | 오류 | 로그 | 치명적오류 | 손상 # ko
|
|
| DEBUG | INFORMACJA | UWAGA | OSTRZEŻENIE | BŁĄD | DZIENNIK | KATASTROFALNY | PANIKA # pl
|
|
| DEPURAÇÃO | INFO | NOTA | AVISO | ERRO | LOG | FATAL | PÂNICO # pt_BR
|
|
| ОТЛАДКА | ИНФОРМАЦИЯ | ЗАМЕЧАНИЕ | ПРЕДУПРЕЖДЕНИЕ | ОШИБКА | СООБЩЕНИЕ | ВАЖНО | ПАНИКА # ru
|
|
| DEBUG | INFO | NOTIS | VARNING | FEL | LOGG | FATALT | PANIK # sv
|
|
| DEBUG | BİLGİ | NOT | UYARI | HATA | LOG | ÖLÜMCÜL\ \(FATAL\) | KRİTİK # tr
|
|
| НАЛАГОДЖЕННЯ | ІНФОРМАЦІЯ | ПОВІДОМЛЕННЯ | ПОПЕРЕДЖЕННЯ | ПОМИЛКА | ЗАПИСУВАННЯ | ФАТАЛЬНО | ПАНІКА # uk
|
|
| 调试 | 信息 | 注意 | 警告 | 错误 | 日志 | 致命错误 | 比致命错误还过分的错误 # zh_CN
|
|
) : \s+
|
|
""", # noqa: E501
|
|
# autogenerated: end
|
|
re.VERBOSE | re.MULTILINE,
|
|
)
|
|
|
|
|
|
def strip_severity(msg: str) -> str:
|
|
"""Strip severity and whitespaces from error message."""
|
|
if m := PREFIXES.match(msg):
|
|
msg = msg[m.span()[1] :]
|
|
|
|
return msg.strip()
|
|
|
|
|
|
def _clean_error_message(msg: bytes, encoding: str) -> str:
|
|
if smsg := msg.decode(encoding, "replace"):
|
|
return strip_severity(smsg)
|
|
else:
|
|
return "no error details available"
|
|
|
|
|
|
def connection_summary(pgconn: abc.PGconn) -> str:
|
|
"""
|
|
Return summary information on a connection.
|
|
|
|
Useful for __repr__
|
|
"""
|
|
parts = []
|
|
if pgconn.status == OK:
|
|
# Put together the [STATUS]
|
|
status: str = TransactionStatus(pgconn.transaction_status).name
|
|
if pgconn.pipeline_status:
|
|
status += f", pipeline={PipelineStatus(pgconn.pipeline_status).name}"
|
|
|
|
# Put together the (CONNECTION)
|
|
if not pgconn.host.startswith(b"/"):
|
|
parts.append(("host", pgconn.host.decode()))
|
|
if (port := pgconn.port.decode() or get_compiled_port()) != "5432":
|
|
parts.append(("port", port))
|
|
if pgconn.user != pgconn.db:
|
|
parts.append(("user", pgconn.user.decode()))
|
|
parts.append(("database", pgconn.db.decode()))
|
|
|
|
else:
|
|
try:
|
|
status = ConnStatus(pgconn.status).name
|
|
except ValueError:
|
|
# It might happen if a new status on connection appears
|
|
# before upgrading the ConnStatus enum.
|
|
status = f"status={pgconn.status} (unkndown)"
|
|
|
|
if sparts := " ".join("%s=%s" % part for part in parts):
|
|
sparts = f" ({sparts})"
|
|
return f"[{status}]{sparts}"
|
|
|
|
|
|
def version_pretty(version: int) -> str:
|
|
"""
|
|
Return a pretty representation of a PostgreSQL version
|
|
|
|
For instance: 140002 -> 14.2, 90610 -> 9.6.10
|
|
"""
|
|
version, patch = divmod(version, 100)
|
|
major, minor = divmod(version, 100)
|
|
if major >= 10 and minor == 0:
|
|
return f"{major}.{patch}"
|
|
else:
|
|
return f"{major}.{minor}.{patch}"
|
|
|
|
|
|
@cache
|
|
def get_compiled_port() -> str:
|
|
"""Return the default port compiled with the libpq."""
|
|
|
|
from psycopg._conninfo_utils import get_param_def
|
|
|
|
info = get_param_def("port")
|
|
return info.compiled if info and info.compiled else ""
|