Пишем инструменты командной строки на Python с помощью Click

Python — невероятно гибкий язык программирования, который хорошо интегрируется с существующими программами. Немало Python-кода написано в виде скриптов и интерфейсов командной строки (CLI).

Инструменты и интерфейсы командной строки — эффективная вещь, так как они позволяют автоматизировать практически всё что угодно. Как следствие, эти интерфейсы с течением времени могут стать довольно сложными.

Обычно всё начинается с простого скрипта на Python, который что-то делает. Например, получает доступ к веб-API и выводит результат в консоль:

Вы можете запустить этот скрипт с помощью команды python3 print_user_agent.py , и он выведет имя user-agent, использованного для вызова API.

12–25 апреля, Онлайн, Беcплатно

Как и было сказано, довольно простой скрипт.

Но что делать, когда подобная программа растёт и становится всё более сложной?

Решением этого вопроса мы сегодня и займёмся. Вы узнаете об основах написания интерфейсов командной строки на Python и о том, как click позволяет упростить этот процесс.

Используя эти знания, мы шаг за шагом перейдём от простого скрипта к интерфейсу командной строки с аргументами, опциями и полезными инструкциями по использованию. Всё это мы сделаем с помощью библиотеки click.

К концу этой статьи вы будете знать:

• Почему click — лучшая альтернатива argparse и optparse;
• Как с его помощью создать простой CLI;
• Как добавить обязательные аргументы командной строки в ваши скрипты;
• Как парсить флаги и опции командной строки;
• Как сделать ваши консольные приложения более удобными, добавив справочный текст.

Вы увидите, как сделать всё это с минимальным количеством шаблонного кода.

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

Зачем вам писать скрипты и инструменты для командной строки на Python?

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

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

Здесь приходят на выручку такие модули, как optparse и argparse, которые делают нашу жизнь на порядок проще. Но прежде чем мы с ними познакомимся, давайте разберёмся с терминологией.

Основы интерфейса командной строки

Интерфейс командной строки (CLI) начинается с имени исполняемого файла. Вы вводите имя в консоль и получаете доступ к главной точке входа скрипта, такого как pip.

В зависимости от сложности CLI обычно есть определённые параметры, которые вы можете передавать скрипту:

1. Аргумент, который является обязательным параметром. Если его не передать, то CLI вернёт ошибку. Например, в следующей команде click является аргументом: pip install click .
2. Опция – необязательный параметр, который объединяет имя и значение, например —cache-dir ./my-cache . Вы говорите CLI, что значение ./my-cache должно использоваться как директория для кэша.
3. Флаг, который включает или выключает определённый сценарий. Вероятно, самым частым является —help . Вы только указываете имя, а CLI самостоятельно интерпретирует значение.

С более сложными CLI, такими как pip или Heroku CLI, вы получаете доступ к набору функций, которые собраны под главной точкой входа. Они обычно называются командами или подкомандами.

Возможно, вы уже использовали CLI, когда устанавливали Python-библиотеку с помощью команды pip install . Команда install говорит CLI, что вы хотите использовать функцию установки пакета, и даёт вам доступ к параметрам, характерным для этой функции.

Пакеты для работы с командной строкой, доступные в стандартной библиотеке Python 3.x

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

Два наиболее известных пакета для этого — optparse и argparse. Они являются частью стандартной библиотеки Python и добавлены туда по принципу «всё включено».

По большей части они делают одно и то же и работают схожим образом. Главное отличие заключается в том, что optparse не используется начиная с Python 3.2, и argparse считается стандартом для создания CLI в Python.

Вы можете узнать о них больше в документации Python, но, чтобы иметь представление, как выглядит скрипт с argparse, посмотрите на пример ниже:

click против argparse: лучшая альтернатива?

Вероятно, вы смотрите на этот код и думаете: «Что это всё значит?» И это является одной из проблем argparse: код с ним неинтуитивен и сложночитаем.

