test2/doc/python_api/rst/info_gotcha.rst


*******
Gotchas
*******

This document attempts to help you work with the Blender API in areas
that can be troublesome and avoid practices that are known to cause instability.


.. toctree::
   :maxdepth: 1

   info_gotchas_crashes.rst
   info_gotchas_threading.rst
   info_gotchas_internal_data_and_python_objects.rst
   info_gotchas_operators.rst
   info_gotchas_meshes.rst
   info_gotchas_armatures_and_bones.rst
   info_gotchas_file_paths_and_encoding.rst
API: Fix Links Self-explanatory. to find broken links run `sphinx-build -b linkcheck sphinx-in sphinx-out` Reviewers: mont29 Tags: #bf_blender, #python, #infrastructure:_websites Differential Revision: https://developer.blender.org/D2297 2016-10-25 17:32:58 +02:00
spelling corrections from Philippe Casteleyn 2011-09-10 14:28:13 +00:00			`*******`
			`Gotchas`
			`*******`
document some of the pitfalls in the blender python api (taken from frequent mails and bug reports) 2011-08-26 04:00:55 +00:00
Docs; Py API gotcha's section Minor corrections and cleanup 2015-07-12 20:50:44 +10:00			`This document attempts to help you work with the Blender API in areas`
API docs: intro overhaul - Update terminology, spelling, formatting. - Rename screen to workspace. - Update for 2.8 UI changes. 2020-06-23 23:08:49 +10:00			`that can be troublesome and avoid practices that are known to cause instability.`
document some of the pitfalls in the blender python api (taken from frequent mails and bug reports) 2011-08-26 04:00:55 +00:00
- use python convention for headings - use implicit examples rather than .. code-block:: 2011-08-27 08:09:12 +00:00
API docs: Split 'Gotchas' page, add some info about python instances and subclasses. This PR: * Splits the `Gotchas` page into several sub-sections. This was getting too big and hard to navigate. * Adds some information regarding Python instances life-time of objects wrapping Blender internal data. * Adds some information about usage of constructors and destructors for sub-classes of Blender-defined types. Pull Request: https://projects.blender.org/blender/blender/pulls/129814 2024-11-10 18:40:14 +01:00			`.. toctree::`
			`:maxdepth: 1`
Add 2 documents to the python api reference. - Blender/Python Addon Tutorial: a step by step guide on how to write an addon from scratch - Blender/Python API Reference Usage: examples of how to use the API reference docs Thanks to John Nyquist for editing these docs and giving feedback. 2012-12-07 05:27:09 +00:00
API docs: Split 'Gotchas' page, add some info about python instances and subclasses. This PR: * Splits the `Gotchas` page into several sub-sections. This was getting too big and hard to navigate. * Adds some information regarding Python instances life-time of objects wrapping Blender internal data. * Adds some information about usage of constructors and destructors for sub-classes of Blender-defined types. Pull Request: https://projects.blender.org/blender/blender/pulls/129814 2024-11-10 18:40:14 +01:00			`info_gotchas_crashes.rst`
Py Docs: Gotcha chapter on threading Update the Python API documentation about crashes with multi-threaded code. - Move the "threading gotcha" into a file of its own. That way it's immediately clear from looking at the Gotcha table of contents that threading is not supported. - Simplify the example code, so that it doesn't access `bpy`. Apparently the problem is much wider than just multi-threaded access to `bpy`, and involves _all_ Python threads, regardless of what they do / access. - Add some more explanation and move some text from the bottom to the top, so that the first-read part (when reading top to bottom) has most of the information. Pull Request: https://projects.blender.org/blender/blender/pulls/139279 2025-05-22 16:23:23 +02:00			`info_gotchas_threading.rst`
API docs: Split 'Gotchas' page, add some info about python instances and subclasses. This PR: * Splits the `Gotchas` page into several sub-sections. This was getting too big and hard to navigate. * Adds some information regarding Python instances life-time of objects wrapping Blender internal data. * Adds some information about usage of constructors and destructors for sub-classes of Blender-defined types. Pull Request: https://projects.blender.org/blender/blender/pulls/129814 2024-11-10 18:40:14 +01:00			`info_gotchas_internal_data_and_python_objects.rst`
			`info_gotchas_operators.rst`
			`info_gotchas_meshes.rst`
			`info_gotchas_armatures_and_bones.rst`
			`info_gotchas_file_paths_and_encoding.rst`