fedora-docs-l10n/packaging-guidelines/master/pages/Python_201x

English

Actions

|Macro
|Expanded path
|Notes

|`+%{__python}+`
|(Error)
|Don't use this macro without redefining it. Defining it changes the meaning of other "unversioned" Python macros such as `+%{python}+` or `+%{python_sitelib}+`.

|`+%{__python3}+`
|`+/usr/bin/python3+`
|Python 3 interpreter. Redefining this macro changes all the `+%{python3...}+` macros.

|`+%{python3}+`
|`+%{__python3}+`
|Python 3 interpreter. Use this macro in spec files.

|`+%py_provides+`
|(Lua script)
|See <<The %py_provides macro>> for detailed explanation.

|`+%{python3_sitelib}+`
|`+/usr/lib/python3.X/site-packages+`
|Where pure python3 modules are installed.

|`+%{python3_sitearch}+`
|`+/usr/lib64/python3.X/site-packages+` on 64bit architectures (e.g. x86_64) and `+/usr/lib/python3.X/site-packages+` on 32bit.
|Where python3 extension modules (e.g. C compiled) are installed.

|`+%{py_byte_compile}+`
|(script)
|See xref:Python_Appendix.adoc#manual-bytecompilation[byte-compiling] section for usage.

|`+%{python3_version}+`
|`+3.X+`
|Python 3 version. Useful when running programs with Python version in filename, such as `+nosetests-%{python3_version}+`.

|`+%{python3_version_nodots}+`
|`+3X+`
|Python 3 version without dots. Useful when listing files explicitly in %files section, such as `+%{python3_sitearch}/foo/_speedups.cpython-%{python3_version_nodots}*.so+`

|`+%{python3_platform}+`
|`+linux-x86_64+` on x86_64
|The platform name used in Python, useful for specifying `+$PYTHONPATH+`, such as `+PYTHONPATH=build/lib.%{python3_platform}-%{python3_version}+`

|`+%{python3_ext_suffix}+`
|`+.cpython-3X-x86_64-linux-gnu.so+` on x86_64
|The usual suffix of Python extension modules, useful when listing files. Note that extension modules can alternatively have a simple `+.so+` suffix as well, depending on how they are built.

|`+%py3_build+`
|`+%{__python3} setup.py build …+`
|See `+%py3_install+` for passing arguments to `+setup.py build+` or directly to `+setup.py+`.

|`+%py3_install+`
|`+%{__python3} setup.py install --skip-build …+`
|Various flags are passed to `+setup.py install+`, see `/usr/lib/rpm/macros.d/macros.python3` for details and similar macros. To add extra flags/arguments to `+setup.py install+`, separate them with `+--+`, for example: `+%py3_install -- --install-scripts %{_libexecdir}+`. To pass custom command line arguments directly to `+setup.py+`, define `+%py_setup_args+`.

|`+%__pytest+`
|`+/usr/bin/pytest+`
|The `pytest` command used in `+%pytest+`. Don't use this macro directly, but feel free to redefine it for usage in `+%pytest+` if desired.

|`+%pytest+`
|`+PATH=… PYTHONPATH=… … %{__pytest}+`
|Various environment variables are set to ensure the packaged version is tested. Use this macro instead of direct `pytest` calls in `+%check+`. Pass additional argument as if passed to `pytest`, e.g. `+%pytest -m "not network"+` to deselect tests marked as `network`.

|`+%py3_check_import …+`
|`+PATH=… PYTHONPATH=… … %{__python3} -c 'import …'+`
|Various environment variables are set to ensure the packaged version is tested. Use this macro in `+%check+` to test public Python modules are importable if running upstream tests suite is not feasible. Pass module names as positional arguments separated by spaces or commas.

|`+%{py_dist_name}+`
|(Lua script)
|Given a standardized name (i.e. dist name, name on PyPI) of Python software, it will convert it to a canonical format. See <<Automatic Provides with a standardized name>> for more information.

