rstudio / rstudio/pins-python

Fix Meta class hierarchy

Open
#65 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

.enhancement
Dominant language
Python
Stars
59
Forks
11
PR merge metrics
No merged PRs in 30d

Description

Currently there is MetaRaw, Meta, and MetaV0, but they aren't really in a class hierarchy. I think roughly they do this:

MetaRaw (necessities):

  • file (optional) - if None, we have no idea what's in there (e.g. rsc admin can see pins, but not their content). Otherwise, board can handle (e.g. board_url could have this point to a single file url.)
  • type (optional) - what driver to use when loading
  • name (required) - the pin name

MetaV0: sets a bunch of fields to None, to be compatible with Meta

Meta: current data.txt format.

Edit: let's add tests of reading MetaV0 as part of this issue.

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.

Research direction

Locate MetaRaw, Meta, and MetaV0 and read the current data.txt parsing path first. Compare their existing fields, then add coverage for reading MetaV0 as requested; done means the intended hierarchy and compatibility behavior are represented and the relevant tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.