2010-01-12 19 views
21

Cách tiêu chuẩn để viết "thông tin bản quyền" trong mã python là gì? Nó có nên ở bên trong docstring hoặc trong các comment không? Tôi không thể tìm thấy nó trong PEP.Viết thông tin bản quyền trong mã python

+2

Tại sao phải gắn thẻ lại với giấy phép chứ không phải bản quyền? – Kimvais

+0

Bạn đã đúng, đã thay đổi thẻ. –

+0

@lutz: wtf? đó là về phong cách của thông điệp bản quyền trong mã python. không chỉ là một thông báo bản quyền trong python. – SilentGhost

Trả lời

21

Một số dự án sử dụng các biến mô-đun như __license__, như trong:

__author__ = "Software Authors Name" 
__copyright__ = "Copyright (C) 2004 Author Name" 
__license__ = "Public Domain" 
__version__ = "1.0" 

Có vẻ như một giải pháp khá sạch sẽ với tôi (trừ khi bạn lạm dụng nó và đổ các văn bản sử thi vào các biến này), nhưng chỉ __version__ dường như được sử dụng rộng rãi, như được đề cập trong PEP 8.

+0

Khá sạch sẽ, nhưng trong hầu hết các tổ chức, trong khi phân phối lại một phần mềm, bản quyền là rất nhiều văn bản. Mặc dù tôi tự hỏi tại sao nó không được bao gồm trong PEP. – Shefali

+2

Tìm thấy phiên bản được chi tiết hơn tại đây: http://bayes.colorado.edu/PythonGuidelines.html#names – Shefali

+0

@Shefali: liên kết bị hỏng –

12
# Comment in the beginning of the file 

Ít nhất mô-đun tích hợp python thực hiện việc này. (được phát hiện bằng cách thực hiện grep 'Copyright' /usr/lib64/python2.4/*.py)

+0

Bất kỳ con trỏ nào chỉ định cách chính xác? – Shefali

+0

Đó là không có lý do (như là của tôi) -1 :) –

+1

@Shefali đã yêu cầu 'cách tiêu chuẩn để viết "thông tin bản quyền"' không cho dù nó cần thiết để viết thông tin. Đó là lý do tại sao tôi nghĩ rằng downvote của tôi là hợp lý, trong khi của bạn trông giống như một sự trả thù đầy khốc liệt. – Kimvais

3

Chúng tôi làm theo các đề xuất được tìm thấy (ở đâu đó) trên Trung tâm Luật Tự do Phần mềm site. Here là một ví dụ về tệp GPL đơn giản.

+0

Có vẻ như không có hướng dẫn nào được chỉ định cho nó ở bất kỳ đâu trong tài liệu python hoặc PEP, nhưng ký hiệu trên được sử dụng rộng rãi và được chấp nhận. Cảm ơn! – Shefali

+0

@Walter liên kết bị hỏng – Marc

1

Như tôi biết, hiện tại không có cách tiêu chuẩn. Mỗi công ty/tổ chức sẽ có mẫu riêng của họ để ghi lại thông tin bản quyền. Nếu đây là dự án cá nhân của bạn, thì chỉ cần cảm thấy tự do để tài liệu theo cách bạn cảm thấy dễ nhất. Thêm một tệp LICENSE là một cách rất phổ biến cho các dự án có nhiều tệp nguồn. Ngay cả trong Python, hiện tại không có tiêu chuẩn về cấu trúc của docstrings.

Python cung cấp rất nhiều tự do, vì vậy chỉ cần để cho nó được chàng;)

Các vấn đề liên quan