lincc-frameworks / lincc-frameworks/python-project-template

Remove pinned python version from black precommit hook

Đang mở Phù hợp với người mới
#575 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.

bug
Ngôn ngữ chính
Jinja
Star
85
Fork
16
Merge trung bình
6 giờ 18 phút
Pull request đã merge (30 ngày)
1

Mô tả

@camposandro and I have run into this with a couple incubees.

In the precommit template (https://github.com/lincc-frameworks/python-project-template/blob/main/python-project-template/.pre-commit-config.yaml.jinja), we set up the black hook with the following (note the last line, with language_version):

{%- if 'black' in enforce_style %}
    # Analyze the code style and report code that doesn't adhere.
  - repo: https://github.com/psf/black
    rev: 23.7.0
    hooks:
      - id: black-jupyter
        name: Format code using black
        types_or: [python, pyi, jupyter]
        # It is recommended to specify the latest version of Python
        # supported by your project here, or alternatively use
        # pre-commit's default_language_version, see
        # https://pre-commit.com/#top_level-default_language_version
        language_version: python{{ py.pref(python_versions) }}
{%- endif %}

And two users have ended up with some version of language_version: 3.11, which caused errors for them.

We should either remove this line, or make it not do this kind of behavior

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 với python-project-template/.pre-commit-config.yaml.jinja và kiểm tra cách py.pref(python_versions) tạo ra language_version của hook. Xem hướng dẫn được liên kết về pre-commit language-version, sau đó điều chỉnh template để các cấu hình được tạo không áp đặt một phiên bản Python cố định gây lỗi; xác minh cấu hình thu được cho các dự án 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
tooling
Loại issue
Lỗi
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
68/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.