From Fedora Project Wiki
 
(8 intermediate revisions by 4 users not shown)
Line 7: Line 7:
 
* Name: [[User:ignatenkobrain|Igor Gnatenko]], [[User:ngompa|Neal Gompa]]
 
* Name: [[User:ignatenkobrain|Igor Gnatenko]], [[User:ngompa|Neal Gompa]]
 
* Email: ignatenkobrain@fedoraproject.org, ngompa13@gmail.com
 
* Email: ignatenkobrain@fedoraproject.org, ngompa13@gmail.com
* Release notes owner: <!--- To be assigned by docs team [[User:FASAccountName| Release notes owner name]] <email address> -->
+
* Release notes ticket: [https://pagure.io/fedora-docs/release-notes/issue/99 #99]
 
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
 
<!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
 
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
 
* FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
Line 27: Line 27:
 
CLOSED as NEXTRELEASE -> change is completed and verified and will be delivered in next release under development
 
CLOSED as NEXTRELEASE -> change is completed and verified and will be delivered in next release under development
 
-->
 
-->
* Tracker bug: <will be assigned by the Wrangler>
+
* Tracker bug: [https://bugzilla.redhat.com/show_bug.cgi?id=1541953 #1541953]
  
 
== Detailed Description ==
 
== Detailed Description ==
Line 34: Line 34:
 
All dependencies which are added are generated out of metadata which means in order to fix them - you need to fix metadata (usually setup.py or requirements.txt).
 
All dependencies which are added are generated out of metadata which means in order to fix them - you need to fix metadata (usually setup.py or requirements.txt).
  
Other distributions (such as Mageia and openSUSE) are using this dependency generator for long time already.
+
Other distributions (such as Mageia, OpenMandriva, and PLD) have been using this dependency generator for long time already.
  
 
In F29 we plan to propose to make generator opt-out.
 
In F29 we plan to propose to make generator opt-out.
Line 45: Line 45:
 
Packager of python-fasteners forgot to add Requires: python3-monotonic >= 0.1 so when anyone does "import fasteners", it fails with traceback:
 
Packager of python-fasteners forgot to add Requires: python3-monotonic >= 0.1 so when anyone does "import fasteners", it fails with traceback:
  
 +
<pre>
 
Traceback (most recent call last):
 
Traceback (most recent call last):
 
   File "/builddir/build/BUILD/jenkins-job-builder-2.0.0/tests/yamlparser/test_yamlparser.py", line 42, in test_incorrect_template_dimensions
 
   File "/builddir/build/BUILD/jenkins-job-builder-2.0.0/tests/yamlparser/test_yamlparser.py", line 42, in test_incorrect_template_dimensions
Line 57: Line 58:
 
     raise DistributionNotFound(req, requirers)
 
     raise DistributionNotFound(req, requirers)
 
pkg_resources.DistributionNotFound: The 'monotonic>=0.1' distribution was not found and is required by fasteners
 
pkg_resources.DistributionNotFound: The 'monotonic>=0.1' distribution was not found and is required by fasteners
 +
</pre>
  
 
With automatic dependency management this should never happen.
 
With automatic dependency management this should never happen.
Line 88: Line 90:
  
 
== How To Test ==
 
== How To Test ==
1. Remove all requires for python modules
+
# Make sure that python-rpm-macros >= 3-25 is installed
2. Add following line to spec: %?python_enable_dependency_generator
+
# Remove all requires for python modules
3. Rebuild package
+
# Add following line to spec: `%?python_enable_dependency_generator`
 +
# Rebuild package
  
 
Every dependency mentioned in egg/wheel (e.g. generated by setuptools/distutils from setup.py) should be automatically added.
 
Every dependency mentioned in egg/wheel (e.g. generated by setuptools/distutils from setup.py) should be automatically added.
Line 106: Line 109:
 
3. What are the expected results of those actions?
 
3. What are the expected results of those actions?
 
-->
 
-->
 
<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 
N/A (not a System Wide Change)
 
  
 
== User Experience ==
 
== User Experience ==
Line 144: Line 144:
 
-->
 
-->
  
[[Category:ChangeReadyForWrangler]]
+
[[Category:ChangeAcceptedF28]]
 
<!-- When your change proposal page is completed and ready for review and announcement -->
 
<!-- When your change proposal page is completed and ready for review and announcement -->
 
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
 
<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->

Latest revision as of 14:57, 2 March 2018

Enabling Python Generators

Summary

This change enables the ability to choose to use the Python module dependency generator for packages that provide Python Egg/Wheel metadata.

Owner

Current status

Detailed Description

There is RPM dependency generator which is able to automatically add Requires/Provides and other types of dependencies based on egg/wheel metadata. The part which is generating Provides has been used in Fedora since Jun 2016 which means by now all packages which provide egg/wheel metadata have Provides: pythonX.Ydist(xyz) added automatically. With this change proposal we allow people to opt-in for using automatic generation of Requires.

All dependencies which are added are generated out of metadata which means in order to fix them - you need to fix metadata (usually setup.py or requirements.txt).

Other distributions (such as Mageia, OpenMandriva, and PLD) have been using this dependency generator for long time already.

In F29 we plan to propose to make generator opt-out.

Benefit to Fedora

  • Packagers do not need to specify runtime dependencies manually anymore
  • No more errors in runtime due to missing dependencies (see example below)

Packager of python-fasteners forgot to add Requires: python3-monotonic >= 0.1 so when anyone does "import fasteners", it fails with traceback:

Traceback (most recent call last):
  File "/builddir/build/BUILD/jenkins-job-builder-2.0.0/tests/yamlparser/test_yamlparser.py", line 42, in test_incorrect_template_dimensions
    reg = registry.ModuleRegistry(config)
  File "/builddir/build/BUILD/jenkins-job-builder-2.0.0/jenkins_jobs/registry.py", line 50, in __init__
    Mod = entrypoint.load()
  File "/usr/lib/python3.6/site-packages/pkg_resources/__init__.py", line 2407, in load
    self.require(*args, **kwargs)
  File "/usr/lib/python3.6/site-packages/pkg_resources/__init__.py", line 2430, in require
    items = working_set.resolve(reqs, env, installer, extras=self.extras)
  File "/usr/lib/python3.6/site-packages/pkg_resources/__init__.py", line 870, in resolve
    raise DistributionNotFound(req, requirers)
pkg_resources.DistributionNotFound: The 'monotonic>=0.1' distribution was not found and is required by fasteners

With automatic dependency management this should never happen.

Scope

  • Proposal owners: Add macros to python-rpm-macros package which enables dependency generator.
  • Other developers: Packagers are advised to replace their hand-crafted list of dependencies on python libraries with simple macros.
  • Release engineering: #7276 (a check of an impact with Release Engineering is needed)
  • Policies and guidelines: Packaging:Python Guidelines need to reference how to turn on the feature (simple variable override). #740.
  • Trademark approval: N/A (not needed for this Change)

Upgrade/compatibility impact

Some new dependencies might be automatically added, but this is rather good because it fixes real bugs.

N/A (not a System Wide Change)

How To Test

  1. Make sure that python-rpm-macros >= 3-25 is installed
  2. Remove all requires for python modules
  3. Add following line to spec: %?python_enable_dependency_generator
  4. Rebuild package

Every dependency mentioned in egg/wheel (e.g. generated by setuptools/distutils from setup.py) should be automatically added.

User Experience

N/A (not a System Wide Change)

Dependencies

N/A (not a System Wide Change)

Contingency Plan

  • Contingency mechanism: (What to do? Who will do it?) N/A (not a System Wide Change)
  • Contingency deadline: N/A (not a System Wide Change)
  • Blocks release? N/A (not a System Wide Change), Yes/No
  • Blocks product? product

Documentation

N/A (not a System Wide Change)

Release Notes