Best Practices für das Parsing von Kwargs in Python

Zeeshan Afridi 21 Juni 2023
  1. kwargs in Python
  2. Verwenden Sie kwargs in Python
  3. Methoden für das kwargs-Parsing in Python
  4. Abschluss
Best Practices für das Parsing von Kwargs in Python

Unter Verwendung von kwargs-Parsing kann ein Entwickler die notwendigen Informationen leicht aus einer Gruppe von Schlüsselwörtern und Argumenten extrahieren. Dies wird häufig verwendet, wenn ein Entwickler eine Reihe von Optionen oder Einstellungen angeben möchte.

Dies sind die drei Methoden des kwargs-Parsings:

  1. Durch die Verwendung der eingebauten Funktion vars().
  2. Durch Verwendung des Operators **.
  3. Mit der Methode get().

kwargs in Python

Python kwargs ist ein Schlüsselwortargument, mit dem wir eine variable Anzahl von Schlüsselwortargumenten an eine Funktion übergeben können. Die Keyword-Ideen werden als Dictionary an die Funktion übergeben.

Im Folgenden finden Sie einige Best Practices, die Sie bei der Verwendung von Schlüsselwortargumenten (kwargs) in Python beachten sollten.

  1. Erstens sollten kwargs sparsam und nur bei Bedarf verwendet werden.
  2. Zweitens sollten kwargs wann immer möglich in Verbindung mit Positionsargumenten (args) verwendet werden.
  3. Drittens sollten kwargs explizit und gut dokumentiert sein.

Bei richtiger Anwendung kann kwargs die Lesbarkeit und Wartbarkeit Ihres Python-Codes verbessern; Bei exzessivem Gebrauch oder ohne angemessene Dokumentation kann kwargs Ihren Code jedoch schwer verständlich machen. Seien Sie im Zweifelsfall vorsichtig und verwenden Sie args statt kwargs.

Verwenden Sie kwargs in Python

Python kwargs sind ein leistungsstarkes Werkzeug zum Erstellen flexibler Funktionen und Methoden, mit denen Sie eine beliebige Anzahl von Schlüsselwortargumenten an eine Funktion oder Methode übergeben können. kwargs werden oft verwendet, um Standardwerte für Funktionsargumente festzulegen.

Um kwargs in Ihren Funktionen und Methoden zu verwenden, fügen Sie das Schlüsselwort **kwargs zur Parameterliste hinzu. Anschließend können Sie mithilfe der Wörterbuchsyntax auf die Schlüsselwortargumente zugreifen.

Wenn Sie beispielsweise eine Funktion haben, die zwei Schlüsselwortargumente akzeptiert, können Sie wie folgt darauf zugreifen:

def my_func(**kwargs):
    arg1 = kwargs["arg1"]
    arg2 = kwargs["arg2"]

Sie können auch kwargs verwenden, um Standardwerte für Funktionsargumente festzulegen. Wenn Sie beispielsweise eine Funktion haben, die ein optionales Schlüsselwortargument akzeptiert, können Sie einen Standardwert wie diesen festlegen:

def my_func(**kwargs):
    arg1 = kwargs.get("arg1", "default_value")

Diese Funktion setzt arg1 auf default_value, wenn das Schlüsselwortargument arg1 nicht an die Funktion übergeben wird.

kwargs sind ein mächtiges Werkzeug zum Erstellen flexibler Funktionen und Methoden. Sie können Ihren Code lesbarer und einfacher zu warten machen.

Methoden für das kwargs-Parsing in Python

Es gibt viele Möglichkeiten, kwargs in Python zu parsen, aber nicht alle sind Best Practices. Beim Analysieren von kwargs ist es wichtig, bei der Typumwandlung und der Verwendung von Nur-Schlüsselwort-Argumenten vorsichtig zu sein, um Verwirrung zu vermeiden.

kwargs Parsing durch den **-Operator in Python

Eine andere Möglichkeit, kwargs zu parsen, ist die Verwendung des **-Operators. Dieser Operator entpackt ein Wörterbuch in Schlüsselwortargumente.

Diese Methode ist expliziter als die Verwendung von vars() und kann helfen, potenzielle Typumwandlungsfehler zu vermeiden.

def intro(**data):

    for key, value in data.items():
        print("{} is {}".format(key, value))


intro(Firstname="Zeeshan", Lastname="Afridi", Age=24)
print("\n")
intro(
    Firstname="Zeeshan",
    Lastname="Afridi",
    Email="zeeshan.afridi@example.com",
    Country="Pakistan",
    Age=24,
    Phone=+923331234567,
)

Ausgang:

Firstname is Zeeshan
Lastname is Afridi
Age is 24


Firstname is Zeeshan
Lastname is Afridi
Email is zeeshan.afridi@example.com
Country is Pakistan
Age is 24
Phone is 923331234567

kwargs Parsing mit der get() Methode in Python

Der beste Weg, kwargs zu parsen, ist die Verwendung der get()-Methode des Wörterbuchs. Mit dieser Methode können Sie einen Standardwert für jedes kwarg angeben, was dazu beitragen kann, Typumwandlungsfehler zu vermeiden.

Zusätzlich macht die get()-Methode Ihren Code lesbarer und leichter verständlich.

Beispielcode:

from uuid import uuid4


def my_function(**kwargs):

    name = kwargs.get("name", None)
    age = kwargs.get("age", None)

    print(f"Name {name} \nAge  {age}")


my_function(name="Zeeshan", age=24)

Ausgang:

Name Zeeshan
Age  24

kwargs Parsing mit der vars() Funktion in Python

Eine gängige Methode zum Analysieren von kwargs ist die Verwendung der eingebauten Funktion vars(). Diese Funktion gibt ein Wörterbuch aller an eine Funktion übergebenen Argumente zurück, einschließlich kwargs.

Diese Methode ist zwar schnell und einfach, kann aber zu Problemen führen, wenn die kwargs nicht explizit als Nur-Schlüsselwort-Argumente angegeben werden.

Beispielcode:

def test_var_kwargs(farg, **kwargs):
    print("formal arg:", farg)
    for key in kwargs:
        print("keyword arg: %s: %s" % (key, kwargs[key]))


test_var_kwargs(farg=1, myarg2=2, myarg3=3)

Ausgang:

formal arg: 1
keyword arg: myarg2: 2
keyword arg: myarg3: 3

Abschluss

Mit kwargs können wir Funktionen schreiben, die eine beliebige Anzahl von Schlüsselwortargumenten annehmen. Dies kann nützlich sein, wenn wir eine flexible Schnittstelle zu einer Funktion bereitstellen möchten.

Beispielsweise möchten wir möglicherweise eine Funktion schreiben, die eine Nachricht in einer Datei protokolliert. Möglicherweise möchten wir in der Lage sein, die Protokollebene und die zu protokollierende Nachricht anzugeben.

Mit kwargs können wir eine Funktion schreiben, die diese Argumente als Schlüsselwortargumente verwendet.

Zeeshan Afridi avatar Zeeshan Afridi avatar

Zeeshan is a detail oriented software engineer that helps companies and individuals make their lives and easier with software solutions.

LinkedIn