Method createScriptCommand

plugins/script/PythonModule.cpp:276–324

}

ScriptCommand::Ptr PythonModule::createScriptCommand(const std::string& scriptBasePath, const std::string& relativeScriptPath)
{
    try
    {
        auto fullPath = scriptBasePath + relativeScriptPath;

        // Create a new dictionary for the initialisation routine
        py::dict locals;

        // Disable the flag for initialisation, just to be sure
        locals["__executeCommand__"] = false;

        // Attempt to run the specified script
        py::eval_file(fullPath, getGlobals(), locals);

        std::string cmdName;
        std::string cmdDisplayName;

        if (locals.contains("__commandName__"))
        {
            cmdName = locals["__commandName__"].cast<std::string>();
        }

        if (locals.contains("__commandDisplayName__"))
        {
            cmdDisplayName = locals["__commandDisplayName__"].cast<std::string>();
        }

        if (!cmdName.empty())
        {
            if (cmdDisplayName.empty())
            {
                cmdDisplayName = cmdName;
            }

            // Successfully retrieved the command
            return std::make_shared<ScriptCommand>(cmdName, cmdDisplayName, relativeScriptPath);
        }

        rError() << "Script file " << relativeScriptPath << " does not export a __commandName__ value" << std::endl;
        return {};
    }
    catch (const py::error_already_set& ex)
    {
        rError() << "Script file " << relativeScriptPath << " is not a valid command:" << std::endl;
        rError() << ex.what() << std::endl;
        return {};
    }
}

PythonModule* PythonModule::_instance = nullptr;