Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make test_export_with_non_default_frame_step compatible with Python 3.11+ #8927

Merged
merged 1 commit into from
Jan 13, 2025

Conversation

SpecLad
Copy link
Contributor

@SpecLad SpecLad commented Jan 10, 2025

Motivation and context

In Python 3.11, Enum.__format__ was changed to be the same as Enum.__str__, so the yielded format name ends up being CVAT for _SourceDataType.images 1.1. Use the string value explicitly.

Also, remove the str base class from _SourceDataType, since it appears to be actively misleading (as well as unnecessary).

How has this been tested?

I ran the test with Python 3.12.

Checklist

  • I submit my changes into the develop branch
  • [ ] I have created a changelog fragment
  • [ ] I have updated the documentation accordingly
  • [ ] I have added tests to cover my changes
  • [ ] I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • Tests
    • Updated the _SourceDataType class to use standard Enum implementation
    • Modified fixture to use correct enum value representation in test generation

….11+

In Python 3.11, `Enum.__format__` was changed to be the same as `Enum.__str__`,
so the yielded format name ends up being `CVAT for _SourceDataType.images 1.1`.
Use the string value explicitly.

Also, remove the `str` base class from `_SourceDataType`, since it appears to
be actively misleading (as well as unnecessary).
@SpecLad SpecLad requested a review from archibald1418 January 10, 2025 14:32
@SpecLad SpecLad requested a review from azhavoro as a code owner January 10, 2025 14:32
Copy link
Contributor

coderabbitai bot commented Jan 10, 2025

Walkthrough

The pull request involves modifying the _SourceDataType class in the test_tasks.py file. The primary change is transitioning the class from inheriting from both str and Enum to being a standard Enum class. This refactoring affects how the enumeration values are represented and used in the test code. The enumeration values images and video remain consistent, with a minor adjustment in how they are referenced in the fixture.

Changes

File Change Summary
tests/python/rest_api/test_tasks.py - Converted _SourceDataType from str, Enum to pure Enum
- Updated fixture to use media_type.value instead of media_type

Poem

🐰 In the realm of tests, a class takes flight
From string and enum, to enum's pure might
media_type.value now leads the way
Refactoring code on this testing day
A rabbit's code dance, precise and bright! 🔍


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 411f8e7 and fd6e42b.

📒 Files selected for processing (1)
  • tests/python/rest_api/test_tasks.py (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • tests/python/rest_api/test_tasks.py
⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: build
  • GitHub Check: generate_github_pages
  • GitHub Check: testing
  • GitHub Check: Analyze (python)
  • GitHub Check: Linter
  • GitHub Check: Analyze (javascript)

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
🪧 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. (Beta)
  • @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.

Copy link
Contributor

@archibald1418 archibald1418 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great catch, I will update to Python3.11 on my azure machine to be able to check such errors in the future

@SpecLad SpecLad mentioned this pull request Jan 13, 2025
7 tasks
@SpecLad SpecLad merged commit af8bfe3 into cvat-ai:develop Jan 13, 2025
35 checks passed
@SpecLad SpecLad deleted the media-type-value branch January 13, 2025 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants