mirror of
https://github.com/psycopg/psycopg2.git
synced 2025-01-31 17:34:08 +03:00
Epydoc clean. :D
This commit is contained in:
parent
0c67c641a8
commit
c7c2c38bcd
|
@ -2,10 +2,10 @@
|
||||||
|
|
||||||
This module holds all the extensions to the DBAPI-2.0 provided by psycopg.
|
This module holds all the extensions to the DBAPI-2.0 provided by psycopg.
|
||||||
|
|
||||||
connection -- the new-type inheritable connection class
|
- connection -- the new-type inheritable connection class
|
||||||
cursor -- the new-type inheritable cursor class
|
- cursor -- the new-type inheritable cursor class
|
||||||
adapt() -- exposes the PEP-246 compatile adapting machanism used
|
- adapt() -- exposes the PEP-246 compatile adapting machanism used
|
||||||
by psycopg to adapt Python types to PostgreSQL ones
|
by psycopg to adapt Python types to PostgreSQL ones
|
||||||
"""
|
"""
|
||||||
# psycopg/extensions.py - DBAPI-2.0 extensions specific to psycopg
|
# psycopg/extensions.py - DBAPI-2.0 extensions specific to psycopg
|
||||||
#
|
#
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
This module uses the new style connection and cursor types to build a psycopg
|
This module uses the new style connection and cursor types to build a psycopg
|
||||||
1.1.1.x compatibility layer. It should be considered a temporary hack to run
|
1.1.1.x compatibility layer. It should be considered a temporary hack to run
|
||||||
old code hile porting to psycopg 2. Import it as follows:
|
old code hile porting to psycopg 2. Import it as follows::
|
||||||
|
|
||||||
from psycopg2 import psycopg1 as psycopg
|
from psycopg2 import psycopg1 as psycopg
|
||||||
"""
|
"""
|
||||||
|
|
|
@ -68,19 +68,19 @@ PyObject *decimalType = NULL;
|
||||||
"connect(dsn, ...) -> new connection object\n\n" \
|
"connect(dsn, ...) -> new connection object\n\n" \
|
||||||
"This function supports two different but equivalent sets of arguments.\n" \
|
"This function supports two different but equivalent sets of arguments.\n" \
|
||||||
"A single data source name or 'dsn' string can be used to specify the\n" \
|
"A single data source name or 'dsn' string can be used to specify the\n" \
|
||||||
"connection parameters, as follows:\n\n" \
|
"connection parameters, as follows::\n\n" \
|
||||||
" psycopg2.connect(\"dbname=xxx user=xxx ...\")\n\n" \
|
" psycopg2.connect(\"dbname=xxx user=xxx ...\")\n\n" \
|
||||||
"If 'dsn' is not provided it is possible to pass the parameters as\n" \
|
"If 'dsn' is not provided it is possible to pass the parameters as\n" \
|
||||||
"keyword arguments; e.g.,\n\n" \
|
"keyword arguments; e.g.::\n\n" \
|
||||||
" psycopg2.connect(database='xxx', user='xxx', ...)\n\n" \
|
" psycopg2.connect(database='xxx', user='xxx', ...)\n\n" \
|
||||||
"The full list of available parameters is:\n\n" \
|
"The full list of available parameters is:\n\n" \
|
||||||
" dbname -- database name (only in 'dsn')\n" \
|
" - dbname -- database name (only in 'dsn')\n" \
|
||||||
" database -- database name (only as keyword argument)\n" \
|
" - database -- database name (only as keyword argument)\n" \
|
||||||
" host -- host address (defaults to UNIX socket if not provided)\n" \
|
" - host -- host address (defaults to UNIX socket if not provided)\n" \
|
||||||
" port -- port number (defaults to 5432 if not provided)\n" \
|
" - port -- port number (defaults to 5432 if not provided)\n" \
|
||||||
" user -- user name used to authenticate\n" \
|
" - user -- user name used to authenticate\n" \
|
||||||
" password -- password used to authenticate\n" \
|
" - password -- password used to authenticate\n" \
|
||||||
" sslmode -- SSL mode (see PostgreSQL documentation)\n\n" \
|
" - sslmode -- SSL mode (see PostgreSQL documentation)\n\n" \
|
||||||
"If the 'connection_factory' keyword argument is not provided this\n" \
|
"If the 'connection_factory' keyword argument is not provided this\n" \
|
||||||
"function always return an instance of the 'psycopg2.connection' class.\n" \
|
"function always return an instance of the 'psycopg2.connection' class.\n" \
|
||||||
"Else the given sub-class of 'psycopg2.connection' will be used to\n" \
|
"Else the given sub-class of 'psycopg2.connection' will be used to\n" \
|
||||||
|
|
Loading…
Reference in New Issue
Block a user