makeplane / makeplane/plane-python-sdk

[bug]: update() strips None values via exclude_none=True, making it impossible to clear nullable fields

Đang mở
#35 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
Python
Star
17
Fork
24
Merge trung bình
8 ngày 9 giờ
Pull request đã merge (30 ngày)
2

Mô tả

Summary

The update() method on every resource class strips None values from the payload via model_dump(exclude_none=True),
making it impossible to clear any nullable field on an existing work item (or any other resource using the same
pattern).

Reproducer

# Setup: work item with target_date = "2026-05-17"
data = UpdateWorkItem(target_date=None)
client.work_items.update(
    workspace_slug=ws, project_id=p, work_item_id=w, data=data, 
) 
# Expected: target_date cleared to null
# Actual: silent no-op — target_date still 2026-05-17
# Wire body sent: {} (None stripped by exclude_none=True)

Root cause

plane/api/work_items/base.py line 102 (same pattern in other resources):

response = self._patch(
    f"{workspace_slug}/projects/{project_id}/work-items/{work_item_id}",
    data.model_dump(exclude_none=True),
)

exclude_none=True conflates two distinct user intents: "do not update this field" and "clear this field to null."

Impact

Affects every nullable field on every resource using this pattern: target_date, start_date, parent, point,
description_html, assignees (back to empty), etc. Currently the only workaround is clearing in the Plane web UI.

Proposed fix (two viable shapes)

A. Switch to exclude_unset=True + explicit None for clears

  • Caller passes None to mean "clear," and omits the field entirely to mean "don't change."
  • Requires the data model to distinguish unset from None (Pydantic v2 supports this natively).
  • Breaking change for callers that currently pass None expecting "don't change."

B. Add explicit clear: list[str] parameter to update() methods

  • Caller passes e.g. clear=["target_date", "parent"] and the wrapper injects null for those fields after
    model_dump.
  • Non-breaking; opt-in.
  • More verbose but unambiguous.

Happy to send a PR with whichever shape the maintainers prefer.

Environment

  • plane-sdk 0.2.10 (also present on main HEAD as of 2026-05-17)
  • Plane Cloud workspace
  • Discovered via plane-mcp-server's update_work_item tool, but the bug is in the SDK, not the MCP wrapper.

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

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu tại plane/api/work_items/base.py, khoảng dòng 102, sau đó tìm mẫu model_dump(exclude_none=True) tương tự trong các lớp resource khác. So sánh cách các trường chưa được thiết lập và None tường minh được biểu diễn trong các model cập nhật trước khi chọn giữa hai phương án được đề xuất. Công việc hoàn tất khi có thể xóa các trường nullable mà không biến các trường bị bỏ qua thành các bản cập nhật trong các resource bị ảnh hưởng.

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
api, backend
Loại issue
Lỗi
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
45/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.