Describe

Synthèse

Describes a data element and returns a Describe object with multiple properties, such as data type, fields, indexes, and many others. Its properties are dynamic, meaning that depending on the data type described, different describe properties will be available for use.

Describe properties are organized into a series of property groups. Any particular dataset will acquire the properties of at least one of these groups. For example, if describing a geodatabase feature class, you can access properties from the Geodatabase Feature Class, Feature Class, Table, and Dataset property groups. All data, regardless of the data type, will always acquire the generic Describe object properties.

Discussion

Many data types include properties from other property groups. For example, if describing a geodatabase feature class, you can access properties from the Geodatabase Feature Class, Feature Class, Table, and Dataset property groups.

See arcpy.da.Describe, which returns the same information but as a dictionary.

Remarque :

In some cases, the object returned by Describe will not have all of the properties that are documented for it. For example, the Describe object for a layer in a map will not have the layer property set. That property only exists if you describe a .lyr file.

If you try to access a property that a Describe object does not have, it will return either an error or an empty value (None, 0 or -1, or an empty string). If you are uncertain of a particular property, you can use the Python hasattr() function to check.

• Propriétés de l’objet Describe
• Propriétés de l’élément ArcInfo Workstation
• Propriétés de la tableArcInfo Workstation
• Propriétés de règle attributaire
• Propriétés de l’espace de travail de fichier BIM
• Propriétés du jeu de données de dessin DAO
• Propriétés de la classe d’entités DAO
• Propriétés de la classe d’entités de couverture
• Propriétés de couverture
• Propriétés de jeu de données
• Propriétés de table dBASE
• Propriétés du suivi de l’éditeur
• Propriétés de classe d’entités
• Propriétés de groupe de champs
• Propriétés de fichier
• Propriétés de dossier
• Propriétés de classe d’entités de géodatabase
• Propriétés de table de géodatabase
• Propriétés de réseau géométrique
• Propriétés de couche géostatistique
• Propriétés de jeu de données LAS
• Propriétés de couche
• Propriétés de jeu de données Location Referencing
• Propriétés de carte
• Propriétés de jeu de données mosaïque
• Network Analyst
• Propriétés de jeu de données réseau
• Propriétés d’atelier parcellaire
• Propriétés d’atelier parcellaire pour ArcMap
• Propriétés de fichier de projection
• Propriétés de bande raster
• Propriétés de catalogue raster
• Propriétés de jeu de données raster
• Propriétés de jeu d’enregistrements et de jeu d’entités
• Propriétés de classe de relations
• Propriétés de classe de représentations
• Propriétés de jeu de données schématique
• Propriétés de diagramme schématique
• Propriétés de dossier schématique
• Propriétés de classe d’entités SDC
• Propriétés de classe d’entités shapefile
• Propriétés de table
• Propriétés de vue tabulaire
• Propriétés de fichier texte
• Propriétés TIN
• Propriétés d’outil
• Propriétés de boîte à outils
• Propriétés de topologie
• Propriétés du réseau de traces
• Propriétés du réseau de distribution
• Propriétés de couverture VPF
• Propriétés de classe d’entités VPF
• Propriétés de table VPF
• Propriétés d’espace de travail

Syntaxe

Describe (value, {data_type})

Paramètre	Explication	Type de données
value	The specified data element or geoprocessing object to describe.	String
data_type	The type of data. This is only necessary when naming conflicts exist, for example, if a geodatabase contains a feature dataset (FeatureDataset) and a feature class (FeatureClass) with the same name. In this case, the data type is used to clarify which dataset will be described. (La valeur par défaut est None)	String

Valeur renvoyée

Type de données	Explication
Describe	Returns an object with properties detailing the data element described. Some of the returned object's properties will contain literal values or objects.

Exemple de code

Describe properties example (stand-alone script)

The following stand-alone script displays layer and describe object properties from a layer set by a script parameter. The parameter can be set to either a layer file or a layer in a map.

import arcpy

# Get the layer as a parameter and describe it.
#
# The layer could be a layer in ArcMap (like "some_layer")
# Or, it could be a .lyr file (like "C:/data/some.lyr")
#
layerString = arcpy.GetParameterAsText(0)
desc = arcpy.Describe(layerString)

# Print selected layer and describe object properties
# 
print("Name: {}".format(desc.name))
if hasattr(desc, "layer"):
    print("Layer name: {}".format(desc.layer.name))
    print("Layer data source: {}".format(desc.layer.catalogPath))
    print(".lyr file: {}".format(desc.catalogPath))
else:
    print("Layer name: {}".format(desc.name))
    print("Layer data source: {}".format(desc.catalogPath))

if desc.FIDSet != '':
    print("Number of selected features: {}".format(len(desc.FIDSet.split(";"))))