[6.13.0] - 2020-03-30

Added:

• The new Config parameter initial_reconnect_delay allows customizing of the base retry delay for stream connections (that is, the delay for the first reconnection after a failure; subsequent retries use an exponential backoff).
• The new Config parameter http and the HTTPConfig class allow advanced configuration of the SDK's network behavior, such as specifying a custom certificate authority for connecting to a proxy/gateway that uses a self-signed certificate.

Changed:

• The retry delay for stream connections has been changed as follows: it uses an exponential backoff no matter what type of error occurred (previously, some kinds of errors had a hard-coded 1-second delay), and each delay is reduced by a random jitter of 0-50% rather than 0-100%. Also, if a connection remains active for at least 60 seconds, the backoff is reset to the initial value. This makes the Python SDK's behavior consistent with other LaunchDarkly SDKs.

Deprecated:

• The existing Config properties connect_timeout, read_timeout, and verify_ssl are now deprecated and superseded by the equivalent properties in HTTPConfig.

[6.12.2] - 2020-03-19

Fixed:

• Setting verify_ssl to False in the client configuration did not have the expected effect of completely turning off SSL/TLS verification, because it still left certificate verification in effect, so it would allow a totally insecure connection but reject a secure connection whose certificate had an unknown CA. This has been changed so that it will turn off certificate verification as well. This is not a recommended practice and a future version of the SDK will add a way to specify a custom certificate authority instead (to support, for instance, using the Relay Proxy with a self-signed certificate).

[6.12.1] - 2020-02-12

Fixed:

• When diagnostic events are enabled (as they are by default), the SDK was logging spurious warning messages saying "Unhandled exception in event processor. Diagnostic event was not sent. ['DiagnosticEventSendTask' object has no attribute '_response_fn']". The events were still being sent; the misleading message has been removed.

[6.12.0] - 2020-02-11

Note: if you are using the LaunchDarkly Relay Proxy to forward events, update the Relay to version 5.10.0 or later before updating to this Python SDK version.

Added:

• The SDK now periodically sends diagnostic data to LaunchDarkly, describing the version and configuration of the SDK, the architecture and version of the runtime platform, and performance statistics. No credentials, hostnames, or other identifiable values are included. This behavior can be disabled with the diagnostic_opt_out option or configured with diagnostic_recording_interval.

Fixed:

• The SDK now specifies a uniquely identifiable request header when sending events to LaunchDarkly to ensure that events are only processed once, even if the SDK sends them two times due to a failed initial attempt.

[6.11.3] - 2019-12-30

Fixed:

