Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate shapefile reader #872

Merged

Conversation

harrism
Copy link
Member

@harrism harrism commented Jan 25, 2023

Description

cuSpatial's C++-based shapefile reader is limited. It can only load polygons (not multipolygons). It was written before cuSpatial supported GeoArrow data format and before it could ingest data from GeoPandas directly. It is better to use GeoPandas or other libraries to load data into cuSpatial. Dropping read_polygon_shapefile and its C++ implementation allows dropping the libcuspatial dependency on GDAL, which may help with publishing PIP wheels, which is a priority.

This PR simply adds deprecation warnings / decorators to the Python and C++ read_polygon_shapefile functions and documentation, and updates the Python user guide to mention deprecation.

The plan is to remove these functions and tests that depend on them in 23.04.

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@harrism harrism requested review from a team as code owners January 25, 2023 01:55
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@github-actions github-actions bot added libcuspatial Relates to the cuSpatial C++ library Python Related to Python code labels Jan 25, 2023
@harrism harrism added feature request New feature or request breaking Breaking change and removed Python Related to Python code libcuspatial Relates to the cuSpatial C++ library labels Jan 25, 2023
@harrism harrism self-assigned this Jan 25, 2023
@harrism harrism requested review from thomcom and isVoid and removed request for cwharris January 25, 2023 01:56
@github-actions github-actions bot added libcuspatial Relates to the cuSpatial C++ library Python Related to Python code labels Jan 25, 2023
@codecov-commenter
Copy link

codecov-commenter commented Jan 25, 2023

Codecov Report

Base: 92.55% // Head: 92.58% // Increases project coverage by +0.02% 🎉

Coverage data is based on head (72861b6) compared to base (a614265).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files
@@               Coverage Diff                @@
##           branch-23.02     #872      +/-   ##
================================================
+ Coverage         92.55%   92.58%   +0.02%     
================================================
  Files                24       24              
  Lines              1008     1011       +3     
================================================
+ Hits                933      936       +3     
  Misses               75       75              
Impacted Files Coverage Δ
python/cuspatial/cuspatial/io/shapefile.py 100.00% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@harrism
Copy link
Member Author

harrism commented Jan 31, 2023

/merge

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Breaking change feature request New feature or request libcuspatial Relates to the cuSpatial C++ library Python Related to Python code
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants