MSVSphere Packaging Team
2 months ago
commit
ae6b370c9e
GPG Key ID:
B2B0B9F29E528FE8
@ -0,0 +1,7 @@
|
||||
Copyright 2019 pyproject-rpm-macros contributors
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
@ -0,0 +1,551 @@
|
||||
pyproject RPM macros
|
||||
====================
|
||||
|
||||
These macros allow projects that follow the Python [packaging specifications]
|
||||
to be packaged as RPMs.
|
||||
|
||||
They work for:
|
||||
|
||||
* traditional Setuptools-based projects that use the `setup.py` file,
|
||||
* newer Setuptools-based projects that have a `setup.cfg` file,
|
||||
* general Python projects that use the [PEP 517] `pyproject.toml` file (which allows using any build system, such as setuptools, flit or poetry).
|
||||
|
||||
These macros replace `%py3_build` and `%py3_install`, which only work with `setup.py`.
|
||||
|
||||
[packaging specifications]: https://packaging.python.org/specifications/
|
||||
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
To use these macros, first BuildRequire the devel package for the Python you
|
||||
are building against. In Fedora, that's `python3-devel`.
|
||||
|
||||
BuildRequires: python3-devel
|
||||
|
||||
The macros will be pulled in as a dependency on Fedora and EPEL 9+.
|
||||
In other distributions you need to BuildRequire the macros as well:
|
||||
|
||||
BuildRequires: python3-devel
|
||||
BuildRequires: pyproject-rpm-macros
|
||||
|
||||
Next, you need to generate more build dependencies (of your projects and
|
||||
the macros themselves) by running `%pyproject_buildrequires` in the
|
||||
`%generate_buildrequires` section:
|
||||
|
||||
%generate_buildrequires
|
||||
%pyproject_buildrequires
|
||||
|
||||
This will add build dependencies according to [PEP 517] and [PEP 518].
|
||||
This also adds run-time dependencies by default and
|
||||
can add test-time dependencies, see the section below.
|
||||
If you need more dependencies, such as non-Python libraries, BuildRequire
|
||||
them manually.
|
||||
|
||||
Note that `%generate_buildrequires` may produce error messages `(exit 11)` in
|
||||
the build log. This is expected behavior of BuildRequires generators; see
|
||||
[the Fedora change] for details.
|
||||
|
||||
[the Fedora change]: https://fedoraproject.org/wiki/Changes/DynamicBuildRequires
|
||||
|
||||
Then, build a wheel in `%build` with `%pyproject_wheel`:
|
||||
|
||||
%build
|
||||
%pyproject_wheel
|
||||
|
||||
And install the wheel in `%install` with `%pyproject_install`:
|
||||
|
||||
%install
|
||||
%pyproject_install
|
||||
|
||||
`%pyproject_install` installs all wheels in `pyproject-wheeldir/` located in the root of the source tree.
|
||||
|
||||
|
||||
Adding run-time and test-time dependencies
|
||||
------------------------------------------
|
||||
|
||||
To run tests or import checks in the `%check` section,
|
||||
the package's runtime dependencies need to also be included as build requirements.
|
||||
|
||||
Hence, `%pyproject_buildrequires` also generates runtime dependencies by default.
|
||||
|
||||
For this to work, the project's build system must support the [prepare-metadata-for-build-wheel hook].
|
||||
The popular buildsystems (setuptools, flit, poetry) do support it.
|
||||
|
||||
This behavior can be disabled
|
||||
(e.g. when the project's build system does not support it)
|
||||
using the `-R` flag:
|
||||
|
||||
%generate_buildrequires
|
||||
%pyproject_buildrequires -R
|
||||
|
||||
Alternatively, the runtime dependencies can be obtained by building the wheel and reading the metadata from the built wheel.
|
||||
This can be enabled by using the `-w` flag.
|
||||
Support for building wheels with `%pyproject_buildrequires -w` is **provisional** and the behavior might change.
|
||||
Please subscribe to Fedora's [python-devel list] if you use the option.
|
||||
|
||||
%generate_buildrequires
|
||||
%pyproject_buildrequires -w
|
||||
|
||||
When this is used, the wheel is going to be built at least twice,
|
||||
becasue the `%generate_buildrequires` section runs repeatedly.
|
||||
To avoid accidentally reusing a wheel leaking from a previous (different) build,
|
||||
it cannot be reused between `%generate_buildrequires` rounds.
|
||||
Contrarily to that, rebuilding the wheel again in the `%build` section is redundant
|
||||
and the packager can omit the `%build` section entirely
|
||||
to reuse the wheel built from the last round of `%generate_buildrequires`.
|
||||
Be extra careful when attempting to modify the sources after `%pyproject_buildrequires`,
|
||||
e.g. when running extra commands in the `%build` section:
|
||||
|
||||
%build
|
||||
cython src/wrong.pyx # this is too late with %%pyproject_buildrequires -w
|
||||
%pyproject_wheel
|
||||
|
||||
For projects that specify test requirements using an [`extra`
|
||||
provide](https://packaging.python.org/specifications/core-metadata/#provides-extra-multiple-use),
|
||||
these can be added using the `-x` flag.
|
||||
Multiple extras can be supplied by repeating the flag or as a comma separated list.
|
||||
For example, if upstream suggests installing test dependencies with
|
||||
`pip install mypackage[testing]`, the test deps would be generated by:
|
||||
|
||||
%generate_buildrequires
|
||||
%pyproject_buildrequires -x testing
|
||||
|
||||
For projects that specify test requirements in their [tox] configuration,
|
||||
these can be added using the `-t` flag (default tox environment)
|
||||
or the `-e` flag followed by the tox environment.
|
||||
The default tox environment (such as `py37` assuming the Fedora's Python version is 3.7)
|
||||
is available in the `%{toxenv}` macro.
|
||||
For example, if upstream suggests running the tests on Python 3.7 with `tox -e py37`,
|
||||
the test deps would be generated by:
|
||||
|
||||
%generate_buildrequires
|
||||
%pyproject_buildrequires -t
|
||||
|
||||
If upstream uses a custom derived environment, such as `py37-unit`, use:
|
||||
|
||||
%pyproject_buildrequires -e %{toxenv}-unit
|
||||
|
||||
Or specify more environments if needed:
|
||||
|
||||
%pyproject_buildrequires -e %{toxenv}-unit,%{toxenv}-integration
|
||||
|
||||
The `-e` option redefines `%{toxenv}` for further reuse.
|
||||
Use `%{default_toxenv}` to get the default value.
|
||||
|
||||
The `-t`/`-e` option uses [tox-current-env]'s `--print-deps-to-file` behind the scenes.
|
||||
|
||||
If your package specifies some tox plugins in `tox.requires`,
|
||||
such plugins will be BuildRequired as well.
|
||||
Not all plugins are guaranteed to play well with [tox-current-env],
|
||||
in worst case, patch/sed the requirement out from the tox configuration.
|
||||
|
||||
Note that neither `-x` or `-t` can be used with `-R`,
|
||||
because runtime dependencies are always required for testing.
|
||||
You can only use those options if the build backend supports the [prepare-metadata-for-build-wheel hook],
|
||||
or together with `-w`.
|
||||
|
||||
[tox]: https://tox.readthedocs.io/
|
||||
[tox-current-env]: https://github.com/fedora-python/tox-current-env/
|
||||
[prepare-metadata-for-build-wheel hook]: https://www.python.org/dev/peps/pep-0517/#prepare-metadata-for-build-wheel
|
||||
[python-devel list]: https://lists.fedoraproject.org/archives/list/python-devel@lists.fedoraproject.org/
|
||||
|
||||
Additionally to generated requirements you can supply multiple file names to `%pyproject_buildrequires` macro.
|
||||
Dependencies will be loaded from them:
|
||||
|
||||
%pyproject_buildrequires requirements/tests.in requirements/docs.in requirements/dev.in
|
||||
|
||||
For packages not using build system you can use `-N` to entirely skip automatical
|
||||
generation of requirements and install requirements only from manually specified files.
|
||||
`-N` option implies `-R` and cannot be used in combination with other options mentioned above
|
||||
(`-w`, `-e`, `-t`, `-x`).
|
||||
|
||||
The `%pyproject_buildrequires` macro also accepts the `-r` flag for backward compatibility;
|
||||
it means "include runtime dependencies" which has been the default since version 0-53.
|
||||
|
||||
|
||||
Passing config settings to build backends
|
||||
-----------------------------------------
|
||||
|
||||
The `%pyproject_buildrequires` and `%pyproject_wheel` macros accept a `-C` flag
|
||||
to pass [configuration settings][config_settings] to the build backend.
|
||||
Options take the form of `-C KEY`, `-C KEY=VALUE`, or `-C--option-with-dashes`.
|
||||
Pass `-C` multiple times to specify multiple options.
|
||||
This option is equivalent to pip's `--config-settings` flag.
|
||||
These are passed on to PEP 517 hooks' `config_settings` argument as a Python
|
||||
dictionary.
|
||||
|
||||
The `%pyproject_buildrequires` macro passes these options to the
|
||||
`get_requires_for_build_wheel` and `prepare_metadata_for_build_wheel` hooks.
|
||||
Passing `-C` to `%pyproject_buildrequires` is incompatible with `-N` which does
|
||||
not call these hooks at all.
|
||||
|
||||
The `%pyproject_wheel` macro passes these options to the `build_wheel` hook.
|
||||
|
||||
Consult the project's upstream documentation and/or the corresponding build
|
||||
backend's documentation for more information.
|
||||
Note that some projects don't use config settings at all
|
||||
and other projects may only accept config settings for one of the two steps.
|
||||
|
||||
Note that the current implementation of the macros uses `pip` to build wheels.
|
||||
On some systems (notably on RHEL 9 with Python 3.9),
|
||||
`pip` is too old to understand `--config-settings`.
|
||||
Using the `-C` option for `%pyproject_wheel` (or `%pyproject_buildrequires -w`)
|
||||
is not supported there and will result to an error like:
|
||||
|
||||
Usage:
|
||||
/usr/bin/python3 -m pip wheel [options] <requirement specifier> ...
|
||||
...
|
||||
no such option: --config-settings
|
||||
|
||||
[config_settings]: https://peps.python.org/pep-0517/#config-settings
|
||||
|
||||
|
||||
Running tox based tests
|
||||
-----------------------
|
||||
|
||||
In case you want to run the tests as specified in [tox] configuration,
|
||||
you must use `%pyproject_buildrequires` with `-t` or `-e` as explained above.
|
||||
Then, use the `%tox` macro in `%check`:
|
||||
|
||||
%check
|
||||
%tox
|
||||
|
||||
The macro:
|
||||
|
||||
- Sets environment variables via `%{py3_test_envvars}`, namely:
|
||||
- Always prepends `$PATH` with `%{buildroot}%{_bindir}`
|
||||
- If not defined, sets `$PYTHONPATH` to `%{buildroot}%{python3_sitearch}:%{buildroot}%{python3_sitelib}`
|
||||
- If not defined, sets `$TOX_TESTENV_PASSENV` to `*`
|
||||
- Runs `tox` with `-q` (quiet), `--recreate` and `--current-env` (from [tox-current-env]) flags
|
||||
- Implicitly uses the tox environment name stored in `%{toxenv}` - as overridden by `%pyproject_buildrequires -e`
|
||||
|
||||
By using the `-e` flag, you can use a different tox environment(s):
|
||||
|
||||
%check
|
||||
%tox
|
||||
%if %{with integration_test}
|
||||
%tox -e %{default_toxenv}-integration
|
||||
%endif
|
||||
|
||||
If you wish to provide custom `tox` flags or arguments, add them after `--`:
|
||||
|
||||
%tox -- --flag-for-tox
|
||||
|
||||
If you wish to pass custom `posargs` to tox, use another `--`:
|
||||
|
||||
%tox -- --flag-for-tox -- --flag-for-posargs
|
||||
|
||||
Or (note the two sequential `--`s):
|
||||
|
||||
%tox -- -- --flag-for-posargs
|
||||
|
||||
|
||||
|
||||
Generating the %files section
|
||||
-----------------------------
|
||||
|
||||
To generate the list of files in the `%files` section, you can use `%pyproject_save_files` after the `%pyproject_install` macro.
|
||||
It takes toplevel module names (i.e. the names used with `import` in Python) and stores paths for those modules and metadata for the package (dist-info directory) to a file stored at `%{pyproject_files}`.
|
||||
For example, if a package provides the modules `requests` and `_requests`, write:
|
||||
|
||||
%install
|
||||
%pyproject_install
|
||||
%pyproject_save_files requests _requests
|
||||
|
||||
To add listed files to the `%files` section, use `%files -f %{pyproject_files}`.
|
||||
Note that you still need to add any documentation manually (for now).
|
||||
|
||||
%files -n python3-requests -f %{pyproject_files}
|
||||
%doc README.rst
|
||||
|
||||
You can use globs in the module names if listing them explicitly would be too tedious:
|
||||
|
||||
%install
|
||||
%pyproject_install
|
||||
%pyproject_save_files '*requests'
|
||||
|
||||
In fully automated environments, you can use the `*` glob to include all modules (put it in single quotes to prevent Shell from expanding it). In Fedora however, you should always use a more specific glob to avoid accidentally packaging unwanted files (for example, a top level module named `test`).
|
||||
|
||||
Speaking about automated environments, some files cannot be classified with `%pyproject_save_files`, but it is possible to list all unclassified files by adding a special `+auto` argument.
|
||||
|
||||
%install
|
||||
%pyproject_install
|
||||
%pyproject_save_files '*' +auto
|
||||
|
||||
%files -n python3-requests -f %{pyproject_files}
|
||||
|
||||
However, in Fedora packages, always list executables explicitly to avoid unintended collisions with other packages or accidental missing executables:
|
||||
|
||||
%install
|
||||
%pyproject_install
|
||||
%pyproject_save_files requests _requests
|
||||
|
||||
%files -n python3-requests -f %{pyproject_files}
|
||||
%doc README.rst
|
||||
%{_bindir}/downloader
|
||||
|
||||
`%pyproject_save_files` can automatically mark license files with `%license` macro
|
||||
and language (`*.mo`) files with `%lang` macro and appropriate language code.
|
||||
Only license files declared via [PEP 639] `License-File` field are detected.
|
||||
[PEP 639] is still a draft and can be changed in the future.
|
||||
It is possible to use the `-l` flag to declare that a missing license should
|
||||
terminate the build or `-L` (the default) to explicitly disable this check.
|
||||
Packagers are encouraged to use the `-l` flag when the `%license` file is not manually listed in `%files`
|
||||
to avoid accidentally losing the file in a future version.
|
||||
When the `%license` file is manually listed in `%files`,
|
||||
packagers can use the `-L` flag to ensure future compatibility in case the `-l` behavior eventually becomes a default.
|
||||
|
||||
Note that `%pyproject_save_files` uses data from the [RECORD file](https://www.python.org/dev/peps/pep-0627/).
|
||||
If you wish to rename, remove or otherwise change the installed files of a package
|
||||
*after* `%pyproject_install`, `%pyproject_save_files` might break.
|
||||
If possible, remove/rename such files in `%prep`.
|
||||
If not possible, avoid using `%pyproject_save_files` or edit/replace `%{pyproject_files}`.
|
||||
|
||||
|
||||
Performing an import check on all importable modules
|
||||
----------------------------------------------------
|
||||
|
||||
If the upstream test suite cannot be used during the package build
|
||||
and you use `%pyproject_save_files`,
|
||||
you can benefit from the `%pyproject_check_import` macro.
|
||||
If `%pyproject_save_files` is not used, calling `%pyproject_check_import` will fail.
|
||||
|
||||
When `%pyproject_save_files` is invoked,
|
||||
it creates a list of all valid and public (i.e. not starting with `_`)
|
||||
importable module names found in the package.
|
||||
Each top-level module name matches at least one of the globs provided as an argument to `%pyproject_save_files`.
|
||||
This list is then usable by `%pyproject_check_import` which performs an import check for each listed module.
|
||||
When a module fails to import, the build fails.
|
||||
|
||||
The modules are imported from both installed and buildroot's `%{python3_sitearch}`
|
||||
and `%{python3_sitelib}`, not from the current directory.
|
||||
|
||||
Use the macro in `%check`:
|
||||
|
||||
%check
|
||||
%pyproject_check_import
|
||||
|
||||
By using the `-e` flag, you can exclude module names matching the given glob(s) from the import check
|
||||
(put it in single quotes to prevent Shell from expanding it).
|
||||
The flag can be used repeatedly.
|
||||
For example, to exclude all submodules ending with `config` and all submodules starting with `test`, you can use:
|
||||
|
||||
%pyproject_check_import -e '*.config' -e '*.test*'
|
||||
|
||||
There must be at least one module left for the import check;
|
||||
if, as a result of greedy excluding, no modules are left to check, the check fails.
|
||||
|
||||
When the `-t` flag is used, only top-level modules are checked,
|
||||
qualified module names with a dot (`.`) are excluded.
|
||||
If the modules detected by `%pyproject_save_files` are `requests`, `requests.models`, and `requests.packages`, this will only perform an import of `requests`:
|
||||
|
||||
%pyproject_check_import -t
|
||||
|
||||
The modifying flags should only be used when there is a valid reason for not checking all available modules.
|
||||
The reason should be documented in a comment.
|
||||
|
||||
The `%pyproject_check_import` macro also accepts positional arguments with
|
||||
additional qualified module names to check, useful for example if some modules are installed manually.
|
||||
Note that filtering by `-t`/`-e` also applies to the positional arguments.
|
||||
|
||||
Another macro, `%_pyproject_check_import_allow_no_modules` allows to pass the import check,
|
||||
even if no Python modules are detected in the package.
|
||||
This may be a valid case for packages containing e.g. typing stubs.
|
||||
Don't use this macro in Fedora packages.
|
||||
It's only intended to be used in automated build environments such as Copr.
|
||||
|
||||
|
||||
Generating Extras subpackages
|
||||
-----------------------------
|
||||
|
||||
The `%pyproject_extras_subpkg` macro generates simple subpackage(s)
|
||||
for Python extras.
|
||||
|
||||
The macro should be placed after the base package's `%description` to avoid
|
||||
issues in building the SRPM.
|
||||
|
||||
For example, if the `requests` project's metadata defines the extras
|
||||
`security` and `socks`, the following invocation will generate the subpackage
|
||||
`python3-requests+security` that provides `python3dist(requests[security])`,
|
||||
and a similar one for `socks`.
|
||||
|
||||
%pyproject_extras_subpkg -n python3-requests security socks
|
||||
|
||||
The macro works like `%python_extras_subpkg`,
|
||||
except the `-i`/`-f`/`-F` arguments are optional and discouraged.
|
||||
A filelist written by `%pyproject_install` is used by default.
|
||||
For more information on `%python_extras_subpkg`, see the [Fedora change].
|
||||
|
||||
[Fedora change]: https://fedoraproject.org/wiki/Changes/PythonExtras
|
||||
|
||||
These arguments are still required:
|
||||
|
||||
* -n: name of the “base” package (e.g. python3-requests)
|
||||
* Positional arguments: the extra name(s).
|
||||
Multiple subpackages are generated when multiple names are provided.
|
||||
|
||||
|
||||
Provisional: Declarative Buildsystem (RPM 4.20+)
|
||||
------------------------------------------------
|
||||
|
||||
It is possible to reduce some of the spec boilerplate by using the provided
|
||||
pyproject [declarative buildsystem].
|
||||
This option is only available with RPM 4.20+ (e.g. in Fedora 41+).
|
||||
The declarative buildsystem is **provisional** and the behavior might change.
|
||||
Please subscribe to Fedora's [python-devel list] if you use the feature.
|
||||
|
||||
To enable the pyproject declarative buildsystem, use the following:
|
||||
|
||||
BuildSystem: pyproject
|
||||
BuildOption(install): <options for %%pyproject_save_files>
|
||||
|
||||
That way, RPM will automatically fill-in the `%prep`, `%generate_buildrequires`,
|
||||
`%build`, `%install`, and `%check` sections the following defaults:
|
||||
|
||||
%prep
|
||||
%autosetup -p1 -C
|
||||
|
||||
%generate_buildrequires
|
||||
%pyproject_buildrequires
|
||||
|
||||
%build
|
||||
%pyproject_wheel
|
||||
|
||||
%install
|
||||
%pyproject_install
|
||||
%pyproject_save_files <options from BuildOption(install)>
|
||||
|
||||
%check
|
||||
%pyproject_check_import
|
||||
|
||||
To pass options to the individual macros, use `BuildOption` (see the [documentation of declarative buildsystems][declarative buildsystem]).
|
||||
|
||||
# pass options for %%pyproject_save_files (mandatory when not overriding %%install)
|
||||
BuildOption(install): -l _module +auto
|
||||
|
||||
# replace the default options for %%autosetup
|
||||
BuildOption(prep): -S git_am -C
|
||||
|
||||
# pass options to %%pyproject_buildrequires
|
||||
BuildOption(generate_buildrequires): docs-requirements.txt -t
|
||||
|
||||
# pass options to %%pyproject_wheel
|
||||
BuildOption(build): -C--global-option=--no-cython-compile
|
||||
|
||||
# pass options to %%pyproject_check_import
|
||||
BuildOption(check): -e '*.test*'
|
||||
|
||||
Alternatively, you can supply your own sections to override the automatic ones:
|
||||
|
||||
BuildOption(generate_buildrequires): -w
|
||||
...
|
||||
%build
|
||||
# do nothing, the wheel was built in %%generate_buildrequires
|
||||
|
||||
You can append to end of the automatic sections:
|
||||
|
||||
%check -a
|
||||
# run %%pytest after %%pyproject_check_import
|
||||
%pytest
|
||||
|
||||
Or prepend to the beginning of them:
|
||||
|
||||
%prep -p
|
||||
# run %%gpgverify before %%autosetup
|
||||
%gpgverify -k2 -s1 -d0
|
||||
|
||||
[declarative buildsystem]: https://rpm-software-management.github.io/rpm/manual/buildsystem.html
|
||||
|
||||
|
||||
Limitations
|
||||
-----------
|
||||
|
||||
`%pyproject_install` changes shebang lines of every Python script in `%{buildroot}%{_bindir}` to `#!%{__python3} %{py3_shbang_opt}` (`#!/usr/bin/python3 -s`).
|
||||
Existing Python flags in shebangs are preserved.
|
||||
For example `#!/usr/bin/python3 -Ru` will be updated to `#!/usr/bin/python3 -sRu`.
|
||||
Sometimes, this can interfere with tests that run such scripts directly by name,
|
||||
because in tests we usually rely on `PYTHONPATH` (and `-s` ignores that).
|
||||
Would this behavior be undesired for any reason,
|
||||
undefine `%{py3_shbang_opt}` to turn it off.
|
||||
|
||||
Some valid Python version specifiers are not supported.
|
||||
|
||||
When a dependency is specified via an URL or local path, for example as:
|
||||
|
||||
https://github.com/ActiveState/appdirs/archive/8eacfa312d77aba28d483fbfb6f6fc54099622be.zip
|
||||
/some/path/foo-1.2.3.tar.gz
|
||||
git+https://github.com/sphinx-doc/sphinx.git@96dbe5e3
|
||||
|
||||
The `%pyproject_buildrequires` macro is unable to convert it to an appropriate RPM requirement and will fail.
|
||||
If the URL contains the `packageName @` prefix as specified in [PEP 508],
|
||||
the requirement will be generated without a version constraint:
|
||||
|
||||
appdirs@https://github.com/ActiveState/appdirs/archive/8eacfa312d77aba28d483fbfb6f6fc54099622be.zip
|
||||
foo@file:///some/path/foo-1.2.3.tar.gz
|
||||
|
||||
Will be converted to:
|
||||
|
||||
python3dist(appdirs)
|
||||
python3dist(foo)
|
||||
|
||||
Alternatively, when an URL requirement parsed from a text file
|
||||
given as positional argument to `%pyproject_buildrequires`
|
||||
contains the `#egg=packageName` fragment,
|
||||
as documented in [pip's documentation]:
|
||||
|
||||
git+https://github.com/sphinx-doc/sphinx.git@96dbe5e3#egg=sphinx
|
||||
|
||||
The requirements will be converted to package names without versions, e.g.:
|
||||
|
||||
python3dist(sphinx)
|
||||
|
||||
However upstreams usually only use direct URLs for their requirements as workarounds,
|
||||
so be prepared for problems.
|
||||
|
||||
[PEP 508]: https://www.python.org/dev/peps/pep-0508/
|
||||
[PEP 517]: https://www.python.org/dev/peps/pep-0517/
|
||||
[PEP 518]: https://www.python.org/dev/peps/pep-0518/
|
||||
[PEP 639]: https://www.python.org/dev/peps/pep-0639/
|
||||
[pip's documentation]: https://pip.pypa.io/en/stable/cli/pip_install/#vcs-support
|
||||
|
||||
|
||||
Deprecated
|
||||
----------
|
||||
|
||||
The `%{pyproject_build_lib}` macro is deprecated, don't use it.
|
||||
|
||||
|
||||
Testing the macros
|
||||
------------------
|
||||
|
||||
This repository has two kinds of tests.
|
||||
First, there is RPM `%check` section, run when building the `python-rpm-macros`
|
||||
package.
|
||||
|
||||
Then there are CI tests.
|
||||
There is currently [no way to run Fedora CI tests locally][ci-rfe],
|
||||
but you can do what the tests do manually using mock.
|
||||
For each `$PKG.spec` in `tests/`:
|
||||
|
||||
- clean your mock environment:
|
||||
|
||||
mock -r fedora-rawhide-x86_64 clean
|
||||
|
||||
- install the version of `python-rpm-macros` you're testing, e.g.:
|
||||
|
||||
mock -r fedora-rawhide-x86_64 install .../python-rpm-macros-*.noarch.rpm
|
||||
|
||||
- download the sources:
|
||||
|
||||
spectool -g -R $PKG.spec
|
||||
|
||||
- build a SRPM:
|
||||
|
||||
rpmbuild -bs $PKG.spec
|
||||
|
||||
- build in mock, using the path from the command above as `$SRPM`:
|
||||
|
||||
mock -r fedora-rawhide-x86_64 -n -N $SRPM
|
||||
|
||||
[ci-rfe]: https://pagure.io/fedora-ci/general/issue/4
|
||||
@ -0,0 +1,83 @@
|
||||
'''Check whether the manpage extensions and directories list hardcoded in brp-compress
|
||||
are the same as the lists stored in pyproject_save_files.py.
|
||||
There is an open issue for RPM to provide them both as macros:
|
||||
https://github.com/rpm-software-management/rpm/issues/1865
|
||||
Once that happens, this script can be removed.
|
||||
'''
|
||||
|
||||
import argparse
|
||||
import re
|
||||
import sys
|
||||
|
||||
from pathlib import PosixPath
|
||||
|
||||
from pyproject_buildrequires import print_err
|
||||
from pyproject_save_files import prepend_mandirs, MANPAGE_EXTENSIONS
|
||||
|
||||
|
||||
|
||||
def read_brp_compress(filename):
|
||||
|
||||
contents = filename.read_text()
|
||||
# To avoid duplicity of the manpage extensions which are listed a few times
|
||||
# in the source file, they are stored in set and then retyped to a sorted list
|
||||
manpage_exts = sorted(
|
||||
set(re.findall(r'\(?(\w+)\\+\)?\$?', contents))
|
||||
)
|
||||
|
||||
# Get rid of ${PREFIX} when extracting the manpage directories
|
||||
mandirs = [
|
||||
entry.replace('.${PREFIX}', '/PREFIX')
|
||||
for entry in contents.split()
|
||||
if entry.startswith('.${PREFIX}')
|
||||
]
|
||||
|
||||
return manpage_exts, sorted(mandirs)
|
||||
|
||||
|
||||
def compare_mandirs(brp_compress_mandirs):
|
||||
'''
|
||||
Check whether each of brp-compress mandirs entry is present in the list
|
||||
stored in pyproject_save_files.py
|
||||
'''
|
||||
|
||||
pyp_save_files_mandirs = sorted(prepend_mandirs(prefix='/PREFIX'))
|
||||
if brp_compress_mandirs == pyp_save_files_mandirs:
|
||||
return True
|
||||
else:
|
||||
print_err('Mandir lists don\'t match, update the list in pyproject_save_files.py')
|
||||
print_err('brp-compress list:', brp_compress_mandirs)
|
||||
print_err('pyproject_save_files list:', pyp_save_files_mandirs)
|
||||
return False
|
||||
|
||||
|
||||
def compare_manpage_extensions(brp_compress_manpage_exts):
|
||||
'''
|
||||
Check whether each of brp-compress manpage extension is present in the list
|
||||
stored in pyproject_save_files.py
|
||||
'''
|
||||
|
||||
if brp_compress_manpage_exts == sorted(MANPAGE_EXTENSIONS):
|
||||
return True
|
||||
else:
|
||||
print_err('Manpage extension lists don\'t match, update the list in pyproject_save_files.py')
|
||||
print_err('brp-compress list:', brp_compress_manpage_exts)
|
||||
print_err('pyproject_save_files list:', sorted(MANPAGE_EXTENSIONS))
|
||||
return False
|
||||
|
||||
|
||||
def main(args):
|
||||
src_manpage_exts, src_mandirs = read_brp_compress(args.filename)
|
||||
extension_check_successful = compare_manpage_extensions(src_manpage_exts)
|
||||
mandir_check_successful = compare_mandirs(src_mandirs)
|
||||
if extension_check_successful and mandir_check_successful:
|
||||
sys.exit(0)
|
||||
else:
|
||||
sys.exit(1)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument('-f', '--filename', type=PosixPath, required=True,
|
||||
help='Provide location of brp-compress file')
|
||||
main(parser.parse_args())
|
||||
@ -0,0 +1,17 @@
|
||||
# This file is called macros.aaa-pyproject-srpm
|
||||
# to sort alphabetically before macros.pyproject.
|
||||
# When this file is installed but macros.pyproject is not
|
||||
# this macro will cause the package with the real macro to be installed.
|
||||
# When macros.pyproject is installed, it overrides this macro.
|
||||
# Note: This needs to maintain the same set of options as the real macro.
|
||||
%pyproject_buildrequires(rRxtNwe:C:) echo 'pyproject-rpm-macros' && exit 0
|
||||
|
||||
|
||||
# Declarative buildsystem, requires RPM 4.20+ to work
|
||||
# https://rpm-software-management.github.io/rpm/manual/buildsystem.html
|
||||
# This is the minimal implementation to be in the srpm package,
|
||||
# as required even before the BuildRequires are installed
|
||||
%buildsystem_pyproject_conf() %nil
|
||||
%buildsystem_pyproject_generate_buildrequires() %pyproject_buildrequires %*
|
||||
%buildsystem_pyproject_build() %nil
|
||||
%buildsystem_pyproject_install() %nil
|
||||
@ -0,0 +1,233 @@
|
||||
# This is a backward-compatible suffix used in all pyproject-rpm-macros directories
|
||||
# For the main Python it's empty, for all others it's "-3.X"
|
||||
%_pyproject_files_pkgversion %{expr:"%{python3_pkgversion}" != "3" ? "-%{python3_pkgversion}" : ""}
|
||||
|
||||
# This is a directory where wheels are stored and installed from, absolute
|
||||
%_pyproject_wheeldir %{_builddir}%{?buildsubdir:/%{buildsubdir}}/pyproject-wheeldir%{_pyproject_files_pkgversion}
|
||||
|
||||
# This is a directory used as TMPDIR, where pip copies sources to and builds from, relative to PWD
|
||||
# For proper debugsource packages, we create TMPDIR within PWD
|
||||
# See https://github.com/pypa/pip/issues/7555#issuecomment-595180864
|
||||
#
|
||||
# This will be used in debugsource package paths (applies to extension modules only)
|
||||
# NB: pytest collects tests from here if not hidden
|
||||
# https://docs.pytest.org/en/latest/reference.html#confval-norecursedirs
|
||||
%_pyproject_builddir %{_builddir}%{?buildsubdir:/%{buildsubdir}}/.pyproject-builddir%{_pyproject_files_pkgversion}
|
||||
|
||||
# We prefix all created files with this value to make them unique
|
||||
# Ideally, we would put them into %%{buildsubdir}, but that value changes during the spec
|
||||
# The used value is similar to the one used to define the default %%buildroot
|
||||
%_pyproject_files_prefix %{name}-%{version}-%{release}.%{_arch}%{_pyproject_files_pkgversion}
|
||||
|
||||
%pyproject_files %{_builddir}/%{_pyproject_files_prefix}-pyproject-files
|
||||
%_pyproject_modules %{_builddir}/%{_pyproject_files_prefix}-pyproject-modules
|
||||
%_pyproject_ghost_distinfo %{_builddir}/%{_pyproject_files_prefix}-pyproject-ghost-distinfo
|
||||
%_pyproject_record %{_builddir}/%{_pyproject_files_prefix}-pyproject-record
|
||||
%_pyproject_buildrequires %{_builddir}/%{_pyproject_files_prefix}-pyproject-buildrequires
|
||||
|
||||
# Avoid leaking %%{_pyproject_builddir} to pytest collection
|
||||
# https://bugzilla.redhat.com/show_bug.cgi?id=1935212
|
||||
# The value is read and used by the %%pytest and %%tox macros:
|
||||
%_set_pytest_addopts %global __pytest_addopts --ignore=%{_pyproject_builddir}
|
||||
|
||||
%pyproject_wheel(C:) %{expand:\\\
|
||||
%_set_pytest_addopts
|
||||
mkdir -p "%{_pyproject_builddir}"
|
||||
CFLAGS="${CFLAGS:-${RPM_OPT_FLAGS}}" LDFLAGS="${LDFLAGS:-${RPM_LD_FLAGS}}" TMPDIR="%{_pyproject_builddir}" \\\
|
||||
%{__python3} -Bs %{_rpmconfigdir}/redhat/pyproject_wheel.py %{?**} %{_pyproject_wheeldir}
|
||||
}
|
||||
|
||||
|
||||
%pyproject_build_lib %{!?__pyproject_build_lib_warned:%{warn:The %%{pyproject_build_lib} macro is deprecated.
|
||||
It only works with setuptools and is not build-backend-agnostic.
|
||||
The macro is not scheduled for removal, but there is a possibility of incompatibilities with future versions of setuptools.
|
||||
As a replacement for the macro for the setuptools backend on Fedora 37+, you can use $PWD/build/lib for pure Python packages,
|
||||
or $PWD/build/lib.%%{python3_platform}-cpython-%%{python3_version_nodots} for packages with extension modules.
|
||||
Other build backends and older distributions may need different paths.
|
||||
See https://lists.fedoraproject.org/archives/list/python-devel@lists.fedoraproject.org/thread/HMLOPAU3RZLXD4BOJHTIPKI3I4U6U7OE/ for details.
|
||||
}%global __pyproject_build_lib_warned 1}%{expand:\\\
|
||||
$(
|
||||
pyproject_build_lib=()
|
||||
if [ -d build/lib.%{python3_platform}-cpython-%{python3_version_nodots} ]; then
|
||||
pyproject_build_lib+=( "${PWD}/build/lib.%{python3_platform}-cpython-%{python3_version_nodots}" )
|
||||
fi
|
||||
if [ -d build/lib.%{python3_platform}-%{python3_version} ]; then
|
||||
pyproject_build_lib+=( "${PWD}/build/lib.%{python3_platform}-%{python3_version}" )
|
||||
fi
|
||||
if [ -d build/lib ]; then
|
||||
pyproject_build_lib+=( "${PWD}/build/lib" )
|
||||
fi
|
||||
for directory in $(find "%{_pyproject_builddir}" -type d -wholename "%{_pyproject_builddir}/pip-req-build-*/build/lib.%{python3_platform}-%{python3_version}" 2>/dev/null); do
|
||||
pyproject_build_lib+=( "${directory}" )
|
||||
done
|
||||
for directory in $(find "%{_pyproject_builddir}" -type d -wholename "%{_pyproject_builddir}/pip-req-build-*/build/lib" 2>/dev/null); do
|
||||
pyproject_build_lib+=( "${directory}" )
|
||||
done
|
||||
echo $(IFS=:; echo "${pyproject_build_lib[*]}")
|
||||
)}
|
||||
|
||||
|
||||
%pyproject_install() %{expand:\\\
|
||||
specifier=$(ls %{_pyproject_wheeldir}/*.whl | xargs basename --multiple | sed -E 's/([^-]+)-([^-]+)-.+\\\.whl/\\\1==\\\2/')
|
||||
if [ -z $specifier ]; then
|
||||
echo 'ERROR: %%%%pyproject_install found no wheel in %%%%{_pyproject_wheeldir} %{_pyproject_wheeldir}' >&2
|
||||
exit 1
|
||||
fi
|
||||
TMPDIR="%{_pyproject_builddir}" %{__python3} -m pip install --root %{buildroot} --prefix %{_prefix} --no-deps --disable-pip-version-check --progress-bar off --verbose --ignore-installed --no-warn-script-location --no-index --no-cache-dir --find-links %{_pyproject_wheeldir} $specifier
|
||||
if [ -d %{buildroot}%{_bindir} ]; then
|
||||
%py3_shebang_fix %{buildroot}%{_bindir}/*
|
||||
rm -rfv %{buildroot}%{_bindir}/__pycache__
|
||||
fi
|
||||
rm -f %{_pyproject_ghost_distinfo}
|
||||
site_dirs=()
|
||||
# Process %%{python3_sitelib} if exists
|
||||
if [ -d %{buildroot}%{python3_sitelib} ]; then
|
||||
site_dirs+=( "%{python3_sitelib}" )
|
||||
fi
|
||||
# Process %%{python3_sitearch} if exists and does not equal to %%{python3_sitelib}
|
||||
if [ %{buildroot}%{python3_sitearch} != %{buildroot}%{python3_sitelib} ] && [ -d %{buildroot}%{python3_sitearch} ]; then
|
||||
site_dirs+=( "%{python3_sitearch}" )
|
||||
fi
|
||||
# Process all *.dist-info dirs in sitelib/sitearch
|
||||
for site_dir in ${site_dirs[@]}; do
|
||||
for distinfo in %{buildroot}$site_dir/*.dist-info; do
|
||||
echo "%ghost ${distinfo#%{buildroot}}" >> %{_pyproject_ghost_distinfo}
|
||||
sed -i 's/pip/rpm/' ${distinfo}/INSTALLER
|
||||
PYTHONPATH=%{_rpmconfigdir}/redhat \\
|
||||
%{__python3} -B %{_rpmconfigdir}/redhat/pyproject_preprocess_record.py \\
|
||||
--buildroot %{buildroot} --record ${distinfo}/RECORD --output %{_pyproject_record}
|
||||
rm -fv ${distinfo}/RECORD
|
||||
rm -fv ${distinfo}/REQUESTED
|
||||
done
|
||||
done
|
||||
lines=$(wc -l %{_pyproject_ghost_distinfo} | cut -f1 -d" ")
|
||||
if [ $lines -ne 1 ]; then
|
||||
echo -e "\\n\\nWARNING: %%%%pyproject_extras_subpkg won't work without explicit -i or -F, found $lines dist-info directories.\\n\\n" >&2
|
||||
rm %{_pyproject_ghost_distinfo} # any attempt to use this will fail
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
# Note: the three times nested questionmarked -i -f -F pattern means: If none of those options was used -- in that case, we inject our own -f
|
||||
%pyproject_extras_subpkg(n:i:f:FaA) %{expand:%{?python_extras_subpkg:%{python_extras_subpkg%{?!-i:%{?!-f:%{?!-F: -f %{_pyproject_ghost_distinfo}}}} %**}}}
|
||||
|
||||
|
||||
# Escaping shell-globs, percentage signs and spaces was reworked in RPM 4.19+
|
||||
# https://github.com/rpm-software-management/rpm/issues/1749#issuecomment-1020420616
|
||||
# Since we support both ways, we pass either 4.19 or 4.18 to the script, so it knows which one to use
|
||||
# Rather than passing the actual version, we let RPM compare the versions, as it is easier done here than in Python
|
||||
%pyproject_save_files(lL) %{expand:\\\
|
||||
%{expr:v"0%{?rpmversion}" >= v"4.18.90" ? "RPM_FILES_ESCAPE=4.19" : "RPM_FILES_ESCAPE=4.18" } \\
|
||||
%{__python3} %{_rpmconfigdir}/redhat/pyproject_save_files.py \\
|
||||
--output-files "%{pyproject_files}" \\
|
||||
--output-modules "%{_pyproject_modules}" \\
|
||||
--buildroot "%{buildroot}" \\
|
||||
--sitelib "%{python3_sitelib}" \\
|
||||
--sitearch "%{python3_sitearch}" \\
|
||||
--python-version "%{python3_version}" \\
|
||||
--pyproject-record "%{_pyproject_record}" \\
|
||||
--prefix "%{_prefix}" \\
|
||||
%{**}
|
||||
}
|
||||
|
||||
# -t - Process only top-level modules
|
||||
# -e - Exclude the module names matching given glob, may be used repeatedly
|
||||
%pyproject_check_import(e:t) %{expand:\\\
|
||||
if [ ! -f "%{_pyproject_modules}" ]; then
|
||||
echo 'ERROR: %%%%pyproject_check_import only works when %%%%pyproject_save_files is used' >&2
|
||||
exit 1
|
||||
fi
|
||||
%py3_check_import -f "%{_pyproject_modules}" %{?**}
|
||||
}
|
||||
|
||||
|
||||
%_pyproject_check_import_allow_no_modules(e:t) \
|
||||
if [ -z "$(cat %{_pyproject_modules})" ]; then\
|
||||
echo "No modules to check found, exiting check"\
|
||||
else\
|
||||
%pyproject_check_import %{?**}\
|
||||
fi
|
||||
|
||||
|
||||
%default_toxenv py%{python3_version_nodots}
|
||||
%toxenv %{default_toxenv}
|
||||
|
||||
|
||||
# Note: Keep the options in sync with this macro from macros.aaa-pyproject-srpm
|
||||
%pyproject_buildrequires(rRxtNwe:C:) %{expand:\\\
|
||||
%_set_pytest_addopts
|
||||
# The _auto_set_build_flags feature does not do this in %%generate_buildrequires section,
|
||||
# but we want to get an environment consistent with %%build:
|
||||
%{?_auto_set_build_flags:%set_build_flags}
|
||||
# The default flags expect the package note file to exist
|
||||
# see https://bugzilla.redhat.com/show_bug.cgi?id=2097535
|
||||
%{?_package_note_flags:%_generate_package_note_file}
|
||||
%{-R:
|
||||
%{-r:%{error:The -R and -r options are mutually exclusive}}
|
||||
%{-x:%{error:The -R and -x options are mutually exclusive}}
|
||||
%{-e:%{error:The -R and -e options are mutually exclusive}}
|
||||
%{-t:%{error:The -R and -t options are mutually exclusive}}
|
||||
%{-w:%{error:The -R and -w options are mutually exclusive}}
|
||||
}
|
||||
%{-N:
|
||||
%{-r:%{error:The -N and -r options are mutually exclusive}}
|
||||
%{-x:%{error:The -N and -x options are mutually exclusive}}
|
||||
%{-e:%{error:The -N and -e options are mutually exclusive}}
|
||||
%{-t:%{error:The -N and -t options are mutually exclusive}}
|
||||
%{-w:%{error:The -N and -w options are mutually exclusive}}
|
||||
%{-C:%{error:The -N and -C options are mutually exclusive}}
|
||||
}
|
||||
%{-e:%{expand:%global toxenv %(%{__python3} -s %{_rpmconfigdir}/redhat/pyproject_construct_toxenv.py %{?**})}}
|
||||
echo 'pyproject-rpm-macros' # first stdout line matches the implementation in macros.aaa-pyproject-srpm
|
||||
echo 'python%{python3_pkgversion}-devel'
|
||||
echo 'python%{python3_pkgversion}dist(pip) >= 19'
|
||||
echo 'python%{python3_pkgversion}dist(packaging)'
|
||||
%{!-N:if [ -f pyproject.toml ]; then
|
||||
%["%{python3_pkgversion}" == "3"
|
||||
? "echo '(python%{python3_pkgversion}dist(tomli) if python%{python3_pkgversion}-devel < 3.11)'"
|
||||
: "%[v"%{python3_pkgversion}" < v"3.11"
|
||||
? "echo 'python%{python3_pkgversion}dist(tomli)'"
|
||||
: "true # will use tomllib, echo nothing"
|
||||
]"
|
||||
]
|
||||
elif [ -f setup.py ]; then
|
||||
# Note: If the default requirements change, also change them in the script!
|
||||
echo 'python%{python3_pkgversion}dist(setuptools) >= 40.8'
|
||||
echo 'python%{python3_pkgversion}dist(wheel)'
|
||||
else
|
||||
echo 'ERROR: Neither pyproject.toml nor setup.py found, consider using %%%%pyproject_buildrequires -N <requirements-file> if this is not a Python package.' >&2
|
||||
exit 1
|
||||
fi}
|
||||
# setuptools assumes no pre-existing dist-info
|
||||
rm -rfv *.dist-info/ >&2
|
||||
if [ -f %{__python3} ]; then
|
||||
mkdir -p "%{_pyproject_builddir}"
|
||||
echo -n > %{_pyproject_buildrequires}
|
||||
CFLAGS="${CFLAGS:-${RPM_OPT_FLAGS}}" LDFLAGS="${LDFLAGS:-${RPM_LD_FLAGS}}" TMPDIR="%{_pyproject_builddir}" \\\
|
||||
RPM_TOXENV="%{toxenv}" HOSTNAME="rpmbuild" %{__python3} -Bs %{_rpmconfigdir}/redhat/pyproject_buildrequires.py %{?!_python_no_extras_requires:--generate-extras} --python3_pkgversion %{python3_pkgversion} --wheeldir %{_pyproject_wheeldir} --output %{_pyproject_buildrequires} %{?**} >&2
|
||||
cat %{_pyproject_buildrequires}
|
||||
fi
|
||||
# Incomplete .dist-info dir might confuse importlib.metadata
|
||||
rm -rfv *.dist-info/ >&2
|
||||
}
|
||||
|
||||
|
||||
%tox(e:) %{expand:\\\
|
||||
TOX_TESTENV_PASSENV="${TOX_TESTENV_PASSENV:-*}" \\
|
||||
%{?py3_test_envvars}%{?!py3_test_envvars:PYTHONDONTWRITEBYTECODE=1 \\
|
||||
PATH="%{buildroot}%{_bindir}:$PATH" \\
|
||||
PYTHONPATH="${PYTHONPATH:-%{buildroot}%{python3_sitearch}:%{buildroot}%{python3_sitelib}}" \\
|
||||
%{?__pytest_addopts:PYTEST_ADDOPTS="${PYTEST_ADDOPTS:-} %{__pytest_addopts}"}} \\
|
||||
HOSTNAME="rpmbuild" \\
|
||||
%{__python3} -m tox --current-env -q --recreate -e "%{-e:%{-e*}}%{!-e:%{toxenv}}" %{?*}
|
||||
}
|
||||
|
||||
|
||||
# Declarative buildsystem, requires RPM 4.20+ to work
|
||||
# https://rpm-software-management.github.io/rpm/manual/buildsystem.html
|
||||
%buildsystem_pyproject_conf() %nil
|
||||
%buildsystem_pyproject_generate_buildrequires() %pyproject_buildrequires %*
|
||||
%buildsystem_pyproject_build() %pyproject_wheel %*
|
||||
%buildsystem_pyproject_install() %["%{shrink:%*}" == "" ? "%{error:BuildOption(install) is mandatory with pyproject BuildSystem.}" : "%pyproject_install \
|
||||
%pyproject_save_files %*"]
|
||||
%buildsystem_pyproject_check() %pyproject_check_import %*
|
||||
@ -0,0 +1,588 @@
|
||||
import glob
|
||||
import io
|
||||
import os
|
||||
import sys
|
||||
import importlib.metadata
|
||||
import argparse
|
||||
import traceback
|
||||
import json
|
||||
import subprocess
|
||||
import re
|
||||
import tempfile
|
||||
import email.parser
|
||||
import pathlib
|
||||
import zipfile
|
||||
|
||||
from pyproject_requirements_txt import convert_requirements_txt
|
||||
from pyproject_wheel import parse_config_settings_args
|
||||
|
||||
|
||||
# Some valid Python version specifiers are not supported.
|
||||
# Allow only the forms we know we can handle.
|
||||
VERSION_RE = re.compile(r'[a-zA-Z0-9.-]+(\.\*)?')
|
||||
|
||||
|
||||
class EndPass(Exception):
|
||||
"""End current pass of generating requirements"""
|
||||
|
||||
|
||||
# nb: we don't use functools.partial to be able to use pytest's capsys
|
||||
# see https://github.com/pytest-dev/pytest/issues/8900
|
||||
def print_err(*args, **kwargs):
|
||||
kwargs.setdefault('file', sys.stderr)
|
||||
print(*args, **kwargs)
|
||||
|
||||
|
||||
try:
|
||||
from packaging.requirements import Requirement, InvalidRequirement
|
||||
from packaging.utils import canonicalize_name
|
||||
except ImportError as e:
|
||||
print_err('Import error:', e)
|
||||
# already echoed by the %pyproject_buildrequires macro
|
||||
sys.exit(0)
|
||||
|
||||
# uses packaging, needs to be imported after packaging is verified to be present
|
||||
from pyproject_convert import convert
|
||||
|
||||
|
||||
def guess_reason_for_invalid_requirement(requirement_str):
|
||||
if ':' in requirement_str:
|
||||
message = (
|
||||
'It might be an URL. '
|
||||
'%pyproject_buildrequires cannot handle all URL-based requirements. '
|
||||
'Add PackageName@ (see PEP 508) to the URL to at least require any version of PackageName.'
|
||||
)
|
||||
if '@' in requirement_str:
|
||||
message += ' (but note that URLs might not work well with other features)'
|
||||
return message
|
||||
if '/' in requirement_str:
|
||||
return (
|
||||
'It might be a local path. '
|
||||
'%pyproject_buildrequires cannot handle local paths as requirements. '
|
||||
'Use an URL with PackageName@ (see PEP 508) to at least require any version of PackageName.'
|
||||
)
|
||||
# No more ideas
|
||||
return None
|
||||
|
||||
|
||||
class Requirements:
|
||||
"""Requirement gatherer. The macro will eventually print out output_lines."""
|
||||
def __init__(self, get_installed_version, extras=None,
|
||||
generate_extras=False, python3_pkgversion='3', config_settings=None):
|
||||
self.get_installed_version = get_installed_version
|
||||
self.output_lines = []
|
||||
self.extras = set()
|
||||
|
||||
if extras:
|
||||
for extra in extras:
|
||||
self.add_extras(*extra.split(','))
|
||||
|
||||
self.missing_requirements = False
|
||||
self.ignored_alien_requirements = []
|
||||
|
||||
self.generate_extras = generate_extras
|
||||
self.python3_pkgversion = python3_pkgversion
|
||||
self.config_settings = config_settings
|
||||
|
||||
def add_extras(self, *extras):
|
||||
self.extras |= set(e.strip() for e in extras)
|
||||
|
||||
@property
|
||||
def marker_envs(self):
|
||||
if self.extras:
|
||||
return [{'extra': e} for e in sorted(self.extras)]
|
||||
return [{'extra': ''}]
|
||||
|
||||
def evaluate_all_environments(self, requirement):
|
||||
for marker_env in self.marker_envs:
|
||||
if requirement.marker.evaluate(environment=marker_env):
|
||||
return True
|
||||
return False
|
||||
|
||||
def add(self, requirement_str, *, package_name=None, source=None):
|
||||
"""Output a Python-style requirement string as RPM dep"""
|
||||
print_err(f'Handling {requirement_str} from {source}')
|
||||
|
||||
try:
|
||||
requirement = Requirement(requirement_str)
|
||||
except InvalidRequirement:
|
||||
hint = guess_reason_for_invalid_requirement(requirement_str)
|
||||
message = f'Requirement {requirement_str!r} from {source} is invalid.'
|
||||
if hint:
|
||||
message += f' Hint: {hint}'
|
||||
raise ValueError(message)
|
||||
|
||||
if requirement.url:
|
||||
print_err(
|
||||
f'WARNING: Simplifying {requirement_str!r} to {requirement.name!r}.'
|
||||
)
|
||||
|
||||
name = canonicalize_name(requirement.name)
|
||||
if (requirement.marker is not None and
|
||||
not self.evaluate_all_environments(requirement)):
|
||||
print_err(f'Ignoring alien requirement:', requirement_str)
|
||||
self.ignored_alien_requirements.append(requirement_str)
|
||||
return
|
||||
|
||||
# Handle self-referencing requirements
|
||||
if package_name and canonicalize_name(package_name) == name:
|
||||
# Self-referential extras need to be handled specially
|
||||
if requirement.extras:
|
||||
if not (requirement.extras <= self.extras): # only handle it if needed
|
||||
# let all further requirements know we want those extras
|
||||
self.add_extras(*requirement.extras)
|
||||
# re-add all of the alien requirements ignored in the past
|
||||
# they might no longer be alien now
|
||||
self.readd_ignored_alien_requirements(package_name=package_name)
|
||||
else:
|
||||
print_err(f'Ignoring self-referential requirement without extras:', requirement_str)
|
||||
return
|
||||
|
||||
# We need to always accept pre-releases as satisfying the requirement
|
||||
# Otherwise e.g. installed cffi version 1.15.0rc2 won't even satisfy the requirement for "cffi"
|
||||
# https://bugzilla.redhat.com/show_bug.cgi?id=2014639#c3
|
||||
requirement.specifier.prereleases = True
|
||||
|
||||
try:
|
||||
# TODO: check if requirements with extras are satisfied
|
||||
installed = self.get_installed_version(requirement.name)
|
||||
except importlib.metadata.PackageNotFoundError:
|
||||
print_err(f'Requirement not satisfied: {requirement_str}')
|
||||
installed = None
|
||||
if installed and installed in requirement.specifier:
|
||||
print_err(f'Requirement satisfied: {requirement_str}')
|
||||
print_err(f' (installed: {requirement.name} {installed})')
|
||||
if requirement.extras:
|
||||
print_err(f' (extras are currently not checked)')
|
||||
else:
|
||||
self.missing_requirements = True
|
||||
|
||||
if self.generate_extras:
|
||||
extra_names = [f'{name}[{extra.lower()}]' for extra in sorted(requirement.extras)]
|
||||
else:
|
||||
extra_names = []
|
||||
|
||||
for name in [name] + extra_names:
|
||||
together = []
|
||||
for specifier in sorted(
|
||||
requirement.specifier,
|
||||
key=lambda s: (s.operator, s.version),
|
||||
):
|
||||
if not VERSION_RE.fullmatch(str(specifier.version)):
|
||||
raise ValueError(
|
||||
f'Unknown character in version: {specifier.version}. '
|
||||
+ '(This might be a bug in pyproject-rpm-macros.)',
|
||||
)
|
||||
together.append(convert(python3dist(name, python3_pkgversion=self.python3_pkgversion),
|
||||
specifier.operator, specifier.version))
|
||||
if len(together) == 0:
|
||||
dep = python3dist(name, python3_pkgversion=self.python3_pkgversion)
|
||||
self.output_lines.append(dep)
|
||||
elif len(together) == 1:
|
||||
self.output_lines.append(together[0])
|
||||
else:
|
||||
self.output_lines.append(f"({' with '.join(together)})")
|
||||
|
||||
def check(self, *, source=None):
|
||||
"""End current pass if any unsatisfied dependencies were output"""
|
||||
if self.missing_requirements:
|
||||
print_err(f'Exiting dependency generation pass: {source}')
|
||||
raise EndPass(source)
|
||||
|
||||
def extend(self, requirement_strs, **kwargs):
|
||||
"""add() several requirements"""
|
||||
for req_str in requirement_strs:
|
||||
self.add(req_str, **kwargs)
|
||||
|
||||
def readd_ignored_alien_requirements(self, **kwargs):
|
||||
"""add() previously ignored alien requirements again."""
|
||||
requirements, self.ignored_alien_requirements = self.ignored_alien_requirements, []
|
||||
kwargs.setdefault('source', 'Previously ignored alien requirements')
|
||||
self.extend(requirements, **kwargs)
|
||||
|
||||
|
||||
def toml_load(opened_binary_file):
|
||||
try:
|
||||
# tomllib is in the standard library since 3.11.0b1
|
||||
import tomllib
|
||||
except ImportError:
|
||||
try:
|
||||
import tomli as tomllib
|
||||
except ImportError as e:
|
||||
print_err('Import error:', e)
|
||||
# already echoed by the %pyproject_buildrequires macro
|
||||
sys.exit(0)
|
||||
return tomllib.load(opened_binary_file)
|
||||
|
||||
|
||||
def get_backend(requirements):
|
||||
try:
|
||||
f = open('pyproject.toml', 'rb')
|
||||
except FileNotFoundError:
|
||||
pyproject_data = {}
|
||||
else:
|
||||
with f:
|
||||
pyproject_data = toml_load(f)
|
||||
|
||||
buildsystem_data = pyproject_data.get('build-system', {})
|
||||
requirements.extend(
|
||||
buildsystem_data.get('requires', ()),
|
||||
source='build-system.requires',
|
||||
)
|
||||
|
||||
backend_name = buildsystem_data.get('build-backend')
|
||||
if not backend_name:
|
||||
# https://www.python.org/dev/peps/pep-0517/:
|
||||
# If the pyproject.toml file is absent, or the build-backend key is
|
||||
# missing, the source tree is not using this specification, and tools
|
||||
# should revert to the legacy behaviour of running setup.py
|
||||
# (either directly, or by implicitly invoking the [following] backend).
|
||||
# If setup.py is also not present program will mimick pip's behavior
|
||||
# and end with an error.
|
||||
if not os.path.exists('setup.py'):
|
||||
raise FileNotFoundError('File "setup.py" not found for legacy project.')
|
||||
backend_name = 'setuptools.build_meta:__legacy__'
|
||||
|
||||
# Note: For projects without pyproject.toml, this was already echoed
|
||||
# by the %pyproject_buildrequires macro, but this also handles cases
|
||||
# with pyproject.toml without a specified build backend.
|
||||
# If the default requirements change, also change them in the macro!
|
||||
requirements.add('setuptools >= 40.8', source='default build backend')
|
||||
# PEP 517 doesn't mandate depending on wheel when the default backend is used.
|
||||
# Historically, it used to be assumed as necessary, but later it turned out to be wrong.
|
||||
# See the removal in pip and build:
|
||||
# https://github.com/pypa/pip/pull/12449
|
||||
# https://github.com/pypa/build/pull/716
|
||||
# However, the requirement *will* be generated by setuptools anyway
|
||||
# as part of get_requires_for_build_wheel().
|
||||
# So we might as well keep it to skip one redundant step.
|
||||
requirements.add('wheel', source='default build backend')
|
||||
|
||||
requirements.check(source='build backend')
|
||||
|
||||
backend_path = buildsystem_data.get('backend-path')
|
||||
if backend_path:
|
||||
# PEP 517 example shows the path as a list, but some projects don't follow that
|
||||
if isinstance(backend_path, str):
|
||||
backend_path = [backend_path]
|
||||
sys.path = backend_path + sys.path
|
||||
|
||||
module_name, _, object_name = backend_name.partition(":")
|
||||
backend_module = importlib.import_module(module_name)
|
||||
|
||||
if object_name:
|
||||
return getattr(backend_module, object_name)
|
||||
|
||||
return backend_module
|
||||
|
||||
|
||||
def generate_build_requirements(backend, requirements):
|
||||
get_requires = getattr(backend, 'get_requires_for_build_wheel', None)
|
||||
if get_requires:
|
||||
new_reqs = get_requires(config_settings=requirements.config_settings)
|
||||
requirements.extend(new_reqs, source='get_requires_for_build_wheel')
|
||||
requirements.check(source='get_requires_for_build_wheel')
|
||||
|
||||
|
||||
def parse_metadata_file(metadata_file):
|
||||
return email.parser.Parser().parse(metadata_file, headersonly=True)
|
||||
|
||||
|
||||
def requires_from_parsed_metadata_file(message):
|
||||
return {k: message.get_all(k, ()) for k in ('Requires', 'Requires-Dist')}
|
||||
|
||||
|
||||
def package_name_from_parsed_metadata_file(message):
|
||||
return message.get('name')
|
||||
|
||||
|
||||
def package_name_and_requires_from_metadata_file(metadata_file):
|
||||
message = parse_metadata_file(metadata_file)
|
||||
package_name = package_name_from_parsed_metadata_file(message)
|
||||
requires = requires_from_parsed_metadata_file(message)
|
||||
return package_name, requires
|
||||
|
||||
|
||||
def generate_run_requirements_hook(backend, requirements):
|
||||
hook_name = 'prepare_metadata_for_build_wheel'
|
||||
prepare_metadata = getattr(backend, hook_name, None)
|
||||
if not prepare_metadata:
|
||||
raise ValueError(
|
||||
'The build backend cannot provide build metadata '
|
||||
'(incl. runtime requirements) before build. '
|
||||
'Use the provisional -w flag to build the wheel and parse the metadata from it, '
|
||||
'or use the -R flag not to generate runtime dependencies.'
|
||||
)
|
||||
dir_basename = prepare_metadata('.', config_settings=requirements.config_settings)
|
||||
with open(dir_basename + '/METADATA') as metadata_file:
|
||||
name, requires = package_name_and_requires_from_metadata_file(metadata_file)
|
||||
for key, req in requires.items():
|
||||
requirements.extend(req,
|
||||
package_name=name,
|
||||
source=f'hook generated metadata: {key} ({name})')
|
||||
|
||||
|
||||
def find_built_wheel(wheeldir):
|
||||
wheels = glob.glob(os.path.join(wheeldir, '*.whl'))
|
||||
if not wheels:
|
||||
return None
|
||||
if len(wheels) > 1:
|
||||
raise RuntimeError('Found multiple wheels in %{_pyproject_wheeldir}, '
|
||||
'this is not supported with %pyproject_buildrequires -w.')
|
||||
return wheels[0]
|
||||
|
||||
|
||||
def generate_run_requirements_wheel(backend, requirements, wheeldir):
|
||||
# Reuse the wheel from the previous round of %pyproject_buildrequires (if it exists)
|
||||
wheel = find_built_wheel(wheeldir)
|
||||
if not wheel:
|
||||
# pip is already echoed from the macro
|
||||
# but we need to explicitly restart if has not yet been installed
|
||||
# see https://bugzilla.redhat.com/2169855
|
||||
requirements.add('pip >= 19', source='%pyproject_buildrequires -w')
|
||||
requirements.check(source='%pyproject_buildrequires -w')
|
||||
import pyproject_wheel
|
||||
returncode = pyproject_wheel.build_wheel(
|
||||
wheeldir=wheeldir,
|
||||
stdout=sys.stderr,
|
||||
config_settings=requirements.config_settings,
|
||||
)
|
||||
if returncode != 0:
|
||||
raise RuntimeError('Failed to build the wheel for %pyproject_buildrequires -w.')
|
||||
wheel = find_built_wheel(wheeldir)
|
||||
if not wheel:
|
||||
raise RuntimeError('Cannot locate the built wheel for %pyproject_buildrequires -w.')
|
||||
|
||||
print_err(f'Reading metadata from {wheel}')
|
||||
with zipfile.ZipFile(wheel) as wheelfile:
|
||||
for name in wheelfile.namelist():
|
||||
if name.count('/') == 1 and name.endswith('.dist-info/METADATA'):
|
||||
with io.TextIOWrapper(wheelfile.open(name), encoding='utf-8') as metadata_file:
|
||||
name, requires = package_name_and_requires_from_metadata_file(metadata_file)
|
||||
for key, req in requires.items():
|
||||
requirements.extend(req,
|
||||
package_name=name,
|
||||
source=f'built wheel metadata: {key} ({name})')
|
||||
break
|
||||
else:
|
||||
raise RuntimeError('Could not find *.dist-info/METADATA in built wheel.')
|
||||
|
||||
|
||||
def generate_run_requirements(backend, requirements, *, build_wheel, wheeldir):
|
||||
if build_wheel:
|
||||
generate_run_requirements_wheel(backend, requirements, wheeldir)
|
||||
else:
|
||||
generate_run_requirements_hook(backend, requirements)
|
||||
|
||||
|
||||
def generate_tox_requirements(toxenv, requirements):
|
||||
toxenv = ','.join(toxenv)
|
||||
requirements.add('tox-current-env >= 0.0.6', source='tox itself')
|
||||
requirements.check(source='tox itself')
|
||||
with tempfile.NamedTemporaryFile('r') as deps, \
|
||||
tempfile.NamedTemporaryFile('r') as extras, \
|
||||
tempfile.NamedTemporaryFile('r') as provision:
|
||||
r = subprocess.run(
|
||||
[sys.executable, '-m', 'tox',
|
||||
'--print-deps-to', deps.name,
|
||||
'--print-extras-to', extras.name,
|
||||
'--no-provision', provision.name,
|
||||
'-q', '-r', '-e', toxenv],
|
||||
check=False,
|
||||
encoding='utf-8',
|
||||
stdout=subprocess.PIPE,
|
||||
stderr=subprocess.STDOUT,
|
||||
)
|
||||
if r.stdout:
|
||||
print_err(r.stdout, end='')
|
||||
|
||||
provision_content = provision.read()
|
||||
if provision_content and r.returncode != 0:
|
||||
provision_requires = json.loads(provision_content)
|
||||
if provision_requires.get('minversion') is not None:
|
||||
requirements.add(f'tox >= {provision_requires["minversion"]}',
|
||||
source='tox provision (minversion)')
|
||||
if 'requires' in provision_requires:
|
||||
requirements.extend(provision_requires["requires"],
|
||||
source='tox provision (requires)')
|
||||
requirements.check(source='tox provision') # this terminates the script
|
||||
raise RuntimeError(
|
||||
'Dependencies requested by tox provisioning appear installed, '
|
||||
'but tox disagreed.')
|
||||
else:
|
||||
r.check_returncode()
|
||||
|
||||
deplines = deps.read().splitlines()
|
||||
packages = convert_requirements_txt(deplines)
|
||||
requirements.add_extras(*extras.read().splitlines())
|
||||
requirements.extend(packages,
|
||||
source=f'tox --print-deps-only: {toxenv}')
|
||||
|
||||
|
||||
def python3dist(name, op=None, version=None, python3_pkgversion="3"):
|
||||
prefix = f"python{python3_pkgversion}dist"
|
||||
|
||||
if op is None:
|
||||
if version is not None:
|
||||
raise AssertionError('op and version go together')
|
||||
return f'{prefix}({name})'
|
||||
else:
|
||||
return f'{prefix}({name}) {op} {version}'
|
||||
|
||||
|
||||
def generate_requires(
|
||||
*, include_runtime=False, build_wheel=False, wheeldir=None, toxenv=None, extras=None,
|
||||
get_installed_version=importlib.metadata.version, # for dep injection
|
||||
generate_extras=False, python3_pkgversion="3", requirement_files=None, use_build_system=True,
|
||||
output, config_settings=None,
|
||||
):
|
||||
"""Generate the BuildRequires for the project in the current directory
|
||||
|
||||
The generated BuildRequires are written to the provided output.
|
||||
|
||||
This is the main Python entry point.
|
||||
"""
|
||||
requirements = Requirements(
|
||||
get_installed_version, extras=extras or [],
|
||||
generate_extras=generate_extras,
|
||||
python3_pkgversion=python3_pkgversion,
|
||||
config_settings=config_settings,
|
||||
)
|
||||
|
||||
try:
|
||||
if (include_runtime or toxenv) and not use_build_system:
|
||||
raise ValueError('-N option cannot be used in combination with -r, -e, -t, -x options')
|
||||
if requirement_files:
|
||||
for req_file in requirement_files:
|
||||
requirements.extend(
|
||||
convert_requirements_txt(req_file, pathlib.Path(req_file.name)),
|
||||
source=f'requirements file {req_file.name}'
|
||||
)
|
||||
requirements.check(source='all requirements files')
|
||||
if use_build_system:
|
||||
backend = get_backend(requirements)
|
||||
generate_build_requirements(backend, requirements)
|
||||
if toxenv:
|
||||
include_runtime = True
|
||||
generate_tox_requirements(toxenv, requirements)
|
||||
if include_runtime:
|
||||
generate_run_requirements(backend, requirements, build_wheel=build_wheel, wheeldir=wheeldir)
|
||||
except EndPass:
|
||||
return
|
||||
finally:
|
||||
output.write_text(os.linesep.join(requirements.output_lines) + os.linesep)
|
||||
|
||||
|
||||
def main(argv):
|
||||
parser = argparse.ArgumentParser(
|
||||
description='Generate BuildRequires for a Python project.',
|
||||
prog='%pyproject_buildrequires',
|
||||
add_help=False,
|
||||
)
|
||||
parser.add_argument(
|
||||
'--help', action='help',
|
||||
default=argparse.SUPPRESS,
|
||||
help=argparse.SUPPRESS,
|
||||
)
|
||||
parser.add_argument(
|
||||
'-r', '--runtime', action='store_true', default=True,
|
||||
help=argparse.SUPPRESS, # Generate run-time requirements (backwards-compatibility only)
|
||||
)
|
||||
parser.add_argument(
|
||||
'--generate-extras', action='store_true',
|
||||
help=argparse.SUPPRESS,
|
||||
)
|
||||
parser.add_argument(
|
||||
'-p', '--python3_pkgversion', metavar='PYTHON3_PKGVERSION',
|
||||
default="3", help=argparse.SUPPRESS,
|
||||
)
|
||||
parser.add_argument(
|
||||
'--output', type=pathlib.Path, required=True, help=argparse.SUPPRESS,
|
||||
)
|
||||
parser.add_argument(
|
||||
'--wheeldir', metavar='PATH', default=None,
|
||||
help=argparse.SUPPRESS,
|
||||
)
|
||||
parser.add_argument(
|
||||
'-x', '--extras', metavar='EXTRAS', action='append',
|
||||
help='comma separated list of "extras" for runtime requirements '
|
||||
'(e.g. -x testing,feature-x) (implies --runtime, can be repeated)',
|
||||
)
|
||||
parser.add_argument(
|
||||
'-t', '--tox', action='store_true',
|
||||
help=('generate test tequirements from tox environment '
|
||||
'(implies --runtime)'),
|
||||
)
|
||||
parser.add_argument(
|
||||
'-e', '--toxenv', metavar='TOXENVS', action='append',
|
||||
help=('specify tox environments (comma separated and/or repeated)'
|
||||
'(implies --tox)'),
|
||||
)
|
||||
parser.add_argument(
|
||||
'-w', '--wheel', action='store_true', default=False,
|
||||
help=('Generate run-time requirements by building the wheel '
|
||||
'(useful for build backends without the prepare_metadata_for_build_wheel hook)'),
|
||||
)
|
||||
parser.add_argument(
|
||||
'-R', '--no-runtime', action='store_false', dest='runtime',
|
||||
help="Don't generate run-time requirements (implied by -N)",
|
||||
)
|
||||
parser.add_argument(
|
||||
'-N', '--no-use-build-system', dest='use_build_system',
|
||||
action='store_false', help='Use -N to indicate that project does not use any build system',
|
||||
)
|
||||
parser.add_argument(
|
||||
'requirement_files', nargs='*', type=argparse.FileType('r'),
|
||||
metavar='REQUIREMENTS.TXT',
|
||||
help=('Add buildrequires from file'),
|
||||
)
|
||||
parser.add_argument(
|
||||
'-C',
|
||||
dest='config_settings',
|
||||
action='append',
|
||||
help='Configuration settings to pass to the PEP 517 backend',
|
||||
)
|
||||
|
||||
args = parser.parse_args(argv)
|
||||
|
||||
if not args.use_build_system:
|
||||
args.runtime = False
|
||||
|
||||
if args.wheel:
|
||||
if not args.wheeldir:
|
||||
raise ValueError('--wheeldir must be set when -w.')
|
||||
|
||||
if args.toxenv:
|
||||
args.tox = True
|
||||
|
||||
if args.tox:
|
||||
args.runtime = True
|
||||
if not args.toxenv:
|
||||
_default = f'py{sys.version_info.major}{sys.version_info.minor}'
|
||||
args.toxenv = [os.getenv('RPM_TOXENV', _default)]
|
||||
|
||||
if args.extras:
|
||||
args.runtime = True
|
||||
|
||||
try:
|
||||
generate_requires(
|
||||
include_runtime=args.runtime,
|
||||
build_wheel=args.wheel,
|
||||
wheeldir=args.wheeldir,
|
||||
toxenv=args.toxenv,
|
||||
extras=args.extras,
|
||||
generate_extras=args.generate_extras,
|
||||
python3_pkgversion=args.python3_pkgversion,
|
||||
requirement_files=args.requirement_files,
|
||||
use_build_system=args.use_build_system,
|
||||
output=args.output,
|
||||
config_settings=parse_config_settings_args(args.config_settings),
|
||||
)
|
||||
except Exception:
|
||||
# Log the traceback explicitly (it's useful debug info)
|
||||
traceback.print_exc()
|
||||
exit(1)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main(sys.argv[1:])
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,15 @@
|
||||
import argparse
|
||||
import sys
|
||||
|
||||
|
||||
def main(argv):
|
||||
parser = argparse.ArgumentParser(
|
||||
description='Parse -e arguments instead of RPM getopt.'
|
||||
)
|
||||
parser.add_argument('-e', '--toxenv', action='append')
|
||||
args, _ = parser.parse_known_args(argv)
|
||||
return ','.join(args.toxenv)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
print(main(sys.argv[1:]))
|
||||
@ -0,0 +1,171 @@
|
||||
# Copyright 2019 Gordon Messmer <gordon.messmer@gmail.com>
|
||||
#
|
||||
# Upstream: https://github.com/gordonmessmer/pyreq2rpm
|
||||
#
|
||||
# Permission is hereby granted, free of charge, to any person
|
||||
# obtaining a copy of this software and associated documentation files
|
||||
# (the "Software"), to deal in the Software without restriction,
|
||||
# including without limitation the rights to use, copy, modify, merge,
|
||||
# publish, distribute, sublicense, and/or sell copies of the Software,
|
||||
# and to permit persons to whom the Software is furnished to do so,
|
||||
# subject to the following conditions:
|
||||
#
|
||||
# The above copyright notice and this permission notice shall be
|
||||
# included in all copies or substantial portions of the Software.
|
||||
#
|
||||
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
||||
# BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
||||
# ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
||||
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
# SOFTWARE.
|
||||
|
||||
from packaging.requirements import Requirement
|
||||
from packaging.version import parse as parse_version
|
||||
|
||||
class RpmVersion():
|
||||
def __init__(self, version_id):
|
||||
version = parse_version(version_id)
|
||||
if isinstance(version._version, str):
|
||||
self.version = version._version
|
||||
else:
|
||||
self.epoch = version._version.epoch
|
||||
self.version = list(version._version.release)
|
||||
self.pre = version._version.pre
|
||||
self.dev = version._version.dev
|
||||
self.post = version._version.post
|
||||
# version.local is ignored as it is not expected to appear
|
||||
# in public releases
|
||||
# https://www.python.org/dev/peps/pep-0440/#local-version-identifiers
|
||||
|
||||
def is_legacy(self):
|
||||
return isinstance(self.version, str)
|
||||
|
||||
def increment(self):
|
||||
self.version[-1] += 1
|
||||
self.pre = None
|
||||
self.dev = None
|
||||
self.post = None
|
||||
return self
|
||||
|
||||
def __str__(self):
|
||||
if self.is_legacy():
|
||||
return self.version
|
||||
if self.epoch:
|
||||
rpm_epoch = str(self.epoch) + ':'
|
||||
else:
|
||||
rpm_epoch = ''
|
||||
while len(self.version) > 1 and self.version[-1] == 0:
|
||||
self.version.pop()
|
||||
rpm_version = '.'.join(str(x) for x in self.version)
|
||||
if self.pre:
|
||||
rpm_suffix = '~{}'.format(''.join(str(x) for x in self.pre))
|
||||
elif self.dev:
|
||||
rpm_suffix = '~~{}'.format(''.join(str(x) for x in self.dev))
|
||||
elif self.post:
|
||||
rpm_suffix = '^post{}'.format(self.post[1])
|
||||
else:
|
||||
rpm_suffix = ''
|
||||
return '{}{}{}'.format(rpm_epoch, rpm_version, rpm_suffix)
|
||||
|
||||
def convert_compatible(name, operator, version_id):
|
||||
if version_id.endswith('.*'):
|
||||
return 'Invalid version'
|
||||
version = RpmVersion(version_id)
|
||||
if version.is_legacy():
|
||||
# LegacyVersions are not supported in this context
|
||||
return 'Invalid version'
|
||||
if len(version.version) == 1:
|
||||
return 'Invalid version'
|
||||
upper_version = RpmVersion(version_id)
|
||||
upper_version.version.pop()
|
||||
upper_version.increment()
|
||||
return '({} >= {} with {} < {})'.format(
|
||||
name, version, name, upper_version)
|
||||
|
||||
def convert_equal(name, operator, version_id):
|
||||
if version_id.endswith('.*'):
|
||||
version_id = version_id[:-2] + '.0'
|
||||
return convert_compatible(name, '~=', version_id)
|
||||
version = RpmVersion(version_id)
|
||||
return '{} = {}'.format(name, version)
|
||||
|
||||
def convert_arbitrary_equal(name, operator, version_id):
|
||||
if version_id.endswith('.*'):
|
||||
return 'Invalid version'
|
||||
version = RpmVersion(version_id)
|
||||
return '{} = {}'.format(name, version)
|
||||
|
||||
def convert_not_equal(name, operator, version_id):
|
||||
if version_id.endswith('.*'):
|
||||
version_id = version_id[:-2]
|
||||
version = RpmVersion(version_id)
|
||||
if version.is_legacy():
|
||||
# LegacyVersions are not supported in this context
|
||||
return 'Invalid version'
|
||||
version_gt = RpmVersion(version_id).increment()
|
||||
version_gt_operator = '>='
|
||||
# Prevent dev and pre-releases from satisfying a < requirement
|
||||
version = '{}~~'.format(version)
|
||||
else:
|
||||
version = RpmVersion(version_id)
|
||||
version_gt = version
|
||||
version_gt_operator = '>'
|
||||
return '({} < {} or {} {} {})'.format(
|
||||
name, version, name, version_gt_operator, version_gt)
|
||||
|
||||
def convert_ordered(name, operator, version_id):
|
||||
if version_id.endswith('.*'):
|
||||
# PEP 440 does not define semantics for prefix matching
|
||||
# with ordered comparisons
|
||||
# see: https://github.com/pypa/packaging/issues/320
|
||||
# and: https://github.com/pypa/packaging/issues/321
|
||||
# This style of specifier is officially "unsupported",
|
||||
# even though it is processed. Support may be removed
|
||||
# in version 21.0.
|
||||
version_id = version_id[:-2]
|
||||
version = RpmVersion(version_id)
|
||||
if operator == '>':
|
||||
# distutils will allow a prefix match with '>'
|
||||
operator = '>='
|
||||
if operator == '<=':
|
||||
# distutils will not allow a prefix match with '<='
|
||||
operator = '<'
|
||||
else:
|
||||
version = RpmVersion(version_id)
|
||||
# For backwards compatibility, fallback to previous behavior with LegacyVersions
|
||||
if not version.is_legacy():
|
||||
# Prevent dev and pre-releases from satisfying a < requirement
|
||||
if operator == '<' and not version.pre and not version.dev and not version.post:
|
||||
version = '{}~~'.format(version)
|
||||
# Prevent post-releases from satisfying a > requirement
|
||||
if operator == '>' and not version.pre and not version.dev and not version.post:
|
||||
version = '{}.0'.format(version)
|
||||
return '{} {} {}'.format(name, operator, version)
|
||||
|
||||
OPERATORS = {'~=': convert_compatible,
|
||||
'==': convert_equal,
|
||||
'===': convert_arbitrary_equal,
|
||||
'!=': convert_not_equal,
|
||||
'<=': convert_ordered,
|
||||
'<': convert_ordered,
|
||||
'>=': convert_ordered,
|
||||
'>': convert_ordered}
|
||||
|
||||
def convert(name, operator, version_id):
|
||||
return OPERATORS[operator](name, operator, version_id)
|
||||
|
||||
def convert_requirement(req):
|
||||
parsed_req = Requirement.parse(req)
|
||||
reqs = []
|
||||
for spec in parsed_req.specs:
|
||||
reqs.append(convert(parsed_req.project_name, spec[0], spec[1]))
|
||||
if len(reqs) == 0:
|
||||
return parsed_req.project_name
|
||||
if len(reqs) == 1:
|
||||
return reqs[0]
|
||||
else:
|
||||
reqs.sort()
|
||||
return '({})'.format(' with '.join(reqs))
|
||||
@ -0,0 +1,85 @@
|
||||
import argparse
|
||||
import csv
|
||||
import json
|
||||
import os
|
||||
from pathlib import PosixPath
|
||||
|
||||
from pyproject_save_files import BuildrootPath
|
||||
|
||||
|
||||
def read_record(record_path):
|
||||
"""
|
||||
A generator yielding individual RECORD triplets.
|
||||
|
||||
https://www.python.org/dev/peps/pep-0376/#record
|
||||
|
||||
The triplet is str-path, hash, size -- the last two optional.
|
||||
We will later care only for the paths anyway.
|
||||
|
||||
Example:
|
||||
|
||||
>>> g = read_record(PosixPath('./test_RECORD'))
|
||||
>>> next(g)
|
||||
['../../../bin/__pycache__/tldr.cpython-....pyc', '', '']
|
||||
>>> next(g)
|
||||
['../../../bin/tldr', 'sha256=...', '12766']
|
||||
>>> next(g)
|
||||
['../../../bin/tldr.py', 'sha256=...', '12766']
|
||||
"""
|
||||
with open(record_path, newline="", encoding="utf-8") as f:
|
||||
yield from csv.reader(
|
||||
f, delimiter=",", quotechar='"', lineterminator=os.linesep
|
||||
)
|
||||
|
||||
|
||||
def parse_record(record_path, record_content):
|
||||
"""
|
||||
Returns a list with BuildrootPaths parsed from record_content
|
||||
|
||||
params:
|
||||
record_path: RECORD BuildrootPath
|
||||
record_content: list of RECORD triplets
|
||||
first item is a str-path relative to directory where dist-info directory is
|
||||
(it can also be absolute according to the standard, but not from pip)
|
||||
|
||||
Examples:
|
||||
>>> parse_record(BuildrootPath('/usr/lib/python3.7/site-packages/requests-2.22.0.dist-info/RECORD'),
|
||||
... [('requests/sessions.py', 'sha256=xxx', '666')])
|
||||
['/usr/lib/python3.7/site-packages/requests/sessions.py']
|
||||
|
||||
>>> parse_record(BuildrootPath('/usr/lib/python3.7/site-packages/tldr-0.5.dist-info/RECORD'),
|
||||
... [('../../../bin/tldr', 'sha256=yyy', '777')])
|
||||
['/usr/bin/tldr']
|
||||
"""
|
||||
sitedir = record_path.parent.parent # trough the dist-info directory
|
||||
# / with absolute right operand will remove the left operand
|
||||
# any .. parts are resolved via normpath
|
||||
return [str((sitedir / row[0]).normpath()) for row in record_content]
|
||||
|
||||
|
||||
def save_parsed_record(record_path, parsed_record, output_file):
|
||||
content = {}
|
||||
if output_file.is_file():
|
||||
content = json.loads(output_file.read_text())
|
||||
content[str(record_path)] = parsed_record
|
||||
output_file.write_text(json.dumps(content))
|
||||
|
||||
|
||||
def main(cli_args):
|
||||
record_path = BuildrootPath.from_real(cli_args.record, root=cli_args.buildroot)
|
||||
parsed_record = parse_record(record_path, read_record(cli_args.record))
|
||||
save_parsed_record(record_path, parsed_record, cli_args.output)
|
||||
|
||||
|
||||
def argparser():
|
||||
parser = argparse.ArgumentParser()
|
||||
r = parser.add_argument_group("required arguments")
|
||||
r.add_argument("--buildroot", type=PosixPath, required=True)
|
||||
r.add_argument("--record", type=PosixPath, required=True)
|
||||
r.add_argument("--output", type=PosixPath, required=True)
|
||||
return parser
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
cli_args = argparser().parse_args()
|
||||
main(cli_args)
|
||||
@ -0,0 +1,101 @@
|
||||
"""Best-effort parser for requirements.txt files"""
|
||||
|
||||
import urllib.parse
|
||||
from pathlib import Path
|
||||
import sys
|
||||
import os
|
||||
import re
|
||||
|
||||
# `#` starts a comment only at end of line and after whitespace
|
||||
COMMENT_RE = re.compile(r'(^|\s+)#.*$')
|
||||
|
||||
# Assume URLs start with a scheme; don't look for "egg=" URLs otherwise
|
||||
URL_START_RE = re.compile(r'^[-_+a-zA-Z0-9]+://')
|
||||
|
||||
ENV_VAR_RE = re.compile(r'(?P<var>\$\{(?P<name>[A-Z0-9_]+)\})')
|
||||
PKGNAME_RE = re.compile(r'^[-_a-zA-Z0-9]+')
|
||||
|
||||
# The requirements.txt format evolved rather organically; expect weirdness.
|
||||
|
||||
def convert_requirements_txt(lines, path:Path = None):
|
||||
"""Convert lines of a requirements file to PEP 440-style requirement strs
|
||||
|
||||
This does NOT handle all of requirements.txt features (only pip can do
|
||||
that), but tries its best.
|
||||
|
||||
The resulting requirements might not actually be valid (either because
|
||||
they're wrong in the file, or because we missed a special case).
|
||||
|
||||
path is the path to the requirements.txt file, used for options like `-r`.
|
||||
"""
|
||||
requirements = []
|
||||
lines = combine_logical_lines(lines)
|
||||
lines = strip_comments(lines)
|
||||
lines = expand_env_vars(lines)
|
||||
if path:
|
||||
filename = path.name
|
||||
else:
|
||||
filename = '<requirements file>'
|
||||
for line in lines:
|
||||
if URL_START_RE.match(line):
|
||||
# Handle URLs with "egg=..." fragments
|
||||
# see https://pip.pypa.io/en/stable/cli/pip_install/#vcs-support
|
||||
parsed_url = urllib.parse.urlparse(line)
|
||||
parsed_fragment = urllib.parse.parse_qs(parsed_url.fragment)
|
||||
if 'egg' in parsed_fragment:
|
||||
# Prepend the package name to the URL.
|
||||
match = PKGNAME_RE.match(parsed_fragment['egg'][0])
|
||||
if match:
|
||||
pkg_name = match[0]
|
||||
requirements.append(f'{pkg_name}@{line}')
|
||||
continue
|
||||
# If that didn't work, pass the line on;
|
||||
# the caller will deal with invalid requirements
|
||||
requirements.append(line)
|
||||
elif line.startswith('-r'):
|
||||
recursed_path = line[2:].strip()
|
||||
if path:
|
||||
recursed_path = path.parent / recursed_path
|
||||
recursed_path = Path(recursed_path)
|
||||
with recursed_path.open() as f:
|
||||
requirements.extend(convert_requirements_txt(f, recursed_path))
|
||||
elif line.startswith('-'):
|
||||
raise ValueError(f'{filename}: unsupported requirements file option: {line}')
|
||||
else:
|
||||
requirements.append(line)
|
||||
return requirements
|
||||
|
||||
def combine_logical_lines(lines):
|
||||
"""Combine logical lines together (backslash line-continuation)"""
|
||||
pieces = []
|
||||
for line in lines:
|
||||
line = line.rstrip('\n')
|
||||
# Whole-line comments *only* are removed before line-contionuation
|
||||
if COMMENT_RE.match(line):
|
||||
continue
|
||||
if line.endswith('\\'):
|
||||
pieces.append(line[:-1])
|
||||
else:
|
||||
# trailing whitespace is only removed from full logical lines
|
||||
pieces.append(line.rstrip())
|
||||
yield ''.join(pieces)
|
||||
pieces = []
|
||||
yield ''.join(pieces)
|
||||
|
||||
|
||||
def strip_comments(lines):
|
||||
for line in lines:
|
||||
line, *rest = COMMENT_RE.split(line, maxsplit=1)
|
||||
line = line.strip()
|
||||
if line:
|
||||
yield line
|
||||
|
||||
|
||||
def expand_env_vars(lines):
|
||||
def repl(match):
|
||||
value = os.getenv(match['name'])
|
||||
if value is None:
|
||||
return match['var']
|
||||
return value
|
||||
for line in lines:
|
||||
yield ENV_VAR_RE.sub(repl, line)
|
||||
@ -0,0 +1,889 @@
|
||||
import argparse
|
||||
import fnmatch
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
|
||||
from collections import defaultdict
|
||||
from keyword import iskeyword
|
||||
from pathlib import PosixPath, PurePosixPath
|
||||
from importlib.metadata import Distribution
|
||||
|
||||
|
||||
# From RPM's build/files.c strtokWithQuotes delim argument
|
||||
RPM_FILES_DELIMETERS = ' \n\t'
|
||||
RPM_GLOB_SYMBOLS = '[]{}*?!'
|
||||
# Combined for escape_rpm_path_4_19()
|
||||
RPM_SPECIAL_SYMBOLS = RPM_FILES_DELIMETERS + RPM_GLOB_SYMBOLS + '"' + "\\"
|
||||
RPM_ESCAPE_REGEX = re.compile(f"([{re.escape(RPM_SPECIAL_SYMBOLS)}])")
|
||||
|
||||
# See the comment in the macro that wraps this script
|
||||
RPM_FILES_ESCAPE = os.getenv('RPM_FILES_ESCAPE', '4.19')
|
||||
|
||||
PYCACHED_SUFFIX = '{,.opt-?}.pyc'
|
||||
|
||||
# RPM hardcodes the lists of manpage extensions and directories,
|
||||
# so we have to maintain separate ones :(
|
||||
# There is an issue for RPM to provide the lists as macros:
|
||||
# https://github.com/rpm-software-management/rpm/issues/1865
|
||||
# The original lists can be found here:
|
||||
# https://github.com/rpm-software-management/rpm/blob/master/scripts/brp-compress
|
||||
MANPAGE_EXTENSIONS = ['gz', 'Z', 'bz2', 'xz', 'lzma', 'zst', 'zstd']
|
||||
MANDIRS = [
|
||||
'/man/man*',
|
||||
'/man/*/man*',
|
||||
'/info',
|
||||
'/share/man/man*',
|
||||
'/share/man/*/man*',
|
||||
'/share/info',
|
||||
'/kerberos/man',
|
||||
'/X11R6/man/man*',
|
||||
'/lib/perl5/man/man*',
|
||||
'/share/doc/*/man/man*',
|
||||
'/lib/*/man/man*',
|
||||
'/share/fish/man/man*',
|
||||
]
|
||||
|
||||
|
||||
class BuildrootPath(PurePosixPath):
|
||||
"""
|
||||
This path represents a path in a buildroot.
|
||||
When absolute, it is "relative" to a buildroot.
|
||||
|
||||
E.g. /usr/lib means %{buildroot}/usr/lib
|
||||
The object carries no buildroot information.
|
||||
"""
|
||||
|
||||
@staticmethod
|
||||
def from_real(realpath, *, root):
|
||||
"""
|
||||
For a given real disk path, return a BuildrootPath in the given root.
|
||||
|
||||
For example::
|
||||
|
||||
>>> BuildrootPath.from_real(PosixPath('/tmp/buildroot/foo'), root=PosixPath('/tmp/buildroot'))
|
||||
BuildrootPath('/foo')
|
||||
"""
|
||||
return BuildrootPath("/") / realpath.relative_to(root)
|
||||
|
||||
def to_real(self, root):
|
||||
"""
|
||||
Return a real PosixPath in the given root
|
||||
|
||||
For example::
|
||||
|
||||
>>> BuildrootPath('/foo').to_real(PosixPath('/tmp/buildroot'))
|
||||
PosixPath('/tmp/buildroot/foo')
|
||||
"""
|
||||
return root / self.relative_to("/")
|
||||
|
||||
def normpath(self):
|
||||
"""
|
||||
Normalize all the potential /../ parts of the path without touching real files.
|
||||
|
||||
PurePaths don't have .resolve().
|
||||
Paths have .resolve() but it touches real files.
|
||||
This is an alternative. It assumes there are no symbolic links.
|
||||
|
||||
Example:
|
||||
|
||||
>>> BuildrootPath('/usr/lib/python/../pypy').normpath()
|
||||
BuildrootPath('/usr/lib/pypy')
|
||||
"""
|
||||
return type(self)(os.path.normpath(self))
|
||||
|
||||
|
||||
def pycache_dir(script):
|
||||
"""
|
||||
For a script BuildrootPath, return a BuildrootPath of its __pycache__ directory.
|
||||
|
||||
Example:
|
||||
|
||||
>>> pycache_dir(BuildrootPath('/whatever/bar.py'))
|
||||
BuildrootPath('/whatever/__pycache__')
|
||||
|
||||
>>> pycache_dir(BuildrootPath('/opt/python3.10/foo.py'))
|
||||
BuildrootPath('/opt/python3.10/__pycache__')
|
||||
"""
|
||||
return script.parent / "__pycache__"
|
||||
|
||||
|
||||
def pycached(script, python_version):
|
||||
"""
|
||||
For a script BuildrootPath, return a list with that path and its bytecode glob.
|
||||
Like the %pycached macro.
|
||||
|
||||
The glob is represented as a BuildrootPath.
|
||||
|
||||
Examples:
|
||||
|
||||
>>> pycached(BuildrootPath('/whatever/bar.py'), '3.8')
|
||||
[BuildrootPath('/whatever/bar.py'), BuildrootPath('/whatever/__pycache__/bar.cpython-38{,.opt-?}.pyc')]
|
||||
|
||||
>>> pycached(BuildrootPath('/opt/python3.10/foo.py'), '3.10')
|
||||
[BuildrootPath('/opt/python3.10/foo.py'), BuildrootPath('/opt/python3.10/__pycache__/foo.cpython-310{,.opt-?}.pyc')]
|
||||
"""
|
||||
assert script.suffix == ".py"
|
||||
pyver = "".join(python_version.split(".")[:2])
|
||||
pycname = f"{script.stem}.cpython-{pyver}{PYCACHED_SUFFIX}"
|
||||
pyc = pycache_dir(script) / pycname
|
||||
pyc.glob_suffix_len = len(PYCACHED_SUFFIX)
|
||||
return [script, pyc]
|
||||
|
||||
|
||||
def add_file_to_module(paths, module_name, module_type, files_dirs, *files):
|
||||
"""
|
||||
Helper procedure, adds given files to the module_name of a given module_type
|
||||
"""
|
||||
for module in paths["modules"][module_name]:
|
||||
if module["type"] == module_type:
|
||||
if files[0] not in module[files_dirs]:
|
||||
module[files_dirs].extend(files)
|
||||
break
|
||||
else:
|
||||
paths["modules"][module_name].append(
|
||||
{"type": module_type, "files": [], "dirs": [], files_dirs: list(files)}
|
||||
)
|
||||
|
||||
|
||||
def add_py_file_to_module(paths, module_name, module_type, path, python_version,
|
||||
*, include_pycache_dir):
|
||||
"""
|
||||
Helper procedure, adds given .py file to the module_name of a given module_type
|
||||
Always also adds the bytecode cache.
|
||||
If include_pycache_dir is set, also include the __pycache__ directory.
|
||||
"""
|
||||
add_file_to_module(paths, module_name, module_type, "files", *pycached(path, python_version))
|
||||
if include_pycache_dir:
|
||||
add_file_to_module(paths, module_name, module_type, "dirs", pycache_dir(path))
|
||||
|
||||
|
||||
def add_lang_to_module(paths, module_name, path):
|
||||
"""
|
||||
Helper procedure, divides lang files by language and adds them to the module_name
|
||||
|
||||
Returns True if the language code detection was successful
|
||||
"""
|
||||
for i, parent in enumerate(path.parents):
|
||||
if parent.name == 'LC_MESSAGES':
|
||||
lang_country_code = path.parents[i+1].name
|
||||
break
|
||||
else:
|
||||
return False
|
||||
# convert potential en_US to plain en
|
||||
lang_code = lang_country_code.partition('_')[0]
|
||||
if module_name not in paths["lang"]:
|
||||
paths["lang"].update({module_name: defaultdict(list)})
|
||||
paths["lang"][module_name][lang_code].append(path)
|
||||
return True
|
||||
|
||||
|
||||
def prepend_mandirs(prefix):
|
||||
"""
|
||||
Return the list of man page directories prepended with the given prefix.
|
||||
"""
|
||||
return [str(prefix) + mandir for mandir in MANDIRS]
|
||||
|
||||
|
||||
def normalize_manpage_filename(prefix, path):
|
||||
"""
|
||||
If a path is processed by RPM's brp-compress script, strip it of the extension
|
||||
(if the extension matches one of the listed by brp-compress),
|
||||
append '*' to the filename and return it. If not, return the unchanged path.
|
||||
Rationale: https://docs.fedoraproject.org/en-US/packaging-guidelines/#_manpages
|
||||
|
||||
Examples:
|
||||
|
||||
>>> normalize_manpage_filename(PosixPath('/usr'), BuildrootPath('/usr/share/man/de/man1/linkchecker.1'))
|
||||
BuildrootPath('/usr/share/man/de/man1/linkchecker.1*')
|
||||
|
||||
>>> normalize_manpage_filename(PosixPath('/usr'), BuildrootPath('/usr/share/doc/en/man/man1/getmac.1'))
|
||||
BuildrootPath('/usr/share/doc/en/man/man1/getmac.1*')
|
||||
|
||||
>>> normalize_manpage_filename(PosixPath('/usr'), BuildrootPath('/usr/share/man/man8/abc.8.zstd'))
|
||||
BuildrootPath('/usr/share/man/man8/abc.8*')
|
||||
|
||||
>>> normalize_manpage_filename(PosixPath('/usr'), BuildrootPath('/usr/kerberos/man/dir'))
|
||||
BuildrootPath('/usr/kerberos/man/dir')
|
||||
|
||||
>>> normalize_manpage_filename(PosixPath('/usr'), BuildrootPath('/usr/kerberos/man/dir.1'))
|
||||
BuildrootPath('/usr/kerberos/man/dir.1*')
|
||||
|
||||
>>> normalize_manpage_filename(PosixPath('/usr'), BuildrootPath('/usr/bin/getmac'))
|
||||
BuildrootPath('/usr/bin/getmac')
|
||||
"""
|
||||
|
||||
prefixed_mandirs = prepend_mandirs(prefix)
|
||||
for mandir in prefixed_mandirs:
|
||||
# "dir" is explicitly excluded by RPM
|
||||
# https://github.com/rpm-software-management/rpm/blob/rpm-4.17.0-release/scripts/brp-compress#L24
|
||||
if fnmatch.fnmatch(str(path.parent), mandir) and path.name != "dir":
|
||||
# "abc.1.gz2" -> "abc.1*"
|
||||
if path.suffix[1:] in MANPAGE_EXTENSIONS:
|
||||
path = BuildrootPath(path.parent / (path.stem + "*"))
|
||||
# "abc.1 -> abc.1*"
|
||||
else:
|
||||
path = BuildrootPath(path.parent / (path.name + "*"))
|
||||
path.glob_suffix_len = 1
|
||||
return path
|
||||
else:
|
||||
return path
|
||||
|
||||
|
||||
def is_valid_module_name(s):
|
||||
"""Return True if a string is considered a valid module name and False otherwise.
|
||||
|
||||
String must be a valid Python name, not a Python keyword and must not
|
||||
start with underscore - we treat those as private.
|
||||
Examples:
|
||||
|
||||
>>> is_valid_module_name('module_name')
|
||||
True
|
||||
|
||||
>>> is_valid_module_name('12module_name')
|
||||
False
|
||||
|
||||
>>> is_valid_module_name('module-name')
|
||||
False
|
||||
|
||||
>>> is_valid_module_name('return')
|
||||
False
|
||||
|
||||
>>> is_valid_module_name('_module_name')
|
||||
False
|
||||
"""
|
||||
if (s.isidentifier() and not iskeyword(s) and not s.startswith("_")):
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
def module_names_from_path(path):
|
||||
"""Get all importable module names from given path.
|
||||
|
||||
Paths containing ".py" and ".so" files are considered importable modules,
|
||||
and so their respective directories (ie. "foo/bar/baz.py": "foo", "foo.bar",
|
||||
"foo.bar.baz").
|
||||
Paths containing invalid Python strings are discarded.
|
||||
|
||||
Return set of all valid possibilities.
|
||||
"""
|
||||
# Discard all files that are not valid modules
|
||||
if path.suffix not in (".py", ".so"):
|
||||
return set()
|
||||
|
||||
parts = list(path.parts)
|
||||
|
||||
# Modify the file names according to their suffixes
|
||||
if path.suffix == ".py":
|
||||
parts[-1] = path.stem
|
||||
elif path.suffix == ".so":
|
||||
# .so files can have two suffixes - cut both of them
|
||||
parts[-1] = PosixPath(path.stem).stem
|
||||
|
||||
# '__init__' indicates a module but we don't want to import the actual file
|
||||
# It's unclear whether there can be __init__.so files in the Python packages.
|
||||
# The idea to implement this file was raised in 2008 on Python-ideas mailing list
|
||||
# (https://mail.python.org/pipermail/python-ideas/2008-October/002292.html)
|
||||
# and there are a few reports of people compiling their __init__.py to __init__.so.
|
||||
# However it's not officially documented nor forbidden,
|
||||
# so we're checking for the stem after stripping the suffix from the file.
|
||||
if parts[-1] == "__init__":
|
||||
del parts[-1]
|
||||
|
||||
# For each part of the path check whether it's valid
|
||||
# If not, discard the whole path - return an empty set
|
||||
for path_part in parts:
|
||||
if not is_valid_module_name(path_part):
|
||||
return set()
|
||||
else:
|
||||
return {'.'.join(parts[:x+1]) for x in range(len(parts))}
|
||||
|
||||
|
||||
def is_license_file(path, license_files, license_directories):
|
||||
"""
|
||||
Check if the given BuildrootPath path matches any of the "License-File" entries.
|
||||
The path is considered matched when resolved from any of the license_directories
|
||||
matches string-wise what is stored in any "License-File" entry (license_files).
|
||||
|
||||
Examples:
|
||||
>>> site_packages = BuildrootPath('/usr/lib/python3.12/site-packages')
|
||||
>>> distinfo = site_packages / 'foo-1.0.dist-info'
|
||||
>>> license_directories = [distinfo / 'licenses', distinfo]
|
||||
>>> license_files = ['LICENSE.txt', 'AUTHORS.md']
|
||||
>>> is_license_file(distinfo / 'AUTHORS.md', license_files, license_directories)
|
||||
True
|
||||
>>> is_license_file(distinfo / 'licenses/LICENSE.txt', license_files, license_directories)
|
||||
True
|
||||
>>> # we don't match based on directory only
|
||||
>>> is_license_file(distinfo / 'licenses/COPYING', license_files, license_directories)
|
||||
False
|
||||
>>> is_license_file(site_packages / 'foo/LICENSE.txt', license_files, license_directories)
|
||||
False
|
||||
"""
|
||||
if not license_files or not license_directories:
|
||||
return False
|
||||
for license_dir in license_directories:
|
||||
if (path.is_relative_to(license_dir) and
|
||||
str(path.relative_to(license_dir)) in license_files):
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
def classify_paths(
|
||||
record_path, parsed_record_content, metadata, sitedirs, python_version, prefix
|
||||
):
|
||||
"""
|
||||
For each BuildrootPath in parsed_record_content classify it to a dict structure
|
||||
that allows to filter the files for the %files and %check section easier.
|
||||
|
||||
For the dict structure, look at the beginning of this function's code.
|
||||
|
||||
Each "module" is a dict with "type" ("package", "script", "extension"), and "files" and "dirs".
|
||||
"""
|
||||
distinfo = record_path.parent
|
||||
paths = {
|
||||
"metadata": {
|
||||
"files": [], # regular %file entries with dist-info content
|
||||
"dirs": [distinfo], # %dir %file entries with dist-info directory
|
||||
"docs": [], # to be used once there is upstream way to recognize READMEs
|
||||
"licenses": [], # %license entries parsed from dist-info METADATA file
|
||||
},
|
||||
"lang": {}, # %lang entries: [module_name or None][language_code] lists of .mo files
|
||||
"modules": defaultdict(list), # each importable module (directory, .py, .so)
|
||||
"module_names": set(), # qualified names of each importable module ("foo.bar.baz")
|
||||
"other": {"files": []}, # regular %file entries we could not parse :(
|
||||
}
|
||||
|
||||
license_files = metadata.get_all('License-File')
|
||||
license_directory = distinfo / 'licenses' # See PEP 639 "Root License Directory"
|
||||
# setuptools was the first known build backend to implement License-File.
|
||||
# Unfortunately they don't put licenses to the license directory (yet):
|
||||
# https://github.com/pypa/setuptools/issues/3596
|
||||
# Hence, we check licenses in both licenses and dist-info
|
||||
license_directories = (license_directory, distinfo)
|
||||
|
||||
# In RECORDs generated by pip, there are no directories, only files.
|
||||
# The example RECORD from PEP 376 does not contain directories either.
|
||||
# Hence, we'll only assume files, but TODO get it officially documented.
|
||||
for path in parsed_record_content:
|
||||
if path.suffix == ".pyc":
|
||||
# we handle bytecode separately
|
||||
continue
|
||||
|
||||
if distinfo in path.parents:
|
||||
if path.parent == distinfo and path.name in ("RECORD", "REQUESTED"):
|
||||
# RECORD and REQUESTED files are removed in %pyproject_install
|
||||
# See PEP 627
|
||||
continue
|
||||
if is_license_file(path, license_files, license_directories):
|
||||
paths["metadata"]["licenses"].append(path)
|
||||
else:
|
||||
paths["metadata"]["files"].append(path)
|
||||
# nested directories within distinfo
|
||||
index = path.parents.index(distinfo)
|
||||
for parent in list(path.parents)[:index]: # no direct slice until Python 3.10
|
||||
if parent not in paths["metadata"]["dirs"]:
|
||||
paths["metadata"]["dirs"].append(parent)
|
||||
continue
|
||||
|
||||
for sitedir in sitedirs:
|
||||
if sitedir in path.parents:
|
||||
# Get only the part without sitedir prefix to classify module names
|
||||
relative_path = path.relative_to(sitedir)
|
||||
paths["module_names"].update(module_names_from_path(relative_path))
|
||||
if path.parent == sitedir:
|
||||
if path.suffix == ".so":
|
||||
# extension modules can have 2 suffixes
|
||||
name = BuildrootPath(path.stem).stem
|
||||
add_file_to_module(paths, name, "extension", "files", path)
|
||||
elif path.suffix == ".py":
|
||||
name = path.stem
|
||||
# we add the .pyc files, but not top-level __pycache__
|
||||
add_py_file_to_module(
|
||||
paths, name, "script", path, python_version,
|
||||
include_pycache_dir=False
|
||||
)
|
||||
else:
|
||||
paths["other"]["files"].append(path)
|
||||
else:
|
||||
# this file is inside a dir, we add all dirs upwards until sitedir
|
||||
index = path.parents.index(sitedir)
|
||||
module_dir = path.parents[index - 1]
|
||||
for parent in list(path.parents)[:index]: # no direct slice until Python 3.10
|
||||
add_file_to_module(paths, module_dir.name, "package", "dirs", parent)
|
||||
is_lang = False
|
||||
if path.suffix == ".mo":
|
||||
is_lang = add_lang_to_module(paths, module_dir.name, path)
|
||||
if not is_lang:
|
||||
if path.suffix == ".py":
|
||||
# we add the .pyc files, and their __pycache__
|
||||
add_py_file_to_module(
|
||||
paths, module_dir.name, "package", path, python_version,
|
||||
include_pycache_dir=True
|
||||
)
|
||||
else:
|
||||
add_file_to_module(paths, module_dir.name, "package", "files", path)
|
||||
break
|
||||
else:
|
||||
if path.suffix == ".mo":
|
||||
add_lang_to_module(paths, None, path) or paths["other"]["files"].append(path)
|
||||
else:
|
||||
path = normalize_manpage_filename(prefix, path)
|
||||
paths["other"]["files"].append(path)
|
||||
|
||||
return paths
|
||||
|
||||
|
||||
def escape_rpm_path_4_19(path):
|
||||
r"""
|
||||
Escape special characters in string-paths or BuildrootPaths, RPM >= 4.19
|
||||
|
||||
E.g. a space in path otherwise makes RPM think it's multiple paths,
|
||||
unless we escape it.
|
||||
Or a literal % symbol in path might be expanded as a macro if not escaped by %%.
|
||||
|
||||
See https://github.com/rpm-software-management/rpm/pull/2103
|
||||
and https://github.com/rpm-software-management/rpm/pull/2206
|
||||
|
||||
If the path ends with a glob produced by our other functions,
|
||||
we cannot escape that part.
|
||||
The BuildrootPath.glob_suffix_len attribute is used to indicate such globs.
|
||||
When such suffix exists, it is not escaped.
|
||||
|
||||
|
||||
Examples:
|
||||
|
||||
>>> escape_rpm_path_4_19(BuildrootPath('/usr/lib/python3.9/site-packages/setuptools'))
|
||||
'/usr/lib/python3.9/site-packages/setuptools'
|
||||
|
||||
>>> escape_rpm_path_4_19('/usr/lib/python3.9/site-packages/setuptools/script (dev).tmpl')
|
||||
'/usr/lib/python3.9/site-packages/setuptools/script\\ (dev).tmpl'
|
||||
|
||||
>>> escape_rpm_path_4_19('/usr/share/data/100%valid.path')
|
||||
'/usr/share/data/100%%valid.path'
|
||||
|
||||
>>> escape_rpm_path_4_19('/usr/share/data/100 % valid.path')
|
||||
'/usr/share/data/100\\ %%\\ valid.path'
|
||||
|
||||
>>> escape_rpm_path_4_19('/usr/share/data/1000 %% valid.path')
|
||||
'/usr/share/data/1000\\ %%%%\\ valid.path'
|
||||
|
||||
>>> escape_rpm_path_4_19('/usr/share/data/spaces and "quotes" and ?')
|
||||
'/usr/share/data/spaces\\ and\\ \\"quotes\\"\\ and\\ \\?'
|
||||
|
||||
>>> escape_rpm_path_4_19('/usr/share/data/spaces and [square brackets]')
|
||||
'/usr/share/data/spaces\\ and\\ \\[square\\ brackets\\]'
|
||||
|
||||
>>> path = BuildrootPath('/whatever/__pycache__/bar.cpython-38{,.opt-?}.pyc')
|
||||
>>> path.glob_suffix_len = len('{,.opt-?}.pyc')
|
||||
>>> escape_rpm_path_4_19(path)
|
||||
'/whatever/__pycache__/bar.cpython-38{,.opt-?}.pyc'
|
||||
|
||||
>>> path = BuildrootPath('/spa ces/__pycache__/bar.cpython-38{,.opt-?}.pyc')
|
||||
>>> path.glob_suffix_len = len('{,.opt-?}.pyc')
|
||||
>>> escape_rpm_path_4_19(path)
|
||||
'/spa\\ ces/__pycache__/bar.cpython-38{,.opt-?}.pyc'
|
||||
|
||||
>>> path = BuildrootPath('/usr/man/man5/ipykernel.5*')
|
||||
>>> path.glob_suffix_len = 1
|
||||
>>> escape_rpm_path_4_19(path)
|
||||
'/usr/man/man5/ipykernel.5*'
|
||||
"""
|
||||
glob_suffix_len = getattr(path, "glob_suffix_len", 0)
|
||||
suffix = ""
|
||||
path = str(path)
|
||||
if glob_suffix_len:
|
||||
suffix = path[-glob_suffix_len:]
|
||||
path = path[:-glob_suffix_len]
|
||||
if "%" in path:
|
||||
path = path.replace("%", "%%")
|
||||
# Prepend all matched/special characters (\1) with a backslash (escaped, hence \\):
|
||||
return RPM_ESCAPE_REGEX.sub(r'\\\1', path) + suffix
|
||||
|
||||
|
||||
def escape_rpm_path_4_18(path):
|
||||
"""
|
||||
Escape special characters in string-paths or BuildrootPaths, RPM < 4.19
|
||||
|
||||
E.g. a space in path otherwise makes RPM think it's multiple paths,
|
||||
unless we put it in "quotes".
|
||||
Or a literal % symbol in path might be expanded as a macro if not escaped.
|
||||
|
||||
Due to limitations in RPM < 4.19,
|
||||
some paths with spaces and other special characters are not supported.
|
||||
|
||||
See this thread http://lists.rpm.org/pipermail/rpm-list/2021-June/002048.html
|
||||
|
||||
Examples:
|
||||
|
||||
>>> escape_rpm_path_4_18(BuildrootPath('/usr/lib/python3.9/site-packages/setuptools'))
|
||||
'/usr/lib/python3.9/site-packages/setuptools'
|
||||
|
||||
>>> escape_rpm_path_4_18('/usr/lib/python3.9/site-packages/setuptools/script (dev).tmpl')
|
||||
'"/usr/lib/python3.9/site-packages/setuptools/script (dev).tmpl"'
|
||||
|
||||
>>> escape_rpm_path_4_18('/usr/share/data/100%valid.path')
|
||||
'/usr/share/data/100%%%%%%%%valid.path'
|
||||
|
||||
>>> escape_rpm_path_4_18('/usr/share/data/100 % valid.path')
|
||||
'"/usr/share/data/100 %%%%%%%% valid.path"'
|
||||
|
||||
>>> escape_rpm_path_4_18('/usr/share/data/1000 %% valid.path')
|
||||
'"/usr/share/data/1000 %%%%%%%%%%%%%%%% valid.path"'
|
||||
|
||||
>>> escape_rpm_path_4_18('/usr/share/data/spaces and "quotes"')
|
||||
Traceback (most recent call last):
|
||||
...
|
||||
NotImplementedError: ...
|
||||
|
||||
>>> escape_rpm_path_4_18('/usr/share/data/spaces and [square brackets]')
|
||||
Traceback (most recent call last):
|
||||
...
|
||||
NotImplementedError: ...
|
||||
"""
|
||||
orig_path = path = str(path)
|
||||
if "%" in path:
|
||||
# Escaping an actual percentage sign in path by 8 signs
|
||||
# has been verified in RPM 4.16 and 4.17:
|
||||
path = path.replace("%", "%" * 8)
|
||||
if any(symbol in path for symbol in RPM_FILES_DELIMETERS):
|
||||
if '"' in path:
|
||||
# As far as we know, RPM < 4.19 cannot list such file individually
|
||||
# See this thread http://lists.rpm.org/pipermail/rpm-list/2021-June/002048.html
|
||||
raise NotImplementedError(f'" symbol in path with spaces is not supported by %pyproject_save_files on RPM < 4.19: {orig_path!r}')
|
||||
if "[" in path or "]" in path:
|
||||
# See https://bugzilla.redhat.com/show_bug.cgi?id=1990879
|
||||
# and https://github.com/rpm-software-management/rpm/issues/1749
|
||||
raise NotImplementedError(f'[ or ] symbol in path with spaces is not supported by %pyproject_save_files on RPM < 4.19: {orig_path!r}')
|
||||
return f'"{path}"'
|
||||
return path
|
||||
|
||||
|
||||
if RPM_FILES_ESCAPE == "4.19":
|
||||
escape_rpm_path = escape_rpm_path_4_19
|
||||
elif RPM_FILES_ESCAPE == "4.18":
|
||||
escape_rpm_path = escape_rpm_path_4_18
|
||||
else:
|
||||
raise RuntimeError("RPM_FILES_ESCAPE must be 4.18 or 4.19")
|
||||
|
||||
|
||||
def generate_file_list(paths_dict, module_globs, include_others=False):
|
||||
"""
|
||||
This function takes the classified paths_dict and turns it into lines
|
||||
for the %files section. Returns list with text lines, no Path objects.
|
||||
|
||||
Only includes files from modules that match module_globs, metadata and
|
||||
optionaly all other files.
|
||||
|
||||
It asserts that all globs match at least one module, raises ValueError otherwise.
|
||||
Multiple globs matching identical module(s) are OK.
|
||||
"""
|
||||
files = set()
|
||||
|
||||
if include_others:
|
||||
files.update(f"{escape_rpm_path(p)}" for p in paths_dict["other"]["files"])
|
||||
try:
|
||||
for lang_code in paths_dict["lang"][None]:
|
||||
files.update(f"%lang({lang_code}) {escape_rpm_path(p)}" for p in paths_dict["lang"][None][lang_code])
|
||||
except KeyError:
|
||||
pass
|
||||
|
||||
files.update(f"{escape_rpm_path(p)}" for p in paths_dict["metadata"]["files"])
|
||||
for macro in "dir", "doc", "license":
|
||||
files.update(f"%{macro} {escape_rpm_path(p)}" for p in paths_dict["metadata"][f"{macro}s"])
|
||||
|
||||
modules = paths_dict["modules"]
|
||||
done_modules = set()
|
||||
done_globs = set()
|
||||
|
||||
for glob in module_globs:
|
||||
for name in modules:
|
||||
if fnmatch.fnmatchcase(name, glob):
|
||||
if name not in done_modules:
|
||||
try:
|
||||
for lang_code in paths_dict["lang"][name]:
|
||||
files.update(f"%lang({lang_code}) {escape_rpm_path(p)}" for p in paths_dict["lang"][name][lang_code])
|
||||
except KeyError:
|
||||
pass
|
||||
for module in modules[name]:
|
||||
files.update(f"%dir {escape_rpm_path(p)}" for p in module["dirs"])
|
||||
files.update(f"{escape_rpm_path(p)}" for p in module["files"])
|
||||
done_modules.add(name)
|
||||
done_globs.add(glob)
|
||||
|
||||
# Users using '*' don't care about the files in the package, so it's ok
|
||||
# not to fail the build when no modules are detected
|
||||
# There can be legitimate reasons to create a package without Python modules
|
||||
if not modules and fnmatch.fnmatchcase("", glob):
|
||||
done_globs.add(glob)
|
||||
|
||||
missed = module_globs - done_globs
|
||||
if missed:
|
||||
missed_text = ", ".join(sorted(missed))
|
||||
raise ValueError(f"Globs did not match any module: {missed_text}")
|
||||
|
||||
return sorted(files)
|
||||
|
||||
|
||||
def generate_module_list(paths_dict, module_globs):
|
||||
"""
|
||||
This function takes the paths_dict created by the classify_paths() function and
|
||||
reads the modules names from it.
|
||||
It filters those whose top-level module names match any of the provided module_globs.
|
||||
|
||||
Returns list with matching qualified module names.
|
||||
|
||||
Examples:
|
||||
|
||||
>>> generate_module_list({'module_names': {'foo', 'foo.bar', 'baz'}}, {'foo'})
|
||||
['foo', 'foo.bar']
|
||||
|
||||
>>> generate_module_list({'module_names': {'foo', 'foo.bar', 'baz'}}, {'*foo'})
|
||||
['foo', 'foo.bar']
|
||||
|
||||
>>> generate_module_list({'module_names': {'foo', 'foo.bar', 'baz'}}, {'foo', 'baz'})
|
||||
['baz', 'foo', 'foo.bar']
|
||||
|
||||
>>> generate_module_list({'module_names': {'foo', 'foo.bar', 'baz'}}, {'*'})
|
||||
['baz', 'foo', 'foo.bar']
|
||||
|
||||
>>> generate_module_list({'module_names': {'foo', 'foo.bar', 'baz'}}, {'bar'})
|
||||
[]
|
||||
|
||||
Submodules aren't discovered:
|
||||
|
||||
>>> generate_module_list({'module_names': {'foo', 'foo.bar', 'baz'}}, {'*bar'})
|
||||
[]
|
||||
"""
|
||||
|
||||
module_names = paths_dict['module_names']
|
||||
filtered_module_names = set()
|
||||
|
||||
for glob in module_globs:
|
||||
for name in module_names:
|
||||
# Match the top-level part of the qualified name, eg. 'foo.bar.baz' -> 'foo'
|
||||
top_level_name = name.split('.')[0]
|
||||
if fnmatch.fnmatchcase(top_level_name, glob):
|
||||
filtered_module_names.add(name)
|
||||
|
||||
return sorted(filtered_module_names)
|
||||
|
||||
|
||||
def parse_varargs(varargs):
|
||||
"""
|
||||
Parse varargs from the %pyproject_save_files macro
|
||||
|
||||
Arguments starting with + are treated as a flags, everything else is a glob
|
||||
|
||||
Returns as set of globs, boolean flag whether to include all the other files
|
||||
|
||||
Raises ValueError for unknown flags and globs with dots (namespace packages).
|
||||
|
||||
Good examples:
|
||||
|
||||
>>> parse_varargs(['*'])
|
||||
({'*'}, False)
|
||||
|
||||
>>> mods, auto = parse_varargs(['requests*', 'kerberos', '+auto'])
|
||||
>>> auto
|
||||
True
|
||||
>>> sorted(mods)
|
||||
['kerberos', 'requests*']
|
||||
|
||||
>>> mods, auto = parse_varargs(['tldr', 'tensorf*'])
|
||||
>>> auto
|
||||
False
|
||||
>>> sorted(mods)
|
||||
['tensorf*', 'tldr']
|
||||
|
||||
>>> parse_varargs(['+auto'])
|
||||
(set(), True)
|
||||
|
||||
Bad examples:
|
||||
|
||||
>>> parse_varargs(['+kinkdir'])
|
||||
Traceback (most recent call last):
|
||||
...
|
||||
ValueError: Invalid argument: +kinkdir
|
||||
|
||||
>>> parse_varargs(['good', '+bad', '*ugly*'])
|
||||
Traceback (most recent call last):
|
||||
...
|
||||
ValueError: Invalid argument: +bad
|
||||
|
||||
>>> parse_varargs(['+bad', 'my.bad'])
|
||||
Traceback (most recent call last):
|
||||
...
|
||||
ValueError: Invalid argument: +bad
|
||||
|
||||
>>> parse_varargs(['mod', 'mod.*'])
|
||||
Traceback (most recent call last):
|
||||
...
|
||||
ValueError: Attempted to use a namespaced package with . in the glob: mod.*. ...
|
||||
|
||||
>>> parse_varargs(['my.bad', '+bad'])
|
||||
Traceback (most recent call last):
|
||||
...
|
||||
ValueError: Attempted to use a namespaced package with . in the glob: my.bad. ...
|
||||
|
||||
>>> parse_varargs(['mod/submod'])
|
||||
Traceback (most recent call last):
|
||||
...
|
||||
ValueError: Attempted to use a namespaced package with / in the glob: mod/submod. ...
|
||||
"""
|
||||
include_auto = False
|
||||
globs = set()
|
||||
namespace_error_template = (
|
||||
"Attempted to use a namespaced package with {symbol} in the glob: {arg}. "
|
||||
"That is not (yet) supported. Use {top} instead and see "
|
||||
"https://bugzilla.redhat.com/1935266 for details."
|
||||
)
|
||||
for arg in varargs:
|
||||
if arg.startswith("+"):
|
||||
if arg == "+auto":
|
||||
include_auto = True
|
||||
else:
|
||||
raise ValueError(f"Invalid argument: {arg}")
|
||||
elif "." in arg:
|
||||
top, *_ = arg.partition(".")
|
||||
raise ValueError(namespace_error_template.format(symbol=".", arg=arg, top=top))
|
||||
elif "/" in arg:
|
||||
top, *_ = arg.partition("/")
|
||||
raise ValueError(namespace_error_template.format(symbol="/", arg=arg, top=top))
|
||||
else:
|
||||
globs.add(arg)
|
||||
|
||||
return globs, include_auto
|
||||
|
||||
|
||||
def load_parsed_record(pyproject_record):
|
||||
parsed_record = {}
|
||||
with open(pyproject_record) as pyproject_record_file:
|
||||
content = json.load(pyproject_record_file)
|
||||
|
||||
if len(content) > 1:
|
||||
raise FileExistsError("%pyproject_install has found more than one *.dist-info/RECORD file. "
|
||||
"Currently, %pyproject_save_files supports only one wheel → one file list mapping. "
|
||||
"Feel free to open a bugzilla for pyproject-rpm-macros and describe your usecase.")
|
||||
|
||||
# Redefine strings stored in JSON to BuildRootPaths
|
||||
for record_path, files in content.items():
|
||||
parsed_record[BuildrootPath(record_path)] = [BuildrootPath(f) for f in files]
|
||||
|
||||
return parsed_record
|
||||
|
||||
|
||||
def dist_metadata(buildroot, record_path):
|
||||
"""
|
||||
Returns distribution metadata (email.message.EmailMessage), possibly empty
|
||||
"""
|
||||
real_dist_path = record_path.parent.to_real(buildroot)
|
||||
dist = Distribution.at(real_dist_path)
|
||||
return dist.metadata
|
||||
|
||||
|
||||
def pyproject_save_files_and_modules(buildroot, sitelib, sitearch, python_version, pyproject_record, prefix, assert_license, varargs):
|
||||
"""
|
||||
Takes arguments from the %{pyproject_save_files} macro
|
||||
|
||||
Returns tuple: list of paths for the %files section and list of module names
|
||||
for the %check section
|
||||
|
||||
Raises ValueError when assert_license is true and no License-File (PEP 639)
|
||||
is found.
|
||||
"""
|
||||
# On 32 bit architectures, sitelib equals to sitearch
|
||||
# This saves us browsing one directory twice
|
||||
sitedirs = sorted({sitelib, sitearch})
|
||||
|
||||
globs, include_auto = parse_varargs(varargs)
|
||||
parsed_records = load_parsed_record(pyproject_record)
|
||||
|
||||
final_file_list = []
|
||||
final_module_list = []
|
||||
|
||||
# we assume OK when not asserting
|
||||
license_ok = not assert_license
|
||||
|
||||
for record_path, files in parsed_records.items():
|
||||
metadata = dist_metadata(buildroot, record_path)
|
||||
paths_dict = classify_paths(
|
||||
record_path, files, metadata, sitedirs, python_version, prefix
|
||||
)
|
||||
license_ok = license_ok or bool(paths_dict["metadata"]["licenses"])
|
||||
|
||||
final_file_list.extend(
|
||||
generate_file_list(paths_dict, globs, include_auto)
|
||||
)
|
||||
final_module_list.extend(
|
||||
generate_module_list(paths_dict, globs)
|
||||
)
|
||||
|
||||
if not license_ok:
|
||||
raise ValueError(
|
||||
"No License-File (PEP 639) in upstream metadata found. "
|
||||
"Adjust the upstream metadata "
|
||||
"if the project's build backend supports PEP 639 "
|
||||
"or use `%pyproject_save_files -L` "
|
||||
"and include the %license file in %files manually."
|
||||
)
|
||||
|
||||
return final_file_list, final_module_list
|
||||
|
||||
|
||||
def main(cli_args):
|
||||
file_section, module_names = pyproject_save_files_and_modules(
|
||||
cli_args.buildroot,
|
||||
cli_args.sitelib,
|
||||
cli_args.sitearch,
|
||||
cli_args.python_version,
|
||||
cli_args.pyproject_record,
|
||||
cli_args.prefix,
|
||||
cli_args.assert_license,
|
||||
cli_args.varargs,
|
||||
)
|
||||
|
||||
cli_args.output_files.write_text("\n".join(file_section) + "\n", encoding="utf-8")
|
||||
cli_args.output_modules.write_text("\n".join(module_names) + "\n", encoding="utf-8")
|
||||
|
||||
|
||||
def argparser():
|
||||
parser = argparse.ArgumentParser(
|
||||
description="Create %{pyproject_files} for a Python project.",
|
||||
prog="%pyproject_save_files",
|
||||
add_help=False,
|
||||
# custom usage to add +auto
|
||||
usage="%(prog)s [-l|-L] MODULE_GLOB [MODULE_GLOB ...] [+auto]",
|
||||
)
|
||||
parser.add_argument(
|
||||
'--help', action='help',
|
||||
default=argparse.SUPPRESS,
|
||||
help=argparse.SUPPRESS,
|
||||
)
|
||||
r = parser.add_argument_group("required arguments")
|
||||
r.add_argument("--output-files", type=PosixPath, required=True, help=argparse.SUPPRESS)
|
||||
r.add_argument("--output-modules", type=PosixPath, required=True, help=argparse.SUPPRESS)
|
||||
r.add_argument("--buildroot", type=PosixPath, required=True, help=argparse.SUPPRESS)
|
||||
r.add_argument("--sitelib", type=BuildrootPath, required=True, help=argparse.SUPPRESS)
|
||||
r.add_argument("--sitearch", type=BuildrootPath, required=True, help=argparse.SUPPRESS)
|
||||
r.add_argument("--python-version", type=str, required=True, help=argparse.SUPPRESS)
|
||||
r.add_argument("--pyproject-record", type=PosixPath, required=True, help=argparse.SUPPRESS)
|
||||
r.add_argument("--prefix", type=PosixPath, required=True, help=argparse.SUPPRESS)
|
||||
parser.add_argument(
|
||||
"-l", "--assert-license", action="store_true", default=False,
|
||||
help="Fail when no License-File (PEP 639) is found.",
|
||||
)
|
||||
parser.add_argument(
|
||||
"-L", "--no-assert-license", action="store_false", dest="assert_license",
|
||||
help="Don't fail when no License-File (PEP 639) is found (the default).",
|
||||
)
|
||||
parser.add_argument(
|
||||
"varargs", nargs="+", metavar="MODULE_GLOB",
|
||||
help="Shell-like glob matching top-level module names to save into %%{pyproject_files}",
|
||||
)
|
||||
return parser
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
cli_args = argparser().parse_args()
|
||||
main(cli_args)
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,78 @@
|
||||
import argparse
|
||||
import sys
|
||||
import subprocess
|
||||
|
||||
|
||||
def parse_config_settings_args(config_settings):
|
||||
"""
|
||||
Given a list of config `KEY=VALUE` formatted config settings,
|
||||
return a dictionary that can be passed to PEP 517 hook functions.
|
||||
"""
|
||||
if not config_settings:
|
||||
return config_settings
|
||||
new_config_settings = {}
|
||||
for arg in config_settings:
|
||||
key, _, value = arg.partition('=')
|
||||
if key in new_config_settings:
|
||||
if not isinstance(new_config_settings[key], list):
|
||||
# convert the existing value to a list
|
||||
new_config_settings[key] = [new_config_settings[key]]
|
||||
new_config_settings[key].append(value)
|
||||
else:
|
||||
new_config_settings[key] = value
|
||||
return new_config_settings
|
||||
|
||||
|
||||
def get_config_settings_args(config_settings):
|
||||
"""
|
||||
Given a dictionary of PEP 517 backend config_settings,
|
||||
yield --config-settings args that can be passed to pip's CLI
|
||||
"""
|
||||
if not config_settings:
|
||||
return
|
||||
for key, values in config_settings.items():
|
||||
if not isinstance(values, list):
|
||||
values = [values]
|
||||
for value in values:
|
||||
if value == '':
|
||||
yield f'--config-settings={key}'
|
||||
else:
|
||||
yield f'--config-settings={key}={value}'
|
||||
|
||||
|
||||
def build_wheel(*, wheeldir, stdout=None, config_settings=None):
|
||||
command = (
|
||||
sys.executable,
|
||||
'-m', 'pip',
|
||||
'wheel',
|
||||
'--wheel-dir', wheeldir,
|
||||
'--no-deps',
|
||||
'--use-pep517',
|
||||
'--no-build-isolation',
|
||||
'--disable-pip-version-check',
|
||||
'--no-clean',
|
||||
'--progress-bar', 'off',
|
||||
'--verbose',
|
||||
*get_config_settings_args(config_settings),
|
||||
'.',
|
||||
)
|
||||
cp = subprocess.run(command, stdout=stdout)
|
||||
return cp.returncode
|
||||
|
||||
|
||||
def parse_args(argv=None):
|
||||
parser = argparse.ArgumentParser(prog='%pyproject_wheel')
|
||||
parser.add_argument('wheeldir', help=argparse.SUPPRESS)
|
||||
parser.add_argument(
|
||||
'-C',
|
||||
dest='config_settings',
|
||||
action='append',
|
||||
help='Configuration settings to pass to the PEP 517 backend',
|
||||
)
|
||||
args = parser.parse_args(argv)
|
||||
args.config_settings = parse_config_settings_args(args.config_settings)
|
||||
return args
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
sys.exit(build_wheel(**vars(parse_args())))
|
||||
@ -0,0 +1,11 @@
|
||||
../../../bin/__pycache__/tldr.cpython-37.pyc,,
|
||||
../../../bin/tldr,sha256=6MUiLCWhldmV8OelT2dvPgS7q5GFwuhvd6th0Bb-LH4,12766
|
||||
../../../bin/tldr.py,sha256=6MUiLCWhldmV8OelT2dvPgS7q5GFwuhvd6th0Bb-LH4,12766
|
||||
__pycache__/tldr.cpython-37.pyc,,
|
||||
tldr-0.5.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||
tldr-0.5.dist-info/LICENSE,sha256=q7quAfjDWCYKC_WRk_uaP6d2wwVpOpVjUSkv8l6H7xI,1075
|
||||
tldr-0.5.dist-info/METADATA,sha256=AN5nYUVxo_zkVaMGKu34YDWWif84oA6uxKmTab213vM,3850
|
||||
tldr-0.5.dist-info/RECORD,,
|
||||
tldr-0.5.dist-info/WHEEL,sha256=S8S5VL-stOTSZDYxHyf0KP7eds0J72qrK0Evu3TfyAY,92
|
||||
tldr-0.5.dist-info/top_level.txt,sha256=xHSI9WD6Y-_hONbi2b_9RIn9oiO7RBGHU3A8geJq3mI,5
|
||||
tldr.py,sha256=aJlA3tIz4QYYy8e7DZUhPyLCqTwnfFjA7Nubwm9bPe0,12779
|
||||
@ -0,0 +1,101 @@
|
||||
from pathlib import Path
|
||||
import importlib.metadata
|
||||
|
||||
import packaging.version
|
||||
import pytest
|
||||
import setuptools
|
||||
import yaml
|
||||
|
||||
from pyproject_buildrequires import generate_requires
|
||||
|
||||
SETUPTOOLS_VERSION = packaging.version.parse(setuptools.__version__)
|
||||
SETUPTOOLS_60 = SETUPTOOLS_VERSION >= packaging.version.parse('60')
|
||||
|
||||
testcases = {}
|
||||
with Path(__file__).parent.joinpath('pyproject_buildrequires_testcases.yaml').open() as f:
|
||||
testcases = yaml.safe_load(f)
|
||||
|
||||
|
||||
@pytest.mark.parametrize('case_name', testcases)
|
||||
def test_data(case_name, capfd, tmp_path, monkeypatch):
|
||||
case = testcases[case_name]
|
||||
|
||||
cwd = tmp_path.joinpath('cwd')
|
||||
cwd.mkdir()
|
||||
monkeypatch.chdir(cwd)
|
||||
wheeldir = cwd.joinpath('wheeldir')
|
||||
wheeldir.mkdir()
|
||||
output = tmp_path.joinpath('output.txt')
|
||||
|
||||
if case.get('xfail'):
|
||||
pytest.xfail(case.get('xfail'))
|
||||
|
||||
if case.get('skipif') and eval(case.get('skipif')):
|
||||
pytest.skip(case.get('skipif'))
|
||||
|
||||
for filename in case:
|
||||
file_types = ('.toml', '.py', '.in', '.ini', '.txt', '.cfg')
|
||||
if filename.endswith(file_types):
|
||||
cwd.joinpath(filename).write_text(case[filename])
|
||||
|
||||
for name, value in case.get('environ', {}).items():
|
||||
monkeypatch.setenv(name, value)
|
||||
|
||||
def get_installed_version(dist_name):
|
||||
try:
|
||||
return str(case['installed'][dist_name])
|
||||
except (KeyError, TypeError):
|
||||
raise importlib.metadata.PackageNotFoundError(
|
||||
f'info not found for {dist_name}'
|
||||
)
|
||||
requirement_files = case.get('requirement_files', [])
|
||||
requirement_files = [open(f) for f in requirement_files]
|
||||
use_build_system = case.get('use_build_system', True)
|
||||
try:
|
||||
generate_requires(
|
||||
get_installed_version=get_installed_version,
|
||||
include_runtime=case.get('include_runtime', use_build_system),
|
||||
build_wheel=case.get('build_wheel', False),
|
||||
wheeldir=str(wheeldir),
|
||||
extras=case.get('extras', []),
|
||||
toxenv=case.get('toxenv', None),
|
||||
generate_extras=case.get('generate_extras', False),
|
||||
requirement_files=requirement_files,
|
||||
use_build_system=use_build_system,
|
||||
output=output,
|
||||
config_settings=case.get('config_settings'),
|
||||
)
|
||||
except SystemExit as e:
|
||||
assert e.code == case['result']
|
||||
except Exception as e:
|
||||
if 'except' not in case:
|
||||
raise
|
||||
assert type(e).__name__ == case['except']
|
||||
else:
|
||||
assert 0 == case['result']
|
||||
|
||||
# this prevents us from accidentally writing "empty" tests
|
||||
# if we ever need to do that, we can remove the check or change it:
|
||||
assert 'expected' in case or 'stderr_contains' in case
|
||||
|
||||
out, err = capfd.readouterr()
|
||||
dependencies = output.read_text()
|
||||
|
||||
if 'expected' in case:
|
||||
expected = case['expected']
|
||||
if isinstance(expected, list):
|
||||
# at least one of them needs to match
|
||||
assert dependencies in expected
|
||||
else:
|
||||
assert dependencies == expected
|
||||
|
||||
# stderr_contains may be a string or list of strings
|
||||
stderr_contains = case.get('stderr_contains')
|
||||
if stderr_contains is not None:
|
||||
if isinstance(stderr_contains, str):
|
||||
stderr_contains = [stderr_contains]
|
||||
for expected_substring in stderr_contains:
|
||||
assert expected_substring.format(**locals()) in err
|
||||
finally:
|
||||
for req in requirement_files:
|
||||
req.close()
|
||||
@ -0,0 +1,78 @@
|
||||
from pathlib import Path
|
||||
from textwrap import dedent
|
||||
|
||||
from pyproject_requirements_txt import convert_requirements_txt
|
||||
|
||||
|
||||
def test_requirements_add_pkgname():
|
||||
reqs_txt = dedent(r"""
|
||||
good@git+https://github.com/monty/spam.git@master#egg=bad
|
||||
git+https://github.com/monty/spam.git@master#egg=ugly
|
||||
https://example.com/undead.tar.gz#egg=undead ; python_version > 3.0
|
||||
""")
|
||||
result = convert_requirements_txt(reqs_txt.splitlines())
|
||||
|
||||
expected = [
|
||||
'good@git+https://github.com/monty/spam.git@master#egg=bad',
|
||||
'ugly@git+https://github.com/monty/spam.git@master#egg=ugly',
|
||||
'undead@https://example.com/undead.tar.gz#egg=undead ; python_version > 3.0',
|
||||
]
|
||||
assert result == expected
|
||||
|
||||
|
||||
def test_requirements_preprocess(monkeypatch):
|
||||
reqs_txt = dedent(r"""
|
||||
Normal_Req ~= 1.2.0
|
||||
whitespace-stripped < 3 <END>
|
||||
|
||||
# indentation is preserved in continuations:
|
||||
foo <=\
|
||||
30
|
||||
bar<= \
|
||||
30
|
||||
# names and operators can be split:
|
||||
this-was-\
|
||||
too-long<\
|
||||
=30
|
||||
|
||||
# this is not a multi-line comment \
|
||||
some-dep
|
||||
# neither is this \
|
||||
other-dep
|
||||
another-dep # but this *is* a multi-line coment \
|
||||
so any garbage can be here
|
||||
dep-a # and this comment ends with the blank line below \
|
||||
|
||||
dep-b
|
||||
${ENVVAR}
|
||||
whitespace-stripped-before-substitution ${SPACE}
|
||||
${MISSING_ENVVAR}
|
||||
""".replace('<END>', ''))
|
||||
monkeypatch.setenv('ENVVAR', 'package-from-env')
|
||||
monkeypatch.setenv('SPACE', ' ')
|
||||
monkeypatch.delenv('MISSING_ENVVAR', raising=False)
|
||||
result = convert_requirements_txt(reqs_txt.splitlines())
|
||||
|
||||
expected = [
|
||||
'Normal_Req ~= 1.2.0',
|
||||
'whitespace-stripped < 3',
|
||||
'foo <= 30',
|
||||
'bar<= 30',
|
||||
'this-was-too-long<=30',
|
||||
'some-dep',
|
||||
'other-dep',
|
||||
'another-dep',
|
||||
'dep-a',
|
||||
'dep-b',
|
||||
'package-from-env',
|
||||
'whitespace-stripped-before-substitution ',
|
||||
'${MISSING_ENVVAR}',
|
||||
]
|
||||
#result = expected
|
||||
assert result == expected
|
||||
|
||||
# This test uses pip internals, so it might break in the future.
|
||||
from pip._internal.req.req_file import preprocess
|
||||
expected = [line for lineno, line in preprocess(reqs_txt)]
|
||||
assert result == expected
|
||||
|
||||
@ -0,0 +1,278 @@
|
||||
import pytest
|
||||
import yaml
|
||||
|
||||
from pathlib import Path
|
||||
from pprint import pprint
|
||||
|
||||
from pyproject_preprocess_record import parse_record, read_record, save_parsed_record
|
||||
|
||||
from pyproject_save_files import argparser, generate_file_list, BuildrootPath
|
||||
from pyproject_save_files import main as save_files_main
|
||||
from pyproject_save_files import module_names_from_path
|
||||
|
||||
DIR = Path(__file__).parent
|
||||
PREFIX = Path("/usr")
|
||||
BINDIR = BuildrootPath("/usr/bin")
|
||||
DATADIR = BuildrootPath("/usr/share")
|
||||
SITELIB = BuildrootPath("/usr/lib/python3.7/site-packages")
|
||||
SITEARCH = BuildrootPath("/usr/lib64/python3.7/site-packages")
|
||||
|
||||
yaml_file = DIR / "pyproject_save_files_test_data.yaml"
|
||||
yaml_data = yaml.safe_load(yaml_file.read_text())
|
||||
EXPECTED_DICT = yaml_data["classified"]
|
||||
EXPECTED_FILES = yaml_data["dumped"]
|
||||
TEST_RECORDS = yaml_data["records"]
|
||||
TEST_METADATAS = yaml_data["metadata"]
|
||||
|
||||
|
||||
# insert glob_suffix_len for .pyc files and man pages globs
|
||||
for paths_dict in EXPECTED_DICT.values():
|
||||
for modules in paths_dict["modules"].values():
|
||||
for module in modules:
|
||||
for idx, file in enumerate(module["files"]):
|
||||
if file.endswith(".pyc"):
|
||||
module["files"][idx] = BuildrootPath(file)
|
||||
module["files"][idx].glob_suffix_len = len("{,.opt-?}.pyc")
|
||||
if "other" in paths_dict and "files" in paths_dict["other"]:
|
||||
for idx, file in enumerate(paths_dict["other"]["files"]):
|
||||
if file.endswith("*"):
|
||||
paths_dict["other"]["files"][idx] = BuildrootPath(file)
|
||||
paths_dict["other"]["files"][idx].glob_suffix_len = len("*")
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def tldr_root(tmp_path):
|
||||
prepare_pyproject_record(tmp_path, package="tldr")
|
||||
return tmp_path
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def pyproject_record(tmp_path):
|
||||
return tmp_path / "pyproject-record"
|
||||
|
||||
|
||||
def prepare_pyproject_record(tmp_path, package=None, content=None):
|
||||
"""
|
||||
Creates RECORD from test data and then uses
|
||||
functions from pyproject_process_record to convert
|
||||
it to pyproject-record file which is then
|
||||
further processed by functions from pyproject_save_files.
|
||||
"""
|
||||
record_file = tmp_path / "RECORD"
|
||||
pyproject_record = tmp_path / "pyproject-record"
|
||||
|
||||
if package is not None:
|
||||
# Get test data and write dist-info/RECORD file
|
||||
record_path = BuildrootPath(TEST_RECORDS[package]["path"])
|
||||
record_file.write_text(TEST_RECORDS[package]["content"])
|
||||
if package in TEST_METADATAS:
|
||||
metadata_path = BuildrootPath(TEST_METADATAS[package]["path"]).to_real(tmp_path)
|
||||
metadata_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
metadata_path.write_text(TEST_METADATAS[package]["content"])
|
||||
# Parse RECORD file
|
||||
parsed_record = parse_record(record_path, read_record(record_file))
|
||||
# Save JSON content to pyproject-record
|
||||
save_parsed_record(record_path, parsed_record, pyproject_record)
|
||||
elif content is not None:
|
||||
save_parsed_record(*content, output_file=pyproject_record)
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def output_files(tmp_path):
|
||||
return tmp_path / "pyproject_files"
|
||||
|
||||
@pytest.fixture
|
||||
def output_modules(tmp_path):
|
||||
return tmp_path / "pyproject_modules"
|
||||
|
||||
|
||||
def test_parse_record_tldr():
|
||||
record_path = BuildrootPath(TEST_RECORDS["tldr"]["path"])
|
||||
record_content = read_record(DIR / "test_RECORD")
|
||||
output = list(parse_record(record_path, record_content))
|
||||
pprint(output)
|
||||
expected = [
|
||||
str(BINDIR / "__pycache__/tldr.cpython-37.pyc"),
|
||||
str(BINDIR / "tldr"),
|
||||
str(BINDIR / "tldr.py"),
|
||||
str(SITELIB / "__pycache__/tldr.cpython-37.pyc"),
|
||||
str(SITELIB / "tldr-0.5.dist-info/INSTALLER"),
|
||||
str(SITELIB / "tldr-0.5.dist-info/LICENSE"),
|
||||
str(SITELIB / "tldr-0.5.dist-info/METADATA"),
|
||||
str(SITELIB / "tldr-0.5.dist-info/RECORD"),
|
||||
str(SITELIB / "tldr-0.5.dist-info/WHEEL"),
|
||||
str(SITELIB / "tldr-0.5.dist-info/top_level.txt"),
|
||||
str(SITELIB / "tldr.py"),
|
||||
]
|
||||
assert output == expected
|
||||
|
||||
|
||||
def test_parse_record_tensorflow():
|
||||
long = "tensorflow_core/include/tensorflow/core/common_runtime/base_collective_executor.h"
|
||||
record_path = SITEARCH / "tensorflow-2.1.0.dist-info/RECORD"
|
||||
record_content = [
|
||||
["../../../bin/toco_from_protos", "sha256=hello", "289"],
|
||||
[f"../../../lib/python3.7/site-packages/{long}", "sha256=darkness", "1024"],
|
||||
["tensorflow-2.1.0.dist-info/METADATA", "sha256=friend", "2859"],
|
||||
]
|
||||
output = list(parse_record(record_path, record_content))
|
||||
pprint(output)
|
||||
expected = [
|
||||
str(BINDIR / "toco_from_protos"),
|
||||
str(SITELIB / long),
|
||||
str(SITEARCH / "tensorflow-2.1.0.dist-info/METADATA"),
|
||||
]
|
||||
assert output == expected
|
||||
|
||||
|
||||
def remove_others(expected):
|
||||
return [
|
||||
p for p in expected
|
||||
if not (
|
||||
p.startswith(str(BINDIR)) or
|
||||
p.endswith(".pth") or
|
||||
p.endswith("*") or
|
||||
p.rpartition(' ')[-1].startswith(str(DATADIR))
|
||||
)
|
||||
]
|
||||
|
||||
|
||||
@pytest.mark.parametrize("include_auto", (True, False))
|
||||
@pytest.mark.parametrize("package, glob, expected_files, expected_modules", EXPECTED_FILES)
|
||||
def test_generate_file_list(package, glob, expected_files, include_auto, expected_modules):
|
||||
paths_dict = EXPECTED_DICT[package]
|
||||
modules_glob = {glob}
|
||||
if not include_auto:
|
||||
expected_files = remove_others(expected_files)
|
||||
tested = generate_file_list(paths_dict, modules_glob, include_auto)
|
||||
|
||||
assert tested == expected_files
|
||||
|
||||
|
||||
def test_generate_file_list_unused_glob():
|
||||
paths_dict = EXPECTED_DICT["kerberos"]
|
||||
modules_glob = {"kerberos", "unused_glob1", "unused_glob2", "kerb*"}
|
||||
with pytest.raises(ValueError) as excinfo:
|
||||
generate_file_list(paths_dict, modules_glob, True)
|
||||
|
||||
assert "unused_glob1, unused_glob2" in str(excinfo.value)
|
||||
assert "kerb" not in str(excinfo.value)
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"path, expected",
|
||||
[
|
||||
("foo/bar/baz.py", {"foo", "foo.bar", "foo.bar.baz"}),
|
||||
("foo/bar.py", {"foo", "foo.bar"}),
|
||||
("foo.py", {"foo"}),
|
||||
("foo/bar.so.2", set()),
|
||||
("foo.cpython-37m-x86_64-linux-gnu.so", {"foo"}),
|
||||
("foo/_api/v2/__init__.py", set()),
|
||||
("foo/__init__.py", {"foo"}),
|
||||
("foo/_priv.py", set()),
|
||||
("foo/_bar/lib.so", set()),
|
||||
("foo/bar/baz.so", {"foo", "foo.bar", "foo.bar.baz"}),
|
||||
("foo/bar/baz.pth", set()),
|
||||
("foo/bar/baz.pyc", set()),
|
||||
("def.py", set()),
|
||||
("foo-bar/baz.py", set()),
|
||||
("foobar/12baz.py", set()),
|
||||
("foo/\nbar/baz.py", set()),
|
||||
("foo/+bar/baz.py", set()),
|
||||
("foo/__init__.cpython-39-x86_64-linux-gnu.so", {"foo"}),
|
||||
("foo/bar/__pycache__/abc.cpython-37.pyc", set()),
|
||||
],
|
||||
)
|
||||
def test_module_names_from_path(path, expected):
|
||||
tested = Path(path)
|
||||
assert module_names_from_path(tested) == expected
|
||||
|
||||
|
||||
def default_options(output_files, output_modules, mock_root, pyproject_record):
|
||||
return [
|
||||
"--output-files",
|
||||
str(output_files),
|
||||
"--output-modules",
|
||||
str(output_modules),
|
||||
"--buildroot",
|
||||
str(mock_root),
|
||||
"--sitelib",
|
||||
str(SITELIB),
|
||||
"--sitearch",
|
||||
str(SITEARCH),
|
||||
"--python-version",
|
||||
"3.7", # test data are for 3.7,
|
||||
"--pyproject-record",
|
||||
str(pyproject_record),
|
||||
"--prefix",
|
||||
str(PREFIX),
|
||||
]
|
||||
|
||||
|
||||
@pytest.mark.parametrize("include_auto", (True, False))
|
||||
@pytest.mark.parametrize("package, glob, expected_files, expected_modules", EXPECTED_FILES)
|
||||
def test_cli(tmp_path, package, glob, expected_files, expected_modules, include_auto, pyproject_record):
|
||||
prepare_pyproject_record(tmp_path, package)
|
||||
output_files = tmp_path / "files"
|
||||
output_modules = tmp_path / "modules"
|
||||
globs = [glob, "+auto"] if include_auto else [glob]
|
||||
cli_args = argparser().parse_args([*default_options(output_files, output_modules, tmp_path, pyproject_record), *globs])
|
||||
save_files_main(cli_args)
|
||||
|
||||
if not include_auto:
|
||||
expected_files = remove_others(expected_files)
|
||||
tested_files = output_files.read_text()
|
||||
assert tested_files == "\n".join(expected_files) + "\n"
|
||||
|
||||
tested_modules = output_modules.read_text().split()
|
||||
|
||||
assert tested_modules == expected_modules
|
||||
|
||||
|
||||
def test_cli_no_pyproject_record(tmp_path, pyproject_record):
|
||||
output_files = tmp_path / "files"
|
||||
output_modules = tmp_path / "modules"
|
||||
cli_args = argparser().parse_args([*default_options(output_files, output_modules, tmp_path, pyproject_record), "tldr*"])
|
||||
|
||||
with pytest.raises(FileNotFoundError):
|
||||
save_files_main(cli_args)
|
||||
|
||||
|
||||
def test_cli_too_many_RECORDS(tldr_root, output_files, output_modules, pyproject_record):
|
||||
# Two calls to simulate how %pyproject_install process more than one RECORD file
|
||||
prepare_pyproject_record(tldr_root,
|
||||
content=("foo/bar/dist-info/RECORD", []))
|
||||
prepare_pyproject_record(tldr_root,
|
||||
content=("foo/baz/dist-info/RECORD", []))
|
||||
cli_args = argparser().parse_args([*default_options(output_files, output_modules, tldr_root, pyproject_record), "tldr*"])
|
||||
|
||||
with pytest.raises(FileExistsError):
|
||||
save_files_main(cli_args)
|
||||
|
||||
|
||||
def test_cli_bad_argument(tldr_root, output_files, output_modules, pyproject_record):
|
||||
cli_args = argparser().parse_args(
|
||||
[*default_options(output_files, output_modules, tldr_root, pyproject_record), "tldr*", "+foodir"]
|
||||
)
|
||||
|
||||
with pytest.raises(ValueError):
|
||||
save_files_main(cli_args)
|
||||
|
||||
|
||||
def test_cli_bad_option(tldr_root, output_files, output_modules, pyproject_record):
|
||||
prepare_pyproject_record(tldr_root.parent, content=("RECORD1", []))
|
||||
cli_args = argparser().parse_args(
|
||||
[*default_options(output_files, output_modules, tldr_root, pyproject_record), "tldr*", "you_cannot_have_this"]
|
||||
)
|
||||
|
||||
with pytest.raises(ValueError):
|
||||
save_files_main(cli_args)
|
||||
|
||||
|
||||
def test_cli_bad_namespace(tldr_root, output_files, output_modules, pyproject_record):
|
||||
cli_args = argparser().parse_args(
|
||||
[*default_options(output_files, output_modules, tldr_root, pyproject_record), "tldr.didntread"]
|
||||
)
|
||||
|
||||
with pytest.raises(ValueError):
|
||||
save_files_main(cli_args)
|
||||
@ -0,0 +1,533 @@
|
||||
Name: pyproject-rpm-macros
|
||||
Summary: RPM macros for PEP 517 Python packages
|
||||
# SPDX
|
||||
License: MIT
|
||||
|
||||
%bcond tests 1
|
||||
# pytest-xdist and tox are not desired in RHEL
|
||||
%bcond pytest_xdist %{undefined rhel}
|
||||
%bcond tox_tests %{undefined rhel}
|
||||
|
||||
# The idea is to follow the spirit of semver
|
||||
# Given version X.Y.Z:
|
||||
# Increment X and reset Y.Z when there is a *major* incompatibility
|
||||
# Increment Y and reset Z when new macros or features are added
|
||||
# Increment Z when this is a bugfix or a cosmetic change
|
||||
# Dropping support for EOL Fedoras is *not* considered a breaking change
|
||||
Version: 1.14.0
|
||||
Release: 1%{?dist}
|
||||
|
||||
# Macro files
|
||||
Source001: macros.pyproject
|
||||
Source002: macros.aaa-pyproject-srpm
|
||||
|
||||
# Implementation files
|
||||
Source101: pyproject_buildrequires.py
|
||||
Source102: pyproject_save_files.py
|
||||
Source103: pyproject_convert.py
|
||||
Source104: pyproject_preprocess_record.py
|
||||
Source105: pyproject_construct_toxenv.py
|
||||
Source106: pyproject_requirements_txt.py
|
||||
Source107: pyproject_wheel.py
|
||||
|
||||
# Tests
|
||||
Source201: test_pyproject_buildrequires.py
|
||||
Source202: test_pyproject_save_files.py
|
||||
Source203: test_pyproject_requirements_txt.py
|
||||
Source204: compare_mandata.py
|
||||
|
||||
# Test data
|
||||
Source301: pyproject_buildrequires_testcases.yaml
|
||||
Source302: pyproject_save_files_test_data.yaml
|
||||
Source303: test_RECORD
|
||||
|
||||
# Metadata
|
||||
Source901: README.md
|
||||
Source902: LICENSE
|
||||
|
||||
URL: https://src.fedoraproject.org/rpms/pyproject-rpm-macros
|
||||
|
||||
BuildArch: noarch
|
||||
|
||||
%if %{with tests}
|
||||
BuildRequires: python3dist(pytest)
|
||||
%if %{with pytest_xdist}
|
||||
BuildRequires: python3dist(pytest-xdist)
|
||||
%endif
|
||||
BuildRequires: python3dist(pyyaml)
|
||||
BuildRequires: python3dist(packaging)
|
||||
BuildRequires: python3dist(pip)
|
||||
BuildRequires: python3dist(setuptools)
|
||||
%if %{with tox_tests}
|
||||
BuildRequires: python3dist(tox-current-env) >= 0.0.6
|
||||
%endif
|
||||
BuildRequires: python3dist(wheel)
|
||||
BuildRequires: (python3dist(tomli) if python3 < 3.11)
|
||||
%endif
|
||||
|
||||
# We build on top of those:
|
||||
BuildRequires: python-rpm-macros
|
||||
BuildRequires: python-srpm-macros
|
||||
BuildRequires: python3-rpm-macros
|
||||
Requires: python-rpm-macros
|
||||
Requires: python-srpm-macros
|
||||
Requires: python3-rpm-macros
|
||||
Requires: (pyproject-srpm-macros = %{?epoch:%{epoch}:}%{version}-%{release} if pyproject-srpm-macros)
|
||||
|
||||
# We use the following tools outside of coreutils
|
||||
Requires: /usr/bin/find
|
||||
Requires: /usr/bin/sed
|
||||
|
||||
# This package requires the %%generate_buildrequires functionality.
|
||||
# It has been introduced in RPM 4.15 (4.14.90 is the alpha of 4.15).
|
||||
# What we need is rpmlib(DynamicBuildRequires), but that is impossible to (Build)Require.
|
||||
# Also, we need to avoid 4.19.90..4.19.91-7 due to rhbz#2284187
|
||||
Requires: ((rpm-build >= 4.14.90 with (rpm-build < 4.19.90 or rpm-build >= 4.19.91-8)) if rpm-build)
|
||||
BuildRequires: rpm-build >= 4.14.90
|
||||
|
||||
%description
|
||||
These macros allow projects that follow the Python packaging specifications
|
||||
to be packaged as RPMs.
|
||||
|
||||
They work for:
|
||||
|
||||
* traditional Setuptools-based projects that use the setup.py file,
|
||||
* newer Setuptools-based projects that have a setup.cfg file,
|
||||
* general Python projects that use the PEP 517 pyproject.toml file
|
||||
(which allows using any build system, such as setuptools, flit or poetry).
|
||||
|
||||
These macros replace %%py3_build and %%py3_install,
|
||||
which only work with setup.py.
|
||||
|
||||
|
||||
%package -n pyproject-srpm-macros
|
||||
Summary: Minimal implementation of %%pyproject_buildrequires
|
||||
Requires: (pyproject-rpm-macros = %{?epoch:%{epoch}:}%{version}-%{release} if pyproject-rpm-macros)
|
||||
Requires: (rpm-build >= 4.14.90 if rpm-build)
|
||||
|
||||
%description -n pyproject-srpm-macros
|
||||
This package contains a minimal implementation of %%pyproject_buildrequires.
|
||||
When used in %%generate_buildrequires, it will generate BuildRequires
|
||||
for pyproject-rpm-macros. When both packages are installed, the full version
|
||||
takes precedence.
|
||||
|
||||
|
||||
%prep
|
||||
# Not strictly necessary but allows working on file names instead
|
||||
# of source numbers in install section
|
||||
%setup -c -T
|
||||
cp -p %{sources} .
|
||||
|
||||
%generate_buildrequires
|
||||
# nothing to do, this is here just to assert we have that functionality
|
||||
|
||||
%build
|
||||
# nothing to do, sources are not buildable
|
||||
|
||||
%install
|
||||
mkdir -p %{buildroot}%{_rpmmacrodir}
|
||||
mkdir -p %{buildroot}%{_rpmconfigdir}/redhat
|
||||
install -pm 644 macros.pyproject %{buildroot}%{_rpmmacrodir}/
|
||||
install -pm 644 macros.aaa-pyproject-srpm %{buildroot}%{_rpmmacrodir}/
|
||||
install -pm 644 pyproject_buildrequires.py %{buildroot}%{_rpmconfigdir}/redhat/
|
||||
install -pm 644 pyproject_convert.py %{buildroot}%{_rpmconfigdir}/redhat/
|
||||
install -pm 644 pyproject_save_files.py %{buildroot}%{_rpmconfigdir}/redhat/
|
||||
install -pm 644 pyproject_preprocess_record.py %{buildroot}%{_rpmconfigdir}/redhat/
|
||||
install -pm 644 pyproject_construct_toxenv.py %{buildroot}%{_rpmconfigdir}/redhat/
|
||||
install -pm 644 pyproject_requirements_txt.py %{buildroot}%{_rpmconfigdir}/redhat/
|
||||
install -pm 644 pyproject_wheel.py %{buildroot}%{_rpmconfigdir}/redhat/
|
||||
|
||||
%check
|
||||
# assert the two signatures of %%pyproject_buildrequires match exactly
|
||||
signature1="$(grep '^%%pyproject_buildrequires' macros.pyproject | cut -d' ' -f1)"
|
||||
signature2="$(grep '^%%pyproject_buildrequires' macros.aaa-pyproject-srpm | cut -d' ' -f1)"
|
||||
test "$signature1" == "$signature2"
|
||||
# but also assert we are not comparing empty strings
|
||||
test "$signature1" != ""
|
||||
|
||||
%if %{with tests}
|
||||
export HOSTNAME="rpmbuild" # to speedup tox in network-less mock, see rhbz#1856356
|
||||
%pytest -vv --doctest-modules %{?with_pytest_xdist:-n auto} %{!?with_tox_tests:-k "not tox"}
|
||||
|
||||
# brp-compress is provided as an argument to get the right directory macro expansion
|
||||
%{python3} compare_mandata.py -f %{_rpmconfigdir}/brp-compress
|
||||
%endif
|
||||
|
||||
|
||||
%files
|
||||
%{_rpmmacrodir}/macros.pyproject
|
||||
%{_rpmconfigdir}/redhat/pyproject_buildrequires.py
|
||||
%{_rpmconfigdir}/redhat/pyproject_convert.py
|
||||
%{_rpmconfigdir}/redhat/pyproject_save_files.py
|
||||
%{_rpmconfigdir}/redhat/pyproject_preprocess_record.py
|
||||
%{_rpmconfigdir}/redhat/pyproject_construct_toxenv.py
|
||||
%{_rpmconfigdir}/redhat/pyproject_requirements_txt.py
|
||||
%{_rpmconfigdir}/redhat/pyproject_wheel.py
|
||||
|
||||
%doc README.md
|
||||
%license LICENSE
|
||||
|
||||
%files -n pyproject-srpm-macros
|
||||
%{_rpmmacrodir}/macros.aaa-pyproject-srpm
|
||||
%license LICENSE
|
||||
|
||||
|
||||
%changelog
|
||||
* Tue Jul 23 2024 Miro Hrončok <mhroncok@redhat.com> - 1.14.0-1
|
||||
- Add a provisional RPM Declarative Buildsystem (RPM 4.20+)
|
||||
|
||||
* Fri Jul 19 2024 Fedora Release Engineering <releng@fedoraproject.org> - 1.13.0-2
|
||||
- Rebuilt for https://fedoraproject.org/wiki/Fedora_41_Mass_Rebuild
|
||||
|
||||
* Tue Jul 02 2024 Miro Hrončok <mhroncok@redhat.com> - 1.13.0-1
|
||||
- Properly escape weird characters from paths in %%{pyproject_files} (RPM 4.19+ only)
|
||||
- Revert the temporary workaround for RPM 4.20 alpha 2 leaking \x1f (unit separators)
|
||||
- Fixes: rhbz#1990879
|
||||
|
||||
* Tue Jun 25 2024 Cristian Le <fedora@lecris.me> - 1.12.2-1
|
||||
- %%pyproject_extras_subpkg: Allow passing -a or -A to %%python_extras_subpkg
|
||||
|
||||
* Tue Jun 04 2024 Miro Hrončok <mhroncok@redhat.com> - 1.12.1-1
|
||||
- Add a temporary workaround for RPM 4.20 alpha 2 leaking \x1f (unit separators)
|
||||
- Related: rhbz#2284187
|
||||
|
||||
* Fri Jan 26 2024 Miro Hrončok <miro@hroncok.cz> - 1.12.0-1
|
||||
- Namespace pyproject-rpm-macros generated text files with %%{python3_pkgversion}
|
||||
- That way, a single-spec can be used to build packages for multiple Python versions
|
||||
- Fixes: rhbz#2209055
|
||||
|
||||
* Fri Jan 26 2024 Fedora Release Engineering <releng@fedoraproject.org> - 1.11.0-3
|
||||
- Rebuilt for https://fedoraproject.org/wiki/Fedora_40_Mass_Rebuild
|
||||
|
||||
* Sun Jan 21 2024 Fedora Release Engineering <releng@fedoraproject.org> - 1.11.0-2
|
||||
- Rebuilt for https://fedoraproject.org/wiki/Fedora_40_Mass_Rebuild
|
||||
|
||||
* Wed Sep 27 2023 Miro Hrončok <mhroncok@redhat.com> - 1.11.0-1
|
||||
- Add the -l/-L flag to %%pyproject_save_files
|
||||
- The -l flag can be used to assert at least 1 License-File was detected
|
||||
- The -L flag explicitly disables this check (which remains the default)
|
||||
- Prevent incorrect usage of %%pyproject_buildrequires -R with -x/-e/-t
|
||||
- Fixes: rhbz#2244282
|
||||
- Show a better error message when %%pyproject_install finds no wheel
|
||||
- Fixes: rhbz#2242452
|
||||
- Fix %%pyproject_buildrequires -w when the build backend is already installed and pip isn't
|
||||
- Fixes: rhbz#2169855
|
||||
|
||||
* Wed Sep 13 2023 Python Maint <python-maint@redhat.com> - 1.10.0-1
|
||||
- Add %%_pyproject_check_import_allow_no_modules for automated environments
|
||||
- Fix handling of tox 4 provision without an explicit tox minversion
|
||||
- Fixes: rhbz#2240590
|
||||
|
||||
* Fri Jul 21 2023 Fedora Release Engineering <releng@fedoraproject.org> - 1.9.0-2
|
||||
- Rebuilt for https://fedoraproject.org/wiki/Fedora_39_Mass_Rebuild
|
||||
|
||||
* Wed May 31 2023 Maxwell G <maxwell@gtmx.me> - 1.9.0-1
|
||||
- Allow passing config_settings to the build backend.
|
||||
- Resolves: rhbz#2192581
|
||||
|
||||
* Wed May 31 2023 Miro Hrončok <mhroncok@redhat.com> - 1.8.1-1
|
||||
- On Python older than 3.11, use tomli instead of deprecated toml
|
||||
- Fix literal %% handling in %%{pyproject_files} on RPM 4.19
|
||||
|
||||
* Tue May 23 2023 Miro Hrončok <mhroncok@redhat.com> - 1.8.0-2
|
||||
- Rebuilt for ELN dependency changes
|
||||
|
||||
* Thu Apr 27 2023 Miro Hrončok <mhroncok@redhat.com> - 1.8.0-1
|
||||
- %%pyproject_buildrequires: Add support for self-referential extras requirements
|
||||
Fixes: rhbz#2171343
|
||||
- Deprecate the provisional %%{pyproject_build_lib} macro
|
||||
See https://lists.fedoraproject.org/archives/list/python-devel@lists.fedoraproject.org/thread/HMLOPAU3RZLXD4BOJHTIPKI3I4U6U7OE/
|
||||
|
||||
* Fri Mar 31 2023 Miro Hrončok <mhroncok@redhat.com> - 1.7.0-1
|
||||
- %%pyproject_buildrequires: Redirect stdout to stderr via Shell
|
||||
- Dependencies are recorded to a text file that is catted at the end
|
||||
- Fixes: rhbz#2183519
|
||||
|
||||
* Mon Feb 13 2023 Lumír Balhar <lbalhar@redhat.com> - 1.6.3-1
|
||||
- Remove .dist-info directory at the end of %%pyproject_buildrequires
|
||||
- An incomplete .dist-info directory in $PWD can confuse tests in %%check
|
||||
|
||||
* Wed Feb 08 2023 Lumír Balhar <lbalhar@redhat.com> - 1.6.2-1
|
||||
- Improve detection of lang files
|
||||
- Fixes: rhbz#2166295
|
||||
|
||||
* Fri Feb 03 2023 Miro Hrončok <mhroncok@redhat.com> - 1.6.1-1
|
||||
- %%pyproject_buildrequires: Avoid leaking stdout from subprocesses
|
||||
- Fixes: rhbz#2166888
|
||||
|
||||
* Fri Jan 20 2023 Miro Hrončok <miro@hroncok.cz> - 1.6.0-1
|
||||
- Add pyproject-srpm-macros with a minimal %%pyproject_buildrequires macro
|
||||
|
||||
* Fri Jan 20 2023 Fedora Release Engineering <releng@fedoraproject.org> - 1.5.1-2
|
||||
- Rebuilt for https://fedoraproject.org/wiki/Fedora_38_Mass_Rebuild
|
||||
|
||||
* Fri Jan 13 2023 Miro Hrončok <mhroncok@redhat.com> - 1.5.1-1
|
||||
- Adjusts %%pyproject_buildrequires tests for tox 4
|
||||
- Fixes: rhbz#2160687
|
||||
|
||||
* Mon Nov 28 2022 Miro Hrončok <mhroncok@redhat.com> - 1.5.0-1
|
||||
- Use %%py3_test_envvars in %%tox when available
|
||||
|
||||
* Mon Sep 19 2022 Python Maint <python-maint@redhat.com> - 1.4.0-1
|
||||
- %%pyproject_save_files: Support License-Files installed into the *Root License Directory* from PEP 639
|
||||
- Fixes: rhbz#2127946
|
||||
- %%pyproject_check_import: Import only the modules whose top-level names
|
||||
match any of the globs provided to %%pyproject_save_files
|
||||
- Fixes: rhbz#2127958
|
||||
|
||||
* Tue Aug 30 2022 Otto Liljalaakso <otto.liljalaakso@iki.fi> - 1.3.4-1
|
||||
- Fix typo in internal function name
|
||||
|
||||
* Tue Aug 09 2022 Karolina Surma <ksurma@redhat.com> - 1.3.3-1
|
||||
- Don't fail %%pyproject_save_files '*' if no modules are detected
|
||||
|
||||
* Fri Jul 22 2022 Fedora Release Engineering <releng@fedoraproject.org> - 1.3.2-2
|
||||
- Rebuilt for https://fedoraproject.org/wiki/Fedora_37_Mass_Rebuild
|
||||
|
||||
* Wed Jun 15 2022 Benjamin A. Beasley <code@musicinmybrain.net> - 1.3.2-1
|
||||
- Update %%pyproject_build_lib to support setuptools 62.1.0 and later
|
||||
- Fixes: rhbz#2097158
|
||||
- %%pyproject_buildrequires: When extension modules are built,
|
||||
support https://fedoraproject.org/wiki/Changes/Package_information_on_ELF_objects
|
||||
- Fixes: rhbz#2097535
|
||||
|
||||
* Fri May 27 2022 Owen Taylor <otaylor@redhat.com> - 1.3.1-1
|
||||
- %%pyproject_install: pass %%{_prefix} explicitly to pip install
|
||||
|
||||
* Thu May 12 2022 Miro Hrončok <mhroncok@redhat.com> - 1.3.0-1
|
||||
- Use tomllib from the standard library on Python 3.11+
|
||||
|
||||
* Wed Apr 27 2022 Miro Hrončok <mhroncok@redhat.com> - 1.2.0-1
|
||||
- %%pyproject_buildrequires: Add provisional -w flag for build backends without
|
||||
prepare_metadata_for_build_wheel hook
|
||||
When used, the wheel is built in %%pyproject_buildrequires
|
||||
and information about runtime requires and extras is read from that wheel.
|
||||
- Fixes: rhbz#2076994
|
||||
|
||||
* Tue Apr 12 2022 Miro Hrončok <mhroncok@redhat.com> - 1.1.0-1
|
||||
- %%pyproject_save_files: Support nested directories in dist-info
|
||||
- Fixes: rhbz#1985340
|
||||
|
||||
* Tue Mar 22 2022 Miro Hrončok <mhroncok@redhat.com> - 1.0.1-1
|
||||
- Prefix paths of intermediate files (such as %%{pyproject_files}) with NVRA
|
||||
|
||||
* Tue Mar 01 2022 Miro Hrončok <mhroncok@redhat.com> - 1.0.0-1
|
||||
- Release final version 1.0.0
|
||||
|
||||
* Mon Feb 07 2022 Lumír Balhar <lbalhar@redhat.com> - 1.0.0~rc2-1
|
||||
- Updated compatibility with tox4
|
||||
|
||||
* Tue Jan 25 2022 Miro Hrončok <mhroncok@redhat.com> - 1.0.0~rc1-1
|
||||
- Release version 1.0.0, first release candidate
|
||||
|
||||
* Mon Jan 24 2022 Miro Hrončok <mhroncok@redhat.com> - 0-55
|
||||
- %%pyproject_buildrequires: Generate BuildRequires for this package
|
||||
This package is already installed, but this way, the resulting SRPM explicitly BuildRequires it
|
||||
|
||||
* Wed Jan 19 2022 Karolina Surma <ksurma@redhat.com> - 0-54
|
||||
- Include compressed manpages to the package if flag '+auto' is provided to %%pyproject_save_files
|
||||
- Fixes: rhbz#2033254
|
||||
|
||||
* Fri Jan 14 2022 Miro Hrončok <mhroncok@redhat.com> - 0-53
|
||||
- %%pyproject_buildrequires: Make -r (include runtime) the default, use -R to opt-out
|
||||
|
||||
* Sun Dec 19 2021 Gordon Messmer <gordon.messmer@gmail.com> - 0-52
|
||||
- Handle legacy version specifiers that would previously raise exceptions.
|
||||
|
||||
* Wed Dec 08 2021 Miro Hrončok <mhroncok@redhat.com> - 0-51
|
||||
- Define provisional %%pyproject_build_lib
|
||||
|
||||
* Mon Nov 1 2021 Gordon Messmer <gordon.messmer@gmail.com> - 0-50
|
||||
- Improve handling of > operator, preventing post-release from satisfying most rpm requirements
|
||||
- Improve handling of < operator, preventing pre-release from satisfying rpm requirement
|
||||
- Improve handling of != operator with prefix matching, preventing pre-release from satisfying rpm requirements
|
||||
|
||||
* Tue Oct 19 2021 Karolina Surma <ksurma@redhat.com> - 0-49
|
||||
- %%pyproject_save_files: Save %%_pyproject_modules file with importable module names
|
||||
- Introduce %%pyproject_check_import which passes %%_pyproject_modules to %%py3_check_import
|
||||
- Introduce -t, -e filtering options to %%pyproject_check_import
|
||||
|
||||
* Sat Oct 16 2021 Miro Hrončok <mhroncok@redhat.com> - 0-48
|
||||
- %%pyproject_buildrequires: Accept installed pre-releases for all requirements
|
||||
- Fixes: rhbz#2014639
|
||||
|
||||
* Thu Sep 09 2021 Miro Hrončok <mhroncok@redhat.com> - 0-47
|
||||
- %%pyproject_save_files: Expand the namespace error message, also display it with /
|
||||
- %%pyproject_save_files: Add a workaround error for spaces and [brackets]
|
||||
|
||||
* Fri Jul 23 2021 Miro Hrončok <miro@hroncok.cz> - 0-46
|
||||
- %%pyproject_buildrequires now fails when it encounters an invalid requirement
|
||||
- Fixes: rhbz#1983053
|
||||
- Rename %%_pyproject_ghost_distinfo and %%_pyproject_record to indicate they are private
|
||||
- Automatically detect LICENSE files and mark them with %%license macro
|
||||
|
||||
* Fri Jul 23 2021 Fedora Release Engineering <releng@fedoraproject.org> - 0-45
|
||||
- Rebuilt for https://fedoraproject.org/wiki/Fedora_35_Mass_Rebuild
|
||||
|
||||
* Fri Jul 09 2021 Python Maint <python-maint@redhat.com> - 0-44
|
||||
- Escape weird paths generated by %%pyproject_save_files
|
||||
- Fixes rhbz#1976363
|
||||
- Support x.* versions in %%pyproject_buildrequires
|
||||
- Fixes rhbz#1981558
|
||||
- %%pyproject_buildrequires fallbacks to setuptools only if setup.py exists
|
||||
- Fixes: rhbz#1976459
|
||||
- Explicitly require the "basic" Python RPM macros
|
||||
|
||||
* Thu Jul 01 2021 Tomas Hrnciar <thrnciar@redhat.com> - 0-43
|
||||
- Generate BuildRequires from file
|
||||
- Fixes: rhbz#1936448
|
||||
|
||||
* Tue Jun 29 2021 Miro Hrončok <mhroncok@redhat.com> - 0-42
|
||||
- Don't accidentally treat "~= X.0" requirement as "~= X"
|
||||
- Fixes rhbz#1977060
|
||||
|
||||
* Mon Jun 28 2021 Miro Hrončok <mhroncok@redhat.com> - 0-41
|
||||
- Don't leak %%{_pyproject_builddir} to pytest collection
|
||||
- Fixes rhbz#1935212
|
||||
|
||||
* Thu May 27 2021 Miro Hrončok <mhroncok@redhat.com> - 0-40
|
||||
- Don't leak $TMPDIR outside of pyproject macros
|
||||
- Set %%_pyproject_wheeldir and %%_pyproject_builddir relative to the source tree, not $PWD
|
||||
|
||||
* Mon Mar 29 2021 Miro Hrončok <mhroncok@redhat.com> - 0-39
|
||||
- Handle tox provision (tox.requires / tox.minversion)
|
||||
- Fixes: rhbz#1922495
|
||||
- Generate BuildRequires on extras in lower case
|
||||
- Fixes: rhbz#1937944
|
||||
|
||||
* Sun Feb 07 2021 Miro Hrončok <mhroncok@redhat.com> - 0-38
|
||||
- Include nested __pycache__ directories in %%pyproject_save_files
|
||||
- Fixes: rhbz#1925963
|
||||
|
||||
* Tue Feb 02 2021 Miro Hrončok <mhroncok@redhat.com> - 0-37
|
||||
- Remove support for Python 3.7 from %%pyproject_buildrequires
|
||||
- Generate python3dist(toml) BR with pyproject.toml earlier to avoid extra install round
|
||||
- Generate python3dist(setutpools/wheel) BR without pyproject.toml earlier as well
|
||||
|
||||
* Wed Jan 27 2021 Fedora Release Engineering <releng@fedoraproject.org> - 0-36
|
||||
- Rebuilt for https://fedoraproject.org/wiki/Fedora_34_Mass_Rebuild
|
||||
|
||||
* Fri Jan 15 2021 Miro Hrončok <mhroncok@redhat.com> - 0-35
|
||||
- Update the description of the package to match the new README content
|
||||
|
||||
* Fri Dec 04 2020 Miro Hrončok <miro@hroncok.cz> - 0-34
|
||||
- List all files in %%pyproject_files explicitly to avoid duplicate %%lang entries
|
||||
- If you amend the installed files after %%pyproject_install, %%pyproject_files might break
|
||||
|
||||
* Fri Nov 27 2020 Miro Hrončok <mhroncok@redhat.com> - 0-33
|
||||
- Pass PYTHONDONTWRITEBYTECODE=1 to %%tox to avoid packaged PYTEST bytecode
|
||||
|
||||
* Tue Nov 03 2020 Miro Hrončok <mhroncok@redhat.com> - 0-32
|
||||
- Allow multiple -e in %%pyproject_buildrequires
|
||||
- Fixes: rhbz#1886509
|
||||
|
||||
* Mon Oct 05 2020 Miro Hrončok <mhroncok@redhat.com> - 0-31
|
||||
- Support PEP 517 list based backend-path
|
||||
|
||||
* Tue Sep 29 2020 Lumír Balhar <lbalhar@redhat.com> - 0-30
|
||||
- Process RECORD files in %%pyproject_install and remove them
|
||||
- Support the extras configuration option of tox in %%pyproject_buildrequires -t
|
||||
- Support multiple -x options for %%pyproject_buildrequires
|
||||
- Fixes: rhbz#1877977
|
||||
- Fixes: rhbz#1877978
|
||||
|
||||
* Wed Sep 23 2020 Miro Hrončok <mhroncok@redhat.com> - 0-29
|
||||
- Check the requirements after installing "requires_for_build_wheel"
|
||||
- If not checked, installing runtime requirements might fail
|
||||
|
||||
* Tue Sep 08 2020 Gordon Messmer <gordon.messmer@gmail.com> - 0-28
|
||||
- Support more Python version specifiers in generated BuildRequires
|
||||
- This adds support for the '~=' operator and wildcards
|
||||
|
||||
* Fri Sep 04 2020 Miro Hrončok <miro@hroncok.cz> - 0-27
|
||||
- Make code in $PWD importable from %%pyproject_buildrequires
|
||||
- Only require toml for projects with pyproject.toml
|
||||
- Remove a no longer useful warning for unrecognized files in %%pyproject_save_files
|
||||
|
||||
* Mon Aug 24 2020 Tomas Hrnciar <thrnciar@redhat.com> - 0-26
|
||||
- Implement automatic detection of %%lang files in %%pyproject_save_files
|
||||
and mark them with %%lang in filelist
|
||||
|
||||
* Fri Aug 14 2020 Miro Hrončok <mhroncok@redhat.com> - 0-25
|
||||
- Handle Python Extras in %%pyproject_buildrequires on Fedora 33+
|
||||
|
||||
* Tue Aug 11 2020 Miro Hrončok <mhroncok@redhat.com> - 0-24
|
||||
- Allow multiple, comma-separated extras in %%pyproject_buildrequires -x
|
||||
|
||||
* Mon Aug 10 2020 Lumír Balhar <lbalhar@redhat.com> - 0-23
|
||||
- Make macros more universal for alternative Python stacks
|
||||
|
||||
* Thu Aug 06 2020 Tomas Hrnciar <thrnciar@redhat.com> - 0-22
|
||||
- Change %%pyproject_save_files +bindir argument to +auto
|
||||
to list all unclassified files in filelist
|
||||
|
||||
* Tue Aug 04 2020 Miro Hrončok <mhroncok@redhat.com> - 0-21
|
||||
- Actually implement %%pyproject_extras_subpkg
|
||||
|
||||
* Wed Jul 29 2020 Miro Hrončok <mhroncok@redhat.com> - 0-20
|
||||
- Implement %%pyproject_extras_subpkg
|
||||
|
||||
* Tue Jul 28 2020 Fedora Release Engineering <releng@fedoraproject.org> - 0-19
|
||||
- Rebuilt for https://fedoraproject.org/wiki/Fedora_33_Mass_Rebuild
|
||||
|
||||
* Thu Jul 16 2020 Miro Hrončok <mhroncok@redhat.com> - 0-18
|
||||
- %%pyproject_buildrequires -x (extras requires for tests) now implies -r
|
||||
(runtime requires) instead of erroring without it for better UX.
|
||||
|
||||
* Wed Jul 15 2020 Miro Hrončok <mhroncok@redhat.com> - 0-17
|
||||
- Set HOSTNAME to prevent tox 3.17+ from a DNS query
|
||||
- Fixes rhbz#1856356
|
||||
|
||||
* Fri Jun 19 2020 Miro Hrončok <mhroncok@redhat.com> - 0-16
|
||||
- Switch from upstream deprecated pytoml to toml
|
||||
|
||||
* Thu May 07 2020 Tomas Hrnciar <thrnciar@redhat.com> - 0-15
|
||||
- Adapt %%pyproject_install not to create a PEP 610 direct_url.json file
|
||||
|
||||
* Wed Apr 15 2020 Patrik Kopkan <pkopkan@redhat.com> - 0-14
|
||||
- Add %%pyproject_save_file macro for generating file section
|
||||
- Handle extracting debuginfo from extension modules (#1806625)
|
||||
|
||||
* Mon Mar 02 2020 Miro Hrončok <mhroncok@redhat.com> - 0-13
|
||||
- Tox dependency generator: Handle deps read in from a text file (#1808601)
|
||||
|
||||
* Wed Feb 05 2020 Miro Hrončok <mhroncok@redhat.com> - 0-12
|
||||
- Fallback to setuptools.build_meta:__legacy__ backend instead of setuptools.build_meta
|
||||
- Properly handle backends with colon
|
||||
- Preserve existing flags in shebangs of Python files in /usr/bin
|
||||
|
||||
* Thu Jan 30 2020 Fedora Release Engineering <releng@fedoraproject.org> - 0-11
|
||||
- Rebuilt for https://fedoraproject.org/wiki/Fedora_32_Mass_Rebuild
|
||||
|
||||
* Fri Nov 15 2019 Patrik Kopkan <pkopkan@redhat.com> - 0-10
|
||||
- Install wheel in '$PWD/pyproject-macros-wheeldir' to have more explicit path from which we install.
|
||||
- The path can be changed by redefining %%_pyproject_wheeldir.
|
||||
|
||||
* Wed Nov 13 2019 Anna Khaitovich <akhaitov@redhat.com> - 0-9
|
||||
- Remove stray __pycache__ directory from /usr/bin when running %%pyproject_install
|
||||
|
||||
* Fri Oct 25 2019 Miro Hrončok <mhroncok@redhat.com> - 0-8
|
||||
- When tox fails, print tox output before failing
|
||||
|
||||
* Tue Oct 08 2019 Miro Hrončok <mhroncok@redhat.com> - 0-7
|
||||
- Move a verbose line of %%pyproject_buildrequires from stdout to stderr
|
||||
|
||||
* Fri Jul 26 2019 Petr Viktorin <pviktori@redhat.com> - 0-6
|
||||
- Use importlib_metadata rather than pip freeze
|
||||
|
||||
* Fri Jul 26 2019 Miro Hrončok <mhroncok@redhat.com> - 0-5
|
||||
- Allow to fetch test dependencies from tox
|
||||
- Add %%tox macro to invoke tests
|
||||
|
||||
* Fri Jul 26 2019 Fedora Release Engineering <releng@fedoraproject.org> - 0-4
|
||||
- Rebuilt for https://fedoraproject.org/wiki/Fedora_31_Mass_Rebuild
|
||||
|
||||
* Tue Jul 02 2019 Miro Hrončok <mhroncok@redhat.com> - 0-3
|
||||
- Add %%pyproject_buildrequires
|
||||
|
||||
* Tue Jul 02 2019 Miro Hrončok <mhroncok@redhat.com> - 0-2
|
||||
- Fix shell syntax errors in %%pyproject_install
|
||||
- Drop PATH warning in %%pyproject_install
|
||||
|
||||
* Fri Jun 28 2019 Patrik Kopkan <pkopkan@redhat.com> - 0-1
|
||||
- created package
|
||||
Loading…
Reference in new issue