• In rare circumstances (depending on the exact data in the flag configuration, the flag's salt value, and the user properties), a percentage rollout could fail and return a default value, logging the error "variation/rollout object with no variation or rollout". This would happen if the user's hashed value fell exactly at the end of the last "bucket" (the last variation defined in the rollout). This has been fixed so that the user will get the last variation.

[6.11.2] - 2019-12-09

Fixed:

• Changed Files.new_data_source() to use yaml.safe_load() instead of yaml.load() for YAML/JSON test data parsing. This disables pyyaml extended syntax features that could allow arbitrary code execution. (#136)

[6.11.1] - 2019-11-21

Fixed:

• Fixed an incompatibility with Python 3.3 due to an unpinned dependency on expiringdict.
• Fixed usages that caused a SyntaxWarning in Python 3.8. (Thanks, bunchesofdonald!)
• Updated CI scripts so a SyntaxWarning will always cause a build failure, and added a 3.8 build.

[6.11.0] - 2019-10-31

Added:

• The new Config parameter http_proxy allows you to specify a proxy server programmatically rather than by using environment variables. This may be helpful if you want the SDK to use a proxy, but do not want other Python code to use the proxy. (Thanks, gangeli!)

[6.10.2] - 2019-10-30

Fixed:

• Since version 6.1.0, the SDK was not respecting the standard https_proxy environment variable for specifying a proxy (because that variable is not used by urllib3). This has been fixed.
• In streaming mode, the SDK could fail to apply a feature flag update if it exceeded the LaunchDarkly service's maximum streaming message size; the service uses an alternate delivery mechanism in this case, which was broken in the SDK. This bug was also introduced in version 6.1.0.
• Fixed the generated documentation to exclude special members like __dict__.

[6.10.1] - 2019-08-20

Fixed:

• Fixed a bug in 6.10.0 that prevented analytics events from being generated for missing flags.

[6.10.0] - 2019-08-20

Added:

• Added support for upcoming LaunchDarkly experimentation features. See LDClient.track().

[6.9.4] - 2019-08-19

Fixed:

• Under conditions where analytics events are being generated at an extremely high rate (for instance, if an application is evaluating a flag repeatedly in a tight loop on many threads), a thread could be blocked indefinitely within variation while waiting for the internal event processing logic to catch up with the backlog. The logic has been changed to drop events if necessary so threads will not be blocked (similar to how the SDK already drops events if the size of the event buffer is exceeded). If that happens, this warning message will be logged once: "Events are being produced faster than they can be processed; some events will be dropped". Under normal conditions this should never happen; this change is meant to avoid a concurrency bottleneck in applications that are already so busy that thread starvation is likely.

[6.9.3] - 2019-06-11

Fixed:

• Usages of Logger.warn() were causing deprecation warnings in some versions of Python. Changed these to Logger.warning(). (#125)

[6.9.2] - 2019-05-01

Changed:

• Changed the artifact name from ldclient-py to launchdarkly-server-sdk
• Changed repository references to use the new URL

There are no other changes in this release. Substituting ldclient-py version 6.9.1 with launchdarkly-server-sdk version 6.9.2 will not affect functionality. Be sure to uninstall the ldclient-py dependency from your runtime environment when making this change.

[6.9.1] - 2019-04-26

Fixed:

• The set_sdk_key function was comparing the existing SDK key (if any) to the new one by identity (is) rather than equality (==). In Python, two strings that have the same characters may or may not be the same string instance; in the case where they were not, set_sdk_key would inappropriately reinitialize the client even though the SDK key had not really changed. (Thanks, jpgimenez!)
• Running the SDK unit tests is now simpler in that the database integrations can be skipped. See CONTRIBUTING.md.

Note on future releases

The LaunchDarkly SDK repositories are being renamed for consistency. This repository is now python-server-sdk rather than python-client.

The package name will also change. In the 6.9.1 release, it is still ldclient-py; in all future releases, it will be launchdarkly-server-sdk. No further updates to the ldclient-py package will be published after this release.

[6.9.0] - 2019-04-09

Added:

• It is now possible to use the with statement on an LDClient object, so that close() will be called automatically when it goes out of scope.

Fixed:

• Calling close() on the client would cause an error if the configuration included use_ldd=True. (#118)

[6.8.4] - 2019-03-29

Fixed:

• Setting user attributes to non-string values when a string was expected would cause analytics events not to be processed. Also, in the case of the "secondary" attribute, this could cause evaluations to fail for a flag with a percentage rollout. The SDK will now convert attribute values to strings as needed. (#115)
• If track or identify is called without a user, the SDK now logs a warning, and does not send an analytics event to LaunchDarkly (since it would not be processed without a user).

[6.8.3] - 2019-02-12

Note that starting with this release, generated API documentation is available online at https://launchdarkly-python-sdk.readthedocs.io. This is published automatically from the documentation comments in the code.

Changed:

• The SDK no longer uses jsonpickle.
• The CI test suite for all supported Python versions, which previously only ran in Linux, has been extended to include Python 3.6 in Windows.

Fixed:

• Corrected and expanded many documentation comments. All public API methods (not including internal implementation details) are now documented.

[6.8.2] - 2019-01-31

Fixed:

• Fixed a different packaging error that was still present in the 6.8.1 release, which made the package installable but caused imports to fail. The 6.8.1 release has been pulled from PyPI. We apologize for these recent errors, which were not detected prior to release because our prerelease testing was using the source code directly rather than installing it with pip. Our CI tests have been updated and should prevent this in the future.

[6.8.1] - 2019-01-31

Fixed:

• Fixed a packaging error that made the 6.8.0 release not installable. There are no other changes. The 6.8.0 release has been pulled from PyPI.