feat!: make graphene-federation compatible to graphene v3

Author: Thomas Leonard

.github/workflows/lint.yml

@@ -17,4 +17,6 @@ jobs:
         python -m pip install --upgrade pip
         pip install -e ".[dev]"
     - name: Run lint 💅
-      run: black graphene_federation --check
+      run: |
+        black graphene_federation --check
+        mypy graphene_federation

.gitignore

@@ -1,3 +1,5 @@
+.DS_Store
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -104,4 +106,4 @@ venv.bak/
 .mypy_cache/
 
 .idea
-node_modules
+node_modules

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.8-slim
+FROM python:3.10-alpine
 
 # Disable Python buffering in order to see the logs immediatly
 ENV PYTHONUNBUFFERED=1

Makefile

@@ -2,22 +2,45 @@
 # Integration testing
 # -------------------------
 
-.PHONY: integration-build ## Build environment for integration tests
-integration-build:
+integration-build: ## Build environment for integration tests
 	cd integration_tests && docker-compose build
+.PHONY: integration-build
 
-.PHONY: integration-test ## Run integration tests
-integration-test:
+integration-tests: ## Run integration tests
 	cd integration_tests && docker-compose down && docker-compose run --rm tests
+.PHONY: integration-test
 
 # -------------------------
 # Development and unit testing
 # -------------------------
 
-.PHONY: dev-setup ## Install development dependencies
-dev-setup:
+dev-setup: ## Install development dependencies
 	docker-compose up -d && docker-compose exec graphene_federation bash
+.PHONY: dev-setup
 
-.PHONY: tests ## Run unit tests
-tests:
+tests: ## Run unit tests
 	docker-compose run graphene_federation py.test graphene_federation --cov=graphene_federation -vv
+.PHONY: tests
+
+check-style: ## Run linting
+	docker-compose run graphene_federation black graphene_federation --check
+.PHONY: check-style
+
+check-types: ## Run typing check
+	docker-compose run graphene_federation mypy graphene_federation
+.PHONY: check-types
+
+# -------------------------
+# Help
+# -------------------------
+
+help: ## Show help
+	@grep -E '^[0-9a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+.PHONY: help
+
+.DEFAULT_GOAL := help
+
+.EXPORT_ALL_VARIABLES:
+DOCKER_BUILDKIT = 1
+COMPOSE_DOCKER_CLI_BUILD = 1
+

Pipfile

@@ -3,6 +3,7 @@ version: '3.5'
 services:
 
   graphene_federation:
+    container_name: graphene_federation
     build:
       context: .
     volumes:

Pipfile.lock

@@ -1,29 +1,33 @@
-from typing import Any, Dict, Union
+from __future__ import annotations
 
-from graphene import List, Union, Schema
+from typing import Any, Callable
 
-import graphene
+from graphene import List, Union
+
+from graphene.types.schema import Schema
+from graphene.types.schema import TypeMap
 
 from .types import _Any
 from .utils import field_name_to_type_attribute
 
 
-def get_entities(schema: Schema) -> Dict[str, Any]:
+def get_entities(schema: Schema) -> dict[str, Any]:
     """
-    Find all the entities from the schema.
+    Find all the entities from the type map.
     They can be easily distinguished from the other type as
     the `@key` and `@extend` decorators adds a `_sdl` attribute to them.
     """
+    type_map: TypeMap = schema.graphql_schema.type_map
     entities = {}
-    for type_name, type_ in schema._type_map.items():
+    for type_name, type_ in type_map.items():
         if not hasattr(type_, "graphene_type"):
             continue
         if getattr(type_.graphene_type, "_keys", None):
             entities[type_name] = type_.graphene_type
     return entities
 
 
-def get_entity_cls(entities: Dict[str, Any]):
+def get_entity_cls(entities: dict[str, Any]) -> Union:
     """
     Create _Entity type which is a union of all the entities types.
     """
@@ -46,14 +50,12 @@ def get_entity_query(schema: Schema):
     entity_type = get_entity_cls(entities_dict)
 
     class EntityQuery:
-        entities = graphene.List(
-            entity_type, name="_entities", representations=List(_Any)
-        )
+        entities = List(entity_type, name="_entities", representations=List(_Any))
 
         def resolve_entities(self, info, representations):
             entities = []
             for representation in representations:
-                type_ = schema.get_type(representation["__typename"])
+                type_ = schema.graphql_schema.get_type(representation["__typename"])
                 model = type_.graphene_type
                 model_arguments = representation.copy()
                 model_arguments.pop("__typename")
@@ -76,7 +78,7 @@ def resolve_entities(self, info, representations):
     return EntityQuery
 
 
-def key(fields: str):
+def key(fields: str) -> Callable:
     """
     Take as input a field that should be used as key for that entity.
     See specification: https://www.apollographql.com/docs/federation/federation-spec/#key