|`+%{py3_dist}+`
|(Lua script)
|Given a standardized name (i.e. dist name, name on PyPI) of Python software, it will convert it to a canonical format, and evaluates to `+python3dist(CANONICAL_NAME)+`, which is useful when listing dependencies. See <<Automatic Provides with a standardized name>> for more information.

|`+%{pypi_source}+`
|(Lua script)
|Evaluates to the appropriate URL for the package. See above for more information.

|`+%pycached ….py+`
|(Lua script)
|Given a Python file, lists the file and the files with its bytecode cache. See <<Byte compiling>> for more information.

|`+%{py3_shebang_flags}+`
|`s`
|The default set of flags for Python shebangs. Redefine this to change the set. Used by `+%py3_shebang_fix+`.

|`+%py3_shebang_fix …+`
|(Python script)
|Given paths for Python files or directories with them, it changes Python shebangs to `+#! %{__python3}+`, preserves any existing flags (if found) and adds flags defined in `+%{py3_shebang_flags}+` (if not already present).

English	English
No related strings found in the glossary.

English

No related strings found in the glossary.

	English	Actions
	Provides: python3.Ydist(CANONICAL_STANDARDIZED_NAME) Provides: python3dist(CANONICAL_STANDARDIZED_NAME)
	The `+3.Y+` is the Python version used (usually 3.6 and higher), and between the parentheses is the name of the software in a canonical format used by Python tools and services such as setuptools, pip and PyPI. The canonical name is obtained by switching the standardized name to lower case and converting all runs of non-alphanumeric characters to single “-” characters. Example: “The $$$ Tree” becomes “the-tree”.
	Requires and BuildRequires with standardized names
	These Provides tags can be used to list Requires and BuildRequires of a package using the _standardized names_ (i.e. dist name, name on PyPI) of Python modules. To make it easier, you can use the `+%{py3_dist}+` macro that accept one or more parameters: the _standardized name(s)_ of the desired Python software. It will convert the name(s) to the _canonical format_ and create the proper `+python3dist(...)+` tag(s).
	In addition, you can use the `+%{py_dist_name}+` macro that simply transforms any _standardized name_ to the _canonical format_.
	For example:
	BuildRequires: %{py3_dist PyMySQL} >= 0.7.5 # => BuildRequires: python3dist(pymysql) >= 0.7.5
	Requires: %{py3_dist virtualenv pyPEG2} # => Requires: python3dist(virtualenv) python3dist(pypeg2)
	%{py_dist_name 0-._.-._.-._.-._.-._.-._.-0} # => 0-0
	Source Files from PyPI
	When packaging software which is available from PyPI, you can make use of the `+%pypi_source+` macro. This macro accepts from zero to three arguments and evaluates to an appropriate URL for the source file on PyPI. The arguments are:
	The name of the PyPI project. Defaults to `+%srcname+` if defined, or to `+%pypi_name+` if defined, or to `+%name+` (the package name).
	The version of the PyPI project. Defaults to `+%version+` (the package version) with any `~` characters removed (used for alpha/beta/dev versions in RPM version but not in Python package version).
	The file extension to use. Defaults to `tar.gz`.
	In most cases it is not necessary to specify any arguments.
	Macros
	The following macros are defined for you in all supported Fedora and EPEL releases:
	\|Macro \|Expanded path \|Notes \|`+%{__python}+` \|(Error) \|Don't use this macro without redefining it. Defining it changes the meaning of other "unversioned" Python macros such as `+%{python}+` or `+%{python_sitelib}+`. \|`+%{__python3}+` \|`+/usr/bin/python3+` \|Python 3 interpreter. Redefining this macro changes all the `+%{python3...}+` macros. \|`+%{python3}+` \|`+%{__python3}+` \|Python 3 interpreter. Use this macro in spec files. \|`+%py_provides+` \|(Lua script) \|See <<The %py_provides macro>> for detailed explanation. \|`+%{python3_sitelib}+` \|`+/usr/lib/python3.X/site-packages+` \|Where pure python3 modules are installed. \|`+%{python3_sitearch}+` \|`+/usr/lib64/python3.X/site-packages+` on 64bit architectures (e.g. x86_64) and `+/usr/lib/python3.X/site-packages+` on 32bit. \|Where python3 extension modules (e.g. C compiled) are installed. \|`+%{py_byte_compile}+` \|(script) \|See xref:Python_Appendix.adoc#manual-bytecompilation[byte-compiling] section for usage. \|`+%{python3_version}+` \|`+3.X+` \|Python 3 version. Useful when running programs with Python version in filename, such as `+nosetests-%{python3_version}+`. \|`+%{python3_version_nodots}+` \|`+3X+` \|Python 3 version without dots. Useful when listing files explicitly in %files section, such as `+%{python3_sitearch}/foo/_speedups.cpython-%{python3_version_nodots}*.so+` \|`+%{python3_platform}+` \|`+linux-x86_64+` on x86_64 \|The platform name used in Python, useful for specifying `+$PYTHONPATH+`, such as `+PYTHONPATH=build/lib.%{python3_platform}-%{python3_version}+` \|`+%{python3_ext_suffix}+` \|`+.cpython-3X-x86_64-linux-gnu.so+` on x86_64 \|The usual suffix of Python extension modules, useful when listing files. Note that extension modules can alternatively have a simple `+.so+` suffix as well, depending on how they are built. \|`+%py3_build+` \|`+%{__python3} setup.py build …+` \|See `+%py3_install+` for passing arguments to `+setup.py build+` or directly to `+setup.py+`. \|`+%py3_install+` \|`+%{__python3} setup.py install --skip-build …+` \|Various flags are passed to `+setup.py install+`, see `/usr/lib/rpm/macros.d/macros.python3` for details and similar macros. To add extra flags/arguments to `+setup.py install+`, separate them with `+--+`, for example: `+%py3_install -- --install-scripts %{_libexecdir}+`. To pass custom command line arguments directly to `+setup.py+`, define `+%py_setup_args+`. \|`+%__pytest+` \|`+/usr/bin/pytest+` \|The `pytest` command used in `+%pytest+`. Don't use this macro directly, but feel free to redefine it for usage in `+%pytest+` if desired. \|`+%pytest+` \|`+PATH=… PYTHONPATH=… … %{__pytest}+` \|Various environment variables are set to ensure the packaged version is tested. Use this macro instead of direct `pytest` calls in `+%check+`. Pass additional argument as if passed to `pytest`, e.g. `+%pytest -m "not network"+` to deselect tests marked as `network`. \|`+%py3_check_import …+` \|`+PATH=… PYTHONPATH=… … %{__python3} -c 'import …'+` \|Various environment variables are set to ensure the packaged version is tested. Use this macro in `+%check+` to test public Python modules are importable if running upstream tests suite is not feasible. Pass module names as positional arguments separated by spaces or commas. \|`+%{py_dist_name}+` \|(Lua script) \|Given a standardized name (i.e. dist name, name on PyPI) of Python software, it will convert it to a canonical format. See <<Automatic Provides with a standardized name>> for more information. \|`+%{py3_dist}+` \|(Lua script) \|Given a standardized name (i.e. dist name, name on PyPI) of Python software, it will convert it to a canonical format, and evaluates to `+python3dist(CANONICAL_NAME)+`, which is useful when listing dependencies. See <<Automatic Provides with a standardized name>> for more information. \|`+%{pypi_source}+` \|(Lua script) \|Evaluates to the appropriate URL for the package. See above for more information. \|`+%pycached ….py+` \|(Lua script) \|Given a Python file, lists the file and the files with its bytecode cache. See <<Byte compiling>> for more information. \|`+%{py3_shebang_flags}+` \|`s` \|The default set of flags for Python shebangs. Redefine this to change the set. Used by `+%py3_shebang_fix+`. \|`+%py3_shebang_fix …+` \|(Python script) \|Given paths for Python files or directories with them, it changes Python shebangs to `+#! %{__python3}+`, preserves any existing flags (if found) and adds flags defined in `+%{py3_shebang_flags}+` (if not already present).
	During `+%install+` or when listing `+%files+` you can use the `+%{python3_sitearch}+` and `+%{python3_sitelib}+` macros to specify where the installed modules are to be found. For instance:
	%files # A pure python3 module %{python3_sitelib}/foomodule/ # A compiled python3 extension module %{python3_sitearch}/barmodule/
	Use of the macros has several benefits:
	It ensures that the packages are installed correctly on multilib architectures.
	Using these macros instead of hardcoding the directory in the specfile ensures your spec remains compatible with the installed Python version even if the directory structure changes radically (for instance, if `+python3_sitelib+` moves into `+%{_datadir}+`).
	Packages using Cython
	A great amount of extension modules for Python (Python modules written in a compiled language such as C or C++) are written using the https://cython.org/[Cython] language and compiler.
	Majority of such packages contains the generated C (or C++) sources in the source tarball.
	Tightening the xref:what-can-be-packaged.adoc#_pregenerated_code[general Fedora policy], packages MUST NOT use pre-generated Cython sources. They MUST be deleted in `%prep` and regenerated during the build.
	Any exception to this rule should be considered a xref:index.adoc#bootstrapping[bootstrapping].
	Files to include
	When packaging Python modules, several types of files are included:
	+*.py+ source files because they are used when generating tracebacks.

