Cara Membina Sembang Interaktif untuk Python CLI Anda Menggunakan Introspeksi, Klik dan Pemformatan Kaya

Jika anda pernah mahu menjadikan CLI anda lebih interaktif dan dinamik, membina sistem interaksi arahan masa nyata boleh menjadi jawapannya. Dengan memanfaatkan keupayaan introspeksi Python, Klik untuk mengurus arahan dan Kaya untuk memformat output, anda boleh mencipta CLI yang berkuasa dan fleksibel yang bertindak balas dengan bijak kepada input pengguna. Daripada mengekod keras setiap perintah secara manual, CLI anda boleh menemui dan melaksanakan perintah secara automatik, menjadikan pengalaman pengguna lebih lancar dan lebih menarik.

Kekacauan konsol berwarna-warni: di mana arahan Klik bertemu dengan output Kaya—kerana terminal pun suka menunjuk-nunjuk dalam gaya!

Mengapa Gunakan Klik dan Markdown?

Klik memudahkan pengurusan arahan, penghuraian hujah dan penjanaan bantuan. Ia juga membolehkan penstrukturan arahan dan pengendalian pilihan yang mudah.

Kaya membolehkan anda mengeluarkan Markdown yang diformat dengan cantik terus dalam terminal, menjadikan hasil bukan sahaja berfungsi tetapi juga menarik secara visual.

Dengan menggabungkan kedua-dua perpustakaan ini dengan introspeksi Python, anda boleh membina ciri sembang interaktif yang menemui dan melaksanakan arahan secara dinamik sambil memaparkan output dalam format yang kaya dan boleh dibaca. Untuk contoh praktikal, lihat cara StoryCraftr menggunakan pendekatan serupa untuk menyelaraskan aliran kerja penulisan dipacu AI: https://storycraftr.app.

Membina Sistem Sembang Interaktif

1. Sediakan Perintah Sembang Asas

Arahan sembang memulakan sesi, membolehkan pengguna berinteraksi dengan CLI. Di sini, kami menangkap input pengguna, yang akan dipetakan secara dinamik kepada arahan Klik yang sesuai.

import os
import click
import shlex
from rich.console import Console
from rich.markdown import Markdown

console = Console()

@click.command()
@click.option("--project-path", type=click.Path(), help="Path to the project directory")
def chat(project_path=None):
    """
    Start a chat session with the assistant for the given project.
    """
    if not project_path:
        project_path = os.getcwd()

    console.print(
        f"Starting chat for [bold]{project_path}[/bold]. Type [bold green]exit()[/bold green] to quit."
    )

    # Start the interactive session
    while True:
        user_input = console.input("[bold blue]You:[/bold blue] ")

        # Handle exit
        if user_input.lower() == "exit()":
            console.print("[bold red]Exiting chat...[/bold red]")
            break

        # Call the function to handle command execution
        execute_cli_command(user_input)

2. Introspeksi untuk Menemui dan Melaksanakan Perintah

Menggunakan introspeksi Python, kami menemui arahan yang tersedia secara dinamik dan melaksanakannya. Satu bahagian penting di sini ialah arahan Klik adalah fungsi yang dihias. Untuk melaksanakan logik sebenar, kita perlu memanggil fungsi yang tidak dihias (iaitu, panggilan balik).

Begini cara anda boleh melaksanakan arahan secara dinamik menggunakan introspeksi dan mengendalikan penghias Click:

import os
import click
import shlex
from rich.console import Console
from rich.markdown import Markdown

console = Console()

@click.command()
@click.option("--project-path", type=click.Path(), help="Path to the project directory")
def chat(project_path=None):
    """
    Start a chat session with the assistant for the given project.
    """
    if not project_path:
        project_path = os.getcwd()

    console.print(
        f"Starting chat for [bold]{project_path}[/bold]. Type [bold green]exit()[/bold green] to quit."
    )

    # Start the interactive session
    while True:
        user_input = console.input("[bold blue]You:[/bold blue] ")

        # Handle exit
        if user_input.lower() == "exit()":
            console.print("[bold red]Exiting chat...[/bold red]")
            break

        # Call the function to handle command execution
        execute_cli_command(user_input)

Bagaimana Ini Berfungsi?

