Depuración de scripts

De un vistazo

La depuración de scripts en Altium Designer comienza por comprender dónde se producen los errores y cómo examinar la ejecución de los scripts. Este artículo explora las herramientas para pausar y seguir el código, comprobar los valores de las variables y seguir las llamadas a procedimientos, además del manejo de excepciones y los mensajes para informar al usuario. Sigue leyendo para ganar confianza a la hora de detectar y resolver errores en los scripts.

- Aprende cómo los puntos de interrupción y las funciones Step Into, Step Over y Run To Cursor te ayudan a investigar el comportamiento de los scripts.
- Descubre cómo las herramientas de inspección de variables y el panel Call Stack permiten ver lo que ocurre durante la ejecución.
- Comprende cómo los controladores de excepciones de DelphiScript y los cuadros de diálogo de mensajes facilitan el manejo de errores y la comunicación con el usuario.
Profundiza con IA:
 

El sistema de scripting de Altium Designer ofrece un entorno de depuración completo. El depurador de scripts le ayuda a identificar y resolver errores en los scripts mediante una serie de herramientas automatizadas y paneles de información.

Errores de script

Entre los errores habituales se incluyen métodos no válidos, operadores de agrupación mal colocados, tipos incompatibles, errores lógicos y errores tipográficos. Cuando el sistema de scripting encuentra un error, el depurador pausa el script y muestra un cuadro de diálogo que indica el problema.

El siguiente ejemplo muestra un script al que le falta un carácter de terminación y el mensaje correspondiente del cuadro de diálogo de error.

 El depurador pausará un script si se producen errores de compilación o de ejecución.

Una vez cerrado el cuadro de diálogo de error, se puede corregir el código y volver a ejecutar el script. Si es necesario detener el script, por ejemplo, al ejecutarlo paso a paso, utilice el comando Stop (Run » Stop, Ctrl+F3) o el botón ( de la barra de herramientas Script Debug).

En algunas situaciones, un error puede hacer que un script quede atrapado en un bucle infinito y deje de responder. Para solucionar este problema, pulse la combinación de teclas Ctrl+Pause/Break para interrumpir el bucle del script.

Depuración de scripts

El sistema de scripting dispone de diversas herramientas que facilitan la depuración de scripts. Estas permiten, entre otras cosas, establecer varios puntos de interrupción en un script, utilizar el panel Watch List para supervisar el valor de las variables, utilizar marcadores para desplazarse con mayor eficacia y utilizar las funciones de ejecución paso a paso por instrucciones y por procedimientos para seguir la ejecución de los scripts.

Por ejemplo, se pueden utilizar las siguientes funciones para comprobar los valores de las variables y expresiones de un script:

► Consulte Herramientas del editor de scripts para obtener información sobre el uso de las herramientas del editor al depurar scripts.

Si está depurando un script que actúa sobre un documento abierto, por ejemplo, al utilizar la interfaz IPCB_Board para obtener datos de un documento de PCB, el editor de scripts no podrá detectarlo como documento activo. En este caso, guarde los cambios realizados y ejecute el script desde el propio documento activo (File » Run Script).

Seguimiento de la ejecución

Para ayudar a localizar y resolver un error desconocido en un script, se pueden insertar varios puntos de interrupción para pausar el código en distintos puntos mientras se comprueban los valores de las variables y expresiones.

Sin embargo, siempre que el script esté en pausa, también se puede avanzar una línea funcional cada vez mediante las funciones de seguimiento y ejecución paso a paso del depurador. De este modo, se puede utilizar un punto de interrupción para pausar inicialmente el script en la zona de interés y, a continuación, avanzar línea a línea mediante la función de seguimiento. El proceso de ejecutar un script línea a línea se denomina seguimiento o ejecución paso a paso del script.

El depurador de scripts ofrece comandos relacionados con el seguimiento: paso a paso por instrucciones (Run » Step Into) y paso a paso por procedimientos (Run » Step Over). Esto permite seguir el proceso del script y analizar su comportamiento al depurar su código.

Los comandos de depuración disponibles en el menú Run .
Los comandos de depuración disponibles en el menú Run .

Comando Step Into

El proceso Step Into ejecuta el script una instrucción cada vez. El comando está disponible en el menú Run , en su botón asociado de la barra de herramientas Script Debug () o mediante la tecla de acceso directo F7 .

Si la instrucción que se está ejecutando llama a otro procedimiento, la ejecución paso a paso por instrucciones transfiere el control a la primera línea del procedimiento llamado. El resaltado de color verde guisante del editor indica la línea de código en la que se encuentra el script. La ejecución paso a paso del script se cancela con el comando Run » Stop, el acceso directo Ctrl+F3 o el botón de la barra de herramientas ().

Comando Step Over