Поэтому вам может понравиться click.

Click решает ту же проблему, что и optparse и argparse, но немного иначе. Он использует декораторы, поэтому ваши команды должны быть функциями, которые можно обернуть этими декораторами.

С click легко создавать многофункциональный CLI с небольшим количеством кода. И этот код будет легко читаться, даже когда ваш CLI вырастет и станет более сложным.

Пишем простой CLI на Python с помощью click

Вдоволь поговорив о CLI и библиотеках, давайте взглянем на пример, чтобы понять, как написать простой CLI с click. Как и в первом примере, мы создаём простой CLI, который выводит результат в консоль. Это несложно:

Не пугайтесь последних двух строк: это то, как Python запускает функцию main при исполнении файла как скрипта.

Как вы видите, всё, что нам нужно сделать – создать функцию и добавить к ней декоратор @click.command() . Он превращает функцию в команду, которая является главной точкой входа нашего скрипта. Теперь вы можете запустить скрипт через командную строку и увидеть что-то вроде этого:

Что в click здорово, так это то, что мы получаем некоторые дополнительные возможности просто так. Мы не реализовывали справочную функцию, однако вы можете добавить флаг —help и увидеть базовое сообщение:

Более реалистичный пример CLI на Python с использованием click

Теперь, когда вы знаете, как click упрощает написание CLI, давайте взглянем на более реалистичный пример. Мы напишем программу, которая позволяет нам взаимодействовать с веб-API.

API, который мы дальше будем использовать, — OpenWeatherMap API. Он предоставляет информацию о текущей погоде, а также прогноз на пять дней для определённого местоположения. Мы начнём с тестового API, который возвращает текущую погоду для места.

Прежде чем мы начнём писать код, давайте познакомимся с API. Для этого можно использовать сервис HTTPie, включая онлайн-терминал.

Давайте посмотрим, что случится, когда мы обратимся к API с Лондоном в качестве местоположения:

Если вы смущены наличием API-ключа в примере сверху, не переживайте, это тестовый API-ключ, предоставляемый сервисом.

Более важное наблюдение заключается в том, что мы отправляем два параметра (обозначаемые == при использовании HTTPie), чтобы узнать текущую погоду:

• q — место, в котором мы хотим узнать погоду;
• appid — наш API-ключ.

Это позволяет нам создать простую реализацию на Python с использованием библиотеки requests (опустим обработку ошибок и неудачных запросов для простоты):

Эта функция делает простой запрос к API, используя два параметра. В качестве обязательного аргумента она принимает location (местоположение), которое должно быть строкой. Также мы можем указать API-ключ, передавая параметр api_key при вызове функции. Это необязательно, так как по умолчанию используется тестовый ключ.

И вот мы видим текущую погоду в Python REPL:

Парсим обязательные параметры с click

Простая функция current_weather позволяет нам создать CLI с местоположением, указанным пользователем. Это должно работать примерно так:

Как вы, возможно, догадались, местоположение — это аргумент, поскольку оно является обязательным параметром для нашего погодного CLI.

Как нам сделать это при помощи click? Всё довольно просто, мы используем декоратор под названием argument . Кто бы мог подумать?

Давайте возьмём наш предыдущий пример и слегка изменим его, добавив аргумент location :

Если этот print выглядит для вас странно, не волнуйтесь — это новый способ форматирования строк в Python 3.6+, который называется f-форматированием.

Как вы видите, всё, что нам нужно сделать, это добавить дополнительный декоратор к нашей функции main и дать ему имя. Click использует имя в качестве имени аргумента, переданного обёрнутой функции.

Примечание переводчика Имя аргумента, переданное click, должно совпадать с именем аргумента в объявлении функции.

В нашем случае значение аргумента командной строки location будет передано функции main в качестве аргумента location . Логично, не так ли?

Также вы можете использовать тире в именах, например api-key , которые click переведёт в snake case для имени аргумента в функции, например main(api_key) .

