PythonConfig.h

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// -                        CloudViewer: www.cloudViewer.org                  -
// ----------------------------------------------------------------------------
// Copyright (c) 2018-2024 www.cloudViewer.org
// SPDX-License-Identifier: MIT
// ----------------------------------------------------------------------------
 
#pragma once
 
#include <QString>
#include <QtGlobal>
 
// Qt5/Qt6 Compatibility
#include <QtCompat.h>
 
#include <memory>
 
#undef slots
#include <pybind11/pybind11.h>
 
struct PyVenvCfg;
class QProcess;
class PythonConfigPaths;
class QWidget;
 
struct Version
{
    constexpr Version() = default;
 
    constexpr Version(uint16_t major_, uint16_t minor_, uint16_t patch_)
        : versionMajor(major_), versionMinor(minor_), versionPatch(patch_)
    {
    }
 
    explicit Version(const QtCompatStringRef &versionStr);
 
    bool isCompatibleWithCompiledVersion() const;
 
    bool isNull() const
    {
        return versionMajor == 0 && versionMinor == 0 && versionPatch == 0;
    };
 
    bool operator==(const Version &other) const;
 
    uint16_t versionMajor{0};
    uint16_t versionMinor{0};
    uint16_t versionPatch{0};
};
 
constexpr Version PythonVersion(PY_MAJOR_VERSION, PY_MINOR_VERSION, PY_MICRO_VERSION);
 
class PythonConfig final
{
  public:
    enum class Type
    {
        Venv,
        Conda,
        System,
        Bundled
    };
 
    PythonConfig() = default;
 
    Type type() const
    {
        return m_type;
    }
 
    template <class ostream> friend ostream &operator<<(ostream &o, Type type)
    {
        switch (type)
        {
        case Type::Venv:
            o << "Venv";
            break;
        case Type::Conda:
            o << "Conda";
            break;
        case Type::System:
            o << "System";
            break;
        case Type::Bundled:
            o << "Bundled";
            break;
        }
        return o;
    }
 
    const QString &pythonHome() const
    {
        return m_pythonHome;
    }
 
    void preparePythonProcess(QProcess &pythonProcess) const;
 
    PythonConfigPaths pythonCompatiblePaths() const;
 
    Version getVersion() const;
 
    bool validateAndDisplayErrors(QWidget *parent = nullptr) const;
 
    static bool IsInsideEnvironment();
    static PythonConfig fromContainingEnvironment();
 
    void initDefault();
    void initBundled();
    void initFromLocation(const QString &prefix);
    void initCondaEnv(const QString &condaPrefix);
    void initVenv(const QString &venvPrefix);
 
    void initFromPythonExecutable(const QString &pythonExecutable);
 
    template <class ostream> friend ostream &operator<<(ostream &o, const PythonConfig &config)
    {
        o << "PythonConfig { type: " << config.m_type << ", home: '" << config.m_pythonHome
          << "', path: '" << config.m_pythonPath << "'}";
        return o;
    }
 
  private:
    QString m_pythonHome{};
    QString m_pythonPath{};
    Type m_type{Type::Bundled};
};
 
class PythonConfigPaths final
{
    friend PythonConfig;
 
  public:
    PythonConfigPaths() = default;
 
    bool isSet() const;
 
    const wchar_t *pythonHome() const;
 
    const wchar_t *pythonPath() const;
 
  private:
    std::unique_ptr<wchar_t[]> m_pythonHome{};
    std::unique_ptr<wchar_t[]> m_pythonPath{};
};