diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-06-08 11:03:14 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-06-08 20:05:44 +0300 |
commit | f29a738e23ce487fc9ae759326fc3409b82f8b26 (patch) | |
tree | 53d55a80b379af27f87bd6eb2a23eed20017a10b /release/scripts/modules/bpy | |
parent | c18ff180e39527d76cbcaab996bb8079ca4efced (diff) |
PyAPI: use keyword only arguments
Use keyword only arguments for the following functions.
- addon_utils.module_bl_info 2nd arg `info_basis`.
- addon_utils.modules 1st `module_cache`, 2nd arg `refresh`.
- addon_utils.modules_refresh 1st arg `module_cache`.
- bl_app_template_utils.activate 1nd arg `template_id`.
- bl_app_template_utils.import_from_id 2nd arg `ignore_not_found`.
- bl_app_template_utils.import_from_path 2nd arg `ignore_not_found`.
- bl_keymap_utils.keymap_from_toolbar.generate 2nd & 3rd args `use_fallback_keys` & `use_reset`.
- bl_keymap_utils.platform_helpers.keyconfig_data_oskey_from_ctrl 2nd arg `filter_fn`.
- bl_ui_utils.bug_report_url.url_prefill_from_blender 1st arg `addon_info`.
- bmesh.types.BMFace.copy 1st & 2nd args `verts`, `edges`.
- bmesh.types.BMesh.calc_volume 1st arg `signed`.
- bmesh.types.BMesh.from_mesh 2nd..4th args `face_normals`, `use_shape_key`, `shape_key_index`.
- bmesh.types.BMesh.from_object 3rd & 4th args `cage`, `face_normals`.
- bmesh.types.BMesh.transform 2nd arg `filter`.
- bmesh.types.BMesh.update_edit_mesh 2nd & 3rd args `loop_triangles`, `destructive`.
- bmesh.types.{BMVertSeq,BMEdgeSeq,BMFaceSeq}.sort 1st & 2nd arg `key`, `reverse`.
- bmesh.utils.face_split 4th..6th args `coords`, `use_exist`, `example`.
- bpy.data.libraries.load 2nd..4th args `link`, `relative`, `assets_only`.
- bpy.data.user_map 1st..3rd args `subset`, `key_types, `value_types`.
- bpy.msgbus.subscribe_rna 5th arg `options`.
- bpy.path.abspath 2nd & 3rd args `start` & `library`.
- bpy.path.clean_name 2nd arg `replace`.
- bpy.path.ensure_ext 3rd arg `case_sensitive`.
- bpy.path.module_names 2nd arg `recursive`.
- bpy.path.relpath 2nd arg `start`.
- bpy.types.EditBone.transform 2nd & 3rd arg `scale`, `roll`.
- bpy.types.Operator.as_keywords 1st arg `ignore`.
- bpy.types.Struct.{keyframe_insert,keyframe_delete} 2nd..5th args `index`, `frame`, `group`, `options`.
- bpy.types.WindowManager.popup_menu 2nd & 3rd arg `title`, `icon`.
- bpy.types.WindowManager.popup_menu_pie 3rd & 4th arg `title`, `icon`.
- bpy.utils.app_template_paths 1st arg `subdir`.
- bpy.utils.app_template_paths 1st arg `subdir`.
- bpy.utils.blend_paths 1st..3rd args `absolute`, `packed`, `local`.
- bpy.utils.execfile 2nd arg `mod`.
- bpy.utils.keyconfig_set 2nd arg `report`.
- bpy.utils.load_scripts 1st & 2nd `reload_scripts` & `refresh_scripts`.
- bpy.utils.preset_find 3rd & 4th args `display_name`, `ext`.
- bpy.utils.resource_path 2nd & 3rd arg `major`, `minor`.
- bpy.utils.script_paths 1st..4th args `subdir`, `user_pref`, `check_all`, `use_user`.
- bpy.utils.smpte_from_frame 2nd & 3rd args `fps`, `fps_base`.
- bpy.utils.smpte_from_seconds 2nd & 3rd args `fps`, `fps_base`.
- bpy.utils.system_resource 2nd arg `subdir`.
- bpy.utils.time_from_frame 2nd & 3rd args `fps`, `fps_base`.
- bpy.utils.time_to_frame 2nd & 3rd args `fps`, `fps_base`.
- bpy.utils.units.to_string 4th..6th `precision`, `split_unit`, `compatible_unit`.
- bpy.utils.units.to_value 4th arg `str_ref_unit`.
- bpy.utils.user_resource 2nd & 3rd args `subdir`, `create`
- bpy_extras.view3d_utils.location_3d_to_region_2d 4th arg `default`.
- bpy_extras.view3d_utils.region_2d_to_origin_3d 4th arg `clamp`.
- gpu.offscreen.unbind 1st arg `restore`.
- gpu_extras.batch.batch_for_shader 4th arg `indices`.
- gpu_extras.batch.presets.draw_circle_2d 4th arg `segments`.
- gpu_extras.presets.draw_circle_2d 4th arg `segments`.
- imbuf.types.ImBuf.resize 2nd arg `resize`.
- imbuf.write 2nd arg `filepath`.
- mathutils.kdtree.KDTree.find 2nd arg `filter`.
- nodeitems_utils.NodeCategory 3rd & 4th arg `descriptions`, `items`.
- nodeitems_utils.NodeItem 2nd..4th args `label`, `settings`, `poll`.
- nodeitems_utils.NodeItemCustom 1st & 2nd arg `poll`, `draw`.
- rna_prop_ui.draw 5th arg `use_edit`.
- rna_prop_ui.rna_idprop_ui_get 2nd arg `create`.
- rna_prop_ui.rna_idprop_ui_prop_clear 3rd arg `remove`.
- rna_prop_ui.rna_idprop_ui_prop_get 3rd arg `create`.
- rna_xml.xml2rna 2nd arg `root_rna`.
- rna_xml.xml_file_write 4th arg `skip_typemap`.
Diffstat (limited to 'release/scripts/modules/bpy')
-rw-r--r-- | release/scripts/modules/bpy/path.py | 12 | ||||
-rw-r--r-- | release/scripts/modules/bpy/utils/__init__.py | 42 |
2 files changed, 27 insertions, 27 deletions
diff --git a/release/scripts/modules/bpy/path.py b/release/scripts/modules/bpy/path.py index 1de4542e69e..30f93d051e5 100644 --- a/release/scripts/modules/bpy/path.py +++ b/release/scripts/modules/bpy/path.py @@ -56,7 +56,7 @@ def _getattr_bytes(var, attr): return var.path_resolve(attr, False).as_bytes() -def abspath(path, start=None, library=None): +def abspath(path, *, start=None, library=None): """ Returns the absolute path relative to the current blend file using the "//" prefix. @@ -92,7 +92,7 @@ def abspath(path, start=None, library=None): return path -def relpath(path, start=None): +def relpath(path, *, start=None): """ Returns the path relative to the current blend file using the "//" prefix. @@ -134,7 +134,7 @@ def is_subdir(path, directory): return False -def clean_name(name, replace="_"): +def clean_name(name, *, replace="_"): """ Returns a name with characters replaced that may cause problems under various circumstances, @@ -311,7 +311,7 @@ def resolve_ncase(path): return ncase_path if found else path -def ensure_ext(filepath, ext, case_sensitive=False): +def ensure_ext(filepath, ext, *, case_sensitive=False): """ Return the path with the extension added if it is not already set. @@ -332,7 +332,7 @@ def ensure_ext(filepath, ext, case_sensitive=False): return filepath + ext -def module_names(path, recursive=False): +def module_names(path, *, recursive=False): """ Return a list of modules which can be imported from *path*. @@ -361,7 +361,7 @@ def module_names(path, recursive=False): if isfile(fullpath): modules.append((filename, fullpath)) if recursive: - for mod_name, mod_path in module_names(directory, True): + for mod_name, mod_path in module_names(directory, recursive=True): modules.append(("%s.%s" % (filename, mod_name), mod_path, )) diff --git a/release/scripts/modules/bpy/utils/__init__.py b/release/scripts/modules/bpy/utils/__init__.py index 2b19d23a367..e6c7bca3e3c 100644 --- a/release/scripts/modules/bpy/utils/__init__.py +++ b/release/scripts/modules/bpy/utils/__init__.py @@ -81,7 +81,7 @@ _script_module_dirs = "startup", "modules" _is_factory_startup = _bpy.app.factory_startup -def execfile(filepath, mod=None): +def execfile(filepath, *, mod=None): """ Execute a file path as a Python script. @@ -193,7 +193,7 @@ _global_loaded_modules = [] # store loaded module names for reloading. import bpy_types as _bpy_types # keep for comparisons, never ever reload this. -def load_scripts(reload_scripts=False, refresh_scripts=False): +def load_scripts(*, reload_scripts=False, refresh_scripts=False): """ Load scripts and run each modules register function. @@ -357,7 +357,7 @@ def script_path_pref(): return _os.path.normpath(path) if path else None -def script_paths(subdir=None, user_pref=True, check_all=False, use_user=True): +def script_paths(*, subdir=None, user_pref=True, check_all=False, use_user=True): """ Returns a list of valid script paths. @@ -446,16 +446,16 @@ def refresh_script_paths(): _sys_path_ensure_append(path) -def app_template_paths(subdir=None): +def app_template_paths(*, path=None): """ Returns valid application template paths. - :arg subdir: Optional subdir. - :type subdir: string + :arg path: Optional subdir. + :type path: string :return: app template paths. :rtype: generator """ - subdir_args = (subdir,) if subdir is not None else () + subdir_args = (path,) if path is not None else () # Note: keep in sync with: Blender's 'BKE_appdir_app_template_any'. # Uses 'BLENDER_USER_SCRIPTS', 'BLENDER_SYSTEM_SCRIPTS' # ... in this case 'system' accounts for 'local' too. @@ -463,9 +463,9 @@ def app_template_paths(subdir=None): (_user_resource, "bl_app_templates_user"), (system_resource, "bl_app_templates_system"), ): - path = resource_fn('SCRIPTS', _os.path.join("startup", module_name, *subdir_args)) - if path and _os.path.isdir(path): - yield path + path_test = resource_fn('SCRIPTS', path=_os.path.join("startup", module_name, *subdir_args)) + if path_test and _os.path.isdir(path_test): + yield path_test def preset_paths(subdir): @@ -478,7 +478,7 @@ def preset_paths(subdir): :rtype: list """ dirs = [] - for path in script_paths("presets", check_all=True): + for path in script_paths(subdir="presets", check_all=True): directory = _os.path.join(path, subdir) if not directory.startswith(path): raise Exception("invalid subdir given %r" % subdir) @@ -532,7 +532,7 @@ def is_path_builtin(path): return False -def smpte_from_seconds(time, fps=None, fps_base=None): +def smpte_from_seconds(time, *, fps=None, fps_base=None): """ Returns an SMPTE formatted string from the *time*: ``HH:MM:SS:FF``. @@ -552,7 +552,7 @@ def smpte_from_seconds(time, fps=None, fps_base=None): ) -def smpte_from_frame(frame, fps=None, fps_base=None): +def smpte_from_frame(frame, *, fps=None, fps_base=None): """ Returns an SMPTE formatted string from the *frame*: ``HH:MM:SS:FF``. @@ -585,7 +585,7 @@ def smpte_from_frame(frame, fps=None, fps_base=None): )) -def time_from_frame(frame, fps=None, fps_base=None): +def time_from_frame(frame, *, fps=None, fps_base=None): """ Returns the time from a frame number . @@ -610,7 +610,7 @@ def time_from_frame(frame, fps=None, fps_base=None): return timedelta(0, frame / fps) -def time_to_frame(time, fps=None, fps_base=None): +def time_to_frame(time, *, fps=None, fps_base=None): """ Returns a float frame number from a time given in seconds or as a datetime.timedelta object. @@ -639,7 +639,7 @@ def time_to_frame(time, fps=None, fps_base=None): return time * fps -def preset_find(name, preset_path, display_name=False, ext=".py"): +def preset_find(name, preset_path, *, display_name=False, ext=".py"): if not name: return None @@ -676,7 +676,7 @@ def keyconfig_init(): keyconfig_set(filepath) -def keyconfig_set(filepath, report=None): +def keyconfig_set(filepath, *, report=None): from os.path import basename, splitext if _bpy.app.debug_python: @@ -712,14 +712,14 @@ def keyconfig_set(filepath, report=None): return True -def user_resource(resource_type, path="", create=False): +def user_resource(resource_type, *, path="", create=False): """ Return a user resource path (normally from the users home directory). :arg type: Resource type in ['DATAFILES', 'CONFIG', 'SCRIPTS', 'AUTOSAVE']. :type type: string - :arg subdir: Optional subdirectory. - :type subdir: string + :arg path: Optional subdirectory. + :type path: string :arg create: Treat the path as a directory and create it if its not existing. :type create: boolean @@ -727,7 +727,7 @@ def user_resource(resource_type, path="", create=False): :rtype: string """ - target_path = _user_resource(resource_type, path) + target_path = _user_resource(resource_type, path=path) if create: # should always be true. |