Azure / Azure/azure-functions-durable-python

Proposal: Support Class-Based Syntax for Python Entities

Đang mở
#278 4 bình luận 0 reaction 0 người được giao Xem trên GitHub
Enhancement fixed-in-v2
Ngôn ngữ chính
Python
Star
157
Fork
70
Merge trung bình
2 ngày 10 giờ
Pull request đã merge (30 ngày)
2

Mô tả

Currently, Entities in Python (and JavaScript) only support function-based syntax, where operations are delineated by a cascade of if-statements. In C#, a class-based syntax is supported, which allows individual operations to be split into methods belonging to a larger class that represents the Entity itself.

Implementing this alternative syntax should not be too difficult, it's mostly just a layer of indirection. Making matters simpler, we already have a community-driven example of how to do this for TypeScript here: https://scale-tone.github.io/2021/03/15/durable-mvc .

As an example for the syntax, consider the following entity function using the current implementation syntax

```Python
def entity_function(context: df.DurableEntityContext):
current_value = context.get_state(lambda: 0)
operation = context.operation_name
if operation == "add":
amount = context.get_input()
current_value += amount
elif operation == "reset":
current_value = 0
elif operation == "get":
pass

context.set_state(current_value)
context.set_result(current_value)
```

It's class-based syntax alternative would look as follows:

```Python
class Counter:
def __init__(self): # this corresponds to state initializer, or the `lambda: 0` in the function-based syntax
self.entity_state= 0

def add(self, amount):
self.entity_state+= amount
return self.entity_state
def get(self):
return self.entity_state
def reset(self):
return self.entity_state= 0
```

Finally, it makes sense to me that the `return` statement would set the value for `context.set_result`. A more difficult question is to know what value to save for `set_state`. One easy solution is to require the state to be under the name `self.entity_state` but perhaps that's too restrictive. What do others think?

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Issue không nêu tên tệp hoặc bài kiểm thử nào. Hãy bắt đầu bằng việc xem xét cách xử lý entity dựa trên hàm hiện có quanh DurableEntityContext và ví dụ TypeScript được liên kết, sau đó xác định các phương thức của class, việc khởi tạo, các kết quả được trả về và trạng thái được persist nên ánh xạ như thế nào vào mô hình entity hiện tại. Điều kiện hoàn thành là phải thống nhất được thiết kế về cú pháp và cách xử lý trạng thái trước khi triển khai.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
backend
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.