sqlalchemy.dialects.postgresql.psycopg2._PGEnum

class documentation

class _PGEnum(ENUM):

View In Hierarchy

Undocumented

Method result​_processor Return a conversion function for processing result row values.
Instance Variable ​_expect​_unicode Undocumented

Inherited from ENUM:

Class Method adapt​_emulated​_to​_native Produce a PostgreSQL native _postgresql.ENUM from plain .Enum.
Method __init__ Construct an _postgresql.ENUM.
Method create Emit CREATE TYPE for this _postgresql.ENUM.
Method drop Emit DROP TYPE for this _postgresql.ENUM.
Class ​Enum​Dropper Undocumented
Class ​Enum​Generator Undocumented
Method ​_check​_for​_name​_in​_memos Look in the 'ddl runner' for 'memos', then note our name in that collection.
Method ​_on​_metadata​_create Undocumented
Method ​_on​_metadata​_drop Undocumented
Method ​_on​_table​_create Undocumented
Method ​_on​_table​_drop Undocumented
Class Variable native​_enum Undocumented
Instance Variable create​_type Undocumented

Inherited from NativeForEmulated (via ENUM):

Class Method adapt​_native​_to​_emulated Given an impl, adapt this type's class to the impl assuming "emulated".

Inherited from Enum (via ENUM):

Class ​Comparator Undocumented
Method __repr__ Undocumented
Method ​_db​_value​_for​_elem Undocumented
Method ​_enum​_init internal init for .Enum and subclasses.
Method ​_object​_value​_for​_elem Undocumented
Method ​_parse​_into​_values Undocumented
Method ​_set​_table Undocumented
Method ​_setup​_for​_values Undocumented
Method ​_should​_create​_constraint Undocumented
Method adapt Produce an "adapted" form of this type, given an "impl" class to work with.
Method adapt​_to​_emulated Given an impl class, adapt this type to the impl assuming "emulated".
Method as​_generic Return an instance of the generic type corresponding to this type using heuristic rule. The method may be overridden if this heuristic rule is not sufficient.
Method bind​_processor Return a conversion function for processing bind values.
Method copy Undocumented
Method literal​_processor Return a conversion function for processing literal values that are to be rendered directly without using binds.
Class Variable __visit​_name__ Undocumented
Instance Variable ​_object​_lookup Undocumented
Instance Variable ​_omit​_aliases Undocumented
Instance Variable ​_sort​_key​_function Undocumented
Instance Variable ​_valid​_lookup Undocumented
Instance Variable create​_constraint Undocumented
Instance Variable enum​_class Undocumented
Instance Variable enums Undocumented
Instance Variable validate​_strings Undocumented
Instance Variable values​_callable Undocumented
Property ​_enums​_argument Undocumented
Property native Undocumented
Property python​_type Return the Python type object expected to be returned by instances of this type, if known.
Property sort​_key​_function A sorting function that can be passed as the key to sorted.

Inherited from String (via ENUM, Enum):

Method get​_dbapi​_type Return the corresponding type object from the underlying DB-API, if any.
Constant RETURNS​_BYTES Undocumented
Constant RETURNS​_CONDITIONAL Undocumented
Constant RETURNS​_UNICODE Undocumented
Constant RETURNS​_UNKNOWN Undocumented
Class Method ​_warn​_deprecated​_unicode Undocumented
Instance Variable ​_expect​_unicode​_error Undocumented
Instance Variable ​_warn​_on​_bytestring Undocumented
Instance Variable collation Undocumented
Instance Variable length Undocumented

Inherited from TypeEngine (via ENUM, Enum, String):

