Monorepo configuration?

[tamis-laan]

I am using uv workspaces and have:

/pyproject.toml
/services/app/pyproject.toml

However pyrefly can't deal with the submodules in /services/app/ it only reasons from /, how do I configure this properly?

[yangdanny97]

Hi! I believe this is a use case for sub-configs (see https://pyrefly.org/en/docs/configuration/#sub-configs).

Are you saying relative imports between two modules in /services/app/ don't work as expected? A bit more detail or a minimal example could be really helpful for us to understand what's happening

@connernilsen may be able to help more here

[tamis-laan]

Well I have:

/pyproject.toml
/services/app/pyproject.toml
/services/app/app/common/globals.py
/services/app/app/main.py

inside main.py I have:

from common import globals

Pyrefly says something like unknown module common. Or no globals inside common. The code runs perfectly fine.

I think Pyrefly only detects /pyproject.toml but not /services/app/pyproject.toml meaning it's looking for common inside /. IK don't know if I need to configure this explicitly but I would expect Pyrefly to detect this automatically like any other python lsp server.

[tamis-laan]

Ah I have figured it out I added the following to the root pyproject.toml:

[tool.pyrefly]
search_path = [
	"services/app",
]

This path should be picked up automatically however by the autodiscovery

[yangdanny97]

Glad you were able to figure out how to make it work! We'll see what we can do to make it work out of the box in the future.

[tamis-laan]

Yeah that would be great because now every service in a monorepo needs to be added by hand.

[connernilsen]

Hey @tamis-laan, glad you were able to find a fix!

I recently changed config finding to treat pyproject.toml files without a [tool.pyrefly] section as lower-priority than pyproject.toml (or pyrefly.toml) with the section, even in parent directories. If you want the /services/app/pyproject.toml to be used as your config for that sub-directory, then just drop in a [tool.pyrefly] section with any other settings you need.

Pyrefly should recognize that as the import root, so search-path = ... shouldn't be needed, unless you need other import roots.

[tamis-laan]

@connernilsen

Well I have multiple projects inside one repository right, so:

/pyproject.toml
/services/service1/pyproject.toml
/services/service2/pyproject.toml
/services/service3/pyproject.toml
/packages/package1/pyproject.toml
/packages/package2/pyproject.toml
/packages/package3/pyproject.toml
/tools/tool1/pyproject.toml
/tools/tool2/pyproject.toml
/tools/tool3/pyproject.toml

These are managed by the uv package manager as what are called workspaces using a pyproject.toml in the root directory and for each service/package or tool a pyproject.toml inside there respective sub directory.

This workspace feature for monorepos are also used by rust cargo and for example npm.

Now I think the best strategy for pyrefly would be:

1. Like you said it detects the root package definition for example /pyproject.toml here pyrefly settings can be set under [tool.pyrefly].
2. If any other pyproject.toml files are found in sub directories then those are seen as sub packages or projects and those sub directories are added to the search_path automatically.

This way no manual setup is required for mono repositories.