File: //opt/saltstack/salt/lib/python3.10/site-packages/setuptools/__pycache__/discovery.cpython-310.pyc
o
�N�g�R � @ s� d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlm Z m
Z
m Z m Z m
Z
mZmZmZmZ ddlZddlmZ ddlmZ eeejf Ze e Zej j Z e rYdd l m Z d
ed e!fd d
�Z"G dd� d�Z#G dd� d�Z$G dd� de$�Z%G dd� de%�Z&G dd� de$�Z'G dd� de&�Z(G dd� de'�Z)d ed ed e
e fd d �Z*G d d!� d!�Z+d"e
e d e
e fd#d$�Z,d"e
e d e
e fd%d&�Z-d"e
e d'eeef d(ed ee fd)d*�Z.d+ed'eeef d(ed efd,d-�Z/d"e
e d.ed e
eef fd/d0�Z0dS )1u_ Automatic discovery of Python modules and packages (for inclusion in the
distribution) and other config values.
For the purposes of this module, the following nomenclature is used:
- "src-layout": a directory representing a Python project that contains a "src"
folder. Everything under the "src" folder is meant to be included in the
distribution when packaging the project. Example::
.
├── tox.ini
├── pyproject.toml
└── src/
└── mypkg/
├── __init__.py
├── mymodule.py
└── my_data_file.txt
- "flat-layout": a Python project that does not use "src-layout" but instead
have a directory under the project root for each package::
.
├── tox.ini
├── pyproject.toml
└── mypkg/
├── __init__.py
├── mymodule.py
└── my_data_file.txt
- "single-module": a project that contains a single Python script direct under
the project root (no directory used)::
.
├── tox.ini
├── pyproject.toml
└── mymodule.py
� N�� fnmatchcase)�glob)�Path) �
TYPE_CHECKING�Dict�Iterable�Iterator�List�Mapping�Optional�Tuple�Union)�log)� convert_path)� Distribution�path�returnc C s t j�| ��� S �N)�osr �basename� isidentifier)r � r �H/opt/saltstack/salt/lib/python3.10/site-packages/setuptools/discovery.py� _valid_nameG s r c @ sB e Zd ZdZdefdd�Zdedefdd�Zdedefd d
�Zd S ) �_Filterz�
Given a list of patterns, create a callable that will be true only if
the input matches at least one of the patterns.
�patternsc G s t �|�| _d S r )�dict�fromkeys� _patterns)�selfr r r r �__init__R s z_Filter.__init__�itemr c s t � fdd�| jD ��S )Nc 3 s � | ]}t � |�V qd S r r )�.0�pat�r" r r � <genexpr>V s � z#_Filter.__call__.<locals>.<genexpr>)�anyr �r r" r r% r �__call__U s z_Filter.__call__c C s
|| j v S r )r r( r r r � __contains__X s
z_Filter.__contains__N) �__name__�
__module__� __qualname__�__doc__�strr! �boolr) r* r r r r r L s
r c @ s� e Zd ZU dZdZeedf ed< dZeedf ed< e dde
d e e d
e e d e e fd d
��Z
e de
d ed
ed efdd��ZdS )�_Finderz@Base class that exposes functionality for module/package findersr .�ALWAYS_EXCLUDE�DEFAULT_EXCLUDE�.��*�where�exclude�includer c C s8 |p| j }t| �tt|��tg | j�|�R � t|� ��S )aF Return a list of all Python items (packages or modules, depending on
the finder implementation) found within directory 'where'.
'where' is the root directory which will be searched.
It should be supplied as a "cross-platform" (i.e. URL-style) path;
it will be converted to the appropriate local path syntax.
'exclude' is a sequence of names to exclude; '*' can be used
as a wildcard in the names.
When finding packages, 'foo.*' will exclude all subpackages of 'foo'
(but not 'foo' itself).
'include' is a sequence of names to include.
If it's specified, only the named items will be included.
If it's not specified, all found items will be included.
'include' can contain shell style wildcard patterns just like
'exclude'.
)r3 �list�
_find_iterr r/ r r2 ��clsr7 r8 r9 r r r �findb s
��z _Finder.findc C s t �r )�NotImplementedErrorr< r r r r; � � z_Finder._find_iterN)r4 r r5 )r+ r, r- r. r2 r
r/ �__annotations__r3 � classmethod�_Pathr r
r> r �StrIterr; r r r r r1 \ s&
���� �" r1 c @ sL e Zd ZdZdZededededefdd��Z e
d ed
e de fd d ��Z
d
S )�
PackageFinderzI
Generate a list of all Python packages found within a directory
)Zez_setupz *__pycache__r7 r8 r9 r c c s� � t jt|�dd�D ]V\}}}|dd� }g |dd�< |D ]B}t j�||�} t j�| |�}
|
�t jjd�} d|v s?| �| | �s@q || �rK|| �sK| V | � d�|v sY| � d�|v rZq |� |� q q
dS )zy
All the packages found in 'where' that pass the 'include' filter, but
not the 'exclude' filter.
T)� followlinksNr4 r6 �.*)
r �walkr/ r �join�relpath�replace�sep�_looks_like_package�append) r= r7 r8 r9 �root�dirs�filesZall_dirs�dir� full_pathZrel_path�packager r r r; � s" � ��zPackageFinder._find_iterr �
_package_namec C s t j�t j�| d��S )z%Does a directory look like a package?� __init__.py)r r �isfilerI )r rU r r r rM � s z!PackageFinder._looks_like_packageN)r+ r, r- r. r2 rB rC r rD r; � staticmethodr/ r0 rM r r r r rE � s rE c @ s& e Zd Zedededefdd��ZdS )�PEP420PackageFinder�_pathrU r c C s dS )NTr )rZ rU r r r rM � r@ z'PEP420PackageFinder._looks_like_packageN)r+ r, r- rX rC r/ r0 rM r r r r rY � s rY c @ s6 e Zd ZdZededededefdd��Ze e
�Z dS ) � ModuleFinderzYFind isolated Python modules.
This function will **not** recurse subdirectories.
r7 r8 r9 r c c sX � t tj�|d��D ] }tj�tj�|��\}}| �|�s q
||�r)||�s)|V q
d S )Nz*.py)r r r rI �splitextr �_looks_like_module)r= r7 r8 r9 �file�moduleZ_extr r r r; � s �
��zModuleFinder._find_iterN) r+ r, r- r. rB rC r rD r; rX r r] r r r r r[ � s
r[ c @ sB e Zd ZdZeedd� eD ���Z edede de
fdd��Z d S )
�FlatLayoutPackageFinder)#Zci�binZdebian�docZdocsZ
documentationZmanpages�newsZ
newsfragmentsZ changelog�test�testsZ unit_testZ
unit_tests�example�examples�scriptsZtools�util�utils�python�build�dist�venv�envZ requirements�tasks�fabfileZ
site_scons� benchmark�
benchmarks�exercise� exercisesZhtmlcov�[._]*c c s � | ]
}||� d �fV qdS )rG Nr )r# �pr r r r& � s � z!FlatLayoutPackageFinder.<genexpr>rZ � package_namer c C sB |� d�}|d �� p|d �d�}|o tdd� |dd � D ��S )Nr4 r �-stubsc s s � | ]}|� � V qd S r )r )r# �namer r r r& s � z>FlatLayoutPackageFinder._looks_like_package.<locals>.<genexpr>� )�splitr �endswith�all)rZ rx �namesZroot_pkg_is_validr r r rM s
z+FlatLayoutPackageFinder._looks_like_packageN) r+ r, r- Z_EXCLUDE�tuple�
chain_iterr3 rX rC r/ r0 rM r r r r r` � s ) r` c @ s e Zd ZdZdS )�FlatLayoutModuleFinder)�setupZconftestrd re rf rg rl ZtoxfileZnoxfileZpavementZdodorp rq z[Ss][Cc]onstructZ conanfileZmanagerr rs rt ru rv N)r+ r, r- r3 r r r r r� s r� �root_pkg�pkg_dirc s" t �|�}� g� fdd�|D � S )Nc s g | ] }d � � |f��qS )r4 )rI �r# �n�r� r r �
<listcomp>) s z)_find_packages_within.<locals>.<listcomp>)rY r> )r� r� �nestedr r� r �_find_packages_within' s
r� c @ s e Zd ZdZd-dd�Zdd� Zdd � Zed
efd d ��Z ed
e
e e f fd
d��Z d.dd�Z
ded
efdd�Zded
efdd�Zd
efdd�Zd
efdd�Zd
efd d �Zd
efd d �Zd
efd d!�Zd"ee d#e fd$d%�Zd&d'� Zd
ee fd(d)�Zd
ee fd*d+�Zd,S )/�ConfigDiscoveryz�Fill-in metadata and options that can be automatically derived
(from other metadata/options, the file system or conventions)
� distributionr c C s || _ d| _d| _d| _d S )NF)rm �_called� _disabled�_skip_ext_modules)r r� r r r r! 1 s
zConfigDiscovery.__init__c C �
d| _ dS )z+Internal API to disable automatic discoveryTN)r� �r r r r �_disable7 s
zConfigDiscovery._disablec C r� )a� Internal API to disregard ext_modules.
Normally auto-discovery would not be triggered if ``ext_modules`` are set
(this is done for backward compatibility with existing packages relying on
``setup.py`` or ``setup.cfg``). However, ``setuptools`` can call this function
to ignore given ``ext_modules`` and proceed with the auto-discovery if
``packages`` and ``py_modules`` are not given (e.g. when using pyproject.toml
metadata).
TN)r� r� r r r �_ignore_ext_modules; s
z#ConfigDiscovery._ignore_ext_modulesr c C s | j jptjS r )rm Zsrc_rootr �curdirr� r r r � _root_dirG s zConfigDiscovery._root_dirc C s | j jd u ri S | j jS r )rm � package_dirr� r r r � _package_dirL s z ConfigDiscovery._package_dirFTc C s8 |du r | j s
| jr dS | �|� |r| �� d| _ dS )a� Automatically discover missing configuration fields
and modifies the given ``distribution`` object in-place.
Note that by default this will only have an effect the first time the
``ConfigDiscovery`` object is called.
To repeatedly invoke automatic discovery (e.g. when the project
directory changes), please use ``force=True`` (or create a new
``ConfigDiscovery`` instance).
FNT)r� r� �_analyse_package_layout� analyse_name)r �forcerz �ignore_ext_modulesr r r r) R s
zConfigDiscovery.__call__r� c C sL |p| j }| jjdu p | }| jjdup%| jjdup%|p%t| jd�o%| jjS )zF``True`` if the user has specified some form of package/module listingN�
configuration)r� rm � ext_modules�packages�
py_modules�hasattrr� )r r� r� r r r �_explicitly_specifiedg s
�� �z%ConfigDiscovery._explicitly_specifiedc C s0 | � |�rdS t�d� | �� p| �� p| �� S )NTzLNo `packages` or `py_modules` configuration, performing automatic discovery.)r� r �debug�_analyse_explicit_layout�_analyse_src_layout�_analyse_flat_layout)r r� r r r r� t s
���z'ConfigDiscovery._analyse_package_layoutc sr | j �� }|�dd� | j� |sdS t�d|� �� t� fdd�|�� D ��}t|�| j _
t�d| j j
� �� dS ) zAThe user can explicitly give a package layout via ``package_dir``� NFz(`explicit-layout` detected -- analysing c 3 s( � | ]\}}t |tj�� |��V qd S r )r� r r rI )r# �pkgZ
parent_dir��root_dirr r r& � s
� �
�z;ConfigDiscovery._analyse_explicit_layout.<locals>.<genexpr>�discovered packages -- T) r� �copy�popr� r r� r� �itemsr: rm r� )r r� �pkgsr r� r r� � s
� z(ConfigDiscovery._analyse_explicit_layoutc C s� | j }tj�| j|�dd��}tj�|�sdS t�d|� �� |� dtj�
|�� || j _ t
�|�| j _t�|�| j _t�d| j j� �� t�d| j j� �� dS )a� Try to find all packages or modules under the ``src`` directory
(or anything pointed by ``package_dir[""]``).
The "src-layout" is relatively safe for automatic discovery.
We assume that everything within is meant to be included in the
distribution.
If ``package_dir[""]`` is not given, but the ``src`` directory exists,
this function will set ``package_dir[""] = "src"``.
r� �srcFz#`src-layout` detected -- analysing r� �discovered py_modules -- T)r� r r rI r� �get�isdirr r� �
setdefaultr rm r� rY r> r� r[ r� )r r� Zsrc_dirr r r r� � s z#ConfigDiscovery._analyse_src_layoutc C s" t �d| j� �� | �� p| �� S )a� Try to find all packages and modules under the project root.
Since the ``flat-layout`` is more dangerous in terms of accidentally including
extra files/directories, this function is more conservative and will raise an
error if multiple packages or modules are found.
This assumes that multi-package dists are uncommon and refuse to support that
use case in order to be able to prevent unintended errors.
z$`flat-layout` detected -- analysing )r r� r� �_analyse_flat_packages�_analyse_flat_modulesr� r r r r� � s
z$ConfigDiscovery._analyse_flat_layoutc C sH t �| j�| j_tt| jj��}t�d| jj� �� | � |d� t
|�S )Nr� r� ) r` r> r� rm r� �remove_nested_packages� remove_stubsr r� � _ensure_no_accidental_inclusionr0 )r � top_levelr r r r� � s
z&ConfigDiscovery._analyse_flat_packagesc C s@ t �| j�| j_t�d| jj� �� | �| jjd� t| jj�S )Nr� �modules) r� r> r� rm r� r r� r� r0 r� r r r r� � s z%ConfigDiscovery._analyse_flat_modules�detected�kindc C sL t |�dkr$ddlm} ddlm} d|� d|� d|� d�}|||���d S ) Nr{ r )�cleandoc)�PackageDiscoveryErrorzMultiple top-level z discovered in a flat-layout: z�.
To avoid accidental inclusion of unwanted files or directories,
setuptools will not proceed with this build.
If you are trying to create a single distribution with multiple a�
on purpose, you should not rely on automatic discovery.
Instead, consider the following options:
1. set up custom discovery (`find` directive with `include` or `exclude`)
2. use a `src-layout`
3. explicitly set `py_modules` or `packages` with a list of names
To find more information, look for "package discovery" on setuptools docs.
)�len�inspectr� Zsetuptools.errorsr� )r r� r� r� r� �msgr r r r� � s � �z/ConfigDiscovery._ensure_no_accidental_inclusionc C sF | j jjs | j jr dS t�d� | �� p| �� }|r!|| j j_dS dS )z�The packages/modules are the essential contribution of the author.
Therefore the name of the distribution can be derived from them.
Nz7No `name` configuration, performing automatic discovery)rm �metadatarz r r� �#_find_name_single_package_or_module�_find_name_from_packages)r rz r r r r� � s
��z ConfigDiscovery.analyse_namec C sP dD ]#}t | j|d�p g }|r%t|�dkr%t�d|d � �� |d S qdS )z Exactly one module or package)r� r� Nr{ z&Single module/package detected, name: r )�getattrrm r� r r� )r �fieldr� r r r r� � s �z3ConfigDiscovery._find_name_single_package_or_modulec C s` | j jsdS tt| j jtd��}| j jpi }t||| j�}|r)t� d|� �� |S t�
d� dS )z<Try to find the root package that is not a PEP 420 namespaceN��keyz&Common parent package detected, name: z7No parent package detected, impossible to derive `name`) rm r� r� �sortedr� r� �find_parent_packager� r r� �warn)r r� r� Z
parent_pkgr r r r� � s
z(ConfigDiscovery._find_name_from_packagesN)r� r )FTF) r+ r, r- r. r! r� r� �propertyrC r� r r/ r� r) r0 r� r� r� r� r� r� r� r
r� r� r r� r� r r r r r� , s*
r� r� c sb t | td�}|dd� }t|�}tt|��D ]\}� t� fdd�|D ��r.|�|| d � q|S )z�Remove nested packages from a list of packages.
>>> remove_nested_packages(["a", "a.b1", "a.b2", "a.b1.c1"])
['a']
>>> remove_nested_packages(["a", "b", "c.d", "c.d.e.f", "g.h", "a.a1"])
['a', 'b', 'c.d', 'g.h']
r� Nc 3 s � | ] }� � |� d ��V qdS �r4 N��
startswith)r# �other�rz r r r& � � z)remove_nested_packages.<locals>.<genexpr>r{ )r� r� � enumerate�reversedr' r� )r� r� r� �size�ir r� r r� s �r� c C s dd� | D �S )z�Remove type stubs (:pep:`561`) from a list of packages.
>>> remove_stubs(["a", "a.b", "a-stubs", "a-stubs.b.c", "b", "c-stubs"])
['a', 'a.b', 'b']
c S s$ g | ]}|� d �d �d�s|�qS )r4 r ry )r| r} �r# r� r r r r� & s $ z remove_stubs.<locals>.<listcomp>r )r� r r r r� s r� r� r� c s� t | td�} g }t| �D ] \}� t� fdd�| |d d� D ��s# n|�� � q |D ]� t� ||�}tj�|d�}tj� |�rD� S q+dS )z0Find the parent package that is not a namespace.r� c 3 s � | ] }|� � � d ��V qdS r� r� r� r� r r r& 0 r� z&find_parent_package.<locals>.<genexpr>r{ NrV )
r� r� r� r~ rN �find_package_pathr r rI rW )r� r� r� Zcommon_ancestorsr� Zpkg_path�initr r� r r� ) s " �r� rz c C s� | � d�}tt|�dd�D ]$}d�|d|� �}||v r1|| }tjj||g||d� �R � S q
|�d�p8d}tjj|g|� d��|�R � S )a� Given a package name, return the path where it should be found on
disk, considering the ``package_dir`` option.
>>> path = find_package_path("my.pkg", {"": "root/is/nested"}, ".")
>>> path.replace(os.sep, "/")
'./root/is/nested/my/pkg'
>>> path = find_package_path("my.pkg", {"my": "root/is/nested"}, ".")
>>> path.replace(os.sep, "/")
'./root/is/nested/pkg'
>>> path = find_package_path("my.pkg", {"my.pkg": "root/is/nested"}, ".")
>>> path.replace(os.sep, "/")
'./root/is/nested'
>>> path = find_package_path("other.pkg", {"my.pkg": "root/is/nested"}, ".")
>>> path.replace(os.sep, "/")
'./other/pkg'
r4 r ���Nr� �/)r| �ranger� rI r r r� )rz r� r� �partsr� Z partial_name�parentr r r r� A s
"� r� � package_pathc s$ t | �}t|�j� � fdd�|D �S )Nc s& i | ]}|d � g � �|�d����qS )r� r4 )rI r| r� ��prefixr r �
<dictcomp>f s & z)construct_package_dir.<locals>.<dictcomp>)r� r r� )r� r� Z parent_pkgsr r� r �construct_package_dirc s
r� )1r. � itertoolsr �fnmatchr r �pathlibr �typingr r r r r
r r r
r Z_distutils_hack.override�_distutils_hack� distutilsr Zdistutils.utilr r/ �PathLikerC rD �chain�
from_iterabler� Z
setuptoolsr r0 r r r1 rE rY r[ r` r� r� r� r� r� r� r� r� r r r r �<module> s^ ' , .-5 c �
��
��
��
�&"