Mercurial > hg > orthanc-python
annotate Sources/PythonModule.cpp @ 222:850b56948b9c default tip
back to mainline
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Thu, 04 Jul 2024 09:40:21 +0200 |
| parents | 3678a028f1f6 |
| children |
| rev | line source |
|---|---|
|
219
3678a028f1f6
making the project REUSE-compliant
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
166
diff
changeset
|
1 /** |
|
3678a028f1f6
making the project REUSE-compliant
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
166
diff
changeset
|
2 * SPDX-FileCopyrightText: 2020-2023 Osimis S.A., 2024-2024 Orthanc Team SRL, 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain |
|
3678a028f1f6
making the project REUSE-compliant
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
166
diff
changeset
|
3 * SPDX-License-Identifier: AGPL-3.0-or-later |
|
3678a028f1f6
making the project REUSE-compliant
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
166
diff
changeset
|
4 */ |
|
3678a028f1f6
making the project REUSE-compliant
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
166
diff
changeset
|
5 |
| 0 | 6 /** |
| 7 * Python plugin for Orthanc | |
|
166
6fada29b6759
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
8 * Copyright (C) 2020-2023 Osimis S.A., Belgium |
|
6fada29b6759
updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
155
diff
changeset
|
9 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium |
|
155
71d305c29cfa
updated year to 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
114
diff
changeset
|
10 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 0 | 11 * |
| 12 * This program is free software: you can redistribute it and/or | |
| 13 * modify it under the terms of the GNU Affero General Public License | |
| 14 * as published by the Free Software Foundation, either version 3 of | |
| 15 * the License, or (at your option) any later version. | |
| 16 * | |
| 17 * This program is distributed in the hope that it will be useful, but | |
| 18 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 20 * Affero General Public License for more details. | |
| 21 * | |
| 22 * You should have received a copy of the GNU Affero General Public License | |
| 23 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 24 **/ | |
| 25 | |
| 26 | |
| 27 #include "PythonModule.h" | |
| 28 | |
|
68
0b3ef425db31
refactoring using ICallbackRegistration::Apply()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
56
diff
changeset
|
29 #include "../Resources/Orthanc/Plugins/OrthancPluginCppWrapper.h" |
| 0 | 30 #include "PythonString.h" |
| 31 | |
| 32 #include <boost/thread/mutex.hpp> | |
| 33 #include <set> | |
| 34 | |
| 35 | |
| 36 #if PY_VERSION_HEX < 0x03070000 /* 3.7.0 */ | |
| 37 static PythonObject* GetModule(PythonLock& lock, | |
| 38 const std::string& utf8Name) | |
| 39 { | |
| 40 static boost::mutex mutex_; | |
| 41 static std::set<std::string> loadedModules_; | |
| 42 | |
| 43 boost::mutex::scoped_lock l(mutex_); | |
| 44 | |
| 45 if (loadedModules_.find(utf8Name) == loadedModules_.end()) | |
| 46 { | |
| 47 PythonString tmp(lock, utf8Name); | |
| 48 | |
| 49 // The module is not imported yet | |
| 50 loadedModules_.insert(utf8Name); | |
| 51 return new PythonObject(lock, PyImport_Import(tmp.GetPyObject()), false); | |
| 52 } | |
| 53 else | |
| 54 { | |
| 55 // PyImport_AddModule returns a borrowed reference | |
| 56 return new PythonObject(lock, PyImport_AddModule(utf8Name.c_str()), true); | |
| 57 } | |
| 58 } | |
| 59 | |
| 60 #else | |
| 61 // The "PyImport_GetModule()" function was introduced in Python | |
| 62 // 3.7.0 | |
| 63 static PythonObject* GetModule(PythonLock& lock, | |
| 64 const std::string& utf8Name) | |
| 65 { | |
| 66 PythonString tmp(lock, utf8Name); | |
| 67 | |
| 68 PyObject* module = PyImport_GetModule(tmp.GetPyObject()); | |
| 69 if (module != NULL) | |
| 70 { | |
| 71 // The module was already imported by a previous call: Reuse it | |
| 72 return new PythonObject(lock, module); | |
| 73 } | |
| 74 else | |
| 75 { | |
| 76 // This is the first time this module is used: Import it | |
| 77 return new PythonObject(lock, PyImport_Import(tmp.GetPyObject())); | |
| 78 } | |
| 79 } | |
| 80 #endif | |
| 81 | |
| 82 | |
| 83 PythonModule::PythonModule(PythonLock& lock, | |
| 84 const std::string& utf8Name) : | |
| 85 lock_(lock), | |
| 86 name_(utf8Name) | |
| 87 { | |
| 88 module_.reset(GetModule(lock, utf8Name)); | |
| 89 } | |
| 90 | |
| 91 | |
| 92 bool PythonModule::IsValid() const | |
| 93 { | |
| 94 return (module_.get() != NULL && | |
| 95 module_->IsValid()); | |
| 96 } | |
| 97 | |
| 98 | |
| 99 PythonObject& PythonModule::GetObject() const | |
| 100 { | |
| 101 if (!IsValid()) | |
| 102 { | |
| 103 ORTHANC_PLUGINS_THROW_EXCEPTION(BadSequenceOfCalls); | |
| 104 } | |
| 105 else | |
| 106 { | |
| 107 return *module_; | |
| 108 } | |
| 109 } | |
| 110 | |
| 111 | |
| 112 PyObject* PythonModule::GetPyObject() const | |
| 113 { | |
| 114 if (!IsValid()) | |
| 115 { | |
| 116 ORTHANC_PLUGINS_THROW_EXCEPTION(BadSequenceOfCalls); | |
| 117 } | |
| 118 else | |
| 119 { | |
| 120 return module_->GetPyObject(); | |
| 121 } | |
| 122 } |