2 /* Module definition and import implementation */
6 #include "Python-ast.h"
7 #undef Yield /* undefine macro conflicting with winbase.h */
26 /* for stat.st_mode */
27 typedef unsigned short mode_t
;
31 /* Magic word to reject .pyc files generated by other Python versions.
32 It should change for each incompatible change to the bytecode.
34 The value of CR and LF is incorporated so if you ever read or write
35 a .pyc file in text mode the magic number will be wrong; also, the
36 Apple MPW compiler swaps their values, botching string constants.
38 The magic numbers must be spaced apart atleast 2 values, as the
39 -U interpeter flag will cause MAGIC+1 being used. They have been
40 odd numbers for some time now.
42 There were a variety of old schemes for setting the magic number.
43 The current working scheme is to increment the previous value by
59 Python 2.3a0: 62011 (!)
64 Python 2.5a0: 62081 (ast-branch)
65 Python 2.5a0: 62091 (with)
66 Python 2.5a0: 62092 (changed WITH_CLEANUP opcode)
67 Python 2.5b3: 62101 (fix wrong code: for x, in ...)
68 Python 2.5b3: 62111 (fix wrong code: x += yield)
69 Python 2.5c1: 62121 (fix wrong lnotab with for loops and
70 storing constants that should have been removed)
71 Python 2.5c2: 62131 (fix wrong code: for x, in ... in listcomp/genexp)
72 Python 2.6a0: 62151 (peephole optimizations and STORE_MAP opcode)
73 Python 2.6a1: 62161 (WITH_CLEANUP optimization)
74 Python 2.7a0: 62171 (optimize list comprehensions/change LIST_APPEND)
77 #define MAGIC (62171 | ((long)'\r'<<16) | ((long)'\n'<<24))
79 /* Magic word as global; note that _PyImport_Init() can change the
80 value of this global to accommodate for alterations of how the
81 compiler works which are enabled by command line switches. */
82 static long pyc_magic
= MAGIC
;
84 /* See _PyImport_FixupExtension() below */
85 static PyObject
*extensions
= NULL
;
87 /* This table is defined in config.c: */
88 extern struct _inittab _PyImport_Inittab
[];
90 struct _inittab
*PyImport_Inittab
= _PyImport_Inittab
;
92 /* these tables define the module suffixes that Python recognizes */
93 struct filedescr
* _PyImport_Filetab
= NULL
;
96 static const struct filedescr _PyImport_StandardFiletab
[] = {
97 {"/py", "U", PY_SOURCE
},
98 {"/pyc", "rb", PY_COMPILED
},
102 static const struct filedescr _PyImport_StandardFiletab
[] = {
103 {".py", "U", PY_SOURCE
},
105 {".pyw", "U", PY_SOURCE
},
107 {".pyc", "rb", PY_COMPILED
},
113 /* Initialize things */
118 const struct filedescr
*scan
;
119 struct filedescr
*filetab
;
123 /* prepare _PyImport_Filetab: copy entries from
124 _PyImport_DynLoadFiletab and _PyImport_StandardFiletab.
126 #ifdef HAVE_DYNAMIC_LOADING
127 for (scan
= _PyImport_DynLoadFiletab
; scan
->suffix
!= NULL
; ++scan
)
130 for (scan
= _PyImport_StandardFiletab
; scan
->suffix
!= NULL
; ++scan
)
132 filetab
= PyMem_NEW(struct filedescr
, countD
+ countS
+ 1);
134 Py_FatalError("Can't initialize import file table.");
135 #ifdef HAVE_DYNAMIC_LOADING
136 memcpy(filetab
, _PyImport_DynLoadFiletab
,
137 countD
* sizeof(struct filedescr
));
139 memcpy(filetab
+ countD
, _PyImport_StandardFiletab
,
140 countS
* sizeof(struct filedescr
));
141 filetab
[countD
+ countS
].suffix
= NULL
;
143 _PyImport_Filetab
= filetab
;
145 if (Py_OptimizeFlag
) {
146 /* Replace ".pyc" with ".pyo" in _PyImport_Filetab */
147 for (; filetab
->suffix
!= NULL
; filetab
++) {
149 if (strcmp(filetab
->suffix
, ".pyc") == 0)
150 filetab
->suffix
= ".pyo";
152 if (strcmp(filetab
->suffix
, "/pyc") == 0)
153 filetab
->suffix
= "/pyo";
158 if (Py_UnicodeFlag
) {
159 /* Fix the pyc_magic so that byte compiled code created
160 using the all-Unicode method doesn't interfere with
161 code created in normal operation mode. */
162 pyc_magic
= MAGIC
+ 1;
167 _PyImportHooks_Init(void)
169 PyObject
*v
, *path_hooks
= NULL
, *zimpimport
;
172 /* adding sys.path_hooks and sys.path_importer_cache, setting up
174 if (PyType_Ready(&PyNullImporter_Type
) < 0)
178 PySys_WriteStderr("# installing zipimport hook\n");
183 err
= PySys_SetObject("meta_path", v
);
190 err
= PySys_SetObject("path_importer_cache", v
);
194 path_hooks
= PyList_New(0);
195 if (path_hooks
== NULL
)
197 err
= PySys_SetObject("path_hooks", path_hooks
);
201 Py_FatalError("initializing sys.meta_path, sys.path_hooks, "
202 "path_importer_cache, or NullImporter failed"
206 zimpimport
= PyImport_ImportModule("zipimport");
207 if (zimpimport
== NULL
) {
208 PyErr_Clear(); /* No zip import module -- okay */
210 PySys_WriteStderr("# can't import zipimport\n");
213 PyObject
*zipimporter
= PyObject_GetAttrString(zimpimport
,
215 Py_DECREF(zimpimport
);
216 if (zipimporter
== NULL
) {
217 PyErr_Clear(); /* No zipimporter object -- okay */
220 "# can't import zipimport.zipimporter\n");
223 /* sys.path_hooks.append(zipimporter) */
224 err
= PyList_Append(path_hooks
, zipimporter
);
225 Py_DECREF(zipimporter
);
230 "# installed zipimport hook\n");
233 Py_DECREF(path_hooks
);
239 Py_XDECREF(extensions
);
241 PyMem_DEL(_PyImport_Filetab
);
242 _PyImport_Filetab
= NULL
;
246 /* Locking primitives to prevent parallel imports of the same module
247 in different threads to return with a partially loaded module.
248 These calls are serialized by the global interpreter lock. */
252 #include "pythread.h"
254 static PyThread_type_lock import_lock
= 0;
255 static long import_lock_thread
= -1;
256 static int import_lock_level
= 0;
261 long me
= PyThread_get_thread_ident();
263 return; /* Too bad */
264 if (import_lock
== NULL
) {
265 import_lock
= PyThread_allocate_lock();
266 if (import_lock
== NULL
)
267 return; /* Nothing much we can do. */
269 if (import_lock_thread
== me
) {
273 if (import_lock_thread
!= -1 || !PyThread_acquire_lock(import_lock
, 0))
275 PyThreadState
*tstate
= PyEval_SaveThread();
276 PyThread_acquire_lock(import_lock
, 1);
277 PyEval_RestoreThread(tstate
);
279 import_lock_thread
= me
;
280 import_lock_level
= 1;
286 long me
= PyThread_get_thread_ident();
287 if (me
== -1 || import_lock
== NULL
)
288 return 0; /* Too bad */
289 if (import_lock_thread
!= me
)
292 if (import_lock_level
== 0) {
293 import_lock_thread
= -1;
294 PyThread_release_lock(import_lock
);
299 /* This function is called from PyOS_AfterFork to ensure that newly
300 created child processes do not share locks with the parent. */
303 _PyImport_ReInitLock(void)
306 if (import_lock
!= NULL
)
307 import_lock
= PyThread_allocate_lock();
313 #define lock_import()
314 #define unlock_import() 0
319 imp_lock_held(PyObject
*self
, PyObject
*noargs
)
322 return PyBool_FromLong(import_lock_thread
!= -1);
324 return PyBool_FromLong(0);
329 imp_acquire_lock(PyObject
*self
, PyObject
*noargs
)
339 imp_release_lock(PyObject
*self
, PyObject
*noargs
)
342 if (unlock_import() < 0) {
343 PyErr_SetString(PyExc_RuntimeError
,
344 "not holding the import lock");
353 imp_modules_reloading_clear(void)
355 PyInterpreterState
*interp
= PyThreadState_Get()->interp
;
356 if (interp
->modules_reloading
!= NULL
)
357 PyDict_Clear(interp
->modules_reloading
);
363 PyImport_GetModuleDict(void)
365 PyInterpreterState
*interp
= PyThreadState_GET()->interp
;
366 if (interp
->modules
== NULL
)
367 Py_FatalError("PyImport_GetModuleDict: no module dictionary!");
368 return interp
->modules
;
372 /* List of names to clear in sys */
373 static char* sys_deletes
[] = {
374 "path", "argv", "ps1", "ps2", "exitfunc",
375 "exc_type", "exc_value", "exc_traceback",
376 "last_type", "last_value", "last_traceback",
377 "path_hooks", "path_importer_cache", "meta_path",
379 "flags", "float_info",
383 static char* sys_files
[] = {
384 "stdin", "__stdin__",
385 "stdout", "__stdout__",
386 "stderr", "__stderr__",
391 /* Un-initialize things, as good as we can */
394 PyImport_Cleanup(void)
396 Py_ssize_t pos
, ndone
;
398 PyObject
*key
, *value
, *dict
;
399 PyInterpreterState
*interp
= PyThreadState_GET()->interp
;
400 PyObject
*modules
= interp
->modules
;
403 return; /* Already done */
405 /* Delete some special variables first. These are common
406 places where user values hide and people complain when their
407 destructors fail. Since the modules containing them are
408 deleted *last* of all, they would come too late in the normal
409 destruction order. Sigh. */
411 value
= PyDict_GetItemString(modules
, "__builtin__");
412 if (value
!= NULL
&& PyModule_Check(value
)) {
413 dict
= PyModule_GetDict(value
);
415 PySys_WriteStderr("# clear __builtin__._\n");
416 PyDict_SetItemString(dict
, "_", Py_None
);
418 value
= PyDict_GetItemString(modules
, "sys");
419 if (value
!= NULL
&& PyModule_Check(value
)) {
422 dict
= PyModule_GetDict(value
);
423 for (p
= sys_deletes
; *p
!= NULL
; p
++) {
425 PySys_WriteStderr("# clear sys.%s\n", *p
);
426 PyDict_SetItemString(dict
, *p
, Py_None
);
428 for (p
= sys_files
; *p
!= NULL
; p
+=2) {
430 PySys_WriteStderr("# restore sys.%s\n", *p
);
431 v
= PyDict_GetItemString(dict
, *(p
+1));
434 PyDict_SetItemString(dict
, *p
, v
);
438 /* First, delete __main__ */
439 value
= PyDict_GetItemString(modules
, "__main__");
440 if (value
!= NULL
&& PyModule_Check(value
)) {
442 PySys_WriteStderr("# cleanup __main__\n");
443 _PyModule_Clear(value
);
444 PyDict_SetItemString(modules
, "__main__", Py_None
);
447 /* The special treatment of __builtin__ here is because even
448 when it's not referenced as a module, its dictionary is
449 referenced by almost every module's __builtins__. Since
450 deleting a module clears its dictionary (even if there are
451 references left to it), we need to delete the __builtin__
452 module last. Likewise, we don't delete sys until the very
453 end because it is implicitly referenced (e.g. by print).
455 Also note that we 'delete' modules by replacing their entry
456 in the modules dict with None, rather than really deleting
457 them; this avoids a rehash of the modules dictionary and
458 also marks them as "non existent" so they won't be
461 /* Next, repeatedly delete modules with a reference count of
462 one (skipping __builtin__ and sys) and delete them */
466 while (PyDict_Next(modules
, &pos
, &key
, &value
)) {
467 if (value
->ob_refcnt
!= 1)
469 if (PyString_Check(key
) && PyModule_Check(value
)) {
470 name
= PyString_AS_STRING(key
);
471 if (strcmp(name
, "__builtin__") == 0)
473 if (strcmp(name
, "sys") == 0)
477 "# cleanup[1] %s\n", name
);
478 _PyModule_Clear(value
);
479 PyDict_SetItem(modules
, key
, Py_None
);
485 /* Next, delete all modules (still skipping __builtin__ and sys) */
487 while (PyDict_Next(modules
, &pos
, &key
, &value
)) {
488 if (PyString_Check(key
) && PyModule_Check(value
)) {
489 name
= PyString_AS_STRING(key
);
490 if (strcmp(name
, "__builtin__") == 0)
492 if (strcmp(name
, "sys") == 0)
495 PySys_WriteStderr("# cleanup[2] %s\n", name
);
496 _PyModule_Clear(value
);
497 PyDict_SetItem(modules
, key
, Py_None
);
501 /* Next, delete sys and __builtin__ (in that order) */
502 value
= PyDict_GetItemString(modules
, "sys");
503 if (value
!= NULL
&& PyModule_Check(value
)) {
505 PySys_WriteStderr("# cleanup sys\n");
506 _PyModule_Clear(value
);
507 PyDict_SetItemString(modules
, "sys", Py_None
);
509 value
= PyDict_GetItemString(modules
, "__builtin__");
510 if (value
!= NULL
&& PyModule_Check(value
)) {
512 PySys_WriteStderr("# cleanup __builtin__\n");
513 _PyModule_Clear(value
);
514 PyDict_SetItemString(modules
, "__builtin__", Py_None
);
517 /* Finally, clear and delete the modules directory */
518 PyDict_Clear(modules
);
519 interp
->modules
= NULL
;
521 Py_CLEAR(interp
->modules_reloading
);
525 /* Helper for pythonrun.c -- return magic number */
528 PyImport_GetMagicNumber(void)
534 /* Magic for extension modules (built-in as well as dynamically
535 loaded). To prevent initializing an extension module more than
536 once, we keep a static dictionary 'extensions' keyed by module name
537 (for built-in modules) or by filename (for dynamically loaded
538 modules), containing these modules. A copy of the module's
539 dictionary is stored by calling _PyImport_FixupExtension()
540 immediately after the module initialization function succeeds. A
541 copy can be retrieved from there by calling
542 _PyImport_FindExtension(). */
545 _PyImport_FixupExtension(char *name
, char *filename
)
547 PyObject
*modules
, *mod
, *dict
, *copy
;
548 if (extensions
== NULL
) {
549 extensions
= PyDict_New();
550 if (extensions
== NULL
)
553 modules
= PyImport_GetModuleDict();
554 mod
= PyDict_GetItemString(modules
, name
);
555 if (mod
== NULL
|| !PyModule_Check(mod
)) {
556 PyErr_Format(PyExc_SystemError
,
557 "_PyImport_FixupExtension: module %.200s not loaded", name
);
560 dict
= PyModule_GetDict(mod
);
563 copy
= PyDict_Copy(dict
);
566 PyDict_SetItemString(extensions
, filename
, copy
);
572 _PyImport_FindExtension(char *name
, char *filename
)
574 PyObject
*dict
, *mod
, *mdict
;
575 if (extensions
== NULL
)
577 dict
= PyDict_GetItemString(extensions
, filename
);
580 mod
= PyImport_AddModule(name
);
583 mdict
= PyModule_GetDict(mod
);
586 if (PyDict_Update(mdict
, dict
))
589 PySys_WriteStderr("import %s # previously loaded (%s)\n",
595 /* Get the module object corresponding to a module name.
596 First check the modules dictionary if there's one there,
597 if not, create a new one and insert it in the modules dictionary.
598 Because the former action is most common, THIS DOES NOT RETURN A
602 PyImport_AddModule(const char *name
)
604 PyObject
*modules
= PyImport_GetModuleDict();
607 if ((m
= PyDict_GetItemString(modules
, name
)) != NULL
&&
610 m
= PyModule_New(name
);
613 if (PyDict_SetItemString(modules
, name
, m
) != 0) {
617 Py_DECREF(m
); /* Yes, it still exists, in modules! */
622 /* Remove name from sys.modules, if it's there. */
624 _RemoveModule(const char *name
)
626 PyObject
*modules
= PyImport_GetModuleDict();
627 if (PyDict_GetItemString(modules
, name
) == NULL
)
629 if (PyDict_DelItemString(modules
, name
) < 0)
630 Py_FatalError("import: deleting existing key in"
631 "sys.modules failed");
634 /* Execute a code object in a module and return the module object
635 * WITH INCREMENTED REFERENCE COUNT. If an error occurs, name is
636 * removed from sys.modules, to avoid leaving damaged module objects
637 * in sys.modules. The caller may wish to restore the original
638 * module object (if any) in this case; PyImport_ReloadModule is an
642 PyImport_ExecCodeModule(char *name
, PyObject
*co
)
644 return PyImport_ExecCodeModuleEx(name
, co
, (char *)NULL
);
648 PyImport_ExecCodeModuleEx(char *name
, PyObject
*co
, char *pathname
)
650 PyObject
*modules
= PyImport_GetModuleDict();
653 m
= PyImport_AddModule(name
);
656 /* If the module is being reloaded, we get the old module back
657 and re-use its dict to exec the new code. */
658 d
= PyModule_GetDict(m
);
659 if (PyDict_GetItemString(d
, "__builtins__") == NULL
) {
660 if (PyDict_SetItemString(d
, "__builtins__",
661 PyEval_GetBuiltins()) != 0)
664 /* Remember the filename as the __file__ attribute */
666 if (pathname
!= NULL
) {
667 v
= PyString_FromString(pathname
);
672 v
= ((PyCodeObject
*)co
)->co_filename
;
675 if (PyDict_SetItemString(d
, "__file__", v
) != 0)
676 PyErr_Clear(); /* Not important enough to report */
679 v
= PyEval_EvalCode((PyCodeObject
*)co
, d
, d
);
684 if ((m
= PyDict_GetItemString(modules
, name
)) == NULL
) {
685 PyErr_Format(PyExc_ImportError
,
686 "Loaded module %.200s not found in sys.modules",
701 /* Given a pathname for a Python source file, fill a buffer with the
702 pathname for the corresponding compiled file. Return the pathname
703 for the compiled file, or NULL if there's no space in the buffer.
704 Doesn't set an exception. */
707 make_compiled_pathname(char *pathname
, char *buf
, size_t buflen
)
709 size_t len
= strlen(pathname
);
714 /* Treat .pyw as if it were .py. The case of ".pyw" must match
715 that used in _PyImport_StandardFiletab. */
716 if (len
>= 4 && strcmp(&pathname
[len
-4], ".pyw") == 0)
717 --len
; /* pretend 'w' isn't there */
719 memcpy(buf
, pathname
, len
);
720 buf
[len
] = Py_OptimizeFlag
? 'o' : 'c';
727 /* Given a pathname for a Python source file, its time of last
728 modification, and a pathname for a compiled file, check whether the
729 compiled file represents the same version of the source. If so,
730 return a FILE pointer for the compiled file, positioned just after
731 the header; if not, return NULL.
732 Doesn't set an exception. */
735 check_compiled_module(char *pathname
, time_t mtime
, char *cpathname
)
741 fp
= fopen(cpathname
, "rb");
744 magic
= PyMarshal_ReadLongFromFile(fp
);
745 if (magic
!= pyc_magic
) {
747 PySys_WriteStderr("# %s has bad magic\n", cpathname
);
751 pyc_mtime
= PyMarshal_ReadLongFromFile(fp
);
752 if (pyc_mtime
!= mtime
) {
754 PySys_WriteStderr("# %s has bad mtime\n", cpathname
);
759 PySys_WriteStderr("# %s matches %s\n", cpathname
, pathname
);
764 /* Read a code object from a file and check it for validity */
766 static PyCodeObject
*
767 read_compiled_module(char *cpathname
, FILE *fp
)
771 co
= PyMarshal_ReadLastObjectFromFile(fp
);
774 if (!PyCode_Check(co
)) {
775 PyErr_Format(PyExc_ImportError
,
776 "Non-code object in %.200s", cpathname
);
780 return (PyCodeObject
*)co
;
784 /* Load a module from a compiled file, execute it, and return its
785 module object WITH INCREMENTED REFERENCE COUNT */
788 load_compiled_module(char *name
, char *cpathname
, FILE *fp
)
794 magic
= PyMarshal_ReadLongFromFile(fp
);
795 if (magic
!= pyc_magic
) {
796 PyErr_Format(PyExc_ImportError
,
797 "Bad magic number in %.200s", cpathname
);
800 (void) PyMarshal_ReadLongFromFile(fp
);
801 co
= read_compiled_module(cpathname
, fp
);
805 PySys_WriteStderr("import %s # precompiled from %s\n",
807 m
= PyImport_ExecCodeModuleEx(name
, (PyObject
*)co
, cpathname
);
813 /* Parse a source file and return the corresponding code object */
815 static PyCodeObject
*
816 parse_source_module(const char *pathname
, FILE *fp
)
818 PyCodeObject
*co
= NULL
;
820 PyCompilerFlags flags
;
821 PyArena
*arena
= PyArena_New();
827 mod
= PyParser_ASTFromFile(fp
, pathname
, Py_file_input
, 0, 0, &flags
,
830 co
= PyAST_Compile(mod
, pathname
, NULL
, arena
);
837 /* Helper to open a bytecode file for writing in exclusive mode */
840 open_exclusive(char *filename
, mode_t mode
)
842 #if defined(O_EXCL)&&defined(O_CREAT)&&defined(O_WRONLY)&&defined(O_TRUNC)
843 /* Use O_EXCL to avoid a race condition when another process tries to
844 write the same file. When that happens, our open() call fails,
845 which is just fine (since it's only a cache).
846 XXX If the file exists and is writable but the directory is not
847 writable, the file will never be written. Oh well.
850 (void) unlink(filename
);
851 fd
= open(filename
, O_EXCL
|O_CREAT
|O_WRONLY
|O_TRUNC
853 |O_BINARY
/* necessary for Windows */
856 , mode
, "ctxt=bin", "shr=nil"
863 return fdopen(fd
, "wb");
865 /* Best we can do -- on Windows this can't happen anyway */
866 return fopen(filename
, "wb");
871 /* Write a compiled module to a file, placing the time of last
872 modification of its source into the header.
873 Errors are ignored, if a write error occurs an attempt is made to
877 write_compiled_module(PyCodeObject
*co
, char *cpathname
, struct stat
*srcstat
)
880 time_t mtime
= srcstat
->st_mtime
;
881 mode_t mode
= srcstat
->st_mode
;
883 fp
= open_exclusive(cpathname
, mode
);
887 "# can't create %s\n", cpathname
);
890 PyMarshal_WriteLongToFile(pyc_magic
, fp
, Py_MARSHAL_VERSION
);
891 /* First write a 0 for mtime */
892 PyMarshal_WriteLongToFile(0L, fp
, Py_MARSHAL_VERSION
);
893 PyMarshal_WriteObjectToFile((PyObject
*)co
, fp
, Py_MARSHAL_VERSION
);
894 if (fflush(fp
) != 0 || ferror(fp
)) {
896 PySys_WriteStderr("# can't write %s\n", cpathname
);
897 /* Don't keep partial file */
899 (void) unlink(cpathname
);
902 /* Now write the true mtime */
904 assert(mtime
< LONG_MAX
);
905 PyMarshal_WriteLongToFile((long)mtime
, fp
, Py_MARSHAL_VERSION
);
909 PySys_WriteStderr("# wrote %s\n", cpathname
);
913 update_code_filenames(PyCodeObject
*co
, PyObject
*oldname
, PyObject
*newname
)
915 PyObject
*constants
, *tmp
;
918 if (!_PyString_Eq(co
->co_filename
, oldname
))
921 tmp
= co
->co_filename
;
922 co
->co_filename
= newname
;
923 Py_INCREF(co
->co_filename
);
926 constants
= co
->co_consts
;
927 n
= PyTuple_GET_SIZE(constants
);
928 for (i
= 0; i
< n
; i
++) {
929 tmp
= PyTuple_GET_ITEM(constants
, i
);
930 if (PyCode_Check(tmp
))
931 update_code_filenames((PyCodeObject
*)tmp
,
937 update_compiled_module(PyCodeObject
*co
, char *pathname
)
939 PyObject
*oldname
, *newname
;
941 if (strcmp(PyString_AsString(co
->co_filename
), pathname
) == 0)
944 newname
= PyString_FromString(pathname
);
948 oldname
= co
->co_filename
;
950 update_code_filenames(co
, oldname
, newname
);
956 /* Load a source module from a given file and return its module
957 object WITH INCREMENTED REFERENCE COUNT. If there's a matching
958 byte-compiled file, use that instead. */
961 load_source_module(char *name
, char *pathname
, FILE *fp
)
965 char buf
[MAXPATHLEN
+1];
970 if (fstat(fileno(fp
), &st
) != 0) {
971 PyErr_Format(PyExc_RuntimeError
,
972 "unable to get file status from '%s'",
976 #if SIZEOF_TIME_T > 4
977 /* Python's .pyc timestamp handling presumes that the timestamp fits
978 in 4 bytes. This will be fine until sometime in the year 2038,
979 when a 4-byte signed time_t will overflow.
981 if (st
.st_mtime
>> 32) {
982 PyErr_SetString(PyExc_OverflowError
,
983 "modification time overflows a 4 byte field");
987 cpathname
= make_compiled_pathname(pathname
, buf
,
988 (size_t)MAXPATHLEN
+ 1);
989 if (cpathname
!= NULL
&&
990 (fpc
= check_compiled_module(pathname
, st
.st_mtime
, cpathname
))) {
991 co
= read_compiled_module(cpathname
, fpc
);
995 if (update_compiled_module(co
, pathname
) < 0)
998 PySys_WriteStderr("import %s # precompiled from %s\n",
1000 pathname
= cpathname
;
1003 co
= parse_source_module(pathname
, fp
);
1007 PySys_WriteStderr("import %s # from %s\n",
1010 PyObject
*ro
= PySys_GetObject("dont_write_bytecode");
1011 if (ro
== NULL
|| !PyObject_IsTrue(ro
))
1012 write_compiled_module(co
, cpathname
, &st
);
1015 m
= PyImport_ExecCodeModuleEx(name
, (PyObject
*)co
, pathname
);
1023 static PyObject
*load_module(char *, FILE *, char *, int, PyObject
*);
1024 static struct filedescr
*find_module(char *, char *, PyObject
*,
1025 char *, size_t, FILE **, PyObject
**);
1026 static struct _frozen
*find_frozen(char *name
);
1028 /* Load a package and return its module object WITH INCREMENTED
1032 load_package(char *name
, char *pathname
)
1035 PyObject
*file
= NULL
;
1036 PyObject
*path
= NULL
;
1038 char buf
[MAXPATHLEN
+1];
1040 struct filedescr
*fdp
;
1042 m
= PyImport_AddModule(name
);
1046 PySys_WriteStderr("import %s # directory %s\n",
1048 d
= PyModule_GetDict(m
);
1049 file
= PyString_FromString(pathname
);
1052 path
= Py_BuildValue("[O]", file
);
1055 err
= PyDict_SetItemString(d
, "__file__", file
);
1057 err
= PyDict_SetItemString(d
, "__path__", path
);
1061 fdp
= find_module(name
, "__init__", path
, buf
, sizeof(buf
), &fp
, NULL
);
1063 if (PyErr_ExceptionMatches(PyExc_ImportError
)) {
1071 m
= load_module(name
, fp
, buf
, fdp
->type
, NULL
);
1085 /* Helper to test for built-in module */
1088 is_builtin(char *name
)
1091 for (i
= 0; PyImport_Inittab
[i
].name
!= NULL
; i
++) {
1092 if (strcmp(name
, PyImport_Inittab
[i
].name
) == 0) {
1093 if (PyImport_Inittab
[i
].initfunc
== NULL
)
1103 /* Return an importer object for a sys.path/pkg.__path__ item 'p',
1104 possibly by fetching it from the path_importer_cache dict. If it
1105 wasn't yet cached, traverse path_hooks until a hook is found
1106 that can handle the path item. Return None if no hook could;
1107 this tells our caller it should fall back to the builtin
1108 import mechanism. Cache the result in path_importer_cache.
1109 Returns a borrowed reference. */
1112 get_path_importer(PyObject
*path_importer_cache
, PyObject
*path_hooks
,
1116 Py_ssize_t j
, nhooks
;
1118 /* These conditions are the caller's responsibility: */
1119 assert(PyList_Check(path_hooks
));
1120 assert(PyDict_Check(path_importer_cache
));
1122 nhooks
= PyList_Size(path_hooks
);
1124 return NULL
; /* Shouldn't happen */
1126 importer
= PyDict_GetItem(path_importer_cache
, p
);
1127 if (importer
!= NULL
)
1130 /* set path_importer_cache[p] to None to avoid recursion */
1131 if (PyDict_SetItem(path_importer_cache
, p
, Py_None
) != 0)
1134 for (j
= 0; j
< nhooks
; j
++) {
1135 PyObject
*hook
= PyList_GetItem(path_hooks
, j
);
1138 importer
= PyObject_CallFunctionObjArgs(hook
, p
, NULL
);
1139 if (importer
!= NULL
)
1142 if (!PyErr_ExceptionMatches(PyExc_ImportError
)) {
1147 if (importer
== NULL
) {
1148 importer
= PyObject_CallFunctionObjArgs(
1149 (PyObject
*)&PyNullImporter_Type
, p
, NULL
1151 if (importer
== NULL
) {
1152 if (PyErr_ExceptionMatches(PyExc_ImportError
)) {
1158 if (importer
!= NULL
) {
1159 int err
= PyDict_SetItem(path_importer_cache
, p
, importer
);
1160 Py_DECREF(importer
);
1167 PyAPI_FUNC(PyObject
*)
1168 PyImport_GetImporter(PyObject
*path
) {
1169 PyObject
*importer
=NULL
, *path_importer_cache
=NULL
, *path_hooks
=NULL
;
1171 if ((path_importer_cache
= PySys_GetObject("path_importer_cache"))) {
1172 if ((path_hooks
= PySys_GetObject("path_hooks"))) {
1173 importer
= get_path_importer(path_importer_cache
,
1177 Py_XINCREF(importer
); /* get_path_importer returns a borrowed reference */
1181 /* Search the path (default sys.path) for a module. Return the
1182 corresponding filedescr struct, and (via return arguments) the
1183 pathname and an open file. Return NULL if the module is not found. */
1186 extern FILE *PyWin_FindRegisteredModule(const char *, struct filedescr
**,
1187 char *, Py_ssize_t
);
1190 static int case_ok(char *, Py_ssize_t
, Py_ssize_t
, char *);
1191 static int find_init_module(char *); /* Forward */
1192 static struct filedescr importhookdescr
= {"", "", IMP_HOOK
};
1194 static struct filedescr
*
1195 find_module(char *fullname
, char *subname
, PyObject
*path
, char *buf
,
1196 size_t buflen
, FILE **p_fp
, PyObject
**p_loader
)
1198 Py_ssize_t i
, npath
;
1199 size_t len
, namelen
;
1200 struct filedescr
*fdp
= NULL
;
1203 PyObject
*path_hooks
, *path_importer_cache
;
1205 struct stat statbuf
;
1207 static struct filedescr fd_frozen
= {"", "", PY_FROZEN
};
1208 static struct filedescr fd_builtin
= {"", "", C_BUILTIN
};
1209 static struct filedescr fd_package
= {"", "", PKG_DIRECTORY
};
1210 char name
[MAXPATHLEN
+1];
1211 #if defined(PYOS_OS2)
1213 size_t saved_namelen
;
1214 char *saved_buf
= NULL
;
1216 if (p_loader
!= NULL
)
1219 if (strlen(subname
) > MAXPATHLEN
) {
1220 PyErr_SetString(PyExc_OverflowError
,
1221 "module name is too long");
1224 strcpy(name
, subname
);
1226 /* sys.meta_path import hook */
1227 if (p_loader
!= NULL
) {
1228 PyObject
*meta_path
;
1230 meta_path
= PySys_GetObject("meta_path");
1231 if (meta_path
== NULL
|| !PyList_Check(meta_path
)) {
1232 PyErr_SetString(PyExc_ImportError
,
1233 "sys.meta_path must be a list of "
1237 Py_INCREF(meta_path
); /* zap guard */
1238 npath
= PyList_Size(meta_path
);
1239 for (i
= 0; i
< npath
; i
++) {
1241 PyObject
*hook
= PyList_GetItem(meta_path
, i
);
1242 loader
= PyObject_CallMethod(hook
, "find_module",
1246 if (loader
== NULL
) {
1247 Py_DECREF(meta_path
);
1248 return NULL
; /* true error */
1250 if (loader
!= Py_None
) {
1251 /* a loader was found */
1253 Py_DECREF(meta_path
);
1254 return &importhookdescr
;
1258 Py_DECREF(meta_path
);
1261 if (path
!= NULL
&& PyString_Check(path
)) {
1262 /* The only type of submodule allowed inside a "frozen"
1263 package are other frozen modules or packages. */
1264 if (PyString_Size(path
) + 1 + strlen(name
) >= (size_t)buflen
) {
1265 PyErr_SetString(PyExc_ImportError
,
1266 "full frozen module name too long");
1269 strcpy(buf
, PyString_AsString(path
));
1273 if (find_frozen(name
) != NULL
) {
1277 PyErr_Format(PyExc_ImportError
,
1278 "No frozen submodule named %.200s", name
);
1282 if (is_builtin(name
)) {
1286 if ((find_frozen(name
)) != NULL
) {
1292 fp
= PyWin_FindRegisteredModule(name
, &fdp
, buf
, buflen
);
1298 path
= PySys_GetObject("path");
1300 if (path
== NULL
|| !PyList_Check(path
)) {
1301 PyErr_SetString(PyExc_ImportError
,
1302 "sys.path must be a list of directory names");
1306 path_hooks
= PySys_GetObject("path_hooks");
1307 if (path_hooks
== NULL
|| !PyList_Check(path_hooks
)) {
1308 PyErr_SetString(PyExc_ImportError
,
1309 "sys.path_hooks must be a list of "
1313 path_importer_cache
= PySys_GetObject("path_importer_cache");
1314 if (path_importer_cache
== NULL
||
1315 !PyDict_Check(path_importer_cache
)) {
1316 PyErr_SetString(PyExc_ImportError
,
1317 "sys.path_importer_cache must be a dict");
1321 npath
= PyList_Size(path
);
1322 namelen
= strlen(name
);
1323 for (i
= 0; i
< npath
; i
++) {
1324 PyObject
*copy
= NULL
;
1325 PyObject
*v
= PyList_GetItem(path
, i
);
1328 #ifdef Py_USING_UNICODE
1329 if (PyUnicode_Check(v
)) {
1330 copy
= PyUnicode_Encode(PyUnicode_AS_UNICODE(v
),
1331 PyUnicode_GET_SIZE(v
), Py_FileSystemDefaultEncoding
, NULL
);
1338 if (!PyString_Check(v
))
1340 len
= PyString_GET_SIZE(v
);
1341 if (len
+ 2 + namelen
+ MAXSUFFIXSIZE
>= buflen
) {
1343 continue; /* Too long */
1345 strcpy(buf
, PyString_AS_STRING(v
));
1346 if (strlen(buf
) != len
) {
1348 continue; /* v contains '\0' */
1351 /* sys.path_hooks import hook */
1352 if (p_loader
!= NULL
) {
1355 importer
= get_path_importer(path_importer_cache
,
1357 if (importer
== NULL
) {
1361 /* Note: importer is a borrowed reference */
1362 if (importer
!= Py_None
) {
1364 loader
= PyObject_CallMethod(importer
,
1369 return NULL
; /* error */
1370 if (loader
!= Py_None
) {
1371 /* a loader was found */
1373 return &importhookdescr
;
1379 /* no hook was found, use builtin import */
1381 if (len
> 0 && buf
[len
-1] != SEP
1383 && buf
[len
-1] != ALTSEP
1387 strcpy(buf
+len
, name
);
1390 /* Check for package import (buf holds a directory name,
1391 and there's an __init__ module in that directory */
1393 if (stat(buf
, &statbuf
) == 0 && /* it exists */
1394 S_ISDIR(statbuf
.st_mode
) && /* it's a directory */
1395 case_ok(buf
, len
, namelen
, name
)) { /* case matches */
1396 if (find_init_module(buf
)) { /* and has __init__.py */
1401 char warnstr
[MAXPATHLEN
+80];
1402 sprintf(warnstr
, "Not importing directory "
1403 "'%.*s': missing __init__.py",
1405 if (PyErr_Warn(PyExc_ImportWarning
,
1413 /* XXX How are you going to test for directories? */
1416 case_ok(buf
, len
, namelen
, name
)) {
1417 if (find_init_module(buf
)) {
1422 char warnstr
[MAXPATHLEN
+80];
1423 sprintf(warnstr
, "Not importing directory "
1424 "'%.*s': missing __init__.py",
1426 if (PyErr_Warn(PyExc_ImportWarning
,
1434 #if defined(PYOS_OS2)
1435 /* take a snapshot of the module spec for restoration
1436 * after the 8 character DLL hackery
1438 saved_buf
= strdup(buf
);
1440 saved_namelen
= namelen
;
1441 #endif /* PYOS_OS2 */
1442 for (fdp
= _PyImport_Filetab
; fdp
->suffix
!= NULL
; fdp
++) {
1443 #if defined(PYOS_OS2) && defined(HAVE_DYNAMIC_LOADING)
1444 /* OS/2 limits DLLs to 8 character names (w/o
1446 * so if the name is longer than that and its a
1447 * dynamically loaded module we're going to try,
1448 * truncate the name before trying
1450 if (strlen(subname
) > 8) {
1451 /* is this an attempt to load a C extension? */
1452 const struct filedescr
*scan
;
1453 scan
= _PyImport_DynLoadFiletab
;
1454 while (scan
->suffix
!= NULL
) {
1455 if (!strcmp(scan
->suffix
, fdp
->suffix
))
1460 if (scan
->suffix
!= NULL
) {
1461 /* yes, so truncate the name */
1463 len
-= strlen(subname
) - namelen
;
1467 #endif /* PYOS_OS2 */
1468 strcpy(buf
+len
, fdp
->suffix
);
1469 if (Py_VerboseFlag
> 1)
1470 PySys_WriteStderr("# trying %s\n", buf
);
1471 filemode
= fdp
->mode
;
1472 if (filemode
[0] == 'U')
1473 filemode
= "r" PY_STDIOTEXTMODE
;
1474 fp
= fopen(buf
, filemode
);
1476 if (case_ok(buf
, len
, namelen
, name
))
1478 else { /* continue search */
1483 #if defined(PYOS_OS2)
1484 /* restore the saved snapshot */
1485 strcpy(buf
, saved_buf
);
1487 namelen
= saved_namelen
;
1490 #if defined(PYOS_OS2)
1491 /* don't need/want the module name snapshot anymore */
1503 PyErr_Format(PyExc_ImportError
,
1504 "No module named %.200s", name
);
1511 /* Helpers for main.c
1512 * Find the source file corresponding to a named module
1515 _PyImport_FindModule(const char *name
, PyObject
*path
, char *buf
,
1516 size_t buflen
, FILE **p_fp
, PyObject
**p_loader
)
1518 return find_module((char *) name
, (char *) name
, path
,
1519 buf
, buflen
, p_fp
, p_loader
);
1522 PyAPI_FUNC(int) _PyImport_IsScript(struct filedescr
* fd
)
1524 return fd
->type
== PY_SOURCE
|| fd
->type
== PY_COMPILED
;
1527 /* case_ok(char* buf, Py_ssize_t len, Py_ssize_t namelen, char* name)
1528 * The arguments here are tricky, best shown by example:
1529 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1531 * |--------------------- buf ---------------------|
1532 * |------------------- len ------------------|
1533 * |------ name -------|
1534 * |----- namelen -----|
1535 * buf is the full path, but len only counts up to (& exclusive of) the
1536 * extension. name is the module name, also exclusive of extension.
1538 * We've already done a successful stat() or fopen() on buf, so know that
1539 * there's some match, possibly case-insensitive.
1541 * case_ok() is to return 1 if there's a case-sensitive match for
1542 * name, else 0. case_ok() is also to return 1 if envar PYTHONCASEOK
1545 * case_ok() is used to implement case-sensitive import semantics even
1546 * on platforms with case-insensitive filesystems. It's trivial to implement
1547 * for case-sensitive filesystems. It's pretty much a cross-platform
1548 * nightmare for systems with case-insensitive filesystems.
1551 /* First we may need a pile of platform-specific header files; the sequence
1552 * of #if's here should match the sequence in the body of case_ok().
1554 #if defined(MS_WINDOWS)
1555 #include <windows.h>
1557 #elif defined(DJGPP)
1560 #elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
1561 #include <sys/types.h>
1564 #elif defined(PYOS_OS2)
1566 #define INCL_DOSERRORS
1567 #define INCL_NOPMAPI
1570 #elif defined(RISCOS)
1571 #include "oslib/osfscontrol.h"
1575 case_ok(char *buf
, Py_ssize_t len
, Py_ssize_t namelen
, char *name
)
1577 /* Pick a platform-specific implementation; the sequence of #if's here should
1578 * match the sequence just above.
1582 #if defined(MS_WINDOWS)
1583 WIN32_FIND_DATA data
;
1586 if (Py_GETENV("PYTHONCASEOK") != NULL
)
1589 h
= FindFirstFile(buf
, &data
);
1590 if (h
== INVALID_HANDLE_VALUE
) {
1591 PyErr_Format(PyExc_NameError
,
1592 "Can't find file for module %.100s\n(filename %.300s)",
1597 return strncmp(data
.cFileName
, name
, namelen
) == 0;
1600 #elif defined(DJGPP)
1604 if (Py_GETENV("PYTHONCASEOK") != NULL
)
1607 done
= findfirst(buf
, &ffblk
, FA_ARCH
|FA_RDONLY
|FA_HIDDEN
|FA_DIREC
);
1609 PyErr_Format(PyExc_NameError
,
1610 "Can't find file for module %.100s\n(filename %.300s)",
1614 return strncmp(ffblk
.ff_name
, name
, namelen
) == 0;
1616 /* new-fangled macintosh (macosx) or Cygwin */
1617 #elif (defined(__MACH__) && defined(__APPLE__) || defined(__CYGWIN__)) && defined(HAVE_DIRENT_H)
1620 char dirname
[MAXPATHLEN
+ 1];
1621 const int dirlen
= len
- namelen
- 1; /* don't want trailing SEP */
1623 if (Py_GETENV("PYTHONCASEOK") != NULL
)
1626 /* Copy the dir component into dirname; substitute "." if empty */
1632 assert(dirlen
<= MAXPATHLEN
);
1633 memcpy(dirname
, buf
, dirlen
);
1634 dirname
[dirlen
] = '\0';
1636 /* Open the directory and search the entries for an exact match. */
1637 dirp
= opendir(dirname
);
1639 char *nameWithExt
= buf
+ len
- namelen
;
1640 while ((dp
= readdir(dirp
)) != NULL
) {
1642 #ifdef _DIRENT_HAVE_D_NAMELEN
1647 if (thislen
>= namelen
&&
1648 strcmp(dp
->d_name
, nameWithExt
) == 0) {
1649 (void)closedir(dirp
);
1650 return 1; /* Found */
1653 (void)closedir(dirp
);
1655 return 0 ; /* Not found */
1658 #elif defined(RISCOS)
1659 char canon
[MAXPATHLEN
+1]; /* buffer for the canonical form of the path */
1660 char buf2
[MAXPATHLEN
+2];
1661 char *nameWithExt
= buf
+len
-namelen
;
1665 if (Py_GETENV("PYTHONCASEOK") != NULL
)
1669 append wildcard, otherwise case of filename wouldn't be touched */
1673 e
= xosfscontrol_canonicalise_path(buf2
,canon
,0,0,MAXPATHLEN
+1,&canonlen
);
1674 canonlen
= MAXPATHLEN
+1-canonlen
;
1675 if (e
|| canonlen
<=0 || canonlen
>(MAXPATHLEN
+1) )
1677 if (strcmp(nameWithExt
, canon
+canonlen
-strlen(nameWithExt
))==0)
1678 return 1; /* match */
1683 #elif defined(PYOS_OS2)
1689 if (Py_GETENV("PYTHONCASEOK") != NULL
)
1692 rc
= DosFindFirst(buf
,
1694 FILE_READONLY
| FILE_HIDDEN
| FILE_SYSTEM
| FILE_DIRECTORY
,
1695 &ffbuf
, sizeof(ffbuf
),
1700 return strncmp(ffbuf
.achName
, name
, namelen
) == 0;
1702 /* assuming it's a case-sensitive filesystem, so there's nothing to do! */
1711 /* Helper to look for __init__.py or __init__.py[co] in potential package */
1713 find_init_module(char *buf
)
1715 const size_t save_len
= strlen(buf
);
1716 size_t i
= save_len
;
1717 char *pname
; /* pointer to start of __init__ */
1718 struct stat statbuf
;
1720 /* For calling case_ok(buf, len, namelen, name):
1721 * /a/b/c/d/e/f/g/h/i/j/k/some_long_module_name.py\0
1723 * |--------------------- buf ---------------------|
1724 * |------------------- len ------------------|
1725 * |------ name -------|
1726 * |----- namelen -----|
1728 if (save_len
+ 13 >= MAXPATHLEN
)
1732 strcpy(pname
, "__init__.py");
1733 if (stat(buf
, &statbuf
) == 0) {
1735 save_len
+ 9, /* len("/__init__") */
1736 8, /* len("__init__") */
1738 buf
[save_len
] = '\0';
1743 strcpy(buf
+i
, Py_OptimizeFlag
? "o" : "c");
1744 if (stat(buf
, &statbuf
) == 0) {
1746 save_len
+ 9, /* len("/__init__") */
1747 8, /* len("__init__") */
1749 buf
[save_len
] = '\0';
1753 buf
[save_len
] = '\0';
1761 find_init_module(buf
)
1764 int save_len
= strlen(buf
);
1767 if (save_len
+ 13 >= MAXPATHLEN
)
1770 strcpy(buf
+i
, "__init__/py");
1772 buf
[save_len
] = '\0';
1776 if (Py_OptimizeFlag
)
1781 buf
[save_len
] = '\0';
1784 buf
[save_len
] = '\0';
1789 #endif /* HAVE_STAT */
1792 static int init_builtin(char *); /* Forward */
1794 /* Load an external module using the default search path and return
1795 its module object WITH INCREMENTED REFERENCE COUNT */
1798 load_module(char *name
, FILE *fp
, char *buf
, int type
, PyObject
*loader
)
1804 /* First check that there's an open file (if we need one) */
1809 PyErr_Format(PyExc_ValueError
,
1810 "file object required for import (type code %d)",
1819 m
= load_source_module(name
, buf
, fp
);
1823 m
= load_compiled_module(name
, buf
, fp
);
1826 #ifdef HAVE_DYNAMIC_LOADING
1828 m
= _PyImport_LoadDynamicModule(name
, buf
, fp
);
1833 m
= load_package(name
, buf
);
1838 if (buf
!= NULL
&& buf
[0] != '\0')
1840 if (type
== C_BUILTIN
)
1841 err
= init_builtin(name
);
1843 err
= PyImport_ImportFrozenModule(name
);
1847 PyErr_Format(PyExc_ImportError
,
1848 "Purported %s module %.200s not found",
1850 "builtin" : "frozen",
1854 modules
= PyImport_GetModuleDict();
1855 m
= PyDict_GetItemString(modules
, name
);
1859 "%s module %.200s not properly initialized",
1861 "builtin" : "frozen",
1869 if (loader
== NULL
) {
1870 PyErr_SetString(PyExc_ImportError
,
1871 "import hook without loader");
1874 m
= PyObject_CallMethod(loader
, "load_module", "s", name
);
1879 PyErr_Format(PyExc_ImportError
,
1880 "Don't know how to import %.200s (type code %d)",
1890 /* Initialize a built-in module.
1891 Return 1 for success, 0 if the module is not found, and -1 with
1892 an exception set if the initialization failed. */
1895 init_builtin(char *name
)
1899 if (_PyImport_FindExtension(name
, name
) != NULL
)
1902 for (p
= PyImport_Inittab
; p
->name
!= NULL
; p
++) {
1903 if (strcmp(name
, p
->name
) == 0) {
1904 if (p
->initfunc
== NULL
) {
1905 PyErr_Format(PyExc_ImportError
,
1906 "Cannot re-init internal module %.200s",
1911 PySys_WriteStderr("import %s # builtin\n", name
);
1913 if (PyErr_Occurred())
1915 if (_PyImport_FixupExtension(name
, name
) == NULL
)
1924 /* Frozen modules */
1926 static struct _frozen
*
1927 find_frozen(char *name
)
1931 for (p
= PyImport_FrozenModules
; ; p
++) {
1932 if (p
->name
== NULL
)
1934 if (strcmp(p
->name
, name
) == 0)
1941 get_frozen_object(char *name
)
1943 struct _frozen
*p
= find_frozen(name
);
1947 PyErr_Format(PyExc_ImportError
,
1948 "No such frozen object named %.200s",
1952 if (p
->code
== NULL
) {
1953 PyErr_Format(PyExc_ImportError
,
1954 "Excluded frozen object named %.200s",
1961 return PyMarshal_ReadObjectFromString((char *)p
->code
, size
);
1964 /* Initialize a frozen module.
1965 Return 1 for succes, 0 if the module is not found, and -1 with
1966 an exception set if the initialization failed.
1967 This function is also used from frozenmain.c */
1970 PyImport_ImportFrozenModule(char *name
)
1972 struct _frozen
*p
= find_frozen(name
);
1980 if (p
->code
== NULL
) {
1981 PyErr_Format(PyExc_ImportError
,
1982 "Excluded frozen object named %.200s",
1987 ispackage
= (size
< 0);
1991 PySys_WriteStderr("import %s # frozen%s\n",
1992 name
, ispackage
? " package" : "");
1993 co
= PyMarshal_ReadObjectFromString((char *)p
->code
, size
);
1996 if (!PyCode_Check(co
)) {
1997 PyErr_Format(PyExc_TypeError
,
1998 "frozen object %.200s is not a code object",
2003 /* Set __path__ to the package name */
2006 m
= PyImport_AddModule(name
);
2009 d
= PyModule_GetDict(m
);
2010 s
= PyString_InternFromString(name
);
2013 err
= PyDict_SetItemString(d
, "__path__", s
);
2018 m
= PyImport_ExecCodeModuleEx(name
, co
, "<frozen>");
2030 /* Import a module, either built-in, frozen, or external, and return
2031 its module object WITH INCREMENTED REFERENCE COUNT */
2034 PyImport_ImportModule(const char *name
)
2039 pname
= PyString_FromString(name
);
2042 result
= PyImport_Import(pname
);
2047 /* Import a module without blocking
2049 * At first it tries to fetch the module from sys.modules. If the module was
2050 * never loaded before it loads it with PyImport_ImportModule() unless another
2051 * thread holds the import lock. In the latter case the function raises an
2052 * ImportError instead of blocking.
2054 * Returns the module object with incremented ref count.
2057 PyImport_ImportModuleNoBlock(const char *name
)
2063 /* Try to get the module from sys.modules[name] */
2064 modules
= PyImport_GetModuleDict();
2065 if (modules
== NULL
)
2068 result
= PyDict_GetItemString(modules
, name
);
2069 if (result
!= NULL
) {
2077 /* check the import lock
2078 * me might be -1 but I ignore the error here, the lock function
2079 * takes care of the problem */
2080 me
= PyThread_get_thread_ident();
2081 if (import_lock_thread
== -1 || import_lock_thread
== me
) {
2082 /* no thread or me is holding the lock */
2083 return PyImport_ImportModule(name
);
2086 PyErr_Format(PyExc_ImportError
,
2087 "Failed to import %.200s because the import lock"
2088 "is held by another thread.",
2093 return PyImport_ImportModule(name
);
2097 /* Forward declarations for helper routines */
2098 static PyObject
*get_parent(PyObject
*globals
, char *buf
,
2099 Py_ssize_t
*p_buflen
, int level
);
2100 static PyObject
*load_next(PyObject
*mod
, PyObject
*altmod
,
2101 char **p_name
, char *buf
, Py_ssize_t
*p_buflen
);
2102 static int mark_miss(char *name
);
2103 static int ensure_fromlist(PyObject
*mod
, PyObject
*fromlist
,
2104 char *buf
, Py_ssize_t buflen
, int recursive
);
2105 static PyObject
* import_submodule(PyObject
*mod
, char *name
, char *fullname
);
2107 /* The Magnum Opus of dotted-name import :-) */
2110 import_module_level(char *name
, PyObject
*globals
, PyObject
*locals
,
2111 PyObject
*fromlist
, int level
)
2113 char buf
[MAXPATHLEN
+1];
2114 Py_ssize_t buflen
= 0;
2115 PyObject
*parent
, *head
, *next
, *tail
;
2117 if (strchr(name
, '/') != NULL
2119 || strchr(name
, '\\') != NULL
2122 PyErr_SetString(PyExc_ImportError
,
2123 "Import by filename is not supported.");
2127 parent
= get_parent(globals
, buf
, &buflen
, level
);
2131 head
= load_next(parent
, Py_None
, &name
, buf
, &buflen
);
2138 next
= load_next(tail
, tail
, &name
, buf
, &buflen
);
2146 if (tail
== Py_None
) {
2147 /* If tail is Py_None, both get_parent and load_next found
2148 an empty module name: someone called __import__("") or
2149 doctored faulty bytecode */
2152 PyErr_SetString(PyExc_ValueError
,
2153 "Empty module name");
2157 if (fromlist
!= NULL
) {
2158 if (fromlist
== Py_None
|| !PyObject_IsTrue(fromlist
))
2162 if (fromlist
== NULL
) {
2168 if (!ensure_fromlist(tail
, fromlist
, buf
, buflen
, 0)) {
2177 PyImport_ImportModuleLevel(char *name
, PyObject
*globals
, PyObject
*locals
,
2178 PyObject
*fromlist
, int level
)
2182 result
= import_module_level(name
, globals
, locals
, fromlist
, level
);
2183 if (unlock_import() < 0) {
2185 PyErr_SetString(PyExc_RuntimeError
,
2186 "not holding the import lock");
2192 /* Return the package that an import is being performed in. If globals comes
2193 from the module foo.bar.bat (not itself a package), this returns the
2194 sys.modules entry for foo.bar. If globals is from a package's __init__.py,
2195 the package's entry in sys.modules is returned, as a borrowed reference.
2197 The *name* of the returned package is returned in buf, with the length of
2198 the name in *p_buflen.
2200 If globals doesn't come from a package or a module in a package, or a
2201 corresponding entry is not found in sys.modules, Py_None is returned.
2204 get_parent(PyObject
*globals
, char *buf
, Py_ssize_t
*p_buflen
, int level
)
2206 static PyObject
*namestr
= NULL
;
2207 static PyObject
*pathstr
= NULL
;
2208 static PyObject
*pkgstr
= NULL
;
2209 PyObject
*pkgname
, *modname
, *modpath
, *modules
, *parent
;
2210 int orig_level
= level
;
2212 if (globals
== NULL
|| !PyDict_Check(globals
) || !level
)
2215 if (namestr
== NULL
) {
2216 namestr
= PyString_InternFromString("__name__");
2217 if (namestr
== NULL
)
2220 if (pathstr
== NULL
) {
2221 pathstr
= PyString_InternFromString("__path__");
2222 if (pathstr
== NULL
)
2225 if (pkgstr
== NULL
) {
2226 pkgstr
= PyString_InternFromString("__package__");
2233 pkgname
= PyDict_GetItem(globals
, pkgstr
);
2235 if ((pkgname
!= NULL
) && (pkgname
!= Py_None
)) {
2236 /* __package__ is set, so use it */
2238 if (!PyString_Check(pkgname
)) {
2239 PyErr_SetString(PyExc_ValueError
,
2240 "__package__ set to non-string");
2243 len
= PyString_GET_SIZE(pkgname
);
2246 PyErr_SetString(PyExc_ValueError
,
2247 "Attempted relative import in non-package");
2252 if (len
> MAXPATHLEN
) {
2253 PyErr_SetString(PyExc_ValueError
,
2254 "Package name too long");
2257 strcpy(buf
, PyString_AS_STRING(pkgname
));
2259 /* __package__ not set, so figure it out and set it */
2260 modname
= PyDict_GetItem(globals
, namestr
);
2261 if (modname
== NULL
|| !PyString_Check(modname
))
2264 modpath
= PyDict_GetItem(globals
, pathstr
);
2265 if (modpath
!= NULL
) {
2266 /* __path__ is set, so modname is already the package name */
2267 Py_ssize_t len
= PyString_GET_SIZE(modname
);
2269 if (len
> MAXPATHLEN
) {
2270 PyErr_SetString(PyExc_ValueError
,
2271 "Module name too long");
2274 strcpy(buf
, PyString_AS_STRING(modname
));
2275 error
= PyDict_SetItem(globals
, pkgstr
, modname
);
2277 PyErr_SetString(PyExc_ValueError
,
2278 "Could not set __package__");
2282 /* Normal module, so work out the package name if any */
2283 char *start
= PyString_AS_STRING(modname
);
2284 char *lastdot
= strrchr(start
, '.');
2287 if (lastdot
== NULL
&& level
> 0) {
2288 PyErr_SetString(PyExc_ValueError
,
2289 "Attempted relative import in non-package");
2292 if (lastdot
== NULL
) {
2293 error
= PyDict_SetItem(globals
, pkgstr
, Py_None
);
2295 PyErr_SetString(PyExc_ValueError
,
2296 "Could not set __package__");
2301 len
= lastdot
- start
;
2302 if (len
>= MAXPATHLEN
) {
2303 PyErr_SetString(PyExc_ValueError
,
2304 "Module name too long");
2307 strncpy(buf
, start
, len
);
2309 pkgname
= PyString_FromString(buf
);
2310 if (pkgname
== NULL
) {
2313 error
= PyDict_SetItem(globals
, pkgstr
, pkgname
);
2316 PyErr_SetString(PyExc_ValueError
,
2317 "Could not set __package__");
2322 while (--level
> 0) {
2323 char *dot
= strrchr(buf
, '.');
2325 PyErr_SetString(PyExc_ValueError
,
2326 "Attempted relative import beyond "
2327 "toplevel package");
2332 *p_buflen
= strlen(buf
);
2334 modules
= PyImport_GetModuleDict();
2335 parent
= PyDict_GetItemString(modules
, buf
);
2336 if (parent
== NULL
) {
2337 if (orig_level
< 1) {
2338 PyObject
*err_msg
= PyString_FromFormat(
2339 "Parent module '%.200s' not found "
2340 "while handling absolute import", buf
);
2341 if (err_msg
== NULL
) {
2344 if (!PyErr_WarnEx(PyExc_RuntimeWarning
,
2345 PyString_AsString(err_msg
), 1)) {
2352 PyErr_Format(PyExc_SystemError
,
2353 "Parent module '%.200s' not loaded, "
2354 "cannot perform relative import", buf
);
2358 /* We expect, but can't guarantee, if parent != None, that:
2359 - parent.__name__ == buf
2360 - parent.__dict__ is globals
2361 If this is violated... Who cares? */
2364 /* altmod is either None or same as mod */
2366 load_next(PyObject
*mod
, PyObject
*altmod
, char **p_name
, char *buf
,
2367 Py_ssize_t
*p_buflen
)
2369 char *name
= *p_name
;
2370 char *dot
= strchr(name
, '.');
2375 if (strlen(name
) == 0) {
2376 /* completely empty module name should only happen in
2377 'from . import' (or '__import__("")')*/
2392 PyErr_SetString(PyExc_ValueError
,
2393 "Empty module name");
2397 p
= buf
+ *p_buflen
;
2400 if (p
+len
-buf
>= MAXPATHLEN
) {
2401 PyErr_SetString(PyExc_ValueError
,
2402 "Module name too long");
2405 strncpy(p
, name
, len
);
2407 *p_buflen
= p
+len
-buf
;
2409 result
= import_submodule(mod
, p
, buf
);
2410 if (result
== Py_None
&& altmod
!= mod
) {
2412 /* Here, altmod must be None and mod must not be None */
2413 result
= import_submodule(altmod
, p
, p
);
2414 if (result
!= NULL
&& result
!= Py_None
) {
2415 if (mark_miss(buf
) != 0) {
2419 strncpy(buf
, name
, len
);
2427 if (result
== Py_None
) {
2429 PyErr_Format(PyExc_ImportError
,
2430 "No module named %.200s", name
);
2438 mark_miss(char *name
)
2440 PyObject
*modules
= PyImport_GetModuleDict();
2441 return PyDict_SetItemString(modules
, name
, Py_None
);
2445 ensure_fromlist(PyObject
*mod
, PyObject
*fromlist
, char *buf
, Py_ssize_t buflen
,
2450 if (!PyObject_HasAttrString(mod
, "__path__"))
2453 for (i
= 0; ; i
++) {
2454 PyObject
*item
= PySequence_GetItem(fromlist
, i
);
2457 if (PyErr_ExceptionMatches(PyExc_IndexError
)) {
2463 if (!PyString_Check(item
)) {
2464 PyErr_SetString(PyExc_TypeError
,
2465 "Item in ``from list'' not a string");
2469 if (PyString_AS_STRING(item
)[0] == '*') {
2472 /* See if the package defines __all__ */
2474 continue; /* Avoid endless recursion */
2475 all
= PyObject_GetAttrString(mod
, "__all__");
2479 int ret
= ensure_fromlist(mod
, all
, buf
, buflen
, 1);
2486 hasit
= PyObject_HasAttr(mod
, item
);
2488 char *subname
= PyString_AS_STRING(item
);
2491 if (buflen
+ strlen(subname
) >= MAXPATHLEN
) {
2492 PyErr_SetString(PyExc_ValueError
,
2493 "Module name too long");
2500 submod
= import_submodule(mod
, subname
, buf
);
2502 if (submod
== NULL
) {
2514 add_submodule(PyObject
*mod
, PyObject
*submod
, char *fullname
, char *subname
,
2519 /* Irrespective of the success of this load, make a
2520 reference to it in the parent package module. A copy gets
2521 saved in the modules dictionary under the full name, so get a
2522 reference from there, if need be. (The exception is when the
2523 load failed with a SyntaxError -- then there's no trace in
2524 sys.modules. In that case, of course, do nothing extra.) */
2525 if (submod
== NULL
) {
2526 submod
= PyDict_GetItemString(modules
, fullname
);
2530 if (PyModule_Check(mod
)) {
2531 /* We can't use setattr here since it can give a
2532 * spurious warning if the submodule name shadows a
2534 PyObject
*dict
= PyModule_GetDict(mod
);
2537 if (PyDict_SetItemString(dict
, subname
, submod
) < 0)
2541 if (PyObject_SetAttrString(mod
, subname
, submod
) < 0)
2548 import_submodule(PyObject
*mod
, char *subname
, char *fullname
)
2550 PyObject
*modules
= PyImport_GetModuleDict();
2554 if mod == None: subname == fullname
2555 else: mod.__name__ + "." + subname == fullname
2558 if ((m
= PyDict_GetItemString(modules
, fullname
)) != NULL
) {
2562 PyObject
*path
, *loader
= NULL
;
2563 char buf
[MAXPATHLEN
+1];
2564 struct filedescr
*fdp
;
2570 path
= PyObject_GetAttrString(mod
, "__path__");
2579 fdp
= find_module(fullname
, subname
, path
, buf
, MAXPATHLEN
+1,
2583 if (!PyErr_ExceptionMatches(PyExc_ImportError
))
2589 m
= load_module(fullname
, fp
, buf
, fdp
->type
, loader
);
2593 if (!add_submodule(mod
, m
, fullname
, subname
, modules
)) {
2603 /* Re-import a module of any kind and return its module object, WITH
2604 INCREMENTED REFERENCE COUNT */
2607 PyImport_ReloadModule(PyObject
*m
)
2609 PyInterpreterState
*interp
= PyThreadState_Get()->interp
;
2610 PyObject
*modules_reloading
= interp
->modules_reloading
;
2611 PyObject
*modules
= PyImport_GetModuleDict();
2612 PyObject
*path
= NULL
, *loader
= NULL
, *existing_m
= NULL
;
2613 char *name
, *subname
;
2614 char buf
[MAXPATHLEN
+1];
2615 struct filedescr
*fdp
;
2619 if (modules_reloading
== NULL
) {
2620 Py_FatalError("PyImport_ReloadModule: "
2621 "no modules_reloading dictionary!");
2625 if (m
== NULL
|| !PyModule_Check(m
)) {
2626 PyErr_SetString(PyExc_TypeError
,
2627 "reload() argument must be module");
2630 name
= PyModule_GetName(m
);
2633 if (m
!= PyDict_GetItemString(modules
, name
)) {
2634 PyErr_Format(PyExc_ImportError
,
2635 "reload(): module %.200s not in sys.modules",
2639 existing_m
= PyDict_GetItemString(modules_reloading
, name
);
2640 if (existing_m
!= NULL
) {
2641 /* Due to a recursive reload, this module is already
2643 Py_INCREF(existing_m
);
2646 if (PyDict_SetItemString(modules_reloading
, name
, m
) < 0)
2649 subname
= strrchr(name
, '.');
2650 if (subname
== NULL
)
2653 PyObject
*parentname
, *parent
;
2654 parentname
= PyString_FromStringAndSize(name
, (subname
-name
));
2655 if (parentname
== NULL
) {
2656 imp_modules_reloading_clear();
2659 parent
= PyDict_GetItem(modules
, parentname
);
2660 if (parent
== NULL
) {
2661 PyErr_Format(PyExc_ImportError
,
2662 "reload(): parent %.200s not in sys.modules",
2663 PyString_AS_STRING(parentname
));
2664 Py_DECREF(parentname
);
2665 imp_modules_reloading_clear();
2668 Py_DECREF(parentname
);
2670 path
= PyObject_GetAttrString(parent
, "__path__");
2675 fdp
= find_module(name
, subname
, path
, buf
, MAXPATHLEN
+1, &fp
, &loader
);
2680 imp_modules_reloading_clear();
2684 newm
= load_module(name
, fp
, buf
, fdp
->type
, loader
);
2690 /* load_module probably removed name from modules because of
2691 * the error. Put back the original module object. We're
2692 * going to return NULL in this case regardless of whether
2693 * replacing name succeeds, so the return value is ignored.
2695 PyDict_SetItemString(modules
, name
, m
);
2697 imp_modules_reloading_clear();
2702 /* Higher-level import emulator which emulates the "import" statement
2703 more accurately -- it invokes the __import__() function from the
2704 builtins of the current globals. This means that the import is
2705 done using whatever import hooks are installed in the current
2706 environment, e.g. by "rexec".
2707 A dummy list ["__doc__"] is passed as the 4th argument so that
2708 e.g. PyImport_Import(PyString_FromString("win32com.client.gencache"))
2709 will return <module "gencache"> instead of <module "win32com">. */
2712 PyImport_Import(PyObject
*module_name
)
2714 static PyObject
*silly_list
= NULL
;
2715 static PyObject
*builtins_str
= NULL
;
2716 static PyObject
*import_str
= NULL
;
2717 PyObject
*globals
= NULL
;
2718 PyObject
*import
= NULL
;
2719 PyObject
*builtins
= NULL
;
2722 /* Initialize constant string objects */
2723 if (silly_list
== NULL
) {
2724 import_str
= PyString_InternFromString("__import__");
2725 if (import_str
== NULL
)
2727 builtins_str
= PyString_InternFromString("__builtins__");
2728 if (builtins_str
== NULL
)
2730 silly_list
= Py_BuildValue("[s]", "__doc__");
2731 if (silly_list
== NULL
)
2735 /* Get the builtins from current globals */
2736 globals
= PyEval_GetGlobals();
2737 if (globals
!= NULL
) {
2739 builtins
= PyObject_GetItem(globals
, builtins_str
);
2740 if (builtins
== NULL
)
2744 /* No globals -- use standard builtins, and fake globals */
2747 builtins
= PyImport_ImportModuleLevel("__builtin__",
2748 NULL
, NULL
, NULL
, 0);
2749 if (builtins
== NULL
)
2751 globals
= Py_BuildValue("{OO}", builtins_str
, builtins
);
2752 if (globals
== NULL
)
2756 /* Get the __import__ function from the builtins */
2757 if (PyDict_Check(builtins
)) {
2758 import
= PyObject_GetItem(builtins
, import_str
);
2760 PyErr_SetObject(PyExc_KeyError
, import_str
);
2763 import
= PyObject_GetAttr(builtins
, import_str
);
2767 /* Call the __import__ function with the proper argument list
2768 * Always use absolute import here. */
2769 r
= PyObject_CallFunction(import
, "OOOOi", module_name
, globals
,
2770 globals
, silly_list
, 0, NULL
);
2773 Py_XDECREF(globals
);
2774 Py_XDECREF(builtins
);
2781 /* Module 'imp' provides Python access to the primitives used for
2786 imp_get_magic(PyObject
*self
, PyObject
*noargs
)
2790 buf
[0] = (char) ((pyc_magic
>> 0) & 0xff);
2791 buf
[1] = (char) ((pyc_magic
>> 8) & 0xff);
2792 buf
[2] = (char) ((pyc_magic
>> 16) & 0xff);
2793 buf
[3] = (char) ((pyc_magic
>> 24) & 0xff);
2795 return PyString_FromStringAndSize(buf
, 4);
2799 imp_get_suffixes(PyObject
*self
, PyObject
*noargs
)
2802 struct filedescr
*fdp
;
2804 list
= PyList_New(0);
2807 for (fdp
= _PyImport_Filetab
; fdp
->suffix
!= NULL
; fdp
++) {
2808 PyObject
*item
= Py_BuildValue("ssi",
2809 fdp
->suffix
, fdp
->mode
, fdp
->type
);
2814 if (PyList_Append(list
, item
) < 0) {
2825 call_find_module(char *name
, PyObject
*path
)
2827 extern int fclose(FILE *);
2828 PyObject
*fob
, *ret
;
2829 struct filedescr
*fdp
;
2830 char pathname
[MAXPATHLEN
+1];
2834 if (path
== Py_None
)
2836 fdp
= find_module(NULL
, name
, path
, pathname
, MAXPATHLEN
+1, &fp
, NULL
);
2840 fob
= PyFile_FromFile(fp
, pathname
, fdp
->mode
, fclose
);
2850 ret
= Py_BuildValue("Os(ssi)",
2851 fob
, pathname
, fdp
->suffix
, fdp
->mode
, fdp
->type
);
2857 imp_find_module(PyObject
*self
, PyObject
*args
)
2860 PyObject
*path
= NULL
;
2861 if (!PyArg_ParseTuple(args
, "s|O:find_module", &name
, &path
))
2863 return call_find_module(name
, path
);
2867 imp_init_builtin(PyObject
*self
, PyObject
*args
)
2872 if (!PyArg_ParseTuple(args
, "s:init_builtin", &name
))
2874 ret
= init_builtin(name
);
2881 m
= PyImport_AddModule(name
);
2887 imp_init_frozen(PyObject
*self
, PyObject
*args
)
2892 if (!PyArg_ParseTuple(args
, "s:init_frozen", &name
))
2894 ret
= PyImport_ImportFrozenModule(name
);
2901 m
= PyImport_AddModule(name
);
2907 imp_get_frozen_object(PyObject
*self
, PyObject
*args
)
2911 if (!PyArg_ParseTuple(args
, "s:get_frozen_object", &name
))
2913 return get_frozen_object(name
);
2917 imp_is_builtin(PyObject
*self
, PyObject
*args
)
2920 if (!PyArg_ParseTuple(args
, "s:is_builtin", &name
))
2922 return PyInt_FromLong(is_builtin(name
));
2926 imp_is_frozen(PyObject
*self
, PyObject
*args
)
2930 if (!PyArg_ParseTuple(args
, "s:is_frozen", &name
))
2932 p
= find_frozen(name
);
2933 return PyBool_FromLong((long) (p
== NULL
? 0 : p
->size
));
2937 get_file(char *pathname
, PyObject
*fob
, char *mode
)
2942 mode
= "r" PY_STDIOTEXTMODE
;
2943 fp
= fopen(pathname
, mode
);
2945 PyErr_SetFromErrno(PyExc_IOError
);
2948 fp
= PyFile_AsFile(fob
);
2950 PyErr_SetString(PyExc_ValueError
,
2951 "bad/closed file object");
2957 imp_load_compiled(PyObject
*self
, PyObject
*args
)
2961 PyObject
*fob
= NULL
;
2964 if (!PyArg_ParseTuple(args
, "ss|O!:load_compiled", &name
, &pathname
,
2965 &PyFile_Type
, &fob
))
2967 fp
= get_file(pathname
, fob
, "rb");
2970 m
= load_compiled_module(name
, pathname
, fp
);
2976 #ifdef HAVE_DYNAMIC_LOADING
2979 imp_load_dynamic(PyObject
*self
, PyObject
*args
)
2983 PyObject
*fob
= NULL
;
2986 if (!PyArg_ParseTuple(args
, "ss|O!:load_dynamic", &name
, &pathname
,
2987 &PyFile_Type
, &fob
))
2990 fp
= get_file(pathname
, fob
, "r");
2994 m
= _PyImport_LoadDynamicModule(name
, pathname
, fp
);
2998 #endif /* HAVE_DYNAMIC_LOADING */
3001 imp_load_source(PyObject
*self
, PyObject
*args
)
3005 PyObject
*fob
= NULL
;
3008 if (!PyArg_ParseTuple(args
, "ss|O!:load_source", &name
, &pathname
,
3009 &PyFile_Type
, &fob
))
3011 fp
= get_file(pathname
, fob
, "r");
3014 m
= load_source_module(name
, pathname
, fp
);
3021 imp_load_module(PyObject
*self
, PyObject
*args
)
3026 char *suffix
; /* Unused */
3031 if (!PyArg_ParseTuple(args
, "sOs(ssi):load_module",
3032 &name
, &fob
, &pathname
,
3033 &suffix
, &mode
, &type
))
3036 /* Mode must start with 'r' or 'U' and must not contain '+'.
3037 Implicit in this test is the assumption that the mode
3038 may contain other modifiers like 'b' or 't'. */
3040 if (!(*mode
== 'r' || *mode
== 'U') || strchr(mode
, '+')) {
3041 PyErr_Format(PyExc_ValueError
,
3042 "invalid file open mode %.200s", mode
);
3049 if (!PyFile_Check(fob
)) {
3050 PyErr_SetString(PyExc_ValueError
,
3051 "load_module arg#2 should be a file or None");
3054 fp
= get_file(pathname
, fob
, mode
);
3058 return load_module(name
, fp
, pathname
, type
, NULL
);
3062 imp_load_package(PyObject
*self
, PyObject
*args
)
3066 if (!PyArg_ParseTuple(args
, "ss:load_package", &name
, &pathname
))
3068 return load_package(name
, pathname
);
3072 imp_new_module(PyObject
*self
, PyObject
*args
)
3075 if (!PyArg_ParseTuple(args
, "s:new_module", &name
))
3077 return PyModule_New(name
);
3081 imp_reload(PyObject
*self
, PyObject
*v
)
3083 return PyImport_ReloadModule(v
);
3089 PyDoc_STRVAR(doc_imp
,
3090 "This module provides the components needed to build your own\n\
3091 __import__ function. Undocumented functions are obsolete.");
3093 PyDoc_STRVAR(doc_reload
,
3094 "reload(module) -> module\n\
3096 Reload the module. The module must have been successfully imported before.");
3098 PyDoc_STRVAR(doc_find_module
,
3099 "find_module(name, [path]) -> (file, filename, (suffix, mode, type))\n\
3100 Search for a module. If path is omitted or None, search for a\n\
3101 built-in, frozen or special module and continue search in sys.path.\n\
3102 The module name cannot contain '.'; to search for a submodule of a\n\
3103 package, pass the submodule name and the package's __path__.");
3105 PyDoc_STRVAR(doc_load_module
,
3106 "load_module(name, file, filename, (suffix, mode, type)) -> module\n\
3107 Load a module, given information returned by find_module().\n\
3108 The module name must include the full package name, if any.");
3110 PyDoc_STRVAR(doc_get_magic
,
3111 "get_magic() -> string\n\
3112 Return the magic number for .pyc or .pyo files.");
3114 PyDoc_STRVAR(doc_get_suffixes
,
3115 "get_suffixes() -> [(suffix, mode, type), ...]\n\
3116 Return a list of (suffix, mode, type) tuples describing the files\n\
3117 that find_module() looks for.");
3119 PyDoc_STRVAR(doc_new_module
,
3120 "new_module(name) -> module\n\
3121 Create a new module. Do not enter it in sys.modules.\n\
3122 The module name must include the full package name, if any.");
3124 PyDoc_STRVAR(doc_lock_held
,
3125 "lock_held() -> boolean\n\
3126 Return True if the import lock is currently held, else False.\n\
3127 On platforms without threads, return False.");
3129 PyDoc_STRVAR(doc_acquire_lock
,
3130 "acquire_lock() -> None\n\
3131 Acquires the interpreter's import lock for the current thread.\n\
3132 This lock should be used by import hooks to ensure thread-safety\n\
3133 when importing modules.\n\
3134 On platforms without threads, this function does nothing.");
3136 PyDoc_STRVAR(doc_release_lock
,
3137 "release_lock() -> None\n\
3138 Release the interpreter's import lock.\n\
3139 On platforms without threads, this function does nothing.");
3141 static PyMethodDef imp_methods
[] = {
3142 {"reload", imp_reload
, METH_O
, doc_reload
},
3143 {"find_module", imp_find_module
, METH_VARARGS
, doc_find_module
},
3144 {"get_magic", imp_get_magic
, METH_NOARGS
, doc_get_magic
},
3145 {"get_suffixes", imp_get_suffixes
, METH_NOARGS
, doc_get_suffixes
},
3146 {"load_module", imp_load_module
, METH_VARARGS
, doc_load_module
},
3147 {"new_module", imp_new_module
, METH_VARARGS
, doc_new_module
},
3148 {"lock_held", imp_lock_held
, METH_NOARGS
, doc_lock_held
},
3149 {"acquire_lock", imp_acquire_lock
, METH_NOARGS
, doc_acquire_lock
},
3150 {"release_lock", imp_release_lock
, METH_NOARGS
, doc_release_lock
},
3151 /* The rest are obsolete */
3152 {"get_frozen_object", imp_get_frozen_object
, METH_VARARGS
},
3153 {"init_builtin", imp_init_builtin
, METH_VARARGS
},
3154 {"init_frozen", imp_init_frozen
, METH_VARARGS
},
3155 {"is_builtin", imp_is_builtin
, METH_VARARGS
},
3156 {"is_frozen", imp_is_frozen
, METH_VARARGS
},
3157 {"load_compiled", imp_load_compiled
, METH_VARARGS
},
3158 #ifdef HAVE_DYNAMIC_LOADING
3159 {"load_dynamic", imp_load_dynamic
, METH_VARARGS
},
3161 {"load_package", imp_load_package
, METH_VARARGS
},
3162 {"load_source", imp_load_source
, METH_VARARGS
},
3163 {NULL
, NULL
} /* sentinel */
3167 setint(PyObject
*d
, char *name
, int value
)
3172 v
= PyInt_FromLong((long)value
);
3173 err
= PyDict_SetItemString(d
, name
, v
);
3183 NullImporter_init(NullImporter
*self
, PyObject
*args
, PyObject
*kwds
)
3188 if (!_PyArg_NoKeywords("NullImporter()", kwds
))
3191 if (!PyArg_ParseTuple(args
, "s:NullImporter",
3195 pathlen
= strlen(path
);
3197 PyErr_SetString(PyExc_ImportError
, "empty pathname");
3201 struct stat statbuf
;
3204 rv
= stat(path
, &statbuf
);
3206 /* MS Windows stat() chokes on paths like C:\path\. Try to
3207 * recover *one* time by stripping off a trailing slash or
3208 * backslash. http://bugs.python.org/issue1293
3210 if (rv
!= 0 && pathlen
<= MAXPATHLEN
&&
3211 (path
[pathlen
-1] == '/' || path
[pathlen
-1] == '\\')) {
3212 char mangled
[MAXPATHLEN
+1];
3214 strcpy(mangled
, path
);
3215 mangled
[pathlen
-1] = '\0';
3216 rv
= stat(mangled
, &statbuf
);
3221 if (S_ISDIR(statbuf
.st_mode
)) {
3222 /* it's a directory */
3223 PyErr_SetString(PyExc_ImportError
,
3224 "existing directory");
3229 if (object_exists(path
)) {
3232 /* it's a directory */
3233 PyErr_SetString(PyExc_ImportError
,
3234 "existing directory");
3244 NullImporter_find_module(NullImporter
*self
, PyObject
*args
)
3249 static PyMethodDef NullImporter_methods
[] = {
3250 {"find_module", (PyCFunction
)NullImporter_find_module
, METH_VARARGS
,
3251 "Always return None"
3253 {NULL
} /* Sentinel */
3257 PyTypeObject PyNullImporter_Type
= {
3258 PyVarObject_HEAD_INIT(NULL
, 0)
3259 "imp.NullImporter", /*tp_name*/
3260 sizeof(NullImporter
), /*tp_basicsize*/
3269 0, /*tp_as_sequence*/
3270 0, /*tp_as_mapping*/
3277 Py_TPFLAGS_DEFAULT
, /*tp_flags*/
3278 "Null importer object", /* tp_doc */
3279 0, /* tp_traverse */
3281 0, /* tp_richcompare */
3282 0, /* tp_weaklistoffset */
3284 0, /* tp_iternext */
3285 NullImporter_methods
, /* tp_methods */
3290 0, /* tp_descr_get */
3291 0, /* tp_descr_set */
3292 0, /* tp_dictoffset */
3293 (initproc
)NullImporter_init
, /* tp_init */
3295 PyType_GenericNew
/* tp_new */
3304 if (PyType_Ready(&PyNullImporter_Type
) < 0)
3307 m
= Py_InitModule4("imp", imp_methods
, doc_imp
,
3308 NULL
, PYTHON_API_VERSION
);
3311 d
= PyModule_GetDict(m
);
3315 if (setint(d
, "SEARCH_ERROR", SEARCH_ERROR
) < 0) goto failure
;
3316 if (setint(d
, "PY_SOURCE", PY_SOURCE
) < 0) goto failure
;
3317 if (setint(d
, "PY_COMPILED", PY_COMPILED
) < 0) goto failure
;
3318 if (setint(d
, "C_EXTENSION", C_EXTENSION
) < 0) goto failure
;
3319 if (setint(d
, "PY_RESOURCE", PY_RESOURCE
) < 0) goto failure
;
3320 if (setint(d
, "PKG_DIRECTORY", PKG_DIRECTORY
) < 0) goto failure
;
3321 if (setint(d
, "C_BUILTIN", C_BUILTIN
) < 0) goto failure
;
3322 if (setint(d
, "PY_FROZEN", PY_FROZEN
) < 0) goto failure
;
3323 if (setint(d
, "PY_CODERESOURCE", PY_CODERESOURCE
) < 0) goto failure
;
3324 if (setint(d
, "IMP_HOOK", IMP_HOOK
) < 0) goto failure
;
3326 Py_INCREF(&PyNullImporter_Type
);
3327 PyModule_AddObject(m
, "NullImporter", (PyObject
*)&PyNullImporter_Type
);
3333 /* API for embedding applications that want to add their own entries
3334 to the table of built-in modules. This should normally be called
3335 *before* Py_Initialize(). When the table resize fails, -1 is
3336 returned and the existing table is unchanged.
3338 After a similar function by Just van Rossum. */
3341 PyImport_ExtendInittab(struct _inittab
*newtab
)
3343 static struct _inittab
*our_copy
= NULL
;
3347 /* Count the number of entries in both tables */
3348 for (n
= 0; newtab
[n
].name
!= NULL
; n
++)
3351 return 0; /* Nothing to do */
3352 for (i
= 0; PyImport_Inittab
[i
].name
!= NULL
; i
++)
3355 /* Allocate new memory for the combined table */
3357 PyMem_RESIZE(p
, struct _inittab
, i
+n
+1);
3361 /* Copy the tables into the new memory */
3362 if (our_copy
!= PyImport_Inittab
)
3363 memcpy(p
, PyImport_Inittab
, (i
+1) * sizeof(struct _inittab
));
3364 PyImport_Inittab
= our_copy
= p
;
3365 memcpy(p
+i
, newtab
, (n
+1) * sizeof(struct _inittab
));
3370 /* Shorthand to add a single entry given a name and a function */
3373 PyImport_AppendInittab(char *name
, void (*initfunc
)(void))
3375 struct _inittab newtab
[2];
3377 memset(newtab
, '\0', sizeof newtab
);
3379 newtab
[0].name
= name
;
3380 newtab
[0].initfunc
= initfunc
;
3382 return PyImport_ExtendInittab(newtab
);