CLN: pandas.sparse -> pandas.core.sparse

Author: jreback

asv_bench/benchmarks/sparse.py

@@ -1,5 +1,5 @@
 from .pandas_vb_common import *
-import pandas.sparse.series
+import pandas.core.sparse.series
 import scipy.sparse
 from pandas.core.sparse import SparseSeries, SparseDataFrame
 from pandas.core.sparse import SparseDataFrame
@@ -37,7 +37,7 @@ def setup(self):
         self.A = scipy.sparse.coo_matrix(([3.0, 1.0, 2.0], ([1, 0, 0], [0, 2, 3])), shape=(100, 100))
 
     def time_sparse_series_from_coo(self):
-        self.ss = pandas.sparse.series.SparseSeries.from_coo(self.A)
+        self.ss = pandas.core.sparse.series.SparseSeries.from_coo(self.A)
 
 
 class sparse_series_to_coo(object):

doc/source/whatsnew/v0.20.0.txt

@@ -21,8 +21,11 @@ Highlights include:
 - Support for S3 handling now uses ``s3fs``, see :ref:`here <whatsnew_0200.api_breaking.s3>`
 - Google BigQuery support now uses the ``pandas-gbq`` library, see :ref:`here <whatsnew_0200.api_breaking.gbq>`
 - Switched the test framework to use `pytest <http://doc.pytest.org/en/latest>`__ (:issue:`13097`)
-- The ``pandas.tools.plotting`` module has been deprecated, moved to ``pandas.plotting``. See :ref:`here <whatsnew_0200.api_breaking.plotting>`
 
+.. warning::
+
+  Pandas has changed the internal structure and layout of the codebase.
+  This can affect imports that are not from the top-level ``pandas.*`` namespace, please see the changes :ref:`here <whatsnew_0200.privacy>`.
 
 Check the :ref:`API Changes <whatsnew_0200.api_breaking>` and :ref:`deprecations <whatsnew_0200.deprecations>` before updating.
 
@@ -558,31 +561,6 @@ Using ``.iloc``. Here we will get the location of the 'A' column, then use *posi
   df.iloc[[0, 2], df.columns.get_loc('A')]
 
 
-.. _whatsnew_0200.api_breaking.deprecate_plotting
-
-Deprecate .plotting
-^^^^^^^^^^^^^^^^^^^
-
-The ``pandas.tools.plotting`` module has been deprecated,  in favor of the top level ``pandas.plotting`` module. All the public plotting functions are now available
-from ``pandas.plotting`` (:issue:`12548`).
-
-Furthermore, the top-level ``pandas.scatter_matrix`` and ``pandas.plot_params`` are deprecated.
-Users can import these from ``pandas.plotting`` as well.
-
-Previous script:
-
-.. code-block:: python
-
-   pd.tools.plotting.scatter_matrix(df)
-   pd.scatter_matrix(df)
-
-Should be changed to:
-
-.. code-block:: python
-
-    pd.plotting.scatter_matrix(df)
-
-
 .. _whatsnew_0200.api_breaking.deprecate_panel:
 
 Deprecate Panel
@@ -1326,48 +1304,74 @@ Other API Changes
 - ``DataFrame`` and ``Panel`` constructors with invalid input will now raise ``ValueError`` rather than ``pandas.core.common.PandasError``, if called with scalar inputs and not axes; The exception ``PandasError`` is removed as well. (:issue:`15541`)
 - The exception ``pandas.core.common.AmbiguousIndexError`` is removed as it is not referenced (:issue:`15541`)
 
-.. _whatsnew_0200.develop:
+.. _whatsnew_0200.privacy:
 
-Development Changes
-~~~~~~~~~~~~~~~~~~~
+Privacy Changes
+~~~~~~~~~~~~~~~
 
-.. _whatsnew_0200.develop.privacy:
+.. _whatsnew_0200.privacy.extensions:
 
 Modules Privacy Has Changed
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Some formerly public python/c/c++/cython extension modules have been moved and/or renamed. These are all removed from the public API.
-Further more, the ``pandas.core``, ``pandas.io``, and ``pandas.util`` top-level modules are now considered to be PRIVATE.
-If indicated, a deprecation warning will be issued if you reference that module. (:issue:`12588`)
+Furthermore, the ``pandas.core``, ``pandas.io``, and ``pandas.util`` top-level modules are now considered to be PRIVATE.
+If indicated, a deprecation warning will be issued if you reference theses modules. (:issue:`12588`)
 
 .. csv-table::
     :header: "Previous Location", "New Location", "Deprecated"
     :widths: 30, 30, 4
 
     "pandas.lib", "pandas._libs.lib", "X"
     "pandas.tslib", "pandas._libs.tslib", "X"
-    "pandas._join", "pandas._libs.join", ""
-    "pandas._period", "pandas._libs.period", ""
     "pandas.computation", "pandas.core.computation", ""
     "pandas.msgpack", "pandas.io.msgpack", ""
     "pandas.index", "pandas._libs.index", ""
     "pandas.algos", "pandas._libs.algos", ""
     "pandas.hashtable", "pandas._libs.hashtable", ""
     "pandas.json", "pandas.io.json.libjson", "X"
     "pandas.parser", "pandas.io.libparsers", "X"
-    "pandas.types", "pandas.core.typed", ""
+    "pandas.sparse", "pandas.core.sparse", ""
+    "pandas.types", "pandas.core.dtypes", ""
     "pandas.io.sas.saslib", "pandas.io.sas.libsas", ""
-    "pandas._testing", "pandas.util.libtesting", ""
-    "pandas._sparse", "pandas.sparse.libsparse", ""
+    "pandas._join", "pandas._libs.join", ""
     "pandas._hash", "pandas.tools.libhash", ""
+    "pandas._period", "pandas._libs.period", ""
+    "pandas._sparse", "pandas.core.sparse.libsparse", ""
+    "pandas._testing", "pandas.util.libtesting", ""
     "pandas._window", "pandas.core.libwindow", ""
 
 - The function :func:`~pandas.api.type.union_categoricals` is now importable from ``pandas.api.types``, formerly from ``pandas.types.concat`` (:issue:`15998`)
 
-.. _whatsnew_0200.develop.other:
+.. _whatsnew_0200.privacy.deprecate_plotting
 
-Other Changes
-^^^^^^^^^^^^^
+Deprecate .plotting
+^^^^^^^^^^^^^^^^^^^
+
+The ``pandas.tools.plotting`` module has been deprecated,  in favor of the top level ``pandas.plotting`` module. All the public plotting functions are now available
+from ``pandas.plotting`` (:issue:`12548`).
+
+Furthermore, the top-level ``pandas.scatter_matrix`` and ``pandas.plot_params`` are deprecated.
+Users can import these from ``pandas.plotting`` as well.
+
+Previous script:
+
+.. code-block:: python
+
+   pd.tools.plotting.scatter_matrix(df)
+   pd.scatter_matrix(df)
+
+Should be changed to:
+
+.. code-block:: python
+
+    pd.plotting.scatter_matrix(df)
+
+
+.. _whatsnew_0200.privacy.development:
+
+Other Developement Changes
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 - Building pandas for development now requires ``cython >= 0.23`` (:issue:`14831`)
 - Require at least 0.23 version of cython to avoid problems with character encodings (:issue:`14699`)

pandas/__init__.py

@@ -40,7 +40,7 @@
 import pandas.core.config_init
 
 from pandas.core.api import *
-from pandas.sparse.api import *
+from pandas.core.sparse.api import *
 from pandas.stats.api import *
 from pandas.tseries.api import *
 from pandas.core.computation.api import *

pandas/compat/pickle_compat.py

@@ -67,16 +67,24 @@ def load_reduce(self):
     ('pandas.core.series', 'TimeSeries'):
         ('pandas.core.series', 'Series'),
     ('pandas.sparse.series', 'SparseTimeSeries'):
-        ('pandas.sparse.series', 'SparseSeries'),
+        ('pandas.core.sparse.series', 'SparseSeries'),
 
     # 12588, extensions moving
     ('pandas._sparse', 'BlockIndex'):
-        ('pandas.sparse.libsparse', 'BlockIndex'),
+        ('pandas.core.sparse.libsparse', 'BlockIndex'),
     ('pandas.tslib', 'Timestamp'):
         ('pandas._libs.tslib', 'Timestamp'),
     ('pandas.tslib', '__nat_unpickle'):
         ('pandas._libs.tslib', '__nat_unpickle'),
-    ('pandas._period', 'Period'): ('pandas._libs.period', 'Period')
+    ('pandas._period', 'Period'): ('pandas._libs.period', 'Period'),
+
+    # 15998 top-level dirs moving
+    ('pandas.sparse.array', 'SparseArray'):
+        ('pandas.core.sparse.array', 'SparseArray'),
+    ('pandas.sparse.series', 'SparseSeries'):
+        ('pandas.core.sparse.series', 'SparseSeries'),
+    ('pandas.sparse.frame', 'SparseDataFrame'):
+        ('pandas.core.sparse.frame', 'SparseDataFrame')
 }
 
 

