graphql-python / graphql-python/graphene-sqlalchemy
Add a way to serve custom properties on model classes
- 主要語言
- Python
- 星號
- 985
- 分支
- 223
- PR 合併指標
- 30 天內沒有已合併 PR
描述
In SQLAlchemy, you often want to provide additional custom properties on the model classes, like this:
```python
class User(Base):
__tablename__ = 'users'
first_name = Column(String)
last_name = Column(String)
@property
def full_name(self):
return self.first_name + ' ' + self.last_name
```
Unfortunately, such properties are currently not made accessible in GraphQL by graphene_sqlalchemy. While there is a way to exclude existing column properties using the Meta attributes `exclude_fields` and `only_fields`, there is no way to include custom properties such as `full_name` from the above model.
One possible solution is to use [hybrid properties](http://docs.sqlalchemy.org/en/latest/orm/extensions/hybrid.html) which are now supported by graphene_sqlalchemy since 2.0. However, "ordinary" properties should also be supported. Often you dont really want or need hybrid properties - it is not always necessary or feasible to provide the property on the class level. Also, the conversion of hybrid properties currently has the limitation that it always generates `String` fields.
So I believe we need some mechanism for proxying arbitrary properties from SQLAlchemy to Graphene objects. I'm not yet sure whether all custom public properties (i.e. those not starting with an underscore) except those who are explicitly excluded should be proxied by default (like it is done with hybrid properties), or whether there should be a Meta attribute with a list of properties that must be explicitly set.
We probably also need to add a way to specify which type the (normal or hybrid) properties shall be converted to. This could also be defined in a Meta attribute, or maybe we could check for Python type hints if nothing is defined, like this:
```python
def full_name(self) -> str:
return self.first_name + ' ' + self.last_name
def current_age(self) -> int:
return current_year() - self.year_of_birth
```
I am willing to contribute with code, but first I want to get some feedback regarding this idea from others.
貢獻指南
研究方向
先檢視 graphene_sqlalchemy 現有的混合屬性支援,以及 Meta 選項 exclude_fields 和 only_fields。釐清一般屬性是否預設會被包含,或必須明確列出;確認其 GraphQL 型別如何選擇;並定義測試,以證明屬性公開與型別轉換符合完成標準。
由索引模型根據 Issue 內容生成。
評估
- 技術堆疊
- graphql, python, sqlalchemy
- 領域
- api, backend
- Issue 類型
- 功能
- 難度
- 5/5
- 預估耗時
- 一週以上
- 活躍度
- 停滯
- 描述清晰度
- 需要釐清
- 新手友好度
- 25/100