feat: update SegTransactionStats to support multiple segment columns…

[mvanwyk]

  - Modified SegTransactionStats to accept a list of columns for grouping
  - Added backwards compatibility with string input for segment_col
  - Updated total_metrics creation to handle multiple columns
  - Added validation in plot method for multiple segment columns
  - Added comprehensive unit tests for new functionality

  🤖 Generated with [Claude Code](https://claude.ai/code)

  Co-Authored-By: Claude <[email protected]>

Summary by CodeRabbit

• New Features

  • Enhanced segmentation analysis now supports specifying one or more grouping columns, offering increased flexibility.
  • Improved visualization safeguards ensure that plotting functions provide clear feedback when multiple grouping columns are configured.

• Bug Fixes

  • Updated validation checks to prevent errors when multiple segment columns are provided for plotting.

• Tests

  • Added tests to verify handling of multiple segment columns and ensure proper error handling during plotting.

• Chores

  • Updated the pre-commit configuration to use a newer version of the ruff tool.

[coderabbitai]

Walkthrough

This PR adjusts the SegTransactionStats class to accept either a single string or a list of strings for the segment_col parameter. Internally, a string is converted to a list, and methods such as _calc_seg_stats and the plot method are updated accordingly. The test suite is expanded with cases for multiple segment columns and proper error handling when plotting with more than one segment column.

Changes

File Path	Change Summary
pyretailscience/analysis/segmentation.py	Updated SegTransactionStats: constructor converts a string to a list; method signatures and stats calculation logic updated to handle multiple segment columns; plot method now checks and raises error for multiple segment columns.
tests/analysis/test_segmentation.py	Added tests for multiple segment columns handling and validating that plotting with multiple columns raises a ValueError; adjusted fixture declarations.
.pre-commit-config.yaml	Updated ruff-pre-commit repository revision from v0.2.2 to v0.11.0.
tests/analysis/test_cross_shop.py	Modified @pytest.fixture decorator by removing parentheses.
tests/analysis/test_haversine.py	Modified @pytest.fixture decorator by removing parentheses.
tests/analysis/test_product_association.py	Modified @pytest.fixture decorator by removing parentheses for multiple methods.
tests/analysis/test_revenue_tree.py	Modified @pytest.fixture decorator by removing parentheses.
tests/plots/test_area.py	Modified @pytest.fixture decorator by removing parentheses for multiple functions.
tests/plots/test_bar.py	Modified @pytest.fixture decorator by removing parentheses for multiple functions.
tests/plots/test_histogram.py	Modified @pytest.fixture decorator by removing parentheses for multiple functions.
tests/plots/test_index.py	Modified @pytest.fixture decorator by removing parentheses.
tests/plots/test_line.py	Modified @pytest.fixture decorator by removing parentheses for multiple functions.
tests/plots/test_scatter.py	Modified @pytest.fixture decorator by removing parentheses for multiple functions.
tests/plots/test_time.py	Modified @pytest.fixture decorator by removing parentheses.
tests/plots/test_venn.py	Modified @pytest.fixture decorator by removing parentheses for multiple functions.
tests/plots/test_waterfall.py	Modified @pytest.fixture decorator by removing parentheses.
tests/test_options.py	Modified @pytest.fixture decorator by removing parentheses.

Possibly related PRs

• Analysis module #127: The changes in the main PR regarding the SegTransactionStats class directly relate to the modifications in the tests/analysis/test_segmentation.py file, which also involves the SegTransactionStats class and its handling of multiple segment columns.
• feat: add total row to SegTransactionStats calculation #57: The changes in the main PR regarding the SegTransactionStats class's handling of the segment_col parameter and the updates to the _calc_seg_stats method are directly related to the modifications in the retrieved PR, which also involves significant changes to the _calc_seg_stats method and overall functionality of the SegTransactionStats class.
• feat: convert seg stats to use Ibis #90: The changes in the main PR regarding the SegTransactionStats class's handling of the segment_col parameter and its methods are directly related to the modifications in the retrieved PR, which also focuses on the SegTransactionStats class and its transition to using Ibis for data handling and aggregation.

Suggested labels

enhancement, Tests, Review effort [1-5]: 4

Suggested reviewers

• mvanwyk
• mayurkmmt

Poem

I'm a little coder rabbit with a hop in my stride,
Changing our segmentation with columns multiplied.
Converting strings to lists is now the trend,
With error checks in plot, our code will not bend.
Let's hop to the future with joy and insight 🐇✨!
Happy coding, my friends!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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 testing code 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Copilot]

Pull Request Overview

This PR enhances SegTransactionStats to support multiple segment columns while maintaining backwards compatibility for a string input. Key changes include:

• Allowing a list of segment columns in the constructor and internal methods.
• Updating the total metrics calculation and dataframe column ordering to accommodate multiple segment columns.
• Adding tests for handling multiple segment columns and ensuring the plot method raises an error when more than one segment is provided.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File	Description
tests/analysis/test_segmentation.py	Added tests for multiple segment columns and plot validation behavior.
pyretailscience/analysis/segmentation.py	Modified SegTransactionStats to process a list of segment columns and update methods accordingly.

[codecov]

Codecov Report

Attention: Patch coverage is 57.14286% with 3 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
pyretailscience/analysis/segmentation.py	57.14%	2 Missing and 1 partial ⚠️

Files with missing lines	Coverage Δ
pyretailscience/analysis/cross_shop.py	46.66% <ø> (ø)
pyretailscience/analysis/haversine.py	100.00% <ø> (ø)
pyretailscience/plots/time.py	100.00% <ø> (ø)
pyretailscience/plots/venn.py	93.33% <ø> (ø)
pyretailscience/analysis/segmentation.py	72.39% <57.14%> (+3.37%)	⬆️

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/examples/cross_shop.ipynb (1)

241-243: Consider clarifying or adjusting the distribution.
You're using a 50/50 split between "Shoes" and "Jeans," which might not always reflect real-world data. Consider documenting or parameterizing these probabilities if you need a more realistic or adjustable distribution.

pyretailscience/plots/venn.py (1)

25-25: Add a quick data format example.

Clarifying that the data must be pre-aggregated is helpful. Consider including a short example or reference in the docstring to show how users should structure their data before calling this module.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 796bc80 and c948ab7.

📒 Files selected for processing (8)

• .pre-commit-config.yaml (1 hunks)
• docs/examples/cross_shop.ipynb (1 hunks)
• docs/examples/gain_loss.ipynb (1 hunks)
• docs/examples/segmentation.ipynb (1 hunks)
• pyretailscience/analysis/cross_shop.py (0 hunks)
• pyretailscience/analysis/haversine.py (1 hunks)
• pyretailscience/plots/time.py (0 hunks)
• pyretailscience/plots/venn.py (1 hunks)

💤 Files with no reviewable changes (2)

• pyretailscience/analysis/cross_shop.py
• pyretailscience/plots/time.py

✅ Files skipped from review due to trivial changes (1)

• pyretailscience/analysis/haversine.py

🚧 Files skipped from review as they are similar to previous changes (1)

• .pre-commit-config.yaml

👮 Files not reviewed due to content moderation or server errors (2)

• docs/examples/gain_loss.ipynb
• docs/examples/segmentation.ipynb