Как создать файл Python

Обновлено: 04.07.2024

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

В этом руководстве по работе с файлами в Python мы узнаем:

Как открыть текстовый файл в Python

Чтобы открыть файл, вам нужно использовать встроенную функцию открытия. Функция открытия файла Python возвращает объект файла, который содержит методы и атрибуты для выполнения различных операций по открытию файлов в Python.

Синтаксис функции открытия файла Python

  • имя файла: имя файла, открытого файловым объектом.
  • режим: атрибут файлового объекта указывает, в каком режиме был открыт файл.

Подробнее об этих режимах рассказывается ниже

Как создать текстовый файл в Python

Шаг 1. Откройте файл .txt

  • Мы объявили переменную «f», чтобы открыть файл с именем guru99.txt. Open принимает 2 аргумента: файл, который мы хотим открыть, и строку, представляющую виды разрешений или операций, которые мы хотим выполнить с файлом
  • Здесь мы использовали букву «w» в нашем аргументе, которая указывает, что Python записывает в файл, и он создаст файл в Python, если он не существует в библиотеке
  • Знак плюс указывает на чтение и запись для операции создания файла Python.

Шаг 2) Введите данные в файл

  • У нас есть цикл for, который работает с диапазоном из 10 чисел.
  • Использование функции записи для ввода данных в файл.
  • Выход, который мы хотим повторить в файле, — это «это номер строки», который мы объявляем с помощью функции записи файла Python, а затем процент d (отображает целое число)
  • По сути, мы вводим номер строки, которую пишем, затем помещаем его в символ возврата каретки и символ новой строки.

Шаг 3. Закройте экземпляр файла

  • Это закроет сохраненный экземпляр файла guru99.txt.

Вот результат после выполнения кода для создания текстового файла в примере Python:

Как создать текстовый файл в Python

Когда вы нажмете на свой текстовый файл, в нашем случае «guru99.txt», он будет выглядеть примерно так

Как создать текстовый файл в Python

Как добавить текстовый файл в Python

Вы также можете добавить новый текст в уже существующий файл или в новый файл.

Шаг 1)

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

Шаг 2)

Это запишет данные в файл в режиме добавления.

Как добавить текстовый файл в Python

Вы можете увидеть результат в файле «guru99.txt». Вывод кода состоит в том, что к предыдущему файлу добавляются новые данные с помощью операции Python append to file.

Пример добавления текстового файла в Python

Как читать файлы в Python

Вы можете прочитать файл в Python, вызвав файл .txt в «режиме чтения»(r).

Шаг 1. Откройте файл в режиме чтения

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

Шаг 3) Используйте f.read для чтения данных файла и сохранения их в переменном содержимом для чтения файлов в Python

Шаг 4) Распечатайте содержимое текстового файла чтения Python

Вот результат чтения примера файла Python:

Как читать файлы в Python

Как прочитать файл построчно в Python

Вы также можете прочитать файл .txt построчно, если ваши данные слишком велики для чтения. Код readlines() разделит ваши данные в удобном для чтения режиме.

Как читать файл построчно в Python

Когда вы запускаете код (f1=f.readlines()) для чтения файла построчно в Python, он разделяет каждую строку и представляет файл в читаемом формате. В нашем случае строка короткая и читабельная, вывод будет похож на режим чтения. Но если есть сложный файл данных, который не читается, этот фрагмент кода может быть полезен.

Чтобы начать работу с PyCharm, давайте напишем скрипт Python.

Создать проект Python

Если вы находитесь на экране приветствия, нажмите «Новый проект» . Если у вас уже открыт какой-либо проект, выберите «Файл | Новый проект из главного меню.

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

Выберите местоположение проекта. Нажмите кнопку рядом с полем Location и укажите каталог для вашего проекта.

Кроме того, снимите флажок "Создать сценарий приветствия main.py", поскольку для этого руководства вы создадите новый файл Python.

В Python лучше всего создавать виртуальную среду для каждого проекта. В большинстве случаев PyCharm автоматически создает новую виртуальную среду, и вам не нужно ничего настраивать. Тем не менее, вы можете просмотреть и изменить параметры venv. Разверните узел Python Interpreter: New Virtualenv Environment и выберите инструмент, используемый для создания новой виртуальной среды. Давайте выберем инструмент Virtualenv и укажем расположение среды и базовый интерпретатор Python, используемый для новой виртуальной среды.

