Heim  >  Artikel  >  Backend-Entwicklung  >  Wonders with Click: Optimieren Sie Ihr CLI-Erlebnis

Wonders with Click: Optimieren Sie Ihr CLI-Erlebnis

Mary-Kate Olsen
Mary-Kate OlsenOriginal
2024-10-25 09:28:28202Durchsuche

Einführung

In diesem Blog werden wir uns mit den faszinierenden Dimensionen von Click befassen, einer Python-Bibliothek, die Ihre CLI-Leistung und -Reichweite optimieren kann. Wir werden die Konzepte besprechen, die zum Erstellen einer einfachen und kompakten CLI erforderlich sind. Dieser Blog würde Ihnen helfen, zu produzieren und zu organisieren? bessere CLI für Ihre Kunden?.

Wonders with Click: Streamline your CLI Experience

Was ist Click überhaupt?

Click ist ein Python-Paket ? Das hilft einem, die Entwicklung seines CLI-Dienstprogramms zu beschleunigen. Dieses Paket stellt im Vergleich zu anderen Python-Paketen eine einfachere Option zur Entwicklung von Befehlszeilenschnittstellen dar. Es ist eine bessere Option, da es minimale Codierung erfordert und über viele integrierte Funktionen verfügt, die die Entwicklungsfunktionen optimieren.

Die Grundlagen von Click beherrschen

Installation:

Zum Installieren klicken Sie auf den folgenden Befehl.

pip install click

Codierung:

Erstellen Sie zunächst eine Datei mit dem Namen main.py und öffnen Sie die Datei mit Ihrem bevorzugten Code-Editor/Ihrer bevorzugten Code-IDE. Veranlassen Sie nun den folgenden Codeausschnitt, um ein einfaches CLI-Tool zu erstellen? in main.py

import click

@click.command()
def say_hello():
  click.echo("Hello Bob")

# runs when the file is run directly and not imported
if __name__ == "__main__": 
  say_hello()

Hier verwenden wir den @click.command-Dekorator, um der Funktion einige weitere Funktionen zu geben, damit sie für einen CLI-Befehl geeignet ist (z. B. Commit, Merge, Init usw. in Git). Und click.echo ist eine angepasste Version der Python-Druckfunktion, die den Anforderungen von click.

entspricht

mehrere Befehle haben

import click

@click.group()
def cli():
  pass

@click.command()
@click.option('--name', prompt='Your name',
              help='The person to greet.')
def say_hello(name):
  click.echo(f'Hello {name}!')

@click.command()
@click.option('--name', prompt='Your name',
              help='The person to greet.')
def say_bye(name):
  click.echo(f'Goodbye {name}!')

@click.command()
@click.option('--num', prompt='Enter a number',type=int ,
              help='The person to greet.')
def give_square(num):
  click.echo(num*num)


# Registering the commands with the CLI
cli.add_command(say_hello)
cli.add_command(say_bye)
cli.add_command(give_square)


if __name__ == "__main__": 
  cli()

Der @click.option-Dekorator wandelt die Funktion in einen Befehl mit der Fähigkeit um, einen optionalen Wert anzunehmen.

Um dieses Snippet zu verwenden, führen Sie den folgenden Befehl im Terminal aus:

python main.py say_hello --name=Kris

mit Argumenten arbeiten

import click

@click.command()
@click.argument('name')
def say_hello(name):
  click.echo(f"Hello {name}")

# runs when the file is run directly and not imported
if __name__ == "__main__": 
  say_hello()

Der @click.argument-Dekorator wandelt die Funktion in einen Befehl um, der ein Argument annehmen kann, das bereitgestellt werden muss und von der CLI benötigt wird.

Um dieses Code-Snippet zu verwenden, führen Sie den folgenden Befehl im Terminal aus:

python main.py bob

Abschluss

Klick macht das Erstellen von Befehlszeilenschnittstellen in Python einfach und intuitiv. Mit der Unterstützung mehrerer Befehle, Optionen und Argumente ist es ein leistungsstarkes Tool, das von einfachen bis hin zu komplexen Anwendungsfällen skaliert werden kann.

Kurzgesagt:

  • Befehlsgruppen ermöglichen Ihnen die Organisation mehrerer Befehle.
  • Befehle definieren die Aktionen, die Ihre CLI ausführen wird.
  • Optionen und Argumente ermöglichen Benutzereingaben, um das Befehlsverhalten anzupassen.

Beginnen Sie mit Click für Ihr nächstes Python-Experiment
Projekt und sehen Sie, wie einfach es ist, benutzerfreundliche CLI-Tools zu erstellen!

Das obige ist der detaillierte Inhalt vonWonders with Click: Optimieren Sie Ihr CLI-Erlebnis. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Stellungnahme:
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn