วิธีสร้างการกระจายแหล่งที่มาโดยไม่ใช้ไฟล์ setup.py

ด้วยโครงสร้างแพ็คเกจดังต่อไปนี้

.
├── my_package
│   └── __init__.py
├── setup.cfg
└── setup.py

เนื้อหาของ setup.py

from setuptools import setup
setup()

เนื้อหาของ setup.cfg

[metadata]
name = my_package
version = 0.1

[options]
packages = find:

ฉันสามารถสร้างวงล้อหรือแหล่งแจกจ่ายmy_packageแบบนี้

pip wheel --no-deps -w dist .
# generates file ./dist/my_package-0.1-py3-none-any.whl
python setup.py sdist
# generates file ./dist/my_package-0.1.tar.gz

แต่ตามผู้ดูแลของ setuptoolsการกำหนดค่าการสร้างที่เปิดเผยนั้นเหมาะและการใช้งานที่จำเป็นจะเป็นกลิ่นรหัส ดังนั้นเราจึงแทนที่setup.pyด้วยpyproject.toml:

.
├── my_package
│   └── __init__.py
├── setup.cfg
└── pyproject.toml

เนื้อหาของ pyproject.toml

[build-system]
build-backend = "setuptools.build_meta"
requires = ["setuptools", "wheel"]

และคุณยังสามารถสร้างวงล้อได้เช่นเดียวกับเมื่อก่อนมันใช้งานได้ แต่ sdist ไม่ทำงาน:

python: can't open file 'setup.py': [Errno 2] No such file or directory

ดังนั้นคุณควรสร้างไฟล์. tar.gz โดยใช้ setuptoolsอย่างไร เครื่องมือที่ผู้ใช้สร้างขึ้นเพื่อสร้าง sdist คืออะไร ฉันไม่ต้องการเปลี่ยนการสร้างแบ็กเอนด์ ดูเหมือนว่าเครื่องมือบรรจุภัณฑ์อื่น ๆ ทั้งหมดเขียนจุดเริ่มต้นการสร้างของตัวเอง แต่ฉันคิดว่าจุดทั้งหมดของการกำหนดระบบการสร้างที่ประกาศในเมตาดาต้าคือเพื่อให้คุณไม่ต้องทำมือกับระบบการสร้าง เครื่องมือบรรจุภัณฑ์ที่แตกต่างกันคาดว่าจะถูกเรียกใช้หรือต้องเข้าไปในล่ามและเรียก Python API ด้วยตนเอง แต่ PEP สำหรับการสร้างความต้องการของระบบนั้นมีอายุมากกว่า 2 ปีแล้ว ฉันขาดอะไรบางอย่างชัดเจนที่นี่?

วิธีสร้างการกระจายแหล่งที่มาโดยไม่ใช้setup.pyไฟล์

นี่เป็นหัวข้อที่ถกเถียงกันอยู่และคำตอบสำหรับช่วงเวลานั้นคือไม่มีเครื่องมือเดียวที่ทุกคนเห็นพ้องต้องกันว่าเป็น "วิธีที่ถูกต้อง" ในการสร้างการแจกแจงแหล่งที่มา ท่านสามารถเข้าดูด้ายยาวเกี่ยวกับเรื่องวาทกรรมบรรจุภัณฑ์หลาม

ผมลังเลที่จะให้คำแนะนำในการบรรจุภัณฑ์ที่มากเกินไปในรูปแบบที่มีความทนทานเพราะหาดทรายมักจะขยับ แต่เป็นของเดือนพฤศจิกายน 2019 setup.py sdistจะไม่เลิก แต่ก็ไม่ได้มีข้อเสียทั้งหมดที่ PEP 517 และ PEP 518 มีวัตถุประสงค์เพื่อแก้ไข - คือว่าคุณมี เพื่อสร้างสภาพแวดล้อมการสร้างด้วยตัวเอง (และรู้เกี่ยวกับการสร้างการอ้างอิงทั้งหมด) และใช้งานได้เฉพาะกับ setuptools / distutils และสิ่งที่เทียบเท่า

มันไม่ได้เป็น "ข้าราชการ" คำแนะนำ แต่เปลี่ยนที่ดีที่สุดในปัจจุบันsetup.py sdistและมีการกล่าวอ้างรุ่นบรรทัดคำสั่งของsetup.py bdist_wheel pep517การทดแทนsdistคือ:

python -m pep517.build --source .

คุณสามารถสร้างวงล้อและการกระจายแหล่งที่มาในเวลาเดียวกันโดย:

python -m pep517.build --source --binary .

นี่คือวิธีที่ฉันสร้างแพ็คเกจที่เข้ากันได้กับ PEP 517 ของฉัน

สิ่งนี้ต้องการให้โครงการของคุณมีpyproject.tomlและและpyproject.tomlต้องมีbuild-system.requiresและbuild-system.build-backendกุญแจ แต่จะใช้ได้กับโครงการที่มีแบ็กเอนด์ที่รองรับ PEP 517 (รวมถึงflit)

เครื่องมืออื่น ๆ :

ทำไมไม่ใช้flitหรือpoetryหรือhatch? เครื่องมือเหล่านั้นพร้อมใช้งานสำหรับผู้ที่ต้องการใช้ แต่ไม่ได้รับคำตอบสำหรับคำถามนี้ คำถามนี้ถามเกี่ยวกับโครงการที่สร้างโดยsetuptoolsใช้setup.cfgรูปแบบการประกาศ ทั้งflitมิได้poetryทำหน้าที่เป็น PEP ทั่วไป 517 สร้างปลายด้านหน้าและเพื่อพวกเขาเพียง แต่ทำงานเป็นสร้างคำสั่งสำหรับโครงการที่ใช้แบ็กเอนด์ของตน

ผมพอที่จะไม่คุ้นเคยกับการhatchที่จะพูดหรือไม่ก็สามารถจัดการโครงการที่มีแบ็กเอนด์อื่น ๆกว่า setuptools แต่ (อีกครั้ง ณ พฤศจิกายน 2019) มันเป็นไม่ได้กำลังใจ 517 หน้าและมันจะไม่ทำงานหากคุณไม่ได้มีsetup.py(มันจะยกข้อผิดพลาด "ไม่สามารถเปิดไฟล์ setup.py" และมันจะไม่ใช้ของคุณpyproject.tomlไฟล์)

ไม่มีอะไร "ชัดเจน" เมื่อมันมาถึงบรรจุภัณฑ์ Python อันที่จริงแล้วในขณะนี้อย่างน้อยถ้าคุณใช้ distutils / setuptools คุณจำเป็นต้องสร้างsetup.pyไฟล์เปล่า (เกือบ) แม้ว่าคุณจะใช้การประกาศอย่างสมบูรณ์setup.cfg:

#!/usr/bin/env python
from setuptools import setup
setup()

chmod +x setup.pyผมขอแนะนำ

ในกรณีนี้คุณเพียงแค่เขียน "จุดเริ่มต้น" ไปยังระบบการสร้างด้วยตัวเองและsetup()เป็นเพียงmain()ฟังก์ชั่นสำหรับมัน - แต่ตอนนี้ทุกข้อโต้แย้งที่ผ่านมาแบบดั้งเดิมsetup()สามารถอ่านได้จากsetup.cfgแทน

ตอนนี้คุณยังสามารถใช้งานได้setup.py sdistหากคุณต้องการสร้างแหล่งทาร์บอล:

./setup.py sdist

นอกจากนี้คุณยังสามารถลองหนึ่งในทางเลือกที่สร้างระบบที่มีการใช้งานผ่านทางpyproject.tomlเช่นโผ