Python files (.py)
===================
.. _learn-more-vscode-script-top:
.. dropdown:: Video Tutorial
:color: muted
:open:
.. raw:: html
A ``.py`` file is a text file that contains Python code.
It's the standard file format used for writing and executing Python programs.
When you write Python code in a ``.py`` file, you can run the file to execute the code it contains,
and it can be opened and edited in any text editor or integrated development environment (IDE) like VS Code or IDLE.
In this tutorial you will learn how to do all of these using Visual Studio Code:
.. contents::
:local:
:depth: 2
Opening a Folder
------------------
Opening a folder in VS Code, by default, sets the *current working directory* (CWD)
to that folder and applies any VS Code settings that have been changed while the
folder was open last time.
Therefore, scripts that interact with files are dependent on which folder
is open in VS Code when they are executed.
.. card::
.. tab-set::
:sync-group: os
.. tab-item:: {{ windows }}
:sync: windows
1. Press the :menuselection:`File` button in the top left corner of VS Code.
2. Select :menuselection:`Open Folder...` from the dropdown menu.
.. image:: ../images/VSC-openfolder.png
:width: 80%
:align: center
:alt: Save File in VS Code
3. Browse to the folder you want to open and select it.
.. tab-item:: {{ macos }}
:sync: mac
1. Press the :menuselection:`File` button in the top left corner of your screen.
2. Select :menuselection:`Open Folder...` from the dropdown menu.
.. image:: ../images/openFolderMac.png
:width: 80%
:align: center
:alt: Open Folder in VS Code
3. Browse to the folder you want to open and select it.
.. dropdown:: Current working directory
:color: warning
Opening a folder in VS Code forces the *current working directory* (CWD) to that
of the opened folder (this may be changed through settings).
Therefore, all scripts executed via VS Code will run the script from that folder
which may have unexpected side-effects.
Thus, the same script may read/write different files depending on which folder
you have opened in VS Code.
When unexpected read/write errors occur, one can use the below script to figure
out where the *current working directory* is:
.. code::
import os
print(os.getcwd())
Creating a Python-file
-----------------------
You can create a Python file using VS code. This is useful if you are writing code that you will need again.
.. card::
.. tab-set::
:sync-group: os
.. tab-item:: {{ windows }}
:sync: windows
Press the :menuselection:`File` button in the top left corner of VS Code. Select :menuselection:`New File --> Python File` from the menu that drops down.
.. image:: ../images/VScode_windows1.png
:width: 80%
:align: center
:alt: IDLE Shell
.. tab-item:: {{ macos }}
:sync: mac
Press the :menuselection:`File` button in the top left corner of your screen. Select :menuselection:`New File --> Python File` from the menu that drops down.
You may need to hover your mouse around the top of the screen for the menu bar to appear.
.. image:: ../images/VScode_mac1.png
:width: 80%
:align: center
:alt: IDLE Shell
Saving a File
--------------
Saving a file in VS Code ensures that your work is not lost and can be accessed later.
.. card::
.. tab-set::
:sync-group: os
.. tab-item:: {{ windows }}
:sync: windows
1. Press the :menuselection:`File` button in the top left corner of VS Code.
2. Select :menuselection:`Save` or :menuselection:`Save As...` from the dropdown menu.
.. image:: ../images/VScode_windows_save_file.png
:width: 80%
:align: center
:alt: Save File in VS Code
3. Please choose a location and name for your file, then save it.
Note, you can save a file by pressing :kbd:`Ctrl+S`.
.. tab-item:: {{ macos }}
:sync: mac
1. Press the :menuselection:`File` button in the top left corner of your screen.
2. Select :menuselection:`Save` or :menuselection:`Save As...` from the dropdown menu.
3. Please choose a location and name for your file, then save it.
.. image:: ../images/saveFileMac.png
:width: 80%
:align: center
:alt: Save File in VS Code
Note, you can save a file by pressing :kbd:`Command+S`.
.. tip::
You can enable auto save by pressing the :menuselection:`File` button in the top left corner of VS Code and then selecting :menuselection:`Auto Save`.
Opening a File
---------------------------
Opening a file in VS Code allows you to edit and run your code directly within the editor.
.. card::
.. tab-set::
:sync-group: os
.. tab-item:: {{ windows }}
:sync: windows
1. Press the :menuselection:`File` button in the top left corner of VS Code.
2. Select :menuselection:`Open...` from the dropdown menu.
.. image:: ../images/VSC-openfile.png
:width: 450
:align: center
:alt: Save File in VS Code
3. Browse to the file you want to open and select it.
.. tab-item:: {{ macos }}
:sync: mac
1. Press the ":menuselection:`File` button in the top left corner of your screen.
2. Select ":menuselection:`Open...` from the dropdown menu.
.. image:: ../images/openFileMac.png
:width: 450
:align: center
:alt: Open File in VS Code
3. Browse to the file you want to open and select it.
.. tip::
You can open a file by dragging and dropping it directly into the VS Code window.
.. _learn-more-vscode-script-select-interpreter:
Selecting the right interpreter
-------------------------------
Once you have created a Python file, select your interpreter.
In short, the interpreter is the version of Python that you use to execute your code.
.. card::
.. tab-set::
.. tab-item:: {{ windows }}
:sync: windows
1. Press :kbd:`Ctrl+Shift+P`
2. Type *Python: Select Interpreter* and press :kbd:`Enter` once this shows up under the options
.. image:: ../images/VScode_windows2.png
:width: 450
:align: center
:alt: IDLE Shell
3. Choose the option similar to ``Python {{python_version_recommended}}.X ('base')``.
Your PC may have a different version of Python.
.. image:: ../images/VScode_windows3.png
:width: 450
:align: center
:alt: IDLE Shell
.. tip::
In VS Code, pressing :kbd:`Ctrl+Shift+P` brings down a search bar where you can search for help with anything.
.. tab-item:: {{ macos }}
:sync: mac
1. Press :kbd:`Ctrl+Shift+P`
2. type *Python: Select Interpreter* and press :kbd:`Enter` once this shows up under the options
.. image:: ../images/VScode_mac2.png
:width: 450
:align: center
:alt: IDLE Shell
3. Choose the option similar to ``Python {{python_version_recommended}}.5 ('base')``. You may have a different version of Python on your own PC.
.. image:: ../images/VScode_mac3.png
:width: 450
:align: center
:alt: IDLE Shell
.. tip::
In VS Code, pressing :kbd:`Ctrl+Shift+P` brings down a search bar where you can search for help with anything.
.. todo::
Fill this section called Run a Python File accordingly once the video includes this info. Sotero should be done with the video during week 19/8 - 23/8
Run a Python File
----------------------------------------------------------------
Once you've written your Python code, you can run it in VS Code.
.. card::
Running Python files/scripts requires one to have set the interpreter, see :ref:`here `.
When a Python file is open in VS Code, a :fas:`play` button will appear
in the top-right of VS Code.
When pressing that button, the currently opened file will be executed.
An example is found towards the end of :ref:`this video`.
.. Difference between Terminal and Python shell in VS Code - Needs to be redone according to video
.. ------------------------------------------------------------------------------------------------------------------------
.. You can start a terminal from VS code, which works just like in the terminal app.
.. .. card
.. .. tab-set
.. :sync-group: os
.. .. tab-item:: {{ windows }}
.. :sync: windows
.. Press the three dots in the top menu bar. They are next to the :menuselection:`View` and :menuselection:`Go` options.
.. Move your mouse to :menuselection:`Terminal` and click :menuselection:`New Terminal`
.. .. image:: ../images/VScode_windows4.png
.. :width: 450
.. :align: center
.. :alt: IDLE Shell
.. .. tab-item:: {{ macos }}
.. :sync: mac
.. Move your mouse to the top of the screen. Select :menuselection:`Terminal --> New Terminal`
.. .. image:: ../images/VScode_mac4.png
.. :width: 450
.. :align: center
.. :alt: IDLE Shell
.. tip
.. You can have multiple terminals open at once.
.. You can delete a terminal by hovering your mouse over it's name (bottom right) and pressing the icon shaped like a trash can