Avoid using import and eval #2043

c-bata · 2019-05-20T14:08:20Z

See https://docs.python.org/3/library/functions.html#__import__

$ python -V
Python 3.7.2
$ gunicorn examples.echo:app
[2019-05-20 23:09:16 +0900] [26697] [INFO] Starting gunicorn 19.9.0
[2019-05-20 23:09:16 +0900] [26697] [INFO] Listening at: http://127.0.0.1:8000 (26697)
[2019-05-20 23:09:16 +0900] [26697] [INFO] Using worker: sync
[2019-05-20 23:09:16 +0900] [26700] [INFO] Booting worker with pid: 26700

c-bata · 2019-05-20T14:09:03Z

gunicorn/util.py

+        else:
+            __import__(module)
+            mod = sys.modules[module]
+    except (ImportError, ModuleNotFoundError):


Error message when specified filepath to python file.

$ python -V Python 3.7.2 $ gunicorn examples/echo.py:app [2019-05-20 23:21:06 +0900] [27295] [INFO] Starting gunicorn 19.9.0 [2019-05-20 23:21:06 +0900] [27295] [INFO] Listening at: http://127.0.0.1:8000 (27295) [2019-05-20 23:21:06 +0900] [27295] [INFO] Using worker: sync [2019-05-20 23:21:06 +0900] [27298] [INFO] Booting worker with pid: 27298 [2019-05-20 23:21:06 +0900] [27298] [ERROR] Exception in worker process Traceback (most recent call last): File "/Users/c-bata/src/github.com/benoitc/gunicorn/gunicorn/util.py", line 368, in import_app mod = importlib.import_module(module) File "/usr/local/Cellar/python/3.7.2_2/Frameworks/Python.framework/Versions/3.7/lib/python3.7/importlib/__init__.py", line 127, in import_module return _bootstrap._gcd_import(name[level:], package, level) File "<frozen importlib._bootstrap>", line 1006, in _gcd_import File "<frozen importlib._bootstrap>", line 983, in _find_and_load File "<frozen importlib._bootstrap>", line 953, in _find_and_load_unlocked File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed File "<frozen importlib._bootstrap>", line 1006, in _gcd_import File "<frozen importlib._bootstrap>", line 983, in _find_and_load File "<frozen importlib._bootstrap>", line 965, in _find_and_load_unlocked ModuleNotFoundError: No module named 'examples/echo' During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/Users/c-bata/src/github.com/benoitc/gunicorn/gunicorn/arbiter.py", line 585, in spawn_worker worker.init_process() File "/Users/c-bata/src/github.com/benoitc/gunicorn/gunicorn/workers/base.py", line 133, in init_process self.load_wsgi() File "/Users/c-bata/src/github.com/benoitc/gunicorn/gunicorn/workers/base.py", line 142, in load_wsgi self.wsgi = self.app.wsgi() File "/Users/c-bata/src/github.com/benoitc/gunicorn/gunicorn/app/base.py", line 65, in wsgi self.callable = self.load() File "/Users/c-bata/src/github.com/benoitc/gunicorn/gunicorn/app/wsgiapp.py", line 49, in load return self.load_wsgiapp() File "/Users/c-bata/src/github.com/benoitc/gunicorn/gunicorn/app/wsgiapp.py", line 39, in load_wsgiapp return util.import_app(self.app_uri) File "/Users/c-bata/src/github.com/benoitc/gunicorn/gunicorn/util.py", line 372, in import_app raise ModuleNotFoundError(msg % (module.rsplit(".", 1)[0], obj)) ModuleNotFoundError: Failed to find application, did you mean 'examples/echo:app'? [2019-05-20 23:21:06 +0900] [27298] [INFO] Worker exiting (pid: 27298) [2019-05-20 23:21:07 +0900] [27295] [INFO] Shutting down: Master [2019-05-20 23:21:07 +0900] [27295] [INFO] Reason: Worker failed to boot.

c-bata · 2019-05-20T14:09:39Z

gunicorn/util.py

-        __import__(module)
-    except ImportError:
+        if importlib:
+            mod = importlib.import_module(module)


$ python -V Python 3.7.2 $ gunicorn examples.echo:app [2019-05-20 23:09:16 +0900] [26697] [INFO] Starting gunicorn 19.9.0 [2019-05-20 23:09:16 +0900] [26697] [INFO] Listening at: http://127.0.0.1:8000 (26697) [2019-05-20 23:09:16 +0900] [26697] [INFO] Using worker: sync [2019-05-20 23:09:16 +0900] [26700] [INFO] Booting worker with pid: 26700

c-bata · 2019-05-20T14:20:29Z

gunicorn/util.py

-        app = eval(obj, vars(mod))
-    except NameError:
+        app = getattr(mod, obj)
+    except AttributeError:


