MRG: refactor modules into netCDF4 package

.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

netCDF4/__init__.py

@@ -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.pyx → netCDF4/_netCDF4.pyx

@@ -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

setup.py

@@ -1,13 +1,15 @@
-import os, sys, subprocess, shutil
+import os, sys, subprocess
+import os.path as osp
+
 try:
     from setuptools import setup, Extension
     setuptools_extra_kwargs = {
         "install_requires":  ["numpy>=1.7"],
         "entry_points": {
             'console_scripts': [
-                'ncinfo = netCDF4_utils:ncinfo',
-                'nc4tonc3 = netCDF4_utils:nc4tonc3',
-                'nc3tonc4 = netCDF4_utils:nc3tonc4',
+                'ncinfo = netCDF4.utils:ncinfo',
+                'nc4tonc3 = netCDF4.utils:nc4tonc3',
+                'nc3tonc4 = netCDF4.utils:nc3tonc4',
             ]
         },
     }
@@ -349,22 +351,25 @@ def getnetcdfvers(libdirs):
     sys.stdout.write('using netcdf library version %s\n' % netcdf_lib_version)
 
 cmdclass = {}
+netcdf4_src_root = osp.join('netCDF4', '_netCDF4')
+netcdf4_src_c = netcdf4_src_root + '.c'
 if has_cython and 'sdist' not in sys.argv[1:]:
     sys.stdout.write('using Cython to compile netCDF4.pyx...\n')
-    extensions = [Extension("netCDF4",["netCDF4.pyx"],
-                  libraries=libs,
-                  library_dirs=lib_dirs,
-                  include_dirs=inc_dirs,
-                  runtime_library_dirs=lib_dirs),
+    extensions = [Extension("netCDF4._netCDF4",
+                            [netcdf4_src_root + '.pyx'],
+                            libraries=libs,
+                            library_dirs=lib_dirs,
+                            include_dirs=inc_dirs,
+                            runtime_library_dirs=lib_dirs),
                   Extension('netcdftime._datetime', ['netcdftime/_datetime.pyx'])]
     # remove netCDF4.c file if it exists, so cython will recompile netCDF4.pyx.
     # run for build *and* install (issue #263). Otherwise 'pip install' will
     # not regenerate netCDF4.c, even if the C lib supports the new features.
-    if len(sys.argv) >= 2 and os.path.exists('netCDF4.c'):
-        os.remove('netCDF4.c')
+    if len(sys.argv) >= 2 and os.path.exists(netcdf4_src_c):
+        os.remove(netcdf4_src_c)
     # this determines whether renameGroup and filepath methods will work.
     has_rename_grp, has_nc_inq_path, has_nc_inq_format_extended = check_api(inc_dirs)
-    f = open('constants.pyx','w')
+    f = open(osp.join('include', 'constants.pyx'),'w')
     if has_rename_grp:
         sys.stdout.write('netcdf lib has group rename capability\n')
         f.write('DEF HAS_RENAME_GRP = 1\n')
@@ -384,13 +389,14 @@ def getnetcdfvers(libdirs):
         sys.stdout.write('netcdf lib does not have nc_inq_format_extended function\n')
         f.write('DEF HAS_NC_INQ_FORMAT_EXTENDED = 0\n')
     f.close()
-    ext_modules = cythonize(extensions)
+    ext_modules = cythonize(extensions, include_path=['include'])
 else:
-    extensions = [Extension("netCDF4",["netCDF4.c"],
-                  libraries=libs,
-                  library_dirs=lib_dirs,
-                  include_dirs=inc_dirs,
-                  runtime_library_dirs=lib_dirs),
+    extensions = [Extension("netCDF4._netCDF4",
+                            [netcdf4_src_c],
+                            libraries=libs,
+                            library_dirs=lib_dirs,
+                            include_dirs=inc_dirs,
+                            runtime_library_dirs=lib_dirs),
                   Extension('netcdftime._datetime', ['netcdftime/_datetime.c'])]
     ext_modules = extensions
 
@@ -412,7 +418,6 @@ def getnetcdfvers(libdirs):
                  "Topic :: Software Development :: Libraries :: Python Modules",
                  "Topic :: System :: Archiving :: Compression",
                  "Operating System :: OS Independent"],
-  py_modules = ["netCDF4_utils"],
-  packages = ['netcdftime'],
+  packages = ['netcdftime', 'netCDF4'],
   ext_modules = ext_modules,
   **setuptools_extra_kwargs)

test/tst_compression.py

@@ -1,5 +1,6 @@
 from numpy.random.mtrand import uniform
-from netCDF4 import Dataset, _quantize
+from netCDF4 import Dataset
+from netCDF4.utils import _quantize
 from numpy.testing import assert_almost_equal
 import os, tempfile, unittest