]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Add note that password parameter is not to be url encoded
authorMike Bayer <mike_mp@zzzcomputing.com>
Tue, 9 Jan 2024 18:45:52 +0000 (13:45 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Tue, 9 Jan 2024 18:45:52 +0000 (13:45 -0500)
References: #10852
Change-Id: Ifa44513ce315214fa5d1b55d3e92b53889caeacc

lib/sqlalchemy/engine/url.py

index 31e94f441a235836903fe0b1ba579e10068767c3..db4f2879c7fc0218a890fc28c4e3d327a7722ae8 100644 (file)
@@ -171,6 +171,11 @@ class URL(NamedTuple):
         :param password: database password.  Is typically a string, but may
           also be an object that can be stringified with ``str()``.
 
+          .. note:: The password string should **not** be URL encoded when
+             passed as an argument to :meth:`_engine.URL.create`; the string
+             should contain the password characters exactly as they would be
+             typed.
+
           .. note::  A password-producing object will be stringified only
              **once** per :class:`_engine.Engine` object.  For dynamic password
              generation per connect, see :ref:`engines_dynamic_tokens`.