discovery.pyc
1 o 2 ���c?Q � @ s d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlm Z m 3 Z 4 m Z m Z m Z mZmZmZmZmZ ddlZddlmZ ddlmZ eeejf Ze 5 ege f Z e e Z ej j Z!e rbdd l"m#Z# d 6 ed e fd 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*deded ee fd d �Z+G d d � d �Z,d ee d ee fd!d"�Z-d ee d ee fd#d$�Z.d ee d%eeef d&ed ee fd'd(�Z/d)ed%eeef d&ed efd*d+�Z0d ee d,ed e eef fd-d.�Z1dS )/u_ Automatic discovery of Python modules and packages (for inclusion in the 7 distribution) and other config values. 8 9 For the purposes of this module, the following nomenclature is used: 10 11 - "src-layout": a directory representing a Python project that contains a "src" 12 folder. Everything under the "src" folder is meant to be included in the 13 distribution when packaging the project. Example:: 14 15 . 16 ├── tox.ini 17 ├── pyproject.toml 18 └── src/ 19 └── mypkg/ 20 ├── __init__.py 21 ├── mymodule.py 22 └── my_data_file.txt 23 24 - "flat-layout": a Python project that does not use "src-layout" but instead 25 have a directory under the project root for each package:: 26 27 . 28 ├── tox.ini 29 ├── pyproject.toml 30 └── mypkg/ 31 ├── __init__.py 32 ├── mymodule.py 33 └── my_data_file.txt 34 35 - "single-module": a project that contains a single Python script direct under 36 the project root (no directory used):: 37 38 . 39 ├── tox.ini 40 ├── pyproject.toml 41 └── mymodule.py 42 43 � N�� fnmatchcase)�glob)�Path) 44 � TYPE_CHECKING�Callable�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 ��C:\Program Files\WindowsApps\PythonSoftwareFoundation.Python.3.10_3.10.2800.0_x64__qbz5n2kfra8p0\lib\site-packages\setuptools\discovery.py� _valid_nameI s r c @ s� e Zd ZU dZdZeedf ed< dZeedf ed< e dde 45 d e e d 46 e e d e e fd d ��Z e de 47 d ed 48 ed efdd��Zeded efdd��ZdS )�_Finderz@Base class that exposes functionality for module/package findersr .�ALWAYS_EXCLUDE�DEFAULT_EXCLUDE�.��*�where�exclude�includer c C s< |p| j }t| �tt|��| jg | j�|�R � | j|� ��S )aF Return a list of all Python items (packages or modules, depending on 49 the finder implementation) found within directory 'where'. 50 51 'where' is the root directory which will be searched. 52 It should be supplied as a "cross-platform" (i.e. URL-style) path; 53 it will be converted to the appropriate local path syntax. 54 55 'exclude' is a sequence of names to exclude; '*' can be used 56 as a wildcard in the names. 57 When finding packages, 'foo.*' will exclude all subpackages of 'foo' 58 (but not 'foo' itself). 59 60 'include' is a sequence of names to include. 61 If it's specified, only the named items will be included. 62 If it's not specified, all found items will be included. 63 'include' can contain shell style wildcard patterns just like 64 'exclude'. 65 )r �list� 66 _find_iterr �str� _build_filterr ��clsr" r# r$ r r r �findT s 67 68 ��z _Finder.findc C s t �r )�NotImplementedErrorr) r r r r& w � z_Finder._find_iter�patternsc s � fdd�S )z� 69 Given a list of patterns, return a callable that will be true only if 70 the input matches at least one of the patterns. 71 c s t � fdd��D ��S )Nc 3 s � | ]}t � |�V qd S r r )�.0�pat��namer r � <genexpr>� s � z:_Finder._build_filter.<locals>.<lambda>.<locals>.<genexpr>)�anyr1 �r. r1 r �<lambda>� s z'_Finder._build_filter.<locals>.<lambda>r r5 r r5 r r( { s z_Finder._build_filterN)r r r )�__name__� 72 __module__� __qualname__�__doc__r r r' �__annotations__r � classmethod�_Pathr r r+ �_Filter�StrIterr& � staticmethodr( r r r r r N s* 73 ���� �" r c @ sL e Zd ZdZdZededededefdd��Z e 74 d ed 75 e de fd d ��Z d S )� PackageFinderzI 76 Generate a list of all Python packages found within a directory 77 )�ez_setupz *__pycache__r" r# r$ r c c s� � t jt|�dd�D ]G\}}}|dd� }g |dd�< |D ]3}t j�||�} t j�| |�} 78 | 79 �t jjd�} d|v s?| �| | �s@q || �rK|| �sK| V |� |� q q 80 dS )zy 81 All the packages found in 'where' that pass the 'include' filter, but 82 not the 'exclude' filter. 83 T)� followlinksNr ) 84 r �walkr' r �join�relpath�replace�sep�_looks_like_package�append) r* r" r# r$ �root�dirs�files�all_dirs�dir� full_path�rel_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 �isfilerE )r rS r r r rI � s z!PackageFinder._looks_like_packageN)r7 r8 r9 r: r r< r= r> r? r& r@ r' �boolrI r r r r rA � s rA c @ s& e Zd Zedededefdd��ZdS )�PEP420PackageFinder�_pathrS r c C s dS )NTr )rX rS r r r rI � r- z'PEP420PackageFinder._looks_like_packageN)r7 r8 r9 r@ r= r' rV rI r r r r rW � s rW c @ s6 e Zd ZdZededededefdd��Ze e 85 �Z dS ) � ModuleFinderzYFind isolated Python modules. 86 This function will **not** recurse subdirectories. 87 r" r# r$ r c c sX � t tj�|d��D ] }tj�tj�|��\}}| �|�s q 88 ||�r)||�s)|V q 89 d S )Nz*.py)r r r rE �splitextr �_looks_like_module)r* r" r# r$ �file�module�_extr r r r& � s � 90 ��zModuleFinder._find_iterN) r7 r8 r9 r: r< r= r> r? r& r@ r r[ r r r r rY � s 91 92 rY c @ sB e Zd ZdZeedd� eD ���Z edede de 93 fdd��Z d S ) 94 �FlatLayoutPackageFinder) �ci�bin�doc�docs� documentation�manpages�news� changelog�test�tests� unit_test� 95 unit_tests�example�examples�scripts�tools�util�utils�python�build�dist�venv�env� requirements�tasks�fabfile� 96 site_scons� benchmark� 97 benchmarks�exercise� exercises�[._]*c c s � | ] 98 }||� d �fV qdS )z.*Nr )r/ �pr r r r3 � s � z!FlatLayoutPackageFinder.<genexpr>rX � package_namer c C sB |� d�}|d �� p|d �d�}|o tdd� |dd � D ��S )Nr r �-stubsc s s � | ]}|� � V qd S r )r )r/ r2 r r r r3 � s � z>FlatLayoutPackageFinder._looks_like_package.<locals>.<genexpr>� )�splitr �endswith�all)rX r� �names�root_pkg_is_validr r r rI � s 99 z+FlatLayoutPackageFinder._looks_like_packageN) r7 r8 r9 �_EXCLUDE�tuple� 100 chain_iterr r@ r= r' rV rI r r r r r_ � s & r_ c @ s e Zd ZdZdS )�FlatLayoutModuleFinder)�setup�conftestrh ri rl rm rs �toxfile�noxfile�pavement�dodorx ry z[Ss][Cc]onstruct� conanfile�manager{ r| r} r~ r N)r7 r8 r9 r r r r r r� � s r� �root_pkg�pkg_dirc s" t �|�}� g� fdd�|D � S )Nc s g | ] }d � � |f��qS )r )rE �r/ �n�r� r r � 101 <listcomp> s z)_find_packages_within.<locals>.<listcomp>)rW r+ )r� r� �nestedr r� r �_find_packages_within s 102 r� c @ s e Zd ZdZd-dd�Zdd� Zdd � Zed 103 efd d ��Z ed 104 e 105 e e f fd d��Z d.dd�Z ded 106 efdd�Zded 107 efdd�Zd 108 efdd�Zd 109 efdd�Zd 110 efd d �Zd 111 efd d �Zd 112 efd d!�Zd"ee d#e fd$d%�Zd&d'� Zd 113 ee fd(d)�Zd 114 ee fd*d+�Zd,S )/�ConfigDiscoveryz�Fill-in metadata and options that can be automatically derived 115 (from other metadata/options, the file system or conventions) 116 � distributionr c C s || _ d| _d| _d| _d S )NF)rt �_called� _disabled�_skip_ext_modules)�selfr� r r r �__init__$ s 117 zConfigDiscovery.__init__c C � 118 d| _ dS )z+Internal API to disable automatic discoveryTN)r� �r� r r r �_disable* s 119 zConfigDiscovery._disablec C r� )a� Internal API to disregard ext_modules. 120 121 Normally auto-discovery would not be triggered if ``ext_modules`` are set 122 (this is done for backward compatibility with existing packages relying on 123 ``setup.py`` or ``setup.cfg``). However, ``setuptools`` can call this function 124 to ignore given ``ext_modules`` and proceed with the auto-discovery if 125 ``packages`` and ``py_modules`` are not given (e.g. when using pyproject.toml 126 metadata). 127 TN)r� r� r r r �_ignore_ext_modules. s 128 129 z#ConfigDiscovery._ignore_ext_modulesr c C s | j jptjS r )rt �src_rootr �curdirr� r r r � _root_dir: s zConfigDiscovery._root_dirc C s | j jd u ri S | j jS r )rt � package_dirr� r r r � _package_dir? s z ConfigDiscovery._package_dirFTc C s8 |du r | j s 130 | jr dS | �|� |r| �� d| _ dS )a� Automatically discover missing configuration fields 131 and modifies the given ``distribution`` object in-place. 132 133 Note that by default this will only have an effect the first time the 134 ``ConfigDiscovery`` object is called. 135 136 To repeatedly invoke automatic discovery (e.g. when the project 137 directory changes), please use ``force=True`` (or create a new 138 ``ConfigDiscovery`` instance). 139 FNT)r� r� �_analyse_package_layout� analyse_name)r� �forcer2 �ignore_ext_modulesr r r �__call__E s 140 141 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� rt � ext_modules�packages� 142 py_modules�hasattrr� )r� r� r� r r r �_explicitly_specifiedZ s 143 144 ���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� f s 145 ���z'ConfigDiscovery._analyse_package_layoutc sr | j �� }|�dd� | j� |sdS t�d|� �� t� fdd�|�� D ��}t|�| j _ 146 t�d| j j 147 � �� 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 rE )r/ �pkg� 148 parent_dir��root_dirr r r3 � s 149 � � 150 �z;ConfigDiscovery._analyse_explicit_layout.<locals>.<genexpr>�discovered packages -- T) r� �copy�popr� r r� r� �itemsr% rt r� )r� r� �pkgsr r� r r� x s 151 � z(ConfigDiscovery._analyse_explicit_layoutc C s� | j }tj�| j|�dd��}tj�|�sdS t�d|� �� |� dtj� 152 |�� || 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 153 (or anything pointed by ``package_dir[""]``). 154 155 The "src-layout" is relatively safe for automatic discovery. 156 We assume that everything within is meant to be included in the 157 distribution. 158 159 If ``package_dir[""]`` is not given, but the ``src`` directory exists, 160 this function will set ``package_dir[""] = "src"``. 161 r� �srcFz#`src-layout` detected -- analysing r� �discovered py_modules -- T)r� r r rE r� �get�isdirr r� � 162 setdefaultr rt r� rW r+ r� rY r� )r� r� �src_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. 163 164 Since the ``flat-layout`` is more dangerous in terms of accidentally including 165 extra files/directories, this function is more conservative and will raise an 166 error if multiple packages or modules are found. 167 168 This assumes that multi-package dists are uncommon and refuse to support that 169 use case in order to be able to prevent unintended errors. 170 z$`flat-layout` detected -- analysing )r r� r� �_analyse_flat_packages�_analyse_flat_modulesr� r r r r� � s 171 z$ConfigDiscovery._analyse_flat_layoutc C sH t �| j�| j_tt| jj��}t�d| jj� �� | � |d� t 172 |�S )Nr� r� ) r_ r+ r� rt r� �remove_nested_packages� remove_stubsr r� � _ensure_no_accidental_inclusionrV )r� � top_levelr r r r� � s 173 z&ConfigDiscovery._analyse_flat_packagesc C s@ t �| j�| j_t�d| jj� �� | �| jjd� t| jj�S )Nr� �modules) r� r+ r� rt r� r r� r� rV 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�. 174 175 To avoid accidental inclusion of unwanted files or directories, 176 setuptools will not proceed with this build. 177 178 If you are trying to create a single distribution with multiple a� 179 on purpose, you should not rely on automatic discovery. 180 Instead, consider the following options: 181 182 1. set up custom discovery (`find` directive with `include` or `exclude`) 183 2. use a `src-layout` 184 3. explicitly set `py_modules` or `packages` with a list of names 185 186 To find more information, look for "package discovery" on setuptools docs. 187 )�len�inspectr� �setuptools.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. 188 Therefore the name of the distribution can be derived from them. 189 Nz7No `name` configuration, performing automatic discovery)rt �metadatar2 r r� �#_find_name_single_package_or_module�_find_name_from_packages)r� r2 r r r r� � s 190 ��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 )�getattrrt 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� 191 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`) rt r� r� �sortedr� r� �find_parent_packager� r r� �warn)r� r� r� � 192 parent_pkgr r r r� � s 193 z(ConfigDiscovery._find_name_from_packagesN)r� r )FTF) r7 r8 r9 r: r� r� r� �propertyr= r� r r' r� r� rV r� r� r� r� r� r� r� r r� r� r r� r� r r r r r� s* 194 195 196 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. 197 198 >>> remove_nested_packages(["a", "a.b1", "a.b2", "a.b1.c1"]) 199 ['a'] 200 >>> remove_nested_packages(["a", "b", "c.d", "c.d.e.f", "g.h", "a.a1"]) 201 ['a', 'b', 'c.d', 'g.h'] 202 r� Nc 3 s � | ] }� � |� d ��V qdS �r N�� 203 startswith)r/ �otherr1 r r r3 � � z)remove_nested_packages.<locals>.<genexpr>r� )r� r� � enumerate�reversedr4 r� )r� r� r� �size�ir r1 r r� s �r� c C s dd� | D �S )z�Remove type stubs (:pep:`561`) from a list of packages. 204 205 >>> remove_stubs(["a", "a.b", "a-stubs", "a-stubs.b.c", "b", "c-stubs"]) 206 ['a', 'a.b', 'b'] 207 c S s$ g | ]}|� d �d �d�s|�qS )r r r� )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� r1 r r r3 " r� z&find_parent_package.<locals>.<genexpr>r� NrT ) 208 r� r� r� r� rJ �find_package_pathr r rE rU )r� r� r� �common_ancestorsr� �pkg_path�initr r1 r r� s " �r� r2 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 209 disk, considering the ``package_dir`` option. 210 211 >>> path = find_package_path("my.pkg", {"": "root/is/nested"}, ".") 212 >>> path.replace(os.sep, "/") 213 './root/is/nested/my/pkg' 214 215 >>> path = find_package_path("my.pkg", {"my": "root/is/nested"}, ".") 216 >>> path.replace(os.sep, "/") 217 './root/is/nested/pkg' 218 219 >>> path = find_package_path("my.pkg", {"my.pkg": "root/is/nested"}, ".") 220 >>> path.replace(os.sep, "/") 221 './root/is/nested' 222 223 >>> path = find_package_path("other.pkg", {"my.pkg": "root/is/nested"}, ".") 224 >>> path.replace(os.sep, "/") 225 './other/pkg' 226 r r �����Nr� �/)r� �ranger� rE r r r� )r2 r� r� �partsr� � partial_name�parentr r r r� 3 s 227 "� r� � package_pathc s$ t | �}t|�j� � fdd�|D �S )Nc s& i | ]}|d � g � �|�d����qS )r� r )rE r� r� ��prefixr r � 228 <dictcomp>X s & z)construct_package_dir.<locals>.<dictcomp>)r� r r� )r� r� � parent_pkgsr r� r �construct_package_dirU s 229 r )2r: � itertoolsr �fnmatchr r �pathlibr �typingr r r r r 230 r r r r r �_distutils_hack.override�_distutils_hack� distutilsr �distutils.utilr r' �PathLiker= rV r> r? �chain� from_iterabler� � 231 setuptoolsr r r rA rW rY r_ r� r� r� r� r� r� r� r r r r r �<module> s^ ' 0 6)2 b � 232 �� 233 �� 234 �� 235 �&"