Checking module name inside 'except ImportError'

Question

try:
   import MySQLdb
   # some action
except ImportError as err:
   # fallback code

PyCharm gives a code inspection warning on that:

'MySQLdb' in try block with 'except ImportError' should also be defined in except block

This inspection detects names that should resolve but don't. Due to dynamic dispatch and duck typing, this is possible in a limited but useful number of cases. Top-level and class-level items are supported better than instance items.

Ok, I thought the warning is reasonable, because the fallback code assumes that 'MySQLdb' is not installed, while it could be some different error that just raised ImportError. So I used something like:

try:
   import MySQLdb
   # some action
except ImportError as err:
   if "MySQLdb" in repr(err):
       # fallback code
   else:
       raise

The PyCharm alert is still exists, but It could be just a PyCharm issue (google shows issues with such inspections)

Questions:

1. Is it really worth checking for name when you "except ImportError"? Even in simple cases (no some action after import MySQLdb)?

2. If it worth checking, Is the above example the right way to do it? If no - what is the right way?

P.S. MySQLdb is just an example of a module that could be absent in the system.

Answer 1

I think you misunderstood the warning, if you do not define a variable called MySQLdb in the except block then later on when you try to use the module you would get a NameError:

try:
    import foo
except ImportError:
    pass

foo.say_foo() #foo may or may not be defined at this point!

If the module is only used in the try: clause then this is no issue. But for the more general case the checker expects you to define the variable in the except block:

try:
    import foo
except ImportError:
    foo = None  #now foo always exists

if foo: #if the module is present
    foo.say_foo()
else:
    print("foo") #backup use

If the module is only used in the try block then you can indicate to the checker (and yourself) that you can't use the module later by deleting it from the namespace:

try:
    import foo
except ImportError:
    pass
else:
    # if it was able to import use it then get rid of the local variable
    foo.do_thing()
    del foo #optional module should not be relied on outside 
 

# now foo never exists here, checker is happy.

Answer 2

In Python 3.3+, an ImportError has the attribute name that tells the name of the module whose import failed. Then of course MySQLdb would hint that you're stuck with Python 2.

Answer 3

One method of getting the name, already mentioned is using the name attribute:

try:
    import pty
except ImportError as e:
    print(e.name)

However, it is important to note that you might not get the module name you started with; namely, running the above on Windows gives you termios as the output, not pty.

To maintain compatibility with python 2.7 (for those who haven't made the switch, you're on the clock)

try:
    import pty
except ImportError as e:
    print(e.args[0].rsplit(' ',1)[-1])  # `msg` attribute is `message` on python2...stick with args

# prints the same result: termios

---

Some bonus tidbits:

• Python 3.6 was released around the end of 2016. Since it's 2019+, you can opt for the clearer exception ModuleNotFoundError:

  A subclass of ImportError which is raised by import when a module could not be located. It is also raised when None is found in sys.modules.

• If you are using Python 3.3+, don't forget about the path attribute (in addition to the name already mentioned), which gives the path to any file that raised the exception (only useful in more complex cases -- in simple examples like the one I gave path will return None.)

Answer 4

Try this:

try:
  import libname
except ImportError as e:
       e = e[0][16:]
       print("\n[!] Error: Please Install Module Name:[ {} ] And Try Again !!!".format(e))
       exit(1)

Output:

[!] Error: Please Install Module Name:[ libname ] And Try Again !!!