[DX] make mypy run in the IDE (VSCode)

[mikeldking]

Right now because of the sub-moduling, mypy (and ruff?) fail to run via IDE plugins. This is critical for fast development flow.

[dosubot]

🤖

Hey @mikeldking! Great to see you back here, diving into the depths of code with us. How's the coding universe treating you?

To configure mypy to run in your VSCode IDE, you can follow these steps:

1. Install the mypy extension for VSCode. You can do this by searching for "mypy" in the Extensions view (Ctrl+Shift+X) and installing the one by "matangover".

2. Configure the mypy extension to use your mypy.ini file. To do this, open your settings.json file (File > Preferences > Settings, then search for "settings.json" and click on "Edit in settings.json"). Add the following lines:

"python.linting.mypyEnabled": true,
"python.linting.mypyArgs": [
    "--config-file=${workspaceFolder}/python/mypy.ini"
],

This tells the mypy extension to enable linting and to use your mypy.ini file for its configuration.

3. Save your settings.json file and restart VSCode. Now, mypy should run automatically in your IDE using the configuration from your mypy.ini file.

Please note that the path to the mypy.ini file in the "config-file" argument should be adjusted if your mypy.ini file is located in a different directory. The "${workspaceFolder}" variable refers to the root directory of your current workspace.

As for the sub-moduling, the OpenInference codebase, specifically the openinference-instrumentation-openai package, contains several sub-modules. These include the OpenAIInstrumentation class, the InstrumentationNodeModuleDefinition, and several helper functions. The OpenAIInstrumentation class is responsible for initializing the instrumentation, patching and unpatching the OpenAI module. The InstrumentationNodeModuleDefinition is used to define the module that needs to be instrumented. The helper functions are used to handle specific tasks such as checking the type of a response, getting attributes from a request, and getting output attributes from a result.

If you're still having trouble getting mypy to run in your IDE, please provide more details about the issues you're encountering so I can assist you further.

Sources

• python/mypy.ini
• js/packages/openinference-instrumentation-openai/src/instrumentation.ts

About Dosu

This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.