Реализация main просто использует нашу функцию current_weather для получения погоды в указанном месте. И затем мы с помощью print выводим полученную информацию.

Парсим опциональные параметры с click

Как вы, возможно, догадались, тестовый API ограничивает нас в возможностях. Поэтому, прежде чем мы продолжим, зарегистрируйтесь и получите настоящий API-ключ.

Первое, что нам нужно изменить, — URL, откуда берутся данные о текущей погоде. Это можно сделать, изменив значение переменной url в функции current_weather на URL, указанный в документации OpenWeatherMap:

Это изменение приведёт к неработоспособности нашего CLI, так как указанный API-ключ не работает с реальным API. Поэтому давайте добавим новый параметр в наш CLI, который позволит нам указывать API-ключ. Но сначала мы должны решить, будет ли этот параметр аргументом или опцией. Мы сделаем его опцией, так как добавление параметра вроде —api-key делает его более явным и говорящим за себя.
Мы хотим, чтобы наша программа запускалась таким образом:

Проще простого. Посмотрим, как добавить опцию к нашей существующей команде:

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

Как было сказано ранее, click создаёт аргумент для передачи в функцию main из длинного варианта имени. В случае с опцией он убирает впередистоящие тире и переводит её в snake case. Таким образом, —api-key становится api_key .

Чтобы всё заработало, осталось лишь передать API-ключ в функцию current_weather .

Мы добавили возможность указывать свой собственный ключ и проверять погоду в любом месте:

Добавляем автоматически генерируемые инструкции по использованию

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

Сначала давайте проверим, что выведет флаг —help после всех сделанных изменений. Довольно неплохо, учитывая что мы не приложили к этому никаких усилий:

Первое, что нужно исправить, это добавить описание для нашей опции с API-ключом. Всё, что нам для этого нужно сделать, – добавить справочный текст в декоратор @click.option :

Второе (и последнее), что мы сделаем, — добавим документацию для всей click-команды. Самый простой и самый питонический способ сделать это — добавить строку документации в нашу функцию main . Да, нам в любом случае нужно сделать это, поэтому это не лишняя работа:

Сложив всё вместе, мы получаем хороший вывод для нашего инструмента:

Подводим итоги

Итак, в этом уроке мы рассмотрели много всего. Можете гордиться собой, вы написали свой собственный CLI, и всё это с минимальным количеством шаблонного кода! Исходный код ниже доказывает это. Не стесняйтесь использовать его для собственных экспериментов:

Начало работы с Python в Windows для начинающих Get started using Python on Windows for beginners

Это пошаговое руководство для начинающих работу с Python в Windows 10. The following is a step-by-step guide for beginners interested in learning Python using Windows 10.

Настройка среды разработки Set up your development environment

Для начинающих, которые не знакомы с Python, рекомендуется установить Python из Microsoft Store. For beginners who are new to Python, we recommend you install Python from the Microsoft Store. При установке из Microsoft Store используется базовый интерпретатор Python3, но в дополнение к автоматическому обновлению также настраиваются параметры пути для текущего пользователя (без необходимости доступа администратора). Installing via the Microsoft Store uses the basic Python3 interpreter, but handles set up of your PATH settings for the current user (avoiding the need for admin access), in addition to providing automatic updates. Это особенно полезно, если вы работаете из среды образовательного учреждения или являетесь частью организации, которая ограничивает разрешения или административный доступ на компьютере. This is especially helpful if you are in an educational environment or a part of an organization that restricts permissions or administrative access on your machine.

