Перейти к содержимому

Как настроить pycharm для python

  • автор:

PyCharm for Productive Python Development (Guide)

As a programmer, you should be focused on the business logic and creating useful applications for your users. In doing that, PyCharm by JetBrains saves you a lot of time by taking care of the routine and by making a number of other tasks such as debugging and visualization easy.

In this article, you’ll learn about:

  • Installing PyCharm
  • Writing code in PyCharm
  • Running your code in PyCharm
  • Debugging and testing your code in PyCharm
  • Editing an existing project in PyCharm
  • Searching and navigating in PyCharm
  • Using Version Control in PyCharm
  • Using Plugins and External Tools in PyCharm
  • Using PyCharm Professional features, such as Django support and Scientific mode

This article assumes that you’re familiar with Python development and already have some form of Python installed on your system. Python 3.6 will be used for this tutorial. Screenshots and demos provided are for macOS. Because PyCharm runs on all major platforms, you may see slightly different UI elements and may need to modify certain commands.

Note:

PyCharm comes in three editions:

    is free and for educational purposes. is free as well and intended for pure Python development. is paid, has everything the Community edition has and also is very well suited for Web and Scientific development with support for such frameworks as Django and Flask, Database and SQL, and scientific tools such as Jupyter.

For more details on their differences, check out the PyCharm Editions Comparison Matrix by JetBrains. The company also has special offers for students, teachers, open source projects, and other cases.

Download Sample Project: Click here to download the sample project you’ll use to explore the project-focused features of PyCharm in this tutorial.

Installing PyCharm

This article will use PyCharm Community Edition 2019.1 as it’s free and available on every major platform. Only the section about the professional features will use PyCharm Professional Edition 2019.1.

The recommended way of installing PyCharm is with the JetBrains Toolbox App. With its help, you’ll be able to install different JetBrains products or several versions of the same product, update, rollback, and easily remove any tool when necessary. You’ll also be able to quickly open any project in the right IDE and version.

To install the Toolbox App, refer to the documentation by JetBrains. It will automatically give you the right instructions depending on your OS. In case it didn’t recognize your OS correctly, you can always find it from the drop down list on the top right section:

List of OSes in the JetBrains website

After installing, launch the app and accept the user agreement. Under the Tools tab, you’ll see a list of available products. Find PyCharm Community there and click Install:

PyCharm installed with the Toolbox app

Voilà! You have PyCharm available on your machine. If you don’t want to use the Toolbox app, then you can also do a stand-alone installation of PyCharm.

Launch PyCharm, and you’ll see the import settings popup:

PyCharm Import Settings Popup

PyCharm will automatically detect that this is a fresh install and choose Do not import settings for you. Click OK, and PyCharm will ask you to select a keymap scheme. Leave the default and click Next: UI Themes on the bottom right:

PyCharm Keymap Scheme

PyCharm will then ask you to choose a dark theme called Darcula or a light theme. Choose whichever you prefer and click Next: Launcher Script:

PyCharm Set UI Theme Page

I’ll be using the dark theme Darcula throughout this tutorial. You can find and install other themes as plugins, or you can also import them.

On the next page, leave the defaults and click Next: Featured plugins. There, PyCharm will show you a list of plugins you may want to install because most users like to use them. Click Start using PyCharm, and now you are ready to write some code!

Writing Code in PyCharm

In PyCharm, you do everything in the context of a project. Thus, the first thing you need to do is create one.

After installing and opening PyCharm, you are on the welcome screen. Click Create New Project, and you’ll see the New Project popup:

New Project in PyCharm

Specify the project location and expand the Project Interpreter drop down. Here, you have options to create a new project interpreter or reuse an existing one. Choose New environment using. Right next to it, you have a drop down list to select one of Virtualenv, Pipenv, or Conda, which are the tools that help to keep dependencies required by different projects separate by creating isolated Python environments for them.

You are free to select whichever you like, but Virtualenv is used for this tutorial. If you choose to, you can specify the environment location and choose the base interpreter from the list, which is a list of Python interpreters (such as Python2.7 and Python3.6) installed on your system. Usually, the defaults are fine. Then you have to select boxes to inherit global site-packages to your new environment and make it available to all other projects. Leave them unselected.

Click Create on the bottom right and you will see the new project created:

Project created in PyCharm

You will also see a small Tip of the Day popup where PyCharm gives you one trick to learn at each startup. Go ahead and close this popup.

It is now time to start a new Python program. Type Cmd + N if you are on Mac or Alt + Ins if you are on Windows or Linux. Then, choose Python File. You can also select File → New from the menu. Name the new file guess_game.py and click OK. You will see a PyCharm window similar to the following:

PyCharm New File

For our test code, let’s quickly code up a simple guessing game in which the program chooses a number that the user has to guess. For every guess, the program will tell if the user’s guess was smaller or bigger than the secret number. The game ends when the user guesses the number. Here’s the code for the game:

Type this code directly rather than copying and pasting. You’ll see something like this:

As you can see, PyCharm provides Intelligent Coding Assistance with code completion, code inspections, on-the-fly error highlighting, and quick-fix suggestions. In particular, note how when you typed main and then hit tab, PyCharm auto-completed the whole main clause for you.

Also note how, if you forget to type if before the condition, append .if , and then hit Tab , PyCharm fixes the if clause for you. The same is true with True.while . That’s PyCharm’s Postfix completions working for you to help reduce backward caret jumps.

Running Code in PyCharm

Now that you’ve coded up the game, it’s time for you to run it.

You have three ways of running this program:

  1. Use the shortcut Ctrl + Shift + R on Mac or Ctrl + Shift + F10 on Windows or Linux.
  2. Right-click the background and choose Run ‘guess_game’ from the menu.
  3. Since this program has the __main__ clause, you can click on the little green arrow to the left of the __main__ clause and choose Run ‘guess_game’ from there.

Use any one of the options above to run the program, and you’ll see the Run Tool pane appear at the bottom of the window, with your code output showing:

Play the game for a little bit to see if you can find the number guessed. Pro tip: start with 50.

Debugging in PyCharm

Did you find the number? If so, you may have seen something weird after you found the number. Instead of printing the congratulations message and exiting, the program seems to start over. That’s a bug right there. To discover why the program starts over, you’ll now debug the program.

First, place a breakpoint by clicking on the blank space to the left of line number 8:

Debug breakpoint in PyCharm

This will be the point where the program will be suspended, and you can start exploring what went wrong from there on. Next, choose one of the following three ways to start debugging:

  1. Press Ctrl + Shift + D on Mac or Shift + Alt + F9 on Windows or Linux.
  2. Right-click the background and choose Debug ‘guess_game’.
  3. Click on the little green arrow to the left of the __main__ clause and choose Debug ‘guess_game from there.

Afterwards, you’ll see a Debug window open at the bottom:

Start of debugging in PyCharm

Follow the steps below to debug the program:

Notice that the current line is highlighted in blue.

See that random_int and its value are listed in the Debug window. Make a note of this number. (In the picture, the number is 85.)

Hit F8 to execute the current line and step over to the next one. You can also use F7 to step into the function in the current line, if necessary. As you continue executing the statements, the changes in the variables will be automatically reflected in the Debugger window.

Notice that there is the Console tab right next to the Debugger tab that opened. This Console tab and the Debugger tab are mutually exclusive. In the Console tab, you will be interacting with your program, and in the Debugger tab you will do the debugging actions.

Switch to the Console tab to enter your guess.

Type the number shown, and then hit Enter .

Switch back to the Debugger tab.

Hit F8 again to evaluate the if statement. Notice that you are now on line 14. But wait a minute! Why didn’t it go to the line 11? The reason is that the if statement on line 10 evaluated to False . But why did it evaluate to False when you entered the number that was chosen?

Look carefully at line 10 and notice that we are comparing user_guess with the wrong thing. Instead of comparing it with random_int , we are comparing it with randint , the function that was imported from the random package.

Change it to random_int , restart the debugging, and follow the same steps again. You will see that, this time, it will go to line 11, and line 10 will evaluate to True :

Congratulations! You fixed the bug.

Testing in PyCharm

No application is reliable without unit tests. PyCharm helps you write and run them very quickly and comfortably. By default, unittest is used as the test runner, but PyCharm also supports other testing frameworks such as pytest , nose , doctest , tox , and trial . You can, for example, enable pytest for your project like this:

  1. Open the Settings/Preferences → Tools → Python Integrated Tools settings dialog.
  2. Select pytest in the Default test runner field.
  3. Click OK to save the settings.

For this example, we’ll be using the default test runner unittest .

In the same project, create a file called calculator.py and put the following Calculator class in it:

