What is the link between source roots and BUILD files Only d Pants #general

What is the link between source roots and BUILD fi...

quaint-gold-40000

07/22/2021, 2:30 PM

What is the link between source roots and BUILD files? Only directories that match a source root will be scanned for a BUILD file?

quaint-gold-40000

07/22/2021, 2:41 PM

So this setup won't work properly?

Copy code

application/
  BUILD
  pyroject.toml
  app.py
library/
  BUILD
  pyproject.toml
  src/
    __init__.py
    module.py

For library, the BUILD needs to be at the same level of pyproject.toml. Therefore, it can't be at the same level as the actual source files.

fresh-cat-90827

07/22/2021, 2:48 PM

unless I misunderstand your needs, you don’t have to put

BUILD

in the

src

directory — it can be where it is now.

fresh-cat-90827

07/22/2021, 2:49 PM

https://github.com/pantsbuild/pants/issues/12195#issuecomment-859598247 may be useful, sorry if isn’t — I asked a question about the layout

❤️ 1

witty-crayon-22786

07/22/2021, 3:54 PM

see https://www.pantsbuild.org/docs/source-roots for more information: but you can think of a source root as similar to a PYTHONPATH entry

witty-crayon-22786

07/22/2021, 3:54 PM

it’s the portion of the filepath that is chopped off, while the rest of the path is used as the module name

witty-crayon-22786

07/22/2021, 5:10 PM

but also, you can absolutely create more than one

BUILD

file: we recommend using the

./pants tailer

goal to maintain most of your

BUILD

files: https://www.pantsbuild.org/v2.6/docs/create-initial-build-files

quaint-gold-40000

07/26/2021, 10:11 AM

So there is no link between source roots and BUILD files then?

witty-crayon-22786

07/26/2021, 3:52 PM

no, there shouldn’t be. see the source_roots page linked above for more information on how to create source roots: via filename patterns, marker files, etc

Open in Slack

Previous Next