Python Module Subfolder Structure

Question

My end goal with my current Python project structure is to be able to do:

from module.file1 import class1
from module.file1.subfile1 import subclass1

I tried the following:

/module
    __init__.py
    file1.py: Class 1
    /file1
        __init__.py
        subfile1.py: Subclass 1
        subfile2.py: Subclass 2
    file2.py: Class 2

However, while the second import statement above works, the first one does not (tested via pip installing the root working directory). I've seen structures like this before in other libraries, so I believe it is possible. If anyone could help, I would greatly appreciate it.

Tobias Holm · Accepted Answer · 2024-12-04 11:04:45Z

3

This code says that module and file1 are packages, and not modules:

from module.file1 import class1
from module.file1.subfile1 import subclass1

It is incorrect to have both package (directory) file1 and module (file) file1. There should be only a package.

For the class class1 to be importable from file1, it should be placed in the __init__.py of the package.

Therefore, the structure should be modified this way:

/module
    __init__.py
    /file1
        __init__.py: Class 1
        subfile1.py: Subclass 1
        subfile2.py: Subclass 2
    file2.py: Class 2

edited Dec 4, 2024 at 11:04

Tobias Holm

358 bronze badges

answered Jul 29, 2020 at 21:24

zvone

19.5k5 gold badges53 silver badges84 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

cmitch Over a year ago

Thanks for the help!

Uce Jan 2 at 8:28

what is the difference between modules and packages in terms of python?

zvone Jan 2 at 12:23

@Uce It's best to read about it here: docs.python.org/3/tutorial/modules.html

Collectives™ on Stack Overflow

Python Module Subfolder Structure

1 Answer 1

3 Comments

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Related