-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2053 from Esri/jy-whats-new24-and-deps
Add what's new in 2.4 and deprecation notices documentation
- Loading branch information
Showing
2 changed files
with
686 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,197 @@ | ||
| { | ||
| "cells": [ | ||
| { | ||
| "cell_type": "markdown", | ||
| "id": "0ba16179-6d58-4caf-8517-3fd1579c7390", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "# Deprecation Announcements\n", | ||
| "\n", | ||
| "The ArcGIS API for Python occasionally deprecates functionalities, scheduling for their eventual removal from future releases. The API reference itself clearly identifies these deprecated features. To ensure your applications continue to function flawlessly and avoid compatibility issues, proactively migrate your code away from them.\n", | ||
| "\n", | ||
| "## Deprecation Candidates\n", | ||
| "\n", | ||
| "These classes, functions, and modules in the ArcGIS API for Python are deprecated and may cause compatibility issues in future versions:\n", | ||
| "\n", | ||
| "### `arcgis.apps` Module \n", | ||
| "\n", | ||
| "- `arcgis.apps.dashboard` - entire module deprecated at version **2.1.0**. This sub-module may be removed at a future major release\n", | ||
| "- `WebExperience.clone` - deprecated in **2.3.0** will be removed in **2.4.2**. Pass in the Web Experience item to `gis.content.clone_items()` instead.\n", | ||
| "- `StoryMap.get` - deprecated in **2.2.0** will be removed in **2.4.2**. `get` method has been deprecated, use `content_list` property instead.\n", | ||
| "- `StoryMap.nodes` - deprecated in **2.2.0** removed in **2.4.0**. The `nodes` property has been deprecated, use `content_list` property instead.\n", | ||
| "- `StoryMap.cover_date` - deprecated in **2.4.0** removed in future major release. Use the `date` property in the Cover class.\n", | ||
| "- `StoryMap.cover` - deprecated in **2.4.0** removed in future major release. Use the Cover class.\n", | ||
| "- `StoryMap.navigation` - deprecated in **2.4.0** removed in future major release. Use the Navigation class.\n", | ||
| "- `Briefing.cover` - deprecated in **2.4.0** removed in future major release. Use the Cover class.\n", | ||
| "- `Collection.cover` - deprecated in **2.4.0** removed in future major release. Use the Cover class.\n", | ||
| "- `Swipe.properties` - deprecated in **2.4.0** removed in future major release. Use the `content` property instead.\n", | ||
| "- `Swipe.edit` - deprecated in **2.4.0** removed in future major release. Use the `content` property setter instead.\n", | ||
| "- `MapAction` - deprecated in **2.4.0** removed in future major release. Use the `MediaAction` class instead.\n", | ||
| "- `JournalStoryMap` - deprecated in **2.0.0** removed in **2.4.0**. Template was removed from the ArcGIS platform.\n", | ||
| "\n", | ||
| "\n", | ||
| "### `arcgis.learn` Module\n", | ||
| "\n", | ||
| "- `categorize_features` - deprecated in **1.7.1** and will be removed in a future major release (For example: 2.x to 3.x). Please use `arcgis.learn.classify_objects` instead.\n", | ||
| "\n", | ||
| "### `arcgis.gis.agonb` Module \n", | ||
| "\n", | ||
| "- `Container.terminate` - deprecated in **2.3.0** will be removed in **2.4.0**. Use `Container.shutdown` instead.\n", | ||
| "\n", | ||
| "### `arcgis.gis.nb` Module \n", | ||
| "\n", | ||
| "- `Container.terminate` - deprecated in **2.3.0** will be removed in **2.4.0**. Use `Container.shutdown` instead.\n", | ||
| "\n", | ||
| "### `arcgis.gis` Module\n", | ||
| "\n", | ||
| "- `ContentManager.add` - deprecated in **2.3.0** will be removed in a future major release (example: 2.x to 3.x). Use `Folder.add` instead.\n", | ||
| "- `ContentManager.create_folder` - deprecated in **2.3.0** will be removed in a future major release (example: 2.x to 3.x). Use `gis.content.folders.create` instead.\n", | ||
| "- `ContentManager.delete_folder` - deprecated in **2.3.0** will be removed in a future major release (example: 2.x to 3.x). Use `Folder.delete()` instead.\n", | ||
| "- `ContentManager.rename_folder` - deprecated in **2.3.0** will be removed in a future major release (example: 2.x to 3.x). Use `Folder.rename()` instead.\n", | ||
| "- `ContentManager.dependency_manager` - deprecated in **2.4.0** will be removed in a future release.\n", | ||
| "- `Item.share` - deprecated in **2.3.0** will be removed in a future major release (example: 2.x to 3.x). Use `Item.sharing` instead.\n", | ||
| "- `Item.shared_with` - deprecated in **2.3.0** will be removed in a future major release (example: 2.x to 3.x). Use `Item.sharing` instead.\n", | ||
| "- `Item.unshare` - deprecated in **2.3.0** will be removed in a future major release (example: 2.x to 3.x). Use `Item.sharing` instead.\n", | ||
| "- `arcgis.gis.UserManager.create` - the `level` parameter is deprecated at **2.4.0** and will be removed from the method signature in a future release. \n", | ||
| "\n", | ||
| "### `arcgis.mapping` Module\n", | ||
| "\n", | ||
| "- `MapImageLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.MapImageLayer` class instead.\n", | ||
| "- `MapImageLayerManager` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.MapImageLayerManager` class instead.\n", | ||
| "- `EnterpriseMapImageLayerManager` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.EnterpriseMapImageLayerManager` class instead.\n", | ||
| "- `VectorTileLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.VectorTileLayer` class instead.\n", | ||
| "- `VectorTileLayerManager` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.VectorTileLayerManager` class instead.\n", | ||
| "- `Object3DLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.Object3DLayer` class instead.\n", | ||
| "- `IntegratedMeshLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.IntegratedMeshLayer` class instead.\n", | ||
| "- `Tiles3DLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.Tiles3DLayer` class instead.\n", | ||
| "- `Point3DLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.Point3DLayer` class instead.\n", | ||
| "- `VoxelLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.VoxelLayer` class instead.\n", | ||
| "- `PointCloudLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.PointCloudLayer` class instead.\n", | ||
| "- `BuildingLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.BuildingLayer` class instead.\n", | ||
| "- `SceneLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.SceneLayer` class instead.\n", | ||
| "- `SceneLayerManager` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.SceneLayerManager` class instead.\n", | ||
| "- `EnterpriseSceneLayerManager` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.EnterpriseSceneLayerManager` class instead.\n", | ||
| "- `MapServiceLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.MapServiceLayer` class instead.\n", | ||
| "- `MapFeatureLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.MapFeatureLayer` class instead.\n", | ||
| "- `MapTable` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.MapTable` class instead.\n", | ||
| "- `MapRasterLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.MapRasterLayer` class instead.\n", | ||
| "- `WMTSLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.WMTSLayer` class instead.\n", | ||
| "- `CSVLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.CSVLayer` class instead.\n", | ||
| "- `GeoRssLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.GeoRssLayer` class instead.\n", | ||
| "- `KMLLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.KMLLayer` class instead.\n", | ||
| "- `WMSLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.WMSLayer` class instead.\n", | ||
| "- `GeoJSONLayer` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.GeoJSONLayer` class instead.\n", | ||
| "- `OGCCollection` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.OGCCollection` class instead.\n", | ||
| "- `OGCFeatureService` - deprecated in **2.4.0** removed in **2.4.2**. Use the `arcgis.layers.OGCFeatureService` class instead.\n", | ||
| "\n", | ||
| "## Deprecation Removals\n", | ||
| "\n", | ||
| "Several classes, functions, and methods have been completely removed from the ArcGIS API for Python. This means your code relying on them will no longer function properly. For a smooth transition, consult the API documentation to find alternative approaches and update your code accordingly.\n", | ||
| "\n", | ||
| "### `arcgis.geoanalytics` Module \n", | ||
| "\n", | ||
| "**The entire geoanalytics module has been deprecated on ArcGIS Enterprise and removed at ArcGIS Enterprise 11.4. If you need the geoanalytics modules, please use version 2.3.x or prior.**\n", | ||
| "\n", | ||
| "See [ArcGIS GeoAnalytics for Server Deprecation Notice](https://www.esri.com/arcgis-blog/products/geoanalytics-server/announcements/deprecation-notice-for-arcgis-geoanalytics-server/) for further details. Support for the arcgis.geoanalytics module will continue to be provided through the built-in Python API included with ArcGIS Enterprise 11.3 and earlier installations.\n", | ||
| " \n", | ||
| "- `analyze_patterns` module removed in **2.4.0**. All functions within this module have been removed. Use version 2.3.x if this functionality is still needed.\n", | ||
| "- `data_enrichment` module removed in **2.4.0**. All functions within this module have been removed. Use version 2.3.x if this functionality is still needed.\n", | ||
| "- `find_locations` module removed in **2.4.0**. All functions within this module have been removed. Use version 2.3.x if this functionality is still needed.\n", | ||
| "- `manage_data` module removed in **2.4.0**. All functions within this module have been removed. Use version 2.3.x if this functionality is still needed.\n", | ||
| "- `summarize_data` module removed in **2.4.0**. All functions within this module have been removed. Use version 2.3.x if this functionality is still needed.\n", | ||
| "- `use_proximity` module removed in **2.4.0**. All functions within this module have been removed. Use version 2.3.x if this functionality is still needed.\n", | ||
| "- `arcgis.geoanalytics.get_datastores` was removed in **2.4.0**. Use version 2.3.x if this functionality is still needed.\n", | ||
| "- `arcgis.geoanalytics.define_output_datastore` was removed in **2.4.0**. Use version 2.3.x if this functionality is still needed.\n", | ||
| "- `arcgis.geoanalytics.is_supported` was removed in **2.4.0**. Use version 2.3.x if this functionality is still needed.\n", | ||
| "\n", | ||
| "\n", | ||
| "### `arcgis.mapping` Module\n", | ||
| "- `WebMap` - removed in **2.4.0**. Use `arcgis.map.Map` instead.\n", | ||
| "- `WebScene` - removed in **2.4.0**. Use `arcgis.map.Scene` instead.\n", | ||
| "- `forms` - removed in **2.4.0**. Use dataclasses found in `arcgis.map.forms` module instead.\n", | ||
| "- `renderer` - removed in **2.4.0**. Use dataclasses found in `arcgis.map.renderers` and methods in `arcgis.map.SmartMappingManager`.\n", | ||
| "- `OfflineMapAreaManager` - removed in **2.4.0**. Use the `arcgis.map.OfflineMapAreaManager`.\n", | ||
| "\n", | ||
| "\n", | ||
| "### `arcgis.geocoding` Module\n", | ||
| "- `suggest` - The **distance** parameter is deprecated and removed at **2.4.0**. The parameter is no longer supported. Please use the `search_extent` parameter instead to control the search area.\n", | ||
| "\n", | ||
| "### `arcgis.widgets` Module\n", | ||
| "- `MapView` - removed in **2.4.0**. Use either `arcgis.map.Map` or `arcgis.map.Scene` instead.\n", | ||
| "\n", | ||
| "### `arcgis.gis.server` Module\n", | ||
| "\n", | ||
| "- `Mode.update` - deprecated in **1.7.1** removed in **2.4.0**. Use `Mode.update_mode` instead.\n", | ||
| "\n", | ||
| "### `arcgis.gis.admin` Module\n", | ||
| "\n", | ||
| "- `Security.ssl property` - deprecated in **2.1.0** removed in **2.4.0**. Use `Machine.ssl_certificate` instead.\n", | ||
| "- `UX.enable_comments` - deprecated in **2.1.0** removed in **2.4.0**. This applies to the getter and setter of the property. \n", | ||
| "- `UX.set_background` -deprecated in **2.1.0** removed in **2.4.0**. This applies to the getter and setter of the property. \n", | ||
| "- `UX.set_banner` - deprecated in **2.1.0** removed in **2.4.0**. This applies to the getter and setter of the property. \n", | ||
| "- `UX.default_extent` - deprecated in **2.1.0** removed in **2.4.0**. This applies to the getter and setter of the property. \n", | ||
| "- `UX.default_basemap` - deprecated in **2.1.0** removed in **2.4.0**. This applies to the getter and setter of the property. \n", | ||
| "- `UX.vector_basemap` - deprecated in **2.1.0** removed in **2.4.0**. This applies to the getter and setter of the property. \n", | ||
| "\n", | ||
| "### `arcgis.raster` Module\n", | ||
| "\n", | ||
| "- `calculate_distance` - deprecated in **1.8.1** removed in **2.4.0**. Please use arcgis.raster.functions.gbl.distance_accumulation (or arcgis.raster.functions.gbl.distance_allocation for allocation output) instead.\n", | ||
| "- `calculate_travel_cost` - deprecated in **1.8.1** removed in **2.4.0**. Please use arcgis.raster.functions.gbl.distance_accumulation (or arcgis.raster.functions.gbl.distance_allocation for allocation output), instead.\n", | ||
| "- `cost_allocation` - deprecated in **1.8.1** removed in **2.4.0**. Please use arcgis.raster.functions.gbl.distance_accumulation instead.\n", | ||
| "- `cost_backlink` - deprecated in **1.8.1** removed in **2.4.0**. Please use arcgis.raster.functions.gbl.distance_accumulation with value specified for output_back_direction_raster_name, instead.\n", | ||
| "- `cost_distance` - deprecated in **1.8.1** removed in **2.4.0**. Please use arcgis.raster.functions.gbl.distance_accumulation instead.\n", | ||
| "- `cost_path` - deprecated in **1.8.1** removed in **2.4.0**. Please use arcgis.raster.functions.gbl.optimal_path_as_raster instead.\n", | ||
| "- `costpath_as_polyline` - deprecated in **1.8.1** removed in **2.4.0**. Please use arcgis.raster.analytics.optimal_path_as_line instead.\n", | ||
| "- `determine_travel_costpath_as_polyline` - deprecated in **1.8.1** removed in **2.4.0**. lease use arcgis.raster.functions.gbl.distance_accumulation followed by arcgis.raster.analytics.optimal_path_as_line instead.\n", | ||
| "- `euclidean_allocation` - deprecated in **1.8.1** removed in **2.4.0**. Please use arcgis.raster.functions.gbl.distance_allocation instead.\n", | ||
| "- `euclidean_back_direction` - deprecated in **1.8.1** removed in **2.4.0**. Please use arcgis.raster.functions.gbl.distance_accumulation with value specified for output_back_direction_raster_name, instead.\n", | ||
| "- `euclidean_direction` - deprecated in **1.8.1** removed in **2.4.0**. Please use arcgis.raster.functions.gbl.distance_allocation instead with value specified for output_source_direction_raster_name, instead.\n", | ||
| "- `euclidean_distance` - deprecated in **1.8.1** removed in **2.4.0**. Please use arcgis.raster.functions.gbl.distance_allocation instead.\n", | ||
| "- `least_cost_path` - deprecated in **1.9.0** removed in **2.4.0**. Please use arcgis.raster.functions.gbl.distance_accumulation and arcgis.raster.functions.gbl.optimal_path_as_raster instead.\n", | ||
| "- `optimum_travel_cost_network` - deprecated in **1.8.1** removed in **2.4.0**. Please use arcgis.raster.analytics.optimal_region_connections instead.\n", | ||
| "- `path_distance` - deprecated in **1.8.1** removed in **2.4.0**. Please use arcgis.raster.functions.gbl.distance_accumulation instead.\n", | ||
| "- `path_distance_back_link` - deprecated in **1.8.1** removed in **2.4.0**. Please use arcgis.raster.functions.gbl.distance_accumulation with value specified for output_back_direction_raster_name, instead..\n", | ||
| "- `path_distance_allocation` - deprecated in **1.8.1** removed in **2.4.0**. Please use arcgis.raster.functions.gbl.distance_accumulation.\n", | ||
| "\n", | ||
| "### `arcgis.features` Module\n", | ||
| "\n", | ||
| "- `UtilityNetworkManager.query_overrides` - deprecated in **2.1.0** removed in **2.4.0**. \n", | ||
| "- `UtilityNetworkManager.apply_overrides` - deprecated in **2.1.0** removed in **2.4.0**. \n", | ||
| "- `FeatureLayerCollectionManager.create_view` - `preserve_layer_ids` is default True at **2.4.0**.\n", | ||
| "\n", | ||
| "### `arcgis.gis` Module\n", | ||
| "\n", | ||
| "- `Group.invite_by_email` - deprecated in **1.5.1** removed in **2.4.0**. Use `Group.invite` instead." | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": null, | ||
| "id": "fd164b20-2b08-4aec-941e-176edd400cbd", | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [] | ||
| } | ||
| ], | ||
| "metadata": { | ||
| "kernelspec": { | ||
| "display_name": "Python 3 (ipykernel)", | ||
| "language": "python", | ||
| "name": "python3" | ||
| }, | ||
| "language_info": { | ||
| "codemirror_mode": { | ||
| "name": "ipython", | ||
| "version": 3 | ||
| }, | ||
| "file_extension": ".py", | ||
| "mimetype": "text/x-python", | ||
| "name": "python", | ||
| "nbconvert_exporter": "python", | ||
| "pygments_lexer": "ipython3", | ||
| "version": "3.10.14" | ||
| } | ||
| }, | ||
| "nbformat": 4, | ||
| "nbformat_minor": 5 | ||
| } |
Oops, something went wrong.