Skip to content

Use 'importlib' module in lieu of deprecated 'imp' module#6832

Merged
jleveque merged 1 commit intosonic-net:masterfrom
jleveque:replace_imp_importlib
Feb 25, 2021
Merged

Use 'importlib' module in lieu of deprecated 'imp' module#6832
jleveque merged 1 commit intosonic-net:masterfrom
jleveque:replace_imp_importlib

Conversation

@jleveque
Copy link
Contributor

@jleveque jleveque commented Feb 20, 2021

What I did

Migrate from using the imp module to using the importlib module. As of Python 3, the imp module has been deprecated in favor of the importlib module.

How I did it

Eliminate all importing of the imp module, and replace all which were actually used with imports of the importlib module, and modify all affected code appropriately.

How to verify it

  • Ensure determine-reboot-cause_test.py unit tests pass
  • Ensure procdockerstatsd_test.py unit tests pass
  • Ensure sonic_py_common.DaemonBase.load_platform_util() still functions correctly with old plugins (which are deprecated and will be removed soon anyway)

Which release branch to backport (provide reason below if selected)

  • 201811
  • 201911
  • 202006
  • 202012

@jleveque jleveque requested a review from lguohan as a code owner February 20, 2021 04:18
@jleveque jleveque self-assigned this Feb 20, 2021
@jleveque jleveque merged commit 72c4203 into sonic-net:master Feb 25, 2021
@jleveque jleveque deleted the replace_imp_importlib branch February 25, 2021 00:41
@jleveque jleveque mentioned this pull request Mar 1, 2021
Merged
4 tasks
jleveque added a commit that referenced this pull request Mar 3, 2021
@jleveque
Fix Python 3 'importlib' bug; Add support for Python 2 back in sonic-…
980a024 
…py-common (#6933)

Fix a strange bug introduced by #6832 which would only occur in environments with both Python 2 and Python 3 installed (e.g., the PMon container). Error messages such as the following would be seen:

```
ERR pmon#ledd[29]: Failed to load ledutil: module 'importlib' has no attribute 'machinery'
```

This is very odd, and it seems like the Python 2 version of importlib, which is basically just a stub, is taking precedence over the Python 3 version. I found that this occurs when calling `import importlib`. However, calling `import importlib.machinery` and `import importlib.util` causes the proper package to be referenced, and the `machinery` and `util` modules are loaded successfully. This is how it is specified in examples in the official documentation, however there is nothing mentioned regarding that it *should* be done this way or that `import importlib` is unreliable.

Also, since sonic-py-common is still used in environments with Python 2 installed we should maintain support for both Python 2 and 3 until we completely deprecate Python 2, so I have added this back in.
yxieca pushed a commit that referenced this pull request Mar 4, 2021
@jleveque @yxieca
Use 'importlib' module in lieu of deprecated 'imp' module (#6832)
40e4457 
Migrate from using the `imp` module to using the `importlib` module. As of Python 3, the `imp` module has been deprecated in favor of the `importlib` module.
yxieca pushed a commit that referenced this pull request Mar 4, 2021
@jleveque @yxieca
Fix Python 3 'importlib' bug; Add support for Python 2 back in sonic-…
2e1e7e0 
…py-common (#6933)

Fix a strange bug introduced by #6832 which would only occur in environments with both Python 2 and Python 3 installed (e.g., the PMon container). Error messages such as the following would be seen:

```
ERR pmon#ledd[29]: Failed to load ledutil: module 'importlib' has no attribute 'machinery'
```

This is very odd, and it seems like the Python 2 version of importlib, which is basically just a stub, is taking precedence over the Python 3 version. I found that this occurs when calling `import importlib`. However, calling `import importlib.machinery` and `import importlib.util` causes the proper package to be referenced, and the `machinery` and `util` modules are loaded successfully. This is how it is specified in examples in the official documentation, however there is nothing mentioned regarding that it *should* be done this way or that `import importlib` is unreliable.

Also, since sonic-py-common is still used in environments with Python 2 installed we should maintain support for both Python 2 and 3 until we completely deprecate Python 2, so I have added this back in.
carl-nokia pushed a commit to carl-nokia/sonic-buildimage that referenced this pull request Aug 7, 2021
@jleveque
Use 'importlib' module in lieu of deprecated 'imp' module (sonic-net#…
9bfac97 
…6832)

Migrate from using the `imp` module to using the `importlib` module. As of Python 3, the `imp` module has been deprecated in favor of the `importlib` module.
carl-nokia pushed a commit to carl-nokia/sonic-buildimage that referenced this pull request Aug 7, 2021
@jleveque
Fix Python 3 'importlib' bug; Add support for Python 2 back in sonic-…
38f5833 
…py-common (sonic-net#6933)

Fix a strange bug introduced by sonic-net#6832 which would only occur in environments with both Python 2 and Python 3 installed (e.g., the PMon container). Error messages such as the following would be seen:

```
ERR pmon#ledd[29]: Failed to load ledutil: module 'importlib' has no attribute 'machinery'
```

This is very odd, and it seems like the Python 2 version of importlib, which is basically just a stub, is taking precedence over the Python 3 version. I found that this occurs when calling `import importlib`. However, calling `import importlib.machinery` and `import importlib.util` causes the proper package to be referenced, and the `machinery` and `util` modules are loaded successfully. This is how it is specified in examples in the official documentation, however there is nothing mentioned regarding that it *should* be done this way or that `import importlib` is unreliable.

Also, since sonic-py-common is still used in environments with Python 2 installed we should maintain support for both Python 2 and 3 until we completely deprecate Python 2, so I have added this back in.
lolyu pushed a commit to lolyu/sonic-buildimage that referenced this pull request Sep 13, 2021
@jleveque @yxieca
Use 'importlib' module in lieu of deprecated 'imp' module (sonic-net#…
231aa6b 
…6832)

Migrate from using the `imp` module to using the `importlib` module. As of Python 3, the `imp` module has been deprecated in favor of the `importlib` module.
lolyu pushed a commit to lolyu/sonic-buildimage that referenced this pull request Sep 13, 2021
@jleveque @yxieca
Fix Python 3 'importlib' bug; Add support for Python 2 back in sonic-…
71fe402 
…py-common (sonic-net#6933)

Fix a strange bug introduced by sonic-net#6832 which would only occur in environments with both Python 2 and Python 3 installed (e.g., the PMon container). Error messages such as the following would be seen:

```
ERR pmon#ledd[29]: Failed to load ledutil: module 'importlib' has no attribute 'machinery'
```

This is very odd, and it seems like the Python 2 version of importlib, which is basically just a stub, is taking precedence over the Python 3 version. I found that this occurs when calling `import importlib`. However, calling `import importlib.machinery` and `import importlib.util` causes the proper package to be referenced, and the `machinery` and `util` modules are loaded successfully. This is how it is specified in examples in the official documentation, however there is nothing mentioned regarding that it *should* be done this way or that `import importlib` is unreliable.

Also, since sonic-py-common is still used in environments with Python 2 installed we should maintain support for both Python 2 and 3 until we completely deprecate Python 2, so I have added this back in.
ganglyu pushed a commit to sonic-net/sonic-host-services that referenced this pull request Jul 12, 2022
@jleveque
Fix Python 3 'importlib' bug; Add support for Python 2 back in sonic-…
4693558 
…py-common (#6933)

Fix a strange bug introduced by sonic-net/sonic-buildimage#6832 which would only occur in environments with both Python 2 and Python 3 installed (e.g., the PMon container). Error messages such as the following would be seen:

```
ERR pmon#ledd[29]: Failed to load ledutil: module 'importlib' has no attribute 'machinery'
```

This is very odd, and it seems like the Python 2 version of importlib, which is basically just a stub, is taking precedence over the Python 3 version. I found that this occurs when calling `import importlib`. However, calling `import importlib.machinery` and `import importlib.util` causes the proper package to be referenced, and the `machinery` and `util` modules are loaded successfully. This is how it is specified in examples in the official documentation, however there is nothing mentioned regarding that it *should* be done this way or that `import importlib` is unreliable.

Also, since sonic-py-common is still used in environments with Python 2 installed we should maintain support for both Python 2 and 3 until we completely deprecate Python 2, so I have added this back in.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lguohan lguohan lguohan approved these changes

Assignees

@jleveque jleveque

Labels

Cleanup 💧 Included in 202012 Branch Python 3 Request for 202012 Branch

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@jleveque @lguohan @yxieca