Tác giả: Hoàng Anh Quân

TLDR

  • Không thể chạy trực tiếp một file sử dụng relative import. Ví dụ, nếu câu lệnh thực thi là python3 main.py thì nội dung file main.py không được chứa relative import.
  • Python tìm module trong các thư mục được liệt kê trong biến môi trường (environment variable) PYTHONPATH. Người dùng có thể thay đổi (chính xác hơn là bổ sung) những đường dẫn thư mục cần thiết vào PYTHONPATH.
  • Phương pháp relative import thường được sử dụng trong file __init__.py để rút gọn việc import ở file code chính.

1. Đặt vấn đề

Xét cấu trúc thư mục như dưới đây

mainFolder/
  bar/
    utils.py
  main.py

Nội dung các file gồm có

# utils.py
def foo():
    print('Hello MIMPython')

# main.py
from utils import foo
print(foo)

Mở một terminal tại thư mục mainFolder/, khi thực thi câu lệnh

python3 main.py

thì ta sẽ nhận được thông báo lỗi

ModuleNotFoundError: No module named 'utils'

2. Python tìm module ở đâu?

Nếu đổi dòng code from utils import foo trong file main.py thành

from bar.utils import foo

thì file này sẽ được chạy thành công (giả sử rằng terminal vẫn đang ở thư mục mainFolder/). Điều này thể hiện rằng hiện tại Python “tìm thấy” bar.utils nhưng không tìm thấy utils.

Khi thực thi một chương trình Python, chương trình sẽ tìm các module trong một danh sách các thư mục nhất định. Danh sách này có chứa vị trí hiện tại của terminal, điều này giải thích cho việc Python có thể tìm thấy bar.utils trong chương trình bên trên.

Để xem danh sách này trong Python, ta sử dụng câu lệnh

import sys
print(sys.path)

Danh sách này được tổng hợp từ nhiều nguồn khác nhau. Nên để bổ sung đường dẫn cần thiết vào sys.path, ta có thể thực hiện một trong hai cách sau:

  • Bổ sung đường dẫn vào sys.path.
  • Bổ sung đường dẫn vào một nguồn mà sys.path sử dụng.

2.1. Bổ sung đường dẫn vào sys.path

Nếu bổ sung hai dòng dưới vào file main.py

import sys
sys.path.append('/path/to/mainFolder/bar/') # to tell Python where to look for "utils"

thì ta có thể chạy file main.py mà không gặp lỗi ModuleNotFoundError.

2.2. Bổ sung đường dẫn vào một nguồn

Phương pháp bổ sung đường dẫn trực tiếp kể trên không tốt (theo quan điểm của người viết) vì nó thực hiện việc bổ sung đường dẫn ngay trong code.
Một cách khác là thay đổi biến môi trường (environment variable) PYTHONPATH, một nguồn danh sách đường dẫn được tổng hợp vào sys.path. Giá trị của biến này được hiển thị trên terminal với câu lệnh

echo $PYTHONPATH # Linux

hoặc bằng đoạn code Python sau

import os
print(os.environ.get('PYTHONPATH', None))

Để bổ sung thêm đường dẫn vào PYTHONPATH, ta thực hiện câu lệnh dưới đây trên terminal

# instructions for Linux
PYTHONPATH=$PYTHONPATH:/path/to/mainFolder/bar/
export PYTHONPATH

Cách làm này có một đặc điểm (có lẽ là nhược điểm) là sự bổ sung đường dẫn này chỉ có tác dụng trong terminal thực thi câu lệnh, trong khi các terminal khác không bị ảnh hưởng.

Ngoài ra, hướng dẫn bổ sung đường dẫn trên Windows có thể tìm thấy trên stackoverflow.

3. Absolute import trong Python

Ví dụ cho cấu trúc absolute import

import random
from math import sqrt

Một số thư viện phổ biến có những quy ước riêng về alias import (sử dụng keyword as), ví dụ như

import matplotlib.pyplot as plt
import numpy as np
import pandas as pd

Chú ý. Cấu trúc wildcard import có cách viết là from x import *. Không nên sử dụng phương pháp này, trừ những trường hợp bất khả kháng, ví dụ như khi sử dụng thư viện manim.

4. Relative import trong Python

Relative import sử dụng cách viết với một hoặc nhiều dấu . ở phần đầu. Chi tiết xem trong phần ví dụ phía dưới.

5. Ví dụ minh họa

Dưới đây là một ví dụ minh họa về cách sử dụng import trong Python.

testImport/
  utils/
    __init__.py
    fileA.py
    fileB.py
  main.py

Nội dung các file gồm có

# fileA.py
def methodA():
    print('In methodA of fileA')
    return None

# fileB.py
from .fileA import methodA
def methodB():
    print('In methodB of fileB')
    return None

# __init__.py
from .fileA import methodA

# main.py
from utils import methodA
from utils.fileB import methodB
methodA()
methodB()

Bằng cách sử dụng import (cụ thể là relative import) trong file __init__.py, ta đã có thể lấy được methodA ngay từ utils, thay vì phải vào utils.fileB để lấy methodB. Một cách tổng quát, việc tạo (và sử dụng relative import trong) file __init__.py làm đơn giản hóa phần import trong file code chính.

Đứng ở thư mục testImport/ và thực thi câu lệnh python3 main.py, ta thu được kết quả (thành công) như sau

In methodA of fileA
In methodB of fileB

6. Một số chú ý khác

  • Quy ước cách viết import được liệt kê chi tiết trong PEP8.
  • Không nên đặt tên file trùng với tên những thư viện phổ biến.
  • Có thể sử dụng thư viện ipynb để import class/function/variable từ một file Jupyter notebook sang một file Jupyter notebook khác. Tuy nhiên, đây là phương pháp bất đắc dĩ. Trong hầu hết các trường hợp, người viết code nên chuyển những thứ cần được import vào một module (file .py).
  • Lỗi cyclic import có thể phát sinh trong quá trình thiết kế chương trình. Đọc thêm bài viết này để biết cách giải quyết chúng.

Nội dung trên chỉ là tóm tắt, học viên cần đọc các tài liệu liệt kê trong phần tài liệu tham khảo dưới đây.

Tài liệu tham khảo

Tài liệu chính

Updated: