kicad-source/scripting/python_manager.h
Seth Hillbrand 0b2d4d4879 Revise Copyright statement to align with TLF
Recommendation is to avoid using the year nomenclature as this
information is already encoded in the git repo.  Avoids needing to
repeatly update.

Also updates AUTHORS.txt from current repo with contributor names
2025-01-01 14:12:04 -08:00

61 lines
2.0 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2023 Jon Evans <jon@craftyjon.com>
* Copyright The KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef KICAD_PYTHON_MANAGER_H
#define KICAD_PYTHON_MANAGER_H
#include <functional>
#include <optional>
#include <wx/wx.h>
#include <kicommon.h>
class KICOMMON_API PYTHON_MANAGER
{
public:
PYTHON_MANAGER( const wxString& aInterpreterPath );
void Execute( const wxString& aArgs,
const std::function<void(int, const wxString&, const wxString&)>& aCallback,
const wxExecuteEnv* aEnv = nullptr );
wxString GetInterpreterPath() const { return m_interpreterPath; }
void SetInterpreterPath( const wxString& aPath ) { m_interpreterPath = aPath; }
/**
* Searches for a Python intepreter on the user's system
* @return the absolute path to a Python interpreter, or an empty string if one was not found
*/
static wxString FindPythonInterpreter();
static std::optional<wxString> GetPythonEnvironment( const wxString& aNamespace );
/// Returns a full path to the python binary in a venv, if it exists
static std::optional<wxString> GetVirtualPython( const wxString& aNamespace );
private:
wxString m_interpreterPath;
};
#endif //KICAD_PYTHON_MANAGER_H