[ADD] setup: pep518 support

[sbidoul]

This is a non-intrusive solution for #16700, that leverages the PEP 517 build backend interface, so pip install . and pip wheel . work out of the box for Odoo.

[sbidoul]

@d-fence

[sbidoul]

@d-fence have had a chance to think about this one?

[d-fence]

I think that the idea is really attractive but it seems that setuptools 41 is needed.
We try to stick to the Debian stable release (stretch for Odoo 12.0) which provides only 33.
The same idea applies to the included packaging script that uses a Dockerfile corresponding to the current Debian version at the time of the release. I'm afraid that this PR could break the actual packaging system.
We could merge that into master when bullseye become stable.

[sbidoul]

@d-fence thanks for looking into this.

Actually the setuptools 41 requirement is the one that has the build_meta PEP 517 API, but it is not needed to run Odoo.

When running pip install . or pip wheel . with a pip version that supports PEP 517, pip will download the build requirements from PyPI in an isolated environment to run the build.

So this should be safe to merge, independently of the distro version for pip and setuptools.

[sbidoul]

@d-fence would you consider this for v14?

[d-fence]

Debian buster only provides setup-tools 40.
41 is needed as I read.

[sbidoul]

But as I mentioned above, this is not needed at runtime nor for debian packaging. And even on buster pip install will download the required setuptools version from PyPI.

[sbidoul]

@d-fence do you thing this can be considered for v15 ?
What are your remaining concerns ?
If you agree to go ahead I'll do a new pass on this and polish the PR.

[rousseldenis]

Works like a charm.

Tested on master, so @sbidoul maybe would be accepted more easily on that branch ?

[sbidoul]

@rousseldenis I'll be more than happy to rebase and improve this if/when someone at Odoo acknowledges it will be considered for inclusion.

[d-fence]

I have to test it further and yes it would be better to target master.

[sbidoul]

@d-fence thanks for reaching back ! I'll rebase on master.

I think its no risk for stable though. Let me know if there are specific tests you have in mind, I'm happy to do them too.

[d-fence]

I want to be sure that it won't clash with our build system and, even better, that it could integrate with our build system.
As you saw, It's not a priority but I'll try to test that soon.

[sbidoul]

You may want to test building the sdist (and why not a wheel), with PyPA build.

[simahawk]

@d-fence any update?

[sbidoul]

I cleaned-up and modernized the code, and made it more robust.

[sbidoul]

@d-fence any chance this can be considered for v16 ? I retargeted this branch to master.

[rousseldenis]

@d-fence gentle reminder. Thanks

[yajo]

I'm getting plenty of warnings like this when building Odoo with this PR enabled:

python3.8-odoo>  SetuptoolsDeprecationWarning:     Installing 'odoo.tools.data.files' as data is deprecated, please list it in `packages`.
python3.8-odoo>       !!
python3.8-odoo>       ############################
python3.8-odoo>       # Package would be ignored #
python3.8-odoo>       ############################
python3.8-odoo>       Python recognizes 'odoo.tools.data.files' as an importable package,
python3.8-odoo>       but it is not listed in the `packages` configuration of setuptools.
python3.8-odoo>       'odoo.tools.data.files' has been automatically added to the distribution only
python3.8-odoo>       because it may contain data files, but this behavior is likely to change
python3.8-odoo>       in future versions of setuptools (and therefore is considered deprecated).
python3.8-odoo>       Please make sure that 'odoo.tools.data.files' is included as a package by using
python3.8-odoo>       the `packages` configuration field or the proper discovery methods
python3.8-odoo>       (for example by using `find_namespace_packages(...)`/`find_namespace:`
python3.8-odoo>       instead of `find_packages(...)`/`find:`).
python3.8-odoo>       You can read more about "package discovery" and "data files" on setuptools
python3.8-odoo>       documentation page.
python3.8-odoo>   !!
python3.8-odoo>     check.warn(importable)
python3.8-odoo>   Building wheel for odoo (pyproject.toml) ... done

Should you add some method to find packages that is more future-proof? 🤔

[sbidoul]

@yajo these are setuptools deprecation warnings that are not directly related to this PR.
They appear when you do a python setup.py bdist_wheel too.
So that would need a separate PR to update setup.py.

[KangOl]

We should not unlink existing symlink

[sbidoul]

@KangOl thanks for your review! I updated and rebased on 17 as requested.
pylint complains on the import * but I think it's the right way to do in this case, as not all setuptools versions implement the same build hooks.

[yajo]

Here's the patch for Odoo 16, for those that still need it there.

[sbidoul]

@KangOl @d-fence gentle nudge here.

[sbidoul]

@KangOl @d-fence this PR is becoming more pressing. Indeed there are more and more situations where pip defaults to doing a PEP 660 editable install which triggers a setuptools installation mode that is not compatible with Odoo. It is therefore important to force the compat editable mode, as this PR does.

Pretty please 🙏