getopt.net - Getopt-ähnliches Argument-Parsing für .net

siycah · 19. Februar 2023, 10:53

Moin zusammen,

Ich stelle heute mein neuestes kleines Projekt vor. Vielleicht findet das in einem eurer Applikationen Verwendung.
Gestartet habe ich das Projekt gestern, da die bereits existierenden Libs entweder nicht cross-plattform-kompatibel waren, oder seit mehreren Jahren outdated sind und z.B. nicht bei mir auf dem Mac liefen.

Da ich hauptsächlich mit C/++ arbeite und viel auf Linux, habe ich diese Funktionalität lieben gelernt und finde dass es sowas auch gerne (gewartet) für dotnet geben sollte.

Name:
getopt.net

Beschreibung:
Diese Lib parst Kommandozeilen-Argumente für dein Programm in einer getopt-ähnlichen Art.
Sprich, anstatt dass man das Argumentparsing immer selber einbaut und ungleiches Verhalten zwischen den Applikationen hat, hat man einen standardisierten Weg, Argumente zu behandeln.

Für alle, die getopt-Argument nicht kennen:

getopt() erlaubt es, kurze Argumente zusammenzufassen und in einem String zu übergeben, sodass Programmaufrufe schneller erledigt sind.
Ein gutes Beispiel ist tar.
tar ist eine Applikation, mit der man Tar-Archive erstellen, entpacken und auch auslesen kann.

Möchte man z.B. ein Tar-Archiv mit Gzip-Komprimierung erstellen, wäre der lange Befehl z.B. so:
tar --gzip --create --verbose --recursive --file=my_tar.tgz <Dateien und Ordner>

Durch die Funktion von getopt, kann man diesen Befehl wie folgt abkürzen:
tar -cvzRf my_tar.tgz <Dateien und Ordner>

Natürlich kann man auch die kurzen Optionen einzeln angeben; ganz wie es einem selber beliebt. Getopt bietet die Möglichkeit.

Dafür gibt man im Programmcode einfach eine ShortOpt-Liste und wahlweise eine Longopt-Liste an.

Die genauen Details findet ihr bei mir im GitHub-Repo: github.com/SimonCahill/getopt.net
oder auf meiner Doku-Seite: docs.simonc.eu/docs/getopt.net

Verwendete Programmiersprache(n) und IDE(s):
C# 11, .net 7.0/6.0/4.6 und Visual Studio [für Mac].
Als Testframework wurde MSTest verwendet; ist ebenfalls im Repo dabei.

Systemanforderungen:
Siehe verwendete Programmiersprachen.

Systemveränderungen:
Es werden keine Systemveränderungen vorgenommen, lediglich eine sehr coole Art von Argument-Parsing deinem Programm bereitgestellt

Download(s):
Downloads sind als .tgz, .zip und Source-Code über mein oben verlinktenes GitHub-Repo verfügbar.
Das Paket ist ebenfalls bei NuGet verfügbar: nuget.org/packages/getopt.net-bsd/

Lizenz/Weitergabe:
Diese Bibliothek ist - im Gegensatz zum Original und einiger Ports mit dem BSD 3-Clause lizensiert und nicht über die GPL.
Ihr dürft die Bibliothek auch kommerziell verwenden, solange ihr die Lizenz zusammen mit der Bibliothek und eurem Programm ausliefert.
Lizenzen eurer Programme sind nicht betroffen; sprich auch closed-source-Applikationen können diese Bibliothek verwenden!

siycah · 27. Februar 2023, 23:32

Hallo zusammen,

Nach ein wenig Feedback von Entwicklern habe ich getopt.net bereits geupdatet und es ist nun in der Version 0.3.1 verfügbar.

Alle Downloadlinks aus dem OP sind weiterhin gültig!

Aktuellste Version bei NuGet: nuget.org/packages/getopt.net-bsd/0.3.1

siycah · 28. Februar 2023, 01:15

Für meine VB-Freunde hier im Forum:

