lsst.afw g4f4f280218+791bc2f724
python.cc
Go to the documentation of this file.
1/*
2 * This file is part of afw.
3 *
4 * Developed for the LSST Data Management System.
5 * This product includes software developed by the LSST Project
6 * (https://www.lsst.org).
7 * See the COPYRIGHT file at the top-level directory of this distribution
8 * for details of code ownership.
9 *
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation, either version 3 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 */
23
24#include <string>
25
27
28namespace lsst {
29namespace afw {
30namespace typehandling {
31
33 // Give the class a custom docstring to avoid confusing Python users
34 std::string docstring = R"docstring(
35For compatibility with C++, ``)docstring" +
36 className + R"docstring(`` has the following restrictions:
37 - all keys must be )docstring" + keyName +
38 R"docstring(
39 - values must be built-in types or subclasses of `lsst.afw.typehandling.Storable`.
40 Almost any user-defined class in C++ or Python can have
41 `~lsst.afw.typehandling.Storable` as a mixin.
42
43As a safety precaution, `~lsst.afw.typehandling.Storable` objects that are
44added from C++ may be copied when you retrieve them from Python, making it
45impossible to modify them in-place. This issue does not affect objects that
46are added from Python, or objects that are always passed by
47:cpp:class:`shared_ptr` in C++.
48)docstring";
49 return docstring;
50}
51
52} // namespace typehandling
53} // namespace afw
54} // namespace lsst
std::string declareGenericMapRestrictions(std::string const &className, std::string const &keyName)
Definition: python.cc:32
A base class for image defects.