From 316c4312f65ed83140f771bc225a84f53ccb1372 Mon Sep 17 00:00:00 2001 From: Charles Leifer Date: Thu, 20 Feb 2025 19:50:09 -0600 Subject: [PATCH] Docs for unquote password & user in db_url. [skip ci] --- docs/peewee/playhouse.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/peewee/playhouse.rst b/docs/peewee/playhouse.rst index e8c7f2ca8..ce1b33d12 100644 --- a/docs/peewee/playhouse.rst +++ b/docs/peewee/playhouse.rst @@ -3467,7 +3467,12 @@ Database URL This module contains a helper function to generate a database connection from a URL connection string. -.. py:function:: connect(url, **connect_params) +.. py:function:: connect(url, [unquote_password=False[, unquote_user=False[, **connect_params]]]) + + :param url: the URL for the database, see examples below. + :param bool unquote_password: unquote special characters in the password. + :param bool unquote_user: unquote special characters in the user. + :param connect_params: additional parameters to pass to the Database. Create a :py:class:`Database` instance from the given connection URL. @@ -3508,7 +3513,11 @@ URL connection string. # back to a local Sqlite database if no database URL is specified. db = connect(os.environ.get('DATABASE') or 'sqlite:///default.db') -.. py:function:: parse(url) +.. py:function:: parse(url, [unquote_password=False[, unquote_user=False]]) + + :param url: the URL for the database, see :py:func:`connect` above for examples. + :param bool unquote_password: unquote special characters in the password. + :param bool unquote_user: unquote special characters in the user. Parse the information in the given URL into a dictionary containing ``database``, ``host``, ``port``, ``user`` and/or ``password``. Additional