Type checks, messages and docstrings

- change instances of SQLAlchemyObjectType to SQLAlchemyBase as appropriate
- update tests

Author: gbunkoczi

graphene_sqlalchemy/converter.py

@@ -7,14 +7,14 @@
 
 from sqlalchemy import types as sqa_types
 from sqlalchemy.dialects import postgresql
+from sqlalchemy.ext.hybrid import hybrid_property
 from sqlalchemy.orm import (
     ColumnProperty,
     RelationshipProperty,
     class_mapper,
     interfaces,
     strategies,
 )
-from sqlalchemy.ext.hybrid import hybrid_property
 
 import graphene
 from graphene.types.json import JSONString
@@ -159,7 +159,7 @@ def convert_sqlalchemy_relationship(
 ):
     """
     :param sqlalchemy.RelationshipProperty relationship_prop:
-    :param SQLAlchemyObjectType obj_type:
+    :param SQLAlchemyBase obj_type:
     :param function|None connection_field_factory:
     :param bool batching:
     :param str orm_field_name:
@@ -202,7 +202,7 @@ def _convert_o2o_or_m2o_relationship(
     Convert one-to-one or many-to-one relationshsip. Return an object field.
 
     :param sqlalchemy.RelationshipProperty relationship_prop:
-    :param SQLAlchemyObjectType obj_type:
+    :param SQLAlchemyBase obj_type:
     :param bool batching:
     :param str orm_field_name:
     :param dict field_kwargs:
@@ -230,7 +230,7 @@ def _convert_o2m_or_m2m_relationship(
     Convert one-to-many or many-to-many relationshsip. Return a list field or a connection field.
 
     :param sqlalchemy.RelationshipProperty relationship_prop:
-    :param SQLAlchemyObjectType obj_type:
+    :param SQLAlchemyBase obj_type:
     :param bool batching:
     :param function|None connection_field_factory:
     :param dict field_kwargs:
@@ -362,7 +362,7 @@ def get_type_from_registry():
         raise TypeError(
             "No model found in Registry for type %s. "
             "Only references to SQLAlchemy Models mapped to "
-            "SQLAlchemyObjectTypes are allowed." % type_arg
+            "SQLAlchemyBase types are allowed." % type_arg
         )
 
     return get_type_from_registry()
@@ -680,7 +680,7 @@ def forward_reference_solver():
             raise TypeError(
                 "No model found in Registry for forward reference for type %s. "
                 "Only forward references to other SQLAlchemy Models mapped to "
-                "SQLAlchemyObjectTypes are allowed." % type_arg
+                "SQLAlchemyBase types are allowed." % type_arg
             )
         # Always fall back to string if no ForwardRef type found.
         return get_global_registry().get_type_for_model(model)

graphene_sqlalchemy/enums.py

@@ -53,10 +53,10 @@ def enum_for_sa_enum(sa_enum, registry):
 
 def enum_for_field(obj_type, field_name):
     """Return the Graphene Enum type for the specified Graphene field."""
-    from .types import SQLAlchemyObjectType
+    from .types import SQLAlchemyBase
 
-    if not isinstance(obj_type, type) or not issubclass(obj_type, SQLAlchemyObjectType):
-        raise TypeError("Expected SQLAlchemyObjectType, but got: {!r}".format(obj_type))
+    if not isinstance(obj_type, type) or not issubclass(obj_type, SQLAlchemyBase):
+        raise TypeError("Expected SQLAlchemyBase, but got: {!r}".format(obj_type))
     if not field_name or not isinstance(field_name, str):
         raise TypeError("Expected a field name, but got: {!r}".format(field_name))
     registry = obj_type._meta.registry
@@ -88,10 +88,10 @@ def _default_sort_enum_symbol_name(column_name, sort_asc=True):
 def sort_enum_for_object_type(
     obj_type, name=None, only_fields=None, only_indexed=None, get_symbol_name=None
 ):
-    """Return Graphene Enum for sorting the given SQLAlchemyObjectType.
+    """Return Graphene Enum for sorting the given SQLAlchemyBase.
 
     Parameters
-    - obj_type : SQLAlchemyObjectType
+    - obj_type : SQLAlchemyBase
         The object type for which the sort Enum shall be generated.
     - name : str, optional, default None
         Name to use for the sort Enum.
@@ -160,10 +160,10 @@ def sort_argument_for_object_type(
     get_symbol_name=None,
     has_default=True,
 ):
-    """ "Returns Graphene Argument for sorting the given SQLAlchemyObjectType.
+    """ "Returns Graphene Argument for sorting the given SQLAlchemyBase.
 
     Parameters
-    - obj_type : SQLAlchemyObjectType
+    - obj_type : SQLAlchemyBase
         The object type for which the sort Argument shall be generated.
     - enum_name : str, optional, default None
         Name to use for the sort Enum.

graphene_sqlalchemy/fields.py

@@ -39,8 +39,8 @@ def type(self):
             nullable_type.__name__
         )
         assert type_ == nullable_type, (
-            "Passing a SQLAlchemyObjectType instance is deprecated. "
-            "Pass the connection type instead accessible via SQLAlchemyObjectType.connection"
+            "Passing a SQLAlchemyBase instance is deprecated. "
+            "Pass the connection type instead accessible via SQLAlchemyBase.connection"
         )
         return nullable_type.connection
 
@@ -266,7 +266,7 @@ def default_connection_field_factory(relationship, registry, **field_kwargs):
 def createConnectionField(type_, **field_kwargs):
     warnings.warn(
         "createConnectionField is deprecated and will be removed in the next "
-        "major version. Use SQLAlchemyObjectType.Meta.connection_field_factory instead.",
+        "major version. Use SQLAlchemyBase.Meta.connection_field_factory instead.",
         DeprecationWarning,
     )
     return __connectionFactory(type_, **field_kwargs)
@@ -275,7 +275,7 @@ def createConnectionField(type_, **field_kwargs):
 def registerConnectionFieldFactory(factoryMethod):
     warnings.warn(
         "registerConnectionFieldFactory is deprecated and will be removed in the next "
-        "major version. Use SQLAlchemyObjectType.Meta.connection_field_factory instead.",
+        "major version. Use SQLAlchemyBase.Meta.connection_field_factory instead.",
         DeprecationWarning,
     )
     global __connectionFactory
@@ -285,7 +285,7 @@ def registerConnectionFieldFactory(factoryMethod):
 def unregisterConnectionFieldFactory():
     warnings.warn(
         "registerConnectionFieldFactory is deprecated and will be removed in the next "
-        "major version. Use SQLAlchemyObjectType.Meta.connection_field_factory instead.",
+        "major version. Use SQLAlchemyBase.Meta.connection_field_factory instead.",
         DeprecationWarning,
     )
     global __connectionFactory

graphene_sqlalchemy/resolvers.py

@@ -19,7 +19,7 @@ def get_attr_resolver(obj_type, model_attr):
     In order to support field renaming via `ORMField.model_attr`,
     we need to define resolver functions for each field.
 
-    :param SQLAlchemyObjectType obj_type:
+    :param SQLAlchemyBase obj_type:
     :param str model_attr: the name of the SQLAlchemy attribute
     :rtype: Callable
     """