Если вы используете Python в Windows для разработки веб-приложений, мы рекомендуем настроить среду разработки другим образом. If you are using Python on Windows for web development, we recommend a different set up for your development environment. Вместо установки непосредственно в Windows рекомендуется установить и использовать Python через подсистему Windows для Linux. Rather than installing directly on Windows, we recommend installing and using Python via the Windows Subsystem for Linux. Справочные сведения см. в следующих статьях: Начало работы с Python для разработки веб-приложений в Windows. For help, see: Get started using Python for web development on Windows. Если вы заинтересованы в автоматизации общих задач в операционной системе, ознакомьтесь с нашим руководством: Начало работы с Python в Windows для создания сценариев и автоматизации If you’re interested in automating common tasks on your operating system, see our guide: Get started using Python on Windows for scripting and automation. В некоторых сложных сценариях (например, при необходимости модификации или доступа к установленным файлам Python, создания копий двоичных файлов или непосредственного использования библиотек DLL Python) может потребоваться загрузить определенный выпуск Python непосредственно с сайта python.org или установить альтернативное средство, например Anaconda, Jython, PyPy, WinPython, IronPython и т. д. Мы рекомендуем это только в том случае, если вы более продвинутый программист на Python и у вас есть конкретная причина выбрать альтернативную реализацию. For some advanced scenarios (like needing to access/modify Python’s installed files, make copies of binaries, or use Python DLLs directly), you may want to consider downloading a specific Python release directly from python.org or consider installing an alternative, such as Anaconda, Jython, PyPy, WinPython, IronPython, etc. We only recommend this if you are a more advanced Python programmer with a specific reason for choosing an alternative implementation.

Установка Python Install Python

Чтобы установить Python с помощью Microsoft Store, сделайте следующее: To install Python using the Microsoft Store:

Перейдите в меню Пуск (значок Windows в нижнем левом углу), введите «Microsoft Store» и щелкните ссылку, чтобы открыть магазин. Go to your Start menu (lower left Windows icon), type «Microsoft Store», select the link to open the store.

Когда магазин откроется, выберите Поиск в верхнем правом меню и введите «Python». Once the store is open, select Search from the upper-right menu and enter «Python». Выберите «Python 3.9» из результатов в разделе приложений. Open «Python 3.9» from the results under Apps. Щелкните Получить. Select Get.

После того как Python завершит процесс загрузки и установки, откройте Windows PowerShell, используя меню Пуск (значок Windows в нижнем левом углу). Once Python has completed the downloading and installation process, open Windows PowerShell using the Start menu (lower left Windows icon). После открытия PowerShell введите Python —version , чтобы убедиться, что Python 3 установлен на компьютере. Once PowerShell is open, enter Python —version to confirm that Python3 has installed on your machine.

Установка Python из Microsoft Store содержит стандартный диспетчер пакетов pip. The Microsoft Store installation of Python includes pip, the standard package manager. Pip позволяет устанавливать дополнительные пакеты, которые не входят в стандартную библиотеку Python, и управлять ими. Pip allows you to install and manage additional packages that are not part of the Python standard library. Чтобы убедиться, что у вас есть pip, который можно использовать для установки пакетов и управления ими, введите pip —version . To confirm that you also have pip available to install and manage packages, enter pip —version .

Установка Visual Studio Code Install Visual Studio Code

При использовании VS Code в качестве текстового редактора или интегрированной среды разработки (IDE) вам доступны IntelliSense (помощь в завершении кода), анализ кода (помогает избежать ошибок в коде), поддержка отладки (помогает находить ошибки в коде после запуска), фрагменты кода (шаблоны для небольших повторно используемых блоков кода) и модульное тестирование (тестирование интерфейса кода с различными типами входных данных). By using VS Code as your text editor / integrated development environment (IDE), you can take advantage of IntelliSense (a code completion aid), Linting (helps avoid making errors in your code), Debug support (helps you find errors in your code after you run it), Code snippets (templates for small reusable code blocks), and Unit testing (testing your code’s interface with different types of input).

VS Code также содержит встроенный терминал, который позволяет открывать командную строку Python с помощью командной строки Windows, PowerShell или любой другой, создавая простой рабочий процесс между редактором кода и командной строкой. VS Code also contains a built-in terminal that enables you to open a Python command line with Windows Command prompt, PowerShell, or whatever you prefer, establishing a seamless workflow between your code editor and command line.

