From: Mike Bayer Date: Wed, 20 Jan 2016 21:20:08 +0000 (-0500) Subject: - generalize the verbiage on LargeBinary so that it doesn't X-Git-Tag: rel_1_1_0b1~84^2~23 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=47d8858c54401cdf10285b7935049faf87432f55;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git - generalize the verbiage on LargeBinary so that it doesn't create confusion for inherited classes such as BYTEA, fixes --- diff --git a/doc/build/dialects/postgresql.rst b/doc/build/dialects/postgresql.rst index e158cacbff..616924685e 100644 --- a/doc/build/dialects/postgresql.rst +++ b/doc/build/dialects/postgresql.rst @@ -44,9 +44,7 @@ construction arguments, are as follows: .. autoclass:: BYTEA :members: __init__ - .. autoclass:: CIDR - :members: __init__ .. autoclass:: DOUBLE_PRECISION diff --git a/lib/sqlalchemy/sql/sqltypes.py b/lib/sqlalchemy/sql/sqltypes.py index 62f163893b..84bfca0261 100644 --- a/lib/sqlalchemy/sql/sqltypes.py +++ b/lib/sqlalchemy/sql/sqltypes.py @@ -909,9 +909,9 @@ class LargeBinary(_Binary): """A type for large binary byte data. - The Binary type generates BLOB or BYTEA when tables are created, - and also converts incoming values using the ``Binary`` callable - provided by each DB-API. + The :class:`.LargeBinary` type corresponds to a large and/or unlengthed + binary type for the target platform, such as BLOB on MySQL and BYTEA for + Postgresql. It also handles the necessary conversions for the DBAPI. """ @@ -922,13 +922,8 @@ class LargeBinary(_Binary): Construct a LargeBinary type. :param length: optional, a length for the column for use in - DDL statements, for those BLOB types that accept a length - (i.e. MySQL). It does *not* produce a *lengthed* BINARY/VARBINARY - type - use the BINARY/VARBINARY types specifically for those. - May be safely omitted if no ``CREATE - TABLE`` will be issued. Certain databases may require a - *length* for use in DDL, and will raise an exception when - the ``CREATE TABLE`` DDL is issued. + DDL statements, for those binary types that accept a length, + such as the MySQL BLOB type. """ _Binary.__init__(self, length=length)