Introduction to Python/sv

Detta är en kort övning gjord för den som aldrig har använt python tidigare. Python är en öppen-källkod, multiplattform programmeringsspråk. Python har flera egenskaper som gör att det skiljer sig mycket från andra vanliga programmeringsspråk, och väldigt åtkomligt för nya användare som du själv:


 * Det har designats speciellt för att vara lätt att läsas av människor, så det är mycket lätt att lära sig och förstå.


 * Det är ett interpreterande språk, vilket är, till skillnad från ett kompilerat som C, att ditt program inte behöver kompileras innan det körs. Den kod som du skriver kan köras omedelbart, rad för rad om du så vill. Detta gör det extremt lätt att lära sig och att hitta fel i din kod, eftersom du går långsamt, steg-för-steg.


 * Det kan bäddas in i andra program och användas som ett skriptspråk. FreeCAD har en inbäddad python tolk, så du kan skriva python kod i FreeCAD, som kan manipulera delar av FreeCAD, till exempel för att skapa geometri. Detta är mycket kraftfullt, därför att istället för att bara klicka på en knapp benämnd "skapa sfär", som en programmerare har placerat där för dig, så har du friheten att lätt skapa ditt eget verktyg för att skapa exakt den geometri du vill.


 * Det är utbyggbart, du kan lätt plugga in nya moduler i din python installation och utöka dess funktionalitet. Till exempel, så finns det moduler som tillåter python att läsa och skriva jpg bilder, för att kommunicera med twitter, att schemalägga uppgifter för att utföras av ditt operativsystem, etc.

Så, sätt igång! Tänk på att det som kommer nu är en mycket enkel introduktion, och inte en komplett övning. Men mitt hopp är att efter detta så har du tillräckliga baskunskaper för att göra djupare utforskningar i FreeCAD's mekanismer.

Tolken
Vanligtvis när man skriver datorprogram, så startar man helt enkelt en textredigerare eller din speciella programmeringsmiljö som i de flesta fall är en textredigerare med flera verktyg runt den, skriver ditt program, kompilerar det och kör det. För det mesta har du gjort något fel när du skrev, så ditt program fungerar inte, och du får ett felmeddelande som talar om vad som gick snett. Sedan går du tillbaka till din textredigerare, korrigerar misstagen, kör igen, och så vidare ända tills ditt program fungerar bra.

Hela denna process, kan i python, göras transparent inne in pythontolken. Tolken är ett python fönster med en kommandoprompt, där du kan skriva python kod. Om du installerar python på din dator (ladda ned den från python webbplatsen om du är på Windows eller Mac, installera den från din pakethanterare om du är på linux), så kommer du att ha en python i din startmeny. Men FreeCAD har också en python tolk i dess nedre del:



