Files
Campbell Barton 1216651ca9 PyAPI: make internal modules explicitly "private"
Rename modules in `./scripts/modules/` to use an underscore prefix to
make it clear they aren't intended to be part of public API's. This
also means there is no implication that these modules should be stable,
allowing us to change them based on Blender's internal usage.

The following modules have been marked as private:

- `animsys_refactor`
- `bl_console_utils`
- `bl_i18n_utils`
- `bl_previews_utils`
- `bl_rna_utils`
- `bl_text_utils`
- `bl_ui_utils`
- `bpy_restrict_state`
- `console_python`
- `console_shell`
- `graphviz_export`
- `keyingsets_utils`
- `rna_info`
- `rna_manual_reference`
- `rna_xml`

Note that we could further re-arrange these modules
(under `_bpy_internal` in some cases), this change is mainly to mark
them as private, further changes can be handed on a case-by-case basis.

Ref !147773
2025-10-13 09:35:09 +00:00

157 lines
4.1 KiB
Python

# SPDX-FileCopyrightText: 2009-2023 Blender Authors
#
# SPDX-License-Identifier: GPL-2.0-or-later
from __future__ import annotations
import bpy
from bpy.types import Operator
from bpy.props import (
BoolProperty,
StringProperty,
)
from bpy.app.translations import contexts as i18n_contexts
def _lang_module_get(sc):
return __import__(
"_console_" + sc.language,
# for python 3.3, maybe a bug???
level=0,
)
class ConsoleExec(Operator):
"""Execute the current console line as a Python expression"""
bl_idname = "console.execute"
bl_label = "Console Execute"
bl_options = {'UNDO_GROUPED'}
interactive: BoolProperty(
options={'SKIP_SAVE'},
)
@classmethod
def poll(cls, context):
return (context.area and context.area.type == 'CONSOLE')
def execute(self, context):
sc = context.space_data
module = _lang_module_get(sc)
execute = getattr(module, "execute", None)
if execute is not None:
return execute(context, self.interactive)
else:
print("Error: bpy.ops.console.execute_{:s} - not found".format(sc.language))
return {'FINISHED'}
class ConsoleAutocomplete(Operator):
"""Evaluate the namespace up until the cursor and give a list of """ \
"""options or complete the name if there is only one"""
bl_idname = "console.autocomplete"
bl_label = "Console Autocomplete"
@classmethod
def poll(cls, context):
return (context.area and context.area.type == 'CONSOLE')
def execute(self, context):
sc = context.space_data
module = _lang_module_get(sc)
autocomplete = getattr(module, "autocomplete", None)
if autocomplete:
return autocomplete(context)
else:
print("Error: bpy.ops.console.autocomplete_{:s} - not found".format(sc.language))
return {'FINISHED'}
class ConsoleCopyAsScript(Operator):
"""Copy the console contents for use in a script"""
bl_idname = "console.copy_as_script"
bl_label = "Copy to Clipboard (as Script)"
@classmethod
def poll(cls, context):
return (context.area and context.area.type == 'CONSOLE')
def execute(self, context):
sc = context.space_data
module = _lang_module_get(sc)
copy_as_script = getattr(module, "copy_as_script", None)
if copy_as_script:
return copy_as_script(context)
else:
print("Error: copy_as_script - not found for {!r}".format(sc.language))
return {'FINISHED'}
class ConsoleBanner(Operator):
"""Print a message when the terminal initializes"""
bl_idname = "console.banner"
bl_label = "Console Banner"
@classmethod
def poll(cls, context):
return (context.area and context.area.type == 'CONSOLE')
def execute(self, context):
sc = context.space_data
# default to python
if not sc.language:
sc.language = "python"
module = _lang_module_get(sc)
banner = getattr(module, "banner", None)
if banner:
return banner(context)
else:
print("Error: bpy.ops.console.banner_{:s} - not found".format(sc.language))
return {'FINISHED'}
class ConsoleLanguage(Operator):
"""Set the current language for this console"""
bl_idname = "console.language"
bl_label = "Console Language"
language: StringProperty(
name="Language",
translation_context=i18n_contexts.editor_python_console,
maxlen=32,
)
@classmethod
def poll(cls, context):
return (context.area and context.area.type == 'CONSOLE')
def execute(self, context):
sc = context.space_data
# default to python
sc.language = self.language
bpy.ops.console.banner()
# insert a new blank line
bpy.ops.console.history_append(text="", current_character=0, remove_duplicates=True)
return {'FINISHED'}
classes = (
ConsoleAutocomplete,
ConsoleBanner,
ConsoleCopyAsScript,
ConsoleExec,
ConsoleLanguage,
)