Feat improve watchlist

[stabacco]

Summary by Sourcery

Improve watchlist support by enabling creation with initial symbols, cleaning up deprecated methods and constants, extending trade types, and refreshing test fixtures to match updated API responses.

New Features:

• Allow specifying initial tickers when creating a new watchlist via CreateWatchlistRequest

Enhancements:

• Automatically add provided tickers after watchlist creation
• Remove deprecated add, remove, and list methods from the watchlist client in favor of unified methods
• Clean up outdated constant URLs for watchlist endpoints
• Extend ASX TradeType enum to include STOP orders

Tests:

• Update VCR cassette fixtures to reflect new watchlist API endpoints and updated response fields (stakeInstrumentId, pre/post-market returns, extended hours status, marketCap, accountStatus)

[sourcery-ai]

Reviewer's Guide

This PR refactors the watchlist feature by cleaning up deprecated methods, extending the create logic to accept initial tickers, and updating request/response models and test fixtures to align with the new API contract.

Class diagram for updated Watchlist request models

classDiagram
    class CreateWatchlistRequest {
        +str name
        +List[str] | None tickers
    }
    class UpdateWatchlistRequest {
        +str id
        +List[str] tickers
    }

Loading

Class diagram for removed deprecated Watchlist methods

classDiagram
    class WatchlistService {
        -add(request: AddToWatchlistRequest) : WatchlistResponse
        -remove(request: RemoveFromWatchlistRequest) : WatchlistResponse
        -list() : List[WatchlistProduct]
        +add_to_watchlist(request: UpdateWatchlistRequest) : Watchlist
        +watchlist(request: GetWatchlistRequest) : Watchlist
    }

Loading

File-Level Changes

Change	Details	Files
Extend watchlist creation with initial tickers	Add optional tickers field to CreateWatchlistRequest Modify create_watchlist to chain to add_to_watchlist when tickers provided Retain existing watchlist retrieval path when no tickers	stake/watchlist.py
Remove deprecated methods and constants	Delete deprecated add, remove, and list methods from Watchlist client Remove corresponding API constants in constant.py	stake/watchlist.py stake/constant.py
Align product and watchlist models with new API fields	Introduce stakeInstrumentId, prePostMarketDailyReturn, extendedHoursNotionalStatus, marketCap in instrument responses Enrich user/account status with accountStatus field Add STOP enum in ASX common	stake/watchlist.py stake/asx/common.py tests/cassettes/**
Update test fixtures to reflect API contract changes	Adjust cassette YAMLs for updated user data, URLs, response shapes Remove legacy tests for deprecated watchlist methods Parametrize tests around new watchlist endpoints	tests/cassettes/test_watchlist/** tests/test_watchlist.py stake/constant.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes and they look great!

Prompt for AI Agents

Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `tests/test_watchlist.py:13` </location>
<code_context>
-    assert len(watched) == 10
-

 @pytest.mark.parametrize(
     "exchange, symbols",
</code_context>

<issue_to_address>
No explicit tests for the new tickers field in CreateWatchlistRequest.

Please add tests for CreateWatchlistRequest with tickers set to None, an empty list, and a large list to ensure all scenarios are handled correctly.
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}