(If you don't have it, click on View → Views → Python console.)

Tolken visar python's version, sedan en >>> symbol, vilken är kommandoprompten, där du skriver in python kod. Skriva kod i tolken är enkelt: en rad är en instruktion. När du trycker på Enter, så kommer din kodrad att köras (efter att omedelbart och osynligt ha kompilerats). Försök till exempel att skriva detta: print är ett speciellt python nyckelord som innebär att skriva något på skärmen. När du trycker på Enter, så utförs operationen, och meddelandet "hello" skrivs ut. Om du gör ett fel, låt oss till exempel skriva: så kommer python att tala om för oss att den inte vet vad hello är. " tecknen specificerar att innehållet är en sträng, vilket på programmeringsspråk betyder att det är en bit text. Utan ", så trodde inte print kommandot att hello var en bit text utan ett speciellt python nyckelord. Det viktiga är att du omedelbart meddelas att du har gjort ett fel. Genom att trycka på tangentbordets upp-pil (eller, i FreeCAD tolken, CTRL+upp-pil), så kan du få tillbaka det sist skrivna kommandot och korrigera det.

Python tolken har även ett inbyggt hjälpsystem. Prova genom att skriva: eller, till exempel, låt oss säga att vi inte förstod vad som gick fel med vårt print hello kommando ovan så vi vill ha specifik information om "print" kommandot: Så får du en lång och komplett beskrivning av allt som print kommandot kan göra.

Nu när vi dominerar vår tolk fullständigt, så kan vi börja med seriösa saker.

Variabler
Det är förstås inte speciellt intressant att skriva "hello". Mer intressant är att skriva saker som du inte visste innan, eller låta python leta åt dig. Det är där konceptet med variabler kommer in. En variabel är helt enkelt ett värde som du lagrar under ett namn. Skriv till exempel detta: Jag gissar att du förstod vad som hände, vi "sparade" strängen "hello" under namnet a. Nu är a inte något okänt namn längre! Vi kan använda det var som helst, till exempel i print kommandot. Vi kan använda vilket namn vi vill, så länge man respekterar några enkla regler, som att inte använda mellanslag eller punktuationer. Vi skulle till exempel mycket väl kunna skriva: Se? nu är hello inte ett odefinierat ord längre. Vad händer om vi skulle ha oturen att välja ett namn som redan finns i python? Låt oss säga att vi vill spara vår sträng under namnet "print": Python är mycket intelligent och kommer att tala om för oss att detta inte är möjligt. Den har några "reserverade" nyckelord som inte kan ändras. Men våra egna variabler kan ändras när som helst, det är precis därför som de kallas variabler, innehållet kan variera. Till exempel: Vi ändrade värdet på myVariable. Vi kan också kopiera variabler: Notera att det är en bra ide att ge bra namn till dina variabler, därför att när du skriver långa program, så glömmer du efter ett tag vad variabeln benämnd "a" är till. Men om du döpte den till till exempel myWelcomeMessage, så är det mycket lättare att komma ihåg vad den används till när du ser den.

Tal
Du vet säkert att programmering är användbart till att behandla all möjlig data, och speciellt tal, inte bara textsträngar. En sak som är viktigt, python måste veta villken sorts data den jobbar med. Vi såg i vårt print hello exempel, att print kommandot kände igen vår "hello" sträng. Det gjorde den för att när vi använde ", så talade vi om för print kommandot att det som kommer efter är en textsträng.

vi kan alltid kontrollera vilken datatyp som en variabel innehåller med det speciella python nyckelordet type: Den kommer att tala om för oss att innehållet i myVar är 'str', vilket betyder sträng på pythonspråk. Vi har även andra typer av data som hel- och flyttal: Detta är redan mycket intressantare, eller hur? Nu har vi redan en kraftfull miniräknare! Titta på hur den fungerade, python vet att 10 och 20 är heltal. så de lagras som "int", och python kan göra allt med dem som man kan göra med heltal. Titta på resultatet av detta: Se? Vi tvingade python att anse att våra två tal inte var tal utan textbitar. Python kan lägga ihop två textbitar, men den kommer inte at försöka räkna ut någon summa. Men vi talade om heltal. Det finns också flyttal. Skillnaden är att heltal inte har någon decimaldel, medan flyttal kan ha en decimaldel: Int och Floats kan blandas ihop utan problem: Eftersom total har decimaler så beslöt python automatiskt att resultatet är ett flyttal. I flera fall som detta, så beslutar python automatiskt vilken typ den ska ge till något. I andra fall så gör den inte det. Till exempel: Detta kommer att ge ett fel, varA är en string och varB är en int, och python vet inte vad den ska göra. Men vi kan tvinga python att konvertera mellan typer: Nu är båda strings, operationen fungerar! Notera att vi "strängifierade" varB när den skrevs, men vi ändrade inte själva varB. Om vi ville förändra varB till en sträng permanent, så skulle vi behöva göra detta: Vi kan också använda int och float för att konvertera till int och float om vi vill: Notering om python kommandon

Du har säkert noterat att vi i detta avsnittet har använt print kommandot på flera sätt. Vi skrev ut variabler, summor, flera saker separerade av komman, och även resultatet av ett annat python kommando som type. Du kanske även såg att om man kör dessa två kommandon: så ger de exakt samma resultat. Det beror på att vi är i tolken, och allt skrivs automatiskt ut på skärmen. När vi skriver mer komplexa program som körs utanför tolken, så kommer inte allt att skrivas ut automatiskt på skärmen, så då behöver vi använda print kommandot. Men låt oss från och med nu sluta med att använda det här, så går det snabbare. Så vi kan skriva: Du måste också ha sett att de flesta python kommandona (eller nyckelorden) som vi redan känner till har parenteser som används till att tala om för dem på vilket innehåll som kommandot måste arbeta med: type, int, str, etc. Det enda undantaget är print kommandot, vilket faktiskt inte är ett undantag, det fungerar också normalt så här: print("hello"), men eftersom det används ofta, så har python programmerarna gjort en förenklad version.

Listor
En annan intressant datatyp är listor. En lista är helt enkelt en lista med annan data. På samma sätt som vi definierar en text sträng genom att använda " ", så definierar vi listor genom att använda [ ]: Du ser att de kan innehålla vilken data som helst. Listor är väldigt användbara därför att du kan samla ihop variabler i grupper. Du kan sedan göra allt möjligt i dessa grupper, till exempel räkna dem: eller hämta en punkt i listan: Du ser att medan len kommandot returnerar det totala antalet punkter i en lista, så börjar deras "position" i listan med 0. Den första punkten i en lista är alltid i position 0, så i vår myOtherList, så kommer "Bob" att vara i position 2. Vi kan göra mycket mer saker med listor som du kan läsa här, som att sortera innehåll, ta bort eller lägga till element.

En rolig och intressant sak för dig: en textsträng är i själva verket en lista med tecken! Försök att göra detta: Vanligtvis så kan allt som kan göras med listor, även göras med strängar.

Förutom strängar, heltal, flyttal och listor, så finns det mer inbyggda datatyper, som ordböcker, eller så kan du skapa dina egna datatyper medklasser.

Indrag
En annan sak man kan göra med listor är att köra igenom dem och göra något med varje punkt. Titta till exempel på detta: Vi itererade (programmeringsslang igen!) genom vår lista med "for ... in ..." kommandot och gjorde något med varje punkt. Notera den speciella syntaxen: for kommandot avslutas med : vilket indikerar att det som kommer efter är ett block av ett eller fler kommandon. Omedelbart efter att du har skrivit en kommandorad som slutar med :, så kommer kommandoprompten att ändras till ... vilket betyder att python vet att en :-avslutad rad har skrivits och att det som kommer efter kommer att vara en del av det.

Hur ska python veta hur många rader som ska utföras innanför for...in operationen? För det, så använder python indrag. Det innebär att de efterkommande raderna inte kommer börja längst till vänster. Du påbörjar dem med ett eller flera mellanslag, eller en eller flera tabbar. Andra programmeringsspråk använder andra metoder, som att skriva allt innanför parenteser, etc.

Så länge som du skriver dina nästa rader med samma indrag, så anses de vara en del av for-in blocket. Om du börjar en rad med 2 mellanslag och nästa med 4, så kommer du att få ett fel.

När du är klar med blocket, skriv bara en annan rad utan indrag, eller tryck på enter för att komma tillbaka från for-in blocket

Indrag är bra därför om du gör stora (till exempel använder tabbar istället för mellanslag), så syns det lättare vad som utförs inuti vad, när du skriver större program. Vi kommeer att se att många andra kommandon än for-in kan ha indragna kodblock.

For-in kommandon kan användas till många saker som måster göras mer än en gång. Det kan till exempel kombineras med range ¨kommandot: Eller mer komplexa saker som detta: Du ser att range kommandot också har den egenskapen att den börjar med 0 (om du inte specificerar startnumret) och att dess sista nummer kommer bli en mindre än det slutnummer du specificerar. Detta är så för att det ska fungera bra ihop med andra python kommandon. Till exempel: Ett annat intressant bruk av indragna block är med if kommandot. If utför endast ett kodblock om ett visst villkor är uppfyllt, till exempel: Detta kommer förstås alltid skriva ut det första ordet, men försök genom att byta ut den andra raden med: Then nothing is printed. We can also specify an else: statement:

Functions
The standard Python commands are not many. In current version of Python there are about 30, and we already know several of them. But imagine if we could invent our own commands? Well, we can, and it's extremely easy. In fact, most the additional modules that you can plug into your Python installation do just that, they add commands that you can use. A custom command in Python is called a function and is made like this: Extremely simple: the def command defines a new function. You give it a name, and inside the parenthesis you define arguments that we'll use in our function. Arguments are data that will be passed to the function. For example, look at the len command. If you just write len alone, Python will tell you it needs an argument. That is, you want len of something, right? Then, for example, you'll write len(myList) and you'll get the length of myList. Well, myList is an argument that you pass to the len function. The len function is defined in such a way that it knows what to do with what is passed to it. Same as we did here.

The "myValue" name can be anything, and it will be used only inside the function. It is just a name you give to the argument so you can do something with it, but it also serves so the function knows how many arguments to expect. For example, if you do this: There will be an error. Our function was programmed to receive just one argument, but it received two, 45 and 34. We could instead do something like this: We made a function that receives two arguments, sums them, and returns that value. Returning something is very useful, because we can do something with the result, such as store it in the myTotal variable. Of course, since we are in the interpreter and everything is printed, doing: will print the result on the screen, but outside the interpreter, since there is no more print command inside the function, nothing would appear on the screen. You would need to do: to have something printed. Read more about functions here.

Modules
Now that we have a good idea of how Python works, we'll need one last thing: How to work with files and modules.

Until now, we wrote Python instructions line by line in the interpreter, right? What if we could write several lines together, and have them executed all at once? It would certainly be handier for doing more complex things. And we could save our work too. Well, that too, is extremely easy. Simply open a text editor (such as the windows notepad), and write all your Python lines, the same way as you write them in the interpreter, with indentations, etc. Then, save that file somewhere, preferably with a .py extension. That's it, you have a complete Python program. Of course, there are much better editors than notepad, but it is just to show you that a Python program is nothing else than a text file.

To make Python execute that program, there are hundreds of ways. In windows, simply right-click your file, open it with Python, and execute it. But you can also execute it from the Python interpreter itself. For this, the interpreter must know where your .py program is. In FreeCAD, the easiest way is to place your program in a place that FreeCAD's Python interpreter knows by default, such as FreeCAD's bin folder, or any of the Mod folders. Suppose we write a file like this:

and we save it as test.py in our FreeCAD/bin directory. Now, let's start FreeCAD, and in the interpreter window, write: without the .py extension. This will simply execute the contents of the file, line by line, just as if we had written it in the interpreter. The sum function will be created, and the message will be printed. There is one big difference: the import command is made not only to execute programs written in files, like ours, but also to load the functions inside, so they become available in the interpreter. Files containing functions, like ours, are called modules.

Normally when we write a sum function in the interpreter, we execute it simply like that: Like we did earlier. When we import a module containing our sum function, the syntax is a bit different. We do: That is, the module is imported as a "container", and all its functions are inside. This is extremely useful, because we can import a lot of modules, and keep everything well organized. So, basically, everywhere you see something.somethingElse, with a dot in between, that means somethingElse is inside something.

We can also throw out the test part, and import our sum function directly into the main interpreter space, like this: Basically all modules behave like that. You import a module, then you can use its functions like that: module.function(argument). Almost all modules do that: they define functions, new data types and classes that you can use in the interpreter or in your own Python modules, because nothing prevents you to import modules inside your module!

One last extremely useful thing. How do we know what modules we have, what functions are inside and how to use them (that is, what kind of arguments they need)? We saw already that Python has a help function. Doing: Will give us a list of all available modules. We can now type q to get out of the interactive help, and import any of them. We can even browse their content with the dir command We'll see all the functions contained in the math module, as well as strange stuff named __doc__, __file__, __name__. The __doc__ is extremely useful, it is a documentation text. Every function of (well-made) modules has a __doc__ that explains how to use it. For example, we see that there is a sin function in side the math module. Want to know how to use it? And finally one last little goodie: When we work on programming a new module, we often want to test it. So once we wrote a little piece of module, in a python interpreter, we do something like this, to test our new code: But what if we see that myTestFunction doesn't work correctly? We go back to our editor and modifiy it. Then, instead of closing and reopening the python interpreter, we can simply update the module like this:

Starting with FreeCAD
Well, I think you must know have a good idea of how Python works, and you can start exploring what FreeCAD has to offer. FreeCAD's Python functions are all well organized in different modules. Some of them are already loaded (imported) when you start FreeCAD. So, just do and read on to FreeCAD Scripting Basics...

Of course, we saw here only a very small part of the Python world. There are many important concepts that we didn't mention here. There are three very important Python reference documents on the net: Be sure to bookmark them!
 * the official Python tutorial with way more information than this one
 * the official Python reference
 * the Dive into Python wikibook/ book.