Update Pyright configuration

Oct 13, 2025 by magicalceylontours.com 97 views

Introduction

Pyright, a static type checker for Python, is unable to resolve the import of a namespace package that shares a prefix with a module in the current directory (VS Code workspace root). This issue arises when working with namespace packages, which are a type of package that can be extended by other packages. In this article, we will explore the problem, provide a minimal reproducible example, and discuss possible solutions.

Describe the bug

Pyright cannot resolve the import of a namespace package that shares a prefix with a module in the current directory (VS Code workspace root). The error message is as follows:

Import "common.logging" could not be resolved Pyright (reportMissingImports)

Background

We store much of our shared code in a common module that exists in the root of our repository. However, we are migrating to namespace packages (here, called common-logging under libs/). Both will exist during the transition.

.
├── common
│   ├── __init__.py
│   └── database.py
├── jobs
│   └── job.py
└── libs
    └── common-logging
        ├── common
        │   └── logging
        │       └── __init__.py
        └── pyproject.toml

Code or Screenshots

I've created a repository with the minimal setup to reproduce this error. Here's how to set it up:

git clone https://github.com/BrunoGrandePhD/pyright-import-error.git
cd pyright-import-error

python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -e libs/common-logging

code .  # And then open jobs/job.py in VS Code to see the error

You should be able to run the jobs/job.py script without an error:

$ PYTHONPATH=$(pwd) python3 jobs/job.py

Hello from /Users/username/Desktop/vscode-import-test/libs/common-logging/common/logging/__init__.py
Hello from /Users/username/Desktop/vscode-import-test/common/database.py

However, in VS Code, the common.logging import cannot get resolved by Pyright:

VS Code extension or command-line

I originally ran into this issue using Pylance language server, but I confirmed that it originates in Pyright.

Possible solutions

Update Pyright configuration: You can try updating the Pyright configuration to include the common-logging package. This can be done by adding the following configuration to your pyrightconfig.json file:

"pythonPath" ["${workspaceFolder"], "typeCheck": "useLibraryCodeForTypes" true, "reportMissingImports": true , "typeCheckingMode": "basic", "diagnosticMode": "basic", "plugins": "common-logging" { "path": "${workspaceFolder/libs/common-logging" } } }


    2.  **Use a different import**: If the above solution does not work, you can try using a different import statement. For example, instead of importing `common.logging`, you can import `common_logging.common.logging`.

    ```python
import common_logging.common.logging as logging

3.  **Disable reportMissingImports**: If none of the above solutions work, you can try disabling the `reportMissingImports` feature in Pyright. This can be done by adding the following configuration to your `pyrightconfig.json` file:

```json

"typeCheck" { "reportMissingImports": false }


    Note that disabling this feature may lead to incorrect type checking and may not be suitable for all projects.

**Conclusion**
----------

In conclusion, Pyright cannot resolve the import of a namespace package that shares a prefix with a module in the current directory (VS Code workspace root). This issue arises when working with namespace packages, which are a type of package that can be extended by other packages. We have discussed possible solutions, including updating Pyright configuration, using a different import statement, and disabling the `reportMissingImports` feature. By following these solutions, you should be able to resolve the issue and continue working with Pyright.

**References**
--------------

*   [Pyright documentation](https://github.com/microsoft/pyright)
*   [Namespace packages in Python](https://packaging.python.org/en/latest/guides/packaging-namespace-packages/)
*   [VS Code documentation](https://code.visualstudio.com/docs)<br/>
**reportMissingImports for namespace package that shares prefix with local module: Q&A**
=====================================================================================

**Introduction**
---------------

In our previous article, we discussed the issue of Pyright not being able to resolve the import of a namespace package that shares a prefix with a module in the current directory (VS Code workspace root). We also provided possible solutions to this issue. In this article, we will answer some frequently asked questions related to this topic.

**Q: What is a namespace package?**
-----------------------------------

A: A namespace package is a type of package that can be extended by other packages. It is a way to organize related packages and modules in a way that makes it easy to share code and dependencies.

**Q: Why do I get the "reportMissingImports" error in Pyright?**
---------------------------------------------------------

A: The "reportMissingImports" error in Pyright occurs when the language server is unable to resolve the import of a namespace package that shares a prefix with a module in the current directory (VS Code workspace root). This can happen when working with namespace packages, which are a type of package that can be extended by other packages.

**Q: How do I fix the "reportMissingImports" error in Pyright?**
---------------------------------------------------------

A: There are several ways to fix the "reportMissingImports" error in Pyright. You can try updating the Pyright configuration to include the namespace package, using a different import statement, or disabling the "reportMissingImports" feature.

**Q: What is the difference between a namespace package and a regular package?**
--------------------------------------------------------------------------------

A: A namespace package is a type of package that can be extended by other packages. It is a way to organize related packages and modules in a way that makes it easy to share code and dependencies. A regular package, on the other hand, is a self-contained package that does not allow other packages to extend it.

**Q: Can I use a namespace package with Pyright?**
------------------------------------------------

A: Yes, you can use a namespace package with Pyright. However, you may need to update the Pyright configuration to include the namespace package and resolve any import issues.

**Q: How do I update the Pyright configuration to include a namespace package?**
--------------------------------------------------------------------------------

A: To update the Pyright configuration to include a namespace package, you can add the following configuration to your `pyrightconfig.json` file:

```json
{
    "pythonPath": ["${workspaceFolder}"],
    "typeCheck": {
        "useLibraryCodeForTypes": true,
        "reportMissingImports": true
    },
    "typeCheckingMode": "basic",
    "diagnosticMode": "basic",
    "plugins": {
        "common-logging": {
            "path": "${workspaceFolder}/libs/common-logging"
        }
    }
}

Q: Can I use a different import statement to resolve the "reportMissingImports" error?

A: Yes, you can use a different import statement to resolve the "reportMissingImports" error. For example, instead of importing common.logging, you can import common_logging.common.logging.

import common_logging.common.logging as logging

Q: How do I disable the "reportMissingImports" feature in Pyright?

A: To disable the "reportMissingImports" feature in Pyright, you can add the following configuration to your pyrightconfig.json file:

{
    "typeCheck": {
        "reportMissingImports": false
    }
}

Conclusion

In conclusion, the "reportMissingImports" error in Pyright occurs when the language server is unable to resolve the import of a namespace package that shares a prefix with a module in the current directory (VS Code workspace root). We have answered some frequently asked questions related to this topic and provided possible solutions to this issue. By following these solutions, you should be able to resolve the issue and continue working with Pyright.