Ignoring pyproject.toml

[smutch]

Question

Is there any way to tell hatch to ignore a pyproject.toml and only use hatch.toml?

Motivation

I've been enjoying using a hatch.toml file to define isolated environments and associated scripts for projects where I am not creating a python package (e.g. exploratory data science work). The problem I am running into is when I want to configure black or some other tool that uses a pyproject.toml file. The presence of the pyproject.toml means that hatch tries to use it and produces a bunch of errors.

[ofek]

What are the errors?

[smutch]

A minimal example is:

hatch.toml

[envs.default]
dependencies = [
    "numpy"
]

[envs.default.scripts]
hello = "python -c 'import numpy; print(numpy.__version__)'"

pyproject.toml

[project]
name = "test"

[tool.black]
line-length = 88

If I do hatch run hello then I get the following error:

  error: subprocess-exited-with-error

  × Getting requirements to build editable did not run successfully.
  │ exit code: 1
  ╰─> [42 lines of output]
      Traceback (most recent call last):
        File "/Users/smutch/Library/Application Support/hatch/env/virtual/test/pA7dQpb9/test/lib/python3.11/site-packages/pip/_vendor/pep517/in_process/_in_process.py", line 351, i
n <module>
          main()
        File "/Users/smutch/Library/Application Support/hatch/env/virtual/test/pA7dQpb9/test/lib/python3.11/site-packages/pip/_vendor/pep517/in_process/_in_process.py", line 333, i
n main
          json_out['return_val'] = hook(**hook_input['kwargs'])
                                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "/Users/smutch/Library/Application Support/hatch/env/virtual/test/pA7dQpb9/test/lib/python3.11/site-packages/pip/_vendor/pep517/in_process/_in_process.py", line 132, i
n get_requires_for_build_editable
          return hook(config_settings)
                 ^^^^^^^^^^^^^^^^^^^^^
        File "/private/var/folders/t7/hq9n1m110kx6jckgpkr2mcp40000gn/T/pip-build-env-h1i_u6qi/overlay/lib/python3.11/site-packages/setuptools/build_meta.py", line 450, in get_requi
res_for_build_editable
          return self.get_requires_for_build_wheel(config_settings)
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "/private/var/folders/t7/hq9n1m110kx6jckgpkr2mcp40000gn/T/pip-build-env-h1i_u6qi/overlay/lib/python3.11/site-packages/setuptools/build_meta.py", line 341, in get_requi
res_for_build_wheel
          return self._get_build_requires(config_settings, requirements=['wheel'])
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "/private/var/folders/t7/hq9n1m110kx6jckgpkr2mcp40000gn/T/pip-build-env-h1i_u6qi/overlay/lib/python3.11/site-packages/setuptools/build_meta.py", line 323, in _get_buil
d_requires
          self.run_setup()
        File "/private/var/folders/t7/hq9n1m110kx6jckgpkr2mcp40000gn/T/pip-build-env-h1i_u6qi/overlay/lib/python3.11/site-packages/setuptools/build_meta.py", line 488, in run_setup
          self).run_setup(setup_script=setup_script)
                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "/private/var/folders/t7/hq9n1m110kx6jckgpkr2mcp40000gn/T/pip-build-env-h1i_u6qi/overlay/lib/python3.11/site-packages/setuptools/build_meta.py", line 338, in run_setup
          exec(code, locals())
        File "<string>", line 1, in <module>
        File "/private/var/folders/t7/hq9n1m110kx6jckgpkr2mcp40000gn/T/pip-build-env-h1i_u6qi/overlay/lib/python3.11/site-packages/setuptools/__init__.py", line 107, in setup
          return distutils.core.setup(**attrs)
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "/private/var/folders/t7/hq9n1m110kx6jckgpkr2mcp40000gn/T/pip-build-env-h1i_u6qi/overlay/lib/python3.11/site-packages/setuptools/_distutils/core.py", line 159, in setu
p
          dist.parse_config_files()
        File "/Users/smutch/Library/Application Support/hatch/env/virtual/test/pA7dQpb9/test/lib/python3.11/site-packages/_virtualenv.py", line 21, in parse_config_files
          result = old_parse_config_files(self, *args, **kwargs)
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "/private/var/folders/t7/hq9n1m110kx6jckgpkr2mcp40000gn/T/pip-build-env-h1i_u6qi/overlay/lib/python3.11/site-packages/setuptools/dist.py", line 898, in parse_config_fi
les
          pyprojecttoml.apply_configuration(self, filename, ignore_option_errors)
        File "/private/var/folders/t7/hq9n1m110kx6jckgpkr2mcp40000gn/T/pip-build-env-h1i_u6qi/overlay/lib/python3.11/site-packages/setuptools/config/pyprojecttoml.py", line 66, in
apply_configuration
          config = read_configuration(filepath, True, ignore_option_errors, dist)
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "/private/var/folders/t7/hq9n1m110kx6jckgpkr2mcp40000gn/T/pip-build-env-h1i_u6qi/overlay/lib/python3.11/site-packages/setuptools/config/pyprojecttoml.py", line 128, in
 read_configuration
          validate(subset, filepath)
        File "/private/var/folders/t7/hq9n1m110kx6jckgpkr2mcp40000gn/T/pip-build-env-h1i_u6qi/overlay/lib/python3.11/site-packages/setuptools/config/pyprojecttoml.py", line 55, in
validate
          raise ValueError(f"{error}\n{summary}") from None
      ValueError: invalid pyproject.toml config: `project`.
      configuration error: `project` must contain ['version'] properties
      [end of output]

  note: This error originates from a subprocess, and is likely not a problem with pip.
error: subprocess-exited-with-error

× Getting requirements to build editable did not run successfully.
│ exit code: 1
╰─> See above for output.

note: This error originates from a subprocess, and is likely not a problem with pip.

If I remove the environment, add a version entry to the project section of pyproject.toml and then try hatch run hello again I get:

  error: subprocess-exited-with-error

  × Getting requirements to build editable did not run successfully.
  │ exit code: 1
  ╰─> [14 lines of output]
      error: Multiple top-level packages discovered in a flat-layout: ['data', 'notebooks'].

      To avoid accidental inclusion of unwanted files or directories,
      setuptools will not proceed with this build.

      If you are trying to create a single distribution with multiple packages
      on purpose, you should not rely on automatic discovery.
      Instead, consider the following options:

      1. set up custom discovery (`find` directive with `include` or `exclude`)
      2. use a `src-layout`
      3. explicitly set `py_modules` or `packages` with a list of names

      To find more information, look for "package discovery" on setuptools docs.
      [end of output]

  note: This error originates from a subprocess, and is likely not a problem with pip.
error: subprocess-exited-with-error

× Getting requirements to build editable did not run successfully.
│ exit code: 1
╰─> See above for output.

note: This error originates from a subprocess, and is likely not a problem with pip.

It looks like the presence of a pyproject.toml is triggering a build even if there is no [build-system] section. This may be expected and deliberate though?

(p.s. Thanks for your work with hatch. It's a great tool for the community. I'm really enjoying it and slowly convincing some of my colleagues to switch to it too. :))

[ofek]

You'll want one of these:

• https://hatch.pypa.io/latest/config/environment/overview/#detached-environments
• https://hatch.pypa.io/latest/config/environment/overview/#skip-install

(p.s. Thanks for your work with hatch. It's a great tool for the community. I'm really enjoying it and slowly convincing some of my colleagues to switch to it too. :))

Thanks for the kind words and let me know how that goes!

[smutch]

That works perfectly. Thanks for this. I completely missed it in the documentation!