rich click

อินเทอร์เฟซบรรทัดคำสั่งที่แสดงผลอย่างสมบูรณ์ในการคลิก

---

เอกสารประกอบ · ซอร์สโค้ด · บันทึกการเปลี่ยนแปลง

---

rich-click เป็นเพียงการเลียนแบบการคลิกที่ช่วยแสดงผลอย่างดีโดยใช้ Rich

• คลิกคือ "แพ็คเกจ Python สำหรับสร้างอินเทอร์เฟซบรรทัดคำสั่งที่สวยงาม"
• Rich คือ "ไลบรารี Python สำหรับข้อความที่หลากหลายและการจัดรูปแบบที่สวยงามในเทอร์มินัล"

จุดประสงค์ของ rich-click คือการมอบเอาต์พุตความช่วยเหลือที่น่าดึงดูดจาก Click ซึ่งจัดรูปแบบด้วย Rich โดยจำเป็นต้องมีการปรับแต่งเพียงเล็กน้อย

คุณสมบัติ

• - การจัดรูปแบบบรรทัดคำสั่งที่หลากหลายสำหรับวิธีใช้การคลิกและข้อความแสดงข้อผิดพลาด
• - API เดียวกับการคลิก: การใช้งานเพียง import rich_click as click
• - สไตล์ที่ดีโดยค่าเริ่มต้น
• เครื่องมือ CLI เพื่อทำงานบนเครื่องมือ ของผู้อื่น (นำหน้าคำสั่งด้วย rich-click )
• - ส่งออกข้อความช่วยเหลือเป็น HTML หรือ SVG
• - จัดกลุ่มคำสั่งและตัวเลือกลงในพาเนลที่มีชื่อ
• ข้อความแสดงข้อผิดพลาดที่จัดรูปแบบอย่างดี
• - เรียงลำดับตัวเลือกและคำสั่งแบบกำหนดเองได้อย่างง่ายดาย
• - ปรับแต่งสไตล์และพฤติกรรมได้อย่างกว้างขวาง

การติดตั้ง

pip install rich-click

อ่านเอกสารสำหรับวิธีการติดตั้งที่รองรับทั้งหมด

ตัวอย่าง

ตัวอย่างง่ายๆ

หากต้องการใช้ 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 :

นำเข้า rich_click เป็นการ click

สลับการนำเข้า click ปกติของคุณด้วย rich_click โดยใช้เนมสเปซเดียวกัน:

 import rich_click as click

แค่นั้นแหละ! จากนั้นจึงใช้ 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

เครื่องมือ CLI rich-click

rich-click มาพร้อมกับเครื่องมือ CLI ที่ให้คุณจัดรูปแบบเอาต์พุตวิธีใช้ Click จากแพ็คเกจ ใด ๆ ที่ใช้ Click

หากต้องการใช้ ให้เติมคำนำหน้า rich-click ให้กับคำสั่งปกติของคุณ ตัวอย่างเช่น หากต้องการรับข้อความช่วยเหลือคลิกที่สมบูรณ์จากแพ็คเกจชื่อ awesometool คุณสามารถเรียกใช้:

$ rich-click awesometool --help

Usage: awesometool [OPTIONS]
..more richified output below.. 

ใบอนุญาต

โครงการนี้ได้รับอนุญาตภายใต้ใบอนุญาต MIT