pandas/core/dtypes/concat.py

@@ -69,15 +69,15 @@ def _get_series_result_type(result):
     if isinstance(result, dict):
         # concat Series with axis 1
         if all(is_sparse(c) for c in compat.itervalues(result)):
-            from pandas.sparse.api import SparseDataFrame
+            from pandas.core.sparse.api import SparseDataFrame
             return SparseDataFrame
         else:
             from pandas.core.frame import DataFrame
             return DataFrame
 
     elif is_sparse(result):
         # concat Series with axis 1
-        from pandas.sparse.api import SparseSeries
+        from pandas.core.sparse.api import SparseSeries
         return SparseSeries
     else:
         from pandas.core.series import Series
@@ -91,7 +91,7 @@ def _get_frame_result_type(result, objs):
     otherwise, return 1st obj
     """
     if any(b.is_sparse for b in result.blocks):
-        from pandas.sparse.api import SparseDataFrame
+        from pandas.core.sparse.api import SparseDataFrame
         return SparseDataFrame
     else:
         return objs[0]
@@ -438,7 +438,7 @@ def _concat_sparse(to_concat, axis=0, typs=None):
     a single array, preserving the combined dtypes
     """
 
-    from pandas.sparse.array import SparseArray, _make_index
+    from pandas.core.sparse.array import SparseArray, _make_index
 
     def convert_sparse(x, axis):
         # coerce to native type

pandas/core/frame.py

@@ -1271,7 +1271,7 @@ def to_sparse(self, fill_value=None, kind='block'):
         -------
         y : SparseDataFrame
         """
-        from pandas.core.sparse import SparseDataFrame
+        from pandas.core.sparse.frame import SparseDataFrame
         return SparseDataFrame(self._series, index=self.index,
                                columns=self.columns, default_kind=kind,
                                default_fill_value=fill_value)

pandas/core/internals.py

@@ -58,7 +58,7 @@
 from pandas.formats.printing import pprint_thing
 
 import pandas.core.missing as missing
-from pandas.sparse.array import _maybe_to_sparse, SparseArray
+from pandas.core.sparse.array import _maybe_to_sparse, SparseArray
 from pandas._libs import lib, tslib
 from pandas._libs.tslib import Timedelta
 from pandas._libs.lib import BlockPlacement

pandas/core/reshape.py

@@ -18,9 +18,9 @@
 from pandas.core.series import Series
 from pandas.core.frame import DataFrame
 
-from pandas.core.sparse import SparseDataFrame, SparseSeries
-from pandas.sparse.array import SparseArray
-from pandas.sparse.libsparse import IntIndex
+from pandas.core.sparse.api import SparseDataFrame, SparseSeries
+from pandas.core.sparse.array import SparseArray
+from pandas.core.sparse.libsparse import IntIndex
 
 from pandas.core.categorical import Categorical, _factorize_from_iterable
 from pandas.core.sorting import (get_group_index, get_compressed_ids,

pandas/core/series.py

@@ -257,7 +257,7 @@ def from_array(cls, arr, index=None, name=None, dtype=None, copy=False,
                    fastpath=False):
         # return a sparse series here
         if isinstance(arr, ABCSparseArray):
-            from pandas.sparse.series import SparseSeries
+            from pandas.core.sparse.series import SparseSeries
             cls = SparseSeries
 
         return cls(arr, index=index, name=name, dtype=dtype, copy=copy,
@@ -1132,7 +1132,7 @@ def to_sparse(self, kind='block', fill_value=None):
         -------
         sp : SparseSeries
         """
-        from pandas.core.sparse import SparseSeries
+        from pandas.core.sparse.series import SparseSeries
         return SparseSeries(self, kind=kind,
                             fill_value=fill_value).__finalize__(self)
 

pandas/core/sparse.py

@@ -0,0 +1,6 @@
+# pylint: disable=W0611
+# flake8: noqa
+from pandas.core.sparse.array import SparseArray
+from pandas.core.sparse.list import SparseList
+from pandas.core.sparse.series import SparseSeries
+from pandas.core.sparse.frame import SparseDataFrame

pandas/sparse/__init__.py renamed to pandas/core/sparse/__init__.py

@@ -29,8 +29,8 @@
     astype_nansafe, find_common_type)
 from pandas.core.dtypes.missing import isnull, notnull, na_value_for_dtype
 
