BLD: rename / move some extensions

xref pandas-dev#12588

pandas.parser -> io/libparsers.pyx

pandas.json -> pandas.io.json.libjson

pandas.io.sas.saslib -> libsas

pandas.msgpack -> pandas.io.msgpack

Author: jreback

asv_bench/benchmarks/binary_ops.py

@@ -107,4 +107,4 @@ def setup(self):
         self.s = Series(date_range('20010101', periods=self.N, freq='T', tz='US/Eastern'))
         self.ts = self.s[self.halfway]
 
-        self.s2 = Series(date_range('20010101', periods=self.N, freq='s',  tz='US/Eastern'))
+        self.s2 = Series(date_range('20010101', periods=self.N, freq='s',  tz='US/Eastern'))

asv_bench/benchmarks/panel_methods.py

@@ -21,4 +21,4 @@ def time_shift(self):
         self.panel.shift(1)
 
     def time_shift_minor(self):
-        self.panel.shift(1, axis='minor')
+        self.panel.shift(1, axis='minor')

doc/source/whatsnew/v0.20.0.txt

@@ -446,6 +446,24 @@ New Behavior:
    In [11]: index.memory_usage(deep=True)
    Out[11]: 260
 
+.. _whatsnew_0200.api_breaking.extensions:
+
+Extension Modules Moving
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Some formerly public extension modules have been moved and/or renamed. These are all removed from the public API.
+If indicated, a deprecation warning will be issued if you reference that module. (:issue:`12588`)
+
+.. csv-table::
+    :header: "Previous Location", "New Location", "Deprecated"
+    :widths: 30, 30, 4
+
+    "pandas.json", "pandas.io.json.libjson", "X"
+    "pandas.parser", "pandas.io.libparsers", "X"
+    "pandas.io.sas.saslib", "pandas.io.sas.libsas", ""
+    "pandas.msgpack", "pandas.io.msgpack", ""
+
+
 .. _whatsnew_0200.api_breaking.groupby_describe:
 
 Groupby Describe Formatting

pandas/__init__.py

@@ -53,11 +53,15 @@
 from pandas.tools.util import to_numeric
 from pandas.core.reshape import melt
 from pandas.util.print_versions import show_versions
-
 from pandas.io.api import *
-
 from pandas.util._tester import test
 
+# extension module deprecations
+from pandas.util.depr_module import _DeprecatedModule
+
+json = _DeprecatedModule(deprmod='pandas.json', deprmodto='pandas.io.json.libjson')
+parser = _DeprecatedModule(deprmod='pandas.parser', deprmodto='pandas.io.libparsers')
+
 # use the closest tagged version if possible
 from ._version import get_versions
 v = get_versions()

pandas/io/api.py

@@ -11,7 +11,7 @@
 from pandas.io.json import read_json
 from pandas.io.html import read_html
 from pandas.io.sql import read_sql, read_sql_table, read_sql_query
-from pandas.io.sas.sasreader import read_sas
+from pandas.io.sas import read_sas
 from pandas.io.feather_format import read_feather
 from pandas.io.stata import read_stata
 from pandas.io.pickle import read_pickle, to_pickle

pandas/io/excel.py

@@ -19,7 +19,7 @@
                               EmptyDataError, get_filepath_or_buffer,
                               _NA_VALUES)
 from pandas.tseries.period import Period
-from pandas import json
+from pandas.io.json import libjson
 from pandas.compat import (map, zip, reduce, range, lrange, u, add_metaclass,
                            string_types, OrderedDict)
 from pandas.core import config
