graphql-python / graphql-python/graphene

Circular import solution

オープン
#1,309 コメント 1 件 リアクション 1 件 担当者 0 名 GitHub で見る
✨ enhancement
主要言語
Python
スター
8.2k
フォーク
818
PR マージ指標
30日以内にマージされた PR はありません

説明

I would like to contribute a solution to the circular import problem. As far as I can see, currently this problem has some workaround through the `Dynamic` type:
https://github.com/graphql-python/graphene/issues/522#issuecomment-626075061

From my point of view strategy described in this link is pretty much elegant, since it uses `type` argument from Scheme constructor, which has relevant description:
```
types (List[GraphQLType], optional): List of any types to include in schema that
may not be introspected through root types.
```

But instead of creating new types and making syntax even more complicated and non-readable, I would like to propose a solution with schema pushing down to the `import_string` method from utils.
Apparently, it was not difficult task:

I made fast and simple changes in interfaces, in order to do this:

Changed `type` method interface of `Field` class:
```python
def type(self, schema):
return get_type(self._type, schema)
```

Then reducer invocation [here](https://github.com/graphql-python/graphene/blob/e24ac547d670d90931cc2392d2330787747c041f/graphene/types/schema.py#L299) :
```python
def construct_fields_for_type(self, map, type, is_input_type=False):
fields = OrderedDict()
for name, field in type._meta.fields.items():
if isinstance(field, Dynamic):
field = get_field_as(field.get_type(self.schema), _as=Field)
if not field:
continue
map = self.reducer(map, field.type(self.schema))
field_type = self.get_field_type(map, field.type(self.schema))
```

Small changes for `get_type` method:
```python
def get_type(_type, schema=None):
if isinstance(_type, string_types):
return import_string(_type, schema=schema)
```
```python
def import_string(type_name, dotted_attributes=None, schema=None):
if schema:
try:
scheme_type = next(type_ for type_ in schema.types if type_._meta.name == type_name)
return scheme_type
except StopIteration:
pass
....
```

At the end of a day I was able to run code from [link](https://github.com/graphql-python/graphene/issues/522#issuecomment-626075061) without problems.
```python
from graphene import ObjectType, List

class FooBarBaz(ObjectType):
foo_bars = List('FooBar', required= True)
```
It is a small fix, I made them with respect to my first impression of graphene structure.

Please, give me feedback, if this solution is okay for you, I will make a pull request.
If not, please, describe why and how can I then avoid circular import

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

調査の方向性

まず graphene/types/schema.py の construct_fields_for_type 周辺と、utils の get_type/import_string メソッドを確認し、次にリンクされたディスカッションの循環インポートの例を再現します。schema を渡すことで既存の型解決を壊さずにその例を解決できるかどうかを判断し、その結果の決定を文書化できれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
api
issue の種類
バグ
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。