Merge pull request #50 from qutech/refactor/fancy_progressbar_notebook_detection

Refactor/fancy progressbar notebook detection

Author: thangleiter

.travis.yml

@@ -13,29 +13,32 @@ env:
     - INSTALL_DEPS="numpy scipy opt_einsum sparse tqdm"
     - INSTALL_TEST_DEPS="pytest>=4.6 pytest-cov codecov"
     - plotting="matplotlib"
-    - fancy_progressbar="jupyter requests"
+    - fancy_progressbar="ipynbname jupyter"
     - bloch_sphere_visualization="matplotlib qutip"
   jobs:
     - INSTALL_EXTRAS=[plotting,bloch_sphere_visualization,fancy_progressbar]
     - INSTALL_EXTRAS=[plotting,fancy_progressbar]
     - INSTALL_EXTRAS=[none]
-       
+
 before_install:
   # Resolve INSTALL_EXTRAS into required packages for use with conda. HACKY
+  # Split by comma and replace by parameter designator ($)
   - TMP=${INSTALL_EXTRAS//,/ $}
+  # Take care of opening bracket separately
   - TMP=${TMP/[/$}
-  - INSTALL_EXTRAS_PACKAGES=$(eval echo ${TMP%]})
-  
+  # Replace the abstract extra names by the packages they require
+  - TMP=$(eval echo ${TMP%]})
+  # Remove ipynbname from conda packages (pip only)
+  - INSTALL_EXTRAS_CONDA=${TMP// ipynbname/}
+
   # Useful info for debugging
   - echo $TRAVIS_PYTHON_VERSION
   - echo $INSTALL_DEPS
   - echo $INSTALL_TEST_DEPS
   - echo $INSTALL_EXTRAS
-  - echo $INSTALL_EXTRAS_PACKAGES
+  - echo $INSTALL_EXTRAS_CONDA
 
   # https://github.com/conda/conda/blob/master/docs/source/user-guide/tasks/use-conda-with-travis-ci.rst
-  # We do this conditionally because it saves us some downloading if the
-  # version is the same.
   - wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh;
   - bash miniconda.sh -b -u -p $HOME/miniconda
   - export PATH="$HOME/miniconda/bin:$PATH"
@@ -46,11 +49,12 @@ before_install:
   # Useful for debugging any issues with conda
   - conda info -a
 
-  - conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION $INSTALL_DEPS $INSTALL_TEST_DEPS $INSTALL_EXTRAS_PACKAGES
+  - conda create -q -n test-environment python=$TRAVIS_PYTHON_VERSION $INSTALL_DEPS $INSTALL_TEST_DEPS $INSTALL_EXTRAS_CONDA
   - source activate test-environment
-  
+
 install:
-  - pip install .
+  # Everything from INSTALL_EXTRAS should already be installed via conda, except for ipynbname
+  - pip install .$INSTALL_EXTRAS
 
 script:
   - pytest

filter_functions/util.py

@@ -69,10 +69,7 @@
 """
 import functools
 import inspect
-import json
 import operator
-import os
-import re
 import string
 from itertools import zip_longest
 from typing import Callable, Dict, Iterable, List, Optional, Sequence, Tuple, Union
@@ -84,79 +81,9 @@
 from .types import Operator, State
 
 try:
-    import jupyter_client
-    import requests
-    from notebook.notebookapp import list_running_servers
-    from requests.compat import urljoin
-
-    def _get_notebook_name() -> str:
-        """
-        Return the full path of the jupyter notebook.
-
-        See https://github.com/jupyter/notebook/issues/1000
-
-        Jupyter notebook is licensed as follows:
-
-        This project is licensed under the terms of the Modified BSD License
-        (also known as New or Revised or 3-Clause BSD), as follows:
-
-        - Copyright (c) 2001-2015, IPython Development Team
-        - Copyright (c) 2015-, Jupyter Development Team
-
-        All rights reserved.
-
-        Redistribution and use in source and binary forms, with or without
-        modification, are permitted provided that the following conditions are
-        met:
-
-        Redistributions of source code must retain the above copyright notice,
-        this list of conditions and the following disclaimer.
-
-        Redistributions in binary form must reproduce the above copyright
-        notice, this list of conditions and the following disclaimer in the
-        documentation and/or other materials provided with the distribution.
-
-        Neither the name of the Jupyter Development Team nor the names of its
-        contributors may be used to endorse or promote products derived from
-        this software without specific prior written permission.
-
-        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
-        IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
-        TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
-        PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-        OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-        SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-        LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-        DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-        THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-        """
-        try:
-            connection_file = jupyter_client.find_connection_file()
-        except OSError:
-            return ''
-
-        kernel_id = re.search('kernel-(.*).json', connection_file).group(1)
-        servers = list_running_servers()
-        for ss in servers:
-            response = requests.get(urljoin(ss['url'], 'api/sessions'),
-                                    params={'token': ss.get('token', '')})
-            for nn in json.loads(response.text):
-                try:
-                    if nn['kernel']['id'] == kernel_id:
-                        try:
-                            relative_path = nn['notebook']['path']
-                            return os.path.join(ss['notebook_dir'], relative_path)
-                        except KeyError:
-                            return ''
-                except TypeError:
-                    return ''
-
-        return ''
-
-    _NOTEBOOK_NAME = _get_notebook_name()
-except ImportError:
+    import ipynbname
+    _NOTEBOOK_NAME = ipynbname.name()
+except (ImportError, IndexError, FileNotFoundError):
     _NOTEBOOK_NAME = ''
 
 if _NOTEBOOK_NAME:

setup.py

@@ -24,7 +24,7 @@ def extract_version(version_file):
 
 extras_require = {'plotting': ['matplotlib'],
                   'bloch_sphere_visualization': ['qutip', 'matplotlib'],
-                  'fancy_progressbar': ['requests'],
+                  'fancy_progressbar': ['ipynbname', 'jupyter'],
                   'doc': ['jupyter', 'nbsphinx', 'numpydoc', 'sphinx', 'sphinx_rtd_theme'],
                   'tests': ['pytest>=4.6', 'pytest-cov', 'codecov']}