From d64bd41ee920e14428a790f250ffe46c7ecccb63 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Thu, 2 Jan 2025 15:11:14 +1100 Subject: [PATCH] Cleanup: wrap long lines --- .../install_linux_packages.py | 98 +++++++++++++------ doc/python_api/examples/bpy.types.USDHook.py | 41 ++++---- 2 files changed, 90 insertions(+), 49 deletions(-) diff --git a/build_files/build_environment/install_linux_packages.py b/build_files/build_environment/install_linux_packages.py index 356287b8f30..4d1a484c0ba 100755 --- a/build_files/build_environment/install_linux_packages.py +++ b/build_files/build_environment/install_linux_packages.py @@ -543,63 +543,72 @@ def suse_pypackages_name_gen(name): PYTHON_SUBPACKAGES = ( - Package(name="Cython", version="0.29", version_short="0.29", version_min="0.20", version_mex="1.0", + Package(name="Cython", + version="0.29", version_short="0.29", version_min="0.20", version_mex="1.0", distro_package_names={DISTRO_ID_DEBIAN: "cython3", DISTRO_ID_FEDORA: "python3-Cython", DISTRO_ID_SUSE: suse_pypackages_name_gen("Cython"), DISTRO_ID_ARCH: "cython", }, ), - Package(name="IDNA", version="3.3", version_short="3.3", version_min="2.0", version_mex="4.0", + Package(name="IDNA", + version="3.3", version_short="3.3", version_min="2.0", version_mex="4.0", distro_package_names={DISTRO_ID_DEBIAN: "python3-idna", DISTRO_ID_FEDORA: "python3-idna", DISTRO_ID_SUSE: suse_pypackages_name_gen("idna"), DISTRO_ID_ARCH: "python-idna", }, ), - Package(name="Charset Normalizer", version="2.0.10", version_short="2.0", version_min="2.0.6", version_mex="4.0.0", + Package(name="Charset Normalizer", + version="2.0.10", version_short="2.0", version_min="2.0.6", version_mex="4.0.0", distro_package_names={DISTRO_ID_DEBIAN: "python3-charset-normalizer", DISTRO_ID_FEDORA: "python3-charset-normalizer", DISTRO_ID_SUSE: suse_pypackages_name_gen("charset-normalizer"), DISTRO_ID_ARCH: "python-charset-normalizer", }, ), - Package(name="URLLib", version="1.26.8", version_short="1.26", version_min="1.0", version_mex="2.0", + Package(name="URLLib", + version="1.26.8", version_short="1.26", version_min="1.0", version_mex="2.0", distro_package_names={DISTRO_ID_DEBIAN: "python3-urllib3", DISTRO_ID_FEDORA: "python3-urllib3", DISTRO_ID_SUSE: suse_pypackages_name_gen("urllib3"), DISTRO_ID_ARCH: "python-urllib3", }, ), - Package(name="Certifi", version="2021.10.08", version_short="2021.10", version_min="2021.0", version_mex="2025.0", + Package(name="Certifi", + version="2021.10.08", version_short="2021.10", version_min="2021.0", version_mex="2025.0", distro_package_names={DISTRO_ID_DEBIAN: "python3-certifi", DISTRO_ID_FEDORA: "python3-certifi", DISTRO_ID_SUSE: suse_pypackages_name_gen("certifi"), DISTRO_ID_ARCH: "python-certifi", }, ), - Package(name="Requests", version="2.27.1", version_short="2.27", version_min="2.0", version_mex="3.0", + Package(name="Requests", + version="2.27.1", version_short="2.27", version_min="2.0", version_mex="3.0", distro_package_names={DISTRO_ID_DEBIAN: "python3-requests", DISTRO_ID_FEDORA: "python3-requests", DISTRO_ID_SUSE: suse_pypackages_name_gen("requests"), DISTRO_ID_ARCH: "python-requests", }, ), - Package(name="ZStandard", version="0.16.0", version_short="0.16", version_min="0.15.2", version_mex="1.0.0", + Package(name="ZStandard", + version="0.16.0", version_short="0.16", version_min="0.15.2", version_mex="1.0.0", distro_package_names={DISTRO_ID_DEBIAN: "python3-zstandard", DISTRO_ID_FEDORA: "python3-zstandard", DISTRO_ID_SUSE: suse_pypackages_name_gen("zstandard"), DISTRO_ID_ARCH: "python-zstandard", }, ), - Package(name="NumPy", version="1.24.3", version_short="1.24", version_min="1.14", version_mex="2.0", + Package(name="NumPy", + version="1.24.3", version_short="1.24", version_min="1.14", version_mex="2.0", distro_package_names={DISTRO_ID_DEBIAN: "python3-numpy", DISTRO_ID_FEDORA: "python3-numpy", DISTRO_ID_SUSE: suse_pypackages_name_gen("numpy"), DISTRO_ID_ARCH: "python-numpy", }, ), - Package(name="NumPy Devel", version="1.24.3", version_short="1.24", version_min="1.14", version_mex="2.0", + Package(name="NumPy Devel", + version="1.24.3", version_short="1.24", version_min="1.14", version_mex="2.0", distro_package_names={DISTRO_ID_DEBIAN: ..., DISTRO_ID_FEDORA: ..., DISTRO_ID_SUSE: suse_pypackages_name_gen("numpy-devel"), @@ -722,14 +731,16 @@ PACKAGES_ALL = ( Package(name="Basic Mandatory Deps", is_group=True, is_mandatory=True, sub_packages=DEPS_MANDATORY_SUBPACKAGES), Package(name="Basic Optional Deps", is_group=True, is_mandatory=False, sub_packages=DEPS_OPTIONAL_SUBPACKAGES), - Package(name="Clang Format", version="10.0", version_short="10.0", version_min="6.0", version_mex="15.0", + Package(name="Clang Format", + version="10.0", version_short="10.0", version_min="6.0", version_mex="15.0", distro_package_names={DISTRO_ID_DEBIAN: "clang-format", DISTRO_ID_FEDORA: "clang", # clang-format is part of the main clang package. DISTRO_ID_SUSE: "clang", # clang-format is part of the main clang package. DISTRO_ID_ARCH: "clang", # clang-format is part of the main clang package. }, ), - Package(name="Python", is_mandatory=True, version="3.11.9", version_short="3.11", version_min="3.11", version_mex="3.13", + Package(name="Python", is_mandatory=True, + version="3.11.9", version_short="3.11", version_min="3.11", version_mex="3.13", sub_packages=PYTHON_SUBPACKAGES, distro_package_names={DISTRO_ID_DEBIAN: "python3-dev", DISTRO_ID_FEDORA: "python3-devel", @@ -737,7 +748,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "python", }, ), - Package(name="Boost Libraries", is_mandatory=True, version="1.82.0", version_short="1.82", version_min="1.49", version_mex="2.0", + Package(name="Boost Libraries", is_mandatory=True, + version="1.82.0", version_short="1.82", version_min="1.49", version_mex="2.0", sub_packages=BOOST_SUBPACKAGES, distro_package_names={DISTRO_ID_DEBIAN: "libboost-dev", DISTRO_ID_FEDORA: "boost-devel", @@ -745,7 +757,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "boost", }, ), - Package(name="TBB Library", is_mandatory=True, version="2020", version_short="2020", version_min="2018", version_mex="2022", + Package(name="TBB Library", is_mandatory=True, + version="2020", version_short="2020", version_min="2018", version_mex="2022", sub_packages=(), distro_package_names={DISTRO_ID_DEBIAN: "libtbb-dev", DISTRO_ID_FEDORA: "tbb-devel", @@ -753,7 +766,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "intel-oneapi-tbb", }, ), - Package(name="OpenColorIO Library", is_mandatory=False, version="2.3.2", version_short="2.3", version_min="2.0", version_mex="3.0", + Package(name="OpenColorIO Library", is_mandatory=False, + version="2.3.2", version_short="2.3", version_min="2.0", version_mex="3.0", sub_packages=(), distro_package_names={DISTRO_ID_DEBIAN: "libopencolorio-dev", DISTRO_ID_FEDORA: "OpenColorIO-devel", @@ -761,7 +775,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "opencolorio", }, ), - Package(name="IMath Library", is_mandatory=False, version="3.2.1", version_short="3.2", version_min="3.0", version_mex="4.0", + Package(name="IMath Library", is_mandatory=False, + version="3.2.1", version_short="3.2", version_min="3.0", version_mex="4.0", sub_packages=(), distro_package_names={DISTRO_ID_DEBIAN: "libimath-dev", DISTRO_ID_FEDORA: "imath-devel", @@ -769,7 +784,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "imath", }, ), - Package(name="OpenEXR Library", is_mandatory=False, version="3.2.4", version_short="3.2", version_min="3.0", version_mex="4.0", + Package(name="OpenEXR Library", is_mandatory=False, + version="3.2.4", version_short="3.2", version_min="3.0", version_mex="4.0", sub_packages=(), distro_package_names={DISTRO_ID_DEBIAN: "libopenexr-dev", DISTRO_ID_FEDORA: "openexr-devel", @@ -777,7 +793,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "openexr", }, ), - Package(name="OpenImageIO Library", is_mandatory=True, version="2.5.11.0", version_short="2.5", version_min="2.5.0", version_mex="2.6.0", + Package(name="OpenImageIO Library", is_mandatory=True, + version="2.5.11.0", version_short="2.5", version_min="2.5.0", version_mex="2.6.0", sub_packages=( Package(name="OpenImageIO Tools", is_mandatory=False, distro_package_names={DISTRO_ID_DEBIAN: "openimageio-tools", @@ -793,7 +810,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "openimageio", }, ), - Package(name="LLVM Library", is_mandatory=False, version="17.0.6", version_short="17.0", version_min="15.0", version_mex="18.0", + Package(name="LLVM Library", is_mandatory=False, + version="17.0.6", version_short="17.0", version_min="15.0", version_mex="18.0", sub_packages=( Package(name="Clang Compiler", is_mandatory=False, distro_package_names={DISTRO_ID_DEBIAN: "clang", @@ -816,7 +834,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "llvm", }, ), - Package(name="OpenShadingLanguage Library", is_mandatory=False, version="1.13.2.0", version_short="1.13", version_min="1.11", version_mex="2.0", + Package(name="OpenShadingLanguage Library", is_mandatory=False, + version="1.13.2.0", version_short="1.13", version_min="1.11", version_mex="2.0", sub_packages=(), distro_package_names={DISTRO_ID_DEBIAN: None, # No package currently. DISTRO_ID_FEDORA: "openshadinglanguage-devel", @@ -824,7 +843,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "openshadinglanguage", }, ), - Package(name="OpenSubDiv Library", is_mandatory=False, version="3.6.0", version_short="3.6", version_min="3.5", version_mex="4.0", + Package(name="OpenSubDiv Library", is_mandatory=False, + version="3.6.0", version_short="3.6", version_min="3.5", version_mex="4.0", sub_packages=(), distro_package_names={DISTRO_ID_DEBIAN: "libosd-dev", DISTRO_ID_FEDORA: "opensubdiv-devel", @@ -832,7 +852,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "opensubdiv", }, ), - Package(name="OpenVDB Library", is_mandatory=False, version="11.0.0", version_short="11.0", version_min="10.0", version_mex="12.0", + Package(name="OpenVDB Library", is_mandatory=False, + version="11.0.0", version_short="11.0", version_min="10.0", version_mex="12.0", sub_packages=( # Assume packaged versions of the dependencies are compatible with OpenVDB package. Package(name="OpenVDB Dependencies", is_mandatory=False, is_group=True, @@ -860,7 +881,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "openvdb", }, ), - Package(name="Alembic Library", is_mandatory=False, version="1.8.3", version_short="1.8", version_min="1.7", version_mex="2.0", + Package(name="Alembic Library", is_mandatory=False, + version="1.8.3", version_short="1.8", version_min="1.7", version_mex="2.0", sub_packages=(), distro_package_names={DISTRO_ID_DEBIAN: None, DISTRO_ID_FEDORA: "alembic-devel", @@ -868,7 +890,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "alembic", }, ), - Package(name="MaterialX Library", is_mandatory=False, version="1.38.8", version_short="1.38", version_min="1.38", version_mex="1.40", + Package(name="MaterialX Library", is_mandatory=False, + version="1.38.8", version_short="1.38", version_min="1.38", version_mex="1.40", sub_packages=(), distro_package_names={DISTRO_ID_DEBIAN: None, DISTRO_ID_FEDORA: None, @@ -876,7 +899,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "materialx-git", }, ), - Package(name="USD Library", is_mandatory=False, version="24.05", version_short="24.05", version_min="22.05", version_mex="25.00", + Package(name="USD Library", is_mandatory=False, + version="24.05", version_short="24.05", version_min="22.05", version_mex="25.00", sub_packages=(), distro_package_names={DISTRO_ID_DEBIAN: None, DISTRO_ID_FEDORA: "usd-devel", @@ -884,14 +908,16 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "usd", # No official package, in AUR only currently. }, ), - Package(name="OpenCollada Library", is_mandatory=False, version="1.6.68", version_short="1.6", version_min="1.6.68", version_mex="1.7", + Package(name="OpenCollada Library", is_mandatory=False, + version="1.6.68", version_short="1.6", version_min="1.6.68", version_mex="1.7", distro_package_names={DISTRO_ID_DEBIAN: "opencollada-dev", # Useless, very old! DISTRO_ID_FEDORA: "openCOLLADA-devel", DISTRO_ID_SUSE: "libopenCOLLADA-devel", DISTRO_ID_ARCH: "opencollada", }, ), - Package(name="Embree Library", is_mandatory=False, version="4.3.2", version_short="4.3", version_min="3.13", version_mex="5.0", + Package(name="Embree Library", is_mandatory=False, + version="4.3.2", version_short="4.3", version_min="3.13", version_mex="5.0", sub_packages=(), distro_package_names={DISTRO_ID_DEBIAN: "libembree-dev", DISTRO_ID_FEDORA: "embree-devel", @@ -899,7 +925,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "embree", }, ), - Package(name="OpenImageDenoiser Library", is_mandatory=False, version="2.3.0", version_short="2.3", version_min="2.0.0", version_mex="3.0", + Package(name="OpenImageDenoiser Library", is_mandatory=False, + version="2.3.0", version_short="2.3", version_min="2.0.0", version_mex="3.0", sub_packages=(), distro_package_names={DISTRO_ID_DEBIAN: None, DISTRO_ID_FEDORA: "oidn-devel", @@ -907,7 +934,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "openimagedenoise", }, ), - Package(name="Level Zero Library", is_mandatory=False, version="1.16.1", version_short="1.16", version_min="1.7", version_mex="2.0", + Package(name="Level Zero Library", is_mandatory=False, + version="1.16.1", version_short="1.16", version_min="1.7", version_mex="2.0", sub_packages=(), distro_package_names={DISTRO_ID_DEBIAN: None, DISTRO_ID_FEDORA: "oneapi-level-zero-devel", @@ -915,7 +943,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "level-zero-headers", # ??? }, ), - Package(name="OpenPGL Library", is_mandatory=False, version="0.6.0", version_short="0.6", version_min="0.5.0", version_mex="0.7", + Package(name="OpenPGL Library", is_mandatory=False, + version="0.6.0", version_short="0.6", version_min="0.5.0", version_mex="0.7", sub_packages=(), distro_package_names={DISTRO_ID_DEBIAN: None, DISTRO_ID_FEDORA: "openpgl-devel", @@ -923,7 +952,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "openpgl", }, ), - Package(name="XROpenXR Library", is_mandatory=False, version="1.0.22", version_short="1.0", version_min="1.0.8", version_mex="2.0", + Package(name="XROpenXR Library", is_mandatory=False, + version="1.0.22", version_short="1.0", version_min="1.0.8", version_mex="2.0", sub_packages=(), distro_package_names={DISTRO_ID_DEBIAN: "libopenxr-dev", DISTRO_ID_FEDORA: None, @@ -931,7 +961,8 @@ PACKAGES_ALL = ( DISTRO_ID_ARCH: "openxr", }, ), - Package(name="FFMPEG Library", is_mandatory=False, version="6.0", version_short="6.0", version_min="4.0", version_mex="7.0", + Package(name="FFMPEG Library", is_mandatory=False, + version="6.0", version_short="6.0", version_min="4.0", version_mex="7.0", sub_packages=( Package(name="AVDevice FFMPEG Library", is_mandatory=False, distro_package_names={DISTRO_ID_DEBIAN: "libavdevice-dev", @@ -1746,7 +1777,10 @@ def argparse_create(): "--no-sudo", dest="no_sudo", action='store_true', - help="Disable use of `sudo` or `doas` (this script won't be able to do much then, will just print needed packages).", + help=( + "Disable use of `sudo` or `doas` " + "(this script won't be able to do much then, will just print needed packages)." + ), ) parser.add_argument( "--all", diff --git a/doc/python_api/examples/bpy.types.USDHook.py b/doc/python_api/examples/bpy.types.USDHook.py index 64689ed940c..667295b9676 100644 --- a/doc/python_api/examples/bpy.types.USDHook.py +++ b/doc/python_api/examples/bpy.types.USDHook.py @@ -51,7 +51,8 @@ Called after the USD import finalizes. Args: -- ``import_context`` (`USDSceneImportContext`_): Provides access to the stage and a map associating USD prim paths and Blender IDs +- ``import_context`` (`USDSceneImportContext`_): + Provides access to the stage and a map associating USD prim paths and Blender IDs Returns: @@ -72,15 +73,15 @@ Returns: - ``True`` if the hook can convert the material or ``False`` otherwise -If any hook returns ``True`` from ``material_import_poll``, the USD importer will skip standard ``USD Preview Surface`` or -``MaterialX`` import and invoke the hook's `on_material_import`_ method to convert the material instead. +If any hook returns ``True`` from ``material_import_poll``, the USD importer will skip standard ``USD Preview Surface`` +or ``MaterialX`` import and invoke the hook's `on_material_import`_ method to convert the material instead. on_material_import ^^^^^^^^^^^^^^^^^^ Called for each material that is imported, to allow converting the USD material to nodes on the Blender material. -To ensure that this function gets called, the hook must also implement the ``material_import_poll()`` callback to return -``True`` for the given USD material. +To ensure that this function gets called, the hook must also implement the ``material_import_poll()`` +callback to return ``True`` for the given USD material. Args: @@ -119,9 +120,10 @@ Methods: - ``get_stage()``: returns the USD stage to be saved - ``export_texture(image: bpy.types.Image)``: Returns the USD asset path for the given texture image -The ``export_texture`` function will save in-memory images and may copy texture assets, depending on the current USD export options. -For example, by default calling ``export_texture(/foo/bar.png)`` will copy the file to a ``textures`` directory next to the exported -USD and will return the relative path ``./textures/bar.png``. +The ``export_texture`` function will save in-memory images and may copy texture assets, +depending on the current USD export options. +For example, by default calling ``export_texture(/foo/bar.png)`` will copy the file to a ``textures`` +directory next to the exported USD and will return the relative path ``./textures/bar.png``. USDSceneImportContext @@ -131,8 +133,9 @@ Argument for `on_import`_. Methods: -- ``get_prim_map()`` returns a ``dict`` where the key is an imported USD Prim path and the value a ``list`` of the IDs created by the imported prim -- ``get_stage()`` returns the USD stage which was imported +- ``get_prim_map()`` returns a ``dict`` where the key is an imported USD Prim path and the value a ``list`` + of the IDs created by the imported prim. +- ``get_stage()`` returns the USD stage which was imported. USDMaterialImportContext @@ -142,14 +145,18 @@ Argument for `material_import_poll`_ and `on_material_import`_. Methods: -- ``get_stage()``: returns the USD stage to be saved -- ``import_texture(asset_path: str)``: for the given USD texture asset path, returns a ``tuple[str, bool]``, containing the asset's local path and a bool indicating whether the path references a temporary file +- ``get_stage()``: + returns the USD stage to be saved. +- ``import_texture(asset_path: str)``: + for the given USD texture asset path, returns a ``tuple[str, bool]``, + containing the asset's local path and a bool indicating whether the path references a temporary file. -The ``import_texture`` function may copy the texture to the local file system if the given asset path is a package-relative path for a -USDZ archive, depending on the current USD ``Import Textures`` options. When the ``Import Textures`` mode is ``Packed``, the texture -is saved to a temporary location and the second element of the returned tuple is ``True``, indicating that the file is temporary, in which -case it may be necessary to pack the image. The original asset path will be returned unchanged if it's already a local file or if it could not -be copied to a local destination. +The ``import_texture`` function may copy the texture to the local file system if the given asset path is a +package-relative path for a USDZ archive, depending on the current USD ``Import Textures`` options. +When the ``Import Textures`` mode is ``Packed``, the texture is saved to a temporary location and the +second element of the returned tuple is ``True``, indicating that the file is temporary, in which +case it may be necessary to pack the image. The original asset path will be returned unchanged if it's +already a local file or if it could not be copied to a local destination. Errors