Refactor Python cursor rules for clarity and consistency

[jjasghar]

Consolidate best practices for Python development and AI-friendly coding.

Summary by CodeRabbit

• Tests
  • Expanded type-hint coverage for additional pytest fixtures to improve editor autocompletion and clarity.
• Chores
  • Standardized wording and bullet formatting in internal guidance to improve consistency.
  • No functional or behavioral changes to user-facing features.

[coderabbitai]

Walkthrough

The .cursorrules file under rules/python-cursorrules-prompt-file-best-practices was reformatted for wording and bullet consistency. The only functional change adds MonkeyPatch and MockerFixture to the TYPE_CHECKING import block for test typing; no public API changes.

Changes

Cohort / File(s)	Summary
Cursorrules normalization rules/python-cursorrules-prompt-file-best-practices/.cursorrules	Wording and bullet formatting normalized; sections reflowed. Test typing guidance updated to include MonkeyPatch and MockerFixture in TYPE_CHECKING imports. No exported/public signature changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

• PatrickJS

Poem

I twitch my nose at tidy rules,
Hyphens hop in tidy schools.
Type hints bloom—two fixtures more!
MonkeyPatch, Mocker at the door.
With whiskered pride I stamp and grin. 🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 5875a10 and 675ac9a.

📒 Files selected for processing (1)

• rules/python-cursorrules-prompt-file-best-practices/.cursorrules (1 hunks)

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

• rules/python-cursorrules-prompt-file-best-practices/.cursorrules

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• 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>, please review it.
  • 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.
• 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

• Add @coderabbitai ignore or @coderabbit 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

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

rules/python-cursorrules-prompt-file-best-practices/.cursorrules (2)

3-11: Tighten tooling guidance (uv, Ruff) for precision and applicability.

Minor wording tweaks will better reflect recommended usage and reduce ambiguity (uv manages pyproject/venv/lock; Ruff can be both linter and formatter).

- - Dependency management via https://github.com/astral-sh/uv and virtual environments.
- - Code style consistency using Ruff.
+ - Dependency and environment management via uv (pyproject.toml + uv lock/venv).
+ - Code style with Ruff (enable ruff lint and ruff format).

Optional: consider noting “pyproject.toml-first” layout and pinning Python versions in CI matrices.

---

14-14: Rephrase AI-facing sentence for consistency and neutral voice.

Keeps tone consistent with the rest of the rules and avoids second-person phrasing.

- - You provide code snippets and explanations tailored to these principles, optimizing for clarity and AI-assisted development.
+ - Provide code snippets and explanations aligned with these principles, optimized for clarity and AI-assisted development.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 52dfd59 and 5875a10.

📒 Files selected for processing (1)

• rules/python-cursorrules-prompt-file-best-practices/.cursorrules (1 hunks)

🔇 Additional comments (1)

rules/python-cursorrules-prompt-file-best-practices/.cursorrules (1)

22-29: Add TYPE_CHECKING guard around type-only imports and verify fixture paths

Please ensure you:

• Import TYPE_CHECKING and wrap all private‐module and plugin type imports in an if TYPE_CHECKING: block to avoid pulling in _pytest internals at runtime.
• Prefer public exports when they exist (for example, pytest.MonkeyPatch) and only fall back to _pytest.* if no public alias is available.
• Manually confirm that for your supported pytest version(s) (e.g. 7.x) and pytest-mock version, the typing import paths for these fixtures are correct:
  • CaptureFixture
  • FixtureRequest
  • LogCaptureFixture
  • MonkeyPatch
  • MockerFixture

Example update:

from typing import TYPE_CHECKING

if TYPE_CHECKING:
    # Verify these paths against your pytest and pytest-mock versions
    from _pytest.capture import CaptureFixture
    from _pytest.fixtures import FixtureRequest
    from _pytest.logging import LogCaptureFixture
    from _pytest.monkeypatch import MonkeyPatch
    from pytest_mock.plugin import MockerFixture

Please double-check the latest recommended import paths in the pytest and pytest-mock documentation to ensure your type annotations remain accurate.