test2/source/blender/python/intern/bpy.hh

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

/** \file
 * \ingroup pythonintern
 */

#pragma once

#include <Python.h>

struct bContext;

/** Creates the `bpy` module and adds it to `sys.modules` for importing. */
void BPy_init_modules(bContext *C);

extern PyObject *bpy_package_py;

/* `bpy_interface_atexit.cc` */

void BPY_atexit_register();
void BPY_atexit_unregister();

extern struct CLG_LogRef *BPY_LOG_RNA;
extern struct CLG_LogRef *BPY_LOG_INTERFACE;
License Headers: Set copyright to "Blender Authors", add AUTHORS Listing the "Blender Foundation" as copyright holder implied the Blender Foundation holds copyright to files which may include work from many developers. While keeping copyright on headers makes sense for isolated libraries, Blender's own code may be refactored or moved between files in a way that makes the per file copyright holders less meaningful. Copyright references to the "Blender Foundation" have been replaced with "Blender Authors", with the exception of `./extern/` since these this contains libraries which are more isolated, any changed to license headers there can be handled on a case-by-case basis. Some directories in `./intern/` have also been excluded: - `./intern/cycles/` it's own `AUTHORS` file is planned. - `./intern/opensubdiv/`. An "AUTHORS" file has been added, using the chromium projects authors file as a template. Design task: #110784 Ref !110783. 2023-08-16 00:20:26 +10:00			`/* SPDX-FileCopyrightText: 2023 Blender Authors`
Cleanup: Add a copyright notice to files and use SPDX format A lot of files were missing copyright field in the header and the Blender Foundation contributed to them in a sense of bug fixing and general maintenance. This change makes it explicit that those files are at least partially copyrighted by the Blender Foundation. Note that this does not make it so the Blender Foundation is the only holder of the copyright in those files, and developers who do not have a signed contract with the foundation still hold the copyright as well. Another aspect of this change is using SPDX format for the header. We already used it for the license specification, and now we state it for the copyright as well, following the FAQ: https://reuse.software/faq/ 2023-05-31 16:19:06 +02:00			`*`
			`* SPDX-License-Identifier: GPL-2.0-or-later */`
doxygen: blender/python tagged. 2011-02-27 20:10:08 +00:00
doxygen: add newline after \file While \file doesn't need an argument, it can't have another doxy command after it. 2019-02-18 08:08:12 +11:00			`/** \file`
			`* \ingroup pythonintern`
doxygen: blender/python tagged. 2011-02-27 20:10:08 +00:00			`*/`

correct include guards and add checks in check_style_c.py for them. 2013-09-19 23:17:52 +00:00			`#pragma once`
quiet -Wmissing-prototypes warnings, and enable this warning by default for C with gcc. helps for finding unused functions and making functions static, also did some minor code cleanup. 2012-09-15 01:52:28 +00:00
Refactor: Make header files more clangd and clang-tidy friendly When using clangd or running clang-tidy on headers there are currently many errors. These are noisy in IDEs, make auto fixes impossible, and break features like code completion, refactoring and navigation. This makes source/blender headers work by themselves, which is generally the goal anyway. But #includes and forward declarations were often incomplete. * Add #includes and forward declarations * Add IWYU pragma: export in a few places * Remove some unused #includes (but there are many more) * Tweak ShaderCreateInfo macros to work better with clangd Some types of headers still have errors, these could be fixed or worked around with more investigation. Mostly preprocessor template headers like NOD_static_types.h. Note that that disabling WITH_UNITY_BUILD is required for clangd to work properly, otherwise compile_commands.json does not contain the information for the relevant source files. For more details see the developer docs: https://developer.blender.org/docs/handbook/tooling/clangd/ Pull Request: https://projects.blender.org/blender/blender/pulls/132608 2025-01-07 12:39:13 +01:00			`#include <Python.h>`

Cleanup: remove duplicate context variable (__py_context) The context was stored both in __py_context & bpy_context_module. This avoids duplicate functions to update them too. 2020-10-15 18:12:03 +11:00			`struct bContext;`

Cleanup: spelling in comments 2022-09-21 11:57:20 +10:00			/** Creates the `bpy` module and adds it to `sys.modules` for importing. */
Refactor: Move BPY `intern` remaining headers to proper C++ ones. 2024-09-24 12:23:25 +02:00			`void BPy_init_modules(bContext *C);`
Cleanup: move public doc-strings into headers for 'python' 2021-12-02 17:24:04 +11:00
Experimental option to build blender as a python module, rather then blender embedding python. CMake build option WITH_PYTHON_MODULE, will build ./bin/bpy.so This allows 'bpy' to be imported from python or other applications/IDE's which embed python, eg: python -c "import bpy ; bpy.ops.render.render(write_still=True)" This runs in background mode and has similar restrictions to running a script: blender --background --python test.py TODO: - install to site-packages with blender scripts - add support for imp.reload() 2011-02-20 23:39:29 +00:00			`extern PyObject *bpy_package_py;`
fix [#28672] Blender segfault after exiting a game that was opened with autoplay on (Blender, not blenderplayer) blender now stops the sound system and free's its self on Pythons sys.exit(). 2011-09-20 12:22:19 +00:00
Cleanup: correct file names in comments after C -> C++ renaming Use back-tick quotes to differentiate these from plain text. 2023-07-31 11:50:54 +10:00			/* `bpy_interface_atexit.cc` */
Cleanup: ensure space after file named in headers Add blank lines after file references to avoid them being interpreted as doc-strings the following declarations. 2022-04-04 13:17:03 +10:00
Refactor: Move BPY `intern` remaining headers to proper C++ ones. 2024-09-24 12:23:25 +02:00			`void BPY_atexit_register();`
			`void BPY_atexit_unregister();`
quiet -Wmissing-prototypes warnings, and enable this warning by default for C with gcc. helps for finding unused functions and making functions static, also did some minor code cleanup. 2012-09-15 01:52:28 +00:00
Cleanup: GCC redundant declarations Previous waning suppression was only tested with clang. 2019-02-23 22:16:32 +11:00			`extern struct CLG_LogRef *BPY_LOG_RNA;`
Cleanup: use logging for "Found bundled Python" message This was added when Python was initially bundled so any problems finding Python could be investigated. Move this to use logging so we can show this information when needed. 2020-11-02 19:33:32 +11:00			`extern struct CLG_LogRef *BPY_LOG_INTERFACE;`