Загрузка Python при создании нового проекта

Теперь нажмите кнопку "Создать" в нижней части диалогового окна "Новый проект".

Если у вас уже есть открытый проект, после нажатия кнопки «Создать» PyCharm спросит вас, открывать ли новый проект в текущем или в новом окне. Выберите Открыть в текущем окне — это закроет текущий проект, но вы сможете снова открыть его позже. Подробнее см. на странице Открытие, повторное открытие и закрытие проектов.

Создать файл Python

В окне инструмента "Проект" выберите корень проекта (обычно это корневой узел в дереве проекта), щелкните его правой кнопкой мыши и выберите "Файл | Новый . .

Выберите параметр «Файл Python» в контекстном меню, а затем введите новое имя файла.

Создание нового файла Python

PyCharm создает новый файл Python и открывает его для редактирования.

Редактировать код Python

Давайте начнем редактировать только что созданный файл Python.

Начните с объявления класса. Как только вы начнете печатать, PyCharm предложит, как завершить строку:

Создать завершение класса

Выберите класс ключевых слов и введите название класса Car .

PyCharm сообщает об отсутствующем двоеточии, а затем об ожидаемом отступе:

Создать анализ класса

Обратите внимание, что PyCharm анализирует ваш код на лету, результаты немедленно отображаются в индикаторе проверки в правом верхнем углу редактора. Эта индикация проверки работает как светофор: когда он зеленый, все в порядке, и вы можете продолжать свой код; желтый свет означает некоторые незначительные проблемы, которые, однако, не повлияют на компиляцию; но когда свет красный, это означает, что у вас есть серьезные ошибки. Щелкните ее, чтобы просмотреть подробности в окне инструмента "Проблемы".

Давайте продолжим создание функции __init__ : когда вы просто вводите открывающую фигурную скобку, PyCharm создает всю конструкцию кода (обязательный параметр self , закрывающая фигурная скобка и двоеточие) и обеспечивает правильный отступ.

Если во время редактирования кода вы заметили какие-либо предупреждения о проверке, щелкните значок лампочки, чтобы просмотреть список возможных исправлений и рекомендуемых действий:

Давайте скопируем и вставим весь пример кода. Нажмите кнопку копирования в правом верхнем углу блока кода здесь, на странице справки, затем вставьте его в редактор PyCharm, заменив содержимое файла Car.py:

Это приложение предназначено для Python 3

На данный момент вы готовы запустить свое первое приложение Python в PyCharm.

Запустите приложение

Используйте любой из следующих способов запуска кода:

Щелкните правой кнопкой мыши редактор и в контекстном меню выберите «Запустить машину».

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

Запуск скрипта

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

PyCharm выполняет ваш код в окне инструмента "Выполнить".

Окно инструмента запуска

Здесь вы можете ввести ожидаемые значения и просмотреть вывод скрипта.

Обратите внимание, что PyCharm создал временную конфигурацию запуска/отладки для файла Car.

Временная конфигурация запуска/отладки

Конфигурация запуска/отладки определяет, как PyCharm выполняет ваш код. Вы можете сохранить его, чтобы сделать его постоянной конфигурацией, или изменить его параметры. Дополнительные сведения о запуске кода Python см. в разделе Конфигурации запуска/отладки.

Обзор

Поздравляем с завершением вашего первого скрипта в PyCharm! Давайте повторим то, что вы сделали с помощью PyCharm:

В этой части серии "Изучение Python" вы узнаете, как создавать файлы Python и запускать их из терминала. Вы будете писать свой самый первый скрипт Python!

Мы будем использовать Visual Studio Code для написания нашего скрипта Python и Cmder (эмулятор терминала) для его запуска, но не стесняйтесь использовать свои собственные инструменты.

Файлы Python

Точно так же, как текстовые файлы имеют расширение .txt, а HTML-файлы имеют расширение .html , файл Python характеризуется расширением .py.

Чтобы создать файл Python, просто сохраните имя файла с расширением your_filename.py, не оставляя пробелов в имени файла.

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

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

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

Откройте Cmder и перейдите на рабочий стол (или туда, где вы хотите создать каталог)

Мы назовем основной каталог learning_python

Терминал

Теперь перейдите в каталог с помощью команды cd:

