Het gebruik van *args- en **kwargs-parameters in je code: een Python 3-tutorial

Introductie

Python is een van de meest populaire programmeertalen ter wereld. In Python maken parameters deel uit van functiedefinities. Ze stellen je in staat om bepaalde argumenten voor een functie te specificeren. Het argument kan door de functie worden geaccepteerd en toegepast.

Het is echter niet mogelijk om op het moment van coderen te weten welke exacte use cases met je code zullen worden geïmplementeerd. Daarom is het, in het belang van toekomstige programmeurs en gebruikers van je programma, raadzaam om een variabel aantal argumenten aan een functie door te geven. Om dit te doen, moet je speciale parameters gebruiken. Dit zijn *args en **kwargs. In deze handleiding zullen we alles leren over de *args en **kwargs parameters in Python. We zullen ook leren hoe we argumenten kunnen ordenen en hoe we deze kunnen toepassen in functie-aanroepen.

Vereisten

Om de stappen in de handleiding te kunnen volgen, zijn er enkele vereisten die je moet voorbereiden. Ten eerste moet je Python 3 geïnstalleerd hebben op je server met een actieve programmeeromgeving. Je moet ook het programma voor jouw specifieke besturingssysteem geïnstalleerd hebben (Ubuntu, CentOS, Debian, etc).

Wat is *args en hoe werkt het?

Laten we beginnen met te begrijpen hoe *args werkt. De versie van de parameter met een enkele asterisk wordt gebruikt om argumentenlijsten van variabele lengte zonder trefwoorden naar functies te sturen. Houd er rekening mee dat de asterisk het meest cruciale element in die parameter is.

Om dit beter te begrijpen, bekijken we een voorbeeld. Hieronder staat een typische functie die je in je code kunt tegenkomen, met twee argumenten:

Zoals je kunt zien, zijn onze argumenten in de bovenstaande functie x en y. Wanneer je de functie aanroept, gebruik je getallen die overeenkomen met x en y. Laten we zeggen dat we de gehele getallen 5 en 4 voor x en y respectievelijk doorgeven:

Nu kunnen we de code uitvoeren:

De uitvoer die we zullen ontvangen is als volgt:

De uitvoer laat zien dat de gehele getallen 5 en 4 zijn vermenigvuldigd. Dit betekent dat de multiply(x, y) functie werkte.

Stel nu dat we uiteindelijk drie getallen willen vermenigvuldigen in plaats van slechts twee. Helaas zal het toevoegen van een extra getal aan de bovenstaande functie een foutmelding als deze opleveren:

Daarom, als je het vermoeden hebt dat je later mogelijk meer argumenten moet toevoegen, pas dan de *args parameter toe voor je gemak. Je kunt het als volgt gebruiken:

We hebben simpelweg de functieparameters x en y vervangen door *args. Het uitvoeren van deze code geeft je het product voor elke afzonderlijke functie-aanroep, zoals hier:

Daarom is *args ideaal om te gebruiken wanneer je argumentenlijsten van variabele lengte naar je functie wilt sturen. Dankzij deze mogelijkheid kun je zoveel argumenten aan functie-aanroepen doorgeven als je wilt. Als zodanig stelt deze parameter je in staat om flexibelere code te bouwen die een flink aantal variabele argumenten zonder trefwoorden in de functie kan accepteren.

Wat is **kwargs en hoe werkt het?

Vervolgens hebben we de versie van de parameters met een dubbele asterisk, namelijk **kwargs. In tegenstelling tot de vorige vorm stelt deze parameter je in staat om dictionaries met argumenten van variabele lengte met trefwoorden aan de functie door te geven. Vergelijkbaar met *args, de dubbele sterretjes zijn het meest cruciale element van de parameter.

Net als in de vorige sectie kun je zoveel argumenten toevoegen als je wilt. Het verschil is dat je trefwoorden moet toewijzen. Om dit beter te begrijpen, bekijken we het volgende voorbeeld. Hier beginnen we met het uitprinten van de **kwargs argumenten die we aan de functie willen doorgeven:

Laten we nu de functie aanroepen. Zoals je kunt zien, hebben we trefwoordargumenten toegevoegd:

Als je het programma op dit punt uitvoert, zie je deze uitvoer:

