Merge pull request #102 from machow/ci-py-versions-tests

ci: test across py 3.7 to 3.10

Author: machow

.github/workflows/ci.yml

@@ -15,23 +15,24 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
+        python: ["3.7", "3.8", "3.9", "3.10"]
+        os: ["ubuntu-latest"]
+        pytest_ops: [""]
         include:
           - os: "macos-latest"
+            python: "3.10"
             # ignore doctests, as they involve calls to github, and all mac machines
             # use the same IP address
             pytest_opts: "-k pins/tests"
-          - os: "ubuntu-latest"
-            pytest_opts:
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: ${{ matrix.python }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install -r requirements/dev.txt
-          python -m pip install -e .
+          python -m pip install -e .[test]
       - name: Run tests
         run: |
           pytest pins -m 'not fs_rsc and not skip_on_github' $PYTEST_OPTS

Makefile

@@ -32,7 +32,7 @@ docs-clean:
 requirements/dev.txt: setup.cfg
 	@# allows you to do this...
 	@# make requirements | tee > requirements/some_file.txt
-	@pip-compile setup.cfg --rebuild --extra dev --output-file=- > $@
+	@pip-compile setup.cfg --rebuild --extra doc --extra test --output-file=- > $@
 
-binder/requirements.txt: setup.cfg
-	@pip-compile setup.cfg --rebuild --extra dev --output-file=- > $@
+binder/requirements.txt: requirements/dev.txt
+	cp $< $@

pins/__init__.py

@@ -1,7 +1,7 @@
 # flake8: noqa
 
 # Set version ----
-from importlib.metadata import version as _v
+from importlib_metadata import version as _v
 
 __version__ = _v("pins")
 

pins/boards.py

@@ -5,20 +5,20 @@
 import re
 
 from io import IOBase
-from functools import cached_property
 from pathlib import Path
 from importlib_resources import files
 from datetime import datetime, timedelta
 
-from typing import Protocol, Sequence, Optional, Mapping
+from typing import Sequence, Optional, Mapping
 
 from .versions import VersionRaw, guess_version
 from .meta import Meta, MetaRaw, MetaFactory
 from .errors import PinsError
 from .drivers import load_data, save_data, default_title
 
 
-class IFileSystem(Protocol):
+# Note that once we drop python 3.7, we can make this a Protocol
+class IFileSystem:
     def ls(self, path: str) -> Sequence[str]:
         ...
 
@@ -797,10 +797,18 @@ def path_to_deploy_version(self, name: str, version: str):
         # to fs.put to the <user>/<content_name>.
         return self.path_to_pin(name)
 
-    @cached_property
+    @property
     def user_name(self):
-        user = self.fs.api.get_user()
-        return user["username"]
+        # note that this is essentially the manual version of functools.cached_property
+        # since we support python 3.7
+        name = getattr(self, "_user_name", None)
+        if name is not None:
+            return name
+        else:
+            user = self.fs.api.get_user()
+            self._user_name = user["username"]
+
+            return self._user_name
 
     def prepare_pin_version(self, pin_dir_path, x, name: "str | None", *args, **kwargs):
 
@@ -824,7 +832,8 @@ def prepare_pin_version(self, pin_dir_path, x, name: "str | None", *args, **kwar
             )
 
         # recursively copy all assets into prepped pin version dir
-        shutil.copytree(self.html_assets_dir, pin_dir_path, dirs_exist_ok=True)
+        # shutil.copytree(self.html_assets_dir, pin_dir_path, dirs_exist_ok=True)
+        _copytree(self.html_assets_dir, pin_dir_path)
 
         # render index.html ------------------------------------------------
 
@@ -870,3 +879,17 @@ def prepare_pin_version(self, pin_dir_path, x, name: "str | None", *args, **kwar
         (Path(pin_dir_path) / "index.html").write_text(rendered)
 
         return meta
+
+
+# TODO: replace with shutil.copytree once py3.7 is dropped
+# copied from https://stackoverflow.com/a/12514470/1144523
+def _copytree(src, dst, symlinks=False, ignore=None):
+    import os
+
+    for item in os.listdir(src):
+        s = os.path.join(src, item)
+        d = os.path.join(dst, item)
+        if os.path.isdir(s):
+            shutil.copytree(s, d, symlinks, ignore)
+        else:
+            shutil.copy2(s, d)

pins/tests/test_cache.py

@@ -1,5 +1,4 @@
 import time
-import shutil
 
 import pytest
 from pins.cache import (
@@ -72,7 +71,7 @@ def test_pins_cache_open():
 
 @pytest.fixture
 def a_cache(tmp_dir2):
-    return tmp_dir2
+    return tmp_dir2 / "board_cache"
 
 
 def create_metadata(p, access_time):
@@ -141,12 +140,10 @@ def test_cache_pruner_old_versions_multi_pins(a_cache, pin1_v2, pin2_v3):
     assert set(old) == {pin1_v2, pin2_v3}
 
 
-def test_cache_prune_prompt(tmp_dir2, a_cache, pin1_v1, pin2_v3, monkeypatch):
-    p_board = tmp_dir2 / "a_board"
-    shutil.copytree(a_cache, p_board)
-    cache_prune(days=1, cache_root=tmp_dir2, prompt=False)
+def test_cache_prune_prompt(a_cache, pin1_v1, pin2_v3, monkeypatch):
+    cache_prune(days=1, cache_root=a_cache.parent, prompt=False)
 
-    versions = list(p_board.glob("*/*"))
+    versions = list(a_cache.glob("*/*"))
 
     # pin2_v3 deleted
     assert len(versions) == 1

setup.cfg

@@ -10,6 +10,7 @@ author_email = [email protected]
 license = MIT
 keywords = data, tidyverse
 classifiers =
+    Programming Language :: Python :: 3.7
     Programming Language :: Python :: 3.8
     Programming Language :: Python :: 3.9
     Programming Language :: Python :: 3.10
@@ -20,17 +21,17 @@ packages = find:
 include_package_data = True
 zipsafe = False
 
-python_requires = >3.8
+python_requires = >=3.7
 install_requires =
     fsspec
     pyyaml
     xxhash
     pandas
     jinja2
     joblib
+    importlib-metadata
     importlib-resources
     appdirs
-    siuba
     humanize
 
 
@@ -40,18 +41,18 @@ aws =
 azure =
     adlfs
 
-dev =
+doc =
+    sphinx
+    jupytext
+    jupyter-book
+
+test =
     pip-tools
-    pydata-sphinx-theme
     pytest
     pytest-cases
     pytest-dotenv
-    sphinx
     s3fs
-    jupytext
-    jupyter-book
-    nbsphinx
-    ipykernel
+    adlfs
 
 
 [bdist_wheel]