realAscot/kicad-source
1
0
Fork 0
mirror of https://gitlab.com/kicad/code/kicad.git synced 2025-09-14 02:03:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add deprecation notices to SWIG API

Browse Source
This commit is contained in:
Jon Evans 2024-12-30 11:24:52 -05:00
parent 2cd28009ef
commit 3bc190e515
2 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
pcbnew/python/swig/pcbnew.i
View File

@ -30,6 +30,16 @@
%module pcbnew %module pcbnew
%pythoncode
{
import warnings
warnings.filterwarnings("default", category=DeprecationWarning, module=__name__)
warnings.warn("The SWIG-based Python interface to the PCB editor is deprecated and will be removed "
"in a future version of KiCad. Please plan to move to the new IPC API and/or make "
"use of the kicad-cli tool for your KiCad automation needs.",
category=DeprecationWarning)
}
%feature("autodoc", "1"); %feature("autodoc", "1");
#ifdef ENABLE_DOCSTRINGS_FROM_DOXYGEN #ifdef ENABLE_DOCSTRINGS_FROM_DOXYGEN
%include "docstrings.i" %include "docstrings.i"

6
scripting/kicad_pyshell/__init__.py
View File

@ -79,6 +79,12 @@ class KiCadPyShell(KiCadEditorNotebookFrame):
""" """
self.notebook = KiCadEditorNotebook(parent=self.parent) self.notebook = KiCadEditorNotebook(parent=self.parent)
intro = 'Py %s' % version.VERSION intro = 'Py %s' % version.VERSION
intro += """\n\nDeprecation Notice:\n
This SWIG-based Python interface to the PCB editor is deprecated and will be removed
in a future version of KiCad. Please plan to move to the new IPC API and/or make
use of the kicad-cli tool for your KiCad automation needs.\n\n"""
import types import types
import builtins import builtins
module = types.ModuleType('__main__') module = types.ModuleType('__main__')