From a21d7afc558307d01b3e98f20ace123b33b1ec86 Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Sat, 10 Aug 2019 22:20:31 -0400 Subject: [PATCH] - shore up TypeDecorator docs a bit to not render tons of comparator methods Change-Id: I8f434b18b2bd632a0db0db1376262944272d2198 (cherry picked from commit 731a20049b372ee2e0c7408519623363e22a4db4) --- doc/build/core/custom_types.rst | 1 - lib/sqlalchemy/sql/type_api.py | 9 +++++++++ 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/doc/build/core/custom_types.rst b/doc/build/core/custom_types.rst index 01902420a7..c3a88509cc 100644 --- a/doc/build/core/custom_types.rst +++ b/doc/build/core/custom_types.rst @@ -65,7 +65,6 @@ to and/or from the database is required. .. autoclass:: TypeDecorator :members: - :inherited-members: TypeDecorator Recipes diff --git a/lib/sqlalchemy/sql/type_api.py b/lib/sqlalchemy/sql/type_api.py index 5404c8de6e..d2a1c6158d 100644 --- a/lib/sqlalchemy/sql/type_api.py +++ b/lib/sqlalchemy/sql/type_api.py @@ -793,6 +793,15 @@ class TypeDecorator(SchemaEventTarget, TypeEngine): """ class Comparator(TypeEngine.Comparator): + """A :class:`.TypeEngine.Comparator` that is specific to + :class:`.TypeDecorator`. + + User-defined :class:`.TypeDecorator` classes should not typically + need to modify this. + + + """ + __slots__ = () def operate(self, op, *other, **kwargs): -- 2.47.2