Терминал

Мы создадим наш первый подкаталог с именем python_files с помощью команды mkdir и переместимся в него

Терминал

И, наконец, давайте создадим наш первый файл Python! Мы собираемся использовать команду touch и назвать файл main,py :

Терминал

Давайте напишем код на Python!

Написание кода на Python

Код Python записывается построчно в файл .py и читается сверху вниз.

Мы не будем подробно объяснять код (это всего пара строк), так как вы узнаете о нем в следующей части этой серии.

Вы можете открыть код Visual Studio из Cmder с помощью следующей команды:

Терминал

Эта команда откроет VS Code в текущем каталоге, в котором вы находитесь. Вы также можете сделать то же самое, щелкнув правой кнопкой мыши каталог Learning_python и выбрав «Открыть с помощью кода».

Первая строка Python (не стесняйтесь изменить название на свое!):

main.py

Я не хочу, чтобы вы слишком беспокоились о коде, но чтобы вы знали, что мы сделали:

  • Мы создали переменную с именем my_name и присвоили ей значение "Юлиан" с помощью оператора =
  • Переменная — это местозаполнитель для хранения значения или значений, которые затем можно повторно использовать снова и снова.
  • "Юлиан" – это строка, которая в терминах программирования – это строка символов, заключенная в кавычки или апострофы.

Давайте добавим еще одну строку кода ниже:

main.py

Давайте быстро взглянем на вторую строку:

  • Мы используем функцию печати и передаем переменную my_name между скобками ()
  • Функция печати в Python используется для вывода данных на терминал. Какие бы значения мы ни передавали, они будут напечатаны для нашего просмотра

print — это одна из встроенных функций Python, и вы скоро узнаете все о функциях!

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

Совет. Обязательно сохраните файл Python. Используйте Ctrl + s в VS Code, чтобы сохранить его

Запуск файлов Python

Запустить файл Python (или сценарии, как их обычно называют) очень просто.

Чтобы запустить файл Python из терминала, просто введите команду python, за которой следует имя вашего файла!

Например (противоположные стрелки <> показывают, где вы должны заменить значение на свое):

Терминал

Если вы находитесь в другом каталоге, вы также можете указать полный путь к файлу Python, например:

Терминал

Мы назвали наш файл main.py , поэтому запустим его следующим образом:

Терминал

Вы должны увидеть следующий вывод в своем терминале:

Терминал

Если вы изменили значение для my_name , вы, конечно же, увидите его вместо этого!

Давайте оживим наш сценарий, распечатав дополнительную информацию.

Замените print(my_name) следующим:

main.py

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

Мы используем так называемую "интерполяцию строк", чтобы вставить переменную my_name в другую строку, которую затем умножаем на 10 и передаем функции печати.

Сейчас сохраните файл и снова запустите его из терминала:

Терминал

Терминал

Вот это было весело! 😄

Подведение итогов

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


Добро пожаловать в Python! В этом руководстве показано, как начать писать программы.

Программы Python представляют собой не что иное, как текстовые файлы, и их можно редактировать с помощью стандартного текстового редактора. [1] Какой текстовый редактор вы используете, вероятно, зависит от вашей операционной системы: любой текстовый редактор может создавать программы Python. Однако проще использовать текстовый редактор с подсветкой синтаксиса Python.

Привет, мир [ редактировать | изменить источник ]

Самая первая программа, которую обычно пишут или изучают начинающие программисты, это "Hello, World!" программа. Эта программа просто выводит фразу «Hello, World!» затем прекращает себя. Давайте напишем "Hello, World!" на Питоне!

Откройте текстовый редактор и создайте новый файл с именем hello.py, содержащий только эту строку (вы можете скопировать и вставить, если хотите):

Строка ниже используется для Python 3.x.x

Вы также можете поместить строку ниже, чтобы приостановить программу в конце, пока вы ничего не нажмете.

Эта программа использует функцию печати, которая просто выводит свои параметры на терминал. По умолчанию print добавляет к своему выводу символ новой строки, который просто перемещает курсор на следующую строку.

Примечание:
В Python 2.x print — это оператор, а не функция. Таким образом, его можно использовать без круглых скобок, и в этом случае он печатает все до конца строки и принимает отдельную запятую после последнего элемента в строке, чтобы указать многострочный оператор. В Python 3.x print — это правильная функция, ожидающая свои аргументы в круглых скобках. Использование печати со скобками (как указано выше) совместимо с Python 2.x, и использование этого стиля обеспечивает независимость от версии.


