تحميل cookie - تنزيل رمز مصدر cookie

cookie

كود الذكاء الاصطناعي

2024.08.19

تنزيل

Python العلمي: دليل ، ملف تعريف الارتباط ، و SP-Repo-Review

ملف تعريف الارتباط

قالب COPIER/CookieCutter لمشاريع Python الجديدة بناءً على دليل مطور Python العلمي. ما الذي يجعل هذا مختلفًا عن القوالب الأخرى لحزم بيثون؟

يعيش مع دليل تطوير العلمي بينثون: يتم توثيق كل قرار بوضوح وكل أداة موصوفة ، ويتم الحفاظ على كل شيء متزامن.
تسع مباريات مختلفة للاختيار من بينها لبناء الحزم.
إصدار VCS اختياري لمعظم الخلايا.
تم اختبار جيل القالب في إجراءات GitHub باستخدام أكاسيد النيتروجين.
يدعم التوليد مع COPIER و CookieCutter و Cruft.
يدعم إجراءات github إذا استهدف عنوان URL github.com (الافتراضي) ، ويضيف دعم Gitlab CI التجريبي خلاف ذلك.
يتضمن العديد من الخلفية المترجمة باستخدام Pybind11 ، مع إنتاج عجلات لجميع المنصات باستخدام cibuildwheel.
يوفر sp-repo-review لتقييم إعادة التدوينات الحالية مقابل الإرشادات ، مع إصدار نسخة ويب مع الدليل. جميع الشيكات مترابطة.
يتبع أفضل الممارسات PYPA وتحديثها بانتظام.

تأكد من أنك قد قرأت دليل تطوير Python العلمي أولاً ، وربما استخدمتها في مشروع أو اثنين. هذا ليس مثالًا أو تعليميًا أدنى. إنها مجموعة من الأدوات المفيدة لبدء مشروع جديد باستخدام cookieCutter ، أو للنسخ في الملفات الفردية لمشروع موجود (باليد ، من {{cookiecutter.project_name}}/ ).

أثناء الجيل ، يمكنك الاختيار من بين الخلفية التالية للحزمة الخاصة بك:

Hatch: يستخدم هذا Hatchling ، وهو منشئ حديث مع إدراج ملف لطيف ، قابل للتمديد عبر الإضافات ، ورسائل خطأ جيدة. (موصى بها لمشاريع بيثون النقية)
FLIT: نظام بناء حديث خفيف الوزن PEP 621 لمشاريع بيثون النقية. يحل محل setuptools ، لا ansherest.in ، setup.py ، أو setup.cfg. منحنى التعلم المنخفض. من السهل bootstrap في توزيعات جديدة. من الصعب الحصول على الملفات المناسبة ، ودعم بيانات التعريف الديناميكية الصغيرة.
PDM: حل حديث وأقل رأيًا للجميع لمشاريع Python الخالصة التي تدعم المعايير. يحل محل setuptools و venv/pipenv و pip و wheel و twine. يدعم PEP 621.
الشعر: حل الكل في واحد لمشاريع بيثون النقية. يحل محل setuptools و venv/pipenv و pip و wheel و twine. منحنى التعلم العالي ، ولكنه الكل في واحد. يجعل بعض الافتراضات الافتراضية السيئة للمكتبات. الوحيدة مع تكوين pyroject.toml غير القياسي.
setuptools: نظام الإنشاء الكلاسيكي ، ولكن مع التكوين الموحد الجديد.
Pybind11: هذا هو setuptools ولكن مع امتداد C ++ مكتوب في pybind11 والعجلات التي تم إنشاؤها بواسطة cibuildwheel.
Scikit-Build: مشروع Scikit-Build (Cmake) يستخدم أيضًا Pybind11 ، باستخدام Scikit-Build-Core. (موصى به لمشاريع C ++)
Meson-Python: مشروع Meson أيضًا باستخدام Pybind11. (لا يوجد إصدار VCS)
Maturin: منشئ PEP 621 للملحقات الثنائية الصدأ. (لا يوجد إصدار VCS) (موصى به لمشاريع الصدأ)

