Skip to content

Commit

Permalink
Flip feature flags to raise exceptions on certain errors (openviess#102)
Browse files Browse the repository at this point in the history
* flip feature flags to raise exceptions on certain errors

* Adapt readme about breaking change

* include name of feature flag in readme

* typo
  • Loading branch information
woehrl01 authored Jul 14, 2021
1 parent 6f0d1a0 commit 467209f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 2 additions & 2 deletions PyViCare/Feature.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Feature flag to raise an exception in case of a non existing device feature.
# The flag should be fully removed in a later release.
# It allows dependend libraries to gracefully migrate to the new behaviour
raise_exception_on_not_supported_device_feature = False
raise_exception_on_not_supported_device_feature = True

# Feature flag to raise exception if rate limit of the API is hit
raise_exception_on_rate_limit = False
raise_exception_on_rate_limit = True
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ This library implements access to Viessmann devices by using the official API fr
## Breaking changes in version 1.x

* The versions prior to 1.x used an inofficial API which stopped working on July, 15th 2021. All users need to migrate to version 1.0.0 to continue using the API.
* Exception is raised if the library runs into a API rate limit. (See feature flag `raise_exception_on_rate_limit`)
* Exception is raised if an unsupported device feature is used. (See feature flag `raise_exception_on_not_supported_device_feature`)
* Python 3.4 is no longer supported.
* Python 3.9 is now supported.

Expand Down

0 comments on commit 467209f

Please sign in to comment.