Thử nghiệm và cấu trúc gói python

Question

Tôi có một số vấn đề trong việc cấu trúc dự án python của tôi. Hiện tại nó là một loạt các tập tin trong cùng một thư mục. Tôi đã cố gắng cấu trúc nó như

proj/ 
    __init__.py 
    foo.py 
    ... 
    bar/ 
    __init__.py 
    foobar.py 
    ... 
    tests/ 
    foo_test.py 
    foobar_test.py 
    ... 

Vấn đề là tôi không thể, từ thư mục bên trong, nhập mô-đun từ các thư mục bên ngoài. Điều này đặc biệt gây phiền nhiễu với các xét nghiệm.

Tôi đã đọc PEP 328 về nhập tương đối và PEP 366 về nhập tương đối từ mô-đun chính. Nhưng cả hai phương pháp này đều yêu cầu gói cơ bản nằm trong PYTHONPATH của tôi. Trên thực tế tôi có được các lỗi sau

ValueError: Attempted relative import in non-package.

Vì vậy, tôi đã thêm mã boilerplate sau trên đầu trang của các tập tin thử nghiệm

import os, sys 
sys.path.append(os.path.join(os.getcwd(), os.path.pardir)) 

Tôi vẫn nhận được lỗi tương tự. cách chính xác để

• cấu trúc một gói là gì, hoàn chỉnh với các bài kiểm tra, và
• thêm thư mục cơ sở để con đường để cho phép nhập khẩu?

EDIT Theo yêu cầu trong các bình luận, tôi thêm một khẩu dụ thất bại (trong file foo_test.py)

import os, sys 
sys.path.append(os.path.join(os.getcwd(), os.path.pardir)) 
from ..foo import Foo 

Answer 1

Khi bạn sử dụng công tắc -m để chạy mã, thư mục hiện tại sẽ được thêm vào sys.path. Vì vậy, cách đơn giản nhất để chạy thử nghiệm của bạn là từ thư mục cha của proj, sử dụng lệnh:

python -m proj.tests.foo_test 

Để thực hiện công việc đó, bạn sẽ cần phải bao gồm một tập tin __init__.py trong thư mục kiểm tra của bạn để kiểm tra là đúng được công nhận là một phần của gói.

Answer 2

Tôi muốn nhập khẩu các module sử dụng đầy đủ proj.NAME gói tiền tố bất cứ khi nào có thể. Đây là phương pháp tiếp cận của Google Python styleguide đề xuất.

Một tùy chọn để cho phép bạn giữ cấu trúc gói, sử dụng đường dẫn gói đầy đủ và vẫn tiếp tục phát triển sẽ sử dụng virtualenv và đặt dự án của bạn ở chế độ phát triển. Dự án của bạn setup.py sẽ cần phải sử dụng setuptools thay vì distutils để nhận lệnh develop.

này sẽ cho phép bạn tránh được những thứ sys.path.append trên:

% virtualenv ~/virt 
% . ~/virt/bin/activate 
(virt)~% cd ~/myproject 
(virt)~/myproject% python setup.py develop 
(virt)~/myproject% python tests/foo_test.py 

đâu foo_test.py sử dụng:

from proj.foo import Foo 

Bây giờ khi bạn chạy python từ bên trong PYTHONPATH bạn virtualenv của bạn sẽ trỏ đến tất cả các gói trong dự án của bạn. Bạn có thể tạo bí danh vỏ ngắn hơn để nhập virtualenv của mình mà không cần phải nhập . ~/virt/bin/activate mỗi lần.