Merge pull request #809 from bashtage/add-test

MAINT: Add tester

Author: bashtage

.travis.yml

@@ -4,6 +4,7 @@ language: python
 env:
   global:
     - TEST_TYPE="stable and not requires_api_key"
+    - TEST_INSTALL=false
     # Doctr deploy key for pydata/pandas-datareader
     - secure: "iGbOAbBSV5y0TKDh2CifRSk6OpLA9GbEEL/hscHFLSDDUCWcdfvYXda3SWJFWyoQ5QUxSigXWd+ukr4u92d7lmB7m3TWj6BAMNuRpatTgnejLNwLvNeYdvLAxPvx39Cq85frd1Rx1beBLn3h/4wm4Ah+dR5W9NH8+x3OuZMH3Eo="
 
@@ -19,7 +20,7 @@ matrix:
   - python: 3.8
     env: PANDAS=1 NUMPY=1.18
   - python: 3.8
-    env: PANDAS=1 NUMPY=1.19
+    env: PANDAS=1 NUMPY=1.19 TEST_INSTALL=true
   - python: 3.7
     env: TEST_TYPE="quandl" PANDAS=1 NUMPY=1.19
     # In allow failures
@@ -44,7 +45,15 @@ install:
 
 script:
   - if [[ -n "${TEST_TYPE+x}" ]]; then export MARKERS="-m ${TEST_TYPE}"; fi
-  - pytest -v -s -r xX "${MARKERS}" --cov-config .coveragerc --cov=pandas_datareader --cov-report xml:/tmp/cov-datareader.xml --junitxml=/tmp/datareader.xml
+  - |
+    if [[ ${TEST_INSTALL} = false ]]; then
+        pytest -v -s -r xX "${MARKERS}" --cov-config .coveragerc --cov=pandas_datareader --cov-report xml:/tmp/cov-datareader.xml --junitxml=/tmp/datareader.xml
+    else
+        mkdir pdr_test
+        cd pdr_test
+        python -c "import pandas_datareader; pandas_datareader.test()"
+        cd ..
+    fi
   - black --version
   - black --check pandas_datareader
   - flake8 --version

docs/source/whatsnew/v0.9.0.txt

@@ -1,7 +1,41 @@
+.. _whatsnew_091:
+
+v0.9.1 (TBD)
+------------
+
+.. contents:: What's new in v0.9.1
+    :local:
+    :backlinks: none
+
+
+.. _whatsnew_091.enhancements:
+
+Enhancements
+~~~~~~~~~~~~
+- Added the method ``test`` to the package to simplify running tests from an
+  installation using
+
+.. code-block:: shell
+
+   python -c "import pandas_datareader; pandas_datareader.test()"
+
+.. _whatsnew_091.api_breaking:
+
+Backwards incompatible API changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Immediately deprecated old symbol names for TSP to reflect the new website API
+
+.. _whatsnew_091.bug_fixes:
+
+Bug Fixes
+~~~~~~~~~
+- Update TSP web scraper to new site (:issue:`740`)
+
 .. _whatsnew_090:
 
 v0.9.0 (July 10, 2020)
----------------------------
+----------------------
 
 Highlights include:
 
@@ -43,7 +77,6 @@ Bug Fixes
 - Correct NASDAQ symbols fields link (:issue:`715`)
 - Fix Yahoo! actions bug due to change in split format (:issue:`755`)
 - Fix FutureWarning from pandas import (:issue:`762`)
-- Update TSP web scraper to new site (:issue:`740`)
 
 Contributors
 ~~~~~~~~~~~~

pandas_datareader/__init__.py

@@ -1,3 +1,6 @@
+import os
+import sys
+
 from ._version import get_versions
 from .data import (
     DataReader,
@@ -27,6 +30,8 @@
     get_tops_iex,
 )
 
+PKG = os.path.dirname(__file__)
+
 __version__ = get_versions()["version"]
 del get_versions
 
@@ -57,4 +62,30 @@
     "get_data_tiingo",
     "get_iex_data_tiingo",
     "get_data_alphavantage",
+    "test",
 ]
+
+
+def test(extra_args=None):
+    """
+    Run the test suite
+
+    Parameters
+    ----------
+    extra_args : {str, List[str]}
+        A string or list of strings to pass to pytest. Default is
+        ["--only-stable", "--skip-requires-api-key"]
+    """
+    try:
+        import pytest
+    except ImportError as err:
+        raise ImportError("Need pytest>=5.0.1 to run tests") from err
+    cmd = ["--only-stable", "--skip-requires-api-key"]
+    if extra_args:
+        if not isinstance(extra_args, list):
+            extra_args = [extra_args]
+        cmd = extra_args
+    cmd += [PKG]
+    joined = " ".join(cmd)
+    print(f"running: pytest {joined}")
+    sys.exit(pytest.main(cmd))

pandas_datareader/av/quotes.py

@@ -2,10 +2,7 @@
 import pandas as pd
 
 from pandas_datareader.av import AlphaVantage
-from pandas_datareader.exceptions import (
-    DEP_ERROR_MSG,
-    ImmediateDeprecationError,
-)
+from pandas_datareader.exceptions import DEP_ERROR_MSG, ImmediateDeprecationError
 
 
 class AVQuotesReader(AlphaVantage):

pandas_datareader/compat/__init__.py

@@ -5,7 +5,7 @@
 
 import pandas as pd
 from pandas.api.types import is_list_like, is_number
-import pandas.io.common as com
+from pandas.io import common as com
 from pandas.testing import assert_frame_equal
 
 PANDAS_VERSION = LooseVersion(pd.__version__)

pandas_datareader/conftest.py

@@ -3,6 +3,30 @@
 import pytest
 
 
+def pytest_addoption(parser):
+    parser.addoption("--only-stable", action="store_true", help="run only stable tests")
+    parser.addoption(
+        "--skip-requires-api-key",
+        action="store_true",
+        help="skip tests that require an API key",
+    )
+    parser.addoption(
+        "--strict-data-files",
+        action="store_true",
+        help="Fail if a test is skipped for missing data file.",
+    )
+
+
+def pytest_runtest_setup(item):
+    if "stable" not in item.keywords and item.config.getoption("--only-stable"):
+        pytest.skip("skipping due to --only-stable")
+
+    if "requires_api_key" in item.keywords and item.config.getoption(
+        "--skip-requires-api-key"
+    ):
+        pytest.skip("skipping due to --skip-requires-api-key")
+
+
 @pytest.fixture
 def datapath(request):
     """Get the path to a data file.

pandas_datareader/data.py

@@ -16,18 +16,12 @@
 from pandas_datareader.econdb import EcondbReader
 from pandas_datareader.enigma import EnigmaReader
 from pandas_datareader.eurostat import EurostatReader
-from pandas_datareader.exceptions import (
-    DEP_ERROR_MSG,
-    ImmediateDeprecationError,
-)
+from pandas_datareader.exceptions import DEP_ERROR_MSG, ImmediateDeprecationError
 from pandas_datareader.famafrench import FamaFrenchReader
 from pandas_datareader.fred import FredReader
 from pandas_datareader.iex.daily import IEXDailyReader
 from pandas_datareader.iex.deep import Deep as IEXDeep
-from pandas_datareader.iex.tops import (
-    LastReader as IEXLasts,
-    TopsReader as IEXTops,
-)
+from pandas_datareader.iex.tops import LastReader as IEXLasts, TopsReader as IEXTops
 from pandas_datareader.moex import MoexReader
 from pandas_datareader.nasdaq_trader import get_nasdaq_symbols
 from pandas_datareader.naver import NaverDailyReader

pandas_datareader/enigma.py

@@ -5,10 +5,7 @@
 
 from pandas_datareader.base import _BaseReader, string_types
 from pandas_datareader.compat import StringIO
-from pandas_datareader.exceptions import (
-    DEP_ERROR_MSG,
-    ImmediateDeprecationError,
-)
+from pandas_datareader.exceptions import DEP_ERROR_MSG, ImmediateDeprecationError
 
 
 class EnigmaReader(_BaseReader):

pandas_datareader/io/sdmx.py

@@ -47,7 +47,7 @@ def read_sdmx(path_or_buf, dtype="float64", dsd=None):
 
     xdata = _read_content(path_or_buf)
 
-    import xml.etree.ElementTree as ET
+    from xml.etree import ElementTree as ET
 
     root = ET.fromstring(xdata)
 
@@ -204,7 +204,7 @@ def _read_sdmx_dsd(path_or_buf):
 
     xdata = _read_content(path_or_buf)
 
-    import xml.etree.cElementTree as ET
+    from xml.etree import cElementTree as ET
 
     root = ET.fromstring(xdata)
 

pandas_datareader/moex.py

@@ -3,12 +3,7 @@
 import pandas as pd
 
 from pandas_datareader.base import _DailyBaseReader
-from pandas_datareader.compat import (
-    StringIO,
-    binary_type,
-    concat,
-    is_list_like,
-)
+from pandas_datareader.compat import StringIO, binary_type, concat, is_list_like
 
 
 class MoexReader(_DailyBaseReader):