@@ -1434,7 +1434,7 @@ def write_cells(self, cells, sheet_name=None, startrow=0, startcol=0,
             elif isinstance(cell.val, date):
                 num_format_str = self.date_format
 
-            stylekey = json.dumps(cell.style)
+            stylekey = libjson.dumps(cell.style)
             if num_format_str:
                 stylekey += num_format_str
 
@@ -1562,7 +1562,7 @@ def write_cells(self, cells, sheet_name=None, startrow=0, startcol=0,
             elif isinstance(cell.val, date):
                 num_format_str = self.date_format
 
-            stylekey = json.dumps(cell.style)
+            stylekey = libjson.dumps(cell.style)
             if num_format_str:
                 stylekey += num_format_str
 

pandas/io/json/json.py

@@ -3,7 +3,7 @@
 import os
 import numpy as np
 
-import pandas.json as _json
+from pandas.io.json import libjson
 from pandas.tslib import iNaT
 from pandas.compat import StringIO, long, u
 from pandas import compat, isnull
@@ -13,8 +13,8 @@
 from pandas.formats.printing import pprint_thing
 from .normalize import _convert_to_line_delimits
 
-loads = _json.loads
-dumps = _json.dumps
+loads = libjson.loads
+dumps = libjson.dumps
 
 
 # interface to/from

pandas/msgpack/__init__.py renamed to pandas/io/msgpack/__init__.py

@@ -2,8 +2,8 @@
 
 from collections import namedtuple
 
-from pandas.msgpack.exceptions import *  # noqa
-from pandas.msgpack._version import version  # noqa
+from pandas.io.msgpack.exceptions import *  # noqa
+from pandas.io.msgpack._version import version  # noqa
 
 
 class ExtType(namedtuple('ExtType', 'code data')):
@@ -19,8 +19,8 @@ def __new__(cls, code, data):
 
 import os  # noqa
 
-from pandas.msgpack._packer import Packer  # noqa
-from pandas.msgpack._unpacker import unpack, unpackb, Unpacker  # noqa
+from pandas.io.msgpack._packer import Packer  # noqa
+from pandas.io.msgpack._unpacker import unpack, unpackb, Unpacker  # noqa
 
 
 def pack(o, stream, **kwargs):

pandas/msgpack/_packer.pyx renamed to pandas/io/msgpack/_packer.pyx

@@ -6,11 +6,11 @@ from libc.stdlib cimport *
 from libc.string cimport *
 from libc.limits cimport *
 
-from pandas.msgpack.exceptions import PackValueError
-from pandas.msgpack import ExtType
+from pandas.io.msgpack.exceptions import PackValueError
+from pandas.io.msgpack import ExtType
 
 
-cdef extern from "../src/msgpack/pack.h":
+cdef extern from "../../src/msgpack/pack.h":
     struct msgpack_packer:
         char* buf
         size_t length

pandas/msgpack/_unpacker.pyx renamed to pandas/io/msgpack/_unpacker.pyx

@@ -11,12 +11,12 @@ from libc.stdlib cimport *
 from libc.string cimport *
 from libc.limits cimport *
 
-from pandas.msgpack.exceptions import (BufferFull, OutOfData,
-                                       UnpackValueError, ExtraData)
-from pandas.msgpack import ExtType
+from pandas.io.msgpack.exceptions import (BufferFull, OutOfData,
+                                          UnpackValueError, ExtraData)
+from pandas.io.msgpack import ExtType
 
 
-cdef extern from "../src/msgpack/unpack.h":
+cdef extern from "../../src/msgpack/unpack.h":
     ctypedef struct msgpack_user:
         bint use_list
         PyObject* object_hook

pandas/msgpack/_version.py renamed to pandas/io/msgpack/_version.py

@@ -64,7 +64,7 @@
 from pandas.core.internals import BlockManager, make_block, _safe_reshape
 import pandas.core.internals as internals
 
-from pandas.msgpack import Unpacker as _Unpacker, Packer as _Packer, ExtType
+from pandas.io.msgpack import Unpacker as _Unpacker, Packer as _Packer, ExtType
 from pandas.util._move import (
     BadMove as _BadMove,
     move_into_mutable_buffer as _move_into_mutable_buffer,

pandas/msgpack/exceptions.py renamed to pandas/io/msgpack/exceptions.py

@@ -37,7 +37,7 @@
 from pandas.util.decorators import Appender
 
 import pandas.lib as lib
-import pandas.parser as _parser
+import pandas.io.libparsers as libparsers
 
 
 # BOM character (byte order mark)
@@ -1415,7 +1415,7 @@ def _convert_to_ndarrays(self, dct, na_values, na_fvalues, verbose=False,
 
             if issubclass(cvals.dtype.type, np.integer) and self.compact_ints:
                 cvals = lib.downcast_int64(
-                    cvals, _parser.na_values,
+                    cvals, libparsers.na_values,
                     self.use_unsigned)
 
             result[c] = cvals
@@ -1533,7 +1533,7 @@ def __init__(self, src, **kwds):
         # #2442
         kwds['allow_leading_cols'] = self.index_col is not False
 
-        self._reader = _parser.TextReader(src, **kwds)
+        self._reader = libparsers.TextReader(src, **kwds)
 
         # XXX
         self.usecols, self.usecols_dtype = _validate_usecols_arg(

pandas/io/packers.py

@@ -13,11 +13,12 @@ from cpython cimport (PyObject, PyBytes_FromString,
                       PyUnicode_Check, PyUnicode_AsUTF8String,
                       PyErr_Occurred, PyErr_Fetch)
 from cpython.ref cimport PyObject, Py_XDECREF
-from io.common import ParserError, DtypeWarning, EmptyDataError, ParserWarning
+from pandas.io.common import (ParserError, DtypeWarning,
+                              EmptyDataError, ParserWarning)
 
 # Import CParserError as alias of ParserError for backwards compatibility.
 # Ultimately, we want to remove this import. See gh-12665 and gh-14479.
-from io.common import CParserError
+from pandas.io.common import CParserError
 
 cdef extern from "Python.h":
     object PyUnicode_FromString(char *v)

pandas/io/parsers.py

@@ -0,0 +1 @@
+from .sasreader import read_sas  # noqa

pandas/parser.pyx renamed to pandas/io/parsers.pyx

@@ -20,7 +20,7 @@
 import numpy as np
 import struct
 import pandas.io.sas.sas_constants as const
-from pandas.io.sas.saslib import Parser
+from pandas.io.sas.libsas import Parser
 
 
 class _subheader_pointer(object):

pandas/io/sas/__init__.py

@@ -0,0 +1,7 @@
+# flake8: noqa
+
+import warnings
+warnings.warn("The pandas.json module is deprecated and will be "
+              "removed in a future version. Please import from "
+              "the pandas.io.json instead", FutureWarning, stacklevel=2)
+from pandas.io.json.libjson import dumps, loads

pandas/io/sas/saslib.pyx renamed to pandas/io/sas/sas.pyx

@@ -0,0 +1,8 @@
+# flake8: noqa
+
+import warnings
+warnings.warn("The pandas.parser module is deprecated and will be "
+              "removed in a future version. Please import from "
+              "the pandas.io.parser instead", FutureWarning, stacklevel=2)
+from pandas.io.libparsers import na_values
+from pandas.io.common import CParserError

pandas/io/sas/sas7bdat.py

@@ -80,7 +80,7 @@ static PyMethodDef ujsonMethods[] = {
 
 static struct PyModuleDef moduledef = {
     PyModuleDef_HEAD_INIT,
-    "_pandasujson",
+    "_libjson",
     0,            /* m_doc */
     -1,           /* m_size */
     ujsonMethods, /* m_methods */
@@ -90,14 +90,14 @@ static struct PyModuleDef moduledef = {
     NULL          /* m_free */
 };
 
-#define PYMODINITFUNC PyMODINIT_FUNC PyInit_json(void)
+#define PYMODINITFUNC PyMODINIT_FUNC PyInit_libjson(void)
 #define PYMODULE_CREATE() PyModule_Create(&moduledef)
 #define MODINITERROR return NULL
 
 #else
 
-#define PYMODINITFUNC PyMODINIT_FUNC initjson(void)
-#define PYMODULE_CREATE() Py_InitModule("json", ujsonMethods)
+#define PYMODINITFUNC PyMODINIT_FUNC initlibjson(void)
+#define PYMODULE_CREATE() Py_InitModule("libjson", ujsonMethods)
 #define MODINITERROR return
 
 #endif

pandas/json.py

@@ -33,16 +33,16 @@ class TestPDApi(Base, tm.TestCase):
     # top-level sub-packages
     lib = ['api', 'compat', 'computation', 'core',
            'indexes', 'formats', 'pandas',
-           'test', 'tools', 'tseries',
+           'test', 'tools', 'tseries', 'sparse',
            'types', 'util', 'options', 'io']
 
     # top-level packages that are c-imports, should rename to _*
     # to avoid naming conflicts
-    lib_to_rename = ['algos', 'hashtable', 'tslib', 'msgpack', 'sparse',
-                     'json', 'lib', 'index', 'parser']
+    lib_to_rename = ['algos', 'hashtable', 'tslib',
+                     'lib', 'index']
 
     # these are already deprecated; awaiting removal
-    deprecated_modules = ['stats', 'datetools']
+    deprecated_modules = ['stats', 'datetools', 'parser', 'json']
 
     # misc
     misc = ['IndexSlice', 'NaT']
@@ -225,3 +225,19 @@ def test_deprecation_access_obj(self):
         with tm.assert_produces_warning(FutureWarning,
                                         check_stacklevel=False):
             pd.datetools.monthEnd
+
+
+class TestJson(tm.TestCase):
+
+    def test_deprecation_access_func(self):
+        with tm.assert_produces_warning(FutureWarning,
+                                        check_stacklevel=False):
+            pd.json.dumps([])
+
+
+class TestParser(tm.TestCase):
+
+    def test_deprecation_access_func(self):
+        with tm.assert_produces_warning(FutureWarning,
+                                        check_stacklevel=False):
+            pd.parser.na_values

pandas/parser.py

@@ -8,7 +8,7 @@
 import numpy as np
 
 from pandas.compat import (lmap, range, lrange, StringIO, u)
-from pandas.parser import ParserError
+from pandas.io.common import ParserError
 from pandas import (DataFrame, Index, Series, MultiIndex, Timestamp,
                     date_range, read_csv, compat, to_datetime)
 import pandas as pd