Python SDK

9.5.0 (2024-07-25)

This release introduces the ability to enable compression of event payloads. When enabled, the SDK will compress events before sending them to the LaunchDarkly servers. This can reduce the bandwidth required to send events, which can be useful in high-traffic environments to reduce egress traffic costs.

[!IMPORTANT] Relay Proxy users MUST upgrade to version 8.9 or higher prior to enabling this option to prevent loss of event data.

However, enabling this feature is NOT required when using the Relay Proxy as it will manage compression automatically.

Features

• Add option to enable event payload compression (#300) (87c56c9)

Bug Fixes

• Log warning if client init timeout is considered high (#295) (08514fe)

Documentation

• Fix readthedocs generation (#292) (9b9c9df)

9.4.0 (2024-04-29)

Features

• Add support for hooks (#287) (eef6e26)

9.3.1 (2024-04-04)

Bug Fixes

• Move tests under ldclient namespace (#29) (#283) (c7d367a)

9.3.0 (2024-03-14)

Features

• Inline contexts for all evaluation events (#245) (8b5429b)
• Redact anonymous attributes within feature events (#246) (4022ee2)

9.2.2 (2024-03-07)

Bug Fixes

• Correct typehint on Config.update_processor_class (#274) (d386f9c), closes #273

9.2.1 (2024-03-01)

Bug Fixes

• Raise minimum urllib3 package to 1.26.0 (#271) (ffeded9), closes #270

Documentation

• Add example output for PROVENANCE.md #268 (43cf5bf)
• Fix version generation in PROVENANCE file (#272) (7dd887e)

9.2.0 (2024-02-14)

Features

• Enable gzip Accept-Encoding header on polling requests (2c2e4fa)

Bug Fixes

• deps: Update flask requirement from 2.2.5 to 3.0.0 (#250) (b3cc0fa)
• deps: Update flask requirement from 3.0.0 to <4 (#254) (dc5a6ba)
• deps: Update jinja2 requirement from 3.0.0 to 3.1.2 (77a1f76)
• deps: Update jinja2 requirement from 3.1.2 to 3.1.3 (#252) (495604b)
• deps: Update mypy requirement from ==0.910 to ==1.8.0 (#251) (cea865e)
• deps: Update pytest-mypy requirement from ==0.8.1 to ==0.10.3 (#249) (f2e2e17)
• deps: Update sphinx requirement from ^1.3.0 to ^6.0.0 (77a1f76)
• deps: Update sphinx requirement from ^6.0.0 to >=6,<8 (#255) (d4eb5af)
• deps: Update sphinx-rtd-theme requirement from ^1.3.0 to >=1.3,<3.0 (#253) (ba2490d)
• Update missing version number change (#238) (7efedc8)

8.3.0 (2024-02-14)

Features

• Enable gzip Accept-Encoding header on polling requests (537b240)

9.1.0 (2023-12-20)

Features

• Add data source status provider support (#228) (f733d07)
• Add support for data store status monitoring (#252) (57ca6ac)
• Introduce flag change tracker api (#229) (4df1762)
• Replace internal es implementation with launchdarkly-eventsource package (#254) (99aafd5)

Bug Fixes

• deps: Bump jsonpickle to fix CVE-2020-22083 (#234) (6280fe8)
• deps: Bump pyyaml to fix CVE-2020-1747 (#236) (48291ec)
• Fix data store availability status check (#237) (81e2910)

[9.0.1] - 2023-10-27

Fixed:

• Replace deprecated utcfromtimestamp usage.

[8.2.1] - 2023-10-23

Fixed:

• Replace deprecated utcfromtimestamp usage.

[9.0.0] - 2023-10-17

The latest version of this SDK supports the ability to manage migrations or modernizations, using migration flags. You might use this functionality if you are optimizing queries, upgrading to new tech stacks, migrating from one database to another, or other similar technology changes. Migration flags are part of LaunchDarkly's Early Access Program. This feature is available to all LaunchDarkly customers but may undergo additional changes before it is finalized.

For detailed information about this version, refer to the list below. For information on how to upgrade from the previous version, read the migration guide.

Added:

• A new Migrator type which provides an out-of-the-box configurable migration framework.
• For more advanced use cases, added new migration_variation and track_migration_op methods on LDClient.

Changed:

• Raised pyyaml dependency to >=5.3.

Removed:

• Python 3.7 support was removed.
• The legacy user format for contexts is no longer supported. To learn more, read the Contexts documentation.
• Methods which originally took a Context or a dict now only accept a Context.
• Previously deprecated config options user_cache_size, user_cache_time, user_keys_capacity, user_keys_flush_interval, and private_attribute_names have been removed.
• Previously deprecated test data flag builder method variation_for_all_users has been removed.

[8.2.0] - 2023-10-17

Deprecated:

• Creating an LDContext using the legacy user format has been deprecated and will be removed in the next major release. To learn more, read the Contexts documentation.
• Providing client methods track, identify, variation, variation_detail, all_flags_state, and secure_mode_hash with a context dictionary is deprecated. In the next major release, a Context will be required.

[8.1.7] - 2023-10-05

Changed:

• Loosened urllib3 requirement to <3

[8.1.6] - 2023-09-06

Changed:

• Recoverable errors are logged as a warning not an error. (Thanks, fritzdj!)

[8.1.5] - 2023-08-15

Changed:

• Loosened the requirements on the semver package. (Thanks, hauntsaninja!)

[8.1.4] - 2023-06-01

Fixed:

• Password will be redacted from redis URL prior to logging.

[8.1.3] - 2023-05-03

Fixed:

• Updated usage of HTTPResponse.getheader to remove deprecation warning from upstream urllib3 package. (Thanks, mnito!)

[8.1.2] - 2023-05-01

Fixed:

• Pinned urllib3 dependency to <2. (Thanks, prpnmac!)

[8.1.1] - 2023-02-10

Fixed:

• Fixed indexing error raised by calling all_flags_state while using the TestData data source.