Skip to content

Update mypy configuration #2464

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 12, 2025
Merged

Update mypy configuration #2464

merged 1 commit into from
Apr 12, 2025

Conversation

@arkid15r
Copy link
Collaborator

Proposed change

Add ruff TC category.

Type of change

  • New country/market holidays support (thank you!)
  • Supported country/market holidays update (calendar discrepancy fix, localization)
  • Existing code/documentation/test/process quality improvement (best practice, cleanup, refactoring, optimization)
  • Dependency update (version deprecation/pin/upgrade)
  • Bugfix (non-breaking change which fixes an issue)
  • Breaking change (a code change causing existing functionality to break)
  • New feature (new holidays functionality in general)

Checklist

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 12, 2025 •
edited
Loading

Summary by CodeRabbit

  • Refactor
    • Improved type annotations and import handling for enhanced code clarity and robustness.
  • Chores
    • Updated internal configuration settings for validation and linting to streamline development workflows.

Walkthrough

The pull request updates tool configurations and type annotations across several files. The pre-commit configuration for mypy now removes certain runtime arguments and adds a new dependency. Within the holidays module, an import is now conditional on type checking, and several method signatures and constructors have been updated to use explicit Optional type hints. Additionally, the pyproject.toml file removes a global strict setting for mypy, adds module-specific error overrides, and extends the ruff linter’s selection criteria.

Changes

Files Change Summary
.pre-commit-config.yaml Modified the mypy hook: removed --ignore-missing-imports, --implicit-optional, and --show-error-codes; added types-setuptools to additional_dependencies.
holidays/.../malaysia.py Changed from datetime import date to a conditional import wrapped in an if TYPE_CHECKING: block.
holidays/.../taiwan.py, holidays/.../holiday_base.py, holidays/.../observed_holiday_base.py Updated method/constructor signatures by adding Optional type hints to parameters (rule, target_date, observed_rule, and observed_since).
pyproject.toml Removed strict = false from mypy config; added module-specific overrides for holidays.countries.* and holidays.groups.* to disable certain error codes; updated ruff’s select list to include TC.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between df044df and f17b403.

📒 Files selected for processing (6)
  • .pre-commit-config.yaml (1 hunks)
  • holidays/countries/malaysia.py (1 hunks)
  • holidays/countries/taiwan.py (2 hunks)
  • holidays/holiday_base.py (1 hunks)
  • holidays/observed_holiday_base.py (1 hunks)
  • pyproject.toml (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
holidays/countries/taiwan.py (1)
holidays/observed_holiday_base.py (1)
  • ObservedRule (20-24)
⏰ Context from checks skipped due to timeout of 300000ms (1)
  • GitHub Check: Test Python 3.12 on windows-latest
🔇 Additional comments (8)
holidays/countries/malaysia.py (1)

13-16: Good use of TYPE_CHECKING for imports.

Making the date import conditional on type checking is a good practice to avoid potential circular imports while maintaining proper type hints for static analysis. The pragma: no cover comment correctly excludes this from coverage metrics.

.pre-commit-config.yaml (1)

61-61: Adding types-setuptools improves type coverage.

Adding the types-setuptools package to the mypy dependencies will provide better type checking support for code that interacts with the setuptools library.

holidays/holiday_base.py (1)

1043-1043: Improved type clarity with Optional.

Using Optional[DateLike] instead of just DateLike with a None default explicitly clarifies that this parameter can be None, improving type checking and code readability.

holidays/countries/taiwan.py (2)

15-15: Good import of Optional type.

Adding the import for Optional from the typing module supports the type annotation changes in this file.

90-90: Enhanced type annotation with Optional.

Updating the parameter annotation to use Optional[ObservedRule] instead of implicitly allowing None improves type clarity and helps static analysis tools better understand the code.

holidays/observed_holiday_base.py (1)

108-109: Good enhancement to type annotations

Adding the Optional type hint for parameters with None default values is a positive improvement for type clarity. This change aligns perfectly with type-checking best practices and will help catch potential type errors during static analysis.

pyproject.toml (2)

59-65: Good approach to module-specific type checking

The introduction of targeted mypy overrides for specific modules provides more granular type checking control. Disabling specific error codes like "override" for country modules and "attr-defined" for group modules is a sensible approach that avoids excessive noise while maintaining type safety where it matters most.

72-72: Good addition of TC category to Ruff selections

Adding the TC (type-checking) category to Ruff's selection criteria is exactly what was needed to fulfill the PR objectives. This will ensure consistent type validation across the codebase and complements the mypy configuration changes.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

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.

@sonarqubecloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@codecov
Copy link

codecov bot commented Apr 12, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (df044df) to head (f17b403).
Report is 1 commits behind head on dev.

Additional details and impacted files 
@@            Coverage Diff            @@
##               dev     #2464   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          210       210           
  Lines        13351     13352    +1     
  Branches      1911      1911           
=========================================
+ Hits         13351     13352    +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

PPsyrius
PPsyrius approved these changes Apr 12, 2025
View reviewed changes
Copy link
Collaborator

@PPsyrius PPsyrius left a comment

Choose a reason for hiding this comment

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

LGTM 🛠️

@arkid15r arkid15r added this pull request to the merge queue Apr 12, 2025
Merged via the queue into vacanza:dev with commit 1448815 Apr 12, 2025
33 checks passed
@arkid15r arkid15r deleted the type-checking branch April 12, 2025 05:23
@KJhellico KJhellico mentioned this pull request Apr 21, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Sep 20, 2025
Merged
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@PPsyrius PPsyrius PPsyrius approved these changes

@KJhellico KJhellico Awaiting requested review from KJhellico KJhellico is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@arkid15r @PPsyrius