Skip to content

WIP: Enable mypy for code examples#947

Open
sergei-encord wants to merge 6 commits intomasterfrom
enable-mypy-for-code-examples
Open

WIP: Enable mypy for code examples#947
sergei-encord wants to merge 6 commits intomasterfrom
enable-mypy-for-code-examples

Conversation

@sergei-encord
Copy link
Contributor

No description provided.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Summary of Changes

Hello @sergei-encord, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request, marked as a Work In Progress, introduces static type checking for Python code examples. By integrating mypy via a new pre-commit hook, the aim is to enhance the reliability and maintainability of the documentation's code snippets by catching potential type-related errors early in the development cycle.

Highlights

  • Type Checking Configuration: A new mypy-docs pre-commit hook has been added to .pre-commit-config.yaml. This hook is configured to run mypy specifically on Python files located within the tests/docs/ directory, ensuring type correctness for code examples.
  • Code Example Formatting: A minor formatting change was applied to tests/docs/export_labels_all_attributes.py by adding a blank line, likely to conform to linting rules or improve readability.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@github-actions
Copy link
Contributor

github-actions bot commented Jul 3, 2025

Unit test report (Python 3.8.18, Pydantic 2.10.6)

255 tests  ±0   255 ✅ ±0   9s ⏱️ -1s
  1 suites ±0     0 💤 ±0 
  1 files   ±0     0 ❌ ±0 

Results for commit 7ed78d1. ± Comparison against base commit 2951131.

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Contributor

github-actions bot commented Jul 3, 2025

Unit test report (Python 3.8.18, Pydantic 1.10.22)

255 tests  ±0   255 ✅ ±0   9s ⏱️ -1s
  1 suites ±0     0 💤 ±0 
  1 files   ±0     0 ❌ ±0 

Results for commit 7ed78d1. ± Comparison against base commit 2951131.

♻️ This comment has been updated with latest results.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request enables mypy checks for code examples in the tests/docs/ directory by adding a new hook to the .pre-commit-config.yaml file. The review focuses on the correctness of the file regex.

@github-actions
Copy link
Contributor

github-actions bot commented Jul 3, 2025

SDK integration test report

  1 files  ±0    1 suites  ±0   21m 22s ⏱️ - 3m 53s
281 tests ±0  278 ✅ +6  1 💤 ±0  1 ❌ +1  1 🔥  - 7 
281 runs   - 1  278 ✅ +7  1 💤 ±0  1 ❌ ±0  1 🔥  - 8 

For more details on these failures and errors, see this check.

Results for commit 7ed78d1. ± Comparison against base commit 2951131.

♻️ This comment has been updated with latest results.

@encord-team encord-team deleted a comment from gemini-code-assist bot Jul 3, 2025
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.

1 participant