Чтобы установить VS Code, скачайте VS Code для Windows: https://code.visualstudio.com. To install VS Code, download VS Code for Windows: https://code.visualstudio.com.

Установив VS Code, необходимо также установить расширение Python. Once VS Code has been installed, you must also install the Python extension. Для установки расширения Python можно выбрать ссылку на VS Code в Marketplace или открыть VS Code и выполнить поиск по фразе Python в меню расширений (Ctrl+Shift+X). To install the Python extension, you can select the VS Code Marketplace link or open VS Code and search for Python in the extensions menu (Ctrl+Shift+X).

Python — интерпретируемый язык, и для выполнения кода Python необходимо указать VS Code, какой интерпретатор нужно использовать. Python is an interpreted language, and in order to run Python code, you must tell VS Code which interpreter to use. Мы советуем использовать Python 3.7, если только у вас нет конкретной причины для выбора другой программы. We recommend sticking with Python 3.7 unless you have a specific reason for choosing something different. После установки расширения Python выберите интерпретатор Python 3, открыв палитру команд (CTRL+SHIFT+P), и начните вводить команду Python: Select Interpreter (Python: выбор интерпретатора) для поиска, а затем выберите появившуюся команду. Once you’ve installed the Python extension, select a Python 3 interpreter by opening the Command Palette (Ctrl+Shift+P), start typing the command Python: Select Interpreter to search, then select the command. Вы также можете использовать параметр Select Python Environment (Выбрать среду Python) в нижней строке состояния, если она доступна (возможно, уже отображается выбранный интерпретатор). You can also use the Select Python Environment option on the bottom Status Bar if available (it may already show a selected interpreter). Команда предоставляет список доступных интерпретаторов, которые VS Code может найти автоматически, включая виртуальные среды. The command presents a list of available interpreters that VS Code can find automatically, including virtual environments. Если нужный интерпретатор не отображается, перейдите к статье о настройке сред Python. If you don’t see the desired interpreter, see Configuring Python environments.

Чтобы открыть терминал в VS Code, выберите Просмотр > Терминал или используйте клавиши CTRL+` (символ обратного апострофа). To open the terminal in VS Code, select View > Terminal, or alternatively use the shortcut Ctrl+` (using the backtick character). Терминалом по умолчанию является PowerShell. The default terminal is PowerShell.

В окне терминала VS Code откройте Python, просто введя команду: python Inside your VS Code terminal, open Python by simply entering the command: python

Попробуйте использовать интерпретатор Python, введя: print(«Hello World») . Try the Python interpreter out by entering: print(«Hello World») . Python вернет фразу «Hello World». Python will return your statement «Hello World».

Установка Git (необязательно) Install Git (optional)

Если вы планируете совместно работать над кодом Python с другими пользователями или размещать проект на сайте с открытым исходным кодом (например, GitHub), примите во внимание, что VS Code поддерживает управление версиями с помощью Git. If you plan to collaborate with others on your Python code, or host your project on an open-source site (like GitHub), VS Code supports version control with Git. Вкладка системы управления версиями в VS Code отслеживает все изменения и содержит общие команды Git (добавление, фиксация, принудительная отправка, извлечение) прямо в пользовательском интерфейсе. The Source Control tab in VS Code tracks all of your changes and has common Git commands (add, commit, push, pull) built right into the UI. Сначала необходимо установить Git для включения панели управления версиями. You first need to install Git to power the Source Control panel.

Скачайте и установите Git для Windows с веб-сайта git-scm. Download and install Git for Windows from the git-scm website.

В комплект входит мастер установки, который задает вам ряд вопросов о параметрах установки Git. An Install Wizard is included that will ask you a series of questions about settings for your Git installation. Рекомендуется использовать все параметры по умолчанию, если у вас нет конкретной причины изменить какой-либо из них. We recommend using all of the default settings, unless you have a specific reason for changing something.