حاليًا ، من المحتمل أن يكون الخيار الأفضل هو تفريخ مشاريع Python Pure ، وبناء Scikit (مثل اختيار Scikit-Build-Core + Pybind11) للمشاريع الثنائية.

لاستخدام (نسخة ناسخة حديثة)

تثبيت copier و copier-templates-extensions . باستخدام PIPX ، هذا:

pipx install copier
pipx inject copier copier-templates-extensions

الآن ، قم بتشغيل COLIER لإنشاء مشروعك:

copier copy gh:scientific-python/cookie < pkg > --trust

( <pkg> هو الطريق لوضع المشروع الجديد. إذا كان النسخ قديمًا ، فاستخدم --UNSAFE بدلاً من --trust )

ستحصل على تجربة CLI أجمل مع التحقق من الإجابة. ستحصل أيضًا على ملف .copier-answers.yml ، والذي سيسمح لك بإجراء التحديثات في المستقبل.

ملاحظة: إضافة- --vcs-ref=HEAD للحصول على أحدث إصدار بدلاً من الإصدار الأخير الموسومة ؛ يمر الرأس دائمًا الاختبارات (وهو ما يستخدمه CookieCutter).

للاستخدام (نسخة CookieCutter الكلاسيكية)

قم بتثبيت cookieCutter ، من الناحية المثالية مع brew install cookiecutter إذا كنت تستخدم Brew ، وإلا مع pipx install cookiecutter (أو إعداد pipx run إلى الأمر أدناه ، وتخطي التثبيت). ثم قم بالتشغيل:

cookiecutter gh:scientific-python/cookie

إذا كنت تستخدم CookieCutter 2.2.3+ ، فستحصل على أوصاف لطيفة للخيارات مثل Copier!

لاستخدام (إصدار Cruft الكلاسيكي)

يمكنك أيضًا استخدام Cruft ، والذي يضيف تحديث القدرة إلى مشاريع CookieCutter. قم بالتثبيت باستخدام pipx install cruft (أو تشغيل Pipx pipx run إلى الأمر أدناه ، وتخطي التثبيت). ثم قم بالتشغيل:

cruft create gh:scientific-python/cookie

بعد الجيل

تحقق من ملفات إعداد المفاتيح ، pyproject.toml ، وربما setup.cfg و setup.py (مثال pybind11). تحديث README.md . أيضا تحديث وإضافة مستندات إلى docs/ .

هناك بعض الأمثلة على التبعيات وإصدار Python الحد الأدنى من 3.9 ، لا تتردد في تغييره إلى كل ما تحتاجه/تريده بالفعل. هناك أيضًا بنية عوامل خلفية أساسية مع مثال على الكتابة الصغيرة.

مكونات تحتوي على:

إجراءات GitHub تعمل على اختبار الجيل نفسه
- يستخدم أكاسيد النيتروجين بحيث يمكن فحص تطور ملفات تعريف الارتباط محليًا
تصرفات github نشر
- تشمل الخلايا الخلفية C ++ cibuildwheel لبناء العجلات
- يستخدم نشر الناشر الموثوق به PYPI
تعتمد على الإجراءات المحدثة بشكل دوري ، من خلال طلبات السحب المفيدة
التنسيق الذي يتم التعامل معه بواسطة اللجنة المسبقة
- لا يوجد سبب لعدم أن تكون صارمًا في مشروع جديد ؛ أزل ما لا تريده.
- يتضمن كتابة mypy - ثابتة
- يتضمن Ruff - التنسيق القياسي ، linting و autofixes
  - يحل محل Flake8 و Isort و Pyupgrade و Yesqa و Pycln وعشرات الإضافات
- يتضمن التحقق الإملائي
يمكن استخدام هدف Pylint Nox لتشغيل Pylint ، والذي تم دمج تعليقات GHA المدمجة
مجلد مستندات SPHINX جاهز لـ REATTHEDOCS و [docs] إضافية
مجلد اختبار واختبار [test] إضافي
يتم تضمين Noxfile مع بعض الأهداف الشائعة

للمطورين:

يمكنك الاختبار محليًا باستخدام أكاسيد النيتروجين:

