a0biR S r SSKrSSKrSSKJr SSKJr SSKJr SSKJ r J
r
J r J r J
r
JrJrJrJr SSKrSSKJr SSKJr \\\R2 4 r\ \ r\R8 R: r \ ( a SS K J r S
\S \!4S jr" " S
S5 r# " S S5 r$ " S S\$5 r% " S S\%5 r& " S S\$5 r' " S S\&5 r( " S S\'5 r)S\S \S \
\ 4S jr* " S S 5 r+S \
\ S \
\ 4S! jr,S \
\ S \
\ 4S" jr-S \
\ S#\\\4 S$\S \\ 4S% jr.S&\S#\\\4 S$\S \4S' jr/S \
\ S(\S \
\\4 4S) jr0g)*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 \ [ R R U 5 R 5 $ N)osr basename isidentifier)r s ڍ/builddir/build/BUILDROOT/alt-python313-setuptools-69.0.2-3.el8.x86_64/opt/alt/python313/lib/python3.13/site-packages/setuptools/discovery.py _valid_namer G s
77 D ! . . 00 c J \ rS rSrSrS\4S jrS\S\4S jrS\S\4S jr S r
g
) _FilterL zw
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 [ R U5 U l g r )dictfromkeys _patterns)selfr s r __init___Filter.__init__R s x0r itemr c B ^ [ U4S jU R 5 5 $ )Nc 3 < ># U H n[ TU5 v M g 7fr r ).0patr( s r #_Filter.__call__..V s D^c;tS))^s )anyr$ r% r( s `r __call___Filter.__call__U s DT^^DDDr c XR ; $ r r$ r0 s r __contains___Filter.__contains__X s ~~%%r r4 N) __name__
__module__ __qualname____firstlineno____doc__strr& boolr1 r5 __static_attributes__ r r r r L s<
1# 1ES ET E& & &r r c \ rS rSr% SrSr\\S4 \S' Sr \\S4 \S' \
SS\ S\ \ S \ \ S
\
\ 4S jj5 r\
S\ S\S \S
\4S j5 rSrg
)_Finder\ z@Base class that exposes functionality for module/package findersr? .ALWAYS_EXCLUDEDEFAULT_EXCLUDEwhereexcludeincluder c U=( d U R n[ U R [ [ U5 5 [ / U R QUQ76 [ U6 5 5 $ )a 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'.
)rD list
_find_iterr r< r rC clsrE rF rG s r find _Finder.findb sW 4 0S 0 0 NN SZ(6++6g6!
r c [ er )NotImplementedErrorrK s r rJ _Finder._find_iter s !!r N).r? )*)r7 r8 r9 r: r; rC r r< __annotations__rD classmethod_Pathr r rM r StrIterrJ r> r? r r rA rA \ s J&(NE#s(O(')OU38_) !#!'
#
#
c
D "u "w " "W " "r rA c ` \ rS rSrSrSr\S\S\S\S\ 4S j5 r
\ S \S
\ S\
4S j5 rS rg
)
PackageFinder zA
Generate a list of all Python packages found within a directory
)ez_setupz *__pycache__rE rF rG r c # # [ R " [ U5 SS9 H u pEnUSS n/ USS& U H n[ R R XH5 n [ R R X5 n
U
R
[ R R S5 n SU; d U R X5 ( d M U" U 5 ( a U" U 5 ( d U v U S3U; d U S3U; a M UR U5 M M g7f)za
All the packages found in 'where' that pass the 'include' filter, but
not the 'exclude' filter.
T) followlinksNrR rS .*)
r walkr< r joinrelpathreplacesep_looks_like_packageappend) rL rE rF rG rootdirsfilesall_dirsdir full_pathrel_pathpackages r rJ PackageFinder._find_iter s "$U!F DAwHDG GGLL 3 77??9<"**277;;< #:S%<% r? r r rY rY sj 2N !u !w ! !W ! !> A% A A A Ar rY c 4 \ rS rSr\S\S\S\4S j5 rSr g)PEP420PackageFinder _pathro r c g)NTr? )rx ro s r rd 'PEP420PackageFinder._looks_like_package s r r? N)
r7 r8 r9 r: rt rV r< r= rd r> r? r r rv rv s) 5 r rv c L \ rS rSrSr\S\S\S\S\4S j5 r \
" \ 5 r Sr
g )
ModuleFinder zQFind isolated Python modules.
This function will **not** recurse subdirectories.
rE rF rG r c # \ # [ [ R R US5 5 H{ n[ R R [ R R U5 5 u pVU R
U5 ( d MY U" U5 ( d Mh U" U5 ( a Mw Uv M} g 7f)Nz*.py)r r r r` splitextr _looks_like_module)rL rE rF rG filemodule_exts r rJ ModuleFinder._find_iter sr eV45D 77++BGG,<, r? r r r| r| sD u w W &k2r r| c d \ rS rSrSr\" \" S \ 5 5 5 r \S\ S\
S\ 4S j5 r Sr
g )
FlatLayoutPackageFinder )#cibindebiandocdocs
documentationmanpagesnews
newsfragments changelogtesttests unit_test
unit_testsexampleexamplesscriptstoolsutilutilspythonbuilddistvenvenv requirementstasksfabfile
site_scons benchmark
benchmarksexercise exerciseshtmlcov[._]*c # . # U H oU S 34v M
g7f)r^ Nr? )r+ ps r r- !FlatLayoutPackageFinder. s &GhaS8}hs rx package_namer c UR S5 nUS R 5 =( d US R S5 nU=( a [ S USS 5 5 $ )NrR r -stubsc 3 @ # U H oR 5 v M g 7fr )r )r+ names r r- >FlatLayoutPackageFinder._looks_like_package.. s (S):):)<)<s )splitr endswithall)rx r namesroot_pkg_is_valids r rd +FlatLayoutPackageFinder._looks_like_package sU ""3' !!H 1 1 3 RuQx7H7H7R SS(Sqr(S%SSr r? N)r7 r8 r9 r: _EXCLUDEtuple
chain_iterrD rt rV r< r= rd r> r? r r r r sP 'HR J&Gh&G GHO T5 T T T Tr r c \ rS rSrSrSrg)FlatLayoutModuleFinderi )setupconftestr r r r r toxfilenoxfilepavementdodor r z[Ss][Cc]onstruct conanfilemanager r r r r r? N)r7 r8 r9 r: rD r> r? r r r r s O4 *r r root_pkgpkg_dirc [ R U5 nU /U Vs/ s H nSR X45 PM sn- $ s snf )NrR )rv rM r` )r r nestedns r _find_packages_withinr ' s<
%
%g
.F :&A&Q8-0&A AAAs =c " \ rS rSrSrSS jrS rS r\S\ 4S j5 r
\S\ \ \ 4 4S j5 r
SS jrS
\S\4S jrS
\S\4S jrS\4S
jrS\4S jrS\4S jrS\4S jrS\4S jrS\\ S\ 4S jrS rS\\ 4S jrS\\ 4S jr Sr g) ConfigDiscoveryi, z}Fill-in metadata and options that can be automatically derived
(from other metadata/options, the file system or conventions)
c : Xl SU l SU l SU l g )NF)r _called _disabled_skip_ext_modules)r% distributions r r& ConfigDiscovery.__init__1 s !& r c SU l g)z+Internal API to disable automatic discoveryTN)r r% s r _disableConfigDiscovery._disable7 s r c SU l g)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_modules#ConfigDiscovery._ignore_ext_modules; s "& r r c \ U R R =( d [ R $ r )r src_rootr curdirr s r _root_dirConfigDiscovery._root_dirG s yy!!.RYY.r c ` U R R c 0 $ U R R $ r )r package_dirr s r _package_dir ConfigDiscovery._package_dirL s' 99 (Iyy$$$r c USL a# U R ( d U R ( a gU R U5 U( a U R 5 SU l g)ay 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 r1 ConfigDiscovery.__call__R s? E>t||t~~ $$%78 r r c l U=( d U R nU R R SL =( d U( + nU R R SL=( d[ U R R SL=( d< U=( d3 [ U R S5 =( a U R R $ )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_specified%ConfigDiscovery._explicitly_specifiedg s / I43I3I 9900D8N# U H1 u p[ U[ R R TU5 5 v M3 g 7fr )r r r r` )r+ pkg
parent_dirroot_dirs r r- ;ConfigDiscovery._analyse_explicit_layout.. s3
#6
"#rww||Hj'I J J#6s 9<discovered packages -- T) r copypopr r r r itemsrI r r )r% r pkgsr s @r r (ConfigDiscovery._analyse_explicit_layout s '',,. D!>> <[MJK
#.#4#4#6
"$Z +DII,>,>+?@Ar c U R n[ R R U R UR SS5 5 n[ R R
U5 ( d g[ R " SU 35 UR S[ R R U5 5 XR l [ R U5 U R l [ R U5 U R l [ R " SU R R 35 [ R " SU R R" 35 g)av 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 r` r getisdirr r
setdefaultr r r rv rM r r| r )r% r src_dirs r r #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 [ R " SU R 35 U R 5 =( d U R 5 $ )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 $ConfigDiscovery._analyse_flat_layout s: 8 8HIJ**,L0J0J0LLr c B [ R U R 5 U R l [ [
U R R 5 5 n[ R " SU R R 35 U R US5 [ U5 $ )Nr r ) r rM r r r remove_nested_packages remove_stubsr r _ensure_no_accidental_inclusionr= )r% top_levels r r &ConfigDiscovery._analyse_flat_packages so 4 9 9$.. I *< 8J8J+KL +DII,>,>+?@A ,,Y
CI r c B [ R U R 5 U R l [
R " SU R R 35 U R U R R S5 [ U R R 5 $ )Nr modules) r rM r r r r r r r= r s r r %ConfigDiscovery._analyse_flat_modules sk 5 : :4>> J -dii.B.B-CDE ,,TYY-A-A9MDII(())r detectedkindc n [ U5 S: a& SSKJn SSKJn SU SU SU S3nU" U" U5 5 eg ) 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 /ConfigDiscovery._ensure_no_accidental_inclusion sU x=1 ( ?)$/MhZ XM
NRF S
C (
6 6) r c D U R R R ( d U R R ( a g[ R " S5 U R 5 =( d U R
5 nU( a XR R l gg)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 ConfigDiscovery.analyse_name so 99 " "diinn KL
4 4 6
/,,.
&*II # r c S H^ n[ U R US5 =( d / nU( d M, [ U5 S:X d M= [ R " SUS 35 US s $ g)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( 3ConfigDiscovery._find_name_single_package_or_module sX /EDIIud39rEuUq B58*MN Qx 0 r c l U R R ( d g[ [ U R R [ S95 nU R R
=( d 0 n[
XU R 5 nU( a [ R " SU 35 U$ [ R " S5 g)zzlK L JKr )r r r r N)r r )FTF) r7 r8 r9 r: r; r& r r propertyrV r r r< r r1 r= r r r r r r r r r r r
r( r) r> r? r r r r , s '
& /5 / / %d38n % %
*
$
4
$$ $T 2 Md M *t * 7S 7 7.+"Xc] (3- r r r c ^ [ U [ S9nUSS n[ U5 n[ [ U5 5 H8 u nm[ U4S jU 5 5 ( d M" UR X4-
S-
5 M: U$ )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']
r0 Nc 3 L ># U H nTR U S 35 v M g7frR N
startswith)r+ otherr s r r- )remove_nested_packages.. s# Ct%{++s !$r )r2 r! enumeratereversedr/ r )r r r sizeir s @r r r se ( $DQI t9D Xd^,4 CC C C MM$(Q, ' - r c U Vs/ s H. oR S5 S R S5 ( a M, UPM0 sn$ s snf )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']
rR r r )r r )r r s r r r s4 $ P8C99S>!+<+E+Eh+OC8 PP Ps +==r r c n ^ [ U [ S9n / n[ U 5 H8 u nm[ U4S jXS- S 5 5 ( d OUR T5 M: U HW m[ TX5 n[ R R US5 n[ R R U5 ( d MU Ts $ g)z0Find the parent package that is not a namespace.r0 c 3 J ># U H oR T S 35 v M g7fr: r; )r+ r r s r r- &find_parent_package..0 s# G5F<<4&
++5Fs #r Nrq )
r2 r! r? r re find_package_pathr r r` rr )r r r common_ancestorsrB pkg_pathinitr s @r r3 r3 ) s hC(H X&4GX!eg5FGGG
% ' !$T;Aww||Hm4
77>>$ K ! r r c z U R S5 n[ [ U5 SS5 HE nSR USU 5 nXQ; d M X n[ R
R " X&/X4S Q76 s $ UR
S5 =( d Sn[ R
R " U/UR S5 QUQ76 $ )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'
rR r Nr /)r ranger! r` r r r
)r r r partsrB partial_nameparents r rG rG A s ,
JJsOE
3u:q"
%xxbq * & .F77<<=59= = & __R
&BF
77<< =6<<#4 =u ==r package_pathc
[ U 5 n[ U5 R nU Vs0 s H' oDSR / UQUR S5 Q5 _M) sn$ s snf )NrM rR )r r rO r` r )r rR parent_pkgsprefixr s r construct_package_dirrV c sS (2K
,
%
%FAL M#4F4SYYs^45 5 MM Ms .A)1r; itertoolsr fnmatchr r pathlibr typingr r r r
r r r
r r _distutils_hack.override_distutils_hack distutilsr distutils.utilr r< PathLikerV rW chain
from_iterabler
setuptoolsr r= r r rA rY rv r| r r r r r r r3 rG rV r? r r rc 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