Changelog¶
2.7.1 (2021-08-13)¶
Bug Fixes¶
2.7.0 (2021-07-24)¶
Features¶
Bug Fixes¶
Dependencies¶
2.6.1¶
07-05-2021 10:33 PDT
Dependencies¶
Documentation¶
Adjust samples for publishing with error handler and flow control. (#433)
Internal / Testing Changes¶
2.6.0 (2021-06-17)¶
Features¶
Bug Fixes¶
Documentation¶
2.5.0 (2021-05-18)¶
Features¶
Bug Fixes¶
2.4.2¶
05-06-2021 23:50 PDT
Implementation Changes¶
Documentation¶
Internal / Testing Changes¶
2.4.1 (2021-03-30)¶
Bug Fixes¶
Implementation Changes¶
(samples) Bump the max_time to 10 minutes for a flaky test. (#311) (e2678d4), closes #291
(samples) Mark delivery attempts test as flaky. (#326) (5a97ef1)
(samples) Mitigate flakiness in subscriber_tests. (#304) (271a385)
(samples) Retry
InternalServerError
in dead letter policy test. (#329) (34c9b11), closes #321
Documentation¶
2.4.0¶
02-22-2021 05:02 PST
Implementation Changes¶
New Features¶
Add graceful streaming pull shutdown. (#292)
Documentation¶
Update samples with using the subscriber client as a context manager. (#254)
2.3.0 (2021-02-08)¶
Features¶
Bug Fixes¶
2.2.0 (2020-11-16)¶
Features¶
Bug Fixes¶
Documentation¶
2.1.0¶
09-21-2020 02:19 PDT
Implementation Changes¶
New Features¶
Regenerate the client lib to pick new mtls env (via synth). (#197)
Documentation¶
Internal / Testing Changes¶
Update CODEOWNERS. (#193)
2.0.0¶
09-11-2020 05:03 PDT
Implementation Changes¶
Transition the library to microgenerator. (#158) This is a breaking change that introduces several method signature changes and drops support for Python 2.7 and 3.5.
Documentation¶
Internal / Testing Changes¶
Fix flaky sequencer unit tests. (#187)
1.7.0 (2020-07-13)¶
This is the last release that supports Python 2.7 and 3.5.
New Features¶
Dependencies¶
Documentation¶
1.6.1 (2020-06-30)¶
Documentation¶
1.6.0 (2020-06-09)¶
Features¶
Bug Fixes¶
Documentation¶
Internal / Testing Changes¶
1.5.0 (2020-05-04)¶
Features¶
1.4.3 (2020-04-16)¶
Bug Fixes¶
1.4.2 (2020-03-25)¶
Bug Fixes¶
1.4.1 (2020-03-23)¶
Bug Fixes¶
1.4.0 (2020-03-06)¶
Features¶
1.3.1 (2020-02-28)¶
Bug Fixes¶
1.3.0 (2020-02-20)¶
Features¶
1.2.0 (2020-02-05)¶
Features¶
Bug Fixes¶
1.1.0¶
12-09-2019 18:51 PST
Implementation Changes¶
Update client configurations (via synth). (#9784)
Include request overhead when computing publish batch size overflow. (#9911)
Split large (mod)ACK requests into smaller ones. (#9594)
Fix messages delivered multiple times despite a long ACK deadline. (#9525)
Update batching and flow control parameters to be same as the other client libraries. (#9597)
Add
StreamingPullManager._should_terminate
. (#9335)
New Features¶
Add stop method. (#9365)
Dependencies¶
Add Python 2 sunset banner to documentation. (#9036)
Documentation¶
Change spacing in docs templates (via synth). (#9759)
Internal / Testing Changes¶
1.0.2¶
09-30-2019 11:57 PDT
Implementation Changes¶
Streaming pull shouldn’t need
subscriptions.get
permission (#9360).
1.0.1¶
09-27-2019 07:01 PDT
Implementation Changes¶
Set default stream ACK deadline to subscriptions’. (#9268)
Documentation¶
Internal / Testing Changes¶
Adjust messaging RPC timeout settings (via synth). #9279
1.0.0¶
08-29-2019 09:27 PDT
Implementation Changes¶
Documentation¶
Internal / Testing Changes¶
Add dead-letter-policy field in preparation for its implementation (via synth) (#9078)
0.45.0¶
07-31-2019 02:03 PDT
Implementation Changes¶
Remove deprecated methods and settings (#8836)
Documentation¶
0.44.0¶
07-29-2019 04:28 PDT
Implementation Changes¶
PubSub: Deprecate several FlowControl settings and things in Message class (#8796)
Documentation¶
Pub/Sub: document regional endpoint (#8789)
0.43.0¶
07-24-2019 17:13 PDT
Implementation Changes¶
New Features¶
Dependencies¶
Documentation¶
Link to googleapis.dev documentation in READMEs. (#8705)
Add compatibility check badges to READMEs. (#8288)
Fix typo in publisher index. (#8619)
Document how to choose the PubSub auth method (#8429)
Document different PuSub received message types (#8468)
PubSub: Document batch settings, make synth operations idempotent (#8448)
Add custom docstrings for FlowControl enum and values (via synth). (#8426)
Internal / Testing Changes¶
0.42.1¶
06-18-2019 15:14 PDT
Implementation Changes¶
0.42.0¶
06-18-2019 11:32 PDT
Implementation Changes¶
Core: Mitigate busy reopen loop in ResumableBidiRpc consuming 100% CPU (#8193)
Pub/Sub: Increase initial_rpc_timeout for messaging (via synth). (#8219)
PubSub: Release the state lock before calling the publish api (#8234)
Pub/Sub: Expose publish retry settings (#8231)
Prevent unhandled background error on SPM shutdown (#8111)
Update timeouts, blacken noxfile.py, setup.py (via synth). (#8128)
PubSub: Fix streaming pull incorrectly handling FlowControl max_messages setting (#7948)
Documentation¶
Internal / Testing Changes¶
0.41.0¶
05-15-2019 13:57 PDT
New Features¶
Implementation Changes¶
Internal / Testing Changes¶
0.40.0¶
03-15-2019 14:09 PDT
Implementation Changes¶
New Features¶
Dependencies¶
Documentation¶
Internal / Testing Changes¶
Copy proto files alongside protoc versions.
0.39.1¶
12-17-2018 16:57 PST
Implementation Changes¶
Documentation¶
Internal / Testing Changes¶
0.39.0¶
11-27-2018 13:32 PST
Implementation Changes¶
Pick up fixes to GAPIC generator. (#6503)
Override client classmethod factories inherited from GAPIC. (#6453)
Fix imports for hand-written client docstring examples. (#6345)
Fix path for patch of ‘bidi’ elements. (#6243)
Move bidi to api-core. (#6211)
Re-generate library using pubsub/synth.py (#6059)
Re-generate library using pubsub/synth.py (#5978)
New Features¶
Add ‘expiration_policy’ to subscriber client. (#6223)
Dependencies¶
Documentation¶
Internal / Testing Changes¶
0.38.0¶
Implementation Changes¶
Internal / Testing Changes¶
Nox: use inplace installs (#5865)
0.37.2¶
Implementation Changes¶
Fix classmethod wrapping (#5826)
Documentation¶
Fix Sphinx rendering for publisher client. (#5822)
Internal / Testing Changes¶
Re-generate library, removing obsolete synth modifications. (#5825)
Add test for testing invoking a wrapped class method on the class itself (#5828)
0.37.1¶
Implementation Changes¶
Make get_initial_request more resilient to race conditions. (#5803)
0.37.0¶
Implementation Changes¶
Make Publisher batch-related interfaces private (#5784)
0.36.0¶
Implementation Changes¶
Pubsub: Make ‘Message.publish_time’ return datetime (#5633)
Ensure SPM methods check that ‘self._consumer’ is not None before use. (#5758)
New Features¶
PubSub: add geo-fencing support (#5769)
Add ‘Message.ack_id’ property. (#5693)
0.35.4¶
Implementation Changes¶
Recover streams during the gRPC error callback. (#5446)
Use operational lock when checking for activity on streams. (#5445)
0.35.3¶
Implementation Changes¶
Add additional error handling to unary RPCs (#5438)
0.35.2¶
Implementation Changes¶
Add heartbeating to the streaming pull manager (#5413)
Fix retrying of bidirectional RPCs and closing the streaming pull manager (#5412)
0.35.1¶
Implementation Changes¶
Catch errors when re-retying send() or recv() in addition to open() (#5402)
0.35.0¶
Implementation Changes¶
Send requests during streaming pull over a separate unary RPC (#5377)
Initialize references to helper threads before starting them (#5374)
Make leaser exit more quickly (#5373)
Make re-open failures bubble to callbacks (#5372)
Avoid overwriting ‘module’ of messages from shared modules. (#5364)
Normalize overflow handling for max count and bytes (#5343)
New Features¶
Restore the synchronous pull method (#5379)
Promote subscribe_experimental() to subscribe(), remove old subscriber implementation. (#5274)
Wire up scheduler argument for subscribe() (#5279)
Documentation¶
Add link to streaming pull behavior documentation (#5378)
Fix example in subscribe’s documentation (#5375)
Internal / Testing Changes¶
Add Test runs for Python 3.7 and remove 3.4 (#5295)
Modify system tests to use prerelease versions of grpcio (#5304)
0.34.0¶
Implementation Changes¶
Lower the flow control defaults. (#5248)
New Features¶
A new implementation of the subscriber has been added. This is available as
SubscriberClient.subscribe_experimental
. In the next release, this will be replace the currentsubscribe
method. If you use this, please report your findings to us on GitHub. (#5189, #5201, #5210, #5229, #5230, #5237, #5256)
Dependencies¶
Remove psutil dependency. (#5248)
0.33.1¶
Implementation changes¶
Surface publish RPC errors back to the publish futures (#5124)
Make the pausable response iterator aware of the RPC state to prevent deadlock (#5108)
Properly handle graceful stop in request generator (#5097)
0.33.0¶
Implementation changes¶
Drop leased messages after flow_control.max_lease_duration has passed. (#5020)
Fix mantain leases to not modack messages it just dropped (#5045)
Avoid race condition in maintain_leases by copying leased_messages (#5035)
Retry subscription stream on InternalServerError, Unknown, and GatewayTimeout (#5021)
Use the rpc’s status to determine when to exit the request generator thread (#5054)
Fix missing iter on request stream (#5078)
Nack messages when the subscriber callback errors (#5019)
Testing¶
pubsub nox.py cleanup (#5056)
Fix test that checks for retryable exceptions (#5034)
0.32.1¶
Dependencies¶
Update dependency range for api-core to include v1.0.0 releases (#4944)
Testing and internal changes¶
Install local dependencies when running lint (#4936)
Re-enable lint for tests, remove usage of pylint (#4921)
0.32.0¶
Implementation changes¶
Added support for streaming pull receipts. (#4878)
0.31.0¶
New features¶
Added the ability for subscriber to batch requests. (#4895)
Added pending request backpressure for subscriber. (#4892)
Implementation changes¶
Raise
ValueError
when a message is too large for a batch. (#4872)Updated the default batch size to 10 MB. (#4857)
Allow a custom
Event
type in Pub / Sub futures. (#4643)
Documentation¶
Clarify that
modify_ack_deadline
resets the deadline. (#4822)
Testing¶
Fix unit test for default
max_bytes
value. (#4860)
0.30.1¶
Notable Implementation Changes¶
Moving lock factory used in publisher client to the Batch implementation (#4628).
Use a UUID (rather than a sentinel object) on
Future
(#4634).Apply scopes to explicitly provided credentials if needed (#4594). Fixes #4479. This feature comes as part of
google-api-core==0.1.3
.
Dependencies¶
Upgrading to
google-api-core==0.1.3
which depends on the latestgrpcio==1.8.2
(#4642). This fixes #4600. For details, see related gRPC bug and fix.
PyPI: https://pypi.org/project/google-cloud-pubsub/0.30.1/
0.30.0¶
Notable Implementation Changes¶
Dropping redundant
Policy._paused
data member (#4568).Removing redundant “active” check in policy (#4603).
Adding a
Consumer.active
property (#4604).Making it impossible to call
Policy.open()
on an already opened policy (#4606).Bug fix (#4575): Fix bug with async publish for batches. There were two related bugs. The first: if a batch exceeds the
max_messages
from the batch settings, then thecommit()
will fail. The second: when a “monitor” worker callscommit()
aftermax_latency
seconds, a failure can occur if a new message is added to the batch during the commit. To fix, the following changes were implemented:Adding a “STARTING” status for
Batch.commit()
(#4614). This fixes the issue when the batch exceedsmax_messages
.Adding extra check in
Batch.will_accept
for the number of messages (#4612).Moving
will_accept()
check out ofPublisherClient.batch()
factory (#4613).Checking
Batch.will_accept
in thread-safe way (#4616).
Breaking API change: As part of #4613, changing
PublisherClient.batch()
to no longer accept amessage
(since thewill_accept
check needs to happen in a more concurrency friendly way). In addition, changing thecreate
argument so that it means “create even if batch already exists” rather than “create if missing”.
Documentation¶
Add more explicit documentation for
Message.attributes
(#4601).Make
Message.__repr__
a bit prettier / more useful (#4602).
PyPI: https://pypi.org/project/google-cloud-pubsub/0.30.0/
0.29.4¶
Notable Implementation Changes¶
Bug fix: Restore previous behavior of the subscription lease maintenance worker. This was accidentally “stopped” in
0.29.3
due to a change in implementation that went from anactive
boolean to an “inactive” /stopped
boolean, soTrue
becameFalse
and vice-versa (#4564).
PyPI: https://pypi.org/project/google-cloud-pubsub/0.29.4/
0.29.3¶
Notable Implementation Changes¶
In subscription consumer thread: Making sure the request generator attached to an inactive bidirectional streaming pull is stopped before spawning a new request generator. This way we have a (fairly strong) guarantee that requests in the queue don’t get sent into an inactive stream (#4503, #4554).
Adding
pause
/resume
to subscription consumer thread and using these methods during flow control. The previous implementation tried to close the subscription (which involved 3 worker threads and 10 executors in a thread pool) and then re-open a new subscription. But, this was not entirely possible to shut down correctly from within one of the worker threads. Instead, we only pause the worker (of the 3) that is pulling new responses from the bidirectional streaming pull (#4558).Bug fix (#4516): Using
max
wheremin
was used by mistake to ensure the number of bytes tracked for subscription flow control remained non-negative (#4514).Raising
TypeError
ifSubscriberClient.subscribe
receives a non-callable callback (#4497).Shutting down thread pool executor when closing a subscriber policy (#4522).
Renaming
Policy.on_callback_request
toPolicy.dispatch_callback
and making the behavior much less dynamic (#4511).Make sure subscription consumer thread doesn’t try to join itself when exiting in error (#4540).
Dependencies¶
Upgrading
google-api-core
dependency to latest revision (0.1.2
) since we rely on the latest version of theconcurrent.futures
backport to provide thethread_name_prefix
argument for thread pool executor (#4521, #4559).
PyPI: https://pypi.org/project/google-cloud-pubsub/0.29.3/
0.29.2¶
Notable Implementation Changes¶
Bug fix (#4463): Making a subscription consumer actually stop running after encountering an exception (#4472, #4498). This bug is the only reason for the
0.29.2
release.Thread Changes
Added names to all threads created directly by Pub / Sub (#4474, #4476, #4480). Also removing spaces and colons from thread names (#4476).
Logging changes
Adding debug logs when lease management exits (#4484)
Adding debug logs when
QueueCallbackThread
exits (#4494). Instances handle the processing of messages in a subscription (e.g. toack
).Using a named logger in
publisher.batch.thread
(#4473)Adding newlines before logging protobuf payloads (#4471)
PyPI: https://pypi.org/project/google-cloud-pubsub/0.29.2/
0.29.1¶
Notable Implementation Changes¶
Bug fix (#4234): Adding retries for connection
UNAVAILABLE
. This bug made the Pub / Sub client mostly unusable for subscribers to topics that don’t have a steady stream of messages. After ~2 minutes of inactivity, the gRPC connection would timeout and raiseUNAVAILABLE
locally, i.e. not due to a response from the backend. (#4444)Updating autogenerated packages (#4438)
Documentation¶
Fixing broken examples in quick start (#4398)
Fixing broken example in README (#4402, h/t to @mehmetboraezer)
Updating old/dead link to usage doc in README (#4406, h/t to @mehmetboraezer)
Dependencies¶
Dropping dependency on
google-cloud-core
in exchange forgoogle-api-core
(#4438)
PyPI: https://pypi.org/project/google-cloud-pubsub/0.29.1/
0.29.0¶
Notable Implementation Changes¶
Honor
max_messages
always (#4262)Add futures for subscriptions (#4265)
Set gRPC message options and keepalive (#4269)
Documentation¶
Added link to “Python Development Environment Setup Guide” in project README (#4187, h/t to @michaelawyu)
Dependencies¶
Upgrading to
google-cloud-core >= 0.28.0
and adding dependency ongoogle-api-core
(#4221, #4280)Deferring to
google-api-core
forgrpcio
andgoogleapis-common-protos
dependencies (#4096, #4098)
PyPI: https://pypi.org/project/google-cloud-pubsub/0.29.0/