How should I organize Python source code? [closed]

Answer 1

The article Eric pointed to is awesome because it covers details of organising large Python code bases.

If you've landed here from Google and are trying to find out how to split one large source file into multiple, more manageable, files I'll summarise the process briefly.

Assume you currently have everything in a file called main.py:

• Create another source file in the same folder (let's call ours utils.py for this example)
• Move whatever classes, functions, statements, etc you need from main.py into utils.py
• In main.py add a single line at the top: import utils

Conceptually what this does is to create a new module called utils in another source file. You can then import it wherever it's needed.

Answer 2

The way you should organise your code and tests is exactly the same you would for any OO language.

Answers from the way I do it. It may not be right but works for me

1. Depends on how your functionality is split. For my main python app I have 1 file with classes for the entry points and then packages of different bits of functionality
2. I use PyDev for eclipse and organise it like I would for Java.

>  Workspace
>     |
>     |-Src
>     |   |-Package1
>     |   |-Package2
>     |   |-main.py
>     |-Test
>         |-TestPackage1
>         |-TestPackage2

3. Use DocString everywhere to keep track of everything
4. After making sure that the relevant __init__.py files are in the folders. its just a simple case of from module import class