Merge pull request #409 from matthew-brett/refactor-package-structure

MRG: refactor modules into netCDF4 package

Author: Jeff Whitaker

.gitignore

@@ -1 +1,4 @@
 build/
+*.pyc
+dist/
+*.egg-info/

Changelog

@@ -27,6 +27,10 @@
    Not installed by setup.py (contributed by Ross Gammon, issue #383).
  * replace tabs with spaces by running reindent.py on all *.py and *.pyx files
    (issue #378).
+ * refactor netCDF4_utils and netCDF4 module into netCDF4 package.
+   Refactoring effectively removes netCDF4 utils private attributes from
+   netCDF4 namespace, so has the potential to break code using private
+   attributes (issue #409).
 
  version 1.1.7 (tag v1.1.7rel)
  =============================

MANIFEST.in

@@ -1,17 +1,12 @@
 recursive-include docs *
 recursive-include man *
+recursive-include include *
 include MANIFEST.in
 include README.md
 include COPYING
 include Changelog
 include setup.cfg
 include setup.cfg.template
-include netCDF4.pyx
-include netCDF4_utils.py
-include netCDF4.pxi
-include netCDF4.c
-include utils.pyx
-include constants.pyx
 include examples/*py
 include examples/*ipynb
 include examples/README.md

create_docs.sh

@@ -1,2 +1,2 @@
 # svn propset svn:mime-type text/html docs/*html
-epydoc -v --no-frames --no-private --introspect-only -o docs netCDF4 
+epydoc -v --no-frames --no-private --introspect-only --name netcdf4-python -o docs netCDF4._netCDF4

constants.pyx renamed to include/constants.pyx

@@ -0,0 +1,8 @@
+# init for netCDF4 package
+# Docstring comes from extension module _netCDF4
+from ._netCDF4 import *
+# Need explicit imports for names beginning with underscores
+from ._netCDF4 import __doc__
+from ._netCDF4 import (__version__, __netcdf4libversion__, __hdf5libversion__,
+                       __has_rename_grp__, __has_nc_inq_path__,
+                       __has_nc_inq_format_extended__)

netCDF4.pxi renamed to include/netCDF4.pxi

@@ -768,8 +768,8 @@ del __test__ # hack so epydoc doesn't show __test__
 # Make changes to this file, not the c-wrappers that Pyrex generates.
 
 # pure python utilities
-from netCDF4_utils import _StartCountStride, _quantize, _find_dim, _walk_grps, \
-                          _out_array_shape, _sortbylist, _tostr
+from .utils import (_StartCountStride, _quantize, _find_dim, _walk_grps,
+                    _out_array_shape, _sortbylist, _tostr)
 # try to use built-in ordered dict in python >= 2.7
 try:
     from collections import OrderedDict