JM d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlm Z m
Z
m Z m Z m
Z
mZmZmZmZmZ ddlZddlmZ ddlmZ eeej f Ze
ege f Z e
e Z ej j Z!e rdd l"m#Z# d
ed e fd Z$ G d
d Z% G d de% Z& G d de& Z' G d de% Z( G d de' Z) G d de( Z*deded ee fdZ+ G d d Z,d ee d ee fd Z-d ee d ee fd Z.d ee d!eeef d"ed ee fd#Z/d$ed!eeef d"ed efd%Z0d ee d&ed e eef fd'Z1dS )(u_ 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_CHECKINGCallableDictIterableIteratorListMappingOptionalTupleUnion)log) convert_path) Distributionpathreturnc d t j | S N)osr basename isidentifier)r s /builddir/build/BUILDROOT/alt-python311-setuptools-65.6.3-2.el9.x86_64/opt/alt/python311/lib/python3.11/site-packages/setuptools/discovery.py _valid_namer I s$
7 D ! ! . . 0 00 c e Zd ZU dZdZeedf ed< dZeedf ed< e dde
d e e d
e e d e e fd Z
e de
d ed
ed efd
Zeded efd ZdS )_Finderz@Base class that exposes functionality for module/package finders .ALWAYS_EXCLUDEDEFAULT_EXCLUDE.*whereexcludeincluder c |p| j }t | t t | | j g | j |R | j | 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'.
)r" list
_find_iterr str
_build_filterr! clsr& r' r( s r findz _Finder.findT sp 4 0S 0 NN SZZ((!!@3#5@@@@!!7+
r c t r )NotImplementedErrorr. s r r+ z_Finder._find_iterw s !!r patternsc fdS )z
Given a list of patterns, return a callable that will be true only if
the input matches at least one of the patterns.
c < t fdD S )Nc 3 8 K | ]}t | V d S r r ).0patnames r z:_Finder._build_filter.... s- K K3 D# 6 6 K K K K K Kr )any)r9 r3 s `r z'_Finder._build_filter.. s% C K K K K( K K K K K r r )r3 s `r r- z_Finder._build_filter{ s LKKKKr N)r# r r$ )__name__
__module__ __qualname____doc__r! r r, __annotations__r" classmethod_Pathr
r r0 _FilterStrIterr+ staticmethodr- r r r r r N s JJ&(NE#s(O(((')OU38_))) !#!'
#
#
c
[
D "u "w " "W " " " [" L L L L L \L L Lr r c b e Zd ZdZdZededededefd Z e
ded e de fd
Z
d S )
PackageFinderzI
Generate a list of all Python packages found within a directory
)ez_setupz *__pycache__r& r' r( r c # K t j t | d D ]\ }}}|dd }g |dd< |D ]}t j || } t j | | }
|
t j j d } d|v s| | | s || r || s| V | | dS )zy
All the packages found in 'where' that pass the 'include' filter, but
not the 'exclude' filter.
T) followlinksNr# )
r walkr, r joinrelpathreplacesep_looks_like_packageappend) r/ r& r' r( rootdirsfilesall_dirsdir full_pathrel_pathpackages r r+ zPackageFinder._find_iter s "$U!F!F!F ! ! D$AAAwHDG
!
! GLLs 3 3 7??9e<<"**27;<< #::S%<% r? r@ r! rB rC rD rE r+ rF r, boolrQ r r r rH rH s 2N!u !w ! !W ! ! ! [!6 A% A A A A A \A A Ar rH c 2 e Zd Zedededefd ZdS )PEP420PackageFinder_pathr[ r c dS )NTr )rb r[ s r rQ z'PEP420PackageFinder._looks_like_package s tr N)r= r> r? rF rC r, r_ rQ r r r ra ra sG 5 \ r ra c P e Zd ZdZededededefd Z e e
Z dS ) ModuleFinderzYFind isolated Python modules.
This function will **not** recurse subdirectories.
r& r' r( r c # H K t t j |d D ]q}t j t j | \ }}| | sW || r || s|V rd S )Nz*.py)r r r rM splitextr _looks_like_module)r/ r& r' r( filemodule_exts r r+ zModuleFinder._find_iter s eV4455 D 7++BG,<, r? r@ rB rC rD rE r+ rF r rh r r r re re sh u w W [ & k22r re c t e Zd ZdZ e ed eD Z edede de
fd Z dS )FlatLayoutPackageFinder) cibindocdocs
documentationmanpagesnews changelogtesttests unit_test
unit_testsexampleexamplesscriptstoolsutilutilspythonbuilddistvenvenv requirementstasksfabfile
site_scons benchmark
benchmarksexercise exercises[._]*c # $ K | ] }|| d fV dS )z.*Nr )r7 ps r r: z!FlatLayoutPackageFinder. s, &G&Ga888}&G&G&G&G&G&Gr rb package_namer c | d }|d p|d d }|o t d |dd D S )Nr# r -stubsc 3 > K | ]}| V d S r )r )r7 r9 s r r: z>FlatLayoutPackageFinder._looks_like_package.. s. (S(S):):)<)<(S(S(S(S(S(Sr )splitr endswithall)rb r namesroot_pkg_is_valids r rQ z+FlatLayoutPackageFinder._looks_like_package sl ""3'' !!H 1 1 3 3 RuQx7H7H7R7R SS(S(Sqrr(S(S(S%S%SSr N) r= r> r? _EXCLUDEtuple
chain_iterr" rF rC r, r_ rQ r r r rm rm s $HL eJJ&G&Gh&G&G&G G GHHO T5 T T T T T \T T Tr rm c e Zd ZdZdS )FlatLayoutModuleFinder)setupconftestrv rw rz r{ r toxfilenoxfilepavementdodor r z[Ss][Cc]onstruct conanfilemanager r r r r N)r= r> r? r" r r r r r s O4 *)r r root_pkgpkg_dirc \ t | } g fd|D z S )Nc > g | ]}d |f S )r# )rM )r7 nr s r
z)_find_packages_within.. s) AAAQ8Q-00AAAr )ra r0 )r r nesteds ` r _find_packages_withinr s8
%
%g
.
.F :AAAA&AAA AAr c $ e Zd ZdZd dZd Zd Zedefd Z ede
e e f fd Z d d Z
d
edefdZd
edefdZdefdZdefdZdefdZdefdZdefdZdee de fdZd Zdee fdZdee fdZdS ) ConfigDiscoveryzFill-in metadata and options that can be automatically derived
(from other metadata/options, the file system or conventions)
distributionr c > || _ d| _ d| _ d| _ d S )NF)r _called _disabled_skip_ext_modules)selfr s r __init__zConfigDiscovery.__init__$ s% !& r c d| _ dS )z+Internal API to disable automatic discoveryTN)r r s r _disablezConfigDiscovery._disable* s
r c d| _ dS )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 s r _ignore_ext_modulesz#ConfigDiscovery._ignore_ext_modules. s "& r r c 2 | j j p t j S r )r src_rootr curdirr s r _root_dirzConfigDiscovery._root_dir: s y!.RY.r c 6 | j j i S | j j S r )r package_dirr s r _package_dirz ConfigDiscovery._package_dir? s 9 (Iy$$r FTc |du r| j s| j rdS | | |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 forcer9 ignore_ext_moduless r __call__zConfigDiscovery.__call__E sX E>>t|>t~> F $$%7888 r r c |p| j }| j j du p| }| j j dup0| j j dup"|p t | j d o | j j S )zF``True`` if the user has specified some form of package/module listingN
configuration)r r ext_modulespackages
py_moduleshasattrr )r r r s r _explicitly_specifiedz%ConfigDiscovery._explicitly_specifiedZ sw / I43I 90D8N. sU
Z
"#rw||Hj'I'I J J
r discovered packages -- T) r copypopr r r r itemsr* r r )r r pkgsr s @r r z(ConfigDiscovery._analyse_explicit_layoutx s ',,.. D!!!> 5 J[JJKKK
#.#4#4#6#6
"$ZZ @DI,>@@AAAtr c | j }t j | j | dd }t j | sdS t j d| | dt j
| || j _ t | | j _ t | | j _ t j d| j j t j 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 rM r getisdirr r
setdefaultr r r ra r0 r re r )r r src_dirs r r z#ConfigDiscovery._analyse_src_layout s ' ',,t~{r5/I/IJJw}}W%% 5 AAABBB r27#3#3G#<#<=== + 0 5 5g > > + 0 0 9 9 @DI,>@@AAA Ddi.BDDEEEtr c t j 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 s r r z$ConfigDiscovery._analyse_flat_layout sB I IIJJJ**,,L0J0J0L0LLr c , t | j | j _ t t
| j j }t j d| j j | |d t | S )Nr r ) rm r0 r r r remove_nested_packages remove_stubsr r _ensure_no_accidental_inclusionr_ )r top_levels r r z&ConfigDiscovery._analyse_flat_packages sv 4 9 9$. I I *< 8J+K+KLL @DI,>@@AAA ,,Y
CCCI r c t | j | j _ t j d| j j | | j j d t | j j S )Nr modules) r r0 r r r r r r r_ r s r r z%ConfigDiscovery._analyse_flat_modules sh 5 : :4> J J Ddi.BDDEEE ,,TY-A9MMMDI()))r detectedkindc t | dk r,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.
)leninspectr setuptools.errorsr )r r r r r msgs r r z/ConfigDiscovery._ensure_no_accidental_inclusion s x==1 ( ( ( ( ( ( ? ? ? ? ? ?$ h
NR C ('
66 6) r c | j j j s | j j rdS t j d | p| }|r|| j j _ dS dS )zThe 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)r metadatar9 r r #_find_name_single_package_or_module_find_name_from_packages)r r9 s r r z ConfigDiscovery.analyse_name s 9 " din 4 KLLL
4 4 6 6
/,,..
+&*DI # # # + +r c dD ]V}t | j |d pg }|r:t | dk r't j d|d |d c S WdS )z Exactly one module or package)r r Nr z&Single module/package detected, name: r )getattrr r r r )r fieldr s r r z3ConfigDiscovery._find_name_single_package_or_module so / EDIud339rE
Uq M58MMNNN Qxtr c " | j j sdS t t | j j t }| j j pi }t
||| j }|rt j d| |S t j
d dS )z r? r@ r r r propertyrC r r r, r r r_ r r r r r r r r r r r r r r r r r r s ' ' ' '
&
&
& /5 / / / X/ %d38n % % % X%
*
$
4
$$ $T 2 Md M M M M *t * * * * 7S 7 7 7 7 7.+ + +"Xc] (3- r r r c t | t }|dd }t | }t t | D ];\ }t fd|D r| ||z
dz
<|S )zRemove 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 H K | ] } | d V dS r# N
startswith)r7 otherr9 s r r: z)remove_nested_packages.. s5 CCt%{{{++CCCCCCr r )r r enumeratereversedr; r )r r r sizeir9 s @r r r s ( $ $ $DQQQI t99D Xd^^,, ( (4 CCCCCCC C C ( MM$(Q, ' ' ' r c d | D S )zRemove 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 n g | ]2}| d d d 0|3S )r# r r )r r )r7 r s r r z remove_stubs.. s: P P PC399S>>!+<+E+Eh+O+O PC P P Pr r )r s r r r s Q P8 P P PPr r r c t | t } g }t | D ]B\ }t fd| |dz d D s n| C|D ]Vt || }t j |d }t j | rc S WdS )z0Find the parent package that is not a namespace.r c 3 H K | ] }| d V dS r r
)r7 r r9 s r r: z&find_parent_package.." s5 DD1<<4
++DDDDDDr r Nr] )
r r r r rR find_package_pathr r rM r^ )r r r common_ancestorsr pkg_pathinitr9 s @r r r s hC(((H X&& & &4DDDDXacdd^DDDDD
E %%%% $T;AAw||Hm44
7>>$ KKK 4r r9 c | d }t t | dd D ]M}d |d| }||v r*|| }t j j ||g||d R c S N| d pd}t j j |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'
r# r Nr /)r ranger rM r r r )r9 r r partsr partial_nameparents r r r 3 s ,
JJsOOE
3u::q"
%
% > >xxbqb ** ; & & .F7<&=59=== = = = ' __R
&BF
7< =6<<#4#4 =u = = ==r package_pathc f t | }t | j fd|D S )Nc j i | ]/}|d g | d 0S )r r# )rM r )r7 r prefixs r
z)construct_package_dir..X s< M M M#C4F4SYYs^^455 M M Mr )r r r )r r# parent_pkgsr& s @r construct_package_dirr) U s: (22K
,
%F M M M M M M MMr )2r@ itertoolsr fnmatchr r pathlibr typingr r r r
r r r
r r r _distutils_hack.override_distutils_hack distutilsr distutils.utilr r, PathLikerC r_ rD rE chain
from_iterabler
setuptoolsr r r rH ra re rm r r r r r r r r) r r r r6 s % %N ' ' ' ' ' '
c2;
C5$;
3-
_
*
(''''''1e 1 1 1 1 1
3L 3L 3L 3L 3L 3L 3L 3Ll&A &A &A &A &AG &A &A &AR - 3 3 3 3 37 3 3 3./T /T /T /T /T 1 /T /T /Td* * * * *\ * * *<BC B% BDI B B B B
^ ^ ^ ^ ^ ^ ^ ^BT#Y 49 $Q49 Qc Q Q Q Q3i&-c3h&7CH
c] 0 >
> #CH - >9> > > > > >DNDI NU NtCQTH~ N N N N N Nr