Preparation for last release (#446)

* Preparation for last release

 - Added New Deprecation warning
 - Removed old deprecation warnings and test.
 - Bumped version to 0.0.1rc
 - Added a max_version for Nilearn to 0.6.3, preventing installation with Nilearn 0.7.0 .
 - Updated news section & whats_new.

* Removed now obviated tests, added test for library deprecation

* Testing installation fails when Nilearn >= 0.7.x

* Fixed: Install Nistats wheel, not Nilearn wheel

* Normalized version number; removed non-implemented key

* Added warnings for Nistats retirements & the unit tests

* Added partial test for checking import times warnings & their count

* Fixed error in partial test for checking import times warnings & their count

* Fixed errors in tests

* Always build Universal wheels

* Test for expected number of correct warning

* Trying to raise error on Grep mismatch

* Trying to raise error on warn count mismatch

Author: kchawla-pi

azure-pipelines.yml

@@ -39,3 +39,42 @@ jobs:
       testResultsFiles: '**/test-results.xml'
       testRunTitle: 'Python $(python.version)'
     condition: succeededOrFailed()
+
+
+- job: 'test_retirement_warning_with_nilearn_07x'
+  pool:
+    vmImage: 'ubuntu-18.04'
+  strategy:
+    matrix:
+      Python36:
+        python.version: '3.6'
+    maxParallel: 4
+
+  steps:
+  - task: UsePythonVersion@0
+    inputs:
+      versionSpec: '$(python.version)'
+      architecture: 'x64'
+
+  - script: |
+      set -e
+      python -m pip install --upgrade pip
+      pip install --prefer-binary setuptools wheel
+      pip install git+https://github.com/nilearn/nilearn.git@master\#egg\=nilearn
+    displayName: 'Install Nilearn master (>=0.7.x) & dependencies for building Nistats'
+
+  - script: |
+      set -e
+      python setup.py sdist bdist_wheel --universal
+    displayName: 'Build Nistats'
+
+  - script: |
+      set -e
+      pip install dist/nistats-0.0.1rc0-*-none-any.whl
+      warn_count=$(python -c "import nistats; from nistats.first_level_model import FirstLevelModel" |& grep -c "Using Nistats with Nilearn versions >= 0.7.0")
+      echo $warn_count
+      if [ $warn_count -ne 1 ]
+        then
+          exit 1
+      fi
+    displayName: 'Install Nistats & check for correct warnings, raised only once'

doc/themes/nistats/layout.html

@@ -191,6 +191,7 @@ <h2>Functional MRI Neuro-Imaging in Python</h2>
 
 <h4> News </h4>
   <ul>
+      <li><p> <strong>April 2020</strong>: Nistats 0.0.1rc released</p></li>
       <li><p> <strong>February 2020</strong>: Nistats 0.0.1b2 released</p></li>
       <li><p> <strong>October 2019</strong>: Nistats 0.0.1b1 released</p></li>
       <li><p> <strong>October 2018</strong>: Nistats 0.0.1b0 released</p></li>

doc/whats_new.rst

@@ -1,3 +1,15 @@
+0.1.0rc
+=======
+
+.. warning::
+
+	This is the LAST release of Nistats.
+
+	| All Nistats functionality has been incorporated into Nilearn.
+	| It will be available as part of Nilearn 0.7.0.
+	| All future development will be done in Nilearn.
+
+
 0.1.0b2
 =======
 

nistats/__init__.py

@@ -26,42 +26,49 @@
 utils                   --- Miscellaneous utilities
 """
 
-import sys
 import warnings
+from distutils.version import LooseVersion
+
+import nilearn
 
 from .version import _check_module_dependencies, __version__
 
 
-def _py2_deprecation_warning():
-    py2_warning = ('Python2 support is deprecated and will be removed in '
-                   'a future release. Consider switching to Python3.')
-    warnings.filterwarnings('once', message=py2_warning)
-    warnings.warn(message=py2_warning,
-                  category=DeprecationWarning,
-                  stacklevel=3,
-                  )
+def _nistats_deprecation_warning():
+    warning_msg = (
+        '\n\n'
+        ' | Starting with Nilearn 0.7.0, all Nistats functionality '
+        "has been incorporated into Nilearn's stats & reporting modules.\n"
+        ' | Nistats package will no longer be updated or maintained.\n')
+    warnings.filterwarnings('once', message=warning_msg)
+    warnings.warn(message=warning_msg,
+                  category=FutureWarning,
+                  stacklevel=4)
 
 
-def _py34_deprecation_warning():
-    py34_warning = ('Python 3.4 support is deprecated and will be removed in '
-                    'a future release. '
-                    'Consider switching to Python 3.6 or 3.7.'
-                    )
-    warnings.filterwarnings('once', message=py34_warning)
-    warnings.warn(message=py34_warning,
-                  category=DeprecationWarning,
-                  stacklevel=3,
-                  )
+def _nistats_redundant_warning():
+    warning_msg = (
+        '\n\n'
+        ' | Using Nistats with Nilearn versions >= 0.7.0 '
+        'is redundant and potentially conflicting.\n'
+        ' | Nilearn versions 0.7.0 and up offer all the functionality of Nistats '
+        'as well the latest features and fixes.\n'
+        ' | We strongly recommend uninstalling Nistats and using '
+        "Nilearn's stats & reporting modules.\n")
+    warnings.filterwarnings('once', message=warning_msg)
+    warnings.warn(message=warning_msg,
+                  stacklevel=4)
 
 
-def _python_deprecation_warnings():
-    if sys.version_info.major == 2:
-        _py2_deprecation_warning()
-    elif sys.version_info.major == 3 and sys.version_info.minor == 4:
-        _py34_deprecation_warning()
+def _nistats_retirement_warning():
+    nilearn_version = LooseVersion(nilearn.__version__)
+    if nilearn_version.version[1] > 6:
+        _nistats_redundant_warning()
+    else:
+        _nistats_deprecation_warning()
 
 
 _check_module_dependencies()
-_python_deprecation_warnings()
+_nistats_retirement_warning()
 
 __all__ = ['__version__', 'datasets', 'design_matrix']

nistats/tests/test_init.py

@@ -1,37 +1,29 @@
 import sys
 import warnings
 
-
 # import time warnings don't interfere with warning's tests
 import pytest
 
 with warnings.catch_warnings(record=True):
-    from nistats import _py34_deprecation_warning
-    from nistats import _py2_deprecation_warning
-    from nistats import _python_deprecation_warnings
-
-
-def test_py2_deprecation_warning():
-    with pytest.warns(DeprecationWarning,
-                      match='Python2 support is deprecated'):
-        _py2_deprecation_warning()
+    from nistats import (_nistats_deprecation_warning,
+                         _nistats_redundant_warning,
+                         )
 
 
-def test_py34_deprecation_warning():
-    with pytest.warns(DeprecationWarning,
-                      match='Python 3.4 support is deprecated'):
-        _py34_deprecation_warning()
+def test_nistats_deprecation_warning():
+    with pytest.warns(
+        FutureWarning,
+        match='\n\n | Starting with Nilearn 0.7.0, all Nistats functionality ',
+        ):
+        _nistats_deprecation_warning()
 
 
-def test_python_deprecation_warnings():
-    if sys.version_info.major == 2:
-        with pytest.warns(DeprecationWarning,
-                          match='Python2 support is deprecated'):
-            _python_deprecation_warnings()
-    elif sys.version_info.major == 3 and sys.version_info.minor == 4:
-        with pytest.warns(DeprecationWarning,
-                          match='Python 3.4 support is deprecated'):
-            _python_deprecation_warnings()
+def test_nistats_redundant_warning():
+    with pytest.warns(
+        UserWarning,
+        match='\n\n | Using Nistats with Nilearn versions >= 0.7.0 ',
+        ):
+        _nistats_redundant_warning()
 
 
 def test_warnings_filter_scope():

nistats/version.py

@@ -21,7 +21,7 @@
 # Dev branch marker is: 'X.Y.dev' or 'X.Y.devN' where N is an integer.
 # 'X.Y.dev0' is the canonical version of 'X.Y.dev'
 #
-__version__ = '0.0.1b2'
+__version__ = '0.0.1rc0'
 
 _NISTATS_INSTALL_MSG = 'See %s for installation information.' % (
     'http://nistats.github.io/introduction.html#installation')

setup.cfg

@@ -10,4 +10,7 @@ addopts =
 	--doctest-modules
 	-s
 	-vv
-	--durations=0
+	--durations=0
+
+[bdist_wheel]
+universal=1