Het is echter mogelijk dat je dictionary-datatype ongeordend is. Dit hangt grotendeels af van de versie van Python 3 die je gebruikt. Elke versie na Python 3.6 geeft je bijvoorbeeld de sleutel-waarde-paren op volgorde. Elke eerdere versie toont de uitvoer in willekeurige volgorde. De dictionary die je maakt, heet kwargs. Merk op dat je deze kunt gebruiken en manipuleren zoals elke andere dictionary op het systeem. Laten we eens kijken hoe je de **kwargs parameter beter kunt benutten en toepassen.

In het volgende voorbeeld proberen we een nieuwe functie te maken die een dictionary met namen begroet. Onze voorbeeld-dictionary heeft twee namen:

Als je het programma uitvoert, krijg je deze uitvoer:

Net als in het vorige voorbeeld kunnen de dictionaries ongeordend lijken. Hierdoor kan de volgorde van de namen Casey en Sammy in sommige gevallen omgedraaid zijn.

Vervolgens geven we extra argumenten door aan de functie. Dit bewijst dat je **kwargs elk gewenst aantal argumenten kunt laten accepteren:

Als je het programma uitvoert, zie je deze uitvoer:

Deze uitvoer kan ook ongeordend zijn. Hoe dan ook, deze voorbeelden laten zien dat **kwargs je programma de flexibiliteit geeft om een aantal trefwoordargumenten te gebruiken.

Hoe argumenten te ordenen

Het is belangrijk om rekening te houden met de vastgestelde volgorde bij het ordenen van een argument in een functie of functie-aanroep. Deze is als volgt:

1. Formele positionele argumenten

2. *args

3. Trefwoordargumenten

4. **kwargs

Stel dat je *args en **kwargs gebruikt met expliciete positionele parameters. Dit betekent dat je functie er als volgt uitziet:

Aan de andere kant, als je deze parameters gebruikt met benoemde keyword-parameters, krijgt je functie de volgende algemene structuur:

Als je je niet aan de ingestelde volgorde houdt, krijg je een syntaxfout wanneer je je code uitvoert. Daarom is het het beste om deze fout in de eerste plaats te voorkomen.

Hoe je *args en **kwargs gebruikt in functie-aanroepen

Tot slot laten we je zien hoe je beide parameters gebruikt om argumenten door te geven aan functies. We beginnen met een voorbeeld dat het volgende laat zien: *args:

Er zijn drie parameters in deze functie: arg_1, arg_2, en arg_3. Je moet een variabele maken en deze instellen op een iterable. In dit geval is dat een tuple. Vervolgens kun je de variabele doorgeven aan de functie met behulp van de asterisk-syntaxis.

Bekijk de uitvoer wanneer je het programma uitvoert met het python some_args.py commando:

Het is ook mogelijk om het programma te wijzigen naar een iterable lijst datatype met een andere variabele als naam. De volgende code combineert *args met een benoemde parameter:

De uitvoer is als volgt bij het uitvoeren van het programma:

Aan de andere kant kun je keyword-argumenten toepassen met **kwargs. Zorg ervoor dat je een variabele maakt die gelijk is aan een dictionary. Deze moet 2 sleutel-waarde-paren hebben. Hier zie je hoe we de variabele doorgeven aan een functie met 3 argumenten:

Gebruik het python some_kwargs.py commando nogmaals om het programma uit te voeren:

Conclusie

Aan het einde van deze handleiding zou je goed op de hoogte moeten zijn van wat *args en **kwargs zijn en hoe ze werken. Je kunt deze parameters nu toepassen op je eigen code om je programma flexibel te maken voor toekomstige gebruikers. Deze zijn ideaal voor situaties waarin je niet weet hoeveel argumenten er gebruikt zullen worden. Zorg er wel voor dat je voorzichtig bent met de cruciale elementen van de functies en parameters.

Tot slot zijn hier nog meer bronnen van onze blog die je zullen helpen succesvol met Python te werken:

• Het txt-bestandsformaat: Werken met platte tekstbestanden in Python 3
• Loops in Python 3: Break-, Continue- en Pass-statements gebruiken
• Modules importeren in Python 3: Een uitgebreide gids
• Python 3 String Formatters gebruiken
• Programmeren met Python 3: Hoe ga je te werk bij het construeren van klassen en het definiëren van objecten?

Veel programmeerplezier!