El proceso Step Over es similar a Step Into, excepto en que, si la instrucción actual es una llamada a otro procedimiento, el procedimiento llamado se ejecuta por completo sin detenerse, en lugar de recorrerlo paso a paso. El comando está disponible en el menú Run , en su botón asociado () o mediante la tecla de acceso directo F8 .

Este comando resulta útil cuando se ha determinado que un procedimiento called no es la causa del problema en el procedimiento actual y evita tener que recorrer innecesariamente el procedimiento llamado línea a línea: se ejecuta todo ese procedimiento en un solo paso.

Utilice el comando Run » Run To Cursor de los menús principales (acceso directo: Ctrl+F9) para ejecutar un script hasta la posición del cursor. El script se pausa en esa línea como si hubiera encontrado un punto de interrupción; desde allí se puede continuar su ejecución o ejecutarlo paso a paso.

Panel Call Stack

El panel Call Stack se utiliza para ver la cadena de procedimientos y funciones que han llevado al punto actual de ejecución del script que se está depurando.

El panel Call Stack
El panel Call Stack

A medida que depura el script paso a paso, el panel muestra el nombre de cada función o procedimiento en el que entra.

Cuando se encuentra una llamada a otra función o procedimiento, el panel muestra el nombre de esa función o procedimiento adicional al entrar en él. Puesto que la función o el procedimiento se llama desde otra función o procedimiento, el original sigue apareciendo en el panel.

De este modo se crea una «pila de llamadas» que muestra la relación entre las llamadas sucesivas a funciones o procedimientos. La función o el procedimiento original aparece en la parte inferior de la pila, y cada función o procedimiento llamado posteriormente aparece encima, hasta llegar a la función o el procedimiento actual, situado en la parte superior.

Cuando la ejecución del script sale de una subfunción o un subprocedimiento y vuelve a la función o al procedimiento que lo llamó, el primero se elimina de la pila y el que realizó la llamada pasa a ocupar la parte superior.

Al hacer doble clic en una entrada del panel, se salta a la línea correspondiente del script en la que se realiza la llamada a la función o al procedimiento seleccionado. La línea se resalta con el color asociado a los errores de scripting y se muestra el marcador de error de scripting en el margen derecho. Esto se utiliza únicamente para resaltar la línea. Desaparece al hacer clic en el documento y no interfiere de ningún modo en la sesión de depuración.

Excepciones y mensajes

Como suele ocurrir en todos los proyectos de programación, el desarrollo y la depuración del código de un script no terminan necesariamente cuando se consigue un script que «funciona». Es probable que, durante su uso real, un script encuentre errores imprevistos o no produzca los resultados esperados.

Afortunadamente, el sistema de scripting se puede utilizar de varias formas para gestionar las excepciones de ejecución y proporcionar al usuario información sobre el funcionamiento del script.

Controladores de excepciones

En DelphiScript, la palabra clave try introduce una instrucción try-except o una instrucción try-finally. Estas dos instrucciones están relacionadas, pero tienen finalidades distintas.

Try Finally

En un controlador Try-Finally, las instrucciones del bloque finally siempre se ejecutan, independientemente de si se ha producido una excepción en el bloque try. Utilice el bloque try-finally para liberar objetos temporales u otros recursos y realizar tareas de limpieza.

Reset(F);
Try
  // process file F
Finally
  CloseFile(F);
End;

Try Except

Utilice la sentencia Try-Except para capturar las excepciones generadas y ejecutar el código de gestión de errores correspondiente. Por ejemplo, se puede capturar una excepción específica y actualizar un registro o abrir un cuadro de diálogo con una descripción del error. Una excepción en el código del bloque try provoca la ejecución del bloque except.

En el siguiente ejemplo, se llama al procedimiento ApplyOffset, con los parámetros adecuados, desde el procedimiento DefineOffset. El procedimiento realiza un cálculo de división sencillo (con las variables Ydim y Zdim ) y muestra el resultado (Offset) en un cuadro de diálogo estándar.

Procedure ApplyOffset(Ydim, Zdim);
Var
   Offset;
Begin;
   Try
      Offset := Ydim div Zdim;
      ShowInfo('Calculated Offset = ' + IntToStr(Offset));
   Except
      ShowWarning('Entered Z dimension must be greater than zero.');
   End;
End;

Procedure DefineOffset;
Begin;
   ApplyOffset(32, 4);
End;

Con los parámetros de ApplyOffset indicados anteriormente (32,4), el script ejecutado mostrará el resultado calculado mediante el procedimiento ShowMessage, como se muestra a continuación.

Por otro lado, si se cambian los parámetros pasados a 32,0 (ApplyOffset(32, 0);), se provoca una excepción de división por cero en el cálculo Offset, lo que activa el bloque de gestión Except. Este utiliza el procedimiento ShowWarning para mostrar el cuadro de diálogo Warning correspondiente.

En el modo de depuración del editor de scripts, una excepción pausará la ejecución del script al cerrar el cuadro de diálogo Error . Utilice el comando Run o Step Into para continuar.

Raise

En el sencillo procedimiento de gestión de errores anterior, se supone que la excepción se genera como respuesta a un error de división por cero, pero esto significa que el texto del cuadro de diálogo de advertencia no describirá con precisión otros tipos de excepciones. Sin embargo, en este ejemplo, es la excepción que tiene más probabilidades de producirse.

No obstante, desde la perspectiva del usuario, conviene disponer de algún mecanismo de detección de errores específicos. En DelphiScript no se admite la palabra clave On de Delphi (para capturar un tipo de excepción específico), pero la sentencia Raise se puede utilizar dentro de un bloque Except para volver a generar la excepción más reciente (sea cual sea su tipo).

Try
   Offset := Ydim div Zdim;
   ShowInfo('Calculated Offset = ' + IntToStr(Offset));
Except
   Raise;
End;

De este modo, cuando la mayor parte del código de un procedimiento se encuentra dentro del bloque try de una sentencia try-except, se puede informar de todas las excepciones mediante la sentencia Raise . Tenga en cuenta que el cuadro de diálogo de excepción solo mostrará mensajes de error genéricos, en lugar de información específica del script.

   

La sentencia Raise se puede utilizar sin parámetros para volver a generar la última excepción, o con un parámetro de cadena para mostrar un mensaje de error específico.

Raise también se puede utilizar para provocar una excepción como respuesta a comprobaciones específicas, por ejemplo, mediante sentencias if-then o case sencillas.

Procedure ApplyOffset(Ydim, Zdim);
Var
   Offset;
Begin;
   if Zdim > Ydim then
      Begin;
         Raise('Z dimension must be smaller than Y dimension.');
      End;
   Offset := Ydim div Zdim;
   ShowInfo('Calculated Offset = ' + IntToStr(Offset));
End;

En este caso, si el parámetro Zdim del ejemplo anterior es mayor que el parámetro Ydim, se genera una excepción (con un mensaje).

Errores en scripts de VB

La implementación de VBScript en el motor de scripts de Altium Designer dispone de funciones integradas que se pueden utilizar en proyectos de scripts de VBScript, como la función MsgBox .

La sentencia On Error se puede utilizar para capturar errores en scripts de VB. Consulte la documentación de Microsoft VBScript para obtener más información sobre la captura de errores.

Mensajes

En general, los mensajes son el principal medio para mejorar el funcionamiento de los scripts desde la perspectiva del usuario.

Los mensajes pueden proporcionar alertas de excepciones o mostrar información y advertencias durante la ejecución, y se pueden insertar en rutinas de scripts que gestionen datos de entrada, cálculos, operaciones con archivos o cualquier procedimiento en el que resulte útil conocer su funcionamiento.

Cuadros de diálogo de mensajes

Además del cuadro de diálogo de mensajes básico disponible en el sistema de scripts (ShowMessage), hay una serie de cuadros de diálogo específicos para proporcionar información adaptada al usuario.

Entre ellos se incluyen procedimientos de mensajes como:

  • ShowError
  • ShowException
  • ShowInfo
  • ShowWarning
  • y otros...

Panel de mensajes

El panel Messages de Altium Designer puede ser una herramienta útil para depurar scripts, pero también se puede utilizar para proporcionar al usuario un flujo continuo de mensajes con información útil.

El panel Messages es un objeto de Workspace Manager al que se accede desde la interfaz de Message Manager. El panel Messages se puede utilizar en un script para mostrar los estados de las variables y propiedades (o cualquier otro dato), tanto para la depuración como para proporcionar información al usuario, tal como se ilustra en el siguiente ejemplo.

Procedure CreateMessages;
var
   WS : IWorkSpace;
   MM : IMessagesManager;
Begin
   WS := GetWorkSpace;           // obtain Workspace Manager interface
   MM := WS.DM_MessagesManager;  // obtain Message Manager interface
   
   MM.ClearMessages;             // initialize

   MM.BeginUpdate;
   // add relevant messages here using MM.AddMesssage procedures
   MM.EndUpdate;

   WS.DM_ShowMessageView;         // display messages
End;
AI-LocalizedLocalizado por IA
Si encuentra un problema, seleccione el texto/imagen y presioneCtrl + Enterpara enviarnos sus comentarios.
Nav
Contents
Disponibilidad de funciones

Las funciones disponibles para usted dependen de qué solución de Altium tenga: Altium Develop, Altium Agile Teams, Altium Agile Enterprise o Altium Designer (con suscripción activa).

Si no ve una función documentada en su software actual, contacte con Ventas de Altium para obtener más información.

Documentación heredada

La documentación de Altium Designer ya no está versionada. Si necesita acceder a la documentación de versiones anteriores de Altium Designer, visite la sección Documentación heredada de la página de Otros instaladores.

Contents