scverse / scverse/spatialdata

[Proposal] Rename Sequence transformation to avoid clashes

Open
#382 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
394
Forks
95
Avg merge
4d 3h
Merged PRs (30d)
7

Description

When type-hinting my code, I frequently need Sequence from collections.abc. In order to avoid name clashes, one can do for either of the two:

from spatialdata.transformations import Sequence as SequenceTransform

I've noticed that by now all my imports are like this.

A good name could be TransformationSequence (which reads as "a sequence of transformations"), or SequenceTransformation (analog to BaseTransformation) or anything shorter. On the other side, all specific transformation classes don't have it in their name (Affine etc.).

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

Start by inspecting the public spatialdata.transformations module and searching for the current Sequence name and its imports. Review how the proposed replacement would affect transformation classes and consumers; done means one agreed name is applied consistently without leaving the existing clash unresolved.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.