kennethreitz/python-guide
1
0
Fork 0
mirror of https://github.com/kennethreitz/python-guide.git synced 2026-06-05 23:00:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

edit stub

Browse Source
This commit is contained in:
Estevan Pequeno
2012-07-03 22:36:07 -05:00
parent 167d566650
commit 28d211f6f5
1 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/writing/structure.rst
+10 -9
View File
@@ -1,21 +1,22 @@
Structuring Your Project Structuring Your Project
======================== ========================
When we say structure we mean the decisions you make concerning By "structure" we mean the decisions you make concerning
how your project best meets its objective. We need to consider how to how your project best meets its objective. We need to consider how to
best leverage Python's features to create clean, effective code. best leverage Python's features to create clean, effective code.
In practical terms structure means the actual files and folders that In practical terms, "structure" means making clean code whose logic and
comprise your project as well as the way dependencies are handled within dependencies are clear as well as how the files and folders are organized
the code itself. in the filesystem.
How does data flow through the project? What features and functions Which functions should go into which modules? How does data flow through
can be grouped together and isolated? By answering questions like these the project? What features and functions can be grouped together and
you can begin to plan, in a broad sense, what your finished product will isolated? By answering questions like these you can begin to plan, in
look like. a broad sense, what your finished product will look like.
In this section we take a closer look at Python's module and import In this section we take a closer look at Python's module and import
systems as they are the central element to enforcing structure in your systems as they are the central element to enforcing structure in your
project. project. We then discuss various perspectives on how to build code which
can be extended and tested reliably.
Structure is Key Structure is Key