Если вы никогда не использовали Git, обратитесь к руководствам по GitHub. Они помогут вам приступить к работе. If you’ve never worked with Git before, GitHub Guides can help you get started.

Учебник по некоторым основам работы с Python (на примере Hello World) Hello World tutorial for some Python basics

Python, согласно его создателю Гвидо ван Россуму, — это «язык программирования высокого уровня, и его основная философия проектирования — это удобочитаемость кода и синтаксис, позволяющий программистам выразить концепции в нескольких строках кода». Python, according to its creator Guido van Rossum, is a “high-level programming language, and its core design philosophy is all about code readability and a syntax which allows programmers to express concepts in a few lines of code.”

Python — интерпретируемый язык. Python is an interpreted language. В отличие от скомпилированных языков, в которых написанный код необходимо перевести в машинный код для выполнения процессором компьютера, код Python передается непосредственно интерпретатору и запускается напрямую. In contrast to compiled languages, in which the code you write needs to be translated into machine code in order to be run by your computer’s processor, Python code is passed straight to an interpreter and run directly. Просто введите код и запустите его. You just type in your code and run it. Попробуем сделать это! Let’s try it!

Откройте командную строку PowerShell и введите python , чтобы запустить интерпретатор Python 3. With your PowerShell command line open, enter python to run the Python 3 interpreter. (В некоторых инструкциях указано использовать команду py или python3 , которые также подойдут.) (Some instructions prefer to use the command py or python3 , these should also work). Если вы делаете все правильно, появится командная строка с тремя символами «больше, чем» (>>>). You will know that you’re successful because a >>> prompt with three greater-than symbols will display.

Существует несколько встроенных методов, позволяющих вносить изменения в строки в Python. There are several built-in methods that allow you to make modifications to strings in Python. Создайте переменную с помощью команды variable = ‘Hello World!’ . Create a variable, with: variable = ‘Hello World!’ . Нажмите клавишу ВВОД для создания новой строки. Press Enter for a new line.

Выведите переменную с помощью команды print(variable) . Print your variable with: print(variable) . Отобразится текст «Hello World!». This will display the text «Hello World!».

Выясните, сколько символов используется для переменной строки, с помощью команды len(variable) . Find out the length, how many characters are used, of your string variable with: len(variable) . Будет показано, что используется 12 символов. This will display that there are 12 characters used. (Обратите внимание, что пробел учитывается как символ в общей длине.) (Note that the blank space it counted as a character in the total length.)

Преобразуйте строковую переменную в буквы верхнего регистра: variable.upper() . Convert your string variable to upper-case letters: variable.upper() . Теперь преобразуйте строковую переменную в буквы нижнего регистра: variable.lower() . Now convert your string variable to lower-case letters: variable.lower() .

Подсчитайте, сколько раз буква «l» используется в строковой переменной: variable.count(«l») . Count how many times the letter «l» is used in your string variable: variable.count(«l») .

Найдите определенный символ в вашей строковой переменной. Давайте найдем восклицательный знак с помощью команды variable.find(«!») . Search for a specific character in your string variable, let’s find the exclamation point, with: variable.find(«!») . Будет показано, что восклицательный знак находится в позиции 11 строки. This will display that the exclamation point is found in the 11th position character of the string.

Замените восклицательный знак на вопросительный знак: variable.replace(«!», «?») . Replace the exclamation point with a question mark: variable.replace(«!», «?») .

Чтобы выйти из Python, введите exit() , quit() или нажмите клавиши CTRL+Z. To exit Python, you can enter exit() , quit() , or select Ctrl-Z.

Надеемся, вам понравилось использовать некоторые из встроенных в Python методов модификации строк. Hope you had fun using some of Python’s built-in string modification methods. Теперь попробуйте создать файл программы Python и запустить его с помощью VS Code. Now try creating a Python program file and running it with VS Code.

