Move IFileSystem out of `boards.py`

Open Beginner friendly
#280 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
62/100
Issue type
Refactor
Clarity
Clearly specified
Activity status
Stale
Tech stack
python
Domain
backend

Research direction

Start by locating IFileSystem in pins/boards.py and inspect its reference in pins/drivers.py, especially the type annotations linked in the issue. Move the interface to pins/fs.py, preserve the boards.py import for compatibility, and update drivers.py to use it without a circular import. Done means the relevant imports and annotations work as intended.

Written by the indexing model from the issue text.

Description

.maint

As per

https://github.com/rstudio/pins-python/blob/d215a8cd6cf958be0f4fc41c6e90e21c907b4655/pins/drivers.py#L9-L10

I propose moving IFileSystem into its own pins/fs.py file. It would still imported in boards.py for type hinting, so this wouldn't break backward compatibility.

It could then be used for type annotations in drivers.py without a circular import. This is currently the only other place where it is referenced.

Dominant language
Python
Stars
59
Forks
11
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rstudio/pins-python

All issues in rstudio/pins-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.