Mercurial > libervia-backend

annotate sat/tools/common/dynamic_import.py @ 4037:524856bd7b19

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
massive refactoring to switch from camelCase to snake_case: historically, Libervia (SàT before) was using camelCase as allowed by PEP8 when using a pre-PEP8 code, to use the same coding style as in Twisted. However, snake_case is more readable and it's better to follow PEP8 best practices, so it has been decided to move on full snake_case. Because Libervia has a huge codebase, this ended with a ugly mix of camelCase and snake_case. To fix that, this patch does a big refactoring by renaming every function and method (including bridge) that are not coming from Twisted or Wokkel, to use fully snake_case. This is a massive change, and may result in some bugs.
author Goffi <goffi@goffi.org>
date Sat, 08 Apr 2023 13:54:42 +0200
parents 7550ae9cfbac
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3028
ab2696e34d29 Python 3 port:
Goffi <goffi@goffi.org>
parents: 2771
diff changeset
1 #!/usr/bin/env python3
3137
559a625a236b fixed shebangs
Goffi <goffi@goffi.org>
parents: 3136
diff changeset
2
3480
7550ae9cfbac Renamed the project from "Salut à Toi" to "Libervia":
Goffi <goffi@goffi.org>
parents: 3479
diff changeset
3 # Libervia: an XMPP client
3479
be6d91572633 date update
Goffi <goffi@goffi.org>
parents: 3290
diff changeset
4 # Copyright (C) 2009-2021 Jérôme Poisson (goffi@goffi.org)
2088
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
5
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
6 # This program is free software: you can redistribute it and/or modify
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
7 # it under the terms of the GNU Affero General Public License as published by
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
8 # the Free Software Foundation, either version 3 of the License, or
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
9 # (at your option) any later version.
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
10
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
11 # This program is distributed in the hope that it will be useful,
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
14 # GNU Affero General Public License for more details.
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
15
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
16 # You should have received a copy of the GNU Affero General Public License
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
18
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
19 """ tools dynamic import """
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
20
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
21 from importlib import import_module
3290
3ff952c042ae tools (common/dynamic_import): log a warning if bridge can't be imported
Goffi <goffi@goffi.org>
parents: 3137
diff changeset
22 from sat.core.log import getLogger
3ff952c042ae tools (common/dynamic_import): log a warning if bridge can't be imported
Goffi <goffi@goffi.org>
parents: 3137
diff changeset
23
3ff952c042ae tools (common/dynamic_import): log a warning if bridge can't be imported
Goffi <goffi@goffi.org>
parents: 3137
diff changeset
24
3ff952c042ae tools (common/dynamic_import): log a warning if bridge can't be imported
Goffi <goffi@goffi.org>
parents: 3137
diff changeset
25 log = getLogger(__name__)
2088
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
26
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
27
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
28 def bridge(name, module_path="sat.bridge"):
4037
524856bd7b19 massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents: 3480
diff changeset
29 """import bridge module
2088
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
30
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
31 @param module_path(str): path of the module to import
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
32 @param name(str): name of the bridge to import (e.g.: dbus)
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
33 @return (module, None): imported module or None if nothing is found
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
34 """
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
35 try:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
36 bridge_module = import_module(module_path + "." + name)
2088
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
37 except ImportError:
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
38 try:
2624
56f94936df1e code style reformatting using black
Goffi <goffi@goffi.org>
parents: 2562
diff changeset
39 bridge_module = import_module(module_path + "." + name + "_bridge")
3290
3ff952c042ae tools (common/dynamic_import): log a warning if bridge can't be imported
Goffi <goffi@goffi.org>
parents: 3137
diff changeset
40 except ImportError as e:
3ff952c042ae tools (common/dynamic_import): log a warning if bridge can't be imported
Goffi <goffi@goffi.org>
parents: 3137
diff changeset
41 log.warning(f"Can't import bridge {name!r}: {e}")
2088
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
42 bridge_module = None
c02f96756d5c core: bridge can now be changed in conf
Goffi <goffi@goffi.org>
parents:
diff changeset
43 return bridge_module