mirror of
https://github.com/tiennm99/DocsGPT.git
synced 2026-10-04 14:12:58 +00:00
Alex
574f96341e
The backend import package is now docsgpt, the name it will carry on PyPI; application was far too generic to install into anyone's site-packages. git mv plus a mechanical rewrite of every import, dotted string and path reference: 734 Python files, the compose files, Dockerfile, workflows, docs, setup scripts, devcontainer, k8s manifests, vscode config, pytest and coverage config, .gitignore. Behaviour is unchanged. Kept for one release: - A top-level application package whose meta-path finder resolves application.x.y to the already-imported docsgpt.x.y object, so old imports and entry points (celery -A application.app.celery, uvicorn application.asgi:asgi_app) keep working with a FutureWarning. - Celery registers every application.* task name as an alias of its docsgpt.* task on start-up, so messages queued by the previous release still run. The redbeat key prefix moves to redbeat:docsgpt:v2: so schedule entries the previous release wrote are left unread instead of firing twice. The backend image builds from the repository root (docker build -f docsgpt/Dockerfile .) so it can ship the alias package; a root .dockerignore allow-lists docsgpt/ and application/ and keeps caches, local data, .env files, the sample index files and the Dockerfile out. Compose and the image workflows point at the new context.
90 lines
3.4 KiB
Python
90 lines
3.4 KiB
Python
"""Normalize user-supplied Postgres URIs for different drivers.
|
|
|
|
DocsGPT has two Postgres connection strings pointing at potentially
|
|
different databases:
|
|
|
|
* ``POSTGRES_URI`` feeds SQLAlchemy, which needs the
|
|
``postgresql+psycopg://`` dialect prefix to pick the psycopg v3 driver.
|
|
* ``PGVECTOR_CONNECTION_STRING`` feeds ``psycopg.connect()`` directly
|
|
(via libpq) in ``docsgpt/vectorstore/pgvector.py``. libpq only
|
|
understands ``postgres://`` and ``postgresql://`` — the SQLAlchemy
|
|
dialect prefix is an invalid URI from its point of view.
|
|
|
|
The two fields therefore need opposite normalization so operators don't
|
|
have to know which driver a given field feeds. Each normalizer also
|
|
silently upgrades the legacy ``postgresql+psycopg2://`` prefix since
|
|
psycopg2 is no longer in the project.
|
|
|
|
This module is deliberately separate from ``docsgpt/core/settings.py``
|
|
so the Settings class stays focused on field declarations, and the
|
|
URI-rewriting logic can be unit-tested without triggering ``.env``
|
|
file loading from importing Settings.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
|
|
def _rewrite_uri_prefixes(v, rewrites):
|
|
"""Shared URI prefix rewriter used by both normalizers below.
|
|
|
|
Strips whitespace, returns ``None`` for empty / ``"none"`` values,
|
|
applies the first matching rewrite, and passes unrecognised input
|
|
through so downstream consumers (SQLAlchemy, libpq) can produce
|
|
their own error messages rather than us silently eating a
|
|
misconfiguration.
|
|
"""
|
|
if v is None:
|
|
return None
|
|
if not isinstance(v, str):
|
|
return v
|
|
v = v.strip()
|
|
if not v or v.lower() == "none":
|
|
return None
|
|
for prefix, target in rewrites:
|
|
if v.startswith(prefix):
|
|
return target + v[len(prefix):]
|
|
return v
|
|
|
|
|
|
# POSTGRES_URI feeds SQLAlchemy, which needs a ``postgresql+psycopg://``
|
|
# dialect prefix to select the psycopg v3 driver. Normalize the
|
|
# operator-friendly forms TOWARD that dialect.
|
|
_POSTGRES_URI_REWRITES = (
|
|
("postgresql+psycopg2://", "postgresql+psycopg://"),
|
|
("postgresql://", "postgresql+psycopg://"),
|
|
("postgres://", "postgresql+psycopg://"),
|
|
)
|
|
|
|
|
|
# PGVECTOR_CONNECTION_STRING feeds ``psycopg.connect()`` directly in
|
|
# docsgpt/vectorstore/pgvector.py — NOT SQLAlchemy. libpq only
|
|
# understands ``postgres://`` and ``postgresql://``; the SQLAlchemy
|
|
# dialect prefix is an invalid URI from libpq's point of view. Strip it
|
|
# if the operator accidentally copied their POSTGRES_URI value here.
|
|
_PGVECTOR_CONNECTION_STRING_REWRITES = (
|
|
("postgresql+psycopg2://", "postgresql://"),
|
|
("postgresql+psycopg://", "postgresql://"),
|
|
)
|
|
|
|
|
|
def normalize_postgres_uri(v):
|
|
"""Normalize a user-supplied POSTGRES_URI to the SQLAlchemy psycopg3 form.
|
|
|
|
Accepts the forms operators naturally write (``postgres://``,
|
|
``postgresql://``) and rewrites them to ``postgresql+psycopg://``.
|
|
Unknown schemes pass through unchanged so SQLAlchemy can produce its
|
|
own dialect-not-found error.
|
|
"""
|
|
return _rewrite_uri_prefixes(v, _POSTGRES_URI_REWRITES)
|
|
|
|
|
|
def normalize_pgvector_connection_string(v):
|
|
"""Normalize a user-supplied PGVECTOR_CONNECTION_STRING for libpq.
|
|
|
|
Strips the SQLAlchemy dialect prefix if the operator accidentally
|
|
copied their POSTGRES_URI value here — libpq can't parse it.
|
|
User-friendly forms (``postgres://``, ``postgresql://``) pass
|
|
through unchanged since libpq accepts them natively.
|
|
"""
|
|
return _rewrite_uri_prefixes(v, _PGVECTOR_CONNECTION_STRING_REWRITES)
|