-from pandas.sparse import libsparse as splib
-from pandas.sparse.libsparse import SparseIndex, BlockIndex, IntIndex
+from pandas.core.sparse import libsparse as splib
+from pandas.core.sparse.libsparse import SparseIndex, BlockIndex, IntIndex
 from pandas._libs import index as libindex
 import pandas.core.algorithms as algos
 import pandas.core.ops as ops

pandas/core/sparse/api.py

@@ -24,8 +24,8 @@
 from pandas.core.internals import (BlockManager,
                                    create_block_manager_from_arrays)
 import pandas.core.generic as generic
-from pandas.sparse.series import SparseSeries, SparseArray
-from pandas.sparse.libsparse import BlockIndex, get_blocks
+from pandas.core.sparse.series import SparseSeries, SparseArray
+from pandas.core.sparse.libsparse import BlockIndex, get_blocks
 from pandas.util.decorators import Appender
 import pandas.core.ops as ops
 

pandas/sparse/array.py renamed to pandas/core/sparse/array.py

@@ -4,9 +4,9 @@
 from pandas.formats.printing import pprint_thing
 
 from pandas.core.dtypes.common import is_scalar
-from pandas.sparse.array import SparseArray
+from pandas.core.sparse.array import SparseArray
 from pandas.util.validators import validate_bool_kwarg
-import pandas.sparse.libsparse as splib
+from pandas.core.sparse import libsparse as splib
 
 
 class SparseList(PandasObject):

pandas/sparse/frame.py renamed to pandas/core/sparse/frame.py

@@ -23,13 +23,15 @@
 import pandas._libs.index as _index
 from pandas.util.decorators import Appender
 
-from pandas.sparse.array import (make_sparse, _sparse_array_op, SparseArray,
-                                 _make_index)
-from pandas.sparse.libsparse import BlockIndex, IntIndex
-import pandas.sparse.libsparse as splib
+from pandas.core.sparse.array import (
+    make_sparse, _sparse_array_op, SparseArray,
+    _make_index)
+from pandas.core.sparse.libsparse import BlockIndex, IntIndex
+import pandas.core.sparse.libsparse as splib
 
-from pandas.sparse.scipy_sparse import (_sparse_series_to_coo,
-                                        _coo_to_sparse_series)
+from pandas.core.sparse.scipy_sparse import (
+    _sparse_series_to_coo,
+    _coo_to_sparse_series)
 
 
 _shared_doc_kwargs = dict(axes='index', klass='SparseSeries',
@@ -264,7 +266,7 @@ def _constructor(self):
 
     @property
     def _constructor_expanddim(self):
-        from pandas.sparse.api import SparseDataFrame
+        from pandas.core.sparse.api import SparseDataFrame
         return SparseDataFrame
 
     @property

pandas/sparse/list.py renamed to pandas/core/sparse/list.py

@@ -57,8 +57,8 @@
                     Panel, RangeIndex, PeriodIndex, DatetimeIndex, NaT,
                     Categorical, CategoricalIndex)
 from pandas._libs.tslib import NaTType
-from pandas.sparse.api import SparseSeries, SparseDataFrame
-from pandas.sparse.array import BlockIndex, IntIndex
+from pandas.core.sparse.api import SparseSeries, SparseDataFrame
+from pandas.core.sparse.array import BlockIndex, IntIndex
 from pandas.core.generic import NDFrame
 from pandas.errors import PerformanceWarning
 from pandas.io.common import get_filepath_or_buffer

pandas/sparse/scipy_sparse.py renamed to pandas/core/sparse/scipy_sparse.py

@@ -30,7 +30,7 @@
                     DatetimeIndex, TimedeltaIndex)
 from pandas.core import config
 from pandas.io.common import _stringify_path
-from pandas.sparse.array import BlockIndex, IntIndex
+from pandas.core.sparse.array import BlockIndex, IntIndex
 from pandas.core.base import StringMixin
 from pandas.formats.printing import adjoin, pprint_thing
 from pandas.errors import PerformanceWarning

pandas/sparse/series.py renamed to pandas/core/sparse/series.py

@@ -11,12 +11,12 @@
 from matplotlib.transforms import nonsingular
 
 
-from pandas.types.common import (is_float, is_integer,
-                                 is_integer_dtype,
-                                 is_float_dtype,
-                                 is_datetime64_ns_dtype,
-                                 is_period_arraylike,
-                                 )
+from pandas.core.dtypes.common import (
+    is_float, is_integer,
+    is_integer_dtype,
+    is_float_dtype,
+    is_datetime64_ns_dtype,
+    is_period_arraylike)
 
 from pandas.compat import lrange
 import pandas.compat as compat