"importlib.metadata" -- Accessing package metadata
**************************************************

Nuevo en la versión 3.8.

Distinto en la versión 3.10: "importlib.metadata" ya no es
provisional.

**Source code:** Lib/importlib/metadata/__init__.py

"importlib.metadata" is a library that provides access to the metadata
of an installed Distribution Package, such as its entry points or its
top-level names (Import Packages, modules, if any). Built in part on
Python's import system, this library intends to replace similar
functionality in the entry point API and metadata API of
"pkg_resources".  Along with "importlib.resources", this package can
eliminate the need to use the older and less efficient "pkg_resources"
package.

"importlib.metadata" operates on third-party *distribution packages*
installed into Python's "site-packages" directory via tools such as
pip. Specifically, it works with distributions with discoverable
"dist-info" or "egg-info" directories, and metadata defined by the
Core metadata specifications.

Importante:

  These are *not* necessarily equivalent to or correspond 1:1 with the
  top-level *import package* names that can be imported inside Python
  code. One *distribution package* can contain multiple *import
  packages* (and single modules), and one top-level *import package*
  may map to multiple *distribution packages* if it is a namespace
  package. You can use package_distributions() to get a mapping
  between them.

By default, distribution metadata can live on the file system or in
zip archives on "sys.path".  Through an extension mechanism, the
metadata can live almost anywhere.

Ver también:

  https://importlib-metadata.readthedocs.io/
     The documentation for "importlib_metadata", which supplies a
     backport of "importlib.metadata". This includes an API reference
     for this module's classes and functions, as well as a migration
     guide for existing users of "pkg_resources".


Descripción general
===================

Let's say you wanted to get the version string for a Distribution
Package you've installed using "pip".  We start by creating a virtual
environment and installing something into it:

   $ python -m venv example
   $ source example/bin/activate
   (example) $ python -m pip install wheel

Se puede obtener la cadena de versión para "wheel" ejecutando lo
siguiente:

   (example) $ python
   >>> from importlib.metadata import version  
   >>> version('wheel')  
   '0.32.3'

You can also get a collection of entry points selectable by properties
of the EntryPoint (typically 'group' or 'name'), such as
"console_scripts", "distutils.commands" and others.  Each group
contains a collection of EntryPoint objects.

