1j&S d Z ddlmZ ddlZddlZddlmZmZmZ ddl m
Z
ddl m Z ddl m
Z
ddlmZmZ ddlZd d
lmZ dd lmZ dd lmZ erdd
lmZ ej j Z d5dZ G d d Z G d d Z G d de Z! G d de! Z" G d d e Z# G d d e" Z$ G d d e# Z%d6d%Z& G d& d' Z'd7d)Z(d7d*Z)d8d/Z*d9d1Z+d:d4Z,dS );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
) annotationsN)IterableIteratorMapping fnmatchcase)glob)Path)
TYPE_CHECKINGClassVar )StrPath)log) convert_path) Distributionpathr returnboolc d t j | S N)osr basename isidentifier)r s K/opt/cloudlinux/venv/lib64/python3.11/site-packages/setuptools/discovery.py _valid_namer ? s$
7 D ! ! . . 0 00 c * e Zd ZdZd dZd
d Zd
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.
patternsstrr Nonec D t | | _ d S r )dictfromkeys _patterns)selfr s r __init__z_Filter.__init__J s x00r itemr c D t fd| j D S )Nc 3 8 K | ]}t | V d S r r ).0patr( s r z#_Filter.__call__..N s- DDc;tS))DDDDDDr )anyr% r& r( s `r __call__z_Filter.__call__M s( DDDDT^DDDDDDr c || j v S r )r% r/ s r __contains__z_Filter.__contains__P s t~%%r N)r r r r! )r( r r r )__name__
__module__ __qualname____doc__r' r0 r2 r r r r D s^
1 1 1 1E E E E& & & & & &r r c h e Zd ZU dZdZded< dZded< e ddd Zedd Z dS )_Finderz@Base class that exposes functionality for module/package findersr7 zClassVar[tuple[str, ...]]ALWAYS_EXCLUDEDEFAULT_EXCLUDE.*wherer exclude
Iterable[str]includer list[str]c |p| j }t | t t | t g | j |R t | S )aZ 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 r r r: clsr? r@ rB s r findz _Finder.findZ sf 4 0S 0 NN SZZ((6+6g666!
r r
Iterator[str]c t r )NotImplementedErrorrG s r rF z_Finder._find_iter} s
"!r N)r< r7 r= )r? r r@ rA rB rA r rC r? r r@ r rB r r rJ )
r3 r4 r5 r6 r: __annotations__r; classmethodrI rF r7 r r r9 r9 T s JJ02N222213O3333 !#!'
[
D " " " [" " "r r9 c F e Zd ZdZdZedd
Zedd ZdS )
PackageFinderzI
Generate a list of all Python packages found within a directory
)ez_setupz *__pycache__r? r r@ r rB r rJ 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 | d|v s| d|v r| | dS )zy
All the packages found in 'where' that pass the 'include' filter, but
not the 'exclude' filter.
T) followlinksNr< r> .*)
r walkr r joinrelpathreplacesep_looks_like_packageappend) rH r? r@ rB rootdirsfilesall_dirsdir full_pathrel_pathpackages r rF zPackageFinder._find_iter s; "$U!F!F!F ! ! D$AAAwHDG
!
! GLLs 3 3 7??9e<<"**27;<< #::S%<% s, &G&Ga888}&G&G&G&G&G&Gr rl r package_namer r r c | d }|d p|d d }|o t d |dd D S )Nr< r -stubsc 3 > K | ]}| V d S r )r )r+ names r r- z>FlatLayoutPackageFinder._looks_like_package.. s. (S(S):):)<)<(S(S(S(S(S(Sr r
)splitr endswithall)rl r namesroot_pkg_is_valids r r[ z+FlatLayoutPackageFinder._looks_like_package sl ""3'' !!H 1 1 3 3 RuQx7H7H7R7R SS(S(Sqrr(S(S(S%S%SSr N)rl r r r r r ) r3 r4 r5 _EXCLUDEtuple
chain_iterr; ri r[ r7 r r rw rw sm 'HR eJJ&G&Gh&G&G&G G GHHO T T T \T T Tr rw c e Zd ZdZdS )FlatLayoutModuleFinder)setupconftestr r r r r toxfilenoxfilepavementdodor r z[Ss][Cc]onstruct conanfilemanager r r r r N)r3 r4 r5 r; r7 r r r r s O4 *)r r root_pkgr pkg_dirrC c \ t | } g fd|D z S )Nc > g | ]}d |f S )r< )rW )r+ nr s r
z)_find_packages_within..' s) AAAQ8Q-00AAAr )rk rI )r r nesteds ` r _find_packages_withinr % s8
%
%g
.
.F :AAAA&AAA AAr c e Zd ZdZd%dZd Zd Zed&d
Zed'd Z d(d)dZ
d*dZ d*dZ d+dZ
d+dZd+dZd+dZd+dZd,d Zd-d Zd.d"Zd.d#Zd$S )/ConfigDiscoveryzFill-in metadata and options that can be automatically derived
(from other metadata/options, the file system or conventions)
distributionr r r! c > || _ d| _ d| _ d| _ d S )NF)r _called _disabled_skip_ext_modules)r& r s r r' zConfigDiscovery.__init__/ s% !& r c d| _ dS )z+Internal API to disable automatic discoveryTN)r r& s r _disablezConfigDiscovery._disable5 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_modules9 s "& r r c 2 | j j p t j S r )r src_rootr curdirr s r _root_dirzConfigDiscovery._root_dirE s y!.RY.r dict[str, str]c 6 | j j i S | j j S r )r package_dirr s r _package_dirz ConfigDiscovery._package_dirJ s 9 (Iy$$r FTforcer r ignore_ext_modulesc |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& r r r s r r0 zConfigDiscovery.__call__P sX E>>t|>t~> F $$%7888 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_specifiedg sw / I43I 90D8N. sU
Z
"#rw||Hj'I'I J J
r discovered packages -- T) r copypopr r r r itemsrE r r )r& r pkgsr s @r r z(ConfigDiscovery._analyse_explicit_layout 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 rW r getisdirr r
setdefaultr r r rk rI r ro 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 ) rw rI 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 rI 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 detectedrC kindr c 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 metadatar r r #_find_name_single_package_or_module_find_name_from_packages)r& r s r r z ConfigDiscovery.analyse_name s 9 " din F KLLL
4 4 6 6
/,,..
+&*DI # # # + +r
str | Nonec 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>> 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)r+ otherr s r r- z)remove_nested_packages.. s5 CCt%{{{++CCCCCCr r
)r r enumeratereversedr. r )r r r sizeir 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 )r+ r s r r z remove_stubs..& s: P P PC399S>>!+<+E+Eh+O+O PC P P Pr r7 )r s r r r s Q P8 P P PPr r Mapping[str, str]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 )r+ r r s r r- z&find_parent_package..0 s5 GG1<<4
++GGGGGGr r
Nrg )
r r r r r\ find_package_pathr r rW rh )r r r common_ancestorsr pkg_pathinitr s @r r r ) s hC(((H X&& & &4GGGGXa!egg5FGGGGG
E %%%% $T;AAw||Hm44
7>>$ KKK 4r r 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 rW r r r )r r r partsr partial_nameparents r r% r% A s ,
JJsOOE
3u::q"
%
% > >xxbqb ** ; & & .F7<&=59=== = = = ' __R
&BF
7< =6<<#4#4 =u = = ==r package_pathr c f t | }t | j fd|D S )Nc j i | ]/}|d g | d 0S )r+ r< )rW r )r+ r prefixs r
z)construct_package_dir..f s< M M M#C4F4SYYs^^455 M M Mr )r r
r- )r r0 parent_pkgsr3 s @r construct_package_dirr6 c s: (22K
,
%F M M M M M M MMr )r r r r )r r r r r rC )r rC r rC )r rC r r" r r r r
)r r r r" r r r r )r rC r0 r r r )-r6
__future__r itertoolsr collections.abcr r r fnmatchr r pathlibr
typingr r _distutils_hack.override_distutils_hackrl r distutilsr distutils.utilr
setuptoolsr chain
from_iterabler r r r9 rQ rk ro rw r r r r r r r% r6 r7 r r rD s % %N # " " " " " 7 7 7 7 7 7 7 7 7 7 * * * * * * * * ' ' ' ' ' ' (''''''
_
*
1 1 1 1
&
&
&
&
&
&
&
& -" -" -" -" -" -" -" -"`,A ,A ,A ,A ,AG ,A ,A ,A^ - 3 3 3 3 37 3 3 322T 2T 2T 2T 2T 1 2T 2T 2Tj* * * * *\ * * *<B B B B
a a a a a a a aH $Q Q Q Q 0 > > > >DN N N N N Nr