Учебник по использованию Python с VS Code (на примере Hello World) Hello World tutorial for using Python with VS Code

Команда VS Code составила отличный учебник по началу работы с Python с пошаговым руководством по созданию программы Hello World с помощью Python, запуску программного файла, настройке и запуску отладчика, а также установке пакетов, таких как matplotlib и numpy, для создания графического изображения в виртуальной среде. The VS Code team has put together a great Getting Started with Python tutorial walking through how to create a Hello World program with Python, run the program file, configure and run the debugger, and install packages like matplotlib and numpy to create a graphical plot inside a virtual environment.

Откройте PowerShell и создайте пустую папку с именем hello, перейдите в эту папку и откройте ее в VS Code: Open PowerShell and create an empty folder called «hello», navigate into this folder, and open it in VS Code:

После открытия среды VS Code, где показана новая папка hello в левом окне обозревателя, откройте окно командной строки в нижней панели VS Code, нажав CTRL+` (символ обратного апострофа) или выбрав Просмотр > Терминал. Once VS Code opens, displaying your new hello folder in the left-side Explorer window, open a command line window in the bottom panel of VS Code by pressing Ctrl+` (using the backtick character) or selecting View > Terminal. После запуска VS Code в папке эта папка станет вашей рабочей областью. By starting VS Code in a folder, that folder becomes your «workspace». VS Code хранит параметры, относящиеся к этой рабочей области, в файле .vscode/settings.json. Они отделены от параметров пользователя, которые хранятся глобально. VS Code stores settings that are specific to that workspace in .vscode/settings.json, which are separate from user settings that are stored globally.

Продолжайте работу с учебником в документации для VS Code: Сведения о создании файла исходного кода для Hello World на Python. Continue the tutorial in the VS Code docs: Create a Python Hello World source code file.

Создание простой игры с помощью Pygame Create a simple game with Pygame

Pygame — это популярный пакет Python для создания игр, который позволяет учащимся изучать программирование увлекательным способом. Pygame is a popular Python package for writing games — encouraging students to learn programming while creating something fun. Pygame отображает графические изображения в новом окне, поэтому метод «только командной строки» WSL не подойдет. Pygame displays graphics in a new window, and so it will not work under the command-line-only approach of WSL. Но если вы установили Python с помощью Microsoft Store, как описано в этом учебнике, все получится. However, if you installed Python via the Microsoft Store as detailed in this tutorial, it will work fine.

После установки Python установите Pygame из командной строки (или терминала в VS Code), введя python -m pip install -U pygame —user . Once you have Python installed, install pygame from the command line (or the terminal from within VS Code) by typing python -m pip install -U pygame —user .

Протестируйте установку, запустив пример игры: python -m pygame.examples.aliens Test the installation by running a sample game : python -m pygame.examples.aliens

Если все в порядке, откроется окно игры. All being well, the game will open a window. По завершении игры закройте окно. Close the window when you are done playing.

Вот как начать написание кода собственной игры: Here’s how to start writing your own game.

Откройте PowerShell (или командную строку Windows) и создайте пустую папку с именем bounce. Open PowerShell (or Windows Command Prompt) and create an empty folder called «bounce». Перейдите к этой папке и создайте файл с именем bounce.py. Navigate to this folder and create a file named «bounce.py». Откройте папку в VS Code: Open the folder in VS Code:

С помощью VS Code введите следующий код Python (или скопируйте и вставьте его): Using VS Code, enter the following Python code (or copy and paste it):

Сохраните его как: bounce.py . Save it as: bounce.py .

Запустите его в терминале PowerShell, введя: python bounce.py . From the PowerShell terminal, run it by entering: python bounce.py .

Попробуйте изменить некоторые из чисел, чтобы увидеть, как они влияют на прыгающий шарик. Try adjusting some of the numbers to see what effect they have on your bouncing ball.