Shortcut	Action
`?`	Open available keyboard shortcuts.
`Alt` + `Home`	Navigate to the first translation in the current search.
`Alt` + `End`	Navigate to the last translation in the current search.
`Alt` + `PageUp` or `Ctrl` + `↑` or `Alt` + `↑` or `Cmd` + `↑` or	Navigate to the last translation in the current search.
`Alt` + `PageDown` or `Ctrl` + `↓` or `Alt` + `↓` or `Cmd` + `↓` or	Navigate to the next translation in the current search.
`Ctrl` + `Enter` or `Cmd` + `Enter`	Submit current form; this works the same as pressing Save and continue while editing translation.
`Ctrl` + `Shift` + `Enter` or `Cmd` + `Shift` +`Enter`	Unmark translation as Needing edit and submit it.
`Alt` + `Enter` or `Option` + `Enter`	Submit the string as a suggestion; this works the same as pressing Suggest while editing translation.
`Ctrl` + `E` or `Cmd` + `E`	Focus on translation editor.
`Ctrl` + `U` or `Cmd` + `U`	Focus on comment editor.
`Ctrl` + `M` or `Cmd` + `M`	Shows Automatic suggestions tab.
`Ctrl` + `1` to `Ctrl` + `9` or `Cmd` + `1` to `Cmd` + `9`	Copies placeable of a given number from source string.
`Ctrl` + `M` followed by `1` to `9` or `Cmd` + `M` followed by `1` to `9`	Copy the machine translation of a given number to current translation.
`Ctrl` + `I` followed by `1` to `9` or `Cmd` + `I` followed by `1` to `9`	Ignore one item in the list of failing checks.
`Ctrl` + `J` or `Cmd` + `J`	Shows the Nearby strings tab.
`Ctrl` + `S` or `Cmd` + `S`	Focus on search field.
`Ctrl` + `O` or `Cmd` + `O`	Copy the source string.
`Ctrl` + `Y` or `Cmd` + `Y`	Toggle the Needs editing checkbox.
`→`	Browse the next translation string.
`←`	Browse the previous translation string.

fedora-docs-l10n/packaging-guidelines

master/pages/Python_201x

English

Translate

Source string Source string

Things to check

Multiple failing checks

Glossary

8316168 String information

Source string description

Flags

Source string location

String age

Last updated

Source string age

Translation file