python-jsonschema / python-jsonschema/jsonschema
Deprecate the `id_of` argument to `validators.create` and the `ID_OF` attribute on `Validator`s
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5k
- Forks
- 671
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 10
Description
These two are redundant with the now-anyways-needed Specification objects from referencing.
Either as part of this or some time in the future there will be a way of specifying which Specification should be associated with a new Validator, but regardless, these two objects are insufficient already today for encapsulating all the information that's needed to know how to deal with schemas for a dialect.
(#1061 is somewhat tangentially related to this).
Also somewhat related is expanding support for dialect <-> vocabulary interaction. The specification is still quite immature here and may change in the future, so there's a slight worry in creating an API that matches it too closely, but this ticket may benefit from "abandoning" jsonschema.validators.* in favor of new APIs that create dialects...
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the validators.create API and the Validator.ID_OF attribute, then read how Specification objects from referencing are used. Review the relationship to issue #1061 and the dialect–vocabulary concerns described here. Done means the redundant APIs have a decided deprecation or replacement path that accounts for associating Specifications with new Validators.
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