_iR p d Z ddlZddlZddlmZ ddlmZ ddlmZ ddlm Z m
Z
m Z m Z m
Z
mZmZmZmZ ddlZddlmZ ddlmZ eeej2 f Ze e Zej8 j: Z e rdd l m Z d
ed e!fd Z" G d
d 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)ded ed e
e fd Z* G d d Z+d e
e d e
e fd!Z,d e
e d e
e fd"Z-d e
e d#eeef d$ed ee fd%Z.d&ed#eeef d$ed efd'Z/d e
e d(ed e
eef fd)Z0y)*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_CHECKINGDictIterableIteratorListMappingOptionalTupleUnion)log) convert_path) Distributionpathreturnc \ t j j | j S N)osr basename isidentifier)r s /builddir/build/BUILDROOT/alt-python312-setuptools-69.0.2-3.el8.x86_64/opt/alt/python312/lib/python3.12/site-packages/setuptools/discovery.py _valid_namer G s
77 D ! . . 00 c < e Zd ZdZdefdZdedefdZdedefdZy) _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 8 t j | | _ y r )dictfromkeys _patterns)selfr s r __init__z_Filter.__init__R s x0r itemr c @ t fd| j D S )Nc 3 6 K | ] }t | y wr r ).0patr& s r z#_Filter.__call__..V s D^c;tS)^s )anyr# r$ r& s `r __call__z_Filter.__call__U s DT^^DDDr c || j v S r )r# r- s r __contains__z_Filter.__contains__X s t~~%%r N) __name__
__module__ __qualname____doc__strr% boolr. r0 r r r r L s<
1# 1ES ET E& & &r r c e Zd ZU dZdZeedf ed< dZeedf ed< e d
de
de e de e d e e fd
Z
e de
deded efd Zy )_Finderz@Base class that exposes functionality for module/package findersr7 .ALWAYS_EXCLUDEDEFAULT_EXCLUDEwhereexcludeincluder c |xs | j }t | j t t | t g | j | 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'.
)r; list
_find_iterr r5 r r: clsr< r= r> s r findz _Finder.findb sW 4 0S 0 0 NN SZ(6++6g6!
r c t r )NotImplementedErrorrB s r rA z_Finder._find_iter s !!r N).r7 )*)r1 r2 r3 r4 r: r r5 __annotations__r; classmethod_Pathr r rD r StrIterrA r7 r r r9 r9 \ s J&(NE#s(O(')OU38_) !#!'
#
#
c
D "u "w " "W " "r r9 c T e Zd ZdZdZededededefd Z e
ded e de fd
Z
y )
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 j || } t j j | | }
|
j
t j j d } d|v s| j | | s || r || s| | d|v s| d|v r|j | yw)zy
All the packages found in 'where' that pass the 'include' filter, but
not the 'exclude' filter.
T) followlinksNrG rH .*)
r walkr5 r joinrelpathreplacesep_looks_like_packageappend) rC r< r= r> rootdirsfilesall_dirsdir full_pathrel_pathpackages r rA zPackageFinder._find_iter s "$U!F D$AwHDG GGLLs 3 77??9e<"**277;;< #:S%<% A% A A A Ar rN c * e Zd Zedededefd Zy)PEP420PackageFinder_pathrb r c y)NTr7 )ri rb s r rX z'PEP420PackageFinder._looks_like_package s r N)r1 r2 r3 rf rK r5 r6 rX r7 r r rh rh s) 5 r rh c B e Zd ZdZededededefd Z e e
Z y) ModuleFinderzYFind isolated Python modules.
This function will **not** recurse subdirectories.
r< r= r> r c # 6 K t t j j |d D ]i }t j j t j j | \ }}| j
| sT || s] || rf| k y w)Nz*.py)r r r rT splitextr _looks_like_module)rC r< r= r> filemodule_exts r rA zModuleFinder._find_iter sn eV45D 77++BGG,<, s &GhaS8}hs ri package_namer c |j d }|d j xs |d j d }|xr t d |dd D S )NrG r -stubsc 3 < K | ] }|j y wr )r )r) names r r+ z>FlatLayoutPackageFinder._looks_like_package.. s (S):):)<s )splitr endswithall)ri r namesroot_pkg_is_valids r rX z+FlatLayoutPackageFinder._looks_like_package sU ""3' !!H 1 1 3 RuQx7H7H7R SS(Sqr(S%SSr N) r1 r2 r3 _EXCLUDEtuple
chain_iterr; rf rK r5 r6 rX r7 r r rt rt sP 'HR J&Gh&G GHO T5 T T T Tr rt c e Zd ZdZy)FlatLayoutModuleFinder)setupconftestr r r r r toxfilenoxfilepavementdodor r z[Ss][Cc]onstruct conanfilemanager r r r r N)r1 r2 r3 r; r7 r r r r s O4 *r r root_pkgpkg_dirc t j | }| g|D cg c] }dj | |f c}z S c c}w )NrG )rh rD rT )r r nestedns r _find_packages_withinr ' s>
%
%g
.F :&A&Q8Q-0&A AAAs ;c e Zd ZdZddZd Zd Zedefd Z ede
e e f fd Z ddZ
d edefd
Zd edefd Zdefd Zdefd
ZdefdZdefdZdefdZdee de fdZd Zdee fdZdee fdZy)ConfigDiscoveryzFill-in metadata and options that can be automatically derived
(from other metadata/options, the file system or conventions)
c < || _ d| _ d| _ d| _ y )NF)r _called _disabled_skip_ext_modules)r$ distributions r r% zConfigDiscovery.__init__1 s !& r c d| _ y)z+Internal API to disable automatic discoveryTN)r r$ s r _disablezConfigDiscovery._disable7 s r c d| _ y)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 R | j j xs t j S r )r src_rootr curdirr s r _root_dirzConfigDiscovery._root_dirG s yy!!.RYY.r c ^ | j j i S | j j S r )r package_dirr s r _package_dirz ConfigDiscovery._package_dirL s' 99 (Iyy$$$r c |du r| j s | j ry| j | |r| j d| _ y)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$ forcer ignore_ext_moduless r r. zConfigDiscovery.__call__R s? E>t||t~~ $$%78 r r c ( |xs | j }| j j du xs | }| j j duxsL | j j duxs2 |xs. t | j d xr | 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_specifiedg s / I43I3I 9900D8N. s3
#6Z
"#rww||Hj'I J#6s 7:discovered packages -- T) r copypopr r r r itemsr@ r r )r$ r pkgsr s @r r z(ConfigDiscovery._analyse_explicit_layout s '',,. D!>> <[MJK
#.#4#4#6
"$Z +DII,>,>+?@Ar c | j }t j j | j |j dd }t j j
| syt j d| |j dt j j | || j _ t j | | j _ t j | | j _ t j d| j j t j d| j j" y)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 rT r getisdirr r
setdefaultr r r rh rD r rl r )r$ r src_dirs r r z#ConfigDiscovery._analyse_src_layout s '' '',,t~~{r5/IJww}}W% 7yAB r277#3#3G#<= + 0 5 5g > + 0 0 9 +DII,>,>+?@A -dii.B.B-CDEr c t j d| j | j xs | j 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 s: 8 8HIJ**,L0J0J0LLr c @ t j | j | j _ t t
| j j }t j d| j j | j |d t | S )Nr r ) rt rD r r r remove_nested_packages remove_stubsr r _ensure_no_accidental_inclusionr6 )r$ top_levels r r z&ConfigDiscovery._analyse_flat_packages so 4 9 9$.. I *< 8J8J+KL +DII,>,>+?@A ,,Y
CI r c @ t j | j | j _ t j d| j j | j | j j d t | j j S )Nr modules) r rD r r r r r r r6 r s r r z%ConfigDiscovery._analyse_flat_modules sk 5 : :4>> J -dii.B.B-CDE ,,TYY-A-A9MDII(())r detectedkindc l t | dkD r&ddlm} ddlm} d| d| d| d} | || y ) 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 sU x=1 ( ?)$/MhZ XM
NRF S
C (
6 6) r c | j j j s| j j ryt j d | j xs | j
}|r || j j _ yy)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 metadatar r r #_find_name_single_package_or_module_find_name_from_packages)r$ r s r r z ConfigDiscovery.analyse_name sq 99 " "diinn KL
4 4 6
/,,.
&*DII # r c dD ]P }t | j |d xs g }|s!t | dk( s0t j d|d |d c S y)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 sV /EDIIud39rEUq B58*MN Qx 0 r c R | j j syt t | j j t }| j j
xs i }t
||| j }|rt j d| |S t j d y)zzlK L JKr N)r r )FTF) r1 r2 r3 r4 r% r r propertyrK r r r5 r r. r6 r r r r r r r r r r r
r r r7 r r r r , s '
& /5 / / %d38n % %
*
$
4
$$ $T 2 Md M *t * 7S 7 7.+"Xc] (3- r r r c t | t }|dd }t | }t t | D ]1 \ }t fd|D s|j ||z
dz
3 |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 F K | ] }j | d ywrG N
startswith)r) otherr s r r+ z)remove_nested_packages.. s! Ct%{+ !r )r r enumeratereversedr, r )r r r sizeir s @r r r sd ( $DQI t9D Xd^,4 CC C MM$(Q, ' - r c t | D cg c]( }|j d d j d r'|* c}S c c}w )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']
rG r r )r r )r r s r r r s6 $ P8C399S>!+<+E+Eh+OC8 PP Ps (55r r c Z t | t } g }t | D ]2 \ }t fd| |dz d D s n|j 4 |D ]R t || }t j j |d }t j j | sPc S y)z0Find the parent package that is not a namespace.r c 3 F K | ] }|j d ywr r )r) r r s r r+ z&find_parent_package..0 s# G5F1<<4&
+5Fr r Nrd )
r r r r rY find_package_pathr r rT re )r r r common_ancestorsr pkg_pathinitr s @r r r ) s hC(H X&4GXa!eg5FGG
% ' !$T;Aww||Hm4
77>>$ K ! r r c l | j d }t t | dd D ]E }dj |d| }||v s || }t j
j ||g||d c S |j
d xs d}t j
j |g|j d | 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'
rG r Nr /)r ranger rT r r r )r r r partsr partial_nameparents r r r A s ,
JJsOE
3u:q"
%xxbq * ; & .F77<<&=59= = & __R
&BF
77<< =6<<#4 =u ==r package_pathc
t | }t | j }|D ci c]' }|dj g ||j d ) c}S c c}w )Nr$ rG )r r r& rT r )r r) parent_pkgsprefixr s r construct_package_dirr- c sU (2K
,
%
%FAL M#C4F4SYYs^45 5 MM Ms ,A)1r4 itertoolsr fnmatchr r pathlibr typingr r r r
r r r
r r _distutils_hack.override_distutils_hack distutilsr distutils.utilr r5 PathLikerK rL chain
from_iterabler
setuptoolsr r6 r r r9 rN rh rl rt r r r r r r r r- r7 r r r: s %N
'
c2;;
3-
__
*
*
'1e 1 1
&
& +" +"\*AG *AZ- 37 3.2T 1 2Tj*\ *<BC B% BDI B
_ _DT#Y 49 $Q49 Qc Q3i&-c3h&7CH
c]0 >
> #CH - >9> > >DNDI NU NtCQTH~ Nr