14 votos

definir descripción de parámetros en ESRI caja de herramientas de Python

Estoy tratando de crear algunas cajas de Herramientas de Python para nuestra aplicación ArcMap (por ejemplo, MyTool.pyt)

Puedo ver que el texto de ayuda se define con las clases de auto.descripción del atributo.

Sin embargo, una vez que ejecute el programa y haga clic en cualquiera de los campos de parámetro, de la ayuda/de texto de la descripción va de vacío. Me gustaría ser capaz de proporcionar el campo de descripción para cada parámetro. Cómo es realizado?

EDIT: Después de algunas respuestas, veo que a través de la "Descripción del Elemento' menú contextual del botón derecho hay muchos campos que se pueden rellenar. Hay un 'python' manera de hacer esto? Es decir, sólo mediante la incorporación de algunos atributos de la .pyt archivo de clases?

Por ejemplo, en la .pyt caja de herramientas de definición de la caja de herramientas de la clase:

import arcpy

class Toolbox(object):
    def __init__(self):
        """Define the toolbox (the name of the toolbox is the name of the
        .pyt file)."""
        self.label = "My Toolbox"
        self.alias = ""

        # List of tool classes associated with this toolbox
        self.tools = [MyNiceTool]


class MyNiceTool(object):
    def __init__(self):
        """Define the tool (tool name is the name of the class)."""
        self.label = "My Tool Class"
        self.description = """
A description that shows up in the help context side pane when the tool is launched.
        """
        self.canRunInBackground = True

    def rest_of_required_methods....

Desde el auto.descripción de la cadena de diálogo de la Herramienta en la ventana de ayuda se mostrará este texto. Sin embargo, lo que estoy queriendo hacer es tener una 'descripción' incrustado en mi código para cada parámetro, de modo que cuando la herramienta se puso en marcha, y el usuario hace clic en un campo de parámetro, el parámetro descripción se muestra. Si yo fuera a hacer esto usando el 'Elemento Descripción método que se hace referencia en las respuestas a continuación, me gustaría editar los campos de Diálogo de la Explicación en la sección Sintaxis para cada parámetro... supongo.

16voto

Puedo ver que el texto de ayuda se define con las clases de auto.descripción del atributo.

Aquí es donde usted va mal. En la página de ayuda de la documentación de una herramienta en una caja de herramientas de Python dice:

Para cajas de herramientas de Python, la documentación de la caja de herramientas y las herramientas se almacenan en .xml archivos que están asociados con la caja de herramientas y las herramientas por su nombre. La ayuda para cada herramienta se almacenarán en un lugar separado .archivo xml.

Esto significa que no se puede establecer el texto de ayuda desde dentro de el .pyt propio archivo. Esto tiene sentido cuando se considera que el texto de ayuda no es ASCII plano, pero rico en texto que puede incluir formato, viñetas, y las imágenes.

Afortunadamente, Python soporta la lectura y escritura en XML, por lo que debe ser capaz de modificar dinámicamente el texto de ayuda de una secuencia de comandos independiente.

12voto

Hameno Puntos 129

Puede definir los mensajes para cada uno de los parámetros mediante los siguientes pasos:

  1. Abierto ArcCatalog y poner de relieve la secuencia de Comandos en el árbol de catálogo
  2. Seleccione la ficha Descripción
  3. Haga clic en el botón Editar
  4. Haga clic en la flecha abajo situada junto a cada parámetro y el tipo en un mensaje
  5. Guardar las modificaciones haciendo clic en el botón Guardar

Cuando un usuario hace clic en un parámetro de script ahora van a ver su mensaje.

2voto

Martin Puntos 2872

Si entiendo correctamente, usted desea agregar textos de Ayuda de sus funciones. Que se puede hacer haciendo clic derecho en la herramienta de la caja de herramientas de la ventana y haga clic en descripción del Elemento y, a continuación, Editar en la parte superior. Que te permitirá agregar una descripción para cada uno de los parámetros que se muestran en la sección de ayuda al hacer clic en el parámetro.

Si usted está en Arcmap 10.0 (al menos antes de SP) usted necesita para hacer esto desde la ventana ArcCatalog (vaya a la caja de herramientas) dentro de Arcmap para que funcione.

i-Ciencias.com

I-Ciencias es una comunidad de estudiantes y amantes de la ciencia en la que puedes resolver tus problemas y dudas.
Puedes consultar las preguntas de otros usuarios, hacer tus propias preguntas o resolver las de los demás.

Powered by:

X