Импортировать модуль в Python с примерами
Анна Блейк
Какие модули есть в Python?
Модуль — это файл с кодом Python. Код может быть в форме переменных, функций или определенных классов. Имя файла становится именем модуля.
Например, если имя вашего файла — guru99.py, имя модуля будет guru99. Благодаря функциональности модуля вы можете разбить свой код на разные файлы вместо того, чтобы писать все в одном файле.
В чём Python модуль импорта?
Файл рассматривается как модуль в Python. Чтобы использовать модуль, вам необходимо импортировать его, используя импорт ключевое слово. Функция или переменные, присутствующие внутри файла, могут быть использованы в другом файле путем импорта модуля. Эта функция доступна на других языках, например машинописном, JavaСкрипт, Java, Ruby и т. д.
Как создать и импортировать модуль в Python?
Теперь мы создадим модуль и импортируем его в другой файл.
Вот процесс создания и импорта модуля, как показано на снимке экрана:
Следуйте инструкциям, чтобы создать модуль в Python.
Структура папок, используемая для тестирования кода, следующая:
modtest/ test.py display.py
Шаг 1) Создайте файл и назовите его test.py.
Шаг 2) Внутри test.py создайте функцию display_message().
Def display_message():
return "Welcome to Guru99 Tutorials!"
Шаг 3) Теперь создайте еще один файл display.py.
Шаг 4) Внутри display.py импортируйте файл Moduletest.py, как показано ниже:
import test
При импорте вам не обязательно указывать test.py, а только имя файла.
Шаг 5) Затем вы можете вызвать функцию display_message() из test.py внутри display.py, вам нужно использовать имя_модуля.имя_функции.
Например test.display_message().
Import test print(test.display_message())
Шаг 6) Когда вы выполните display.py, вы получите следующее Вывод:
Welcome to Guru99 Tutorials!
Импорт класса в Python
Ранее мы видели простой модуль с функцией. Здесь будет создан класс и ссылка на класс внутри другого файла.
Структура папок для тестирования кода следующая:
myproj/ Car.py display.py
Создайте файл Car.py со следующим кодом:
Имя файла: Car.py
class Car:
brand_name = "BMW"
model = "Z4"
manu_year = "2020"
def __init__(self, brand_name, model, manu_year):
self.brand_name = brand_name
self.model = model
self.manu_year = manu_year
def car_details(self):
print("Car brand is ", self.brand_name)
print("Car model is ", self.model)
print("Car manufacture year is ", self.manu_year)
def get_Car_brand(self):
print("Car brand is ", self.brand_name)
def get_Car_model(self):
print("Car model is ", self.model)
В файле Car.py есть атрибуты name_name, model и manu_year. Внутри класса определены функции car_details(), get_Car_brand(), get_Car_model().
Давайте теперь используем файл Car.py в качестве модуля в другом файле с именем display.py.
Имя файла: display.py
import Car
car_det = Car.Car("BMW","Z5", 2020)
print(car_det.brand_name)
print(car_det.car_details())
print(car_det.get_Car_brand())
print(car_det.get_Car_model())
Вывод:
BMW Car brand is BMW Car model is Z5 Car manufacture year is 2020 Car brand is BMW Car model is Z5
Таким образом, мы можем получить доступ ко всем переменным и функциям из Car.py с помощью модуля Car.
Использование модуля from для импорта
Вместо импорта всего кода вы можете импортировать только небольшую часть модуля, т. е. только необходимые функции и имена переменных из модуля.
Если вы хотите импортировать только определенные элементы, вы можете использовать ключевое слово «from», чтобы импортировать то, что вы хотите.
Итак, синтаксис
from module import your function_name , variables,... etc.
Структура папок, используемая для тестирования кода, следующая:
modtest/ test.py display.py
В test.py есть две функции, как показано:
Имя файла: test.py
defdisplay_message(): return "Welcome to Guru99 Tutorials!" def display_message1(): return "All about Python!"
Теперь вам нужна функция display_message(). К импортируемой функции или переменной можно получить прямой доступ, как показано ниже:
Имя файла: display.py
from test import display_message print(display_message())
Вывод:
Welcome to Guru99 Tutorials!
Теперь, если вы воспользуетесь функцией display_message1() , она выдаст ошибку, что функция не определена, как показано ниже:
from test import display_message print(display_message1())
Вывод:
Traceback (most recent call last): File "display.py", line 3, in <module> print(display_message1()) Name Error: name 'display_message1' is not defined
Импорт всего из модуля
Импорт позволяет импортировать весь модуль, используя команду import, за которой следует имя модуля, т. е. имя файла или используемой библиотеки.
Синтаксис:
Import module
Или используя
from module import *
Структура папок, используемая для тестирования кода, следующая:
modtest/ test.py display.py
Ниже приведены детали кода внутри test.py.
my_name = "Guru99" my_address = "Mumbai" defdisplay_message(): return "Welcome to Guru99 Tutorials!" def display_message1(): return "All about Python!"
Использование модуля импорта
Используя только имя модуля импорта, для ссылки на переменные и функции внутри модуля необходимо добавить префикс имени модуля.
Пример
Имя файла: display.py
Import test print(test.display_message()) print(test.display_message1()) print(test.my_name) print(test.my_address)
Тест имени модуля используется для ссылки на функцию и переменные внутри теста модуля.
Вывод:
Welcome to Guru99 Tutorials! All about Python! Guru99 Mumbai
Использование импорта *
Давайте посмотрим пример использования Импортировать *, С помощью Импортировать *, функции и переменные доступны напрямую, как показано в примере ниже:
from test import * print(display_message()) print(display_message1()) print(my_name) print(my_address)
Вывод:
Welcome to Guru99 Tutorials! All about Python! Guru99 Mumbai
Функция реж( )
dir() — это встроенная функция Python. Функция dir() возвращает все свойства и методы, включая встроенные свойства данного объекта.
Поэтому, когда dir() используется в модуле, он предоставит вам переменные и функции, которые присутствуют внутри модуля.
Вот рабочий пример dir() в модуле. У нас есть класс Car.py, давайте импортируем Car и назначим его dir(), чтобы увидеть результат.
Структура папок для тестирования кода будет следующей:
test prop/ Car.py test.py
Имя файла: Car.py
class Car:
brand_name = "BMW"
model = "Z4"
manu_year = "2020"
def __init__(self, brand_name, model, manu_year):
self.brand_name = brand_name
self.model = model
self.manu_year = manu_year
def car_details(self):
print("Car brand is ", self.brand_name)
print("Car model is ", self.model)
print("Car manufacture year is ", self.manu_year)
def get_Car_brand(self):
print("Car brand is ", self.brand_name)
def get_Car_model(self):
print("Car model is ", self.model)
Имя файла: test.py
import Car class_contents = dir(Car) print(class_contents)
Вывод дает нам имя класса и всех функций, определенных в Car.py.
Вы также можете попробовать использовать dir() во встроенном модуле, доступном в Python. Давайте попробуем то же самое JSON модуль, как показано в примере ниже. Он отобразит все свойства и методы, доступные в JSON модуль.
Import json json_details = dir(json) print(json_details)
Вывод:
['JSONDecodeError', 'JSONDecoder', 'JSONEncoder', '__all__', '__author__', '__bu iltins__', '__cached__', '__doc__', '__file__', '__loader__', '__name__', '__pac kage__', '__path__', '__spec__', '__version__', '_default_decoder', '_default_en coder', 'codecs', 'decoder', 'detect_encoding', 'dump', 'dumps', 'encoder', 'loa d', 'loads', 'scanner']
Packages
Пакет — это каталог, в котором определены все модули. Чтобы сделать Python интерпретатор воспринимает его как пакет, в вашем каталоге должен быть файл init.py. init.py создает каталог как пакет. Вот макет пакета, над которым мы будем работать.
Название пакета мой пакет. Чтобы начать работу с пакетом, создайте каталог с именем package/. Внутри каталога создайте пустой файл с именем __init__.py. Создайте еще 3 файла Module1.py, Module2.py и Module3.py и определите функции, как показано на снимке экрана. Вот подробности о модуле1.py,модуле2.py и модуле3.py.
модуль1.py
def mod1_func1():
print("Welcome to Module1 function1")
def mod1_func2():
print("Welcome to Module1 function2")
def mod1_func3():
print("Welcome to Module1 function3")
модуль2.py
def mod2_func1():
print("Welcome to Module2 function1")
def mod2_func2():
print("Welcome to Module2 function2")
def mod2_func3():
print("Welcome to Module2 function3")
модуль3.py
def mod3_func1():
print("Welcome to Module3 function1")
def mod3_func2():
print("Welcome to Module3 function2")
def mod3_func3():
print("Welcome to Module3 function3")
Наша команда пакетон готов к использованию. Теперь вызовите пакет внутри любого файла, как показано ниже: test.py:
Здесь mypackage.module1 импортируется и получает псевдоним как мод1. Аналогично вы можете использовать другие модули mod2.py и modul3.py из моего пакета.
import mypackage.module1 as mod1 print(mod1.mod1_func1()) print(mod1.mod1_func2()) print(mod1.mod1_func2())
Вывод:
Welcome to Module1 function1 None Welcome to Module1 function2 None Welcome to Module1 function2 None
Мы только что продемонстрировали пакет с простым модулем с функциями внутри него. В соответствии с вашим проектом вы также можете упаковать подпакеты. Подпапки/содержащие модули с определенными классами.
Python Путь поиска модуля
Во время выполнения, когда попадается Python имя модуля импорта, интерпретатор пытается найти модуль. Он ищет модуль в списке встроенных модулей. Later в целом каталоги, определенные внутри sys.path.
Подводя итог, интерпретатор выполняет следующий поиск, чтобы найти модуль:
- В вашем текущем каталоге.
- В списке встроенных модулей
- Внутри каталогов sys.path
Вы можете получить подробную информацию о sys.path, импортировав модуль sys и распечатав sys.path. Он предоставит вам список каталогов, как показано ниже:
importsys print(sys.path)
Вывод:
['Python Latest\\task2', 'Users\\AppData\\Local\\Programs\\Python\ \Python37\\python37.zip', 'Users\\AppData\\Local\\Programs\\Python\\P ython37\\DLLs']
Вы также можете изменить путь и сохранить каталоги в соответствии с вашими требованиями.
Использование псевдонима модуля при импорте
Вы также можете преобразовать имя модуля в более короткую форму, присвоив ему псевдоним. Псевдоним можно создать с помощью ключевого слова.
Синтаксис:
import filename as alias name
Структура папок для тестирования кода будет следующей:
Mod test/ test.py display.py
Ниже приведен код внутри test.py.
my_name = "Guru99" my_address = "Mumbai" def display_message(): return "Welcome to Guru99 Tutorials!" def display_message1(): return "All about Python!"
Теперь мы будем использовать псевдоним для test.py в display.py.
Import test as t print(t.display_message()) print(t.display_message1()) print(t.my_name) print(t.my_address)
Псевдоним, используемый для тестового модуля, — t. Таким образом, на функцию и переменные из test.py можно ссылаться, используя псевдоним t.
Вывод:
Welcome to Guru99 Tutorials! All about Python! Guru99 Mumbai
Абсолютный и относительный импорт в Python
Теперь вы знаете, как импортировать файл как модуль внутри другого файла. Давайте теперь посмотрим, как управлять файлами, доступными в папках. Файлы в папках можно импортировать с помощью абсолютного или относительного импорта.
Предположим, у вас есть структура папок проекта, как показано ниже:
Корневая папка — мой проект/. Он имеет две подпапки package1 и package2.
Папка package1 содержит два модуля: Module1.py и Module2.py.
В папке package2 есть один класс myclass.py, подпакет subpkg с модулем3.py и последний модуль4.py.
- В файле mod1.py есть функция myfunc1.
- В файле mod2.py есть функция myfunc2.
- В mod3.py есть функция myfunc3.
- В файле mod4.py есть функция myfunc4.
Использование абсолютного импорта
Для абсолютного импорта вам необходимо добавить полный путь к вашему модулю прямо из корневой папки проекта.
Давайте теперь посмотрим, как использовать абсолютный импорт для ссылки на функции, присутствующие в каждом модуле.
Для работы с функциейmyfunc1 вам потребуется импортировать следующим образом:
from package1.module1 import myfunc1 or from package1 import module1 module1.myfunc1()
Для работы с функцией myfunc3 вам потребуется импортировать следующим образом:
from package1.subpkg.module3 import myfunc3 or from package1.subpkg import module3 module3.myfunc3()
Преимущества и недостатки использования абсолютного импорта
Вот преимущества использования абсолютного импорта:
- Становится легко отслеживать модули для проверки кода.
- Простой в использовании и очень простой.
- Если проект будет перемещен по другому пути, импорт останется прежним.
Недостатки использования абсолютного импорта
Вот недостатки использования абсолютного импорта:
Минусы:
- Путь импорта может оказаться очень длинным, если модули вложены или имя модулей длинное.
Использование относительного импорта
Учитывая ту же структуру папок, упомянутую ниже, мы увидим, как импортировать ее, используя относительный импорт.
При относительном импорте импортируемый модуль относится к текущему местоположению, то есть месту, где присутствует оператор импорта.
Синтаксис
При относительном импорте вам необходимо добавить точку (.) перед именем модуля при импорте с использованием от.
Перед именем модуля будут стоять 2 точки (..), если модуль находится на уровень выше текущего местоположения.
Ссылаясь на упомянутый выше рисунок структуры папок, мы видим следующие модули с их функциями, на которые нам нужно обратиться.
- В файле mod1.py есть функция myfunc1.
- В файле mod2.py есть функция myfunc2.
- В mod3.py есть функция myfunc3.
- В файле mod4.py есть функция myfunc4.
Для работы с функциейmyfunc1 вам потребуется импортировать следующим образом:
from .module1 import myfunc1
Для работы с функцией myfunc3 вам потребуется импортировать следующим образом:
from .subpkg.module3 import myfunc3
Преимущества относительного импорта
Преимущества:
- С относительным импортом легко работать.
- Из текущего местоположения импорт может быть сокращен по сравнению с абсолютным импортом.
Недостатки относительного импорта
Минусы:
- Используя относительный импорт, трудно отследить, где находится код.
Резюме
- Импортировать в Python помогает вам ссылаться на код, т. е. .functions/objects, которые написаны в другом файле. Он также используется для импорта библиотек/пакетов python, которые установлены с помощью pip (менеджер пакетов python), и которые вам затем нужно использовать в вашем коде.
- Функция импорта доступна на других языках, таких как машинописный текст, JavaСкрипт, Java, Ruby и т. д.
- Модуль Python — это код, написанный внутри файла, например (test.py). Внутри вашего файла вы можете определить переменные, функции или класс. Весь файл становится модулем и может быть импортирован в другой файл для ссылки на код.
- Благодаря функциональности модуля вы можете разбить свой код на разные файлы вместо того, чтобы писать все в одном файле. Later, используя импорт, вы можете обратиться к коду внутри нужного вам файла.
- Python имеет встроенные модули, а также внешние библиотеки/пакеты, установленные с помощью менеджер пакетов питона (pip), например pandas, NumPy и т. д., называются модулями.
- Вместо импорта всего кода вы можете импортировать только небольшую часть модуля, т. е. только необходимые функции и имена переменных из модуля.
- Вы также можете преобразовать имя модуля в более короткую форму, присвоив ему псевдоним. Псевдоним можно создать с помощью ключевого слова.
- Пакет — это каталог, в котором определены все модули. Чтобы сделать Python интерпретатор воспринимает его как пакет, в вашем каталоге должен быть файл __init.py. init.py создает каталог как пакет. Вот макет пакета, над которым мы будем работать.
- Во время выполнения, когда попадается Python имя модуля импорта, интерпретатор пытается найти модуль. Он ищет модуль в списке встроенных модулей. Later в целом каталоги, определенные внутри sys.path.
- Для абсолютного импорта вам необходимо добавить полный путь к вашему модулю прямо из корневой папки проекта.
- При относительном импорте импортируемый модуль относится к текущему местоположению, то есть месту, где присутствует оператор импорта.
