##// END OF EJS Templates
Minor edits to reorg.txt.
Brian Granger -
Show More
@@ -14,6 +14,7 b' Currently, IPython has many top-level modules that serve many different purposes'
14 This effort will result in the removal from IPython of certain modules
14 This effort will result in the removal from IPython of certain modules
15 that are not used anymore, don't currently work, are unmaintained, etc.
15 that are not used anymore, don't currently work, are unmaintained, etc.
16
16
17
17 Current subpackges
18 Current subpackges
18 ==================
19 ==================
19
20
@@ -48,146 +49,151 b' We propose to create the following new sub-packages:'
48 interpreter, but none of its extended capabilities.
49 interpreter, but none of its extended capabilities.
49
50
50 * :mod:`IPython.lib`. IPython has many extended capabilities that are not part
51 * :mod:`IPython.lib`. IPython has many extended capabilities that are not part
51 of the IPython core. These things go here and sit on top of the IPython
52 of the IPython core. These things will go here. Any better names than
52 core.
53 :mod:`IPython.lib`?
53
54
54 * :mod:`IPython.python`. This sub-package will contain anything that might
55 * :mod:`IPython.python`. This sub-package will contain anything that might
55 eventually be found in the Python standard library. These things should only
56 eventually be found in the Python standard library, like things in
56 depend on Python and the standard library. Each sub-module in this
57 :mod:`genutils`. Each sub-module in this sub-package should contain functions
57 sub-package should contain functions and objects that serve a single
58 and classes that serve a single purpose. Similar in purpose to
58 purpose. Similar in purpose to :mod:`twisted.python`. Could also call this
59 :mod:`twisted.python`. Could also call this :mod:`IPython.tools`,
59 :mod:`IPython.tools` or something similar.
60 :mod:`IPython.utils` or something similar.
60
61
61 * :mod:`IPython.sandbox`. This is for code that is untested and/or rotting and
62 * :mod:`IPython.sandbox`. This is for code that is untested and/or rotting and
62 needs to be removed from IPython. Eventually all this code will either i) be
63 needs to be removed from IPython. Eventually all this code will either i) be
63 revived with tests and docs and re-included into IPython or 2) be put into a
64 revived with tests and docs and re-included into IPython or 2) be removed from
64 separate top-level (not IPython) package that we keep around.
65 IPython proper, but put into a separate top-level (not IPython) package that we
66 keep around.
65
67
66 Where things will be moved
68 Where things will be moved
67 ==========================
69 ==========================
68
70
69 * :mod:`ColorANSI.py`. Move to :mod:`IPython.core`.
71 * :file:`ColorANSI.py`. Move to :file:`IPython/core/coloransi.py`.
70
72
71 * :mod:`ConfigLoader.py`. Move to :mod:`IPython.config`.
73 * :file:`ConfigLoader.py`. Move to :file:`IPython/config/configloader.py`.
72
74
73 * :mod:`CrashHandler.py`. Move to :mod:`IPython.core`.
75 * :file:`CrashHandler.py`. Move to :file:`IPython/core/crashhandler`.
74
76
75 * :mod:`DPyGetOpt.py`. Move the :mod:`IPython.sandbox` and replace with newer options parser.
77 * :file:`DPyGetOpt.py`. Move to :mod:`IPython.sandbox` and replace with newer options parser.
76
78
77 * :mod:`Debugger.py`. Move to :mod:`IPython.core`.
79 * :file:`Debugger.py`. Move to :file:`IPython/core/debugger.py`.
78
80
79 * :mod:`Extensions`. This needs to be gone through separately. By default
81 * :file:`Extensions`. This needs to be gone through separately. Minimally,
80 everything here should simply be put into :mod:`IPython.core`. Of course, as
82 the package should be renamed to :file:`extensions`.
81 we do this, we will realize that some things belong in places like
82 :mod:`IPython.core`, :mod:`IPython.lib` and :mod:`IPython.python`.
83
83
84 * :mod:`FakeModule.py`. Move to :mod:`IPython.core`.
84 * :file:`FakeModule.py`. Move to :file:`IPython/core/fakemodule.py`.
85
85
86 * :mod:`Gnuplot2.py`. Move to :mod:`IPython.sandbox`.
86 * :file:`Gnuplot2.py`. Move to :file:`IPython.sandbox`.
87
87
88 * :mod:`GnuplotInteractive.py`. Move to :mod:`IPython.sandbox`.
88 * :file:`GnuplotInteractive.py`. Move to :file:`IPython.sandbox`.
89
89
90 * :mod:`GnuplotRuntime.py`. Move to :mod:`IPython.sandbox`.
90 * :file:`GnuplotRuntime.py`. Move to :file:`IPython.sandbox`.
91
91
92 * :mod:`Itpl.py`. Remove. Version already in :mod:`IPython.external`.
92 * :file:`Itpl.py`. Remove. Version already in :file:`IPython.external`.
93
93
94 * :mod:`Logger.py`. Move to :mod:`IPython.core`.
94 * :file:`Logger.py`. Move to :file:`IPython/core/logger.py`.
95
95
96 * :mod:`Magic.py`. Move to :mod:`IPython.core`.
96 * :file:`Magic.py`. Move to :file:`IPython/core/magic.py`.
97
97
98 * :mod:`OInspect.py`. Move to :mod:`IPython.core`.
98 * :file:`OInspect.py`. Move to :file:`IPython/core/oinspect.py`.
99
99
100 * :mod:`OutputTrap.py`. Move to :mod:`IPython.core`.
100 * :file:`OutputTrap.py`. Move to :file:`IPython/core/outputtrap.py`.
101
101
102 * :mod:`Prompts.py`. Move to :mod:`IPython.core` or :mod:`IPython.frontend`.
102 * :file:`Prompts.py`. Move to :file:`IPython/core/prompts.py` or
103 :file:`IPython/frontend/prompts.py`.
103
104
104 * :mod:`PyColorize.py`. Replace with pygments? If not, move to :mod:`IPython.core`.
105 * :file:`PyColorize.py`. Replace with pygments? If not, move to :file:`IPython/core/pycolorize.py`.
105
106
106 * :mod:`Release.py`. Move to ???.
107 * :file:`Release.py`. Move to ??? or remove?
107
108
108 * :mod:`Shell.py`. Move to :mod:`IPython.core` or :mod:`IPython.frontend`.
109 * :file:`Shell.py`. Move to :file:`IPython.core.shell.py` or
110 :file:`IPython/frontend/shell.py`.
109
111
110 * :mod:`UserConfig`. Move to a subdirectory of :mod:`IPython.config`.
112 * :file:`UserConfig`. Move to a subdirectory of :file:`IPython.config`.
111
113
112 * :mod:`background_jobs.py`. Move to :mod:`IPython.lib`.
114 * :file:`background_jobs.py`. Move to :file:`IPython/lib/backgroundjobs.py`.
113
115
114 * :mod:`completer.py`. Move to :mod:`IPython.core`.
116 * :file:`completer.py`. Move to :file:`IPython/core/completer.py`.
115
117
116 * :mod:`config`. Good where it is!
118 * :file:`config`. Good where it is!
117
119
118 * :mod:`deep_reload.py`. Move to :mod:`IPython.lib`.
120 * :file:`deep_reload.py`. Move to :file:`IPython/lib/deepreload.py`.
119
121
120 * :mod:`demo.py`. Move to :mod:`IPython.lib`.
122 * :file:`demo.py`. Move to :file:`IPython/lib/demo.py`.
121
123
122 * :mod:`dtutils.py`. Move to :mod:`IPython.testing` or :mod:`IPython.lib`.
124 * :file:`dtutils.py`. Remove or move to :file:`IPython.testing` or
125 :file:`IPython.lib`.
123
126
124 * :mod:`excolors.py`. Move to :mod:`IPython.core` or :mod:`IPython.config`.
127 * :file:`excolors.py`. Move to :file:`IPython.core` or :file:`IPython.config`.
125
128
126 * :mod:`external`. Good where it is!
129 * :file:`external`. Good where it is!
127
130
128 * :mod:`frontend`. Good where it is!
131 * :file:`frontend`. Good where it is!
129
132
130 * :mod:`generics.py`. Move to :mod:`IPython.python`.
133 * :file:`generics.py`. Move to :file:`IPython.python`.
131
134
132 * :mod:`genutils.py`. Move to :mod:`IPython.python` and break up into different modules.
135 * :file:`genutils.py`. Move to :file:`IPython.python` and break up into different
136 modules.
133
137
134 * :mod:`gui`. Eventually this should be moved to a subdir of :mod:`IPython.python`
138 * :file:`gui`. Eventually this should be moved to a subdir of
139 :file:`IPython.frontend`.
135
140
136 * :mod:`history.py`. Move to :mod:`IPython.core`.
141 * :file:`history.py`. Move to :file:`IPython.core`.
137
142
138 * :mod:`hooks.py`. Move to :mod:`IPython.core`.
143 * :file:`hooks.py`. Move to :file:`IPython.core`.
139
144
140 * :mod:`ipapi.py`. Move to :mod:`IPython.core`.
145 * :file:`ipapi.py`. Move to :file:`IPython.core`.
141
146
142 * :mod:`iplib.py`. Move to :mod:`IPython.core`.
147 * :file:`iplib.py`. Move to :file:`IPython.core`.
143
148
144 * :mod:`ipmaker.py`: Move to :mod:`IPython.core`.
149 * :file:`ipmaker.py`: Move to :file:`IPython.core`.
145
150
146 * :mod:`ipstruct.py`. Move to :mod:`IPython.python`.
151 * :file:`ipstruct.py`. Move to :file:`IPython.python`.
147
152
148 * :mod:`irunner.py`. Move to :mod:`IPython.scripts`.
153 * :file:`irunner.py`. Move to :file:`IPython.scripts`.
149
154
150 * :mod:`kernel`. Good where it is.
155 * :file:`kernel`. Good where it is.
151
156
152 * :mod:`macro.py`. Move to :mod:`IPython.core`.
157 * :file:`macro.py`. Move to :file:`IPython.core`.
153
158
154 * :mod:`numutils.py`. Move to :mod:`IPython.sandbox`.
159 * :file:`numutils.py`. Move to :file:`IPython.sandbox`.
155
160
156 * :mod:`platutils.py`. Move to :mod:`IPython.python`.
161 * :file:`platutils.py`. Move to :file:`IPython.python`.
157
162
158 * :mod:`platutils_dummy.py`. Move to :mod:`IPython.python`.
163 * :file:`platutils_dummy.py`. Move to :file:`IPython.python`.
159
164
160 * :mod:`platutils_posix.py`. Move to :mod:`IPython.python`.
165 * :file:`platutils_posix.py`. Move to :file:`IPython.python`.
161
166
162 * :mod:`platutils_win32.py`. Move to :mod:`IPython.python`.
167 * :file:`platutils_win32.py`. Move to :file:`IPython.python`.
163
168
164 * :mod:`prefilter.py`: Move to :mod:`IPython.core`.
169 * :file:`prefilter.py`: Move to :file:`IPython.core`.
165
170
166 * :mod:`rlineimpl.py`. Move to :mod:`IPython.core`.
171 * :file:`rlineimpl.py`. Move to :file:`IPython.core`.
167
172
168 * :mod:`shadowns.py`. Move to :mod:`IPython.core`.
173 * :file:`shadowns.py`. Move to :file:`IPython.core`.
169
174
170 * :mod:`shellglobals.py`. Move to :mod:`IPython.core`.
175 * :file:`shellglobals.py`. Move to :file:`IPython.core`.
171
176
172 * :mod:`strdispatch.py`. Move to :mod:`IPython.python`.
177 * :file:`strdispatch.py`. Move to :file:`IPython.python`.
173
178
174 * :mod:`testing`. Good where it is.
179 * :file:`testing`. Good where it is.
175
180
176 * :mod:`tests`. Good where it is.
181 * :file:`tests`. Good where it is.
177
182
178 * :mod:`tools`. Things in here need to be looked at and moved elsewhere.
183 * :file:`tools`. Things in here need to be looked at and moved elsewhere like
184 :file:`IPython.python`.
179
185
180 * :mod:`twshell.py`. Move to :mod:`IPython.sandbox`.
186 * :file:`twshell.py`. Move to :file:`IPython.sandbox`.
181
187
182 * :mod:`ultraTB.py`. Move to :mod:`IPython.core`.
188 * :file:`ultraTB.py`. Move to :file:`IPython/core/ultratb.py`.
183
189
184 * :mod:`upgrade_dir.py`. Move to :mod:`IPython.python`.
190 * :file:`upgrade_dir.py`. Move to :file:`IPython/python/upgradedir.py`.
185
191
186 * :mod:`usage.py`. Move to :mod:`IPython.core`.
192 * :file:`usage.py`. Move to :file:`IPython.core`.
187
193
188 * :mod:`wildcard.py`. Move to :mod:`IPython.python` or :mod:`IPython.core`.
194 * :file:`wildcard.py`. Move to :file:`IPython.python` or :file:`IPython.core`.
189
195
190 * :mod:`winconsole.py`. Move to :mod:`IPython.lib`.
196 * :file:`winconsole.py`. Move to :file:`IPython.lib`.
191
197
192 Other things
198 Other things
193 ============
199 ============
@@ -199,10 +205,12 b' When these files are moved around, a number of other things will happen at the s'
199 test of the module reorganization. These tests will be put into new
205 test of the module reorganization. These tests will be put into new
200 :file:`tests` subdirectories that each package will have.
206 :file:`tests` subdirectories that each package will have.
201
207
202 2. Modules will be renamed to comply with PEP 8 naming conventions: all
208 2. PyFlakes and other code checkers will be run to look for problems.
209
210 3. Modules will be renamed to comply with PEP 8 naming conventions: all
203 lowercase and no special characters like ``-`` or ``_``.
211 lowercase and no special characters like ``-`` or ``_``.
204
212
205 3. Existing tests will be moved to the appropriate :file:`tests`
213 4. Existing tests will be moved to the appropriate :file:`tests`
206 subdirectories.
214 subdirectories.
207
215
208
216
General Comments 0
You need to be logged in to leave comments. Login now