graphene_sqlalchemy/tests/test_converter.py

@@ -130,7 +130,7 @@ def hybrid_prop(self) -> "MyTypeNotInRegistry":
     with pytest.raises(
         TypeError,
         match=r"(.*)Only forward references to other SQLAlchemy Models mapped to "
-        "SQLAlchemyObjectTypes are allowed.(.*)",
+        "SQLAlchemyBase types are allowed.(.*)",
     ):
         get_hybrid_property_type(hybrid_prop).type
 

graphene_sqlalchemy/tests/test_enums.py

@@ -119,6 +119,6 @@ class Meta:
     with pytest.raises(TypeError, match=re_err):
         PetType.enum_for_field(None)
 
-    re_err = "Expected SQLAlchemyObjectType, but got: None"
+    re_err = "Expected SQLAlchemyBase, but got: None"
     with pytest.raises(TypeError, match=re_err):
         enum_for_field(None, "other_kind")

graphene_sqlalchemy/types.py

@@ -67,8 +67,8 @@ def __init__(
         **field_kwargs,
     ):
         """
-        Use this to override fields automatically generated by SQLAlchemyObjectType.
-        Unless specified, options will default to SQLAlchemyObjectType usual behavior
+        Use this to override fields automatically generated by SQLAlchemyBase.
+        Unless specified, options will default to SQLAlchemyBase usual behavior
         for the given SQLAlchemy model property.
 
         Usage:
@@ -159,8 +159,8 @@ def filter_field_from_field(
     model_attr: Any,
     model_attr_name: str,
 ) -> Optional[graphene.InputField]:
-    # Field might be a SQLAlchemyObjectType, due to hybrid properties
-    if issubclass(type_, SQLAlchemyObjectType):
+    # Field might be a SQLAlchemyBase, due to hybrid properties
+    if issubclass(type_, SQLAlchemyBase):
         filter_class = registry.get_filter_for_base_type(type_)
     # Enum Special Case
     elif issubclass(type_, graphene.Enum) and isinstance(model_attr, ColumnProperty):
@@ -285,13 +285,13 @@ def construct_fields_and_filters(
     connection_field_factory,
 ):
     """
-    Construct all the fields for a SQLAlchemyObjectType.
+    Construct all the fields for a SQLAlchemyBase.
     The main steps are:
       - Gather all the relevant attributes from the SQLAlchemy model
       - Gather all the ORM fields defined on the type
       - Merge in overrides and build up all the fields
 
-    :param SQLAlchemyObjectType obj_type:
+    :param SQLAlchemyBase obj_type:
     :param model: the SQLAlchemy model
     :param Registry registry:
     :param tuple[string] only_fields: