U
|
W ±dfc ã @ sÚ d Z ddlZddlZddlZddlZddlmZ ddl m
|
Z
|
ddl m Z m Z ddlmZ ddlmZ e e¡Ze aG dd d eZd
|
d Zee
|
fee
|
fedfedfd d efeefdZ G dd dZ G dd dZ dS )z-
|
Code related to processing of import hooks.
|
é N)Úlog)Úformat_binaries_and_datas)Ú expand_pathÚimportlib_load_source)Ú PostGraphAPI)ÚImportErrorWhenRunningHookc s4 e Zd ZdZdZ fddZdd Zdd Z ZS ) ÚModuleHookCacheaÃ
|
Cache of lazily loadable hook script objects.
|
|
This cache is implemented as a `dict` subclass mapping from the fully-qualified names of all modules with at
|
least one hook script to lists of `ModuleHook` instances encapsulating these scripts. As a `dict` subclass,
|
all cached module names and hook scripts are accessible via standard dictionary operations.
|
|
Attributes
|
----------
|
module_graph : ModuleGraph
|
Current module graph.
|
_hook_module_name_prefix : str
|
String prefixing the names of all in-memory modules lazily loaded from cached hook scripts. See also the
|
`hook_module_name_prefix` parameter passed to the `ModuleHook.__init__()` method.
|
r c s@ t ¡ t |¡| _d tj¡| _t jd7 _| |¡ dS )aé
|
Cache all hook scripts in the passed directories.
|
|
**Order of caching is significant** with respect to hooks for the same module, as the values of this
|
dictionary are lists. Hooks for the same module will be run in the order in which they are cached. Previously
|
cached hooks are always preserved rather than overridden.
|
|
By default, official hooks are cached _before_ user-defined hooks. For modules with both official and
|
user-defined hooks, this implies that the former take priority over and hence will be loaded _before_ the
|
latter.
|
|
Parameters
|
----------
|
module_graph : ModuleGraph
|
Current module graph.
|
hook_dirs : list
|
List of the absolute or relative paths of all directories containing **hook scripts** (i.e.,
|
Python scripts with filenames matching `hook-{module_name}.py`, where `{module_name}` is the module
|
hooked by that script) to be cached.
|
z__PyInstaller_hooks_{}_é N)
|
ÚsuperÚ__init__ÚweakrefÚproxyÚ module_graphÚformatr Ú_cache_id_nextÚ_hook_module_name_prefixÚ_cache_hook_dirs)Úselfr Ú hook_dirs©Ú __class__© úQd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\PyInstaller/depend/imphook.pyr ; s
|
|
zModuleHookCache.__init__c C s |D ]}t j t|¡}t j |¡s2td |¡t t j |d¡¡}|D ]B}t j |¡dd
}t
|
| j ||| j d}| |g ¡}| |¡ qJqdS )zï
|
Cache all hook scripts in the passed directories.
|
|
Parameters
|
----------
|
hook_dirs : list
|
List of the absolute or relative paths of all directories containing hook scripts to be cached.
|
z Hook directory "{}" not found.z hook-*.pyé éýÿÿÿ)r Ú module_nameÚ hook_filenameÚhook_module_name_prefixN)ÚosÚpathÚabspathr ÚisdirÚFileNotFoundErrorr ÚglobÚjoinÚbasenameÚ
|
ModuleHookr r Ú
|
setdefaultÚappend)r r Zhook_dirZhook_filenamesr r Ú module_hookÚ module_hooksr r r r _ s
|
ü z ModuleHookCache._cache_hook_dirsc G s@ |D ]6}| |g ¡}|D ]}tj |jd¡ q| |d¡ qdS )zñ
|
Remove the passed modules and all hook scripts cached for these modules from this cache.
|
|
Parameters
|
----------
|
module_names : list
|
List of all fully-qualified module names to be removed.
|
N)ÚgetÚsysÚmodulesÚpopÚhook_module_name)r Z module_namesr r* r) r r r Úremove_modules s
|
|
z ModuleHookCache.remove_modules) Ú__name__Ú
|
__module__Ú __qualname__Ú__doc__r r r r0 Ú __classcell__r r r r r ! s
|
$#r c C s2 t | tr| S t | tr d | iS td| d S )Nz.Invalid module collection mode setting value: )Ú
|
isinstanceÚdictÚstrÚ
|
ValueError)Úvaluer r r Ú!_module_collection_mode_sanitizer s
|
|
|
r; c C s dS )NTr r r r r Ú<lambda>¿ ó r< )ÚdatasÚbinariesZexcludedimportsÚ hiddenimportsÚ warn_on_missing_hiddenimportsÚmodule_collection_modec sV e Zd ZdZdd Zdd Z fddZd fd d
|
Zd d Zd d Z dd Z
|
Z S )r& a=
|
Cached object encapsulating a lazy loadable hook script.
|
|
This object exposes public attributes (e.g., `datas`) of the underlying hook script as attributes of the same
|
name of this object. On the first access of any such attribute, this hook script is lazily loaded into an
|
in-memory private module reused on subsequent accesses. These dynamic attributes are referred to as "magic." All
|
other static attributes of this object (e.g., `hook_module_name`) are referred to as "non-magic."
|
|
Attributes (Magic)
|
----------
|
datas : set
|
Set of `TOC`-style 2-tuples `(target_file, source_file)` for all external non-executable files required by
|
the module being hooked, converted from the `datas` list of hook-style 2-tuples `(source_dir_or_glob,
|
target_dir)` defined by this hook script.
|
binaries : set
|
Set of `TOC`-style 2-tuples `(target_file, source_file)` for all external executable files required by the
|
module being hooked, converted from the `binaries` list of hook-style 2-tuples `(source_dir_or_glob,
|
target_dir)` defined by this hook script.
|
excludedimports : set
|
Set of the fully-qualified names of all modules imported by the module being hooked to be ignored rather than
|
imported from that module, converted from the `excludedimports` list defined by this hook script. These
|
modules will only be "locally" rather than "globally" ignored. These modules will remain importable from all
|
modules other than the module being hooked.
|
hiddenimports : set
|
Set of the fully-qualified names of all modules imported by the module being hooked that are _not_
|
automatically detectable by PyInstaller (usually due to being dynamically imported in that module),
|
converted from the `hiddenimports` list defined by this hook script.
|
warn_on_missing_hiddenimports : bool
|
Boolean flag indicating whether missing hidden imports from the hook should generate warnings or not. This
|
behavior is enabled by default, but individual hooks can opt out of it.
|
module_collection_mode : dict
|
A dictionary of package/module names and their corresponding collection mode strings ('pyz', 'pyc', 'py',
|
'pyz+py', 'py+pyz').
|
|
Attributes (Non-magic)
|
----------
|
module_graph : ModuleGraph
|
Current module graph.
|
module_name : str
|
Name of the module hooked by this hook script.
|
hook_filename : str
|
Absolute or relative path of this hook script.
|
hook_module_name : str
|
Name of the in-memory module of this hook script's interpreted contents.
|
_hook_module : module
|
In-memory module of this hook script's interpreted contents, lazily loaded on the first call to the
|
`_load_hook_module()` method _or_ `None` if this method has yet to be accessed.
|
c C sp t |tjst|| _|| _|| _|| j dd¡ | _| jt krHd| _
|
nd| _
|
t | j¡ d| _ d| _ d| _dS )aá
|
Initialize this metadata.
|
|
Parameters
|
----------
|
module_graph : ModuleGraph
|
Current module graph.
|
module_name : str
|
Name of the module hooked by this hook script.
|
hook_filename : str
|
Absolute or relative path of this hook script.
|
hook_module_name_prefix : str
|
String prefixing the name of the in-memory module for this hook script. To avoid namespace clashes with
|
similar modules created by other `ModuleHook` objects in other `ModuleHookCache` containers, this string
|
_must_ be unique to the `ModuleHookCache` container containing this `ModuleHook` object. If this string
|
is non-unique, an existing in-memory module will be erroneously reused when lazily loading this hook
|
script, thus erroneously resanitizing previously sanitized hook script attributes (e.g., `datas`) with
|
the `format_binaries_and_datas()` helper.
|
|
Ú.Ú_TFN)r6 r Ú
|
ProxyTypesÚAssertionErrorr r r Úreplacer/ ÚHOOKS_MODULE_NAMESÚ_shallowÚaddÚ_loadedÚ_has_hook_functionÚ _hook_module)r r r r r r r r r ú s
|
zModuleHook.__init__c C s, |t kr | js | ¡ t| |S t|dS )a
|
Get the magic attribute with the passed name (e.g., `datas`) from this lazily loaded hook script if any _or_
|
raise `AttributeError` otherwise.
|
|
This special method is called only for attributes _not_ already defined by this object. This includes
|
undefined attributes and the first attempt to access magic attributes.
|
|
This special method is _not_ called for subsequent attempts to access magic attributes. The first attempt to
|
access magic attributes defines corresponding instance variables accessible via the `self.__dict__` instance
|
dictionary (e.g., as `self.datas`) without calling this method. This approach also allows magic attributes to
|
be deleted from this object _without_ defining the `__delattr__()` special method.
|
|
See Also
|
----------
|
Class docstring for supported magic attributes.
|
N)Ú_MAGIC_MODULE_HOOK_ATTRSrK Ú_load_hook_moduleÚgetattrÚAttributeError)r Ú attr_namer r r Ú __getattr__' s
|
zModuleHook.__getattr__c s |t kr| ¡ t ||¡S )a
|
Set the attribute with the passed name to the passed value.
|
|
If this is a magic attribute, this hook script will be lazily loaded before setting this attribute. Unlike
|
`__getattr__()`, this special method is called to set _any_ attribute -- including magic, non-magic,
|
and undefined attributes.
|
|
See Also
|
----------
|
Class docstring for supported magic attributes.
|
)rN rO r
|
Ú __setattr__)r rR Ú
|
attr_valuer r r rT B s zModuleHook.__setattr__Fc
|
s j r jdk s|r jr~ jrzd _ d _tjd tj j¡ddd
j f t
|
¡ D ] \}\}}t || ¡ q\dS tj j¡\}}t d||¡ zt j j _W n0 tk
|
râ tjddd t j jY nX d _ t jd _t
|
¡ D ]L\}\}}t j|d} | dkr,| } n|dk r>|| } t || q t d fd
|
d t d ¡ D |s~d _dS ) aÍ
|
Lazily load this hook script into an in-memory private module.
|
|
This method (and, indeed, this class) preserves all attributes and functions defined by this hook script as
|
is, ensuring sane behaviour in hook functions _not_ expecting unplanned external modification. Instead,
|
this method copies public attributes defined by this hook script (e.g., `binaries`) into private attributes
|
of this object, which the special `__getattr__()` and `__setattr__()` methods safely expose to external
|
callers. For public attributes _not_ defined by this hook script, the corresponding private attributes will
|
be assigned sane defaults. For some public attributes defined by this hook script, the corresponding private
|
attributes will be transformed into objects more readily and safely consumed elsewhere by external callers.
|
|
See Also
|
----------
|
Class docstring for supported attributes.
|
NTúNSkipping module hook %r from %r because a hook for %s has already been loaded.éÿÿÿÿz!Loading module hook %r from %r...úHook failed with:©Úexc_infoÚhookrB c s$ i | ] \}}|d k r|n j |qS ©N)r )Ú.0Úkeyr: ©r r r Ú
|
<dictcomp> s ÿ z0ModuleHook._load_hook_module.<locals>.<dictcomp>)rV )rK rM rI ÚloggerÚdebugr r Úsplitr r rN Úitemsr
|
rT Úinfor r/ Ú ImportErrorr ÚhasattrrL rP Úsetattr)
|
r Úkeep_module_refrR Z attr_typerD ÚheadÚtailZ default_typeZsanitizer_funcrU r r_ r rO Z sL ÿ þ
|
|
|
þÿ z ModuleHook._load_hook_modulec C s. | j r | jr"| jdd | |¡ | ¡ dS )aO
|
Call the **post-graph hook** (i.e., `hook()` function) defined by this hook script, if any.
|
|
Parameters
|
----------
|
analysis: build_main.Analysis
|
Analysis that calls the hook
|
|
This method is intended to be called _after_ the module graph for this application is constructed.
|
T)ri N)rK rL rO Ú_process_hook_funcÚ_process_hidden_imports)r Úanalysisr r r Ú
|
post_graphª s
|
zModuleHook.post_graphc C sÄ t | jdsdS t| j| j|d}z| j |¡ W n0 tk
|
rb tjddd t | j
|
| j Y nX | j t|j¡ | j t|j¡ | j |j¡ | j |j¡ |jD ]}| j |j|¡ qªdS )z¶
|
Call this hook's `hook()` function if defined.
|
|
Parameters
|
----------
|
analysis: build_main.Analysis
|
Analysis that calls the hook
|
r[ N)r r rn rX TrY )rg rM r r r r[ rf ra rb r r/ r r> ÚupdateÚsetZ _added_datasr? Z_added_binariesr@ ÚextendZ_added_importsrB Z_module_collection_modeZ_deleted_importsZremoveReferenceÚnode)r rn Zhook_apiZdeleted_module_namer r r rl Ä s
|
z ModuleHook._process_hook_funcc C s\ | j D ]P}z$| jj| jdd}| j ||¡ W q tk
|
rT | jrPt d|¡ Y qX qdS )a1
|
Add all imports listed in this hook script's `hiddenimports` attribute to the module graph as if directly
|
imported by this hooked module.
|
|
These imports are typically _not_ implicitly detectable by PyInstaller and hence must be explicitly defined
|
by hook scripts.
|
F)Z create_nspkgz Hidden import "%s" not found!N) r@ r Z find_noder Z import_hookrf rA ra Úwarning)r Zimport_module_nameZcallerr r r rm ê s
|
|
z"ModuleHook._process_hidden_imports)F) r1 r2 r3 r4 r rS rT rO ro rl rm r5 r r r r r& Æ s 3- P&r& c @ s8 e Zd ZdZdd Zdd Zdd Zdd Zd
|
d Zd S ) ÚAdditionalFilesCachezq
|
Cache for storing what binaries and datas were pushed by what modules when import hooks were processed.
|
c C s i | _ i | _d S r\ ©Ú _binariesÚ_datasr_ r r r r s z AdditionalFilesCache.__init__c C sH | j |g ¡ | j | |p g ¡ | j |g ¡ | j| |p@g ¡ d S r\ )rw r' rr rx )r Úmodnamer? r> r r r rJ
|
s zAdditionalFilesCache.addc C s || j kp|| jkS r\ rv )r Únamer r r Ú __contains__ s z!AdditionalFilesCache.__contains__c C s
|
| j | S )z@
|
Return list of binaries for given module name.
|
)rw ©r ry r r r r? s z AdditionalFilesCache.binariesc C s
|
| j | S )z=
|
Return list of datas for given module name.
|
)rx r| r r r r> s zAdditionalFilesCache.datasN) r1 r2 r3 r4 r rJ r{ r? r> r r r r ru s ru ) r4 r# Úos.pathr r, r Z PyInstallerr ÚloggingZPyInstaller.building.utilsr ZPyInstaller.compatr r Z PyInstaller.depend.imphookapir ZPyInstaller.exceptionsr Ú getLoggerr1 ra rq rH r7 r r; ÚlistÚboolrN r& ru r r r r Ú<module> s0
|
w
|
ë >
|
