0.5.3 is not backwards compatible

Open
#323 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
python

Research direction

Start by locating the Stream classes and their update methods in the streamz repository, then reproduce the issue with a custom Stream subclass whose update method lacks a metadata keyword argument. Trace how the 0.5.3 change reaches custom subclasses and check the project’s release-versioning guidance. Done means the compatibility impact is addressed or the breaking change is correctly represented in the release plan.

Written by the indexing model from the issue text.

Description

I have a few projects that require ~=0.5.0 of streamz. Today I got upgraded to 0.5.3 and found that it is aggressively not backwards compatible as this new version assumes that the update method on all Stream classes takes a metadata kwarg. We define quite a few custom subclasses of Stream, so this was quite a nasty issue to run into. A breaking change like this should be released as 0.6.0 to avoid these problems.

Dominant language
Python
Stars
1.3k
Forks
149
PR merge metrics
No merged PRs in 30d

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-streamz/streamz

All issues in python-streamz/streamz

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.