How to rename attributes and still support the old name of it?

Open
#417 14 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

The issue names cattrs loading and dumping but no files, tests, or entry points. Start by reviewing cattrs support for renamed attributes and clarify the expected legacy-JSON behavior with maintainers before locating the implementation and tests; done should mean old input is accepted while the renamed attribute is used elsewhere.

Written by the indexing model from the issue text.

Description

Feature

The case that I ran into was that I needed to rename a variable but I still would like to support the old JSON that used the old name.

Basically, I am looking for some kind of hook if the old attribute is supplied, use it for the new name, but do not use that old name anywhere else. I mostly use cattrs to do the loading/dumping of the classes.

Dominant language
Python
Stars
5.8k
Forks
480
Avg merge
2h 15m
Merged PRs (30d)
2

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 python-attrs/attrs

All issues in python-attrs/attrs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.