Method bind​_expression Given a bind value (i.e. a .BindParameter instance), return a SQL expression in its place.
Method coerce​_compared​_value Suggest a type for a 'coerced' Python value in an expression.
Method column​_expression Given a SELECT column expression, return a wrapping SQL expression.
Method compare​_against​_backend Compare this type against the given backend type.
Method compare​_values Compare two values for equality.
Method compile Produce a string-compiled form of this .TypeEngine.
Method dialect​_impl Return a dialect-specific implementation for this .TypeEngine.
Method evaluates​_none Return a copy of this type which has the .should_evaluate_none flag set to True.
Method with​_variant Produce a new type object that will utilize the given type when applied to the dialect of the given name.
Class Variable hashable Flag, if False, means values from this type aren't hashable.
Class Variable should​_evaluate​_none If True, the Python constant None is considered to be handled explicitly by this type.
Static Method ​_to​_instance Undocumented
Method __str__ Undocumented
Method ​_cached​_bind​_processor Return a dialect-specific bind processor for this type.
Method ​_cached​_custom​_processor Undocumented
Method ​_cached​_literal​_processor Return a dialect-specific literal processor for this type.
Method ​_cached​_result​_processor Return a dialect-specific result processor for this type.
Method ​_compare​_type​_affinity Undocumented
Method ​_default​_dialect Undocumented
Method ​_dialect​_info Return a dialect-specific registry which caches a dialect-specific implementation, bind processing function, and one or more result processing functions.
Method ​_gen​_dialect​_impl Undocumented
Method ​_resolve​_for​_literal adjust this type given a literal Python value that will be stored in a bound parameter.
Method ​_unwrapped​_dialect​_impl Return the 'unwrapped' dialect impl for this type.
Method copy​_value Undocumented
Class Variable ​_is​_array Undocumented
Class Variable ​_is​_table​_value Undocumented
Class Variable ​_is​_tuple​_type Undocumented
Class Variable ​_is​_type​_decorator Undocumented
Class Variable ​_isnull Undocumented
Class Variable ​_sqla​_type Undocumented
Property ​_generic​_type​_affinity Undocumented
Property ​_has​_bind​_expression memoized boolean, check if bind_expression is implemented.
Property ​_has​_column​_expression memoized boolean, check if column_expression is implemented.
Property ​_static​_cache​_key Undocumented
Property ​_type​_affinity Return a rudimental 'affinity' value expressing the general class of type.

Inherited from Traversible (via ENUM, Enum, String, TypeEngine):

Method get​_children Return immediate child .visitors.Traversible elements of this .visitors.Traversible.
Method __class​_getitem__ Undocumented

Inherited from SchemaType (via ENUM, Enum):

Method ​_is​_impl​_for​_variant Undocumented
Method ​_set​_parent Associate with this SchemaEvent's parent object.
Method ​_variant​_mapping​_for​_set​_table Undocumented
Class Variable ​_use​_schema​_map Undocumented
Instance Variable ​_create​_events Undocumented
Instance Variable inherit​_schema Undocumented
Instance Variable metadata Undocumented
Instance Variable name Undocumented
Instance Variable schema Undocumented
Property bind Undocumented

Inherited from SchemaEventTarget (via ENUM, Enum, SchemaType):

Method ​_set​_parent​_with​_dispatch Undocumented
def result_processor(self, dialect, coltype):
overrides sqlalchemy.types.Enum.result_processor

Return a conversion function for processing result row values.

Returns a callable which will receive a result row column value as the sole positional argument and will return a value to return to the user.

If processing is not necessary, the method should return None.

Note

This method is only called relative to a dialect specific type object, which is often private to a dialect in use and is not the same type object as the public facing one, which means it's not feasible to subclass a .types.TypeEngine class in order to provide an alternate _types.TypeEngine.result_processor method, unless subclassing the _types.UserDefinedType class explicitly.

To provide alternate behavior for _types.TypeEngine.result_processor, implement a _types.TypeDecorator class and provide an implementation of _types.TypeDecorator.process_result_value.

See Also

:ref:`types_typedecorator`

Parameters
dialectDialect instance in use.
coltypeDBAPI coltype argument received in cursor.description.
_expect_unicode: str =
overrides sqlalchemy.types.String._expect_unicode

Undocumented