No easy way to get the distribution which provided a importlib.metadata.EntryPoint #86548

Activity

1. s0undt3ch commented on Nov 17, 2020

   

   s0undt3chmannequin

   on Nov 17, 2020

   MannequinAuthor

   More actions

   With pkg_resources an EntryPoint has a dist attribute which allows you to get the distribution that provided that specific entry-point, however, with importlib.metafata and importlib_metadata that's not an east task.

   USE_IMPORTLIB_METADATA_STDLIB = USE_IMPORTLIB_METADATA = False
   try:
       # Py3.8+
       import importlib.metadata
   
       USE_IMPORTLIB_METADATA_STDLIB = True
   except ImportError:
       # < Py3.8 backport package
       import importlib_metadata
   
       USE_IMPORTLIB_METADATA = True
   
   
   def get_distribution_from_entry_point(entry_point):
       loaded_entry_point = entry_point.load()
       if isinstance(loaded_entry_point, types.ModuleType):
           module_path = loaded_entry_point.__file__
       else:
           module_path = sys.modules[loaded_entry_point.__module__].__file__
       if USE_IMPORTLIB_METADATA_STDLIB:
           distributions = importlib.metadata.distributions
       else:
           distributions = importlib_metadata.distributions
   
       for distribution in distributions():
           try:
               relative = pathlib.Path(module_path).relative_to(
                   distribution.locate_file("")
               )
           except ValueError:
               pass
           else:
               if relative in distribution.files:
                   return distribution

   The above solution has the additional drawback that you're iterating the distributions list, once per EntryPoint, which, was already iterated to get the entry-points listing.

   I propose we attach the Distribution instance to each of the found EntryPoint to avoid this low performance workaround.

   I don't have an issue with providing a pull-request, but should that pull request be done against importlib_metadata or importlib.metadata?
2. s0undt3ch

   added

   stdlibStandard Library Python modules in the Lib/ directoryStandard Library Python modules in the Lib/ directory

   type-featureA feature request or enhancementA feature request or enhancement

   on Nov 17, 2020
3. jaraco commented on Nov 17, 2020

   

   jaraco

   on Nov 17, 2020

   Member

   More actions

   Pedro - thanks for the detailed report. Pull requests against importlib_metadata are easier to accept because they can be tested more easily, released more rapidly, and there's a straightforward way to port them to CPython. Regardless, I see you've proposed a change to CPython, so I can work with that.
4. s0undt3ch commented on Nov 17, 2020

   

   s0undt3chmannequin

   on Nov 17, 2020

   MannequinAuthor

   More actions

   Guess I jumped too fast :)

   Will the changes in CPythom be included in importlib_metadata?
5. jaraco commented on Nov 17, 2020

   

   jaraco

   on Nov 17, 2020

   Member

   More actions

   Yes - I keep both in sync.
6. jaraco

   assigned

   jaraco

   on Dec 6, 2020
7. jaraco commented on Dec 6, 2020

   

   jaraco

   on Dec 6, 2020

   Member

   More actions

   I've ported the initial patch over to the backport and am exploring options in python/importlib_metadata#266.
8. jaraco commented on Dec 6, 2020

   

   jaraco

   on Dec 6, 2020

   Member

   More actions

   In discussion, I realized that I don't yet understand what use-cases drive this demand? What code is it that requires resolving a distribution from an entry point?
9. s0undt3ch commented on Dec 6, 2020

   

   s0undt3chmannequin

   on Dec 6, 2020

   MannequinAuthor

   More actions

   Our software uses a plug-in based approach.
   Plugins are able to add/modify internal behavior, and, as part of bug submission process we have a CLI flag which provides information about the core app as well as any intervening plugins.

   This is where we need to "map" an entry point to it's distribution, so we know the name and version of it to display on this report.
10. jaraco commented on Dec 31, 2020

    

    jaraco

    on Dec 31, 2020

    Member

    More actions

    New changeset dfdca85 by Jason R. Coombs in branch 'master':
    bpo-42382: In importlib.metadata, EntryPoint objects now expose dist (bpo-23758)
    dfdca85
11. jaraco

    closed this as completedon Mar 7, 2021
12. jaraco

    closed this as completedon Mar 7, 2021
13. jaraco

    added

    3.10 (EOL)end of lifeend of life

    on Mar 7, 2021
14. ezio-melotti

    transferred this issue fromon Apr 10, 2022