Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Add py.typed marker

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#696 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.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
python
Lĩnh vực
tooling

Hướng nghiên cứu

Bắt đầu bằng cách xác định module markdown2 đã được đóng gói và cấu hình đóng gói của dự án, sau đó kiểm tra cách dữ liệu của package được đưa vào các bản distribution. Công việc được hoàn tất khi marker py.typed được phân phối cùng markdown2 và mypy cũng như Pyright không còn báo các cảnh báo về việc thiếu thông tin kiểu.

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

Mô tả

When importing markdown2, I’m seeing the following linter warnings:

  • mypy: Skipping analyzing "markdown2": module is installed, but missing library stubs or py.typed marker.
  • Pyright: Stub file not found for "markdown2"

I noticed that typing support was introduced in PR #581 — thanks for that! I was wondering if there might be one additional step needed to make this fully recognized by type checkers.

From what I understand, adding a py.typed file to the package can help tools like mypy and Pyright detect that the package includes type information (as mentioned in #456 and #562). For reference, this might be helpful:
https://blog.whtsky.me/tech/2021/dont-forget-py.typed-for-your-typed-python-package/

If this sounds reasonable and you would like to have support, I’d be happy to help.

Ngôn ngữ chính
Python
Star
2.8k
Fork
459
Merge trung bình
2 ngày 14 giờ
Pull request đã merge (30 ngày)
5

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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.

Issue khác của trentm/python-markdown2

Tất cả issue của trentm/python-markdown2

Issue tương tự

Thêm issue về Python

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.