Feature/251 add ruff (#267)

* Bump black: 22.3.0 -> 24.4.2 & Apply new format rules
Disable E704 for consistency between Flake8 and black

* Replace black and flake8 with ruff.

* Add blank line after rebase.

Author: nathanjmcdougall

.pre-commit-config.yaml

@@ -3,16 +3,14 @@ repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v2.4.0
     hooks:
-      - id: flake8
-        # line too long and line before binary operator (black is ok with these)
-        types:
-          - python
       - id: trailing-whitespace
       - id: end-of-file-fixer
       - id: check-yaml
         args: ["--unsafe"]
       - id: check-added-large-files
-  - repo: https://github.com/psf/black
-    rev: 22.3.0
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.5.4" # Sync with pyproject.toml
     hooks:
-      - id: black
+      - id: ruff
+        args: ["--fix"]
+      - id: ruff-format

pins/boards.py

@@ -25,32 +25,23 @@
 
 
 class IFileSystem(Protocol):
-
     protocol: "str | list"
 
-    def ls(self, path: str) -> Sequence[str]:
-        ...
+    def ls(self, path: str) -> Sequence[str]: ...
 
-    def put(self) -> None:
-        ...
+    def put(self) -> None: ...
 
-    def open(self, path: str, mode: str, *args, **kwargs) -> IOBase:
-        ...
+    def open(self, path: str, mode: str, *args, **kwargs) -> IOBase: ...
 
-    def get(self) -> None:
-        ...
+    def get(self) -> None: ...
 
-    def exists(self, path: str, **kwargs) -> bool:
-        ...
+    def exists(self, path: str, **kwargs) -> bool: ...
 
-    def mkdir(self, path, create_parents=True, **kwargs) -> None:
-        ...
+    def mkdir(self, path, create_parents=True, **kwargs) -> None: ...
 
-    def rm(self, path, recursive=False, maxdepth=None) -> None:
-        ...
+    def rm(self, path, recursive=False, maxdepth=None) -> None: ...
 
-    def info(self, path):
-        ...
+    def info(self, path): ...
 
 
 class BaseBoard:
@@ -163,9 +154,7 @@ def pin_meta(self, name, version: str = None) -> Meta:
         path_meta = self.construct_path([*components, meta_name])
         f, local = self._open_pin_meta(path_meta)
 
-        meta = self.meta_factory.read_pin_yaml(
-            f, pin_name, selected_version, local=local
-        )
+        meta = self.meta_factory.read_pin_yaml(f, pin_name, selected_version, local=local)
 
         return meta
 
@@ -237,7 +226,6 @@ def _pin_store(
         versioned: Optional[bool] = None,
         created: Optional[datetime] = None,
     ) -> Meta:
-
         if type == "feather":
             warn_deprecated(
                 'Writing pin type "feather" is unsupported. Switching type to "arrow".'
@@ -299,9 +287,7 @@ def _pin_store(
                     "but that directory already exists."
                 )
 
-            inform(
-                _log, f"Writing pin:\nName: {repr(pin_name)}\nVersion: {dst_version}"
-            )
+            inform(_log, f"Writing pin:\nName: {repr(pin_name)}\nVersion: {dst_version}")
 
             res = self.fs.put(tmp_dir, dst_version_path, recursive=True)
 
@@ -456,9 +442,7 @@ def pin_version_delete(self, name: str, version: str):
         pin_version_path = self.construct_path([pin_name, version])
         self.fs.rm(pin_version_path, recursive=True)
 
-    def pin_versions_prune(
-        self, name, n: "int | None" = None, days: "int | None" = None
-    ):
+    def pin_versions_prune(self, name, n: "int | None" = None, days: "int | None" = None):
         """Delete old versions of a pin.
 
         Parameters

pins/cache.py

@@ -190,9 +190,7 @@ def _open(self, path, mode="rb", **kwargs):
         fn = self._check_file(path)
 
         if fn is None:
-            raise ValueError(
-                f"Cached file should exist for path, but none found: {path}"
-            )
+            raise ValueError(f"Cached file should exist for path, but none found: {path}")
 
         touch_access_time(fn)
 

pins/constructors.py

@@ -152,9 +152,7 @@ def board_folder(path: str, versioned=True, allow_pickle_read=None):
         takes precedence.
     """
 
-    return board(
-        "file", path, versioned, cache=None, allow_pickle_read=allow_pickle_read
-    )
+    return board("file", path, versioned, cache=None, allow_pickle_read=allow_pickle_read)
 
 
 def board_temp(versioned=True, allow_pickle_read=None):
@@ -206,9 +204,7 @@ def board_local(versioned=True, allow_pickle_read=None):
     """
     path = get_data_dir()
 
-    return board(
-        "file", path, versioned, cache=None, allow_pickle_read=allow_pickle_read
-    )
+    return board("file", path, versioned, cache=None, allow_pickle_read=allow_pickle_read)
 
 
 def board_github(
@@ -425,9 +421,7 @@ def board_connect(
         server_url = os.environ.get("CONNECT_SERVER")
 
     kwargs = dict(server_url=server_url, api_key=api_key)
-    return board(
-        "rsc", None, versioned, cache, allow_pickle_read, storage_options=kwargs
-    )
+    return board("rsc", None, versioned, cache, allow_pickle_read, storage_options=kwargs)
 
 
 board_rsconnect = board_connect
@@ -569,6 +563,4 @@ def board_azure(path, versioned=True, cache=DEFAULT, allow_pickle_read=None):
     """
 
     opts = {"use_listings_cache": False}
-    return board(
-        "abfs", path, versioned, cache, allow_pickle_read, storage_options=opts
-    )
+    return board("abfs", path, versioned, cache, allow_pickle_read, storage_options=opts)

pins/drivers.py

@@ -31,7 +31,7 @@ def load_path(meta, path_to_version):
 
     # file path creation ------------------------------------------------------
 
-    if type == "table":
+    if type == "table":  # noqa: E721 False Positive due to bug: https://github.com/rstudio/pins-python/issues/266
         # this type contains an rds and csv files named data.{ext}, so we match
         # R pins behavior and hardcode the name
         target_fname = "data.csv"
@@ -134,9 +134,7 @@ def load_data(
     raise NotImplementedError(f"No driver for type {meta.type}")
 
 
-def save_data(
-    obj, fname, type=None, apply_suffix: bool = True
-) -> "str | Sequence[str]":
+def save_data(obj, fname, type=None, apply_suffix: bool = True) -> "str | Sequence[str]":
     # TODO: extensible saving with deferred importing
     # TODO: how to encode arguments to saving / loading drivers?
     #       e.g. pandas index options

pins/meta.py

@@ -223,7 +223,6 @@ def create(
         created=None,
         user=None,
     ) -> Meta:
-
         if title is None:
             raise NotImplementedError("title arguments required")
         if isinstance(files, str):

pins/rsconnect/api.py

@@ -278,7 +278,6 @@ def get_users(
         asc_order: "bool | None" = None,
         walk_pages=True,
     ) -> "Sequence[User] | Sequence[dict]":
-
         params = {k: v for k, v in locals().items() if k != "self" if v is not None}
 
         if walk_pages:
@@ -290,9 +289,7 @@ def get_users(
 
     # content ----
 
-    def get_content(
-        self, owner_guid: str = None, name: str = None
-    ) -> Sequence[Content]:
+    def get_content(self, owner_guid: str = None, name: str = None) -> Sequence[Content]:
         params = self._get_params(locals())
 
         results = self.query_v1("content", params=params)
@@ -355,7 +352,6 @@ def get_content_bundle(self, guid: str, id: int) -> Bundle:
     def get_content_bundle_archive(
         self, guid: str, id: str, f_obj: "str | IOBase"
     ) -> None:
-
         r = self.query_v1(
             f"content/{guid}/bundles/{id}/download", stream=True, return_request=True
         )

pins/rsconnect/fs.py

@@ -45,9 +45,7 @@ class PinBundleManifest:
     version: int = 1
     local: str = "en_US"
     platform: str = "3.5.1"
-    metadata: PinBundleManifestMetadata = field(
-        default_factory=PinBundleManifestMetadata
-    )
+    metadata: PinBundleManifestMetadata = field(default_factory=PinBundleManifestMetadata)
     packages: None = None
     files: list = field(default_factory=list)
     users: None = None
@@ -119,9 +117,7 @@ def __init__(self, server_url, **kwargs):
         self._user_name_cache = {}
         self._content_name_cache = {}
 
-    def ls(
-        self, path, details=False, **kwargs
-    ) -> "Sequence[BaseEntity] | Sequence[str]":
+    def ls(self, path, details=False, **kwargs) -> "Sequence[BaseEntity] | Sequence[str]":
         """List contents of Rstudio Connect Server.
 
         Parameters
@@ -219,9 +215,7 @@ def put(
         # Deploy bundle ----
 
         if deploy:
-            task = self.api.post_content_item_deploy(
-                bundle["content_guid"], bundle["id"]
-            )
+            task = self.api.post_content_item_deploy(bundle["content_guid"], bundle["id"])
 
             task = self.api.poll_tasks(task["task_id"])
             if task["code"] != 0 or not task["finished"]:
@@ -399,9 +393,7 @@ def _get_content_from_name(self, user_guid, content_name):
                 if len(contents) == 0
                 else RsConnectApiResultError
             )
-            raise err(
-                f"Expecting 1 content entry, but found {len(contents)}: {contents}"
-            )
+            raise err(f"Expecting 1 content entry, but found {len(contents)}: {contents}")
 
         res = contents[0]
 

pins/tests/conftest.py

@@ -44,7 +44,9 @@ def http_example_board_path():
     # yield backend.create_tmp_board(str(PATH_TO_EXAMPLE_BOARD.absolute())).board
     # backend.teardown()
     # TODO: could putting it in a publically available bucket folder
-    return "https://raw.githubusercontent.com/machow/pins-python/main/pins/tests/pins-compat"
+    return (
+        "https://raw.githubusercontent.com/machow/pins-python/main/pins/tests/pins-compat"
+    )
 
 
 @pytest.fixture

pins/tests/test_boards.py

@@ -71,27 +71,22 @@ def test_board_validate_pin_name_root(board):
 
 
 def test_board_pin_write_default_title(board):
-
     df = pd.DataFrame({"x": [1, 2, 3], "y": [4, 5, 6]})
     meta = board.pin_write(df, "df_csv", title=None, type="csv")
     assert meta.title == "df_csv: a pinned 3 x 2 DataFrame"
 
 
 def test_board_pin_write_prepare_pin(board, tmp_dir2):
-
     df = pd.DataFrame({"x": [1, 2, 3], "y": [4, 5, 6]})
 
-    meta = board.prepare_pin_version(
-        str(tmp_dir2), df, "df_csv", title=None, type="csv"
-    )
+    meta = board.prepare_pin_version(str(tmp_dir2), df, "df_csv", title=None, type="csv")
     assert meta.file == "df_csv.csv"
     assert (tmp_dir2 / "data.txt").exists()
     assert (tmp_dir2 / "df_csv.csv").exists()
     assert not (tmp_dir2 / "df_csv.csv").is_dir()
 
 
 def test_board_pin_write_roundtrip(board):
-
     df = pd.DataFrame({"x": [1, 2, 3], "y": [4, 5, 6]})
 
     assert not board.pin_exists("df_csv")
@@ -413,7 +408,6 @@ def test_board_pin_version_delete_latest(board, pin_name, pin_del):
 
 @pytest.mark.parametrize("n", [1, 2])
 def test_board_pin_versions_prune_n(board, pin_prune, pin_name, n):
-
     board.pin_versions_prune(pin_name, n=n)
     new_versions = board.pin_versions(pin_name, as_df=False)
 
@@ -428,7 +422,6 @@ def test_board_pin_versions_prune_n(board, pin_prune, pin_name, n):
 
 @pytest.mark.parametrize("days", [1, 2])
 def test_board_pin_versions_prune_days(board, pin_prune, pin_name, days):
-
     # RStudio cannot handle days, since it involves pulling metadata
     if board.fs.protocol == "rsc":
         with pytest.raises(NotImplementedError):
@@ -482,7 +475,6 @@ 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",
@@ -635,7 +627,6 @@ def test_board_rsc_pin_read_public(df, board_short):
 
 
 def test_board_manual_http_file_download():
-
     path = "https://raw.githubusercontent.com/rstudio/pins-python"
     license_path = "main/LICENSE"