PyCharm makes it very easy to create tests for your existing code. With the calculator.py file open, execute any one of the following that you like:

  • Press Shift + Cmd + T on Mac or Ctrl + Shift + T on Windows or Linux.
  • Right-click in the background of the class and then choose Go To and Test.
  • On the main menu, choose Navigate → Test.

Choose Create New Test…, and you will see the following window:

Create tests in PyCharm

Leave the defaults of Target directory, Test file name, and Test class name. Select both of the methods and click OK. Voila! PyCharm automatically created a file called test_calculator.py and created the following stub tests for you in it:

Run the tests using one of the methods below:

  • Press Ctrl + R on Mac or Shift + F10 on Windows or Linux.
  • Right-click the background and choose Run ‘Unittests for test_calculator.py’.
  • Click on the little green arrow to the left of the test class name and choose Run ‘Unittests for test_calculator.py’.

You’ll see the tests window open on the bottom with all the tests failing:

Failed tests in PyCharm

Notice that you have the hierarchy of the test results on the left and the output of the terminal on the right.

Now, implement test_add by changing the code to the following:

Run the tests again, and you’ll see that one test passed and the other failed. Explore the options to show passed tests, to show ignored tests, to sort tests alphabetically, and to sort tests by duration:

Note that the sleep(0.1) method that you see in the GIF above is intentionally used to make one of the tests slower so that sorting by duration works.

Editing an Existing Project in PyCharm

These single file projects are great for examples, but you’ll often work on much larger projects over a longer period of time. In this section, you’ll take a look at how PyCharm works with a larger project.

To explore the project-focused features of PyCharm, you’ll use the Alcazar web framework that was built for learning purposes. To continue following along, download the sample project locally:

Download Sample Project: Click here to download the sample project you’ll use to explore the project-focused features of PyCharm in this tutorial.

Once you have the project downloaded and extracted locally, open it in PyCharm using one of the following methods:

  • Click File → Open on the main menu.
  • Click Open on the Welcome Screen if you are there.

After either of these steps, find the folder containing the project on your computer and open it.

If this project contains a virtual environment, then PyCharm will automatically use this virtual environment and make it the project interpreter.

If you need to configure a different virtualenv , then open Preferences on Mac by pressing Cmd + , or Settings on Windows or Linux by pressing Ctrl + Alt + S and find the Project: ProjectName section. Open the drop-down and choose Project Interpreter:

Project interpreter in PyCharm

Choose the virtualenv from the drop-down list. If it’s not there, then click on the settings button to the right of the drop-down list and then choose Add…. The rest of the steps should be the same as when we were creating a new project.

Searching and Navigating in PyCharm

In a big project where it’s difficult for a single person to remember where everything is located, it’s very important to be able to quickly navigate and find what you looking for. PyCharm has you covered here as well. Use the project you opened in the section above to practice these shortcuts:

  • Searching for a fragment in the current file: Press Cmd + F on Mac or Ctrl + F on Windows or Linux.
  • Searching for a fragment in the entire project: Press Cmd + Shift + F on Mac or Ctrl + Shift + F on Windows or Linux.
  • Searching for a class: Press Cmd + O on Mac or Ctrl + N on Windows or Linux.
  • Searching for a file: Press Cmd + Shift + O on Mac or Ctrl + Shift + N on Windows or Linux.
  • Searching all if you don’t know whether it’s a file, class, or a code fragment that you are looking for: Press Shift twice.

As for the navigation, the following shortcuts may save you a lot of time:

  • Going to the declaration of a variable: Press Cmd on Mac or Ctrl on Windows or Linux, and click on the variable.
  • Finding usages of a class, a method, or any symbol: Press Alt + F7 .
  • Seeing your recent changes: Press Shift + Alt + C or go to View → Recent Changes on the main menu.
  • Seeing your recent files: Press Cmd + E on Mac or Ctrl + E on Windows or Linux, or go to View → Recent Files on the main menu.
  • Going backward and forward through your history of navigation after you jumped around: Press Cmd + [ / Cmd + ] on Mac or Ctrl + Alt + Left / Ctrl + Alt + Right on Windows or Linux.

Using Version Control in PyCharm

Version control systems such as Git and Mercurial are some of the most important tools in the modern software development world. So, it is essential for an IDE to support them. PyCharm does that very well by integrating with a lot of popular VC systems such as Git (and Github), Mercurial, Perforce and, Subversion.

Note: Git is used for the following examples.

Configuring VCS