Se pueden obtener los metadatos para una distribución:

   >>> list(metadata('wheel'))  
   ['Metadata-Version', 'Name', 'Version', 'Summary', 'Home-page', 'Author', 'Author-email', 'Maintainer', 'Maintainer-email', 'License', 'Project-URL', 'Project-URL', 'Project-URL', 'Keywords', 'Platform', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Classifier', 'Requires-Python', 'Provides-Extra', 'Requires-Dist', 'Requires-Dist']

También se puede obtener el número de versión de una distribución,
enumerar sus archivos constituyentes y obtener una lista de los
Requerimientos de la distribución de la distribución.


API funcional
=============

Este paquete provee la siguiente funcionalidad a través de su API
pública.


Puntos de entrada
-----------------

La función "entry_points()" retorna una colección de todos los puntos
de entrada. Los puntos de entrada están representados por instancias
de "EntryPoint". Cada "EntryPoint" tiene los atributos ".name",
".group" y ".value", y un método ".load()" para resolver el valor.
También hay atributos ".module", ".attr" y ".extras" para obtener los
componentes del atributo ".value".

Consultar todos los puntos de entrada:

   >>> eps = entry_points()  

The "entry_points()" function returns an "EntryPoints" object, a
collection of all "EntryPoint" objects with "names" and "groups"
attributes for convenience:

   >>> sorted(eps.groups)  
   ['console_scripts', 'distutils.commands', 'distutils.setup_keywords', 'egg_info.writers', 'setuptools.installation']

"EntryPoints" tiene un método "select" para seleccionar puntos de
entrada que coincidan con propiedades específicas. Seleccione los
puntos de entrada en el grupo "console_scripts":

   >>> scripts = eps.select(group='console_scripts')  

De manera equivalente, ya que "entry_points" para argumentos de
palabra clave para seleccionar:

   >>> scripts = entry_points(group='console_scripts')  

Elige un script específico llamado "wheel" (que se encuentra en el
proyecto *wheel*):

   >>> 'wheel' in scripts.names  
   True
   >>> wheel = scripts['wheel']  

De manera equivalente, consulta por ese punto de entrada durante la
selección:

   >>> (wheel,) = entry_points(group='console_scripts', name='wheel')  
   >>> (wheel,) = entry_points().select(group='console_scripts', name='wheel')  

Inspeccionar el punto de entrada resuelto:

   >>> wheel  
   EntryPoint(name='wheel', value='wheel.cli:main', group='console_scripts')
   >>> wheel.module  
   'wheel.cli'
   >>> wheel.attr  
   'main'
   >>> wheel.extras  
   []
   >>> main = wheel.load()  
   >>> main  
   <function main at 0x103528488>

The "group" and "name" are arbitrary values defined by the package
author and usually a client will wish to resolve all entry points for
a particular group.  Read the setuptools docs for more information on
entry points, their definition, and usage.

*Nota de compatibilidad*

Los puntos de entrada "seleccionables" se introdujeron en
"importlib_metadata" 3.6 y Python 3.10. Antes de esos cambios,
"entry_points" no aceptaba parámetros y siempre retornaba un
diccionario de puntos de entrada, cifrados por grupo. Para la
compatibilidad, si no se pasa ningún parámetro a *entry_points*, se
retorna un objeto "SelectableGroups", implementando esa interfaz de
diccionario. En el futuro, llamar a "entry_points" sin parámetros
retornará un objeto "EntryPoints". Los usuarios deberían confiar en la
interfaz de selección para recuperar los puntos de entrada por grupo.


Metadatos de distribución
-------------------------

Every Distribution Package includes some metadata, which you can
extract using the "metadata()" function:

   >>> wheel_metadata = metadata('wheel')  

Las claves de la estructura de datos retornada un "PackageMetadata",
nombran las palabras clave de los metadatos y sus valores se retornan
sin analizar de los metadatos de distribución:

   >>> wheel_metadata['Requires-Python']  
   '>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'

"PackageMetadata" también presenta un atributo "json" que retorna
todos los metadatos en un formulario compatible con JSON por **PEP
566**:

   >>> wheel_metadata.json['requires_python']
   '>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'

Nota:

  The actual type of the object returned by "metadata()" is an
  implementation detail and should be accessed only through the
  interface described by the PackageMetadata protocol.

Distinto en la versión 3.10: La "Descripción" ahora se incluye en los
metadatos cuando se presenta a través de la carga útil. Se han
eliminado los caracteres de continuación de línea.El atributo "json"
fue añadido.


Versiones de distribución
-------------------------

The "version()" function is the quickest way to get a Distribution
Package's version number, as a string:

   >>> version('wheel')  
   '0.32.3'


Archivos de distribución
------------------------

You can also get the full set of files contained within a
distribution.  The "files()" function takes a Distribution Package
name and returns all of the files installed by this distribution.
Each file object returned is a "PackagePath", a "pathlib.PurePath"
derived object with additional "dist", "size", and "hash" properties
as indicated by the metadata.  For example:

   >>> util = [p for p in files('wheel') if 'util.py' in str(p)][0]  
   >>> util  
   PackagePath('wheel/util.py')
   >>> util.size  
   859
   >>> util.dist  
   <importlib.metadata._hooks.PathDistribution object at 0x101e0cef0>
   >>> util.hash  
   <FileHash mode: sha256 value: bYkw5oMccfazVCoYQwKkkemoVyMAFoR34mmKBx8R1NI>

Una vez que se tiene el archivo, también se puede leer su contenido:

   >>> print(util.read_text())  
   import base64
   import sys
   ...
   def as_bytes(s):
       if isinstance(s, text_type):
           return s.encode('utf-8')
       return s

También puede usar el método "locate" para obtener la ruta absoluta al
archivo:

   >>> util.locate()  
   PosixPath('/home/gustav/example/lib/site-packages/wheel/util.py')

En el caso de que el archivo de metadatos que enumera los archivos
(RECORD o SOURCES.txt) falte, "files()" retornará "None". Para evitar
esta condición, si no se sabe si la distribución de destino contiene
los metadatos, se puede envolver las llamadas a "files()" con
always_iterable u otra protección similar.


Requerimientos de la distribución
---------------------------------

To get the full set of requirements for a Distribution Package, use
the "requires()" function:

   >>> requires('wheel')  
   ["pytest (>=3.0.0) ; extra == 'test'", "pytest-cov ; extra == 'test'"]


Mapping import to distribution packages
---------------------------------------

A convenience method to resolve the Distribution Package name (or
names, in the case of a namespace package) that provide each
importable top-level Python module or Import Package:

   >>> packages_distributions()
   {'importlib_metadata': ['importlib-metadata'], 'yaml': ['PyYAML'], 'jaraco': ['jaraco.classes', 'jaraco.functools'], ...}

Nuevo en la versión 3.10.


Distribuciones
==============

While the above API is the most common and convenient usage, you can
get all of that information from the "Distribution" class.  A
"Distribution" is an abstract object that represents the metadata for
a Python Distribution Package.  You can get the "Distribution"
instance:

   >>> from importlib.metadata import distribution  
   >>> dist = distribution('wheel')  

Por lo tanto, una forma alternativa de obtener el número de versión es
mediante la instancia de "Distribución":

   >>> dist.version  
   '0.32.3'

Hay todo tipo de metadatos disponibles adicionales en la instancia de
"Distribution":

   >>> dist.metadata['Requires-Python']  
   '>=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*'
   >>> dist.metadata['License']  
   'MIT'

The full set of available metadata is not described here. See the Core
metadata specifications for additional details.


Distribution Discovery
======================

By default, this package provides built-in support for discovery of
metadata for file system and zip file Distribution Packages. This
metadata finder search defaults to "sys.path", but varies slightly in
how it interprets those values from how other import machinery does.
In particular:

* "importlib.metadata" does not honor "bytes" objects on "sys.path".

* "importlib.metadata" will incidentally honor "pathlib.Path" objects
  on "sys.path" even though such values will be ignored for imports.


Extendiendo el algoritmo de búsqueda
====================================

Because Distribution Package metadata is not available through
"sys.path" searches, or package loaders directly, the metadata for a
distribution is found through import system finders.  To find a
distribution package's metadata, "importlib.metadata" queries the list
of *meta path finders* on "sys.meta_path".

By default "importlib.metadata" installs a finder for distribution
packages found on the file system. This finder doesn't actually find
any *distributions*, but it can find their metadata.

La clase abstracta "importlib.abc.MetaPathFinder" define la interfaz
que se espera de los buscadores por el sistema de importación de
Python. "importlib.metadata" amplía este protocolo buscando una
"find_distributions" opcional invocable en los buscadores desde
"sys.meta_path" y presenta esta interfaz extendida como la clase base
abstracta "DistributionFinder", que define este método abstracto:

   @abc.abstractmethod
   def find_distributions(context=DistributionFinder.Context()):
       """Return an iterable of all Distribution instances capable of
       loading the metadata for packages for the indicated ``context``.
       """

El objeto "DistributionFinder.Context" proporciona propiedades ".path"
y ".name" que indican la ruta de búsqueda y los nombres que deben
coincidir y puede proporcionar otro contexto relevante.

Lo que esto significa en la práctica es que, para soportar la búsqueda
de metadatos en paquetes de distribución en ubicaciones distintas al
sistema de archivos, se debe subclasificar "Distribution" e
implementar sus métodos abstractos. Luego, en el método
"find_distributions()" de un buscador personalizado no hay más que
retornar instancias de esta "Distribution" derivada.
