NASA-AMMOS / NASA-AMMOS/AIT-Core

Revisiting Slots usage on key data abstractions

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

Nobody has claimed this yet.

Dominant language
Python
Stars
56
Forks
35
Avg merge
1d 20h
Merged PRs (30d)
3

Description

A good portion of our classes define their fields in __slots__. We also use slots for JSON Serialization (see the JSON module). The slots can be frustrating because they prevent any custom dictionary extensions without subclassing the relevant dictionary classes.

We should considering doing one of two things:

  • Figure out an alternative way of dealing with serialization and the reliance on slots
  • Live with __slots__ and the like but document clearly the necessity of slots and its uses in the extension documentation so there's no surprises for users.

Contributor guide

No contributing guide indexed for this repository

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

Start with ait/core/json.py and inspect the project’s uses of slots in key data abstractions. Determine whether the issue should pursue an alternative serialization approach or document the existing constraint in the extension documentation; done requires a clearly chosen direction and corresponding coverage.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.