# See all commands
nox -l

# Run a specific check
nox -s "lint(scikit-build)"

# Run a noxfile command on the project noxfile
nox -s "nox(hatch)" -- docs

إذا لم يكن لديك nox محليًا ، فيمكنك استخدام PIPX ، مثل pipx run nox بدلاً من ذلك.

مشاريع أخرى مماثلة

يعد Hypermodern-Python مشروعًا آخر يستحق التحقق من العديد من أوجه التشابه ، مثل الوثائق الرائعة لكل ميزة والعديد من نفس الأدوات المستخدمة. إنه يحتوي على مجموعة مختلفة قليلاً من الميزات ، ولديه تركيز أقوى على إجراءات GitHub - يمكن تكييف معظم دليلنا مع نظام CI مختلف بسهولة إلى حد ما إذا كنت لا ترغب في استخدام GHA. كما أنه يفرض استخدام الشعر (بدلاً من اختيار الخلفية) ، ولا يدعم المشاريع المترجمة. وهي تتفق حاليًا على جميع تبعيات التنمية في بيئة مشتركة ، مما يسبب أوقات حل طويلة وفرصة عالية للصراعات. كما أنه لا يستخدم مسبقًا بالطريقة التي كان المقصود منها استخدامها. كما أن لديها القليل من التعليمات البرمجية المخصصة.

تاريخ

بدأ الكثير من الدليل و CookieCutter و Respo-Review كجزء من Scikit-Hep. تم دمج هذه المشاريع وتعميمها ودمجها مع دليل NSLS-II خلال قمة مطوري Python العلمي 2023.

SP-Repo-Review

يوفر sp-repo-review شيكات بناءً على دليل تطوير العلمي في Python في Scientific-Python/Cookie لإعادة مراجعة.

يمكن لهذه الأداة التحقق من نمط المستودع. استخدم مثل هذا:

pipx run ' sp-repo-review[cli] ' < path to repository >

سيؤدي ذلك إلى إنتاج قائمة بالنتائج - علامات الفحص الخضراء تعني أن هذه القاعدة تتبع ، يعني Red X أن القاعدة ليست كذلك. علامة تحذير صفراء تعني أن الشيك قد تم تخطيه بسبب فشل فحص سابق مطلوب. ستفشل بعض الشيكات ، لا بأس - الهدف هو لفت انتباهك إلى جميع المشكلات الممكنة ، وليس لفرض الامتثال للشيكات التعسفية. في النهاية قد يكون هناك وسيلة لوضع علامة على الشيكات كما تم تجاهلها.

على سبيل المثال ، يتوقع GH101 أن يكون لجميع ملفات الإجراء الخاصة بك name: الحقل. إذا كنت راضيًا عن الأسماء المستندة إلى الملفات التي تراها في CI ، فيجب أن تتردد في تجاهل هذا الشيك ببساطة (فقط تجاهله في الوقت الحالي ، فمن المحتمل أن تتم إضافة شيكات تم تجاهلها في النهاية).

يتم ذكر جميع الشيكات على الأقل بطريقة ما في دليل تطوير Python العلمي. يجب أن تقرأ ذلك أولاً - إذا كنت لا تحاول متابعتها ، فقد لا تعمل بعض الشيكات. على سبيل المثال ، تحدد الإرشادات تكوين Pytest في pyproject.toml . إذا قمت بوضعه في مكان آخر ، فسيتم تخطي جميع الشيكات Pytest.

تم تطوير هذا في الأصل لـ Scikit-Hep قبل الانتقال إلى Python العلمي.

طرق أخرى للاستخدام

يمكنك أيضًا استخدام تصرفات github:

- uses : scientific-python/cookie@<version>

أو ما قبل الالتزام:

- repo : https://github.com/scientific-python/cookie
  rev : <version>
  hooks :
    - id : sp-repo-review

إذا كنت تستخدم additional_dependencies لإضافة المزيد من المكونات الإضافية ، مثل validate-pyproject ، فيجب عليك أيضًا تضمين "repo-review[cli]" لضمان تضمين متطلبات CLI.