Теперь, когда вы написали свою первую программу, давайте запустим ее на Python! Этот процесс немного отличается в зависимости от вашей операционной системы.

Windows [ редактировать | изменить источник ]

  • Создайте папку на своем компьютере для программ Python, например C:\pythonpractice , и сохраните программу hello.py в этой папке.
  • В меню "Пуск" выберите "Выполнить" и введите cmd . Это приведет к открытию терминала Windows.
  • Введите cd \pythonpractice, чтобы изменить каталог на папку pythonpractice, и нажмите Enter.
  • Введите hello.py, чтобы запустить программу!

Если это не сработало, убедитесь, что ваш PATH содержит каталог python. См. Получение Python.

Mac [ редактировать | изменить источник ]

  • Создайте папку на своем компьютере, чтобы использовать ее для программ Python. Хорошим предложением было бы назвать его pythonpractice и поместить в домашнюю папку (та, которая содержит папки для документов, фильмов, музыки, изображений и т. д.). Сохраните в нем вашу программу hello.py. Откройте папку «Программы», перейдите в папку «Утилиты» и откройте программу «Терминал».
  • Введите cd pythonpractice, чтобы изменить каталог на папку pythonpractice, и нажмите Enter.
  • Введите python ./hello.py, чтобы запустить программу!

Примечание:
Если у вас установлены и Python 2, и Python 3 (на вашем компьютере установлена ​​версия Python 2, но вы также можете установить Python 3), вам следует запустить python3 hello.py

Линукс [ редактировать | изменить источник ]

  • Создайте папку на своем компьютере для программ Python, например ~/pythonpractice , и сохраните программу hello.py в этой папке.
  • Откройте терминальную программу. В KDE откройте главное меню и выберите «Выполнить команду», чтобы открыть консоль. В GNOME откройте главное меню, откройте папку «Приложения», откройте папку «Стандартные» и выберите «Терминал».
  • Введите cd ~/pythonpractice, чтобы изменить каталог на папку pythonpractice, и нажмите Enter.
  • Не забудьте сделать скрипт исполняемым с помощью chmod +x.
  • Введите python ./hello.py, чтобы запустить программу!

Примечание:
Если у вас установлены версии Python 2.6.1 и Python 3.0 (очень возможно, если вы используете Ubuntu и запустили sudo apt-get install python3, чтобы установить python3), вам следует запустить python3 hello .py

Linux (расширенный) [ редактировать | изменить источник ]

  • Создайте на своем компьютере папку для программ Python, например ~/pythonpractice .
  • Откройте свой любимый текстовый редактор и создайте новый файл с именем hello.py, содержащий всего две следующие строки (вы можете скопировать и вставить, если хотите): [2]

Примечание:
Если у вас установлены Python версии 2.6.1 и версии 3.0 (очень возможно, если вы используете дистрибутив Debian или на основе Debian (*buntu, Mint, …) и запустили sudo apt- get install python3, чтобы установить python3), используйте

  • сохраните программу hello.py в папке ~/pythonpractice.
  • Откройте терминальную программу. В KDE откройте главное меню и выберите «Выполнить команду», чтобы открыть консоль. В GNOME откройте главное меню, откройте папку «Приложения», откройте папку «Стандартные» и выберите «Терминал».
  • Введите cd ~/pythonpractice, чтобы изменить каталог на папку pythonpractice, и нажмите Enter.
  • Введите chmod a+x hello.py, чтобы сообщить Linux, что это исполняемая программа.
  • Введите ./hello.py, чтобы запустить программу!
  • Кроме того, вы также можете использовать ln -s hello.py /usr/bin/hello, чтобы создать символическую ссылку hello.py на /usr/bin под именем hello, а затем запустить ее, просто выполнив команду hello.

Обратите внимание, что это в основном должно быть сделано для полных, скомпилированных программ. Если у вас есть скрипт, который вы создали и часто используете, то, возможно, было бы неплохо поместить его где-нибудь в вашем домашнем каталоге и поместить ссылку на него в /USR/бен. Если вам нужна игровая площадка, хорошей идеей будет вызвать mkdir ~/.local/bin, а затем поместить туда скрипты. Чтобы сделать содержимое ~/.local/bin исполняемым так же, как /usr/bin, введите $PATH = $PATH:~/local/bin (эту строку можно добавить в rc-файл оболочки, например ~/.bashrc).

