[Tut] Writing, Running, Debugging, and Testing Code In PyCharm

[Tut] Writing, Running, Debugging, and Testing Code In PyCharm - Printable Version

+- Sick Gaming (https://www.sickgaming.net)
+-- Forum: Programming (https://www.sickgaming.net/forum-76.html)
+--- Forum: Python (https://www.sickgaming.net/forum-83.html)
+--- Thread: [Tut] Writing, Running, Debugging, and Testing Code In PyCharm (/thread-98084.html)

[Tut] Writing, Running, Debugging, and Testing Code In PyCharm - xSicKxBot - 11-02-2020

Writing, Running, Debugging, and Testing Code In PyCharm

<div><h2>How To Write Python Code In Pycharm?</h2>
<figure class="wp-block-embed is-type-video is-provider-youtube wp-block-embed-youtube wp-embed-aspect-16-9 wp-has-aspect-ratio">
<div class="wp-block-embed__wrapper">
<div class="ast-oembed-container"><iframe title="4. Writing and Running Code In PyCharm" width="1400" height="788" src="https://www.youtube.com/embed/FCbuXmGqYUY?feature=oembed" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></div>
</div>
</figure>
Every code or file within Pycharm is written inside a project. This means, everything in PyCharm is written with respect to a Project and the first thing that you need to create before you can write any code is a project. So, let’s see how we can create a project in PyCharm.
➮ After successfully installing PyCharm, the welcome screen comes up. Click Create New Project. 
<figure class="wp-block-image size-large is-resized"><img loading="lazy" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-247.png" alt="" class="wp-image-16213" width="487" height="352" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-247.png 658w, https://blog.finxter.com/wp-content/uploads/2020/10/image-247-300x217.png 300w, https://blog.finxter.com/wp-content/uploads/2020/10/image-247-150x109.png 150w" sizes="(max-width: 487px) 100vw, 487px" /></figure>
The Create New Project window opens up.
<figure class="wp-block-image size-large"><img loading="lazy" width="795" height="455" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-212.png" alt="" class="wp-image-15982" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-212.png 795w, https://blog.finxter.com/wp-content/uploads/2020/10/image-212-300x172.png 300w, https://blog.finxter.com/wp-content/uploads/2020/10/image-212-768x440.png 768w, https://blog.finxter.com/wp-content/uploads/2020/10/image-212-150x86.png 150w" sizes="(max-width: 795px) 100vw, 795px" /></figure>
✶ In this window specify the location of the project where you want to save the files.
<figure class="wp-block-image size-large"><img loading="lazy" width="790" height="44" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-209.png" alt="" class="wp-image-15963" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-209.png 790w, https://blog.finxter.com/wp-content/uploads/2020/10/image-209-300x17.png 300w, https://blog.finxter.com/wp-content/uploads/2020/10/image-209-768x43.png 768w, https://blog.finxter.com/wp-content/uploads/2020/10/image-209-150x8.png 150w" sizes="(max-width: 790px) 100vw, 790px" /></figure>
✶ Expand the Python Interpreter menu. Here, you can specify whether you want to create a new project interpreter or reuse an existing one. From the drop-down list, you can select one of the options: Virtualenv, Pipenv, or Conda. These are the tools that help us to keep dependencies required by different projects and are separated by creating isolated Python environments for each of them. You can also specify the location of the New environment and select a Base interpreter (for example Python2.x or Python3.x) from the options available. Then we have checkboxes to select Inherit global site-packages and Make available to all projects. Usually, it is a good idea to keep the defaults. 
<figure class="wp-block-image size-large"><img loading="lazy" width="786" height="231" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-210.png" alt="" class="wp-image-15972" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-210.png 786w, https://blog.finxter.com/wp-content/uploads/2020/10/image-210-300x88.png 300w, https://blog.finxter.com/wp-content/uploads/2020/10/image-210-768x226.png 768w, https://blog.finxter.com/wp-content/uploads/2020/10/image-210-150x44.png 150w" sizes="(max-width: 786px) 100vw, 786px" /></figure>
✶ Click Create on the bottom right corner of the dialog box to create the new project.
Note: You might be notified that: Projects can either be opened in a new window or you can replace the project in the existing window or be attached to the already opened projects. How would you like to open the project? Select the desired option.
<figure class="wp-block-image size-large"><img loading="lazy" width="800" height="107" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-211.png" alt="" class="wp-image-15981" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-211.png 800w, https://blog.finxter.com/wp-content/uploads/2020/10/image-211-300x40.png 300w, https://blog.finxter.com/wp-content/uploads/2020/10/image-211-768x103.png 768w, https://blog.finxter.com/wp-content/uploads/2020/10/image-211-150x20.png 150w" sizes="(max-width: 800px) 100vw, 800px" /></figure>
You might also get a small Tip of the Day popup where PyCharm gives you one trick to learn at each startup. Feel free to close this popup.
Now, we are all set to start writing our first Python code in PyCharm. 
<ul>
<li>Click on File.</li>
<li>Choose New.</li>
</ul>
<figure class="wp-block-image size-large is-resized"><img loading="lazy" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-213.png" alt="" class="wp-image-15983" width="269" height="368" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-213.png 354w, https://blog.finxter.com/wp-content/uploads/2020/10/image-213-219x300.png 219w, https://blog.finxter.com/wp-content/uploads/2020/10/image-213-150x205.png 150w" sizes="(max-width: 269px) 100vw, 269px" /></figure>
<ul>
<li>Choose Python File and provide a name for the new file. In our case we name it add. Press enter on your keyboard and your new file will be ready and you can write your code in it.</li>
</ul>
<figure class="wp-block-image size-large"><img loading="lazy" width="343" height="145" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-214.png" alt="" class="wp-image-15984" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-214.png 343w, https://blog.finxter.com/wp-content/uploads/2020/10/image-214-300x127.png 300w, https://blog.finxter.com/wp-content/uploads/2020/10/image-214-150x63.png 150w" sizes="(max-width: 343px) 100vw, 343px" /></figure>
Let us write a simple code that adds two numbers and prints the result of the addition as output. 
<figure class="wp-block-image size-large"><img loading="lazy" width="1024" height="207" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-215-1024x207.png" alt="" class="wp-image-15993" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-215-1024x207.png 1024w, https://blog.finxter.com/wp-content/uploads/2020/10/image-215-300x61.png 300w, https://blog.finxter.com/wp-content/uploads/2020/10/image-215-768x155.png 768w, https://blog.finxter.com/wp-content/uploads/2020/10/image-215-150x30.png 150w, https://blog.finxter.com/wp-content/uploads/2020/10/image-215.png 1358w" sizes="(max-width: 1024px) 100vw, 1024px" /></figure>
<h2>How To Run The Python Code In PyCharm?</h2>
Once the code is written, it is time to run the code. There are three ways of running the Python code in PyCharm.
Method 1: Using Shortcuts
<ul>
<li>Use the shortcut <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>R</kbd> on Mac to run the code.</li>
<li>Use the shortcut <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>F10</kbd> on Windows or Linux to run the code.</li>
</ul>
Method 2: Right click the code window and click on Run ‘add’
<figure class="wp-block-image size-large"><img loading="lazy" width="600" height="337" src="https://blog.finxter.com/wp-content/uploads/2020/10/run-code.gif" alt="" class="wp-image-15995" /></figure>
Method 3: Choose ‘add’  and click on the little green arrow at the top right corner of the screen as shown in the diagram below.
<figure class="wp-block-image size-large"><img loading="lazy" width="1024" height="54" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-216-1024x54.png" alt="" class="wp-image-15994" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-216-1024x54.png 1024w, https://blog.finxter.com/wp-content/uploads/2020/10/image-216-300x16.png 300w, https://blog.finxter.com/wp-content/uploads/2020/10/image-216-768x40.png 768w, https://blog.finxter.com/wp-content/uploads/2020/10/image-216-150x8.png 150w, https://blog.finxter.com/wp-content/uploads/2020/10/image-216.png 1357w" sizes="(max-width: 1024px) 100vw, 1024px" /></figure>
<h2>How To Debug The Code Using Breakpoints?</h2>
<figure class="wp-block-embed is-type-video is-provider-youtube wp-block-embed-youtube wp-embed-aspect-16-9 wp-has-aspect-ratio">
<div class="wp-block-embed__wrapper">
<div class="ast-oembed-container"><iframe title="5. Debugging In PyCharm" width="1400" height="788" src="https://www.youtube.com/embed/Oz8zmjcO8cw?feature=oembed" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></div>
</div>
</figure>
While coding, you are bound to come across bugs especially if you are working with a tedious production code. PyCharm provides an effective way of debugging your code and allows you to debug your code line by line and identify exceptions or errors with ease. Let us have a look at the following example to visualize how to debug your code in PyCharm.
Example:
<figure class="wp-block-image size-large"><img loading="lazy" width="502" height="273" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-218.png" alt="" class="wp-image-15998" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-218.png 502w, https://blog.finxter.com/wp-content/uploads/2020/10/image-218-300x163.png 300w, https://blog.finxter.com/wp-content/uploads/2020/10/image-218-150x82.png 150w" sizes="(max-width: 502px) 100vw, 502px" /></figure>
 Output: 
<figure class="wp-block-image size-large"><img loading="lazy" width="653" height="142" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-219.png" alt="" class="wp-image-15999" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-219.png 653w, https://blog.finxter.com/wp-content/uploads/2020/10/image-219-300x65.png 300w, https://blog.finxter.com/wp-content/uploads/2020/10/image-219-150x33.png 150w" sizes="(max-width: 653px) 100vw, 653px" /></figure>
Note: This is a very basic example and has been just used for the purpose to guide you through the process of debugging in PyCharm. The example computes the average of two numbers but yields different results in the two print statements. A spoiler: we have not used the brackets properly which results in the wrong result in the first case. Now, we will have a look at how we can identify the same by debugging our Python code in PyCharm. 
Debugging our code:
Step 1: Setting The Breakpoint
The first requirement to start debugging our code is to place a breakpoint by clicking on the blank space to the left of line number 1 ( this might vary according to your code and requirements). This is the point where the program will be suspended and the process of debugging can be started from here, one line at a time.
<figure class="wp-block-image size-large"><img loading="lazy" width="681" height="383" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-220.png" alt="" class="wp-image-16000" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-220.png 681w, https://blog.finxter.com/wp-content/uploads/2020/10/image-220-300x169.png 300w, https://blog.finxter.com/wp-content/uploads/2020/10/image-220-150x84.png 150w" sizes="(max-width: 681px) 100vw, 681px" /></figure>
Step 2: Start Debugging
Once the breakpoint is set the next step is to start debugging using one of the following ways:
<ul>
<li>Using Shortcuts: <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>D</kbd> on Mac or <kbd>Shift</kbd>+<kbd>Alt</kbd>+<kbd>F9</kbd> on Windows or Linux.</li>
<li>Right-click on the code and choose Debug ‘add’.</li>
<li>Choose ‘add’  and click on the <img loading="lazy" width="27" height="28" class="wp-image-16001" style="width: 27px" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-221.png" alt=""> icon on the top right corner of the menu bar.</li>
</ul>
Once you use any one of the above methods to start debugging your code, the Debug Window will open up at the bottom as shown in the figure below. Also, note that the current line is highlighted in blue.
<figure class="wp-block-image size-large"><img loading="lazy" width="747" height="359" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-223.png" alt="" class="wp-image-16004" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-223.png 747w, https://blog.finxter.com/wp-content/uploads/2020/10/image-223-300x144.png 300w, https://blog.finxter.com/wp-content/uploads/2020/10/image-223-150x72.png 150w" sizes="(max-width: 747px) 100vw, 747px" /></figure>
Step 3: Debug line by line and identify the error (logical in our case). Press <kbd>F8</kbd> on your keyboard to execute the current line and step over to the next line. To step into the function in the current line, press <code>F7</code>. As each statement is executed, the changes in the variables are automatically reflected in the Debugger window. 
<figure class="wp-block-image size-large"><img loading="lazy" width="600" height="337" src="https://blog.finxter.com/wp-content/uploads/2020/10/debug.gif" alt="" class="wp-image-16005" /></figure>
<h2>How To Test Code In PyCharm?</h2>
<figure class="wp-block-embed is-type-video is-provider-youtube wp-block-embed-youtube wp-embed-aspect-16-9 wp-has-aspect-ratio">
<div class="wp-block-embed__wrapper">
<div class="ast-oembed-container"><iframe title="6. Testing In PyCharm" width="1400" height="788" src="https://www.youtube.com/embed/PJ6uXtNdjjo?feature=oembed" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></div>
</div>
</figure>
For any application or code to be operational, it must undergo unit test and PyCharm facilitates us with numerous testing frameworks for testing our code. The default test runner in Python is <code>unittest</code>, however, PyCharm also supports other testing frameworks such as <code>pytest</code>, <code>nose</code>, <code>doctest</code>, <code>tox</code>, and <code>trial</code>. 
Let us create a file with the name currency.py and then test our file using unit testing.
<figure class="wp-block-image size-large"><img loading="lazy" width="435" height="221" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-224.png" alt="" class="wp-image-16007" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-224.png 435w, https://blog.finxter.com/wp-content/uploads/2020/10/image-224-300x152.png 300w, https://blog.finxter.com/wp-content/uploads/2020/10/image-224-150x76.png 150w" sizes="(max-width: 435px) 100vw, 435px" /></figure>
 Now, let us begin unit testing. Follow the steps given below:
Step 1: Create The Test File
To begin testing keep the <code>currency.py</code> file open and execute any one of the following steps:
<ol>
<li>Use Shortcut: Press <code><kbd>Shift</kbd>+<kbd>Cmd</kbd>+<kbd>T</kbd></code> on Mac or <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>T</kbd> on Windows or Linux.</li>
<li>Right-click on the class and select Go To ➠ Test. Make sure you right-click on the name of the class to avoid confusion!</li>
<li>Go to the main menu ➠ select Navigate ➠ Select Test</li>
</ol>
Step 2: Select Create New Test and that opens up the Create Test window. Keep the defaults and select all the methods and click on OK. 
<figure class="wp-block-image size-large"><img loading="lazy" width="524" height="488" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-225.png" alt="" class="wp-image-16008" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-225.png 524w, https://blog.finxter.com/wp-content/uploads/2020/10/image-225-300x279.png 300w, https://blog.finxter.com/wp-content/uploads/2020/10/image-225-150x140.png 150w" sizes="(max-width: 524px) 100vw, 524px" /></figure>
✶ PyCharm will automatically create a file with the name <code>test_currency.py</code> with the following tests within it.
<figure class="wp-block-image size-large"><img loading="lazy" width="364" height="276" src="https://blog.finxter.com/wp-content/uploads/2020/10/image-226.png" alt="" class="wp-image-16009" srcset="https://blog.finxter.com/wp-content/uploads/2020/10/image-226.png 364w, https://blog.finxter.com/wp-content/uploads/2020/10/image-226-300x227.png 300w, https://blog.finxter.com/wp-content/uploads/2020/10/image-226-150x114.png 150w" sizes="(max-width: 364px) 100vw, 364px" /></figure>
Step 3: Create the Test Cases
Once our test file is created we need to import the currency class within it and define the test cases as follows:
<figure class="wp-block-image size-large"><img loading="lazy" width="567" height="403" src="https://blog.finxter.com/wp-content/uploads/2020/11/image-1.png" alt="" class="wp-image-16216" srcset="https://blog.finxter.com/wp-content/uploads/2020/11/image-1.png 567w, https://blog.finxter.com/wp-content/uploads/2020/11/image-1-300x213.png 300w, https://blog.finxter.com/wp-content/uploads/2020/11/image-1-150x107.png 150w" sizes="(max-width: 567px) 100vw, 567px" /></figure>
 Step 4: Run the Unit Test
Now, we need to run the test using one of the following methods:
<ul>
<li>Using Shortcut: Press <kbd>Ctrl</kbd>+<kbd>R</kbd> on Mac or <kbd>Shift</kbd>+<kbd>F10</kbd> on Windows or Linux. </li>
<li>Right-click and choose Run ‘Unittests for test_currency.py’.</li>
<li>Click on the green arrow to the left of the test class name and choose Run ‘Unittests for test_currency.py’.</li>
</ul>
You will since that two tests are successful while one test fails. To be more specific unit test for test_euro() and test_yen() are successful while the test fails for test_pound().
Output:
<figure class="wp-block-image size-large"><img loading="lazy" width="697" height="257" src="https://blog.finxter.com/wp-content/uploads/2020/11/image-2.png" alt="" class="wp-image-16217" srcset="https://blog.finxter.com/wp-content/uploads/2020/11/image-2.png 697w, https://blog.finxter.com/wp-content/uploads/2020/11/image-2-300x111.png 300w, https://blog.finxter.com/wp-content/uploads/2020/11/image-2-150x55.png 150w" sizes="(max-width: 697px) 100vw, 697px" /></figure>
That brings us to the end of this section and it is time for us to move on to a very important section of our tutorial where we will be discussing numerous tips and tricks to navigate PyCharm with the help of some interesting shortcuts. We will also discuss in brief about some of the tools like Django that we can integrate with PyCharm. So, without further delay lets dive into to next section. 
Please click on the Next link/button given below to move on to the next phase of PyCharm journey!
 <a href="https://blog.finxter.com/pycharm-a-simple-illustrated-guide/" target="_blank" rel="noopener noreferrer"> 
<button type="button" style="background-color: #4CAF50;border: none">Previous</button> 
</a> 
<a href="#" rel="noopener noreferrer"> 
<button type="button" style="background-color: #4CAF50;border: none">Next</button> 
</a>
The post <a href="https://blog.finxter.com/writing-running-debugging-and-testing-code-in-pycharm/" target="_blank" rel="noopener noreferrer">Writing, Running, Debugging, and Testing Code In PyCharm</a> first appeared on <a href="https://blog.finxter.com/" target="_blank" rel="noopener noreferrer">Finxter</a>.
</div>

https://www.sickgaming.net/blog/2020/11/02/writing-running-debugging-and-testing-code-in-pycharm/