Error message when failing to find application object.

$ python -V Python 3.7.2 $ gunicorn examples.echo:foo [2019-05-20 23:19:04 +0900] [27282] [INFO] Starting gunicorn 19.9.0 [2019-05-20 23:19:04 +0900] [27282] [INFO] Listening at: http://127.0.0.1:8000 (27282) [2019-05-20 23:19:04 +0900] [27282] [INFO] Using worker: sync [2019-05-20 23:19:04 +0900] [27285] [INFO] Booting worker with pid: 27285 Failed to find application object 'foo' in 'examples.echo' [2019-05-20 23:19:04 +0900] [27285] [INFO] Worker exiting (pid: 27285) [2019-05-20 23:19:05 +0900] [27282] [INFO] Shutting down: Master [2019-05-20 23:19:05 +0900] [27282] [INFO] Reason: App failed to load.

tilgovi

I believe this looks good! Thanks!

berkerpeksag · 2019-05-22T17:36:58Z

gunicorn/util.py

    except ImportError:
+        # ModuleNotFoundError (a subclass of ImportError) is new in version 3.6.


This comment can be dropped.

I just wanted to tell ModuleNotFound exception is also handled in this clause. But It's ok to remove this comment. Should I remove this?

It's probably not necessary to have the comment. There's only one statement in the try clause, so even if the error is more general than needed on Python 3.6 there's not much need to justify it.

I see. I've just removed this line.

berkerpeksag · 2019-05-22T19:07:16Z

Nice cleanup, thanks!

c-bata commented May 20, 2019

View reviewed changes

c-bata added 2 commits May 20, 2019 23:17

Avoid using __import__, use importlib instead

9b5c1f9

Avoid using eval, use getattr instead

225a0b6

c-bata force-pushed the use-importlib branch from 135d77c to 225a0b6 Compare May 20, 2019 14:18

c-bata changed the title ~~Avoid using __import__, use importlib instead~~ Avoid using __import__ and eval May 20, 2019

c-bata commented May 20, 2019

View reviewed changes

Handle ImportError

1465639

tilgovi approved these changes May 22, 2019

View reviewed changes

berkerpeksag reviewed May 22, 2019

View reviewed changes

c-bata added 2 commits May 23, 2019 04:01

Remove unnecessary comment

360b83f

Merge branch 'master' into use-importlib

baf0a76

berkerpeksag approved these changes May 22, 2019

View reviewed changes

berkerpeksag merged commit 3701ad9 into benoitc:master May 22, 2019

c-bata deleted the use-importlib branch May 22, 2019 19:27

This was referenced May 26, 2019

Remove execfile_, use SourceFileLoader instead #2046

Merged

Remove util.import_module #2047

Merged

benoitc mentioned this pull request Nov 10, 2019

v20 issue: Failed to find application object 'create_app()' in 'app' #2159

Closed

rbwinslow pushed a commit to rbwinslow/gunicorn that referenced this pull request Jun 1, 2020

Use importlib instead of __import__ and eval (benoitc#2043)

5e9e071

pajod mentioned this pull request Apr 22, 2024

Display NameError on import #1821

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Avoid using import and eval #2043

Avoid using import and eval #2043

c-bata commented May 20, 2019 •

edited

Loading

c-bata May 20, 2019 •

edited

Loading

c-bata May 20, 2019

c-bata May 20, 2019 •

edited

Loading

tilgovi left a comment

berkerpeksag May 22, 2019

c-bata May 22, 2019 •

edited

Loading

tilgovi May 22, 2019

c-bata May 22, 2019

berkerpeksag commented May 22, 2019

		except ImportError:
		# ModuleNotFoundError (a subclass of ImportError) is new in version 3.6.

Avoid using __import__ and eval #2043

Avoid using __import__ and eval #2043

Conversation

c-bata commented May 20, 2019 • edited Loading

c-bata May 20, 2019 • edited Loading

Choose a reason for hiding this comment

c-bata May 20, 2019

Choose a reason for hiding this comment

c-bata May 20, 2019 • edited Loading

Choose a reason for hiding this comment

tilgovi left a comment

Choose a reason for hiding this comment

berkerpeksag May 22, 2019

Choose a reason for hiding this comment

c-bata May 22, 2019 • edited Loading

Choose a reason for hiding this comment

tilgovi May 22, 2019

Choose a reason for hiding this comment

c-bata May 22, 2019

Choose a reason for hiding this comment

berkerpeksag commented May 22, 2019

Avoid using import and eval #2043

Avoid using import and eval #2043

c-bata commented May 20, 2019 •

edited

Loading

c-bata May 20, 2019 •

edited

Loading

c-bata May 20, 2019 •

edited

Loading

c-bata May 22, 2019 •

edited

Loading