Add `pyright` configuration file #225

omertuc · 2025-07-11T09:08:24Z

Description

pyright can be used as a language server for Python.

Tell pyright where to find the source files, so it can resolve imports correctly

Type of change

Related Tickets & Documents

Related Issue #
Closes #

Checklist before requesting a review

I have performed a self-review of my code.
PR has passed all pre-merge test jobs.
If it is a core feature, I have added thorough tests.

Testing

Please provide detailed steps to perform tests related to this code change.
How were the fix/results from this change verified? Please provide relevant screenshots or results.

Pyright works better

Summary by CodeRabbit

Chores
- Updated configuration to improve static type checking coverage.

coderabbitai · 2025-07-11T09:08:29Z

Walkthrough

The Pyright configuration in the pyproject.toml file was updated to include an extraPaths entry pointing to the ./src directory. This change directs Pyright to consider this directory during static type checking. No other configuration or code changes were made.

Changes

File	Change Summary
pyproject.toml	Added `extraPaths = ["./src"]` to Pyright config

Poem

In the warren where code does hop,
Pyright now knows where to stop—
With ./src in its sight,
Type checks are just right,
Our code garden grows, tip-top! 🥕

📜 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 a166b68 and d44e3c6.

📒 Files selected for processing (1)

pyproject.toml (1 hunks)

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

pyproject.toml

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: build-pr

🪧 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

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

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

pyrightconfig.json (1)
1-3: Consider expanding the minimal config for clarity & future-proofing

A single extraPaths entry works, but Pyright will default to analyzing every file under the repo unless told otherwise. Adding an explicit include (and optionally an exclude) list makes the intent clearer, speeds up analysis, and avoids editors mistakenly type-checking irrelevant folders (e.g. dist, .venv, or generated code).

Example patch:
 {
+  // Folders to be type-checked
+  "include": ["./src"],
+
   "extraPaths": ["./src"]
+  // "exclude": ["./dist", "./.venv", "**/__pycache__"]
 }
Optional but recommended.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b69c20b and 368fbe1.

📒 Files selected for processing (1)

pyrightconfig.json (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: build-pr

tisnik

we can use [tool.pyright] section in pyproject.toml

with this change, the new file take precedence, so the "older" settings is not used -> cause CI failure

`pyright` can be used as a language server for Python. Tell `pyright` where to find the source files, so it can resolve imports correctly.

omertuc · 2025-07-11T09:16:43Z

Ah didn't see you have that. Updated

tisnik

LGTM, thank you

coderabbitai bot reviewed Jul 11, 2025

View reviewed changes

omertuc force-pushed the pyright branch from 368fbe1 to a166b68 Compare July 11, 2025 09:10

tisnik reviewed Jul 11, 2025

View reviewed changes

Add pyright configuration file

d44e3c6

`pyright` can be used as a language server for Python. Tell `pyright` where to find the source files, so it can resolve imports correctly.

omertuc force-pushed the pyright branch from a166b68 to d44e3c6 Compare July 11, 2025 09:16

tisnik approved these changes Jul 11, 2025

View reviewed changes

tisnik merged commit 54dee42 into lightspeed-core:main Jul 11, 2025
17 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add `pyright` configuration file #225

Add `pyright` configuration file #225

Uh oh!

omertuc commented Jul 11, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 11, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

tisnik left a comment •

edited

Loading

Uh oh!

omertuc commented Jul 11, 2025

Uh oh!

tisnik left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Add pyright configuration file #225

Add pyright configuration file #225

Uh oh!

Conversation

omertuc commented Jul 11, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

Related Tickets & Documents

Checklist before requesting a review

Testing

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

tisnik left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

omertuc commented Jul 11, 2025

Uh oh!

tisnik left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Add `pyright` configuration file #225

Add `pyright` configuration file #225

omertuc commented Jul 11, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 11, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

tisnik left a comment •

edited

Loading