Changes after review

plotly · Sep 21, 2021 · bfc95de · bfc95de
1 parent af23c5b
commit bfc95de
Show file tree

Hide file tree

Showing 12 changed files with 45 additions and 44 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -43,8 +43,7 @@ jobs:
             sudo pip install virtualenv --upgrade
             python -m venv venv && . venv/bin/activate
             set -eo pipefail
-            pip install -e .[testing,dev,celery-manager,diskcache-manager] --progress-bar off
-            pip install -r ./requires-ci.txt --progress-bar off
+            pip install -e .[ci,dev,testing,celery,diskcache] --progress-bar off
             pip list | grep dash
             npm i
             npm run build
@@ -78,7 +77,7 @@ jobs:
           command: |
             sudo pip install --upgrade virtualenv --progress-bar off
             python -m venv venv || virtualenv venv && . venv/bin/activate
-            pip install -e .[dev,testing] --no-cache-dir -r requires-ci.txt --progress-bar off
+            pip install -e .[ci,dev,testing] --no-cache-dir --progress-bar off
       - save_cache:
           key: dep-{{ checksum ".circleci/config.yml" }}-{{ checksum "ver.txt" }}-{{ checksum "requires-ci.txt" }}-{{ checksum "requires-dev.txt" }}-{{ checksum "requires-install.txt" }}-{{ checksum "requires-testing.txt" }}
           paths:
@@ -224,8 +223,7 @@ jobs:
           command: |
             . venv/bin/activate
             npm install --production
-            pip install --no-cache-dir --upgrade --ignore-installed dash-package/dash-package.tar.gz --progress-bar off
-            pip install -r requires-install.txt -r requires-ci.txt -r requires-dev.txt -r requires-testing.txt -r requires-celery-manager.txt -r requires-diskcache-manager.txt --progress-bar off
+            pip install --no-cache-dir --upgrade --ignore-installed dash-package/dash-package.tar.gz[ci,dev,testing,celery,diskcache] --progress-bar off
             sed -i '/dash/d' requires-install.txt
             pip list | grep dash
       - run:
@@ -267,18 +265,18 @@ jobs:
             path: ~/dash
       - run: echo $PYTHON_VERSION > ver.txt
       - restore_cache:
-          key: dep-{{ checksum ".circleci/config.yml" }}-{{ checksum "ver.txt" }}-{{ checksum "dev-requirements.txt" }}-{{ checksum "../../requires-ci.txt" }}
+          key: dep-{{ checksum ".circleci/config.yml" }}-{{ checksum "ver.txt" }}-{{ checksum "dev-requirements.txt" }}
       - attach_workspace:
           at: ~/dash/components/dash-core-components
       - run:
           name: 🐍 pip dev requirements
           command: |
             sudo pip install virtualenv --upgrade
             python -m venv venv || virtualenv venv && . venv/bin/activate
-            pip install dash-package/dash-package.tar.gz[dev,testing]
-            pip install --progress-bar off --no-cache-dir -r dev-requirements.txt -r ../../requires-ci.txt
+            pip install dash-package/dash-package.tar.gz[ci,dev,testing]
+            pip install --progress-bar off --no-cache-dir -r dev-requirements.txt
       - save_cache:
-          key: dep-{{ checksum ".circleci/config.yml" }}-{{ checksum "ver.txt" }}-{{ checksum "dev-requirements.txt" }}-{{ checksum "../../requires-ci.txt" }}
+          key: dep-{{ checksum ".circleci/config.yml" }}-{{ checksum "ver.txt" }}-{{ checksum "dev-requirements.txt" }}
           paths:
               - venv
       - run:
@@ -422,8 +420,8 @@ jobs:
               sudo pip install virtualenv --upgrade
               python -m venv venv || virtualenv venv
               . venv/bin/activate
-              pip install dash-package/dash-package.tar.gz[dev,testing]
-              pip install -r dev-requirements.txt -r ../../requires-ci.txt
+              pip install dash-package/dash-package.tar.gz[ci,dev,testing]
+              pip install -r dev-requirements.txt
               npm ci
 
       - run:
@@ -495,8 +493,7 @@ jobs:
                   . venv/bin/activate
                   pip install -r dev-requirements.txt --quiet
                   pip install -r python-requirements.txt --quiet
-                  pip install -r ../../requires-ci.txt                  
-                  pip install dash-package/dash-package.tar.gz[dev,testing]
+                  pip install dash-package/dash-package.tar.gz[ci,dev,testing]
           - run:
               name: Build
               command: |
@@ -600,8 +597,8 @@ jobs:
               name: Install requirements
               command: |
                   . venv/bin/activate
-                  pip install -r dev-requirements.txt -r ../../requires-ci.txt --quiet
-                  pip install dash-package/dash-package.tar.gz[dev,testing]
+                  pip install -r dev-requirements.txt --quiet
+                  pip install dash-package/dash-package.tar.gz[ci,dev,testing]
 
           - run:
               name: Run eslint

