bartvdbraak/blender
1
0
Fork 4
Code Issues 4 Pull Requests 1 Actions 1 Packages Projects Releases Wiki Activity
11b1919bcf
blender/pyproject.toml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

57 lines
2.3 KiB
TOML
Raw Normal View History

pyproject: add configuration for autopep8 This adds pyproject.toml, needed to configure defaults for autopep8. The file is auto-discovered in a similar way to .clang-format, other tools could be configured here too. For now just configure autopep8 so this can be enabled in IDE's without causing unexpected edits such as wrapping lines over 80 columns in width. Now autopep8 can be used from the root directory by running: autopep8 . This uses multiple-jobs to run autopep8 over all Python scripts except paths that are explicitly ignored in exclude defined by pyproject.toml. Reviewed By: mont29, brecht, sybren Ref D14686
2022-04-19 05:50:35 +00:00
# SPDX-License-Identifier: GPL-2.0-or-later
[tool.autopep8]
Cleanup: fix various typos Differential Revision: https://developer.blender.org/D15304
2022-06-28 13:35:35 +00:00
# Configuration for `autopep8`, allowing the command: autopep8 .
pyproject: add configuration for autopep8 This adds pyproject.toml, needed to configure defaults for autopep8. The file is auto-discovered in a similar way to .clang-format, other tools could be configured here too. For now just configure autopep8 so this can be enabled in IDE's without causing unexpected edits such as wrapping lines over 80 columns in width. Now autopep8 can be used from the root directory by running: autopep8 . This uses multiple-jobs to run autopep8 over all Python scripts except paths that are explicitly ignored in exclude defined by pyproject.toml. Reviewed By: mont29, brecht, sybren Ref D14686
2022-04-19 05:50:35 +00:00
# to reformat all source files.
#
Cleanup: fix various typos Differential Revision: https://developer.blender.org/D15304
2022-06-28 13:35:35 +00:00
# NOTE: the settings defined here map directly to command line arguments
pyproject: add configuration for autopep8 This adds pyproject.toml, needed to configure defaults for autopep8. The file is auto-discovered in a similar way to .clang-format, other tools could be configured here too. For now just configure autopep8 so this can be enabled in IDE's without causing unexpected edits such as wrapping lines over 80 columns in width. Now autopep8 can be used from the root directory by running: autopep8 . This uses multiple-jobs to run autopep8 over all Python scripts except paths that are explicitly ignored in exclude defined by pyproject.toml. Reviewed By: mont29, brecht, sybren Ref D14686
2022-04-19 05:50:35 +00:00
# which will override these settings when passed in to autopep8.
max_line_length = 120
ignore = [
# Info: Use `isinstance()` instead of comparing types directly.
# Why disable? Changes code logic, in rare cases we want to compare exact types.
"E721",
# Info: Fix bare except.
# Why disable? Disruptive, leave our exceptions alone.
"E722",
# Info: Fix module level import not at top of file.
# Why disable? Re-ordering imports is disruptive and breaks some scripts
# that need to check if a module has already been loaded in the case of reloading.
"E402",
# Info: Fix various deprecated code (via lib2to3)
# Why disable? Does nothing besides incorrectly adding a duplicate import,
# could be reported as a bug except this is likely to be removed soon, see:
# https://github.com/python/cpython/issues/84540.
"W690",
]
pyproject: enable aggressive, ignore E501 (line wrapping) Aggressive needs to be enabled for many useful edits to take effect, the ignore list is currently used to disable edits that may need further checks/investigation before they're enabled. Note that aggressive was already enabled for the: source/tools/utils/autopep8_clean.py script which was previously used when applying autopep8.
2022-04-26 04:53:34 +00:00
# Use aggressive as many useful edits are disabled unless it's enabled.
# Any edits which are overly disruptive or risky can be removed in the `ignore` list.
aggressive = 2
pyproject: add configuration for autopep8 This adds pyproject.toml, needed to configure defaults for autopep8. The file is auto-discovered in a similar way to .clang-format, other tools could be configured here too. For now just configure autopep8 so this can be enabled in IDE's without causing unexpected edits such as wrapping lines over 80 columns in width. Now autopep8 can be used from the root directory by running: autopep8 . This uses multiple-jobs to run autopep8 over all Python scripts except paths that are explicitly ignored in exclude defined by pyproject.toml. Reviewed By: mont29, brecht, sybren Ref D14686
2022-04-19 05:50:35 +00:00
# Exclude:
# - `./extern/` because it's maintained separately.
pyproject: remove tools/pyproject.toml Rely on ./pyproject.toml. This file was only separated because it was in an external repository.
2023-03-01 11:18:28 +00:00
# - `./tools/svn_rev_map/` contains data-files which are slow to re-format and don't benefit from formatting.
# - `./scripts/addons*` because it is an external repository.
pyproject: add configuration for autopep8 This adds pyproject.toml, needed to configure defaults for autopep8. The file is auto-discovered in a similar way to .clang-format, other tools could be configured here too. For now just configure autopep8 so this can be enabled in IDE's without causing unexpected edits such as wrapping lines over 80 columns in width. Now autopep8 can be used from the root directory by running: autopep8 . This uses multiple-jobs to run autopep8 over all Python scripts except paths that are explicitly ignored in exclude defined by pyproject.toml. Reviewed By: mont29, brecht, sybren Ref D14686
2022-04-19 05:50:35 +00:00
# which can contain their own configuration and be handled separately.
Re-design of submodules used in blender.git This commit implements described in the #104573. The goal is to fix the confusion of the submodule hashes change, which are not ideal for any of the supported git-module configuration (they are either always visible causing confusion, or silently staged and committed, also causing confusion). This commit replaces submodules with a checkout of addons and addons_contrib, covered by the .gitignore, and locale and developer tools are moved to the main repository. This also changes the paths: - /release/scripts are moved to the /scripts - /source/tools are moved to the /tools - /release/datafiles/locale is moved to /locale This is done to avoid conflicts when using bisect, and also allow buildbot to automatically "recover" wgen building older or newer branches/patches. Running `make update` will initialize the local checkout to the changed repository configuration. Another aspect of the change is that the make update will support Github style of remote organization (origin remote pointing to thy fork, upstream remote pointing to the upstream blender/blender.git). Pull Request #104755
2023-02-21 15:39:58 +00:00
# - `./scripts/modules/rna_manual_reference.py` because it's a generated data-file.
pyproject: add configuration for autopep8 This adds pyproject.toml, needed to configure defaults for autopep8. The file is auto-discovered in a similar way to .clang-format, other tools could be configured here too. For now just configure autopep8 so this can be enabled in IDE's without causing unexpected edits such as wrapping lines over 80 columns in width. Now autopep8 can be used from the root directory by running: autopep8 . This uses multiple-jobs to run autopep8 over all Python scripts except paths that are explicitly ignored in exclude defined by pyproject.toml. Reviewed By: mont29, brecht, sybren Ref D14686
2022-04-19 05:50:35 +00:00
exclude = """
./extern/*,
Extensions: Support online extensions and move add-ons outside Blender The extensions system allows to extend Blender with connectivity to the internet. Right now it means Blender can discover and install add-ons and themes directly from the internet, and notify users about their updates. By default this is disabled (opt-in), and users can enable it the first time they try to install an extension or visit the Prefences > Extensions tab. If this is enabled, Blender will automatically check for updates for extensions.blender.org upon startup. When will Blender access the remote repositories: * Every time you open the Preferences → Extensions: ALL the enabled repositories get checked for the latest info (json) * Every time you try to install by dragging: ALL the enabled repositories get checked for the latest info (json). * Every time you start Blender: selected repositories get checked for the latest info (json). ------------------ From the Blender code point of view, this means that most of the add-ons and themes originally bundled with Blender will now be available from the online platform, instead of bundled with Blender. The exception are add-ons which are deemed core functionality which just happened to be written as Python add-ons. Links: * Original Extenesions Platform Announcement: https://code.blender.org/2022/10/blender-extensions-platform/ * Extensions website: https://extensions.blender.org/ * User Manual: https://docs.blender.org/manual/en/4.2/extensions/index.html#extensions-index * Technical specifications: https://developer.blender.org/docs/features/extensions/ * Changes on add-ons bundling: https://devtalk.blender.org/t/changes-to-add-on-bundling-4-2-onwards/34593 ------------------ This PR does the following: * Move extensions out of experimental. * No longer install `scripts/addons` & `scripts/addons_contrib`. * Add `scripts/addons_core` to blender's repository. These add-ons will still be bundled with Blender and will be always enabled in the future, with their preferences moved to be more closely integrated with the rest of Blender. This will happen during the remaining bcon2 period. For more details, see #121830 From scripts/addons: * copy_global_transform.py * hydra_storm * io_anim_bvh * io_curve_svg * io_mesh_uv_layout * io_scene_fbx * io_scene_gltf2 * pose_library * ui_translate * viewport_vr_preview Extra: bl_pkg (scripts/addons_contrib) Note: The STL (legacy) add-on is going to be moved to the extensions platform. There is already a C++ version on core which is enabled by default. All the other add-ons are already available at extensions.blender.org. To use them you need to: * Go to User Preferences > Extensions * You will be greated with an "Online Extensions" message, click on "Enable Repository". * Search the add-on you are looking for (e.g, Import Images as Planes). * Click on Install Over time their maintaince will be transferred over to the community so their development can carry on. If you used to help maintain a bundled add-on please read: https://devtalk.blender.org/t/changes-to-add-on-bundling-4-2-onwards/34593 Ref: !121825
2024-05-15 12:21:00 +00:00
./scripts/addons_core/*,
Re-design of submodules used in blender.git This commit implements described in the #104573. The goal is to fix the confusion of the submodule hashes change, which are not ideal for any of the supported git-module configuration (they are either always visible causing confusion, or silently staged and committed, also causing confusion). This commit replaces submodules with a checkout of addons and addons_contrib, covered by the .gitignore, and locale and developer tools are moved to the main repository. This also changes the paths: - /release/scripts are moved to the /scripts - /source/tools are moved to the /tools - /release/datafiles/locale is moved to /locale This is done to avoid conflicts when using bisect, and also allow buildbot to automatically "recover" wgen building older or newer branches/patches. Running `make update` will initialize the local checkout to the changed repository configuration. Another aspect of the change is that the make update will support Github style of remote organization (origin remote pointing to thy fork, upstream remote pointing to the upstream blender/blender.git). Pull Request #104755
2023-02-21 15:39:58 +00:00
./scripts/modules/rna_manual_reference.py,
pyproject: remove tools/pyproject.toml Rely on ./pyproject.toml. This file was only separated because it was in an external repository.
2023-03-01 11:18:28 +00:00
./tools/svn_rev_map/sha1_to_rev.py,
./tools/svn_rev_map/rev_to_sha1.py,
pyproject: add configuration for autopep8 This adds pyproject.toml, needed to configure defaults for autopep8. The file is auto-discovered in a similar way to .clang-format, other tools could be configured here too. For now just configure autopep8 so this can be enabled in IDE's without causing unexpected edits such as wrapping lines over 80 columns in width. Now autopep8 can be used from the root directory by running: autopep8 . This uses multiple-jobs to run autopep8 over all Python scripts except paths that are explicitly ignored in exclude defined by pyproject.toml. Reviewed By: mont29, brecht, sybren Ref D14686
2022-04-19 05:50:35 +00:00
"""
pyproject: remove settings that cause other uses of autopep8 to fail While the ability to run `autopep8 .` to format Blender's Python code is handy, the settings to perform this can conflict with other uses of autopep8 (which editors may use to auto-format on save). Some arguments now need to be passed in, e.g: autopep8 . --in-place --recursive --jobs=0 We'll likely include this in `make format` convenience target so the details for invoking autopep8 shouldn't be an issue in the long term.
2022-04-24 03:20:17 +00:00
# Omit settings such as `jobs`, `in_place` & `recursive` as they can cause editor utilities that auto-format on save
# to fail if the STDIN/STDOUT is used for formatting (which isn't compatible with these options).
Black: skip string normalisation Black (the Python formatter) shouldn't be used on Blender. However, it is still the default formatter for some people's IDE (like mine). If it's accidentally used, its default behaviour is to normalise strings so they use double quotes. This string normalisation can be tedious to recover from. This PR configures Black so that it doesn't do that any more. This makes such a mistake easier to recover. An additional comment explains that Black shouldn't be used, and that the configuration is there just to make it less annoying in case of mistakes. For the same reasons, this commit also includes the config option `line_length = 120`. It just makes Black change less of our code when it's accidentally used.
2023-12-22 08:14:52 +00:00
# Black shouldn't be used as a formatter. But if it's accidentally
# used, it certainly shouldn't change all the quote marks around
# strings. This simply makes such a mistake easier to recover from.
[tool.black]
skip-string-normalization = true
line-length = 120
Reference in New Issue Copy Permalink