rich click
v1.8.4
واجهات سطر الأوامر المقدمة بشكل غني بالنقر.
التوثيق · كود المصدر · سجل التغيير
النقر الغني عبارة عن شريط لاصق حول النقر يعرض المساعدة في الإخراج بشكل جيد باستخدام النسق.
الهدف من rich-click هو توفير مخرجات مساعدة جذابة من النقر، بتنسيق منسق، مع الحد الأدنى من التخصيص المطلوب.
import rich_click as clickrich-click )pip install rich-clickاقرأ المستندات للتعرف على جميع طرق التثبيت المدعومة.
لاستخدام النقر المنسق في التعليمات البرمجية الخاصة بك، استبدل import click import rich_click as click في CLI الخاص بالنقر الحالي:
import rich_click as click
@ click . command ()
@ click . option ( "--count" , default = 1 , help = "Number of greetings." )
@ click . option ( "--name" , prompt = "Your name" , help = "The person to greet." )
def hello ( count , name ):
"""Simple program that greets NAME for a total of COUNT times."""
for _ in range ( count ):
click . echo ( f"Hello, { name } !" )
if __name__ == '__main__' :
hello () لقطة شاشة من examples/11_hello.py
لقطة شاشة من examples/03_groups_sorting.py
هذه نظرة عامة سريعة على كيفية استخدام النقر الغني . اقرأ المستندات لمزيد من المعلومات.
هناك طريقتان لبدء استخدام rich-click :
rich_click عند click قم بتبديل استيراد click العادية باستخدام rich_click باستخدام نفس مساحة الاسم:
import rich_click as clickهذا كل شيء! ثم استمر في استخدام النقر كما تفعل عادةً.
راجع
examples/01_simple.pyللحصول على مثال.
إذا كنت تفضل ذلك، يمكنك استخدام RichGroup أو RichCommand مع الوسيطة cls في استخدام النقر الخاص بك بدلاً من ذلك. وهذا يعني أنه يمكنك الاستمرار في استخدام حزمة click غير المعدلة بالتوازي.
import click
from rich_click import RichCommand
@ click . command ( cls = RichCommand )
def main ():
"""My amazing tool does all the things."""راجع
examples/02_declarative.pyللحصول على مثال.
rich-clickيأتي النقر الغني مع أداة CLI التي تسمح لك بتنسيق مخرجات تعليمات Click من أي حزمة تستخدم Click.
للاستخدام، قم بالبادئة rich-click على أمرك العادي. على سبيل المثال، للحصول على نص تعليمات النقر المنسق من حزمة تسمى awesometool ، يمكنك تشغيل:
$ rich-click awesometool --help
Usage: awesometool [OPTIONS]
..more richified output below.. هذا المشروع مرخص بموجب ترخيص MIT.
