Merge pull request #124 from isabelizimm/board-deparse-update

verbose allow_pickle_read for board_deparse

Author: machow

.github/workflows/ci.yml

@@ -16,6 +16,7 @@ jobs:
   tests:
     name: "Tests"
     runs-on: ${{ matrix.os }}
+    if: ${{ !github.event.pull_request.head.repo.fork }}
     strategy:
       fail-fast: false
       matrix:
@@ -60,6 +61,7 @@ jobs:
   test-rsconnect:
     name: "Test RSConnect"
     runs-on: ubuntu-latest
+    if: ${{ !github.event.pull_request.head.repo.fork }}
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
@@ -83,6 +85,27 @@ jobs:
         run: |
           pytest pins -m 'fs_rsc and not skip_on_github'
 
+
+  test-fork:
+    name: "Test a fork PR (no secrets)"
+    runs-on: ubuntu-latest
+    if: ${{ github.event.pull_request.head.repo.fork }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+
+          python -m pip install -e .[test]
+      - name: Run tests
+        run: |
+          # TODO: better way to disable all cloud backend tests?
+          pytest pins -m 'not fs_rsc and not fs_s3 and not skip_on_github'
+
+
   check-cross-compatibility:
     name: "Check cross lib compatibility"
     runs-on: ubuntu-latest

.github/workflows/code-checks.yml

@@ -0,0 +1,18 @@
+name: Code Checks
+
+on:
+  workflow_dispatch:
+  push:
+    branches: ['main', 'dev-*']
+  pull_request:
+  release:
+    types: [published]
+
+jobs:
+  pre-commit:
+    name: "Run pre-commit"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+      - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -13,6 +13,6 @@ repos:
         args: ["--unsafe"]
       - id: check-added-large-files
   - repo: https://github.com/psf/black
-    rev: 19.10b0
+    rev: 22.3.0
     hooks:
       - id: black

pins/constructors.py

@@ -42,14 +42,21 @@ def board_deparse(board: BaseBoard):
 
     >>> board_deparse(board_folder("a/b/c"))
     "board_folder('a/b/c')"
+
+    >>> board_deparse(board_folder(path="a/b/c", allow_pickle_read=True))
+    "board_folder('a/b/c', allow_pickle_read=True)"
     """
+    if board.allow_pickle_read is not None:
+        allow_pickle = f", allow_pickle_read={repr(board.allow_pickle_read)}"
+    else:
+        allow_pickle = ""
 
     prot = board.fs.protocol
     if prot == "rsc":
         url = board.fs.api.server_url
-        return f"board_rsconnect(server_url={repr(url)})"
+        return f"board_rsconnect(server_url={repr(url)}{allow_pickle})"
     elif prot == "file":
-        return f"board_folder({repr(board.board)})"
+        return f"board_folder({repr(board.board)}{allow_pickle})"
     else:
         raise NotImplementedError(
             f"board deparsing currently not supported for protocol: {prot}"

pins/meta.py

@@ -150,9 +150,7 @@ def to_pin_yaml(self, *args, **kwargs):
 
 
 class MetaFactory:
-    """Responsible for creating and loading (e.g. from yaml) of meta objects.
-
-    """
+    """Responsible for creating and loading (e.g. from yaml) of meta objects."""
 
     def get_meta_name(self, *args, **kwargs) -> str:
         return META_FILENAME

pins/tests/test_boards.py

@@ -308,7 +308,10 @@ def test_board_pin_search_name(board, df, search, matches):
 def test_board_base_pin_meta_cache_touch(tmp_dir2, df):
 
     cache = fsspec.filesystem(
-        "pinscache", target_protocol="file", same_names=True, hash_prefix=str(tmp_dir2),
+        "pinscache",
+        target_protocol="file",
+        same_names=True,
+        hash_prefix=str(tmp_dir2),
     )
     board = BaseBoard(str(tmp_dir2), fs=cache)