Add old functions back with deprecation warning

Author: Cito

src/graphql_relay/__init__.py

@@ -1,43 +1,56 @@
+"""The graphql_relay package"""
+
+# The graphql-relay and graphql-relay-js version info
 from .version import version, version_info, version_js, version_info_js
+
+# Types for creating connection types in the schema
 from .connection.connectiontypes import (
-    Connection, ConnectionArguments, ConnectionCursor, Edge, PageInfo
-)
+    Connection, ConnectionArguments, ConnectionCursor, Edge, PageInfo)
+
+# Helpers for creating connection types in the schema
 from .connection.connection import (
     backward_connection_args, connection_args, connection_definitions,
     forward_connection_args, GraphQLConnectionDefinitions)
+
+# Helpers for creating connections from arrays
 from .connection.arrayconnection import (
     connection_from_array, connection_from_array_slice,
     cursor_for_object_in_connection,
     cursor_to_offset, get_offset_with_default, offset_to_cursor)
+
+# Helper for creating mutations with client mutation IDs
 from .mutation.mutation import mutation_with_client_mutation_id
+
+# Helper for creating node definitions
+from .node.node import node_definitions
+
+#  Helper for creating plural identifying root fields
+from .node.plural import plural_identifying_root_field
+
+# Utilities for creating global IDs in systems that don't have them
 from .node.node import (
-    node_definitions,
     from_global_id, global_id_field, to_global_id)
-from .node.plural import plural_identifying_root_field
+
+# Deprecated functions from older graphql-relay-py versions
+# noinspection PyProtectedMember,PyUnresolvedReferences,PyDeprecation
+from .connection.arrayconnection import (  # noqa: F401
+    connection_from_list, connection_from_list_slice)
 
 __version__ = version
 __version_info__ = version_info
 __version_js__ = version_js
 __version_info_js__ = version_info_js
 
 __all__ = [
-    # The graphql-relay and graphql-relay-js version info
     'version', 'version_info', 'version_js', 'version_info_js',
-    # Types for creating connection types in the schema
     'Connection', 'ConnectionArguments', 'ConnectionCursor', 'Edge', 'PageInfo',
-    # Helpers for creating connection types in the schema
     'backward_connection_args', 'connection_args', 'connection_definitions',
     'forward_connection_args', 'GraphQLConnectionDefinitions',
-    # Helpers for creating connections from arrays
     'connection_from_array', 'connection_from_array_slice',
     'cursor_for_object_in_connection', 'cursor_to_offset',
     'get_offset_with_default', 'offset_to_cursor',
-    # Helper for creating mutations with client mutation IDs
     'mutation_with_client_mutation_id',
-    # Helper for creating node definitions
     'node_definitions',
-    #  Helper for creating plural identifying root fields
     'plural_identifying_root_field',
-    # Utilities for creating global IDs in systems that don't have them
     'from_global_id', 'global_id_field', 'to_global_id',
 ]

src/graphql_relay/connection/arrayconnection.py

@@ -1,4 +1,5 @@
 import binascii
+import warnings
 from typing import Any, Optional, Sequence
 
 from ..utils.base64 import base64, unbase64
@@ -37,6 +38,25 @@ def connection_from_array(
     )
 
 
+def connection_from_list(
+        data: Sequence, args: ConnectionArguments = None,
+        connection_type: Any = Connection,
+        edge_type: Any = Edge, pageinfo_type: Any = PageInfo) -> Connection:
+    """Deprecated alias for connection_from_array.
+
+    We're now using the JavaScript terminology in Python as well, since list
+    is too narrow a type and there is no other really appropriate type name.
+    """
+    warnings.warn(
+        "connection_from_list() has been deprecated."
+        " Please use connection_from_array() instead.",
+        DeprecationWarning, stacklevel=2)
+    return connection_from_array_slice(
+        data, args,
+        connection_type=connection_type,
+        edge_type=edge_type, page_info_type=pageinfo_type)
+
+
 def connection_from_array_slice(
         array_slice: Sequence, args: ConnectionArguments = None,
         slice_start: int = 0, array_length: int = None, array_slice_length: int = None,
@@ -116,6 +136,28 @@ def connection_from_array_slice(
     )
 
 
+def connection_from_list_slice(
+        list_slice: Sequence, args: ConnectionArguments = None,
+        connection_type: Any = Connection,
+        edge_type: Any = Edge, pageinfo_type: Any = PageInfo,
+        slice_start=0, list_length=0, list_slice_length=None) -> Connection:
+    """Deprecated alias for connection_from_array_slice.
+
+    We're now using the JavaScript terminology in Python as well, since list
+    is too narrow a type and there is no other really appropriate type name.
+    """
+    warnings.warn(
+        "connection_from_list_slice() has been deprecated."
+        " Please use connection_from_array_slice() instead.",
+        DeprecationWarning, stacklevel=2)
+    return connection_from_array_slice(
+        list_slice, args,
+        slice_start=slice_start, array_length=list_length,
+        array_slice_length=list_slice_length,
+        connection_type=connection_type,
+        edge_type=edge_type, page_info_type=pageinfo_type)
+
+
 PREFIX = 'arrayconnection:'
 
 

tests/connection/test_arrayconnection.py

@@ -1,13 +1,16 @@
 from typing import cast, Sequence
 
-from pytest import raises  # type: ignore
+from pytest import deprecated_call, raises  # type: ignore
 
 from graphql_relay import (
     connection_from_array,
     connection_from_array_slice,
     cursor_for_object_in_connection,
     Connection, Edge, PageInfo)
 
+# noinspection PyProtectedMember
+from graphql_relay import connection_from_list, connection_from_list_slice
+
 
 def describe_connection_from_array():
     letters = ['A', 'B', 'C', 'D', 'E']
@@ -484,6 +487,24 @@ def __init__(
             assert page_info.hasPreviousPage is False
             assert page_info.hasNextPage is False
 
+        def provides_deprecated_connection_from_list():
+            with deprecated_call():
+                # noinspection PyDeprecation
+                c = connection_from_list(
+                    letters[:1], args={}, connection_type=Connection,
+                    edge_type=Edge, pageinfo_type=PageInfo)
+            assert c == Connection(
+                edges=[
+                    Edge(node='A', cursor='YXJyYXljb25uZWN0aW9uOjA='),
+                ],
+                pageInfo=PageInfo(
+                    startCursor='YXJyYXljb25uZWN0aW9uOjA=',
+                    endCursor='YXJyYXljb25uZWN0aW9uOjA=',
+                    hasPreviousPage=False,
+                    hasNextPage=False,
+                )
+            )
+
 
 def describe_connection_from_array_slice():
     letters = ['A', 'B', 'C', 'D', 'E']
@@ -828,3 +849,22 @@ def __init__(
             assert page_info.endCursor == 'YXJyYXljb25uZWN0aW9uOjA='
             assert page_info.hasPreviousPage is False
             assert page_info.hasNextPage is False
+
+        def provides_deprecated_connection_from_list_slice():
+            with deprecated_call():
+                # noinspection PyDeprecation
+                c = connection_from_list_slice(
+                    letters[:1], args={}, connection_type=Connection,
+                    edge_type=Edge, pageinfo_type=PageInfo,
+                    slice_start=0, list_length=1, list_slice_length=1)
+            assert c == Connection(
+                edges=[
+                    Edge(node='A', cursor='YXJyYXljb25uZWN0aW9uOjA='),
+                ],
+                pageInfo=PageInfo(
+                    startCursor='YXJyYXljb25uZWN0aW9uOjA=',
+                    endCursor='YXJyYXljb25uZWN0aW9uOjA=',
+                    hasPreviousPage=False,
+                    hasNextPage=False,
+                )
+            )