v0.13.5

Release Notes

Breaking Changes

• Append "Error" to all exception classes for conforming to PEP-8 naming conventions.

Internal Changes

• Bump minimum version of owslib to 0.27.2 since the pyproj incompatibility issue has been addressed in this issue.
• Bump minimum version of requests-cache to 0.9.6 since the attrs version issue has been addressed.

v0.13.3

Release Notes

New Features

• Add support for disabling persistent caching in RetrySession via an argument and also HYRIVER_CACHE_DISABLE environmental variable.

v0.13.2

Release Notes

Breaking Changes

• Set the minimum supported version of Python to 3.8 since many of the dependencies such as xarray, pandas, rioxarray have dropped support for Python 3.7.
• Pin owslib to version <0.26 since version 0.26 has pinned pyproj to version <3.3 which is not compatible with rasterio on macOS.

Internal Changes

• Use micromamba for running tests and use nox for linting in CI.

v0.13.1

Release Notes

New Features

• More robust handling of errors in ArcGISRESTful by catching None responses. Also, use the POST method for ArcGISRESTful.bysql since the SQL Clause could be a long string.

v0.13.0

Release Notes

Breaking Changes

• Remove caching-related arguments from all functions since now they can be set globally via three environmental variables:

  • HYRIVER_CACHE_NAME: Path to the caching SQLite database.
  • HYRIVER_CACHE_EXPIRE: Expiration time for cached requests in seconds.
  • HYRIVER_CACHE_DISABLE: Disable reading/writing from/to the cache file.

  You can do this like so:

import os

os.environ["HYRIVER_CACHE_NAME"] = "path/to/file.sqlite"
os.environ["HYRIVER_CACHE_EXPIRE"] = "3600"
os.environ["HYRIVER_CACHE_DISABLE"] = "true"

Bug Fixes

• In ArcGISRESTful.oids_byfield convert the input ids to a list if a user passes a single id.

Internal Changes

• Refactor ServicURL to hard code the supported links instead of reading them from a file. Also, the class now is based on NamedTuple that has a nicer __repr__.

v0.12.2

Release Notes

New Features

• Make validate_crs public that can be accessed from the utils module. This is useful for checking validity of user input CRS values and getting its string representation.
• Add pygeoogc.utils.valid_wms_crs function for getting a list of valid CRS values from a WMS service.
• Add 3DEP's index WFS service for querying availability of 3DEP data within a bounding box.

Internal Changes

• Add type checking with typeguard and fixed typing issues raised by typeguard.
• Refactor show_versions to ensure getting correct versions of all dependencies.

v0.12.1

Release Notes

Internal Changes

• Use the three new ar.retrieve_* functions instead of the old ar.retrieve function to improve type hinting and to make the API more consistent.

v0.12.0

Release Notes

New Features

• Add a new argument to ArcGISRESTful called verbose to turn on/off all info level logs.
• Add an option to ArcGISRESTful.get_features called get_geometry to turn on/off requesting the data with or without geometry.
• Now, ArcGISRESTful saves the object IDs of the features that user requested but are not available in the database to ./cache/failed_request_ids.txt.
• Add a new parameter to ArcGISRESTful called disable_retry that If True in case there are any failed queries, no retrying attempts is done and object IDs of the failed requests are saved to a text file which its path can be accessed via ArcGISRESTful.client.failed_path.
• Set response caching expiration time to never expire, for all base classes. A new argument has been added to all three base classes called expire_after that can be used to set the expiration time.
• Add a new method to all three base classes called clear_cache that clears all cached responses for that specific client.

Breaking Changes

• All oids_by* methods of ArcGISRESTful class now return a list of object IDs rather than setting self.featureids. This makes it possible to pass the outputs of the oids_by* functions directly to the get_features method.

Internal Changes

• Make ArcGISRESTful less cluttered by instantiating ArcGISRESTfulBase in the init method of ArcGISRESTful rather than inheriting from its base class.
• Explicitly set a minimum value of 1 for the maximum number of feature IDs per request in ArcGISRESTful, i.e., self.max_nrecords.
• Add all the missing types so mypy --strict passes.

v0.11.7

Release Notes

Breaking Changes

• Remove the onlyipv4 method from RetrySession since it can be easily be achieved using with unittest.mock.patch("socket.has_ipv6", False):.

Internal Changes

• Use the geoms method for iterating over geometries to address the deprecation warning of shapely.
• Use importlib-metadata for getting the version insead of pkg_resources to decrease import time as discussed in this issue.
• Remove unnecessary dependency on simplejson and use ujson instead.

v0.11.6

Release Notes

Breaking Changes

• Remove the onlyipv4 method from RetrySession since it can be easily be achieved using with unittest.mock.patch("socket.has_ipv6", False):.

Internal Changes

• Use the geoms method for iterating over geometries to address the deprecation warning of shapely.
• Use importlib-metadata for getting the version insead of pkg_resources to decrease import time as discussed in this issue.