• Penghuraian Input: Kami menggunakan shlex.split untuk mengendalikan input seperti argumen baris arahan. Ini memastikan rentetan yang dipetik dan aksara khas diproses dengan betul.
• Modul dan Carian Perintah: Input dibahagikan kepada module_name dan command_name. Nama arahan diproses untuk menggantikan tanda sempang dengan garis bawah untuk dipadankan dengan nama fungsi Python.
• Introspeksi: Kami menggunakan getattr() untuk mengambil fungsi arahan secara dinamik daripada modul. Jika ia adalah arahan Klik (iaitu, mempunyai atribut panggil balik), kami mengakses logik fungsi sebenar dengan menanggalkan penghias Klik.
• Pelaksanaan Perintah: Sebaik sahaja kami mendapatkan semula fungsi yang tidak dihias, kami lulus hujah dan memanggilnya, sama seperti kami menggunakan fungsi Python secara langsung.

3. Contoh Perintah CLI

Mari kita pertimbangkan beberapa contoh arahan dalam modul projek yang pengguna boleh panggil secara interaktif melalui sembang:

import inspect
import your_project_cmd  # Replace with your actual module containing commands

command_modules = {"project": your_project_cmd}  # List your command modules here

def execute_cli_command(user_input):
    """
    Function to execute CLI commands dynamically based on the available modules,
    calling the undecorated function directly.
    """
    try:
        # Use shlex.split to handle quotes and separate arguments correctly
        parts = shlex.split(user_input)
        module_name = parts[0]
        command_name = parts[1].replace("-", "_")  # Replace hyphens with underscores
        command_args = parts[2:]  # Keep the rest of the arguments as a list

        # Check if the module exists in command_modules
        if module_name in command_modules:
            module = command_modules[module_name]

            # Introspection: Get the function by name
            if hasattr(module, command_name):
                cmd_func = getattr(module, command_name)

                # Check if it's a Click command and strip the decorator
                if hasattr(cmd_func, "callback"):
                    # Call the underlying undecorated function
                    cmd_func = cmd_func.callback

                # Check if it's a callable (function)
                if callable(cmd_func):
                    console.print(
                        f"Executing command from module: [bold]{module_name}[/bold]"
                    )

                    # Directly call the function with the argument list
                    cmd_func(*command_args)
                else:
                    console.print(
                        f"[bold red]'{command_name}' is not a valid command[/bold red]"
                    )
            else:
                console.print(
                    f"[bold red]Command '{command_name}' not found in {module_name}[/bold red]"
                )
        else:
            console.print(f"[bold red]Module {module_name} not found[/bold red]")
    except Exception as e:
        console.print(f"[bold red]Error executing command: {str(e)}[/bold red]")

Melaksanakan Antara Muka Sembang

Untuk menjalankan sistem sembang interaktif:

1. Pastikan modul anda (seperti projek) disenaraikan dalam command_modules.
2. Jalankan arahan:

@click.group()
def project():
    """Project management CLI."""
    pass

@project.command()
def init():
    """Initialize a new project."""
    console.print("[bold green]Project initialized![/bold green]")

@project.command()
@click.argument("name")
def create(name):
    """Create a new component in the project."""
    console.print(f"[bold cyan]Component {name} created.[/bold cyan]")

@project.command()
def status():
    """Check the project status."""
    console.print("[bold yellow]All systems operational.[/bold yellow]")

Setelah sesi bermula, pengguna boleh memasukkan arahan seperti:

python your_cli.py chat --project-path /path/to/project

Output akan dipaparkan dalam cara yang diformat dengan baik menggunakan Rich Markdown:

You: project init You: project create "Homepage"

Kesimpulan

Dengan menggabungkan Click for command management, Rich for Markdown formatting dan introspeksi Python, kami boleh membina sistem sembang yang berkuasa dan interaktif untuk CLI. Pendekatan ini membolehkan anda menemui dan melaksanakan perintah secara dinamik sambil mempersembahkan output dalam format yang elegan dan boleh dibaca.

Sorotan Utama:

• Pelaksanaan Perintah Dinamik: Introspeksi membolehkan anda menemui dan menjalankan arahan tanpa mengekodkannya secara keras.
• Keluaran Kaya: Menggunakan Penurunan Berkaya memastikan output mudah dibaca dan menarik secara visual.
• Fleksibiliti: Persediaan ini membolehkan fleksibiliti dalam struktur perintah dan pelaksanaan.

Atas ialah kandungan terperinci Cara Membina Sembang Interaktif untuk Python CLI Anda Menggunakan Introspeksi, Klik dan Pemformatan Kaya. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!