c1bc70b711
A lot of files were missing copyright field in the header and
the Blender Foundation contributed to them in a sense of bug
fixing and general maintenance.
This change makes it explicit that those files are at least
partially copyrighted by the Blender Foundation.
Note that this does not make it so the Blender Foundation is
the only holder of the copyright in those files, and developers
who do not have a signed contract with the foundation still
hold the copyright as well.
Another aspect of this change is using SPDX format for the
header. We already used it for the license specification,
and now we state it for the copyright as well, following the
FAQ:
https://reuse.software/faq/
119 lines
2.9 KiB
C
119 lines
2.9 KiB
C
/* SPDX-FileCopyrightText: 2023 Blender Foundation
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
/** \file
|
|
* \ingroup pythonintern
|
|
*
|
|
* This file contains Blender/Python utility functions to help implementing API's.
|
|
* This is not related to a particular module.
|
|
*/
|
|
|
|
#include <Python.h>
|
|
|
|
#include "BLI_dynstr.h"
|
|
#include "BLI_listbase.h"
|
|
#include "BLI_utildefines.h"
|
|
|
|
#include "bpy_capi_utils.h"
|
|
|
|
#include "MEM_guardedalloc.h"
|
|
|
|
#include "BKE_context.h"
|
|
#include "BKE_report.h"
|
|
|
|
#include "BLT_translation.h"
|
|
|
|
#include "../generic/py_capi_utils.h"
|
|
|
|
short BPy_reports_to_error(ReportList *reports, PyObject *exception, const bool clear)
|
|
{
|
|
char *report_str;
|
|
|
|
report_str = BKE_reports_string(reports, RPT_ERROR);
|
|
|
|
if (clear == true) {
|
|
BKE_reports_clear(reports);
|
|
}
|
|
|
|
if (report_str) {
|
|
PyErr_SetString(exception, report_str);
|
|
MEM_freeN(report_str);
|
|
}
|
|
|
|
return (report_str == NULL) ? 0 : -1;
|
|
}
|
|
|
|
void BPy_reports_write_stdout(const ReportList *reports, const char *header)
|
|
{
|
|
if (header) {
|
|
PySys_WriteStdout("%s\n", header);
|
|
}
|
|
|
|
LISTBASE_FOREACH (const Report *, report, &reports->list) {
|
|
PySys_WriteStdout("%s: %s\n", report->typestr, report->message);
|
|
}
|
|
}
|
|
|
|
bool BPy_errors_to_report_ex(ReportList *reports,
|
|
const char *err_prefix,
|
|
const bool use_full,
|
|
const bool use_location)
|
|
{
|
|
|
|
if (!PyErr_Occurred()) {
|
|
return 1;
|
|
}
|
|
|
|
PyObject *err_str_py = use_full ? PyC_ExceptionBuffer() : PyC_ExceptionBuffer_Simple();
|
|
if (err_str_py == NULL) {
|
|
BKE_report(reports, RPT_ERROR, "Unknown py-exception, could not convert");
|
|
return 0;
|
|
}
|
|
|
|
/* Strip trailing newlines so the report doesn't show a blank-line in the info space. */
|
|
Py_ssize_t err_str_len;
|
|
const char *err_str = PyUnicode_AsUTF8AndSize(err_str_py, &err_str_len);
|
|
while (err_str_len > 0 && err_str[err_str_len - 1] == '\n') {
|
|
err_str_len -= 1;
|
|
}
|
|
|
|
if (err_prefix == NULL) {
|
|
/* Not very helpful, better than nothing. */
|
|
err_prefix = "Python";
|
|
}
|
|
|
|
const char *location_filepath = NULL;
|
|
int location_line_number = -1;
|
|
|
|
/* Give some additional context. */
|
|
if (use_location) {
|
|
PyC_FileAndNum(&location_filepath, &location_line_number);
|
|
}
|
|
|
|
if (location_filepath) {
|
|
BKE_reportf(reports,
|
|
RPT_ERROR,
|
|
"%s: %.*s\n"
|
|
/* Location (when available). */
|
|
"Location: %s:%d",
|
|
err_prefix,
|
|
(int)err_str_len,
|
|
err_str,
|
|
location_filepath,
|
|
location_line_number);
|
|
}
|
|
else {
|
|
BKE_reportf(reports, RPT_ERROR, "%s: %.*s", err_prefix, (int)err_str_len, err_str);
|
|
}
|
|
|
|
/* Ensure this is _always_ printed to the output so developers don't miss exceptions. */
|
|
Py_DECREF(err_str_py);
|
|
return 1;
|
|
}
|
|
|
|
bool BPy_errors_to_report(ReportList *reports)
|
|
{
|
|
return BPy_errors_to_report_ex(reports, NULL, true, true);
|
|
}
|