To enable VCS integration. Go to VCS → VCS Operations Popup… from the menu on the top or press Ctrl + V on Mac or Alt + ` on Windows or Linux. Choose Enable Version Control Integration…. You’ll see the following window open:

Enable Version Control Integration in PyCharm

Choose Git from the drop down list, click OK, and you have VCS enabled for your project. Note that if you opened an existing project that has version control enabled, then PyCharm will see that and automatically enable it.

Now, if you go to the VCS Operations Popup…, you’ll see a different popup with the options to do git add , git stash , git branch , git commit , git push and more:

VCS operations in PyCharm

If you can’t find what you need, you can most probably find it by going to VCS from the top menu and choosing Git, where you can even create and view pull requests.

Committing and Conflict Resolution

These are two features of VCS integration in PyCharm that I personally use and enjoy a lot! Let’s say you have finished your work and want to commit it. Go to VCS → VCS Operations Popup… → Commit… or press Cmd + K on Mac or Ctrl + K on Windows or Linux. You’ll see the following window open:

Commit window in PyCharm

In this window, you can do the following:

  1. Choose which files to commit
  2. Write your commit message
  3. Do all kinds of checks and cleanup before commit
  4. See the difference of changes
  5. Commit and push at once by pressing the arrow to the right of the Commit button on the right bottom and choosing Commit and Push…

It can feel magical and fast, especially if you’re used to doing everything manually on the command line.

When you work in a team, merge conflicts do happen. When somebody commits changes to a file that you’re working on, but their changes overlap with yours because both of you changed the same lines, then VCS will not be able to figure out if it should choose your changes or those of your teammate. So you’ll get these unfortunate arrows and symbols:

Conflicts in PyCharm

This looks strange, and it’s difficult to figure out which changes should be deleted and which ones should stay. PyCharm to the rescue! It has a much nicer and cleaner way of resolving conflicts. Go to VCS in the top menu, choose Git and then Resolve conflicts…. Choose the file whose conflicts you want to resolve and click on Merge. You will see the following window open:

Conflict resolving windown in PyCharm

On the left column, you will see your changes. On the right one, the changes made by your teammate. Finally, in the middle column, you will see the result. The conflicting lines are highlighted, and you can see a little X and >>/<< right beside those lines. Press the arrows to accept the changes and the X to decline. After you resolve all those conflicts, click the Apply button:

In the GIF above, for the first conflicting line, the author declined his own changes and accepted those of his teammates. Conversely, the author accepted his own changes and declined his teammates’ for the second conflicting line.

There’s a lot more that you can do with the VCS integration in PyCharm. For more details, see this documentation.

Using Plugins and External Tools in PyCharm

You can find almost everything you need for development in PyCharm. If you can’t, there is most probably a plugin that adds that functionality you need to PyCharm. For example, they can:

  • Add support for various languages and frameworks
  • Boost your productivity with shortcut hints, file watchers, and so on
  • Help you learn a new programming language with coding exercises

For instance, IdeaVim adds Vim emulation to PyCharm. If you like Vim, this can be a pretty good combination.

Material Theme UI changes the appearance of PyCharm to a Material Design look and feel:

Material Theme in PyCharm

Vue.js adds support for Vue.js projects. Markdown provides the capability to edit Markdown files within the IDE and see the rendered HTML in a live preview. You can find and install all of the available plugins by going to the Preferences → Plugins on Mac or Settings → Plugins on Windows or Linux, under the Marketplace tab:

Plugin Marketplace in PyCharm

If you can’t find what you need, you can even develop your own plugin.

If you can’t find the right plugin and don’t want to develop your own because there’s already a package in PyPI, then you can add it to PyCharm as an external tool. Take Flake8 , the code analyzer, as an example.

First, install flake8 in your virtualenv with pip install flake8 in the Terminal app of your choice. You can also use the one integrated into PyCharm:

Terminal in PyCharm

Then, go to Preferences → Tools on Mac or Settings → Tools on Windows/Linux, and then choose External Tools. Then click on the little + button at the bottom (1). In the new popup window, insert the details as shown below and click OK for both windows:

Flake8 tool in PyCharm

Here, Program (2) refers to the Flake8 executable that can be found in the folder /bin of your virtual environment. Arguments (3) refers to which file you want to analyze with the help of Flake8. Working directory is the directory of your project.

You could hardcode the absolute paths for everything here, but that would mean that you couldn’t use this external tool in other projects. You would be able to use it only inside one project for one file.

So you need to use something called Macros. Macros are basically variables in the format of $name$ that change according to your context. For example, $FileName$ is first.py when you’re editing first.py , and it is second.py when you’re editing second.py . You can see their list and insert any of them by clicking on the Insert Macro… buttons. Because you used macros here, the values will change according to the project you’re currently working on, and Flake8 will continue to do its job properly.

In order to use it, create a file example.py and put the following code in it:

It deliberately breaks some of the Flake8 rules. Right-click the background of this file. Choose External Tools and then Flake8. Voilà! The output of the Flake8 analysis will appear at the bottom:

Flake8 Output in PyCharm

In order to make it even better, you can add a shortcut for it. Go to Preferences on Mac or to Settings on Windows or Linux. Then, go to Keymap → External Tools → External Tools. Double-click Flake8 and choose Add Keyboard Shortcut. You’ll see this window:

Add shortcut in PyCharm

In the image above, the shortcut is Ctrl + Alt + A for this tool. Add your preferred shortcut in the textbox and click OK for both windows. Now you can now use that shortcut to analyze the file you’re currently working on with Flake8.

PyCharm Professional Features

PyCharm Professional is a paid version of PyCharm with more out-of-the-box features and integrations. In this section, you’ll mainly be presented with overviews of its main features and links to the official documentation, where each feature is discussed in detail. Remember that none of the following features is available in the Community edition.

Django Support

PyCharm has extensive support for Django, one of the most popular and beloved Python web frameworks. To make sure that it’s enabled, do the following:

  1. Open Preferences on Mac or Settings on Windows or Linux.
  2. Choose Languages and Frameworks.
  3. Choose Django.
  4. Check the checkbox Enable Django support.
  5. Apply changes.

Now that you’ve enabled Django support, your Django development journey will be a lot easier in PyCharm:

  • When creating a project, you’ll have a dedicated Django project type. This means that, when you choose this type, you’ll have all the necessary files and settings. This is the equivalent of using django-admin startproject mysite .
  • You can run manage.py commands directly inside PyCharm.
  • Django templates are supported, including:
    • Syntax and error highlighting
    • Code completion
    • Navigation
    • Completion for block names
    • Completion for custom tags and filters
    • Quick documentation for tags and filters
    • Capability to debug them

    For more details on Django support, see the official documentation.

    Database Support

    Modern database development is a complex task with many supporting systems and workflows. That’s why JetBrains, the company behind PyCharm, developed a standalone IDE called DataGrip for that. It’s a separate product from PyCharm with a separate license.

    Luckily, PyCharm supports all the features that are available in DataGrip through a plugin called Database tools and SQL, which is enabled by default. With the help of it, you can query, create and manage databases whether they’re working locally, on a server, or in the cloud. The plugin supports MySQL, PostgreSQL, Microsoft SQL Server, SQLite, MariaDB, Oracle, Apache Cassandra, and others. For more information on what you can do with this plugin, check out the comprehensive documentation on the database support.

    Thread Concurrency Visualization

    Django Channels , asyncio , and the recent frameworks like Starlette are examples of a growing trend in asynchronous Python programming. While it’s true that asynchronous programs do bring a lot of benefits to the table, it’s also notoriously hard to write and debug them. In such cases, Thread Concurrency Visualization can be just what the doctor ordered because it helps you take full control over your multi-threaded applications and optimize them.

    Profiler

    Speaking of optimization, profiling is another technique that you can use to optimize your code. With its help, you can see which parts of your code are taking most of the execution time. A profiler runs in the following order of priority:

    If you don’t have vmprof or yappi installed, then it’ll fall back to the standard cProfile . It’s well-documented, so I won’t rehash it here.

    Scientific Mode

    Python is not only a language for general and web programming. It also emerged as the best tool for data science and machine learning over these last years thanks to libraries and tools like NumPy, SciPy, scikit-learn, Matplotlib, Jupyter, and more. With such powerful libraries available, you need a powerful IDE to support all the functions such as graphing and analyzing those libraries have. PyCharm provides everything you need as thoroughly documented here.

    Remote Development

    One common cause of bugs in many applications is that development and production environments differ. Although, in most cases, it’s not possible to provide an exact copy of the production environment for development, pursuing it is a worthy goal.

    With PyCharm, you can debug your application using an interpreter that is located on the other computer, such as a Linux VM. As a result, you can have the same interpreter as your production environment to fix and avoid many bugs resulting from the difference between development and production environments. Make sure to check out the official documentation to learn more.

    Conclusion

    PyCharm is one of best, if not the best, full-featured, dedicated, and versatile IDEs for Python development. It offers a ton of benefits, saving you a lot of time by helping you with routine tasks. Now you know how to be productive with it!

    In this article, you learned about a lot, including:

    • Installing PyCharm
    • Writing code in PyCharm
    • Running your code in PyCharm
    • Debugging and testing your code in PyCharm
    • Editing an existing project in PyCharm
    • Searching and navigating in PyCharm
    • Using Version Control in PyCharm
    • Using Plugins and External Tools in PyCharm
    • Using PyCharm Professional features, such as Django support and Scientific mode

    If there’s anything you’d like to ask or share, please reach out in the comments below. There’s also a lot more information at the PyCharm website for you to explore.

    Download Sample Project: Click here to download the sample project you’ll use to explore the project-focused features of PyCharm in this tutorial.

    Как настроить pycharm для python

    В прошлой теме было описано создание простейшего скрипта на языке Python. Для создания скрипта использовался текстовый редактор. В моем случае это был Notepad++. Но есть и другой способ создания программ, который представляет использование различных интегрированных сред разработки или IDE.

    IDE предоставляют нам текстовый редактор для набора кода, но в отличие от стандартных текстовых редакторов, IDE также обеспечивает полноценную подсветку синтаксиса, автодополнение или интеллектуальную подсказку кода, возможность тут же выполнить созданный скрипт, а также многое другое.

    Для Python можно использовать различные среды разработки, но одной из самых популярных из них является среда PyCharm , созданная компанией JetBrains. Эта среда динамично развивается, постоянно обновляется и доступна для наиболее распространенных операционных систем — Windows, MacOS, Linux.

    Правда, она имеет одно важное ограничение. А именно она доступна в двух основных вариантах: платный выпуск Professional и бесплатный Community. Многие базовые возможности доступны и в бесплатном выпуске Community. В то же время ряд возможностей, например, веб-разработка, доступны только в платном Professional.

    В нашем случае воспользуемся бесплатным выпуском Community. Для этого перейдем на страницу загрузки и загрузим установочный файл PyCharm Community.

    IDE PyCharm

    После загрузки выполним его установку.

    Установка PyCharm

    После завершения установки запустим программу. При первом запуске открывается начальное окно:

    Первая программа в PyCharm

    Создадим проект и для этого выберем пункт New Project .

    Далее нам откроется окно для настройки проекта. В поле Location необходимо указать путь к проекту. В моем случае проект будет помещаться в папку HelloApp. Собственно название папки и будет названием проекта.

    Настройка проекта в PyCharm

    Кроме пути к проекту все остальные настройки оставим по умолчанию и нажмем на кнопку Create для создания проекта.

    После этого будет создан пустой проект:

    Первый проект в PyCharm

    В центре среды будет открыт файл main.py с некоторым содержимым по умолчанию.

    Теперь создадим простейшую программу. Для этого изменим код файла main.py следующим образом:

    Для запуска скрипта нажмем на зеленую стрелку в панели инструментов программы:

    Запуск программы в PyCharm

    Также для запуска можно перейти в меню Run и там нажать на подпункт Run ‘main’ )

    После этого внизу IDE отобразится окно вывода, где надо будет ввести имя и где после этого будет выведено приветствие:

    PyCharm для продуктивной разработки Python (Руководство)

    PyCharm для продуктивной разработки Python (Руководство)

    Как программист, вы должны сосредоточиться на бизнес-логике и создании полезных приложений для ваших пользователей. При этомPyCharm byJetBrains экономит ваше время, заботясь о рутине и облегчая ряд других задач, таких как отладка и визуализация.

    В этой статье вы узнаете о:

    Написание кода в PyCharm

    Выполнение вашего кода в PyCharm

    Отладка и тестирование вашего кода в PyCharm

    Редактирование существующего проекта в PyCharm

    Поиск и навигация в PyCharm

    Использование контроля версий в PyCharm

    Использование плагинов и внешних инструментов в PyCharm

    Использование функций PyCharm Professional, таких как поддержка Django и научный режим

    В этой статье предполагается, что вы знакомы с разработкой Python, и в вашей системе уже установлена ​​какая-то форма Python. Python 3.6 будет использоваться для этого урока. Скриншоты и демонстрации предоставлены для macOS. Поскольку PyCharm работает на всех основных платформах, вы можете увидеть немного разные элементы пользовательского интерфейса и, возможно, потребуется изменить определенные команды.

    Note:

    PyCharm выпускается в трех редакциях:

    PyCharm Edu предоставляется бесплатно и в образовательных целях.

    PyCharm Community также бесплатен и предназначен для разработки на чистом Python.

    PyCharm Professional платный, имеет все, что есть в версии Community, а также очень хорошо подходит для веб-разработки и научных разработок с поддержкой таких фреймворков, как Django и Flask, Database и SQL, а также научных инструментов, таких как Jupyter.

    Чтобы узнать больше об их различиях, ознакомьтесь сPyCharm Editions Comparison Matrix от JetBrains. У компании также естьspecial offers для студентов, преподавателей, проектов с открытым исходным кодом и других кейсов.

    Clone Repo:Click here to clone the repo you’ll use, чтобы изучить в этом руководстве функции PyCharm, ориентированные на проекты.

    Установка PyCharm

    В этой статье будет использоваться PyCharm Community Edition 2019.1, поскольку она бесплатна и доступна на любой основной платформе. Только раздел о профессиональных функциях будет использовать PyCharm Professional Edition 2019.1.

    Рекомендуемый способ установки PyCharm -JetBrains Toolbox App. С его помощью вы сможете устанавливать различные продукты JetBrains или несколько версий одного и того же продукта, обновлять, выполнять откат и легко удалять любые инструменты при необходимости. Вы также сможете быстро открыть любой проект в нужной IDE и версии.

    Чтобы установить приложение Toolbox, обратитесь кdocumentation от JetBrains. Это автоматически даст вам правильные инструкции в зависимости от вашей ОС. В случае, если она не распознает вашу ОС правильно, вы всегда можете найти ее в раскрывающемся списке в правом верхнем углу:

    List of OSes in the JetBrains website

    После установки запустите приложение и примите пользовательское соглашение. На вкладкеTools вы увидите список доступных продуктов. Найдите там сообщество PyCharm и нажмитеInstall:

    PyCharm installed with the Toolbox app

    Вуаля! У вас есть PyCharm на вашем компьютере. Если вы не хотите использовать приложение Toolbox, вы также можете выполнитьstand-alone installation of PyCharm.

    Запустите PyCharm, и вы увидите всплывающее окно настроек импорта:

    PyCharm Import Settings Popup

    PyCharm автоматически определит, что это новая установка, и выберет для васDo not import settings. ЩелкнитеOK, и PyCharm попросит вас выбрать схему раскладки клавиатуры. Оставьте значение по умолчанию и щелкнитеNext: UI Themes справа внизу:

    PyCharm Keymap Scheme

    Затем PyCharm попросит вас выбрать темную тему под названием Darcula или светлую тему. Выберите то, что вам больше нравится, и нажмитеNext: Launcher Script:

    PyCharm Set UI Theme Page

    В этом уроке я буду использовать темную тему Даркула. Вы можете найти и установить другие темы какplugins или какimport them.

    На следующей странице оставьте значения по умолчанию и щелкнитеNext: Featured plugins. Там PyCharm покажет вам список плагинов, которые вы, возможно, захотите установить, потому что большинству пользователей нравится их использовать. ЩелкнитеStart using PyCharm, и теперь вы готовы написать код!

    Написание кода в PyCharm

    В PyCharm вы все делаете в контекстеproject. Таким образом, первое, что вам нужно сделать, это создать.

    После установки и открытия PyCharm вы попадаете на экран приветствия. НажмитеCreate New Project, и вы увидите всплывающее окноNew Project:

    New Project in PyCharm

    Укажите местоположение проекта и разверните раскрывающийся списокProject Interpreter. Здесь у вас есть возможность создать новый интерпретатор проекта или повторно использовать существующий. ВыберитеNew environment using. Рядом с ним у вас есть раскрывающийся список для выбора одного изVirtualenv,Pipenv илиConda, которые являются инструментами, которые помогают разделить зависимости, необходимые для разных проектов, путем создания изолированные среды Python для них.

    Вы можете выбрать то, что вам нравится, но для этого урока используетсяVirtualenv. При желании вы можете указать местоположение среды и выбрать базовый интерпретатор из списка, который представляет собой список интерпретаторов Python (таких как Python2.7 и Python3.6), установленных в вашей системе. Обычно с настройками по умолчанию все в порядке. Затем вы должны выбрать блоки для наследования глобальных пакетов сайтов в вашей новой среде и сделать их доступными для всех других проектов. Оставьте их невыбранными.

    ЩелкнитеCreate в правом нижнем углу, и вы увидите созданный новый проект:

    Project created in PyCharm

    Вы также увидите небольшое всплывающее окноTip of the Day, в котором PyCharm дает вам один трюк, который нужно изучить при каждом запуске. Идите и закройте это всплывающее окно.

    Настало время начать новую программу на Python. Введите Cmd [.kbd .key-n]#N## if you are on Mac or [.keys]#[.kbd .key-alt]##Alt##[.kbd .key-insert]#Ins #, если вы работаете в Windows или Linux. Затем выберитеPython File. Вы также можете выбратьFile → New из меню. Назовите новый файл guess_game.py и щелкнитеOK. Вы увидите окно PyCharm, подобное следующему:

    PyCharm New File

    Для нашего тестового кода давайте быстро создадим простую игру на угадывание, в которой программа выбирает число, которое должен угадать пользователь. Для каждого предположения программа скажет, было ли предположение пользователя меньше или больше секретного числа. Игра заканчивается, когда пользователь угадывает число. Вот код для игры:

    Введите этот код напрямую, а не копировать и вставлять. Вы увидите что-то вроде этого:

    Как видите, PyCharm предоставляетIntelligent Coding Assistance автозавершение кода, инспекцию кода, выделение ошибок на лету и предложения по быстрому исправлению. В частности, обратите внимание, как когда вы набираете main и затем нажимаете вкладку, PyCharm автоматически завершает за вас все предложение main .

    Также обратите внимание, как, если вы забыли ввести if перед условием, добавить .if , а затем нажать [.kbd .key-tab]#Tab #, PyCharm исправит предложение if за вас. То же самое и с True.while . ЭтоPyCharm’s Postfix completions работает на вас, чтобы уменьшить количество обратных переходов курсора.

    Запуск кода в PyCharm

    Теперь, когда вы написали код, пришло время запустить его.

    У вас есть три способа запуска этой программы:

    Используйте ярлык Ctrl [.kbd .key-shift]##Shift##[.kbd .key-r]#R on Mac or [.keys] [.kbd .key-control] Ctrl [.kbd .key-shift]##Shift##[.kbd .key-f10]#F10 в Windows или Linux.

    Щелкните фон правой кнопкой мыши и выберите в менюRun ‘guess_game’.

    Поскольку в этой программе есть предложение __main__ , вы можете щелкнуть маленькую зеленую стрелку слева от предложения __main__ и выбрать оттудаRun ‘guess_game’.

    Используйте любой из приведенных выше вариантов для запуска программы, и вы увидите панель «Run Tool», появившуюся в нижней части окна, с выводом кода, показывающим:

    Сыграйте в игру немного, чтобы увидеть, сможете ли вы найти угаданное число. Совет профессионала: начните с 50.

    Отладка в PyCharm

    Вы нашли номер? Если так, то, возможно, вы увидели что-то странное после того, как нашли номер. Вместо того, чтобы печатать поздравительное сообщение и выходить, программа, кажется, запускается заново. Это ошибка прямо здесь. Чтобы выяснить, почему программа запускается заново, вы должны отладить программу.

    Сначала установите точку останова, нажав на пустое место слева от строки № 8:

    Debug breakpoint in PyCharm

    Это будет момент, когда программа будет приостановлена, и вы можете начать исследовать, что пошло не так с этого момента. Затем выберите один из следующих трех способов начать отладку:

    Нажмите Ctrl [.kbd .key-shift]##Shift##[.kbd .key-d]#D on Mac or [.keys] [.kbd .key-shift] Shift [.kbd .key-alt]##Alt##[.kbd .key-f9]#F9 в Windows или Linux.

    Щелкните фон правой кнопкой мыши и выберитеDebug ‘guess_game’.

    Щелкните маленькую зеленую стрелку слева от предложения __main__ и выберите оттудаDebug ‘guess_game.

    После этого вы увидите открытое окноDebug внизу:

    Start of debugging in PyCharm

    Для отладки программы выполните следующие действия:

    Обратите внимание, что текущая строка выделена синим цветом.

    Посмотрите, что random_int и его значение перечислены в окне отладки. Запишите этот номер. (На рисунке номер 85.)

    При необходимости нажмите [.kbd .key-f8]#F8 to execute the current line and step over to the next one. You can also use [.keys] [.kbd .key-f7] # F7, чтобы перейти кinto функции в текущей строке. Когда вы продолжите выполнять операторы, изменения в переменных будут автоматически отражены в окне отладчика.

    Обратите внимание, что рядом с открывшейся вкладкой «Отладчик» находится вкладка «Консоль». Эта вкладка Консоль и вкладка Отладчик являются взаимоисключающими. На вкладке Консоль вы будете взаимодействовать с вашей программой, а на вкладке Отладчик вы будете выполнять действия по отладке.

    Переключитесь на вкладку Консоль, чтобы ввести свое предположение.

    Введите показанное число и нажмите [.kbd .key-enter]#Enter #.

    Вернитесь на вкладку «Отладчик».

    Нажмите [.kbd .key-f8]#F8 # еще раз, чтобы оценить оператор if . Обратите внимание, что вы сейчас на линии 14. Но подожди минутку! Почему он не пошел на линию 11? Причина в том, что оператор if в строке 10 оценивается как False . Но почему при вводе выбранного числа он оценивается как False ?

    Внимательно посмотрите на строку 10 и обратите внимание, что мы сравниваем user_guess не с тем. Вместо того, чтобы сравнивать его с random_int , мы сравниваем его с randint , функцией, которая была импортирована из пакета random .

    Измените его на random_int , перезапустите отладку и снова выполните те же действия. Вы увидите, что на этот раз он перейдет к строке 11, а строка 10 будет оценивать как True :

    Поздравляем! Вы исправили ошибку.

    Тестирование в PyCharm

    Ни одно приложение не является надежным без юнит-тестов. PyCharm помогает вам писать и запускать их очень быстро и удобно. По умолчанию unittest используется как средство запуска тестов, но PyCharm также поддерживает другие среды тестирования, такие как pytest , nose , doctest , tox и trial с. Вы можете, например, включить pytest для своего проекта следующим образом:

    Откройте диалоговое окно настроекSettings/Preferences → Tools → Python Integrated Tools.

    Выберите pytest в поле Запуск теста по умолчанию.

    ЩелкнитеOK, чтобы сохранить настройки.

    В этом примере мы будем использовать средство запуска тестов по умолчанию unittest .

    В том же проекте создайте файл с именем calculator.py и поместите в него следующий класс Calculator :

    PyCharm позволяет очень легко создавать тесты для существующего кода. Открыв файл calculator.py , выполните любое из следующих действий:

    Нажмите Shift [.kbd .key-command]##Cmd##[.kbd .key-t]#T on Mac or [.keys] [.kbd .key-control] Ctrl [.kbd .key-shift]##Shift##[.kbd .key-t]#T в Windows или Linux.

    Щелкните правой кнопкой мыши фон класса и выберитеGo To иTest.

    В главном меню выберитеNavigate → Test.

    ВыберитеCreate New Test…, и вы увидите следующее окно:

    Create tests in PyCharm

    Оставьте значения по умолчаниюTarget directory,Test file name иTest class name. Выберите оба метода и щелкнитеOK. Вуаля! PyCharm автоматически создал файл с именем test_calculator.py и создал для вас следующие тесты-заглушки:

    Запустите тесты одним из следующих способов:

    Нажмите Ctrl [.kbd .key-r]#R## on Mac or [.keys]#[.kbd .key-shift]##Shift##[.kbd .key-f10]#F10 # в Windows или Linux.

    Щелкните фон правой кнопкой мыши и выберитеRun ‘Unittests for test_calculator.py’.

    Щелкните маленькую зеленую стрелку слева от имени тестового класса и выберитеRun ‘Unittests for test_calculator.py’.

    Вы увидите открытое окно тестов с ошибками всех тестов:

    Failed tests in PyCharm

    Обратите внимание, что у вас есть иерархия результатов теста слева и вывод терминала справа.

    Теперь реализуйте test_add , изменив код на следующий:

    Запустите тесты еще раз, и вы увидите, что один тест пройден, а другой не пройден. Изучите варианты отображения пройденных тестов, отображения игнорируемых тестов, сортировки тестов по алфавиту и сортировки тестов по продолжительности:

    Обратите внимание, что метод sleep(0.1) , который вы видите в приведенном выше GIF-файле, намеренно используется для замедления одного из тестов, чтобы работала сортировка по продолжительности.

    Редактирование существующего проекта в PyCharm

    Эти однофайловые проекты отлично подходят для примеров, но вы часто будете работать над гораздо более крупными проектами в течение более длительного периода времени. В этом разделе вы узнаете, как PyCharm работает с большим проектом.

    Чтобы изучить возможности PyCharm, ориентированные на проекты, вы будете использовать веб-фреймворк Alcazar, созданный для целей обучения. Чтобы продолжить, скопируйте репо локально:

    Clone Repo:Click here to clone the repo you’ll use, чтобы изучить в этом руководстве функции PyCharm, ориентированные на проекты.

    Если у вас есть проект локально, откройте его в PyCharm одним из следующих способов:

    ЩелкнитеFile → Open в главном меню.

    ЩелкнитеOpen наWelcome Screen, если вы там.

    После любого из этих шагов найдите папку, содержащую проект на вашем компьютере, и откройте ее.

    Если этот проект содержитvirtual environment, тогда PyCharm автоматически использует эту виртуальную среду и сделает ее интерпретатором проекта.

    Если вам нужно настроить другой virtualenv , откройтеPreferences на Mac, нажав Cmd [.kbd .key-comma]#,## or _Settings_ on Windows or Linux by pressing [.keys]#[.kbd .key-control]##Ctrl## Alt +[.kbd .key-s]#S # и найдите разделProject: ProjectName. Откройте раскрывающийся список и выберитеProject Interpreter:

    Project interpreter in PyCharm

    Выберите virtualenv из раскрывающегося списка. Если его там нет, нажмите кнопку настроек справа от раскрывающегося списка и выберитеAdd…. Остальные шаги должны быть такими же, как когда мы былиcreating a new project.

    Поиск и навигация в PyCharm

    В большом проекте, где одному человеку трудно запомнить, где все находится, очень важно иметь возможность быстро ориентироваться и находить то, что вы ищете. PyCharm также охватил вас. Используйте проект, который вы открыли в разделе выше, чтобы попрактиковаться в этих сочетаниях клавиш:

    Searching for a fragment in the current file: Нажмите Cmd [.kbd .key-f]#F## on Mac or [.keys]#[.kbd .key-control]##Ctrl##[.kbd .key-f]#F # в Windows или Linux.

    Searching for a fragment in the entire project: Нажмите Cmd [.kbd .key-shift]##Shift##[.kbd .key-f]#F on Mac or [.keys] [.kbd .key-control] Ctrl [.kbd .key-shift]##Shift##[.kbd .key-f]#F в Windows или Linux.

    Searching for a class: Нажмите Cmd [.kbd .key-o]#O## on Mac or [.keys]#[.kbd .key-control]##Ctrl##[.kbd .key-n]#N # в Windows или Linux.

    Searching for a file: Нажмите Cmd [.kbd .key-shift]##Shift##[.kbd .key-o]#O on Mac or [.keys] [.kbd .key-control] Ctrl [.kbd .key-shift]##Shift##[.kbd .key-n]#N в Windows или Linux.

    Searching all if you don’t know whether it’s a file, class, or a code fragment that you are looking for: Дважды нажмите [.kbd .key-shift]#Shift #.

    Что касается навигации, следующие ярлыки могут сэкономить вам много времени:

    Going to the declaration of a variable: Нажмите [.kbd .key-command]#Cmd on Mac or [.keys] [.kbd .key-control] #Ctrl в Windows или Linux и щелкните по переменной.

    Finding usages of a class, a method, or any symbol: Нажмите Alt +[.kbd .key-f7]#F7 #.

    Seeing your recent changes: Нажмите Shift [.kbd .key-alt]##Alt##[.kbd .key-c]#C # или перейдите кView → Recent Changes в главном меню.

    Seeing your recent files: Нажмите Cmd [.kbd .key-e]#E## on Mac or [.keys]#[.kbd .key-control]##Ctrl##[.kbd .key-e]#E # в Windows или Linux или перейдите кView → Recent Files в главном меню.

    Going backward and forward through your history of navigation after you jumped around: Нажмите Cmd [.kbd .key-bracket-left]#[## / [.keys]#[.kbd .key-command]##Cmd##[.kbd .key-bracket-right] ] on Mac or [.kbd .key-control] Ctrl [.kbd .key-alt]##Alt##[.kbd .key-arrow-left]#Left / [.keys] Ctrl [.kbd .key-alt] ## Alt ## Right # в Windows или Linux.

    Использование контроля версий в PyCharm

    Системы контроля версий, такие какGit иMercurial, являются одними из самых важных инструментов в современном мире разработки программного обеспечения. Поэтому для IDE важно поддерживать их. PyCharm делает это очень хорошо, интегрируясь с множеством популярных систем VC, таких как Git (иGithub), Mercurial,Perforce иSubversion.

    Note:Git используется в следующих примерах.

    Настройка VCS

    Чтобы включить интеграцию VCS. Перейдите кVCS → VCS Operations Popup… из меню вверху или нажмите Ctrl [.kbd .key-v]#V## on Mac or [.keys]#[.kbd .key-alt]##Alt##[.kbd .key-grave] ` ## в Windows или Linux. ВыберитеEnable Version Control Integration…. Вы увидите следующее открытое окно:

    Enable Version Control Integration in PyCharm

    ВыберитеGit из раскрывающегося списка, щелкнитеOK, и у вас включен VCS для вашего проекта. Обратите внимание, что если вы открыли существующий проект с включенным контролем версий, PyCharm увидит это и автоматически включит его.

    Теперь, если вы перейдете кVCS Operations Popup…, вы увидите другое всплывающее окно с вариантами выполнения git add , git stash , git branch , git commit , git push и другие:

    VCS operations in PyCharm

    Если вы не можете найти то, что вам нужно, вы, скорее всего, сможете найти это, перейдя вVCS в верхнем меню и выбравGit, где вы даже можете создавать и просматривать запросы на вытягивание.

    Фиксация и разрешение конфликтов

    Это две особенности интеграции VCS в PyCharm, которые я лично использую и получаю огромное удовольствие! Допустим, вы завершили свою работу и хотите ее совершить. Перейдите кVCS → VCS Operations Popup… → Commit… или нажмите Cmd [.kbd .key-k]#K## on Mac or [.keys]#[.kbd .key-control]##Ctrl##[.kbd .key-k]#K # в Windows или Linux. Вы увидите следующее открытое окно:

    Commit window in PyCharm

    В этом окне вы можете сделать следующее:

    Выберите файлы для фиксации

    Напишите ваше сообщение

    Сделайте всевозможные проверки и очисткуbefore commit

    Увидеть разницу изменений

    Зафиксируйте и нажмите сразу, нажав стрелку справа от кнопкиCommit в правом нижнем углу и выбравCommit and Push…

    Это может показаться волшебным и быстрым, особенно если вы привыкли делать все вручную в командной строке.

    Когда вы работаете в команде,merge conflicts случается. Когда кто-то фиксирует изменения в файле, над которым вы работаете, но их изменения пересекаются с вашими, потому что вы оба изменили одни и те же строки, VCS не сможет определить, стоит ли выбирать ваши изменения или изменения вашего товарища по команде. Таким образом, вы получите эти несчастные стрелки и символы:

    Conflicts in PyCharm

    Это выглядит странно, и трудно понять, какие изменения следует удалить, а какие оставить. PyCharm на помощь! У него гораздо приятнее и понятнее способ разрешения конфликтов. Перейдите кVCS в верхнем меню, выберитеGit, а затемResolve conflicts…. Выберите файл, конфликты которого вы хотите разрешить, и нажмитеMerge. Вы увидите следующее открытое окно:

    Conflict resolving windown in PyCharm

    В левой колонке вы увидите ваши изменения. Справа — изменения, внесенные вашим товарищем по команде. Наконец, в среднем столбце вы увидите результат. Конфликтующие строки выделены, и вы можете увидеть маленькиеX и>> /<< прямо рядом с этими строками. Нажмите стрелки, чтобы принять изменения, иX, чтобы отклонить. После устранения всех этих конфликтов нажмите кнопкуApply:

    В приведенном выше GIF для первой конфликтующей строки автор отклонил свои изменения и принял изменения своих товарищей по команде. И наоборот, автор принял свои собственные изменения и отклонил своих партнеров по команде для второй конфликтующей строки.

    Вы можете сделать гораздо больше с интеграцией VCS в PyCharm. Подробнее см.this documentation.

    Использование плагинов и внешних инструментов в PyCharm

    Вы можете найти почти все, что вам нужно для разработки в PyCharm. Если вы не можете этого сделать, скорее всего, существуетplugin, который добавляет необходимые вам функции в PyCharm. Например, они могут:

    Добавить поддержку для различных языков и структур

    Повысьте свою производительность с помощью ярлыков, средств просмотра файлов и т. Д.

    Помочь вам выучить новый язык программирования с помощью упражнений по кодированию

    Например,IdeaVim добавляет эмуляцию Vim в PyCharm. Если вам нравится Vim, это может быть очень хорошая комбинация.

    Material Theme UI изменяет внешний вид PyCharm на внешний вид Material Design:

    Material Theme in PyCharm

    Vue.js добавляет поддержку проектовVue.js. Markdown предоставляет возможность редактировать файлы Markdown в среде IDE и просматривать визуализированный HTML-код в режиме предварительного просмотра. Вы можете найти и установить все доступные плагины, перейдя вPreferences → Plugins на Mac илиSettings → Plugins на Windows или Linux, на вкладкеMarketplace:

    Plugin Marketplace in PyCharm

    Если вы не можете найти то, что вам нужно, можете дажеdevelop your own plugin.

    Если вы не можете найти нужный плагин и не хотите разрабатывать свой собственный, потому что в PyPI уже есть пакет, вы можете добавить его в PyCharm в качестве внешнего инструмента. Возьмем для примера анализатор кода Flake8 .

    Сначала установите flake8 в свой виртуальный сервер с помощью pip install flake8 в приложении терминала по вашему выбору. Вы также можете использовать тот, который интегрирован в PyCharm:

    Terminal in PyCharm

    Затем перейдите кPreferences → Tools на Mac илиSettings → Tools на Windows / Linux, а затем выберитеExternal Tools. Затем нажмите маленькую кнопку+ внизу (1). В новом всплывающем окне вставьте детали, как показано ниже, и щелкнитеOK для обоих окон:

    Flake8 tool in PyCharm

    ЗдесьProgram (2) относится к исполняемому файлу Flake8, который находится в папке/bin вашей виртуальной среды. Arguments (3) указывает, какой файл вы хотите проанализировать с помощью Flake8. Working directory — это каталог вашего проекта.

    Вы можете жестко указать здесь абсолютные пути для всего, но это будет означать, что вы не сможете использовать этот внешний инструмент в других проектах. Вы сможете использовать его только внутри одного проекта для одного файла.

    Поэтому вам нужно использовать что-то под названиемMacros. Макросы — это в основном переменные в формате $name$ , которые меняются в зависимости от вашего контекста. Например, $FileName$ — это first.py , когда вы редактируете first.py , и second.py , когда вы редактируете second.py . Вы можете просмотреть их список и вставить любой из них, нажав на кнопкиInsert Macro…. Поскольку вы использовали здесь макросы, значения будут меняться в зависимости от проекта, над которым вы сейчас работаете, и Flake8 продолжит правильно выполнять свою работу.

    Чтобы использовать его, создайте файл example.py и поместите в него следующий код:

    Это намеренно нарушает некоторые правила Flake8. Щелкните правой кнопкой мыши фон этого файла. ВыберитеExternal Tools, а затемFlake8. Вуаля! Результат анализа Flake8 появится внизу:

    Flake8 Output in PyCharm

    Чтобы сделать его еще лучше, вы можете добавить ярлык для него. Перейдите кPreferences на Mac или кSettings в Windows или Linux. Затем перейдите кKeymap → External Tools → External Tools. Дважды щелкнитеFlake8 и выберитеAdd Keyboard Shortcut. Вы увидите это окно:

    Add shortcut in PyCharm

    На изображении выше ярлык для этого инструмента Ctrl [.kbd .key-alt]##Alt##[.kbd .key-a]#A #. Добавьте желаемый ярлык в текстовое поле и щелкнитеOK для обоих окон. Теперь вы можете использовать этот ярлык для анализа файла, над которым вы сейчас работаете с Flake8.

    PyCharm Professional Особенности

    PyCharm Professional — это платная версия PyCharm с большим количеством готовых функций и интеграций. В этом разделе вам в основном будут представлены обзоры его основных функций и ссылки на официальную документацию, где каждая функция подробно обсуждается. Помните, что ни одна из следующих функций не доступна в версии для сообщества.

    Поддержка Django

    PyCharm имеет обширную поддержкуDjango, одного из самых популярных и любимыхPython web frameworks. Чтобы убедиться, что он включен, выполните следующие действия:

    ОткройтеPreferences на Mac илиSettings в Windows или Linux.

    ВыберитеLanguages and Frameworks.

    Установите флажокEnable Django support.

    Теперь, когда вы включили поддержку Django, ваш путь развития Django будет намного проще в PyCharm:

    При создании проекта у вас будет выделенный тип проекта Django. Это означает, что при выборе этого типа у вас будут все необходимые файлы и настройки. Это эквивалент использования django-admin startproject mysite .

    Команды manage.py можно запускать прямо внутри PyCharm.

    Поддерживаются шаблоны Django, в том числе:

    Синтаксис и подсветка ошибок

    Завершение для имен блоков

    Завершение для пользовательских тегов и фильтров

    Быстрая документация по тегам и фильтрам

    Возможность их отладки

    Завершение кода во всех других частях Django, таких как представления, URL-адреса и модели, а также поддержка анализа кода для Django ORM.

    Диаграммы зависимостей моделей для моделей Джанго.

    Дополнительные сведения о поддержке Django см. Вofficial documentation.

    Поддержка базы данных

    Современная разработка баз данных — сложная задача со множеством вспомогательных систем и рабочих процессов. Вот почему JetBrains, компания, стоящая за PyCharm, разработала для этого автономную среду IDE под названиемDataGrip. Это отдельный продукт от PyCharm с отдельной лицензией.

    К счастью, PyCharm поддерживает все функции, доступные в DataGrip, через плагин под названиемDatabase tools and SQL, который по умолчанию включен. С его помощью вы можете запрашивать, создавать и управлять базами данных независимо от того, работают ли они локально, на сервере или в облаке. Плагин поддерживает MySQL, PostgreSQL, Microsoft SQL Server, SQLite, MariaDB, Oracle, Apache Cassandra и другие. Для получения дополнительной информации о том, что вы можете делать с этим плагином, ознакомьтесь сthe comprehensive documentation on the database support.

    Визуализация параллелизма потоков

    Django Channels , asyncio и недавние фреймворки, такие как Starlette , являются примерами растущей тенденции в асинхронном программировании на Python. Несмотря на то, что асинхронные программы действительно приносят много пользы, известно, что их также сложно писать и отлаживать. В таких случаяхThread Concurrency Visualization может быть именно тем, что доктор прописал, потому что он помогает вам полностью контролировать свои многопоточные приложения и оптимизировать их.

    Profiler

    Говоря об оптимизации, профилирование — это еще один метод, который вы можете использовать для оптимизации вашего кода. С его помощью вы можете увидеть, какие части вашего кода занимают большую часть времени выполнения. Профилировщик работает в следующем порядке приоритета:

    Если у вас не установлены vmprof или yappi , то он вернется к стандартному cProfile . Этоwell-documented, поэтому я не буду его здесь повторять.

    Научный режим

    Python — это не только язык для общего и веб-программирования. Он также стал лучшим инструментом для науки о данных и машинного обучения за последние годы благодаря библиотекам и инструментам, таким какNumPy,SciPy,scikit-learn,Matplotlib,Jupyter. ) s и многое другое. При наличии таких мощных библиотек вам необходима мощная IDE для поддержки всех функций, таких как построение графиков и анализ этих библиотек. PyCharm предоставляет все необходимое в видеthoroughly documented here.

    Удаленная разработка

    Одной из распространенных причин ошибок во многих приложениях является то, что среды разработки и производства отличаются. Хотя в большинстве случаев невозможно предоставить точную копию производственной среды для разработки, достижение этой цели является достойной.

    С PyCharm вы можете отлаживать свое приложение с помощью интерпретатора, расположенного на другом компьютере, например на виртуальной машине Linux. В результате вы можете иметь тот же интерпретатор, что и ваша производственная среда, для исправления и предотвращения множества ошибок, возникающих в результате различий между средой разработки и производственной средой. Обязательно ознакомьтесь сofficial documentation, чтобы узнать больше.

    Заключение

    PyCharm является одной из лучших, если не лучшими, полнофункциональными, выделенными и универсальными IDE для разработки на Python. Он предлагает массу преимуществ, экономя вам много времени, помогая вам с рутинными задачами. Теперь вы знаете, как с этим работать!

    В этой статье вы узнали о многом, в том числе:

    Написание кода в PyCharm

    Выполнение вашего кода в PyCharm

    Отладка и тестирование вашего кода в PyCharm

    Редактирование существующего проекта в PyCharm

    Поиск и навигация в PyCharm

    Использование контроля версий в PyCharm

    Использование плагинов и внешних инструментов в PyCharm

    Использование функций PyCharm Professional, таких как поддержка Django и научный режим

    Если вы хотите что-то спросить или поделиться, пожалуйста, обратитесь к комментариям ниже. ВPyCharm website также есть много дополнительной информации, которую вы можете изучить.

    Clone Repo:Click here to clone the repo you’ll use, чтобы изучить в этом руководстве функции PyCharm, ориентированные на проекты.

    2.2. Практикум¶

    При выполнении заданий используйте заготовки решений: -> Репозиторий.

    2.2.1. Установка и настройка¶

    В настоящем курсе используются Python 3.5, Geany 1.30, Atom 1.23 и PyCharm 2019, однако могут быть установлены и их более свежие версии.

    2.2.1.1. Python¶

    Для установки Python необходимо выполнить ряд действий в зависимости от ОС:

    определить разрядность ОС (32- или 64-битная, инструкции для Windows, Mac OS X или Linux);

    открыть страницу загрузки (общая) и загрузить соответствующий дистрибутив;

    выполнить установку (при установке на ОС Windows необходимо установить флажок Add python.exe to PATH во время установки).

    В дистрибутивах Linux с пакетным менеджером, удобнее использовать его команды, например:

    После установки запустите терминал и убедитесь, что необходимая версия Python установлена.

    2.2.1.1.1. Дополнительные пакеты¶

    Задания, выполняемые на Python, должны проходить автоматическую проверку (валидацию) и соответствовать стандарту оформления PEP 8. Для поддержки этой возможности откройте терминал в папке с tests (в папке с заданиями) и выполните команду установки:

    Запуск проверки отдельно для каждой IDE описан далее.

    2.2.1.2. IDE¶

    В рамках курса возможности Atom, Geany и PyCharm не отличаются, поэтому выбор остается за Вами: Atom и PyCharm являются более современными и популярными IDE, в то время как Geany обладает необходимыми возможностями и поддерживает русский язык в интерфейсе.

    В курсе достаточно использовать одну из IDE.

    2.2.1.2.1. Atom¶

    Для установки необходимо перейти на официальный сайт Atom и загрузить предложенный дистрибутив.

    Главное окно Atom приведено на Рисунке 2.2.1; в Таблице 2.2.1 — краткое описание элементов интерфейса.

    _images/02_02_01.png

    Рисунок 2.2.1 — Главное окно IDE Atom ¶

    Назначение / Что можно найти?

    Все доступные команды IDE

    Список открытых файлов

    Дерево файлов проекта

    Набор кода с подсветкой синтаксиса и прочими удобствами

    Удобное отображение структуры файла

    Информация о запуске программы, ошибках в стандарте оформления и т.д.

    Информация о файле: кодировка, положение курсора в редакторе кода и т.д.

    Некоторые из элементов главного окна отобразятся после дополнительной настройки.

    2.2.1.2.1.1. Настройка отступов и пробелов¶

    В главном меню Atom нажмите Ctrl + Shift + P , наберите settings и нажмите <ENTER>. Проверьте значения следующих параметров:

    • установлен флажок «Show Indent Guide»;

    • установлен флажок «Show Invisibles»;

    • установлен флажок «Soft Wrap».

    2.2.1.2.1.2. Установка и настройка пакетов¶

    Дополнительно необходимо установить следующие пакеты:

    minimap: «мини-карта» документа;

    linter-flake8: проверка на соответствие кода стандарту PEP 8;

    autocomplete-python: интерактивная подсказка синтаксиса языка;

    atom-python-run: запуск программы из редактора.

    Установку дополнений можно произвести (1) из терминала или (2) в графическом интерфейсе.

    Откройте терминал и введите команду:

    В главном окне Atom:

    нажмите Ctrl + Shift + P , наберите install package и выберите появившееся меню Install Packages And Themes;

    для каждого пакета:

    • в текстовом поле Search packages введите имя пакета и нажмите <ENTER> для его поиска;

    • установите найденный пакет, нажав на кнопку Install; в случае дополнительных запросов на установку зависимых пакетов (dependencies) необходимо ответить Yes.

    2.2.1.2.1.3. Автоматическая проверка заданий и PEP8¶

    Установленные плагины позволяют автоматически выполнять проверку на соответствие кода стандарту PEP 8, отображая ошибки в окне сообщений.

    Для проверки выполняемых заданий откройте настройки пакета atom-python-run и проверьте, что команды установлены как на Рисунке 2.2.2 (обведено красным), где путь ..\tests\test.py — относительный путь к валидатору test.py .

    _images/02_02_02.png

    Рисунок 2.2.2 — Команды сборки Python ¶

    После настройки используйте команды:

    F5: запуск программы на выполнение;

    F6: запуск автоматической проверки решенной задачи (см. пример: Цикл выполнения и защиты заданий ).

    2.2.1.2.2. Geany¶

    Для установки Geany необходимо выполнить следующие шаги в зависимости от операционной системы.

    на официальном сайте Geany перейти в раздел Download/Releases, загрузить соответствующий дистрибутив ( geany-1.X_setup.exe или geany-1.X_osx.dmg ) и выполнить установку;

    только для Windows(!): на официальном сайте плагинов Geany перейти в раздел Downloads, загрузить дистрибутив, соответствующий по версии установленной Geany ( geany-plugins-1.X_setup.exe ) и выполнить установку.

    В дистрибутивах Linux с пакетным менеджером, удобнее использовать его команды, например:

    Для других дистрибутивов:

    на официальном сайте Geany перейти в раздел Download/Third Party Packages и выполнить инструкции для своего дистрибутива Linux;

    на официальном сайте плагинов Geany перейти в раздел Installation и выполнить инструкции для своего дистрибутива Linux.

    Главное окно Geany приведено на Рисунке 2.2.3; в Таблице 2.2.2 — краткое описание элементов интерфейса.

    _images/02_02_03.png

    Рисунок 2.2.3 — Главное окно IDE Geany ¶

    Назначение / Что можно найти?

    Все доступные команды IDE

    Быстрый доступ к командам работы с файлами, а также запуску программ

    Список открытых файлов

    Отображение идентификаторов программы, дерева файлов и т.д.

    Набор кода с подсветкой синтаксиса и прочими удобствами

    Удобное отображение структуры файла

    Информация о запуске программы или о выполнении прочих команд

    Информация о файле: кодировка, положение курсора в редакторе кода и т.д.

    Некоторые из элементов главного окна отобразятся после дополнительной настройки.

    2.2.1.2.2.1. Настройка отступов и пробелов¶

    В главном меню Geany выберите Правка -> Настройки (Edit -> Preferences). Проверьте значения следующих параметров:

    вкладка Редактор (Editor):

    • вкладка Возможности (Features):

    • установлен флажок «Новая строка убирает лишние пробелы» («Newline strips trailing spaces»);

    • поле «Маркер переключения комментариев» («Comment toggle marker») установлено в 1 пробел.

    вкладка Отступы (Indentation):

    • Ширина (Width): 4;

    • Тип (Type): Пробелы;

    • снят флажок «Отступ при помощи клавиши Tab» («Tab key indents»).

    вкладка Отображение (Display):

    • установлен флажок «Показывать индикаторы отступа» («Show indentation guides»);

    • установлен флажок «Показывать пробелы» («Show white space»).

    вкладка Файлы (Files):

    • Сохранение файлов (Saving Files):

    • установлен флажок «Убирать лишние пробелы и табуляции» («Strip trailing spaces and tabs»);

    • установлен флажок «Заменять табуляции пробелами» («Replace tabs with space»).

    2.2.1.2.2.2. Включение и настройка модулей¶

    В главном меню Geany выберите Инструменты -> Менеджер модулей (Tools -> Plugin Manager). Отметьте флажки у следующих модулей:

    Overview: отображает «мини-карту» документа;

    Авто-маркер (Auto-mark): подсвечивает текущее слово под курсором;

    Дерево файлов (TreeBrowser): показывает дерево файлов на боковой панели слева;

    Дополнения (Addons): маленькие удобства, например, панель задач, обрамление выделенного текста и т.д.

    Для настройки модулей выберите в главном меню команду Правка -> Настройка модулей (Edit -> Plugin Preferences).

    вкладка Дополнения (Addons):

    установите флажок «Удалять пустые строки в конце файла при сохранении» («Strip trailing blank lines»).

    2.2.1.2.2.3. Автоматическая проверка заданий и PEP8¶

    Для проверки и соответствия стандарту оформления PEP 8 создайте новый файл с расширением ‘.py’ , после чего откройте настройки сборки в Geany Сборка -> Установить команды сборки (Build -> Set Build Commands) и проверьте, что команды установлены как на Рисунке 2.2.4 (обведено красным), где путь ../tests/ — относительный путь к валидатору test.py .

    _images/02_02_04.png

    Рисунок 2.2.4 — Команды сборки Python ¶

    После настройки используйте команды:

    F5: запуск программы на выполнение;

    PEP8 (или Lint) в меню Сборка: запуск проверки текущего файла на соответствие PEP8 с отображением возможных ошибок в окне сообщений красным цветом (данную проверку и устранение ошибок рекомендуется осуществлять регулярно);

    Проверить в меню Сборка: запуск автоматической проверки решенной задачи (см. пример: Цикл выполнения и защиты заданий ).

    2.2.1.2.3. PyCharm¶

    Для установки необходимо перейти на официальный сайт PyCharm и загрузить предложенный дистрибутив (Community Edition).

    Главное окно PyCharm приведено на Рисунке 2.2.5; в Таблице 2.2.3 — краткое описание элементов интерфейса.

    _images/02_02_05.png

    Рисунок 2.2.5 — Главное окно IDE PyCharm ¶

    Назначение / Что можно найти?

    Все доступные команды IDE

    Список открытых файлов

    Дерево файлов проекта

    Набор кода с подсветкой синтаксиса и прочими удобствами

    Удобное отображение структуры файла

    Интерактивная консоль запуска программы

    Информация о файле: кодировка, положение курсора в редакторе кода и т.д.

    2.2.1.2.3.1. Запуск и автоматическая проверка заданий и PEP8¶

    PyCharm автоматически проверяет код на соответствие стандарту PEP 8, используя подчеркивание в редакторе кода (Рисунок 2.2.6).

    _images/02_02_06.png

    Рисунок 2.2.6 — Автоматическая проверка PEP8 в PyCharm ¶

    Для быстрого запуска и проверки выполняемых заданий необходимо выполнить ряд настроек.

    В главном меню PyCharm выберите File -> Settings и найдите в поиске меню External Tools (Рисунок 2.2.7).

    _images/02_02_07.png

    Рисунок 2.2.7 — Окно добавления инструментов для запуска и проверки заданий ¶

    Для возможности запуска задания добавьте (через кнопку +) возможность запуска программы (Рисунок 2.2.8) и нажмите OK.

    _images/02_02_08.png

    Рисунок 2.2.8 — Команда запуска задания ¶

    Аналогично добавьте возможность проверки задания (Рисунок 2.2.9) и нажмите OK, где путь ..\tests\test.py — относительный путь к валидатору test.py .

    _images/02_02_09.png

    Рисунок 2.2.9 — Команда проверки задания ¶

    Для быстрого запуска и проверки заданий также рекомендуется добавить горячие клавиши. В главном меню PyCharm выберите File -> Settings и найдите в поиске меню Keymap (Рисунок 2.2.10).

    _images/02_02_10.png

    Рисунок 2.2.10 — Окно настройки сочетаний клавиш ¶

    Для добавления сочетания клавиш:

    выделите строку с командой;

    вызовите контекстное меню и выберите пункт Add Keyboard Shortcut;

    в открывшемся окне нажмите горячую клавишу (F5 для запуска, F6 — для проверки) и нажмите OK;

    в случае предупреждения, что горячая клавиша уже занята, нажмите Remove (в дальнейшем сочетания можно будет сбросить к начальным настройкам при необходимости).

    2.2.1.2.4. Сочетания клавиш¶

    Некоторые полезные сочетания клавиш приведены в Таблице 2.2.4.

    Таблица 2.2.4 — Некоторые сочетания клавиш в IDE ¶

    Добавить комментарий

    Ваш адрес email не будет опубликован. Обязательные поля помечены *