Примечание:
Расширения файлов не нужны в UNIX-подобных файловых системах. Для Linux hello.py означает то же самое, что и hello.txt, hello.mp3 или просто hello. Linux в основном использует содержимое файла, чтобы определить его тип.

Результат [ редактировать | изменить источник ]

Программа должна напечатать:

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

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

Если у вас возникли проблемы с выполнением команд из этого руководства, скопируйте команду и ее вывод, а затем откройте проблему в репозитории проблем с упаковкой на GitHub. Мы сделаем все возможное, чтобы помочь вам!

Для некоторых команд требуется более новая версия pip , поэтому начните с того, что у вас установлена ​​последняя версия:

Простой проект¶

В этом руководстве используется простой проект с именем example_package . Мы рекомендуем следовать этому руководству как есть, используя этот проект, прежде чем упаковывать свой собственный проект.

Создайте следующую файловую структуру локально:

__init__.py требуется для импорта каталога в виде пакета и должен быть пустым.

example.py — это пример модуля в пакете, который может содержать логику (функции, классы, константы и т. д.) вашего пакета. Откройте этот файл и введите следующее содержимое:

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

После того как вы создадите эту структуру, вам нужно будет запускать все команды из этого руководства в каталоге packages_tutorial.

Создание файлов пакета¶

Теперь вы добавите файлы, которые используются для подготовки проекта к распространению. Когда вы закончите, структура проекта будет выглядеть так:

Создание тестового каталога¶

tests/ — это заполнитель для тестовых файлов. Пока оставьте его пустым.

Создание pyproject.toml¶

pyproject.toml сообщает инструментам сборки (таким как pip и build ), что требуется для сборки вашего проекта. В этом руководстве используются setuptools , поэтому откройте pyproject.toml и введите следующее содержимое:

build-system.requires предоставляет список пакетов, необходимых для сборки вашего пакета. Перечисление чего-либо здесь сделает его только доступным во время сборки, а не после его установки.

build-system.build-backend — это имя объекта Python, который будет использоваться для выполнения сборки. Если бы вы использовали другую систему сборки, такую ​​как flit или поэзия, они были бы здесь, и детали конфигурации были бы полностью отличными от конфигурации setuptools, описанной ниже.

Настройка метаданных¶

Существует два типа метаданных: статические и динамические.

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

Динамические метаданные ( setup.py ): возможно, недетерминированные.Любые элементы, которые являются динамическими или определяются во время установки, а также модули расширения или расширения для инструментов настройки, должны войти в setup.py .

Предпочтительнее использовать статические метаданные ( setup.cfg ). Динамические метаданные ( setup.py ) следует использовать только в качестве аварийного выхода, когда это абсолютно необходимо. setup.py раньше требовался, но его можно опустить в более новых версиях setuptools и pip.

setup.cfg — это файл конфигурации для setuptools. Он сообщает setuptools о вашем пакете (например, имя и версия), а также о том, какие файлы кода следует включать. Со временем большую часть этой конфигурации можно будет перенести в pyproject.toml .

Откройте setup.cfg и введите следующее содержимое. Измените имя, чтобы оно включало ваше имя пользователя; это гарантирует, что у вас есть уникальное имя пакета и что ваш пакет не конфликтует с пакетами, загруженными другими людьми после этого руководства.

Здесь поддерживаются различные метаданные и параметры. Это в формате configparser; не заключайте значения в кавычки. В этом примере пакета используется относительно минимальный набор метаданных:

версия — это версия пакета. Подробнее о версиях см. в PEP 440. Вы можете использовать директивы file: или attr: для чтения из файла или атрибута пакета.

author и author_email используются для идентификации автора пакета.

описание — это краткое описание пакета, состоящее из одного предложения.

long_description — подробное описание пакета. Это показано на странице сведений о пакете в индексе пакетов Python. В этом случае длинное описание загружается из README.md (что является распространенным шаблоном) с помощью директивы file:.

long_description_content_type сообщает индексу, какой тип разметки используется для длинного описания. В данном случае это Markdown.

