diff options
author | Mike Bayer <mike_mp@zzzcomputing.com> | 2008-12-08 21:32:29 +0000 |
---|---|---|
committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2008-12-08 21:32:29 +0000 |
commit | 70f55bd2cdd0bcc6d188a24f78ee124c851b368f (patch) | |
tree | e27a9f6eb48e9a6da496350ded35bc86f5d6ad9a /lib/sqlalchemy/engine/url.py | |
parent | 3e2d6a9a18b318466c1de0a1b61baac579cb1690 (diff) | |
download | sqlalchemy-70f55bd2cdd0bcc6d188a24f78ee124c851b368f.tar.gz |
- restored the previous API Reference structure
- bumped latex TOC structure, the PDF looks great
- but we need to fix the translate_connect_args docstring bug to really have PDF
Diffstat (limited to 'lib/sqlalchemy/engine/url.py')
-rw-r--r-- | lib/sqlalchemy/engine/url.py | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/lib/sqlalchemy/engine/url.py b/lib/sqlalchemy/engine/url.py index 035e28693..679e4af89 100644 --- a/lib/sqlalchemy/engine/url.py +++ b/lib/sqlalchemy/engine/url.py @@ -11,7 +11,8 @@ from sqlalchemy import exc class URL(object): - """Represent the components of a URL used to connect to a database. + """ + Represent the components of a URL used to connect to a database. This object is suitable to be passed directly to a ``create_engine()`` call. The fields of the URL are parsed from a @@ -21,8 +22,8 @@ class URL(object): All initialization parameters are available as public attributes. :param drivername: the name of the database backend. - This name will correspond to a module in sqlalchemy/databases - or a third party plug-in. + This name will correspond to a module in sqlalchemy/databases + or a third party plug-in. :param username: The user name. @@ -35,7 +36,7 @@ class URL(object): :param database: The database name. :param query: A dictionary of options to be passed to the - dialect and/or the DBAPI upon connect. + dialect and/or the DBAPI upon connect. """ @@ -102,9 +103,10 @@ class URL(object): used as the keys by default. Unset or false attributes are omitted from the final dictionary. - :param \**kw: Optional, alternate key names for url - attributes:: + :param \**kw: Optional, alternate key names for url attributes: + .. sourcecode:: python + # return 'username' as 'user' username='user' |