Дополнительные сведения о создании игр с помощью Pygame см. на сайте pygame.org. Read more about writing games with pygame at pygame.org.

Материалы для непрерывного обучения Resources for continued learning

Мы рекомендуем использовать следующие ресурсы, чтобы продолжить изучение разработки на Python в Windows. We recommend the following resources to support you in continuing to learn about Python development on Windows.

Онлайн-курсы для изучения Python Online courses for learning Python

Введение в Python на Microsoft Learn. Попробуйте интерактивную платформу Microsoft Learn и получите навыки выполнения этого модуля, охватывающего основы написания базового кода Python, объявления переменных и работы с входными и выходными данными консоли. Introduction to Python on Microsoft Learn: Try the interactive Microsoft Learn platform and earn experience points for completing this module covering the basics on how to write basic Python code, declare variables, and work with console input and output. Интерактивная среда песочницы предоставляет эту отличную возможность начать пользователям, у которых еще не настроена среда разработки Python. The interactive sandbox environment makes this a great place to start for folks who don’t have their Python development environment set up yet.

Python на Pluralsight: 8 курсов, 29 часов. Схема обучения Python на Pluralsight предлагает онлайн-курсы, охватывающие различные темы, связанные с Python, включая средство для измерения навыков и поиска пробелов в знаниях. Python on Pluralsight: 8 Courses, 29 Hours: The Python learning path on Pluralsight offers online courses covering a variety of topics related to Python, including a tool to measure your skill and find your gaps.

Учебники на сайте LearnPython.org. Приступите к изучению Python без необходимости дополнительной установки или настройки с помощью этих бесплатных интерактивных учебников по Python от DataCamp. LearnPython.org Tutorials: Get started on learning Python without needing to install or set anything up with these free interactive Python tutorials from the folks at DataCamp.

Учебники на сайте Python.org. Предоставляют читателям неформальное описание основных понятий и функций языка и системы Python. The Python.org Tutorials: Introduces the reader informally to the basic concepts and features of the Python language and system.

Изучение Python на сайте Lynda.com. Основные сведения о Python. Learning Python on Lynda.com: A basic introduction to Python.

Работа с Python в VS Code Working with Python in VS Code

Редактирование Python в VS Code. Узнайте больше о том, как воспользоваться преимуществами автозаполнения VS Code и поддержкой IntelliSense для Python, включая их настройку или отключение. Editing Python in VS Code: Learn more about how to take advantage of VS Code’s autocomplete and IntelliSense support for Python, including how to customize their behavior. or just turn them off.

Анализ кода Python. Анализ кода — это процесс запуска программы, которая будет анализировать код на наличие возможных ошибок. Linting Python: Linting is the process of running a program that will analyse code for potential errors. Узнайте о различных формах поддержки анализа кода VS Code для Python и о том, как выполнить его настройку. Learn about the different forms of linting support VS Code provides for Python and how to set it up.

Отладка Python. Отладка — это процесс обнаружения и удаления ошибок из компьютерной программы. Debugging Python: Debugging is the process of identifying and removing errors from a computer program. В статье по этой ссылке описывается инициализация и настройка отладки для Python с помощью VS Code, установка и проверка точек останова, присоединение локального скрипта, выполнение отладки для различных типов приложений или на удаленном компьютере, а также некоторые основные способы устранения неполадок. This article covers how to initialize and configure debugging for Python with VS Code, how to set and validate breakpoints, attach a local script, perform debugging for different app types or on a remote computer, and some basic troubleshooting.

Модульное тестирование Python. В статье по этой ссылке содержатся некоторые основные сведения о модульном тестировании, включении платформы тестирования, создании и выполнении тестов, отладке тестов и параметрах конфигурации теста, а также приведено пошаговое руководство с примером. Unit testing Python: Covers some background explaining what unit testing means, an example walkthrough, enabling a test framework, creating and running your tests, debugging tests, and test configuration settings.