Add sort argument to get_markets

[kongzii]

Summary by CodeRabbit

• New Features
  • Introduced sorting options for market listings, allowing users to sort by liquidity or newest additions.

[coderabbitai]

Walkthrough

The update introduces a MarketSort enumeration with options to sort markets by liquidity or newness. It enhances the get_markets function to accept a new sorting parameter, which can leverage the MarketSort enum or remain unspecified, in which case it defaults to sorting by liquidity. This addition enables customized sorting of markets for different MarketSources, improving the flexibility and usability of the tooling for prediction market agents.

Changes

File(s)	Change Summary
.../benchmark/utils.py	Introduced MarketSort enum with liquidity and newest. Updated get_markets to accept sort parameter, defaulting to liquidity. Added sorting logic for various MarketSources.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between d226831 and 3885ade.

Files selected for processing (1)

• prediction_market_agent_tooling/benchmark/utils.py (2 hunks)

Additional comments: 3

prediction_market_agent_tooling/benchmark/utils.py (3)

• 25-27: The MarketSort enum is well-defined with clear, concise values (liquidity and newest). This design choice aligns with the PR objectives and provides a structured way to specify sorting criteria.
• 313-313: The addition of the sort parameter to the get_markets function is a significant enhancement. It's good to see that it can accept both MarketSort and None, with a sensible default to liquidity when not provided. This change improves the function's flexibility and usability.
• 318-321: The implementation of sorting logic within the get_manifold_markets_paged function call is correctly handling the sort parameter. By defaulting to liquidity when sort is None, it ensures backward compatibility and adheres to the new sorting feature's requirements.

[coderabbitai]

Raising a ValueError when a sort is attempted on Polymarket data is a necessary limitation given the current API constraints. However, it's important to ensure that this limitation is clearly documented in the function's docstring or in relevant user-facing documentation to prevent confusion.

Consider adding a note in the function's docstring about the limitation regarding sorting with Polymarket sources to improve clarity for users.