1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
|
From: Alex Willmer <alex@moreati.org.uk>
Date: Sun, 17 Mar 2024 14:55:15 +0000
Subject: mitogen: Support PEP 451 ModuleSpec API, required for Python 3.12
importlib.machinery.ModuleSpec and find_spec() were introduced in Python 3.4
under PEP 451. They replace the find_module() API of PEP 302, which was
deprecated from Python 3.4. They were removed in Python 3.12 along with the
imp module.
This change adds support for the PEP 451 APIs. Mitogen should no longer import
imp on Python versions that support ModuleSpec. Tests have been added to cover
the new APIs.
CI jobs have been added to cover Python 3.x on macOS.
Refs #1033
Co-authored-by: Witold Baryluk <witold.baryluk@gmail.com>
Bug-Debain: https://bugs.debian.org/1111363
---
ansible_mitogen/module_finder.py | 122 +++++++++++++++-
ansible_mitogen/runner.py | 91 +++++++++++-
docs/internals.rst | 2 +-
mitogen/core.py | 153 +++++++++++++++++++--
mitogen/master.py | 122 +++++++++++++++-
.../connection_delegation/delegate_to_template.yml | 4 +-
.../interpreter_discovery/ansible_2_8_tests.yml | 7 -
tests/ansible/lib/modules/module_finder_test.py | 12 ++
tests/ansible/tests/module_finder_test.py | 80 +++++++++++
tests/importer_test.py | 126 +++++++++++++++--
tests/module_finder_test.py | 14 +-
tests/testlib.py | 9 +-
12 files changed, 697 insertions(+), 45 deletions(-)
create mode 100644 tests/ansible/lib/modules/module_finder_test.py
create mode 100644 tests/ansible/tests/module_finder_test.py
diff --git a/ansible_mitogen/module_finder.py b/ansible_mitogen/module_finder.py
index cec465c..f227c7b 100644
--- a/ansible_mitogen/module_finder.py
+++ b/ansible_mitogen/module_finder.py
@@ -31,12 +31,23 @@ from __future__ import unicode_literals
__metaclass__ = type
import collections
-import imp
+import logging
import os
+import re
+import sys
+
+try:
+ # Python >= 3.4, PEP 451 ModuleSpec API
+ import importlib.machinery
+ import importlib.util
+except ImportError:
+ # Python < 3.4, PEP 302 Import Hooks
+ import imp
import mitogen.master
+LOG = logging.getLogger(__name__)
PREFIX = 'ansible.module_utils.'
@@ -119,14 +130,121 @@ def find_relative(parent, name, path=()):
def scan_fromlist(code):
+ """Return an iterator of (level, name) for explicit imports in a code
+ object.
+
+ Not all names identify a module. `from os import name, path` generates
+ `(0, 'os.name'), (0, 'os.path')`, but `os.name` is usually a string.
+
+ >>> src = 'import a; import b.c; from d.e import f; from g import h, i\\n'
+ >>> code = compile(src, '<str>', 'exec')
+ >>> list(scan_fromlist(code))
+ [(0, 'a'), (0, 'b.c'), (0, 'd.e.f'), (0, 'g.h'), (0, 'g.i')]
+ """
for level, modname_s, fromlist in mitogen.master.scan_code_imports(code):
for name in fromlist:
- yield level, '%s.%s' % (modname_s, name)
+ yield level, str('%s.%s' % (modname_s, name))
if not fromlist:
yield level, modname_s
+def walk_imports(code, prefix=None):
+ """Return an iterator of names for implicit parent imports & explicit
+ imports in a code object.
+
+ If a prefix is provided, then only children of that prefix are included.
+ Not all names identify a module. `from os import name, path` generates
+ `'os', 'os.name', 'os.path'`, but `os.name` is usually a string.
+
+ >>> source = 'import a; import b; import b.c; from b.d import e, f\\n'
+ >>> code = compile(source, '<str>', 'exec')
+ >>> list(walk_imports(code))
+ ['a', 'b', 'b', 'b.c', 'b', 'b.d', 'b.d.e', 'b.d.f']
+ >>> list(walk_imports(code, prefix='b'))
+ ['b.c', 'b.d', 'b.d.e', 'b.d.f']
+ """
+ if prefix is None:
+ prefix = ''
+ pattern = re.compile(r'(^|\.)(\w+)')
+ start = len(prefix)
+ for _, name, fromlist in mitogen.master.scan_code_imports(code):
+ if not name.startswith(prefix):
+ continue
+ for match in pattern.finditer(name, start):
+ yield name[:match.end()]
+ for leaf in fromlist:
+ yield str('%s.%s' % (name, leaf))
+
+
def scan(module_name, module_path, search_path):
+ # type: (str, str, list[str]) -> list[(str, str, bool)]
+ """Return a list of (name, path, is_package) for ansible.module_utils
+ imports used by an Ansible module.
+ """
+ log = LOG.getChild('scan')
+ log.debug('%r, %r, %r', module_name, module_path, search_path)
+
+ if sys.version_info >= (3, 4):
+ result = _scan_importlib_find_spec(
+ module_name, module_path, search_path,
+ )
+ log.debug('_scan_importlib_find_spec %r', result)
+ else:
+ result = _scan_imp_find_module(module_name, module_path, search_path)
+ log.debug('_scan_imp_find_module %r', result)
+ return result
+
+
+def _scan_importlib_find_spec(module_name, module_path, search_path):
+ # type: (str, str, list[str]) -> list[(str, str, bool)]
+ module = importlib.machinery.ModuleSpec(
+ module_name, loader=None, origin=module_path,
+ )
+ prefix = importlib.machinery.ModuleSpec(
+ PREFIX.rstrip('.'), loader=None,
+ )
+ prefix.submodule_search_locations = search_path
+ queue = collections.deque([module])
+ specs = {prefix.name: prefix}
+ while queue:
+ spec = queue.popleft()
+ if spec.origin is None:
+ continue
+ try:
+ with open(spec.origin, 'rb') as f:
+ code = compile(f.read(), spec.name, 'exec')
+ except Exception as exc:
+ raise ValueError((exc, module, spec, specs))
+
+ for name in walk_imports(code, prefix.name):
+ if name in specs:
+ continue
+
+ parent_name = name.rpartition('.')[0]
+ parent = specs[parent_name]
+ if parent is None or not parent.submodule_search_locations:
+ specs[name] = None
+ continue
+
+ child = importlib.util._find_spec(
+ name, parent.submodule_search_locations,
+ )
+ if child is None or child.origin is None:
+ specs[name] = None
+ continue
+
+ specs[name] = child
+ queue.append(child)
+
+ del specs[prefix.name]
+ return sorted(
+ (spec.name, spec.origin, spec.submodule_search_locations is not None)
+ for spec in specs.values() if spec is not None
+ )
+
+
+def _scan_imp_find_module(module_name, module_path, search_path):
+ # type: (str, str, list[str]) -> list[(str, str, bool)]
module = Module(module_name, module_path, imp.PY_SOURCE, None)
stack = [module]
seen = set()
diff --git a/ansible_mitogen/runner.py b/ansible_mitogen/runner.py
index 31ccf1c..4306b0b 100644
--- a/ansible_mitogen/runner.py
+++ b/ansible_mitogen/runner.py
@@ -40,7 +40,6 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
import atexit
-import imp
import os
import re
import shlex
@@ -63,6 +62,14 @@ except ImportError:
# Python 2.4
ctypes = None
+try:
+ # Python >= 3.4, PEP 451 ModuleSpec API
+ import importlib.machinery
+ import importlib.util
+except ImportError:
+ # Python < 3.4, PEP 302 Import Hooks
+ import imp
+
try:
import json
except ImportError:
@@ -519,10 +526,71 @@ class ModuleUtilsImporter(object):
sys.modules.pop(fullname, None)
def find_module(self, fullname, path=None):
+ """
+ Return a loader for the module with fullname, if we will load it.
+
+ Implements importlib.abc.MetaPathFinder.find_module().
+ Deprecrated in Python 3.4+, replaced by find_spec().
+ Raises ImportWarning in Python 3.10+. Removed in Python 3.12.
+ """
if fullname in self._by_fullname:
return self
+ def find_spec(self, fullname, path, target=None):
+ """
+ Return a `ModuleSpec` for module with `fullname` if we will load it.
+ Otherwise return `None`.
+
+ Implements importlib.abc.MetaPathFinder.find_spec(). Python 3.4+.
+ """
+ if fullname.endswith('.'):
+ return None
+
+ try:
+ module_path, is_package = self._by_fullname[fullname]
+ except KeyError:
+ LOG.debug('Skipping %s: not present', fullname)
+ return None
+
+ LOG.debug('Handling %s', fullname)
+ origin = 'master:%s' % (module_path,)
+ return importlib.machinery.ModuleSpec(
+ fullname, loader=self, origin=origin, is_package=is_package,
+ )
+
+ def create_module(self, spec):
+ """
+ Return a module object for the given ModuleSpec.
+
+ Implements PEP-451 importlib.abc.Loader API introduced in Python 3.4.
+ Unlike Loader.load_module() this shouldn't populate sys.modules or
+ set module attributes. Both are done by Python.
+ """
+ module = types.ModuleType(spec.name)
+ # FIXME create_module() shouldn't initialise module attributes
+ module.__file__ = spec.origin
+ return module
+
+ def exec_module(self, module):
+ """
+ Execute the module to initialise it. Don't return anything.
+
+ Implements PEP-451 importlib.abc.Loader API, introduced in Python 3.4.
+ """
+ spec = module.__spec__
+ path, _ = self._by_fullname[spec.name]
+ source = ansible_mitogen.target.get_small_file(self._context, path)
+ code = compile(source, path, 'exec', 0, 1)
+ exec(code, module.__dict__)
+ self._loaded.add(spec.name)
+
def load_module(self, fullname):
+ """
+ Return the loaded module specified by fullname.
+
+ Implements PEP 302 importlib.abc.Loader.load_module().
+ Deprecated in Python 3.4+, replaced by create_module() & exec_module().
+ """
path, is_pkg = self._by_fullname[fullname]
source = ansible_mitogen.target.get_small_file(self._context, path)
code = compile(source, path, 'exec', 0, 1)
@@ -823,12 +891,17 @@ class NewStyleRunner(ScriptRunner):
synchronization mechanism by importing everything the module will need
prior to detaching.
"""
+ # I think "custom" means "found in custom module_utils search path",
+ # e.g. playbook relative dir, ~/.ansible/..., Ansible collection.
for fullname, _, _ in self.module_map['custom']:
mitogen.core.import_module(fullname)
+
+ # I think "builtin" means "part of ansible/ansible-base/ansible-core",
+ # as opposed to Python builtin modules such as sys.
for fullname in self.module_map['builtin']:
try:
mitogen.core.import_module(fullname)
- except ImportError:
+ except ImportError as exc:
# #590: Ansible 2.8 module_utils.distro is a package that
# replaces itself in sys.modules with a non-package during
# import. Prior to replacement, it is a real package containing
@@ -839,8 +912,18 @@ class NewStyleRunner(ScriptRunner):
# loop progresses to the next entry and attempts to preload
# 'distro._distro', the import mechanism will fail. So here we
# silently ignore any failure for it.
- if fullname != 'ansible.module_utils.distro._distro':
- raise
+ if fullname == 'ansible.module_utils.distro._distro':
+ continue
+
+ # ansible.module_utils.compat.selinux raises ImportError if it
+ # can't load libselinux.so. The importer would usually catch
+ # this & skip selinux operations. We don't care about selinux,
+ # we're using import to get a copy of the module.
+ if (fullname == 'ansible.module_utils.compat.selinux'
+ and exc.msg == 'unable to load libselinux.so'):
+ continue
+
+ raise
def _setup_excepthook(self):
"""
diff --git a/docs/internals.rst b/docs/internals.rst
index 7f44d7b..434a74f 100644
--- a/docs/internals.rst
+++ b/docs/internals.rst
@@ -174,7 +174,7 @@ Module Finders
:members:
.. currentmodule:: mitogen.master
-.. autoclass:: ParentEnumerationMethod
+.. autoclass:: ParentImpEnumerationMethod
:members:
diff --git a/mitogen/core.py b/mitogen/core.py
index bee722e..253fb07 100644
--- a/mitogen/core.py
+++ b/mitogen/core.py
@@ -54,13 +54,18 @@ import syslog
import threading
import time
import traceback
+import types
import warnings
import weakref
import zlib
-# Python >3.7 deprecated the imp module.
-warnings.filterwarnings('ignore', message='the imp module is deprecated')
-import imp
+try:
+ # Python >= 3.4, PEP 451 ModuleSpec API
+ import importlib.machinery
+ import importlib.util
+except ImportError:
+ # Python < 3.4, PEP 302 Import Hooks
+ import imp
# Absolute imports for <2.5.
select = __import__('select')
@@ -1353,6 +1358,19 @@ class Importer(object):
def __repr__(self):
return 'Importer'
+ @staticmethod
+ def _loader_from_module(module, default=None):
+ """Return the loader for a module object."""
+ try:
+ return module.__spec__.loader
+ except AttributeError:
+ pass
+ try:
+ return module.__loader__
+ except AttributeError:
+ pass
+ return default
+
def builtin_find_module(self, fullname):
# imp.find_module() will always succeed for __main__, because it is a
# built-in module. That means it exists on a special linked list deep
@@ -1388,14 +1406,13 @@ class Importer(object):
try:
#_v and self._log.debug('Python requested %r', fullname)
fullname = to_text(fullname)
- pkgname, dot, _ = str_rpartition(fullname, '.')
+ pkgname, _, suffix = str_rpartition(fullname, '.')
pkg = sys.modules.get(pkgname)
if pkgname and getattr(pkg, '__loader__', None) is not self:
self._log.debug('%s is submodule of a locally loaded package',
fullname)
return None
- suffix = fullname[len(pkgname+dot):]
if pkgname and suffix not in self._present.get(pkgname, ()):
self._log.debug('%s has no submodule %s', pkgname, suffix)
return None
@@ -1415,6 +1432,66 @@ class Importer(object):
finally:
del _tls.running
+ def find_spec(self, fullname, path, target=None):
+ """
+ Return a `ModuleSpec` for module with `fullname` if we will load it.
+ Otherwise return `None`, allowing other finders to try.
+
+ fullname Fully qualified name of the module (e.g. foo.bar.baz)
+ path Path entries to search. None for a top-level module.
+ target Existing module to be reloaded (if any).
+
+ Implements importlib.abc.MetaPathFinder.find_spec()
+ Python 3.4+.
+ """
+ # Presence of _tls.running indicates we've re-invoked importlib.
+ # Abort early to prevent infinite recursion. See below.
+ if hasattr(_tls, 'running'):
+ return None
+
+ log = self._log.getChild('find_spec')
+
+ if fullname.endswith('.'):
+ return None
+
+ pkgname, _, modname = fullname.rpartition('.')
+ if pkgname and modname not in self._present.get(pkgname, ()):
+ log.debug('Skipping %s. Parent %s has no submodule %s',
+ fullname, pkgname, modname)
+ return None
+
+ pkg = sys.modules.get(pkgname)
+ pkg_loader = self._loader_from_module(pkg)
+ if pkgname and pkg_loader is not self:
+ log.debug('Skipping %s. Parent %s was loaded by %r',
+ fullname, pkgname, pkg_loader)
+ return None
+
+ # #114: whitelisted prefixes override any system-installed package.
+ if self.whitelist != ['']:
+ if any(s and fullname.startswith(s) for s in self.whitelist):
+ log.debug('Handling %s. It is whitelisted', fullname)
+ return importlib.machinery.ModuleSpec(fullname, loader=self)
+
+ if fullname == '__main__':
+ log.debug('Handling %s. A special case', fullname)
+ return importlib.machinery.ModuleSpec(fullname, loader=self)
+
+ # Re-invoke the import machinery to allow other finders to try.
+ # Set a guard, so we don't infinitely recurse. See top of this method.
+ _tls.running = True
+ try:
+ spec = importlib.util._find_spec(fullname, path, target)
+ finally:
+ del _tls.running
+
+ if spec:
+ log.debug('Skipping %s. Available as %r', fullname, spec)
+ return spec
+
+ log.debug('Handling %s. Unavailable locally', fullname)
+ return importlib.machinery.ModuleSpec(fullname, loader=self)
+
blacklisted_msg = (
'%r is present in the Mitogen importer blacklist, therefore this '
'context will not attempt to request it from the master, as the '
@@ -1501,6 +1578,64 @@ class Importer(object):
if present:
callback()
+ def create_module(self, spec):
+ """
+ Return a module object for the given ModuleSpec.
+
+ Implements PEP-451 importlib.abc.Loader API introduced in Python 3.4.
+ Unlike Loader.load_module() this shouldn't populate sys.modules or
+ set module attributes. Both are done by Python.
+ """
+ self._log.debug('Creating module for %r', spec)
+
+ # FIXME Should this be done in find_spec()? Can it?
+ self._refuse_imports(spec.name)
+
+ # FIXME "create_module() should properly handle the case where it is
+ # called more than once for the same spec/module." -- PEP-451
+ event = threading.Event()
+ self._request_module(spec.name, callback=event.set)
+ event.wait()
+
+ # 0:fullname 1:pkg_present 2:path 3:compressed 4:related
+ _, pkg_present, path, _, _ = self._cache[spec.name]
+
+ if path is None:
+ raise ImportError(self.absent_msg % (spec.name))
+
+ spec.origin = self.get_filename(spec.name)
+ if pkg_present is not None:
+ # TODO Namespace packages
+ spec.submodule_search_locations = []
+ self._present[spec.name] = pkg_present
+
+ module = types.ModuleType(spec.name)
+ # FIXME create_module() shouldn't initialise module attributes
+ module.__file__ = spec.origin
+ return module
+
+ def exec_module(self, module):
+ """
+ Execute the module to initialise it. Don't return anything.
+
+ Implements PEP-451 importlib.abc.Loader API, introduced in Python 3.4.
+ """
+ name = module.__spec__.name
+ origin = module.__spec__.origin
+ self._log.debug('Executing %s from %s', name, origin)
+ source = self.get_source(name)
+ try:
+ # Compile the source into a code object. Don't add any __future__
+ # flags and don't inherit any from this module.
+ # FIXME Should probably be exposed as get_code()
+ code = compile(source, origin, 'exec', flags=0, dont_inherit=True)
+ except SyntaxError:
+ # FIXME Why is this LOG, rather than self._log?
+ LOG.exception('while importing %r', name)
+ raise
+
+ exec(code, module.__dict__)
+
def load_module(self, fullname):
"""
Return the loaded module specified by fullname.
@@ -1516,11 +1651,11 @@ class Importer(object):
self._request_module(fullname, event.set)
event.wait()
- ret = self._cache[fullname]
- if ret[2] is None:
+ # 0:fullname 1:pkg_present 2:path 3:compressed 4:related
+ _, pkg_present, path, _, _ = self._cache[fullname]
+ if path is None:
raise ModuleNotFoundError(self.absent_msg % (fullname,))
- pkg_present = ret[1]
mod = sys.modules.setdefault(fullname, imp.new_module(fullname))
mod.__file__ = self.get_filename(fullname)
mod.__loader__ = self
@@ -3921,7 +4056,7 @@ class ExternalContext(object):
def _setup_package(self):
global mitogen
- mitogen = imp.new_module('mitogen')
+ mitogen = types.ModuleType('mitogen')
mitogen.__package__ = 'mitogen'
mitogen.__path__ = []
mitogen.__loader__ = self.importer
diff --git a/mitogen/master.py b/mitogen/master.py
index 4fb535f..9b5c2ff 100644
--- a/mitogen/master.py
+++ b/mitogen/master.py
@@ -37,7 +37,6 @@ contexts.
import dis
import errno
-import imp
import inspect
import itertools
import logging
@@ -50,6 +49,16 @@ import threading
import types
import zlib
+try:
+ # Python >= 3.4, PEP 451 ModuleSpec API
+ import importlib.machinery
+ import importlib.util
+ from _imp import is_builtin as _is_builtin
+except ImportError:
+ # Python < 3.4, PEP 302 Import Hooks
+ import imp
+ from imp import is_builtin as _is_builtin
+
try:
import sysconfig
except ImportError:
@@ -122,14 +131,14 @@ def is_stdlib_name(modname):
"""
Return :data:`True` if `modname` appears to come from the standard library.
"""
- # `imp.is_builtin()` isn't a documented as part of Python's stdlib API.
+ # `(_imp|imp).is_builtin()` isn't a documented part of Python's stdlib.
#
# """
# Main is a little special - imp.is_builtin("__main__") will return False,
# but BuiltinImporter is still the most appropriate initial setting for
# its __loader__ attribute.
# """ -- comment in CPython pylifecycle.c:add_main_module()
- if imp.is_builtin(modname) != 0:
+ if _is_builtin(modname) != 0:
return True
module = sys.modules.get(modname)
@@ -460,6 +469,9 @@ class FinderMethod(object):
name according to the running Python interpreter. You'd think this was a
simple task, right? Naive young fellow, welcome to the real world.
"""
+ def __init__(self):
+ self.log = LOG.getChild(self.__class__.__name__)
+
def __repr__(self):
return '%s()' % (type(self).__name__,)
@@ -641,7 +653,7 @@ class SysModulesMethod(FinderMethod):
return path, source, is_pkg
-class ParentEnumerationMethod(FinderMethod):
+class ParentImpEnumerationMethod(FinderMethod):
"""
Attempt to fetch source code by examining the module's (hopefully less
insane) parent package, and if no insane parents exist, simply use
@@ -668,9 +680,9 @@ class ParentEnumerationMethod(FinderMethod):
@staticmethod
def _iter_parents(fullname):
"""
- >>> list(ParentEnumerationMethod._iter_parents('a'))
+ >>> list(ParentImpEnumerationMethod._iter_parents('a'))
[('', 'a')]
- >>> list(ParentEnumerationMethod._iter_parents('a.b.c'))
+ >>> list(ParentImpEnumerationMethod._iter_parents('a.b.c'))
[('a.b', 'c'), ('a', 'b'), ('', 'a')]
"""
while fullname:
@@ -770,6 +782,9 @@ class ParentEnumerationMethod(FinderMethod):
"""
See implementation for a description of how this works.
"""
+ if sys.version_info >= (3, 4):
+ return None
+
#if fullname not in sys.modules:
# Don't attempt this unless a module really exists in sys.modules,
# else we could return junk.
@@ -798,6 +813,98 @@ class ParentEnumerationMethod(FinderMethod):
return self._found_module(fullname, path, fp)
+class ParentSpecEnumerationMethod(ParentImpEnumerationMethod):
+ def _find_parent_spec(self, fullname):
+ #history = []
+ debug = self.log.debug
+ children = []
+ for parent_name, child_name in self._iter_parents(fullname):
+ children.insert(0, child_name)
+ if not parent_name:
+ debug('abandoning %r, reached top-level', fullname)
+ return None, children
+
+ try:
+ parent = sys.modules[parent_name]
+ except KeyError:
+ debug('skipping %r, not in sys.modules', parent_name)
+ continue
+
+ try:
+ spec = parent.__spec__
+ except AttributeError:
+ debug('skipping %r: %r.__spec__ is absent',
+ parent_name, parent)
+ continue
+
+ if not spec:
+ debug('skipping %r: %r.__spec__=%r',
+ parent_name, parent, spec)
+ continue
+
+ if spec.name != parent_name:
+ debug('skipping %r: %r.__spec__.name=%r does not match',
+ parent_name, parent, spec.name)
+ continue
+
+ if not spec.submodule_search_locations:
+ debug('skipping %r: %r.__spec__.submodule_search_locations=%r',
+ parent_name, parent, spec.submodule_search_locations)
+ continue
+
+ return spec, children
+
+ raise ValueError('%s._find_parent_spec(%r) unexpectedly reached bottom'
+ % (self.__class__.__name__, fullname))
+
+ def find(self, fullname):
+ # Returns absolute path, ParentImpEnumerationMethod returns relative
+ # >>> spec_pem.find('six_brokenpkg._six')[::2]
+ # ('/Users/alex/src/mitogen/tests/data/importer/six_brokenpkg/_six.py', False)
+
+ if sys.version_info < (3, 4):
+ return None
+
+ fullname = to_text(fullname)
+ spec, children = self._find_parent_spec(fullname)
+ for child_name in children:
+ if spec:
+ name = '%s.%s' % (spec.name, child_name)
+ submodule_search_locations = spec.submodule_search_locations
+ else:
+ name = child_name
+ submodule_search_locations = None
+ spec = importlib.util._find_spec(name, submodule_search_locations)
+ if spec is None:
+ self.log.debug('%r spec unavailable from %s', fullname, spec)
+ return None
+
+ is_package = spec.submodule_search_locations is not None
+ if name != fullname:
+ if not is_package:
+ self.log.debug('%r appears to be child of non-package %r',
+ fullname, spec)
+ return None
+ continue
+
+ if not spec.has_location:
+ self.log.debug('%r.origin cannot be read as a file', spec)
+ return None
+
+ if os.path.splitext(spec.origin)[1] != '.py':
+ self.log.debug('%r.origin does not contain Python source code',
+ spec)
+ return None
+
+ # FIXME This should use loader.get_source()
+ with open(spec.origin, 'rb') as f:
+ source = f.read()
+
+ return spec.origin, source, is_package
+
+ raise ValueError('%s.find(%r) unexpectedly reached bottom'
+ % (self.__class__.__name__, fullname))
+
class ModuleFinder(object):
"""
Given the name of a loaded module, make a best-effort attempt at finding
@@ -838,7 +945,8 @@ class ModuleFinder(object):
DefectivePython3xMainMethod(),
PkgutilMethod(),
SysModulesMethod(),
- ParentEnumerationMethod(),
+ ParentSpecEnumerationMethod(),
+ ParentImpEnumerationMethod(),
]
def get_module_source(self, fullname):
diff --git a/tests/ansible/integration/connection_delegation/delegate_to_template.yml b/tests/ansible/integration/connection_delegation/delegate_to_template.yml
index be083ff..357c485 100644
--- a/tests/ansible/integration/connection_delegation/delegate_to_template.yml
+++ b/tests/ansible/integration/connection_delegation/delegate_to_template.yml
@@ -42,7 +42,7 @@
'keepalive_count': 10,
'password': null,
'port': null,
- 'python_path': ["/usr/bin/python"],
+ 'python_path': ["{{ ansible_facts.discovered_interpreter_python | default('/usr/bin/python') }}"],
'remote_name': null,
'ssh_args': [
'-o',
@@ -72,7 +72,7 @@
'keepalive_count': 10,
'password': null,
'port': null,
- 'python_path': ["/usr/bin/python"],
+ 'python_path': ["{{ ansible_facts.discovered_interpreter_python | default('/usr/bin/python') }}"],
'remote_name': null,
'ssh_args': [
'-o',
diff --git a/tests/ansible/integration/interpreter_discovery/ansible_2_8_tests.yml b/tests/ansible/integration/interpreter_discovery/ansible_2_8_tests.yml
index 201ef8b..fa9baba 100644
--- a/tests/ansible/integration/interpreter_discovery/ansible_2_8_tests.yml
+++ b/tests/ansible/integration/interpreter_discovery/ansible_2_8_tests.yml
@@ -190,13 +190,6 @@
- distro == 'ubuntu'
- distro_version is version('16.04', '>=', strict=True)
- - name: mac assertions
- assert:
- that:
- - auto_out.ansible_facts.discovered_interpreter_python == '/usr/bin/python'
- fail_msg: auto_out={{auto_out}}
- when: os_family == 'Darwin'
-
always:
- meta: clear_facts
when:
diff --git a/tests/ansible/lib/modules/module_finder_test.py b/tests/ansible/lib/modules/module_finder_test.py
new file mode 100644
index 0000000..41cf1c1
--- /dev/null
+++ b/tests/ansible/lib/modules/module_finder_test.py
@@ -0,0 +1,12 @@
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+import os
+import sys
+
+import ansible.module_utils.external1
+
+from ansible.module_utils.externalpkg.extmod import path as epem_path
+
+def main():
+ pass
diff --git a/tests/ansible/tests/module_finder_test.py b/tests/ansible/tests/module_finder_test.py
new file mode 100644
index 0000000..79e8fdb
--- /dev/null
+++ b/tests/ansible/tests/module_finder_test.py
@@ -0,0 +1,80 @@
+import os.path
+import sys
+import textwrap
+import unittest
+
+import ansible_mitogen.module_finder
+
+import testlib
+
+
+class ScanFromListTest(testlib.TestCase):
+ def test_absolute_imports(self):
+ source = textwrap.dedent('''\
+ from __future__ import absolute_import
+ import a; import b.c; from d.e import f; from g import h, i
+ ''')
+ code = compile(source, '<str>', 'exec')
+ self.assertEqual(
+ list(ansible_mitogen.module_finder.scan_fromlist(code)),
+ [(0, '__future__.absolute_import'), (0, 'a'), (0, 'b.c'), (0, 'd.e.f'), (0, 'g.h'), (0, 'g.i')],
+ )
+
+
+class WalkImportsTest(testlib.TestCase):
+ def test_absolute_imports(self):
+ source = textwrap.dedent('''\
+ from __future__ import absolute_import
+ import a; import b; import b.c; from b.d import e, f
+ ''')
+ code = compile(source, '<str>', 'exec')
+
+ self.assertEqual(
+ list(ansible_mitogen.module_finder.walk_imports(code)),
+ ['__future__', '__future__.absolute_import', 'a', 'b', 'b', 'b.c', 'b', 'b.d', 'b.d.e', 'b.d.f'],
+ )
+ self.assertEqual(
+ list(ansible_mitogen.module_finder.walk_imports(code, prefix='b')),
+ ['b.c', 'b.d', 'b.d.e', 'b.d.f'],
+ )
+
+
+class ScanTest(testlib.TestCase):
+ module_name = 'ansible_module_module_finder_test__this_should_not_matter'
+ module_path = os.path.join(testlib.ANSIBLE_MODULES_DIR, 'module_finder_test.py')
+ search_path = (
+ 'does_not_exist/module_utils',
+ testlib.ANSIBLE_MODULE_UTILS_DIR,
+ )
+
+ @staticmethod
+ def relpath(path):
+ return os.path.relpath(path, testlib.ANSIBLE_MODULE_UTILS_DIR)
+
+ @unittest.skipIf(sys.version_info < (3, 4), 'find spec() unavailable')
+ def test_importlib_find_spec(self):
+ scan = ansible_mitogen.module_finder._scan_importlib_find_spec
+ actual = scan(self.module_name, self.module_path, self.search_path)
+ self.assertEqual(
+ [(name, self.relpath(path), is_pkg) for name, path, is_pkg in actual],
+ [
+ ('ansible.module_utils.external1', 'external1.py', False),
+ ('ansible.module_utils.external2', 'external2.py', False),
+ ('ansible.module_utils.externalpkg', 'externalpkg/__init__.py', True),
+ ('ansible.module_utils.externalpkg.extmod', 'externalpkg/extmod.py',False),
+ ],
+ )
+
+ @unittest.skipIf(sys.version_info >= (3, 4), 'find spec() preferred')
+ def test_imp_find_module(self):
+ scan = ansible_mitogen.module_finder._scan_imp_find_module
+ actual = scan(self.module_name, self.module_path, self.search_path)
+ self.assertEqual(
+ [(name, self.relpath(path), is_pkg) for name, path, is_pkg in actual],
+ [
+ ('ansible.module_utils.external1', 'external1.py', False),
+ ('ansible.module_utils.external2', 'external2.py', False),
+ ('ansible.module_utils.externalpkg', 'externalpkg/__init__.py', True),
+ ('ansible.module_utils.externalpkg.extmod', 'externalpkg/extmod.py',False),
+ ],
+ )
diff --git a/tests/importer_test.py b/tests/importer_test.py
index e48c02a..e86af8a 100644
--- a/tests/importer_test.py
+++ b/tests/importer_test.py
@@ -2,6 +2,7 @@ import sys
import threading
import types
import zlib
+import unittest
import mock
@@ -42,6 +43,49 @@ class ImporterMixin(testlib.RouterMixin):
super(ImporterMixin, self).tearDown()
+class InvalidNameTest(ImporterMixin, testlib.TestCase):
+ modname = 'trailingdot.'
+ # 0:fullname 1:pkg_present 2:path 3:compressed 4:related
+ response = (modname, None, None, None, None)
+
+ @unittest.skipIf(sys.version_info < (3, 4), 'Requires ModuleSpec, Python 3.4+')
+ def test_find_spec_invalid(self):
+ self.set_get_module_response(self.response)
+ self.assertEqual(self.importer.find_spec(self.modname, path=None), None)
+
+
+class MissingModuleTest(ImporterMixin, testlib.TestCase):
+ modname = 'missing'
+ # 0:fullname 1:pkg_present 2:path 3:compressed 4:related
+ response = (modname, None, None, None, None)
+
+ @unittest.skipIf(sys.version_info >= (3, 4), 'Superceded in Python 3.4+')
+ def test_load_module_missing(self):
+ self.set_get_module_response(self.response)
+ self.assertRaises(ImportError, self.importer.load_module, self.modname)
+
+ @unittest.skipIf(sys.version_info < (3, 4), 'Requires ModuleSpec, Python 3.4+')
+ def test_find_spec_missing(self):
+ """
+ Importer should optimistically offer itself as a module loader
+ when there are no disqualifying criteria.
+ """
+ import importlib.machinery
+ self.set_get_module_response(self.response)
+ spec = self.importer.find_spec(self.modname, path=None)
+ self.assertIsInstance(spec, importlib.machinery.ModuleSpec)
+ self.assertEqual(spec.name, self.modname)
+ self.assertEqual(spec.loader, self.importer)
+
+ @unittest.skipIf(sys.version_info < (3, 4), 'Requires ModuleSpec, Python 3.4+')
+ def test_create_module_missing(self):
+ import importlib.machinery
+ self.set_get_module_response(self.response)
+ spec = importlib.machinery.ModuleSpec(self.modname, self.importer)
+ self.assertRaises(ImportError, self.importer.create_module, spec)
+
+
+@unittest.skipIf(sys.version_info >= (3, 4), 'Superceded in Python 3.4+')
class LoadModuleTest(ImporterMixin, testlib.TestCase):
data = zlib.compress(b("data = 1\n\n"))
path = 'fake_module.py'
@@ -50,14 +94,6 @@ class LoadModuleTest(ImporterMixin, testlib.TestCase):
# 0:fullname 1:pkg_present 2:path 3:compressed 4:related
response = (modname, None, path, data, [])
- def test_no_such_module(self):
- self.set_get_module_response(
- # 0:fullname 1:pkg_present 2:path 3:compressed 4:related
- (self.modname, None, None, None, None)
- )
- self.assertRaises(ImportError,
- lambda: self.importer.load_module(self.modname))
-
def test_module_added_to_sys_modules(self):
self.set_get_module_response(self.response)
mod = self.importer.load_module(self.modname)
@@ -80,6 +116,26 @@ class LoadModuleTest(ImporterMixin, testlib.TestCase):
self.assertIsNone(mod.__package__)
+@unittest.skipIf(sys.version_info < (3, 4), 'Requires ModuleSpec, Python 3.4+')
+class ModuleSpecTest(ImporterMixin, testlib.TestCase):
+ data = zlib.compress(b("data = 1\n\n"))
+ path = 'fake_module.py'
+ modname = 'fake_module'
+
+ # 0:fullname 1:pkg_present 2:path 3:compressed 4:related
+ response = (modname, None, path, data, [])
+
+ def test_module_attributes(self):
+ import importlib.machinery
+ self.set_get_module_response(self.response)
+ spec = importlib.machinery.ModuleSpec(self.modname, self.importer)
+ mod = self.importer.create_module(spec)
+ self.assertIsInstance(mod, types.ModuleType)
+ self.assertEqual(mod.__name__, 'fake_module')
+ #self.assertFalse(hasattr(mod, '__file__'))
+
+
+@unittest.skipIf(sys.version_info >= (3, 4), 'Superceded in Python 3.4+')
class LoadSubmoduleTest(ImporterMixin, testlib.TestCase):
data = zlib.compress(b("data = 1\n\n"))
path = 'fake_module.py'
@@ -93,6 +149,25 @@ class LoadSubmoduleTest(ImporterMixin, testlib.TestCase):
self.assertEqual(mod.__package__, 'mypkg')
+@unittest.skipIf(sys.version_info < (3, 4), 'Requires ModuleSpec, Python 3.4+')
+class SubmoduleSpecTest(ImporterMixin, testlib.TestCase):
+ data = zlib.compress(b("data = 1\n\n"))
+ path = 'fake_module.py'
+ modname = 'mypkg.fake_module'
+ # 0:fullname 1:pkg_present 2:path 3:compressed 4:related
+ response = (modname, None, path, data, [])
+
+ def test_module_attributes(self):
+ import importlib.machinery
+ self.set_get_module_response(self.response)
+ spec = importlib.machinery.ModuleSpec(self.modname, self.importer)
+ mod = self.importer.create_module(spec)
+ self.assertIsInstance(mod, types.ModuleType)
+ self.assertEqual(mod.__name__, 'mypkg.fake_module')
+ #self.assertFalse(hasattr(mod, '__file__'))
+
+
+@unittest.skipIf(sys.version_info >= (3, 4), 'Superceded in Python 3.4+')
class LoadModulePackageTest(ImporterMixin, testlib.TestCase):
data = zlib.compress(b("func = lambda: 1\n\n"))
path = 'fake_pkg/__init__.py'
@@ -140,6 +215,41 @@ class LoadModulePackageTest(ImporterMixin, testlib.TestCase):
self.assertEqual(mod.func.__module__, self.modname)
+@unittest.skipIf(sys.version_info < (3, 4), 'Requires ModuleSpec, Python 3.4+')
+class PackageSpecTest(ImporterMixin, testlib.TestCase):
+ data = zlib.compress(b("func = lambda: 1\n\n"))
+ path = 'fake_pkg/__init__.py'
+ modname = 'fake_pkg'
+ # 0:fullname 1:pkg_present 2:path 3:compressed 4:related
+ response = (modname, [], path, data, [])
+
+ def test_module_attributes(self):
+ import importlib.machinery
+ self.set_get_module_response(self.response)
+ spec = importlib.machinery.ModuleSpec(self.modname, self.importer)
+ mod = self.importer.create_module(spec)
+ self.assertIsInstance(mod, types.ModuleType)
+ self.assertEqual(mod.__name__, 'fake_pkg')
+ #self.assertFalse(hasattr(mod, '__file__'))
+
+ def test_get_filename(self):
+ import importlib.machinery
+ self.set_get_module_response(self.response)
+ spec = importlib.machinery.ModuleSpec(self.modname, self.importer)
+ _ = self.importer.create_module(spec)
+ filename = self.importer.get_filename(self.modname)
+ self.assertEqual('master:fake_pkg/__init__.py', filename)
+
+ def test_get_source(self):
+ import importlib.machinery
+ self.set_get_module_response(self.response)
+ spec = importlib.machinery.ModuleSpec(self.modname, self.importer)
+ _ = self.importer.create_module(spec)
+ source = self.importer.get_source(self.modname)
+ self.assertEqual(source,
+ mitogen.core.to_text(zlib.decompress(self.data)))
+
+
class EmailParseAddrSysTest(testlib.RouterMixin, testlib.TestCase):
def initdir(self, caplog):
self.caplog = caplog
diff --git a/tests/module_finder_test.py b/tests/module_finder_test.py
index 401a607..8ccbd88 100644
--- a/tests/module_finder_test.py
+++ b/tests/module_finder_test.py
@@ -139,9 +139,7 @@ class SysModulesMethodTest(testlib.TestCase):
self.assertIsNone(tup)
-class GetModuleViaParentEnumerationTest(testlib.TestCase):
- klass = mitogen.master.ParentEnumerationMethod
-
+class ParentEnumerationMixin(object):
def call(self, fullname):
return self.klass().find(fullname)
@@ -231,6 +229,16 @@ class GetModuleViaParentEnumerationTest(testlib.TestCase):
self.assertEqual(is_pkg, False)
+@unittest.skipIf(sys.version_info >= (3, 4), 'Superceded in Python >= 3.4')
+class ParentImpEnumerationMethodTest(ParentEnumerationMixin, testlib.TestCase):
+ klass = mitogen.master.ParentImpEnumerationMethod
+
+
+@unittest.skipIf(sys.version_info < (3, 4), 'Requires ModuleSpec, Python 3.4+')
+class ParentSpecEnumerationMethodTest(ParentEnumerationMixin, testlib.TestCase):
+ klass = mitogen.master.ParentSpecEnumerationMethod
+
+
class ResolveRelPathTest(testlib.TestCase):
klass = mitogen.master.ModuleFinder
diff --git a/tests/testlib.py b/tests/testlib.py
index 8ab895c..1146a92 100644
--- a/tests/testlib.py
+++ b/tests/testlib.py
@@ -41,8 +41,13 @@ except NameError:
LOG = logging.getLogger(__name__)
-DATA_DIR = os.path.join(os.path.dirname(__file__), 'data')
-MODS_DIR = os.path.join(DATA_DIR, 'importer')
+
+TESTS_DIR = os.path.join(os.path.dirname(__file__))
+ANSIBLE_LIB_DIR = os.path.join(TESTS_DIR, 'ansible', 'lib')
+ANSIBLE_MODULE_UTILS_DIR = os.path.join(TESTS_DIR, 'ansible', 'lib', 'module_utils')
+ANSIBLE_MODULES_DIR = os.path.join(TESTS_DIR, 'ansible', 'lib', 'modules')
+DATA_DIR = os.path.join(TESTS_DIR, 'data')
+MODS_DIR = os.path.join(TESTS_DIR, 'data', 'importer')
sys.path.append(DATA_DIR)
sys.path.append(MODS_DIR)
|