docs.unity3d.com
    Show / Hide Table of Contents

    Run Python script files from C#

    Use the PythonRunner.RunFile method to execute a Python script file from C#.

    Example: ensure GameObject names in the Scene

    Python script

    The following Python script loops over all the GameObjects in a Scene and makes sure all their names end up with an underscore.

    import UnityEngine
    
    all_objects = UnityEngine.Object.FindObjectsOfType(UnityEngine.GameObject)
    for go in all_objects:
        if go.name[-1] != '_':
            go.name = go.name + '_'
    

    Save this code as Assets/ensure_naming.py.

    C# code

    The following C# code creates a new menu item that calls the Python script file you just created.

    using UnityEditor.Scripting.Python;
    using UnityEditor;
    using UnityEngine;
    
    public class EnsureNaming
    {
        [MenuItem("MyPythonScripts/Ensure Naming")]
        static void RunEnsureNaming()
        {
            PythonRunner.RunFile($"{Application.dataPath}/ensure_naming.py");
        }
    }
    

    Test

    From the main menu of the Editor, select MyPythonScripts > Ensure Naming.

    All the GameObjects in the Hierarchy should now be suffixed with an underscore.

    Additional references

    • Call Python instructions from C#
    • Call Python APIs from C#
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023