diff --git a/dash/long_callback/managers/celery_manager.py b/dash/long_callback/managers/celery_manager.py
@@ -35,7 +35,7 @@ def __init__(self, celery_app, cache_by=None, expire=None):
                 """\
 CeleryLongCallbackManager requires extra dependencies which can be installed doing
 
-    $ pip install "dash[celery-manager]"\n"""
+    $ pip install "dash[celery]"\n"""
             ) from missing_imports
 
         if not isinstance(celery_app, celery.Celery):

diff --git a/dash/long_callback/managers/diskcache_manager.py b/dash/long_callback/managers/diskcache_manager.py
@@ -4,14 +4,15 @@
 
 
 class DiskcacheLongCallbackManager(BaseLongCallbackManager):
-    def __init__(self, cache, cache_by=None, expire=None):
+    def __init__(self, cache=None, cache_by=None, expire=None):
         """
         Long callback manager that runs callback logic in a subprocess and stores
         results on disk using diskcache
 
         :param cache:
             A diskcache.Cache or diskcache.FanoutCache instance. See the diskcache
-            documentation for information on configuration options.
+            documentation for information on configuration options. If not provided,
+            a diskcache.Cache instance will be created with default values.
         :param cache_by:
             A list of zero-argument functions.  When provided, caching is enabled and
             the return values of these functions are combined with the callback
@@ -30,13 +31,20 @@ def __init__(self, cache, cache_by=None, expire=None):
                 """\
 DiskcacheLongCallbackManager requires extra dependencies which can be installed doing
 
-    $ pip install "dash[diskcache-manager]"\n"""
+    $ pip install "dash[diskcache]"\n"""
             ) from missing_imports
 
-        if not isinstance(cache, (diskcache.Cache, diskcache.FanoutCache)):
-            raise ValueError("First argument must be a diskcache.Cache object")
+        if cache is None:
+            self.handle = diskcache.Cache()
+        else:
+            if not isinstance(cache, (diskcache.Cache, diskcache.FanoutCache)):
+                raise ValueError(
+                    "First argument must be a diskcache.Cache "
+                    "or diskcache.FanoutCache object"
+                )
+            self.handle = cache
+
         super().__init__(cache_by)
-        self.handle = cache
         self.expire = expire
 
     def terminate_job(self, job):

diff --git a/dash/testing/plugin.py b/dash/testing/plugin.py
@@ -189,18 +189,8 @@ def dashjl(request, dashjl_server, tmpdir):
 
 @pytest.fixture
 def diskcache_manager():
-    try:
-        from dash.long_callback import (  # pylint: disable=import-outside-toplevel
-            DiskcacheLongCallbackManager,
-        )
-        import diskcache  # pylint: disable=import-outside-toplevel
-    except ImportError as missing_imports:
-        raise ImportError(
-            """\
-DiskcacheLongCallbackManager requires extra dependencies which can be installed doing
-
-$ pip install "dash[diskcache-manager]"\n"""
-        ) from missing_imports
-
-    cache = diskcache.Cache()
-    return DiskcacheLongCallbackManager(cache)
+    from dash.long_callback import (  # pylint: disable=import-outside-toplevel
+        DiskcacheLongCallbackManager,
+    )
+
+    return DiskcacheLongCallbackManager()
diff --git a/requires-celery-manager.txt b/requires-celery-manager.txt
diff --git a/requires-celery.txt b/requires-celery.txt
@@ -0,0 +1,3 @@
+# Dependencies used by the CeleryLongCallbackManager
+redis>=3.5.3
+celery[redis]>=5.1.2
diff --git a/requires-ci.txt b/requires-ci.txt
@@ -1,3 +1,4 @@
+# Dependencies used by CI on github.com/plotly/dash
 black==21.6b0
 dash-flow-example==0.0.5
 dash-dangerously-set-inner-html

diff --git a/requires-dev.txt b/requires-dev.txt
@@ -1,3 +1,4 @@
+# Dependencies used for development new Dash components
 coloredlogs>=15.0.1
 fire>=0.4.0
 PyYAML>=5.4.1
diff --git a/requires-diskcache-manager.txt b/requires-diskcache-manager.txt
diff --git a/requires-diskcache.txt b/requires-diskcache.txt
@@ -0,0 +1,4 @@
+# Dependencies used by the DiskcacheLongCallbackManager
+diskcache>=5.2.1
+multiprocess>=0.70.12
+psutil>=5.8.0
diff --git a/requires-testing.txt b/requires-testing.txt
@@ -1,3 +1,4 @@
+# Dependencies necessary for utilizing Dash provided testing utilities
 beautifulsoup4>=4.8.2
 cryptography<3.4;python_version<"3.7"
 lxml>=4.6.2

diff --git a/setup.py b/setup.py
@@ -28,10 +28,11 @@ def read_req_file(req_type):
     install_requires=read_req_file("install"),
     python_requires=">=3.6",
     extras_require={
+        "ci": read_req_file("ci"),
         "dev": read_req_file("dev"),
         "testing": read_req_file("testing"),
-        "celery-manager": read_req_file("celery-manager"),
-        "diskcache-manager": read_req_file("diskcache-manager"),
+        "celery": read_req_file("celery"),
+        "diskcache": read_req_file("diskcache"),
     },
     entry_points={
         "console_scripts": [