Anbei eine Referenz-Implementierung mit getopt.net.

VB.NET-Quellcode

Option Strict On
Imports System
Imports System.IO
Imports getopt.net
Module Program
Dim _progOptions() As [Option] = {
New [Option]("help", ArgumentType.None, "h"c),
New [Option]("version", ArgumentType.None, "v"c),
New [Option]("file", ArgumentType.Required, "f"c)
}
Dim _progShortOptions As String = "hvf:"
Sub Main(args As String())
Dim getopt = New GetOpt With {
.AppArgs = args,
.Options = _progOptions,
.ShortOpts = _progShortOptions
}
Dim optChar = 0
Dim optArg As String = Nothing
Dim fileToRead As String = Nothing
While optChar <> -1
optChar = getopt.GetNextOpt(optArg)
Select Case optChar
Case Convert.ToInt32("h"c) ' this is a god awful syntax.
PrintHelp()
Return
Case Convert.ToInt32("v"c)
PrintVersion()
Return
Case Convert.ToInt32("f"c)
If optArg Is Nothing Then
Console.Error.WriteLine("Missing input file!")
Environment.ExitCode = 1
Return
End If
fileToRead = optArg
End Select
End While
If (fileToRead Is Nothing) Then
Console.Error.WriteLine("Nothing to read. Exiting...")
Environment.ExitCode = 1
Return
End If
If Not File.Exists(fileToRead) Then
Console.Error.WriteLine("The file " & fileToRead & " doesn't exist!")
Environment.ExitCode = 2
Return
End If
Console.WriteLine("Got file: " & fileToRead)
Console.WriteLine(File.ReadAllText(fileToRead))
End Sub
Sub PrintHelp()
Console.WriteLine("
myapp (VB) v1.0.0
Displays the usage of getopt.net in VB
Usage:
myapp [-h] [-v]
myapp -f/path/to/file
myapp -f /path/to/file
myapp --file=/path/to/file
myapp --file /path/to/file
Arguments:
--help, -h Displays this text and exits
--version, -v Displays the version and exits
--file=[file], -f Reads a file and outputs its contents
")
End Sub
Sub PrintVersion()
Console.WriteLine("myapp (VB) v1.0.0")
End Sub
End Module

Weitere Details: github.com/SimonCahill/getopt.…0/getopt.net.reference.vb

siycah · 5. März 2023, 20:51

Es ist eine neue Version von getopt.net verfügbar!

Seit dem letzten Update (im Forum!) haben sich folgende Änderungen ergeben:

Flag-Eigenschaft wurde rausgeschmissen
Windows-Style Argumente werden nun auch unterstützt
Es wurde eine neue Eigenschaft AllExceptionsDisabled eingeführt, welche das Ein-/Ausschalten aller Exceptions verwaltet.

Downloads weiterhin über NuGet: nuget.org/packages/getopt.net-bsd/
Oder direkt aus dem Repository: github.com/SimonCahill/getopt.net

siycah · 5. April 2023, 23:44

Hallo zusammen,

Vor einigen Tagen habe ich die Version 0.6.0 von getopt.net veröffentlicht!

Änderungen in diesem Release:

Unterstützung von optionalen Argumenten in den ShortOpts.

Erklärung:
Sowohl GNU- als auch POSIX-kompatible getopt-Implementierungen erlauben die Verwendung von reinen Short-Opts.
Dieser String ist dann wie folgt aufgebaut: Ein Zeichen (A-z0-9 & Sonderzeichen) und wahlweise ein Modifier.
Dieser Modifier kann entweder ein Doppelpunkt (:) sein, was dann bedeutet, dass ein Argument für die Option zwingend notwendig ist;
alternativ kann dieser Modifier auch (und getopt.net unterstützt dies seit v0.6.0) ein Semikolon (;) sein. Ein Semikolon bedeutet, dass ein Argument optional auch zu dieser Option gegeben werden kann.

Ein ShortOpt-String mit einer Option 'h' ohne Argument, eine Option 'C' mit optionalem Argument und einer Option 'i' mit notwendigem Argument würde bspw. so aussehen: "hC;i:"

Nachwievor unterstützt getopt.net auch die anderen Konstellationen. Optionen und ihre Argumente können wild durcheinander gewürfelt werden: "hvc;C:f:pklq;tmyj:".

Heruntergeladen werden kann das Paket nachwievor über NuGet, oder direkt bei GitHub.

Bei Fragen oder Anregungen gerne hier im Faden eine Antwort erstellen, oder bei GitHub ein Issue erstellen!

siycah · 19. April 2023, 23:39

Hallo zusammen,

Soeben wurde Version 0.7.0 von getopt.net veröffentlich!

Dieses Release ist ein relativ kleines und bringt keine Breaking-Changes!

Änderungen in diesem Release:

Unterstützung für Powershell Argumente
- Powershell-Argumente verwenden einen einzelnen Bindestrich für lange und kurze Options (-lang -K)
- Der Support ist standardmäßig deaktiviert
- Um Support zu aktivieren, muss AllowPowershellConventions = true gesetzt werden
- Es werden auch Powershell-Options mit Windows-ähnlichen Argumenten -myopt:argument unterstützt, allerdings muss hierfür ebenfalls AllowWindowsConventions = true gesetzt werden.

Download:
Das Paket ist ab sofort bei Nuget und bei GitHub zum Download verfügbar!

Da es sich hierbei um eine relativ kleine Änderung/Erneuerung handelt, wurde die Referenz-Implementierung nicht angepasst.

Bei Fragen, Anmerkungen oder Feature-Requests gerne hier im Forum oder (noch besser) bei GitHub ein Issue erstellen!

Frohes Parsen!

siycah · 22. April 2023, 17:10

Version 0.8.0 von getopt.net ist veröffentlicht!

Version 0.8.0 bringt ein neues Feature mit, für Anwendungen mit vielen und/oder komplexen Argumenten/Optionen.

Speziell bringt 0.8.0 Unterstützung für "paramfiles", diese sind Dateien, welches mit folgender Syntax an eure Programme übergeben werden können: @/path/to/file.
Diese Dateien enthalten pro Zeile Argumente, die man ebenfalls an getopt.net/dem Programm übergeben werden.

Das heißt konkret, jede Zeile kann entweder mehrere Kurzoptionen halten, oder ein Option mit Argument.

Diese Version ist ab sofort bei NuGet und GitHub verfügbar.

siycah · 6. Oktober 2023, 08:42

Hallo zusammen!

Vor einigen Tagen wurde die neueste Version von getopt.net veröffentlicht.

Version 0.9.0 beinhaltet einen Non-Breaking-Change, der Paramfiles betrifft:

Kommentare werden nun in Paramfiles unterstützt
Kommentare müssen am Beginn der Zeile mit einer Raute (#) als Präfix stehen

Die Version ist ab sofort bei GitHub und NuGet verfügbar.

siycah · 22. Dezember 2023, 19:56

Hallo zusammen,

Heute wurde eine neue Version von getopt.net veröffentlicht; Version 0.9.1.

Dieses Update enthält ein kleines QoL Update und ein Paket für .net8.

Version 0.9.1 beinhaltet folgende Änderungen:

.net8 Pakete
Neue Extension-Methode um Option[] in ein Shortopt-String zu wandeln.

Die Version ist ab sofort bei GitHub und NuGet verfügbar.

getopt.net - Getopt-ähnliches Argument-Parsing für .net

getopt.net - Getopt-ähnliches Argument-Parsing für .net

Update v0.3.1

VB.NET-Quellcode

Version 0.5.1

Version 0.6.0

Version 0.7.0

Version 0.8.0

Version 0.9.0

Version 0.9.1

Benutzer online 1

Tags

Ähnliche Themen

1 Benutzer hat hier geschrieben