Note: The ArcGIS API for Python 2.4.0 release is supported with ArcGIS Pro 3.4 and later cloned environments for use with arcpy. The 2.4.0 arcgis and arcgis-mapping packages are incompatible with ArcGIS Pro 3.3.x and earlier cloned environments. The default ArcGIS Pro 3.3.x environment can be cloned and upgraded to arcgis packages of 2.3.x.
New
Reorganized modules and refactored functionality into new classes to incorporate the new Jupyter Lab and Notebook 7 architectures.
- Deprecated modules:
- arcgis.mapping
- WebMap
- class deprecated and functionality refactored into Map class
- all interactive widget functionality for clicking on map deprecated
- WebScene
- class deprecated and functionality refactored into Scene class
- All other classes refactored into the arcgis.map module
- WebMap
- arcgis.widgets
- arcgis.mapping
- New modules:
- See What's New in 2.4.0 for additional details
- arcgis.map
- Map
- dedicated class aligning with the web map specification
- provides most of the functionality of previous Webmap and MapView classes
- interactive functionality for clicking on map has been deprecated
- Scene
- dedicated class aligning with the web scene specification
- Classes provide fine-tuned management for individual layers within Map or Scene
- Map
- arcgis.layers
- Service
- class takes any service url endpoint and returns the appropriate API class object
- BasemapServices
- BasemapService
- See Basemap styles service for concepts.
- Service
- Deprecating ContentManager.add()
- Use Folder.add() for uploading content
- New method on the Item class:
Guides
Samples
Module Changes
arcgis.gis
GIS
- Adds documentation:
- to class description for retrieving a token
- to token keyword for retrieving a token
- Adds documentation:
Item
- New method:
publish()
- Adds information to code snippet for publishing tables
ContentManager
- clone_items()
- Enhances processing to export items in cases where it applies to prevent excess server processing and 504 errors
- clone_items()
Folder
add()
- Adds deprecation notice when using the overwrite parameter as it has been deprecated in the REST API
UserManager
create()
- BUG-000168602 - Adds documentation note for using the org_admin value to assign built-in Administrator role to a user
GroupMigrationManager
load()
- New parameter:
- keep_epk_item
- New parameter:
arcgis.gis Dataclasses
ItemProperties
properties
- Fixes internal processing of input to accept strings or dictionaries
arcgis.gis.admin
- New classes:
ClassificationManager
- See ArcGIS Enterprise Item classification.
PortalAdminManager
- New properties:
arcgis.gis.server
DataStoreManager
- New method:
arcgis.gis.agonb
AGOlNotebookManager
- New properties:
services
- Adds support for working with web tools in ArcGIS Online
- New properties:
arcgis.gis.workflowmanager
arcgis.features
FeatureLayer
append()
- New parameter: layer_mappings
FeatureCollection
properties
- ENH-000147463 - Adds documentation
- Spatially Enabled DataFrame -
GeoAccessor
sanitize_column_names()
- Adds support for setting column width
arcgis.features.managers
FeatureLayerCollectionManager
overwrite()
- Enhances method to remove file size check so large items added in chunks
arcgis.raster
- Adds note about using
get_stac_info()
utility to: Raster
- Deprecates following properties as no longer necessary for rendering local rasters:
cmap
opacity
vmin
vmax
spatial_reference
- Updates output format to a dictionary rather than string
- Deprecates following properties as no longer necessary for rendering local rasters:
arcgis.raster.functions
speckle()
- Adds support for RefinedLee and GammaMap as filter_type arguments
arcgis.raster.utils
- New function:
arcgis.raster.orthomapping
- Adds new function:
- Enhances context parameter description documentation for:
generate_dem()
- New paramters:
classify_ground_options
Project
- Enhances settings on the resulting portal item
arcgis.notebook
NotebookJob
- Enhances messaging
arcgis.geoanalytics
- Removed from the 2.4.0 code base. Supported only in 2.3.x releases.
- See the 2.3.x documentation to use
arcgis.geocoding
suggest()
- Deprecates parameters:
- distance - use search_extent
- Adds parameters:
- preferred_label_values
- return_collections
- Deprecates parameters:
arcgis.geoenrichment
- Enhances error messaging when attempted in environments without ArcPy or Shapely
arcgis.graph
KnowledgeGraph
- New method:
arcgis.layers
- New module: See What's New in 2.4.0 for additional details
Service
- Adds simplified initialization of appropriate API class from url or Item
- Working with Map Service Layers
MapFeatureLayer
- Adds time_filter parameter in class initializer for data that has timeInfo
arcgis.map
- Functionality from the deprecated
argis.mapping
module - New module: See What's New in 2.4.0 for additional details
arcgis.widgets
- Deprecated at the 2.4 Release
- See What's New in 2.4.0 for additional details
arcgis.apps
- Adds deprecation notices to reference documentation for:
hub
- Adds support for Folder.add() throughout module
- Adds deprecation notice to:
storymap
- New classes:
Storymap
survey123
expbuilder
- Enhances module to move both structure and contained resources from local Experiences into Web GIS deployments
arcgis.learn
- New Table of Contents heading:
- Object Detection Models
- New models:
- MMDetection
- Adds DINO: DETR support
- Unstructured Text Models
- arcgis.learn.text module
- Adds Extensibility framework support for module
- arcgis.learn.text module
arcgis.datapipelines
- Adds documentation
Fixes
Guides
- Fixes display issue in documentation where
Item
Type icon appeared incorrectly when displaying Item cards - Fixes display of internal information on
User
cards - Fixes display issue with
Group
card in notebooks
Module Changes
arcgis.gis
GIS
- Fixes issue where session not created if certificate Common Name does not match Server Name
Item
- Fixes inconsistency with return values for layers and tables property for Map Service items
- Fixes issue with improperly item objects from CodeType items based on Python version
SharingGroupManager
add()
- Fixes BUG-000168928 where method retuns
True
only for first Group added in a sequence of calls
- Fixes BUG-000168928 where method retuns
ContentManager
- clone_items()
- Fixes issue when cloning StoryMap items containing web maps on Windows not properly cloning all resoures
- Fixes BUG-000168118 where cloning Web Experiences created through the Create Web App button on Web Map item details page
- Fixes Public Repo Issue #1761 where survey content was causing failures because of character encoding
- Fixes BUG-000167100 where a
TypeError
raised when cloning Dashboard items of latest version - Fixes BUG-000166690 where read-only fields are not properly populated
- Fixes issue where editor tracking information was not cloned in feature services
import_data()
- Fixes optimization issues when using overwrite
- Fixes
Analyze Service Error
in environments whereArcPy
is present and service source name generated from file is not unique
- clone_items()
Folders
list()
- Fixes performance issue by reducing number of calls to endpoints
Folder
add()
- Fixes
TypeError
when file input is a io.StringIO or io.BytesIO object - Fixes
ValueError
if file, text, url, or data_url argument not provided
- Fixes
UserManager
create()
- Fixes BUG-000168590 where user_type value from New Member Defaults settings not honored when user_type not provided
arcgis.gis.nb
arcgis.features
FeatureLayer
edit_features()
- Fixes issue where no response returned when run asynchronously using the deletes argument
- Spatially Enabled DataFrame -
GeoAccessor
centroid
- Fixes BUG-000164784 where
ValueError
returned in an ArcPy environment on dataframe containing geometries with z values
- Fixes BUG-000164784 where
from_featureclass()
- Fixes
AttributeError
when accessing wkid property on geometries
- Fixes
to_featureclass()
- Fixes BUG-000162383 where Utility Network layers failed to export because numeric column values of 0 were getting set to Null
to_featurelayer()
- Fixes optimization issues when overwrite=True
- Fixes BUG-000169830 where m-values are not retained
from_layer()
- Fixes issue where date values were read incorrectly and returning all values at beginning of Unix Epoch
arcgis.features.managers
FeatureLayerCollectionManager
insert_layer()
- Fixes BUG-000167656 where method failed when using layers with attachments
create_view()
- Updates default value for preserve_layer_ids to
True
- Updates default value for preserve_layer_ids to
- Fixes issues where locks where left behind after reading and/or editing sessions with:
arcgis.raster
ImageLayer
save()
- Fixes BUG-000167021 where misleading error message returned in service property of allow copy is set to False
Raster
get_raster_bands()
- Corrects documentation referring to how indexes are based
arcgis.raster.utils
publish_hosted_imagery_layer()
- Fixes issue with failing to include auxiliary files when accessing the input_data location
arcgis.network.analysis
get_tool_info()
- Fixes
TypeError
because of passing an additional parameter
- Fixes
arcgis.notebook()
NotebookJob
- Fixes issue where following property and methods return incorrect values after execute_notebook() job is cancelled:
arcgis.geoanalytics
- Removed from the 2.4.0 code base. Supported only in 2.3.x releases.
- See the 2.3.x documentation to use
arcgis.geocoding
reverse_geocode()
- Fixes processing for the location_type paramter
geocode_from_items()
- Fixes BUG-000170142
TypeError: code() takes no keyword arguments
when run against CSV items
- Fixes BUG-000170142
arcgis.geometry
- Updates how GeometryService is accessed within the API for increased flexibility in different deployments
Geometry
has_z
- Fixes BUG-000169189 where property returns incorrect results in environment with Shapely only
- Fixes issue where Polygon objects were missing property if initialized from a feature class
arcgis.geometry.functions
- Fixes issues multipart polygon processing by spatial operations performed inconsistently between environments with Shapely and ArcPy
arcgis.layers
- Working with OGC layers
WMTSLayer
- Fixes issue with reading properties improperly leading to incorrectly formatted object leading to multiple methods returning None
- Working with 3D Maps
SceneLayerManager
- Fixes BUG-000169804 where incorrect source was used in populating information to initialize object
arcgis.apps
hub
SiteManager
add()
- Fixes issue where site is added but not rendering in browser
PageManager
add()
- Fixes issue where page is added but not rendering in browser
workforce
create_project()
- Fixes issue where resulting Project item had improper structure
storymap
- Fixes issue when population version information in disconnected environments
survey123
expbuilder
WebExperience
upload()
- Fixes Public Repo Issue #1950 where
KeyError
is raised if datasources lack a portal url
- Fixes Public Repo Issue #1950 where
arcgis.learn
- Fixes out of memory issues by providing backbone support during model initialization when batch size is being estimated
- Fixes error in format of default value for TTA scales used in inferencing
- Fixes error with show_batch() when training data had fewer elements than the batch_size argument
- Fixes
ValueError
failures on most models with predict_video() - Data Preparation Methods
prepare_data()
- Fixes error initializing
PSETAE
model from output when class doesn't contain any files - Fixes incorrect recursion error raised if working_dir argument does not exist
- Fixes error initializing
prepare_textdata()
- Fixes issue where similar entities are extracted multiple times using Mistral
- Automated Machine Learning
- Fixes issue where early stopping was triggered before adequate processing time elapsed on time calculations
AutoML
- Object Classification Models
FeatureClassifier
from_model()
- Fixes failure to load model because of incompatibility between supported backbone and saved backbone names using torchgeo
save()
- Fixes
NotADirectoryError
using torchgeo
- Fixes
- Object Detection Models
- Fixes warning messages received during initialization
SingleShotDetector
- Fixes issue when initializing model from data bunch without specifying backbone
from_model()
- Fixes compatible backbone exception using torchgeo
- Fixes performance issue for objects of varying sizes related to ordering of grids
MMDetection
fit()
- Fixes info messages printing during training of
vfnet
models - Fixes issue resulting from incorrect available_metrics for
dino detr
models
- Fixes info messages printing during training of
- Pixel Classification Models
MMSegmentation
fit()
- Fixes error with finetuning with
prithvi
models
- Fixes error with finetuning with
- Image Translation Models
Pix2Pix
- Fixes backbone names for backbone parameter description
- 3d Models
- Scanned Maps
ScannedMapDigitizer
digitize_image()
- Fixes warning display resulting from incorrect internal processing of extent values
- Unstructured Text Models
- arcgis.learn.text module
- Fixes issue with path of the emd file not properly transferred to the extension file
- Fixes performance issues for models using the Mistral backbone
EntityRecognizer
extract_entities()
- Fixes issue where fails to pull out information from text while inferencing using Mistral
from_model()
- Fixes
EntityRecognizer not present
issue on model created fromner_json
dataset type
- Fixes
TextClassifier
from_model()
- Fixes
UnboundLocalError
resulting from incorrect passing of parameters to extension model
- Fixes
- arcgis.learn.text module