url — это URL-адрес главной страницы проекта. Для многих проектов это будет просто ссылка на GitHub, GitLab, Bitbucket или аналогичную службу размещения кода.

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

В категории параметров у нас есть элементы управления для самих инструментов настройки:

package_dir — это сопоставление имен пакетов и каталогов. Пустое имя пакета представляет собой «корневой пакет» — каталог в проекте, который содержит все исходные файлы Python для пакета — поэтому в этом случае каталог src обозначается как корневой пакет.

packages — это список всех пакетов импорта Python, которые должны быть включены в дистрибутив. Вместо того, чтобы перечислять каждый пакет вручную, мы можем использовать директиву find: для автоматического обнаружения всех пакетов и подпакетов и options.packages.find для указания используемого package_dir. В этом случае список пакетов будет example_package, так как это единственный существующий пакет.

python_requires предоставляет версии Python, поддерживаемые вашим проектом. Установщики, такие как pip, просматривают старые версии пакетов, пока не найдут пакет с соответствующей версией Python.

Есть гораздо больше, чем упомянутые здесь. Дополнительные сведения см. в разделе Упаковка и распространение проектов.

setup.py — это скрипт сборки для setuptools . Он сообщает setuptools о вашем пакете (например, имя и версия), а также о том, какие файлы кода следует включать.

Откройте setup.py и введите следующее содержимое. Измените имя, чтобы оно включало ваше имя пользователя; это гарантирует, что у вас есть уникальное имя пакета и что ваш пакет не конфликтует с пакетами, загруженными другими людьми после этого руководства.

setup() принимает несколько аргументов. В этом примере пакета используется относительно минимальный набор:

версия — это версия пакета. Дополнительные сведения о версиях см. в PEP 440.

author и author_email используются для идентификации автора пакета.

описание — это краткое описание пакета, состоящее из одного предложения.

long_description — подробное описание пакета. Это показано на странице сведений о пакете в индексе пакетов Python. В этом случае длинное описание загружается из README.md, что является распространенным шаблоном.

long_description_content_type сообщает индексу, какой тип разметки используется для длинного описания. В данном случае это Markdown.

url — это URL-адрес главной страницы проекта. Для многих проектов это будет просто ссылка на GitHub, GitLab, Bitbucket или аналогичную службу размещения кода.

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

package_dir — это словарь с именами пакетов для ключей и каталогов для значений. Пустое имя пакета представляет собой «корневой пакет» — каталог в проекте, который содержит все исходные файлы Python для пакета — поэтому в этом случае каталог src обозначается как корневой пакет.

packages — это список всех пакетов импорта Python, которые должны быть включены в дистрибутив.Вместо того, чтобы перечислять каждый пакет вручную, мы можем использовать find_packages() для автоматического обнаружения всех пакетов и подпакетов в package_dir. В этом случае список пакетов будет example_package, так как это единственный существующий пакет.

python_requires предоставляет версии Python, поддерживаемые вашим проектом. Установщики, такие как pip, просматривают более старые версии пакетов, пока не найдут пакет с соответствующей версией Python.

Есть гораздо больше, чем упомянутые здесь. Дополнительные сведения см. в разделе Упаковка и распространение проектов.

Вы можете увидеть некоторые существующие проекты или другие учебные пособия по пакетированию Python, которые импортируют свою функцию установки из distutils.core, а не из setuptools. Это устаревший подход, который установщики поддерживают в целях обратной совместимости 1, но использование устаревшего API distutils непосредственно в новых проектах настоятельно не рекомендуется, поскольку distutils устарел в соответствии с PEP 632 и будет удален из стандартной библиотеки в Python 3.12.

Создание README.md¶

Откройте README.md и введите следующее содержимое. Вы можете настроить это, если хотите.

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

Создание ЛИЦЕНЗИИ¶

Включение других файлов¶

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

Окончательный собранный дистрибутив будет содержать файлы Python в обнаруженных или перечисленных пакетах Python. Если вы хотите управлять тем, что здесь происходит, например добавлять файлы данных, см. раздел «Включение файлов данных» в документации setuptools .

Создание архивов дистрибутива¶

Следующим шагом является создание пакетов распространения для пакета. Это архивы, которые загружаются в индекс пакетов Python и могут быть установлены с помощью pip .

Читайте также: