Port a better schema printer from GraphQL Core 3.x (#9389)

This exports more information including descriptions and makes the
schema file useful for client implementation and for linting.

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
     hooks:
       - id: trailing-whitespace
         exclude: ^templates/templated_email/compiled/
-        exclude_types: [svg]
+        exclude_types: [svg,graphql]
       - id: end-of-file-fixer
         exclude: ^templates/templated_email/compiled/
         exclude_types: [svg]

saleor/__init__.py

@@ -1,19 +1,4 @@
-from graphql.utils import schema_printer
-
 from .celeryconf import app as celery_app
 
 __all__ = ["celery_app"]
 __version__ = "dev"
-
-
-def patched_print_object(type):
-    interfaces = type.interfaces
-    implemented_interfaces = (
-        " implements {}".format(" & ".join(i.name for i in interfaces))
-        if interfaces
-        else ""
-    )
-
-    return ("type {}{} {{\n" "{}\n" "}}").format(
-        type.name, implemented_interfaces, schema_printer._print_fields(type)
-    )

saleor/graphql/core/federation/schema.py

@@ -7,6 +7,7 @@
 from graphql import GraphQLArgument, GraphQLError, GraphQLField, GraphQLList
 
 from ...channel import ChannelContext
+from ...schema_printer import print_schema
 from .entities import federated_entities
 
 
@@ -134,7 +135,7 @@ def resolve_entities(_, info, *, representations):
 
 def create_service_sdl_resolver(schema):
     # Render schema to string
-    federated_schema_sdl = str(schema)
+    federated_schema_sdl = print_schema(schema)
 
     # Remove "schema { ... }"
     schema_start = federated_schema_sdl.find("schema {")

saleor/graphql/core/types/sort_input.py

@@ -42,7 +42,7 @@ class ChannelSortInputObjectType(SortInputObjectType):
     channel = graphene.Argument(
         graphene.String,
         description=(
-            "Specifies the channel in which to sort the data. "
+            "Specifies the channel in which to sort the data."
             f"{DEPRECATED_IN_3X_INPUT} Use root-level channel argument instead."
         ),
     )

saleor/graphql/discount/mutations.py

@@ -145,7 +145,7 @@ def remove_catalogues_from_node(cls, node, input):
 
 class VoucherInput(graphene.InputObjectType):
     type = VoucherTypeEnum(
-        description=("Voucher type: PRODUCT, CATEGORY SHIPPING or ENTIRE_ORDER.")
+        description="Voucher type: PRODUCT, CATEGORY SHIPPING or ENTIRE_ORDER."
     )
     name = graphene.String(description="Voucher name.")
     code = graphene.String(description="Code to use the voucher.")
@@ -290,7 +290,7 @@ class Arguments:
         id = graphene.ID(required=True, description="ID of a voucher.")
         input = CatalogueInput(
             required=True,
-            description=("Fields required to modify catalogue IDs of voucher."),
+            description="Fields required to modify catalogue IDs of voucher.",
         )
 
     class Meta:

saleor/graphql/management/commands/get_graphql_schema.py

@@ -1,10 +1,11 @@
 from django.core.management.base import BaseCommand
 
 from ...api import schema
+from ...schema_printer import print_schema
 
 
 class Command(BaseCommand):
     help = "Writes SDL for GraphQL API schema to stdout"
 
     def handle(self, *args, **options):
-        self.stdout.write(str(schema))
+        self.stdout.write(print_schema(schema))

saleor/graphql/meta/mutations.py

@@ -332,7 +332,7 @@ class Arguments:
         )
         input = graphene.List(
             graphene.NonNull(MetadataInput),
-            description=("Fields required to update the object's metadata."),
+            description="Fields required to update the object's metadata.",
             required=True,
         )
 

saleor/graphql/notifications/mutations/external_notification_trigger.py

@@ -44,7 +44,7 @@ class ExternalNotificationTriggerInput(graphene.InputObjectType):
 class ExternalNotificationTrigger(BaseMutation):
     class Arguments:
         input = ExternalNotificationTriggerInput(
-            required=True, description="Input for External Notification Trigger. "
+            required=True, description="Input for External Notification Trigger."
         )
         plugin_id = graphene.String(description="The ID of notification plugin.")
         channel = graphene.String(

saleor/graphql/order/types.py

@@ -398,7 +398,7 @@ class Fulfillment(ModelObjectType):
     warehouse = graphene.Field(
         Warehouse,
         required=False,
-        description=("Warehouse from fulfillment was fulfilled."),
+        description="Warehouse from fulfillment was fulfilled.",
     )
 
     class Meta:

saleor/graphql/payment/types.py

@@ -48,11 +48,11 @@ class CreditCard(graphene.ObjectType):
         description="Last 4 digits of the card number.", required=True
     )
     exp_month = graphene.Int(
-        description=("Two-digit number representing the card’s expiration month."),
+        description="Two-digit number representing the card’s expiration month.",
         required=False,
     )
     exp_year = graphene.Int(
-        description=("Four-digit number representing the card’s expiration year."),
+        description="Four-digit number representing the card’s expiration year.",
         required=False,
     )
 

saleor/graphql/product/bulk_mutations/products.py

@@ -221,7 +221,7 @@ class ProductVariantBulkCreateInput(ProductVariantInput):
     )
     stocks = graphene.List(
         graphene.NonNull(StockInput),
-        description=("Stocks of a product available for sale."),
+        description="Stocks of a product available for sale.",
         required=False,
     )
     channel_listings = graphene.List(

saleor/graphql/product/mutations/digital_contents.py

@@ -125,7 +125,7 @@ class DigitalContentDelete(BaseMutation):
 
     class Arguments:
         variant_id = graphene.ID(
-            description=("ID of a product variant with digital content to remove."),
+            description="ID of a product variant with digital content to remove.",
             required=True,
         )
 
@@ -161,7 +161,7 @@ class DigitalContentUpdate(BaseMutation):
 
     class Arguments:
         variant_id = graphene.ID(
-            description=("ID of a product variant with digital content to update."),
+            description="ID of a product variant with digital content to update.",
             required=True,
         )
         input = DigitalContentInput(

saleor/graphql/product/mutations/products.py

@@ -831,7 +831,7 @@ class ProductVariantCreateInput(ProductVariantInput):
     )
     stocks = graphene.List(
         graphene.NonNull(StockInput),
-        description=("Stocks of a product available for sale."),
+        description="Stocks of a product available for sale.",
         required=False,
     )
 

saleor/graphql/product/types/digital_contents.py

@@ -16,9 +16,7 @@ class DigitalContentUrl(ModelObjectType):
     created = graphene.DateTime(required=True)
     download_num = graphene.Int(required=True)
     url = graphene.String(description="URL for digital content.")
-    token = graphene.Field(
-        UUID, description=("UUID of digital content."), required=True
-    )
+    token = graphene.Field(UUID, description="UUID of digital content.", required=True)
 
     class Meta:
         model = models.DigitalContentUrl

saleor/graphql/product/types/products.py

@@ -813,7 +813,7 @@ class Product(ChannelContextTypeWithMetadata, ModelObjectType):
         resolver=ChannelContextType.resolve_translation,
     )
     available_for_purchase = graphene.Date(
-        description="Date when product is available for purchase. "
+        description="Date when product is available for purchase."
     )
     is_available_for_purchase = graphene.Boolean(
         description="Whether the product is available for purchase."