Changelog 114 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272
  1. .. _changelog:
  2. ================
  3. Change history
  4. ================
  5. .. _version-4.3.0:
  6. 4.3.0
  7. =====
  8. :release-date: 2019-01-14 7:00 P.M UTC+2:00
  9. :release-by: Omer Katz
  10. - Added Python 3.7 support.
  11. Contributed by **Omer Katz**, **Mads Jensen** and **Asif Saif Uddin**
  12. - Avoid caching queues which are declared with a TTL.
  13. Queues that are declared with a TTL are now also be excluded from the
  14. in-memory cache in case they expire between publishes on the same channel.
  15. Contributed by **Matt Yule-Bennett**
  16. - Added an index to the Message table for the SQLAlchemy transport.
  17. The index allows to effectively sorting the table by the message's timestamp.
  18. .. note::
  19. We do not provide migrations for this model yet.
  20. You will need to add the index manually if you are already
  21. using the SQLAlchemy transport.
  22. The syntax may vary between databases.
  23. Please refer to your database's documentation for instructions.
  24. Contributed by **Mikhail Shcherbinin**
  25. - Added a timeout that limits the amount of time we retry
  26. to reconnect to a transport.
  27. Contributed by **:github_user:`tothegump`**
  28. - :class:``celery.asynchronous.hub.Hub`` is now reentrant.
  29. This allows calling :func:`celery.bin.celery.main` to revive a worker in
  30. the same process after rescuing from shutdown (:class:``SystemExit``).
  31. Contributed by **Alan Justino da Silva**
  32. - Queues now accept string exchange names as arguments as documented.
  33. Tests were added to avoid further regressions.
  34. Contributed by **Antonio Gutierrez**
  35. - Specifying names for broadcast queues now work as expected.
  36. Previously, named broadcast queues did not create multiple queues per worker.
  37. They incorrectly declared the named queue which resulted in one queue per
  38. fanout exchange, thus missing the entire point of a fanout exchange.
  39. The behavior is now matched to unnamed broadcast queues.
  40. Contributed by **Kuan Hsuan-Tso**
  41. - When initializing the Redis transport in conjunction with gevent
  42. restore all unacknowledged messages to queue.
  43. Contributed by **Gal Cohen**
  44. - Allow :class:``kombu.simple.SimpleQueue`` to pass queue_arguments to Queue object.
  45. This allows :class:``kombu.simple.SimpleQueue`` to connect to RabbitMQ queues with
  46. custom arguments like 'x-queue-mode'='lazy'.
  47. Contributed by **C Blue Neeh**
  48. - Add support for 'rediss' scheme for secure Redis connections.
  49. The rediss scheme defaults to the least secure form, as
  50. there is no suitable default location for `ca_certs`. The recommendation
  51. would still be to follow the documentation and specify `broker_use_ssl` if
  52. coming from celery.
  53. Contributed by **Daniel Blair**
  54. - Added the Azure Storage Queues transport.
  55. The transport is implemented on top of Azure Storage
  56. Queues. This offers a simple but scalable and low-cost PaaS
  57. transport for Celery users in Azure. The transport is intended to be
  58. used in conjunction with the Azure Block Blob Storage backend.
  59. Contributed by **Clemens Wolff**, **:github_user:`@ankurokok`**,
  60. **Denis Kisselev**, **Evandro de Paula**, **Martin Peck**
  61. and **:github_user:`@michaelperel`**
  62. - Added the Azure Service Bus transport.
  63. The transport is implemented on top of Azure Service Bus and
  64. offers PaaS support for more demanding Celery workloads in Azure.
  65. The transport is intended to be used in conjunction with the Azure
  66. CosmosDB backend.
  67. Contributed by **Clemens Wolff**, **:github_user:`@ankurokok`**,
  68. **Denis Kisselev**, **Evandro de Paula**, **Martin Peck**
  69. and **:github_user:`@michaelperel`**
  70. - Drop remaining mentions of Jython support completely.
  71. Contributed by **Asif Saif Uddin** and **Mads Jensen**
  72. - When publishing messages to the Pidbox, retry if an error occurs.
  73. Contributed by **Asif Saif Uddin**
  74. - Fix infinite loop in :method:``kombu.asynchronous.hub.Hub.create_loop``.
  75. Previous attempt to fix the problem (PR kombu/760) did not consider
  76. an edge case. It is now fixed.
  77. Contributed by **Vsevolod Strukchinsky**
  78. - Worker shutdown no longer duplicates messages when using the SQS broker.
  79. Contributed by **Mintu Kumar Sah**
  80. - When using the SQS broker, prefer boto's default region before our hardcoded default.
  81. Contributed by **Victor Villas**
  82. - Fixed closing of shared redis sockets which previously caused Celery to hang.
  83. Contributed by **Alexey Popravka**
  84. - the `Pyro`_ transport (:mod:`kombu.transport.pyro`) now works with
  85. recent Pyro versions. Also added a Pyro Kombu Broker that this transport
  86. needs for its queues.
  87. Contributed by **Irmen de Jong**
  88. - Handle non-base64-encoded SQS messages.
  89. Fix contributed by **Tim Li**, **Asif Saif Uddin** and **Omer Katz**.
  90. - Move the handling of Sentinel failures to the redis library itself.
  91. Previously, Redis Sentinel worked only if the first node's sentinel
  92. service in the URI was up. A server outage would have caused downtime.
  93. Contributed by **Brian Price**
  94. - When using Celery and the pickle serializer with binary data as part of the
  95. payload, `UnicodeDecodeError` would be raised as the content was not utf-8.
  96. We now replace on errors.
  97. Contributed by **Jian Dai**
  98. - Allow setting :method:``boto3.sqs.create_queue`` Attributes via transport_options.
  99. Contributed by **Hunter Fernandes**
  100. - Fixed infinite loop when entity.channel is replaced by revive() on connection
  101. drop.
  102. Contributed by **Tzach Yarimi**
  103. - Added optional support for Brotli compression.
  104. Contributed by **Omer Katz**
  105. - When using the SQS broker, FIFO queues with names that ended with the 'f' letter
  106. were incorrectly parsed. This is now fixed.
  107. Contributed by **Alex Vishnya** and **Ilya Konstantinov**
  108. - Added optional support for LZMA compression.
  109. Contributed by **Omer Katz**
  110. - Added optional support for ZStandard compression.
  111. Contributed by **Omer Katz**
  112. - Require py-amqp 2.4.0 as the minimum version.
  113. Contributed by **Asif Saif Uddin**
  114. - The value of DISABLE_TRACEBACKS environment variable is now respected on debug, info
  115. and warning logger level.
  116. Contributed by **Ludovic Rivallain**
  117. - As documented in kombu/#741 and eventlet/eventlet#415
  118. there is a mismatch between the monkey-patched eventlet queue
  119. and the interface Kombu is expecting.
  120. This causes Celery to crash when the `broker_pool_limit`
  121. configuration option is set
  122. eventlet/eventlet#415 suggests that the mutex can be a noop.
  123. This is now the case.
  124. Contributed by **Josh Morrow**
  125. - Codebase improvements and fixes by:
  126. - **Omer Katz**
  127. - **Mads Jensen**
  128. - **Asif Saif Uddin**
  129. - **Lars Rinn**
  130. - Documentation improvements by:
  131. - **Jon Dufresne**
  132. - **Fay Cheng**
  133. - **Asif Saif Uddin**
  134. - **Kyle Verhoog**
  135. - **Noah Hall**
  136. - **:github_user:`brabiega`**
  137. .. _version-4.2.2-post1:
  138. 4.2.2-post1
  139. ===========
  140. :release-date: 2019-01-01 04:00 P.M IST
  141. :release-by: Omer Katz
  142. .. note::
  143. The previous release contained code from master.
  144. It is now deleted from PyPi.
  145. Please use this release instead.
  146. - No changes since previous release.
  147. .. _version-4.2.2:
  148. 4.2.2
  149. =====
  150. :release-date: 2018-12-06 04:30 P.M IST
  151. :release-by: Omer Katz
  152. - Support both Redis client version 2.x and version 3.x.
  153. Contributed by **Ash Berlin-Taylor** and **Jeppe Fihl-Pearson**
  154. .. _version-4.2.1:
  155. 4.2.1
  156. =====
  157. :release-date: 2018-05-21 09:00 A.M IST
  158. :release-by: Omer Katz
  159. .. note::
  160. The 4.2.0 release contained remains of the ``async`` module by accident.
  161. This is now fixed.
  162. - Handle librabbitmq fileno raising a ValueError when socket is not connected.
  163. Contributed by **Bryan Shelton**
  164. .. _version-4.2.0:
  165. 4.2.0
  166. =====
  167. :release-date: 2018-05-21 09:00 A.M IST
  168. :release-by: Omer Katz
  169. - Now passing ``max_retries``, ``interval_start``, ``interval_step``,
  170. ``interval_max`` parameters from broker ``transport_options`` to
  171. :meth:`~kombu.Connection.ensure_connection` when returning
  172. :meth:`~kombu.Connection.default_connection` (Issue #765).
  173. Contributed by **Anthony Lukach**.
  174. - Qpid: messages are now durable by default
  175. Contributed by **David Davis**
  176. - Kombu now requires version 2.10.4 or greater of the redis library,
  177. in line with Celery
  178. Contributed by **Colin Jeanne**
  179. - Fixed ImportError in some environments with outdated simplejson
  180. Contributed by **Aaron Morris**
  181. - MongoDB: fixed failure on MongoDB versions with an "-rc" tag
  182. Contributed by **dust8**
  183. - Ensure periodic polling frequency does not exceed timeout in
  184. virtual transport
  185. Contributed by **Arcadiy Ivanov**
  186. - Fixed string handling when using python-future module
  187. Contributed by **John Koehl"
  188. - Replaced "async" with "asynchronous" in preparation for Python 3.7
  189. Contributed by **Thomas Achtemichuk**
  190. - Allow removing pool size limit when in use
  191. Contributed by **Alex Hill**
  192. - Codebase improvements and fixes by:
  193. - **j2gg0s**
  194. - **Jon Dufresne**
  195. - **Jonas Lergell**
  196. - **Mads Jensen**
  197. - **Nicolas Delaby**
  198. - **Omer Katz**
  199. - Documentation improvements by:
  200. - **Felix Yan**
  201. - **Harry Moreno**
  202. - **Mads Jensen**
  203. - **Omer Katz**
  204. - **Radha Krishna. S.**
  205. - **Wojciech Matyśkiewicz**
  206. .. _version-4.1.0:
  207. 4.1.0
  208. =====
  209. :release-date: 2017-07-17 04:45 P.M MST
  210. :release-by: Anthony Lukach
  211. - SQS: Added support for long-polling on all supported queries. Fixed bug
  212. causing error on parsing responses with no retrieved messages from SQS.
  213. Contributed by **Anthony Lukach**.
  214. - Async hub: Fixed potential infinite loop while performing todo tasks
  215. (Issue celery/celery#3712).
  216. - Qpid: Fixed bug where messages could have duplicate ``delivery_tag``
  217. (Issue #563).
  218. Contributed by **bmbouter**.
  219. - MongoDB: Fixed problem with using ``readPreference`` option at pymongo 3.x.
  220. Contributed by **Mikhail Elovskikh**.
  221. - Re-added support for :pypi:``SQLAlchemy``
  222. Contributed by **Amin Ghadersohi**.
  223. - SQS: Fixed bug where hostname would default to ``localhost`` if not specified
  224. in settings.
  225. Contributed by **Anthony Lukach**.
  226. - Redis: Added support for reading password from transport URL (Issue #677).
  227. Contributed by **George Psarakis**.
  228. - RabbitMQ: Ensured safer encoding of queue arguments.
  229. Contributed by **Robert Kopaczewski**.
  230. - Added fallback to :func:``uuid.uuid5`` in :func:``generate_oid`` if
  231. :func:``uuid.uuid3`` fails.
  232. Contributed by **Bill Nottingham**.
  233. - Fixed race condition and innacurrate timeouts for
  234. :class:``kombu.simple.SimpleBase`` (Issue #720).
  235. Contributed by **c-nichols**.
  236. - Zookeeper: Fixed last chroot character trimming
  237. Contributed by **Dima Kurguzov**.
  238. - RabbitMQ: Fixed bug causing an exception when attempting to close an
  239. already-closed connection (Issue #690).
  240. Contributed by **eavictor**.
  241. - Removed deprecated use of StopIteration in generators and invalid regex
  242. escape sequence.
  243. Contributed by **Jon Dufresne**.
  244. - Added Python 3.6 to CI testing.
  245. Contributed by **Jon Dufresne**.
  246. - SQS: Allowed endpoint URL to be specified in the boto3 connection.
  247. Contributed by **georgepsarakis**.
  248. - SQS: Added support for Python 3.4.
  249. Contributed by **Anthony Lukach**.
  250. - SQS: ``kombu[sqs]`` now depends on :pypi:`boto3` (no longer using
  251. :pypi:`boto)`.
  252. - Adds support for Python 3.4+
  253. - Adds support for FIFO queues (Issue #678) and (Issue celery/celery#3690)
  254. - Avoids issues around a broken endpoints file (Issue celery/celery#3672)
  255. Contributed by **Mischa Spiegelmock** and **Jerry Seutter**.
  256. - Zookeeper: Added support for delaying task with Python 3.
  257. Contributed by **Dima Kurguzov**.
  258. - SQS: Fixed bug where :meth:`kombu.transport.SQS.drain_events` did not support
  259. callback argument (Issue #694).
  260. Contributed by **Michael Montgomery**.
  261. - Fixed bug around modifying dictionary size while iterating over it
  262. (Issue #675).
  263. Contributed by **Felix Yan**.
  264. - etcd: Added handling for :exc:`EtcdException` exception rather than
  265. :exc:`EtcdError`.
  266. Contributed by **Stephen Milner**.
  267. - Documentation improvements by:
  268. - **Mads Jensen**
  269. - **Matias Insaurralde**
  270. - **Omer Katz**
  271. - **Dmitry Dygalo**
  272. - **Christopher Hoskin**
  273. .. _version-4.0.2:
  274. 4.0.2
  275. =====
  276. :release-date: 2016-12-15 03:31 P.M PST
  277. :release-by: Ask Solem
  278. - Now depends on :mod:`amqp` 2.1.4
  279. This new version takes advantage of TCP Keepalive settings on Linux,
  280. making it better at detecting closed connections, also in failover
  281. conditions.
  282. - Redis: Priority was reversed so, e.g. priority 0 became priority 9.
  283. .. _version-4.0.1:
  284. 4.0.1
  285. =====
  286. :release-date: 2016-12-07 06:00 P.M PST
  287. :release-by: Ask Solem
  288. - Now depends on :mod:`amqp` 2.1.3
  289. This new version takes advantage of the new ``TCP_USER_TIMEOUT`` socket option
  290. on Linux.
  291. - Producer: Fixed performance degradation when default exchange specified
  292. (Issue #651).
  293. - QPid: Switch to using getattr in qpid.Transport.__del__ (Issue #658)
  294. Contributed by **Patrick Creech**.
  295. - QPid: Now uses monotonic time for timeouts.
  296. - MongoDB: Fixed compatibility with Python 3 (Issue #661).
  297. - Consumer: ``__exit__`` now skips cancelling consumer if connection-related
  298. error raised (Issue #670).
  299. - MongoDB: Removes use of natural sort (Issue #638).
  300. Contributed by **Anton Chaporgin**.
  301. - Fixed wrong keyword argument ``channel`` error (Issue #652).
  302. Contributed by **Toomore Chiang**.
  303. - Safe argument to ``urllib.quote`` must be bytes on Python 2.x (Issue #645).
  304. - Documentation improvements by:
  305. - **Carlos Edo**
  306. - **Cemre Mengu**
  307. .. _version-4.0:
  308. 4.0
  309. ===
  310. :release-date: 2016-10-28 16:45 P.M UTC
  311. :release-by: Ask Solem
  312. - Now depends on :mod:`amqp` 2.0.
  313. The new py-amqp version have been refactored for better performance,
  314. using modern Python socket conventions, and API consistency.
  315. - No longer depends on :mod:`anyjson`.
  316. Kombu will now only choose between :pypi:`simplejson` and the built-in
  317. :mod:`json`.
  318. Using the latest version of simplejson is recommended:
  319. .. code-block:: console
  320. $ pip install -U simplejson
  321. - Removed transports that are no longer supported in this version:
  322. - Django ORM transport
  323. - SQLAlchemy ORM transport
  324. - Beanstalk transport
  325. - ZeroMQ transport
  326. - amqplib transport (use pyamqp).
  327. - API Changes
  328. * Signature of :class:`kombu.Message` now takes body as first argment.
  329. It used to be ``Message(channel, body=body, **kw)``, but now it's
  330. ``Message(body, channel=channel, **kw)``.
  331. This is unlikey to affect you, as the Kombu API does not have
  332. users instantiate messages manually.
  333. - New SQS transport
  334. Donated by NextDoor, with additional contributions from mdk.
  335. .. note::
  336. ``kombu[sqs]`` now depends on :pypi:`pycurl`.
  337. - New Consul transport.
  338. Contributed by **Wido den Hollander**.
  339. - New etcd transport.
  340. Contributed by **Stephen Milner**.
  341. - New Qpid transport.
  342. It was introduced as an experimental transport in Kombu 3.0, but is now
  343. mature enough to be fully supported.
  344. Created and maintained by **Brian Bouterse**.
  345. - Redis: Priority 0 is now lowest, 9 is highest.
  346. (**backward incompatible**)
  347. This to match how priorities in AMQP works.
  348. Fix contributed by **Alex Koshelev**.
  349. - Redis: Support for Sentinel
  350. You can point the connection to a list of sentinel URLs like:
  351. .. code-block:: text
  352. sentinel://0.0.0.0:26379;sentinel://0.0.0.0:26380/...
  353. where each sentinel is separated by a `;`. Multiple sentinels are handled
  354. by :class:`kombu.Connection` constructor, and placed in the alternative
  355. list of servers to connect to in case of connection failure.
  356. Contributed by **Sergey Azovskov**, and **Lorenzo Mancini**
  357. - RabbitMQ Queue Extensions
  358. New arguments have been added to :class:`kombu.Queue` that lets
  359. you directly and conveniently configure the RabbitMQ queue extensions.
  360. - ``Queue(expires=20.0)``
  361. Set queue expiry time in float seconds.
  362. See :attr:`kombu.Queue.expires`.
  363. - ``Queue(message_ttl=30.0)``
  364. Set queue message time-to-live float seconds.
  365. See :attr:`kombu.Queue.message_ttl`.
  366. - ``Queue(max_length=1000)``
  367. Set queue max length (number of messages) as int.
  368. See :attr:`kombu.Queue.max_length`.
  369. - ``Queue(max_length_bytes=1000)``
  370. Set queue max length (message size total in bytes) as int.
  371. See :attr:`kombu.Queue.max_length_bytes`.
  372. - ``Queue(max_priority=10)``
  373. Declare queue to be a priority queue that routes messages
  374. based on the ``priority`` field of the message.
  375. See :attr:`kombu.Queue.max_priority`.
  376. - RabbitMQ: ``Message.ack`` now supports the ``multiple`` argument.
  377. If multiple is set to True, then all messages received before
  378. the message being acked will also be acknowledged.
  379. - ``amqps://`` can now be specified to require SSL (Issue #610).
  380. - ``Consumer.cancel_by_queue`` is now constant time.
  381. - ``Connection.ensure*`` now raises :exc:`kombu.exceptions.OperationalError`.
  382. Things that can be retried are now reraised as
  383. :exc:`kombu.exceptions.OperationalError`.
  384. - Redis: Fixed SSL support.
  385. Contributed by **Robert Kolba**.
  386. - New ``Queue.consumer_arguments`` can be used for the ability to
  387. set consumer priority via ``x-priority``.
  388. See https://www.rabbitmq.com/consumer-priority.html
  389. Example:
  390. .. code-block:: python
  391. Queue(
  392. 'qname',
  393. exchange=Exchange('exchange'),
  394. routing_key='qname',
  395. consumer_arguments={'x-priority': 3},
  396. )
  397. - Queue/Exchange: ``no_declare`` option added (also enabled for
  398. internal amq. exchanges) (Issue #565).
  399. - JSON serializer now calls ``obj.__json__`` for unsupported types.
  400. This means you can now define a ``__json__`` method for custom
  401. types that can be reduced down to a built-in json type.
  402. Example:
  403. .. code-block:: python
  404. class Person:
  405. first_name = None
  406. last_name = None
  407. address = None
  408. def __json__(self):
  409. return {
  410. 'first_name': self.first_name,
  411. 'last_name': self.last_name,
  412. 'address': self.address,
  413. }
  414. - JSON serializer now handles datetimes, Django promise, UUID and Decimal.
  415. - Beanstalk: Priority 0 is now lowest, 9 is highest.
  416. (**backward incompatible**)
  417. This to match how priorities in AMQP works.
  418. Fix contributed by **Alex Koshelev**.
  419. - Redis: now supports SSL using the ``ssl`` argument to
  420. :class:`~kombu.Connection`.
  421. - Redis: Fanout exchanges are no longer visible between vhosts,
  422. and fanout messages can be filtered by patterns.
  423. (**backward incompatible**)
  424. It was possible to enable this mode previously using the
  425. ``fanout_prefix``, and ``fanout_patterns``
  426. transport options, but now these are enabled by default.
  427. If you want to mix and match producers/consumers running different
  428. versions you need to configure your kombu 3.x clients to also enable
  429. these options:
  430. .. code-block:: pycon
  431. >>> Connection(transport_options={
  432. 'fanout_prefix': True,
  433. 'fanout_patterns': True,
  434. })
  435. - Pidbox: Mailbox new arguments: TTL and expiry.
  436. Mailbox now supports new arguments for controlling
  437. message TTLs and queue expiry, both for the mailbox
  438. queue and for reply queues.
  439. - ``queue_expires`` (float/int seconds).
  440. - ``queue_ttl`` (float/int seconds).
  441. - ``reply_queue_expires`` (float/int seconds).
  442. - ``reply_queue_ttl`` (float/int seconds).
  443. All take seconds in int/float.
  444. Contributed by **Alan Justino**.
  445. - Exchange.delivery_mode now defaults to :const:`None`, and the default
  446. is instead set by ``Producer.publish``.
  447. - :class:`~kombu.Consumer` now supports a new ``prefetch_count`` argument,
  448. which if provided will force the consumer to set an initial prefetch count
  449. just before starting.
  450. - Virtual transports now stores ``priority`` as a property, not in
  451. ``delivery_info``, to be compatible with AMQP.
  452. - ``reply_to`` argument to ``Producer.publish`` can now be
  453. :class:`~kombu.Queue` instance.
  454. - Connection: There's now a new method
  455. ``Connection.supports_exchange_type(type)`` that can be used to check if the
  456. current transport supports a specific exchange type.
  457. - SQS: Consumers can now read json messages not sent by Kombu.
  458. Contributed by **Juan Carlos Ferrer**.
  459. - SQS: Will now log the access key used when authentication fails.
  460. Contributed by **Hank John**.
  461. - Added new :class:`kombu.mixins.ConsumerProducerMixin` for consumers that
  462. will also publish messages on a separate connection.
  463. - Messages: Now have a more descriptive ``repr``.
  464. Contributed by **Joshua Harlow**.
  465. - Async: HTTP client based on curl.
  466. - Async: Now uses `poll` instead of `select` where available.
  467. - MongoDB: Now supports priorities
  468. Contributed by **Alex Koshelev**.
  469. - Virtual transports now supports multiple queue bindings.
  470. Contributed by **Federico Ficarelli**.
  471. - Virtual transports now supports the anon exchange.
  472. If when publishing a message, the exchange argument is set to '' (empty
  473. string), the routing_key will be regarded as the destination queue.
  474. This will bypass the routing table compeltely, and just deliver the
  475. message to the queue name specified in the routing key.
  476. - Zookeeper: Transport now uses the built-in suport in kazoo to handle
  477. failover when using a list of server names.
  478. Contributed by **Joshua Harlow**.
  479. - ConsumerMixin.run now passes keyword arguments to .consume.
  480. Deprecations and removals
  481. -------------------------
  482. - The deprecated method ``Consumer.add_queue_from_dict`` has been removed.
  483. Use instead:
  484. .. code-block:: python
  485. consumer.add_queue(Queue.from_dict(queue_name, **options))
  486. - The deprecated function ``kombu.serialization.encode`` has been removed.
  487. Use :func:`kombu.serialization.dumps` instead.
  488. - The deprecated function ``kombu.serialization.decode`` has been removed.
  489. Use :func:`kombu.serialization.loads` instead.
  490. - Removed module ``kombu.syn``
  491. ``detect_environment`` has been moved to kombu.utils.compat
  492. .. _version-3.0.37:
  493. 3.0.37
  494. ======
  495. :release-date: 2016-10-06 05:00 P.M PDT
  496. :release-by: Ask Solem
  497. - Connection: Return value of ``.info()`` was no longer JSON serializable,
  498. leading to "itertools.cycle object not JSON serializable"
  499. errors (Issue #635).
  500. .. _version-3.0.36:
  501. 3.0.36
  502. ======
  503. :release-date: 2016-09-30 03:06 P.M PDT
  504. :release-by: Ask Solem
  505. - Connection: Fixed bug when cloning connection with alternate urls.
  506. Fix contributed by Emmanuel Cazenave.
  507. - Redis: Fixed problem with unix socket connections.
  508. https://github.com/celery/celery/issues/2903
  509. Fix contributed by Raphael Michel.
  510. - Redis: Fixed compatibility with older redis-py versions (Issue #576).
  511. - Broadcast now retains queue name when being copied/pickled (Issue #578).
  512. .. _version-3.0.35:
  513. 3.0.35
  514. ======
  515. :release-date: 2016-03-22 11:22 P.M PST
  516. :release-by: Ask Solem
  517. - msgpack: msgpack support now requires msgpack-python > 0.4.7.
  518. - Redis: TimeoutError was no longer handled as a recoverable error.
  519. - Redis: Adds the ability to set more Redis connection options
  520. using ``Connection(transport_options={...})``.
  521. - ``socket_connect_timeout``
  522. - ``socket_keepalive`` (requires :mod:`redis-py` > 2.10)
  523. - ``socket_keepalive_options`` (requires :mod:`redis-py` > 2.10)
  524. - msgpack: Fixes support for binary/unicode data
  525. .. _version-3.0.34:
  526. 3.0.34
  527. ======
  528. :release-date: 2016-03-03 05:30 P.M PST
  529. :release-by: Ask Solem
  530. - Qpid: Adds async error handling.
  531. Contributed by Brian Bouterse.
  532. - Qpid: Delivery tag is now a UUID4 (Issue #563).
  533. Fix contributed by Brian Bouterse.
  534. - Redis: Connection.as_uri() returned malformed URLs when the
  535. ``redis+socket`` scheme was ised (Issue celery/celery#2995).
  536. - msgpack: Use binary encoding instead of utf-8 (Issue #570).
  537. .. _version-3.0.33:
  538. 3.0.33
  539. ======
  540. :release-date: 2016-01-08 06:36 P.M PST
  541. :release-by: Ask Solem
  542. - Now depends on :mod:`amqp` 1.4.9.
  543. - Redis: Fixed problem with auxilliary connections causing the main
  544. consumer connection to be closed (Issue #550).
  545. - Qpid: No longer uses threads to operate, to ensure compatibility with
  546. all environments (Issue #531).
  547. .. _version-3.0.32:
  548. 3.0.32
  549. ======
  550. :release-date: 2015-12-16 02:29 P.M PST
  551. :release-by: Ask Solem
  552. - Redis: Fixed bug introduced in 3.0.31 where the redis transport always
  553. connects to localhost, regardless of host setting.
  554. .. _version-3.0.31:
  555. 3.0.31
  556. ======
  557. :release-date: 2015-12-16 12:00 P.M PST
  558. :release-by: Ask Solem
  559. - Redis: Fixed bug introduced in 3.0.30 where socket was prematurely
  560. disconnected.
  561. - Hub: Removed debug logging message: "Deregistered fd..." (Issue #549).
  562. .. _version-3.0.30:
  563. 3.0.30
  564. ======
  565. :release-date: 2015-12-07 12:28 A.M PST
  566. :release-by: Ask Solem
  567. - Fixes compatiblity with uuid in Python 2.7.11 and 3.5.1.
  568. Fix contributed by Kai Groner.
  569. - Redis transport: Attempt at fixing problem with hanging consumer
  570. after disconnected from server.
  571. - Event loop:
  572. Attempt at fixing issue with 100% CPU when using the Redis transport,
  573. - Database transport: Fixed oracle compatiblity.
  574. An "ORA-00907: missing right parenthesis" error could manifest when using
  575. an Oracle database with the database transport.
  576. Fix contributed by Deepak N.
  577. - Documentation fixes
  578. Contributed by Tommaso Barbugli.
  579. .. _version-3.0.29:
  580. 3.0.29
  581. ======
  582. :release-date: 2015-10-26 11:10 A.M PDT
  583. :release-by: Ask Solem
  584. - Fixed serialization issue for ``bindings.as_dict()`` (Issue #453).
  585. Fix contributed by Sergey Tikhonov.
  586. - Json serializer wrongly treated bytes as ``ascii``, not ``utf-8``
  587. (Issue #532).
  588. - MongoDB: Now supports pymongo 3.x.
  589. Contributed by Len Buckens.
  590. - SQS: Tests passing on Python 3.
  591. Fix contributed by Felix Yan
  592. .. _version-3.0.28:
  593. 3.0.28
  594. ======
  595. :release-date: 2015-10-12 12:00 PM PDT
  596. :release-by: Ask Solem
  597. .. admonition:: Django transport migrations.
  598. If you're using Django 1.8 and have already created the
  599. kombu_transport_django tables, you have to run a fake initial migration:
  600. .. code-block:: console
  601. $ python manage.py migrate kombu_transport_django --fake-initial
  602. - No longer compatible with South by default.
  603. To keep using kombu.transport.django with South migrations
  604. you now need to configure a new location for the kombu migrations:
  605. .. code-block:: python
  606. SOUTH_MIGRATION_MODULES = {
  607. 'kombu_transport_django':
  608. 'kombu.transport.django.south_migrations',
  609. }
  610. - Keep old South migrations in ``kombu.transport.django.south_migrations``.
  611. - Now works with Redis < 2.10 again.
  612. .. _version-3.0.27:
  613. 3.0.27
  614. ======
  615. :release-date: 2015-10-09 3:10 PM PDT
  616. :release-by: Ask Solem
  617. - Now depends on :mod:`amqp` 1.4.7.
  618. - Fixed libSystem import error on some macOS 10.11 (El Capitan) installations.
  619. Fix contributed by Eric Wang.
  620. - Now compatible with Django 1.9.
  621. - Django: Adds migrations for the database transport.
  622. - Redis: Now depends on py-redis 2.10.0 or later (Issue #468).
  623. - QPid: Can now connect as localhost (Issue #519).
  624. Fix contributed by Brian Bouterse.
  625. - QPid: Adds support for ``login_method`` (Issue #502, Issue #499).
  626. Contributed by Brian Bouterse.
  627. - QPid: Now reads SASL mechanism from broker string (Issue #498).
  628. Fix contributed by Brian Bouterse.
  629. - QPid: Monitor thread now properly terminated on session close (Issue #485).
  630. Fix contributed by Brian Bouterse.
  631. - QPid: Fixed file descriptor leak (Issue #476).
  632. Fix contributed by Jeff Ortel
  633. - Docs: Fixed wrong order for entrypoint arguments (Issue #473).
  634. - ConsumerMixin: Connection error logs now include traceback (Issue #480).
  635. - BaseTransport now raises RecoverableConnectionError when disconnected
  636. (Issue #507).
  637. - Consumer: Adds ``tag_prefix`` option to modify how consumer tags are
  638. generated (Issue #509).
  639. .. _version-3.0.26:
  640. 3.0.26
  641. ======
  642. :release-date: 2015-04-22 06:00 P.M UTC
  643. :release-by: Ask Solem
  644. - Fixed compatibility with py-redis versions before 2.10.3 (Issue #470).
  645. .. _version-3.0.25:
  646. 3.0.25
  647. ======
  648. :release-date: 2015-04-21 02:00 P.M UTC
  649. :release-by: Ask Solem
  650. - pyamqp/librabbitmq now uses 5671 as default port when SSL is enabled
  651. (Issue #459).
  652. - Redis: Now supports passwords in ``redis+socket://:pass@host:port`` URLs
  653. (Issue #460).
  654. - ``Producer.publish`` now defines the ``expiration`` property in support
  655. of the `RabbitMQ per-message TTL extension`_.
  656. Contributed by Anastasis Andronidis.
  657. - Connection transport attribute now set correctly for all transports.
  658. Contributed by Alex Koshelev.
  659. - qpid: Fixed bug where the connectionw as not being closed properly.
  660. Contributed by Brian Bouterse.
  661. - :class:`~kombu.entity.bindings` is now JSON serializable (Issue #453).
  662. Contributed by Sergey Tikhonov.
  663. - Fixed typo in error when yaml is not installed (said ``msgpack``).
  664. Contributed by Joshua Harlow.
  665. - Redis: Now properly handles :exc:`redis.exceptions.TimeoutError`
  666. raised by :mod:`redis`.
  667. Contributed by markow.
  668. - qpid: Adds additional string to check for when connecting to qpid.
  669. When we connect to qpid, we need to ensure that we skip to the next SASL
  670. mechanism if the current mechanism fails. Otherwise, we will keep retrying the
  671. connection with a non-working mech.
  672. Contributed by Chris Duryee.
  673. - qpid: Handle ``NotFound`` exceptions.
  674. Contributed by Brian Bouterse.
  675. - :class:`Queue.__repr__` now makes sure return value is not unicode
  676. (Issue #440).
  677. - qpid: ``Queue.purge`` incorrectly raised :exc:`AttributeErrror` if the
  678. does not exist (Issue #439).
  679. Contributed by Brian Bouterse.
  680. - Linux: Now ignores permission errors on epoll unregister.
  681. .. _`RabbitMQ per-message TTL extension`: https://www.rabbitmq.com/ttl.html
  682. .. _version-3.0.24:
  683. 3.0.24
  684. ======
  685. :release-date: 2014-11-17 11:00 P.M UTC
  686. :release-by: Ask Solem
  687. - The `Qpid <http://qpid.apache.org/>`_ broker is supported for Python 2.x
  688. environments. The Qpid transport includes full SSL support within Kombu. See
  689. the :mod:`kombu.transport.qpid` docs for more info.
  690. Contributed by Brian Bouterse and Chris Duryee through support from Red Hat.
  691. - Dependencies: extra[librabbitmq] now requires librabbitmq 1.6.0
  692. - Docstrings for :class:`~kombu.utils.limit.TokenBucket` did not match
  693. implementation.
  694. Fix contributed by Jesse Dhillon.
  695. - :func:`~kombu.common.oid_from` accidentally called ``uuid.getnode()`` but
  696. did not use the return value.
  697. Fix contributed by Alexander Todorov.
  698. - Redis: Now ignores errors when cosing the underlying connection.
  699. - Redis: Restoring messages will now use a single connection.
  700. - ``kombu.five.monotonic``: Can now be imported even if ctypes is not
  701. available for some reason (e.g. App Engine)
  702. - Documentation: Improved example to use the ``declare`` argument to
  703. ``Producer`` (Issue #423).
  704. - Django: Fixed ``app_label`` for older Django versions (``< 1.7``).
  705. (Issue #414).
  706. .. _version-3.0.23:
  707. 3.0.23
  708. ======
  709. :release-date: 2014-09-14 10:45 P.M UTC
  710. :release-by: Ask Solem
  711. - Django: Fixed bug in the Django 1.7 compatibility improvements related
  712. to autocommit handling.
  713. Contributed by Radek Czajka.
  714. - Django: The Django transport models would not be created on syncdb
  715. after app label rename (Issue #406).
  716. .. _version-3.0.22:
  717. 3.0.22
  718. ======
  719. :release-date: 2014-09-04 03:00 P.M UTC
  720. :release-by: Ask Solem
  721. - kombu.async: Min. delay between waiting for timer was always increased to
  722. one second.
  723. - Fixed bug in itermessages where message is received after the with
  724. statement exits the block.
  725. Fixed by Rumyana Neykova
  726. - Connection.autoretry: Now works with functions missing wrapped attributes
  727. (``__module__``, ``__name__``, ``__doc__``). Fixes #392.
  728. Contributed by johtso.
  729. - Django: Now sets custom app label for ``kombu.transport.django`` to work
  730. with recent changes in Django 1.7.
  731. - SimpleQueue removed messages from the wrong end of buffer (Issue #380).
  732. - Tests: Now using ``unittest.mock`` if available (Issue #381).
  733. .. _version-3.0.21:
  734. 3.0.21
  735. ======
  736. :release-date: 2014-07-07 02:00 P.M UTC
  737. :release-by: Ask Solem
  738. - Fixed remaining bug in ``maybe_declare`` for ``auto_delete`` exchanges.
  739. Fix contributed by Roger Hu.
  740. - MongoDB: Creating a channel now properly evaluates a connection (Issue #363).
  741. Fix contributed by Len Buckens.
  742. .. _version-3.0.20:
  743. 3.0.20
  744. ======
  745. :release-date: 2014-06-24 02:30 P.M UTC
  746. :release-by: Ask Solem
  747. - Reverts change in 3.0.17 where ``maybe_declare`` caches the declaration
  748. of auto_delete queues and exchanges.
  749. Fix contributed by Roger Hu.
  750. - Redis: Fixed race condition when using gevent and the channel is closed.
  751. Fix contributed by Andrew Rodionoff.
  752. .. _version-3.0.19:
  753. 3.0.19
  754. ======
  755. :release-date: 2014-06-09 03:10 P.M UTC
  756. :release-by: Ask Solem
  757. - The wheel distribution did not support Python 2.6 by failing to list
  758. the extra dependencies required.
  759. - Durable and auto_delete queues/exchanges can be be cached using
  760. ``maybe_declare``.
  761. .. _version-3.0.18:
  762. 3.0.18
  763. ======
  764. :release-date: 2014-06-02 06:00 P.M UTC
  765. :release-by: Ask Solem
  766. - A typo introduced in 3.0.17 caused kombu.async.hub to crash (Issue #360).
  767. .. _version-3.0.17:
  768. 3.0.17
  769. ======
  770. :release-date: 2014-06-02 05:00 P.M UTC
  771. :release-by: Ask Solem
  772. - ``kombu[librabbitmq]`` now depends on librabbitmq 1.5.2.
  773. - Async: Event loop now selectively removes file descriptors for the mode
  774. it failed in, and keeps others (e.g read vs write).
  775. Fix contributed by Roger Hu.
  776. - CouchDB: Now works without userid set.
  777. Fix contributed by Latitia M. Haskins.
  778. - SQLAlchemy: Now supports recovery from connection errors.
  779. Contributed by Felix Schwarz.
  780. - Redis: Restore at shutdown now works when ack emulation is disabled.
  781. - :func:`kombu.common.eventloop` accidentally swallowed socket errors.
  782. - Adds :func:`kombu.utils.url.sanitize_url`
  783. .. _version-3.0.16:
  784. 3.0.16
  785. ======
  786. :release-date: 2014-05-06 01:00 P.M UTC
  787. :release-by: Ask Solem
  788. - ``kombu[librabbitmq]`` now depends on librabbitmq 1.5.1.
  789. - Redis: Fixes ``TypeError`` problem in ``unregister`` (Issue #342).
  790. Fix contributed by Tobias Schottdorf.
  791. - Tests: Some unit tests accidentally required the `redis-py` library.
  792. Fix contributed by Randy Barlow.
  793. - librabbitmq: Would crash when using an older version of :mod:`librabbitmq`,
  794. now emits warning instead.
  795. .. _version-3.0.15:
  796. 3.0.15
  797. ======
  798. :release-date: 2014-04-15 09:00 P.M UTC
  799. :release-by: Ask Solem
  800. - Now depends on :mod:`amqp` 1.4.5.
  801. - RabbitMQ 3.3 changes QoS semantics (Issue #339).
  802. See the RabbitMQ release notes here:
  803. http://www.rabbitmq.com/blog/2014/04/02/breaking-things-with-rabbitmq-3-3/
  804. A new connection property has been added that can be used to detect
  805. whether the remote server is using this new QoS behavior:
  806. .. code-block:: pycon
  807. >>> Connection('amqp://').qos_behavior_matches_spec
  808. False
  809. so if your application depends on the old semantics you can
  810. use this to set the ``apply_global`` flag appropriately:
  811. .. code-block:: python
  812. def update_prefetch_count(channel, new_value):
  813. channel.basic_qos(
  814. 0, new_value,
  815. not channel.connection.client.qos_behavior_matches_spec,
  816. )
  817. - Users of :mod:`librabbitmq` is encouraged to upgrade to librabbitmq 1.5.0.
  818. The ``kombu[librabbitmq]`` extra has been updated to depend on this
  819. version.
  820. - Pools: Now takes transport options into account when comparing connections
  821. (Issue #333).
  822. - MongoDB: Fixes Python 3 compatibility.
  823. - Async: select: Ignore socket errors when attempting to unregister handles
  824. from the loop.
  825. - Pidbox: Can now be configured to use a serializer other than json,
  826. but specifying a serializer argument to :class:`~kombu.pidbox.Mailbox`.
  827. Contributed by Dmitry Malinovsky.
  828. - Message decompression now works with Python 3.
  829. Fix contributed by Adam Gaca.
  830. .. _version-3.0.14:
  831. 3.0.14
  832. ======
  833. :release-date: 2014-03-19 07:00 P.M UTC
  834. :release-by: Ask Solem
  835. - **MongoDB**: Now endures a connection failover (Issue #123).
  836. Fix contributed by Alex Koshelev.
  837. - **MongoDB**: Fixed ``KeyError`` when a replica set member is removed.
  838. Also fixes celery#971 and celery/#898.
  839. Fix contributed by Alex Koshelev.
  840. - **MongoDB**: Fixed MongoDB broadcast cursor re-initialization bug.
  841. Fix contributed by Alex Koshelev.
  842. - **Async**: Fixed bug in lax semaphore implementation where in
  843. some usage patterns the limit was not honored correctly.
  844. Fix contributed by Ionel Cristian Mărieș.
  845. - **Redis**: Fixed problem with fanout when using Python 3 (Issue #324).
  846. - **Redis**: Fixed ``AttributeError`` from attempting to close a non-existing
  847. connection (Issue #320).
  848. .. _version-3.0.13:
  849. 3.0.13
  850. ======
  851. :release-date: 2014-03-03 04:00 P.M UTC
  852. :release-by: Ask Solem
  853. - Redis: Fixed serious race condition that could lead to data loss.
  854. The delivery tags were accidentally set to be an incremental number
  855. local to the channel, but the delivery tags need to be globally
  856. unique so that a message can not overwrite an older message
  857. in the backup store.
  858. This change is not backwards incompatible and you are encouraged
  859. to update all your system using a previous version as soon as possible.
  860. - Now depends on :mod:`amqp` 1.4.4.
  861. - Pidbox: Now makes sure message encoding errors are handled by default,
  862. so that a custom error handler does not need to be specified.
  863. - Redis: The fanout exchange can now use AMQP patterns to route and filter
  864. messages.
  865. This change is backwards incompatible and must be enabled with
  866. the ``fanout_patterns`` transport option:
  867. .. code-block:: pycon
  868. >>> conn = kombu.Connection('redis://', transport_options={
  869. ... 'fanout_patterns': True,
  870. ... })
  871. When enabled the exchange will work like an amqp topic exchange
  872. if the binding key is a pattern.
  873. This is planned to be default behavior in the future.
  874. - Redis: Fixed ``cycle`` no such attribute error.
  875. .. _version-3.0.12:
  876. 3.0.12
  877. ======
  878. :release-date: 2014-02-09 03:50 P.M UTC
  879. :release-by: Ask Solem
  880. - Now depends on :mod:`amqp` 1.4.3.
  881. - Fixes Python 3.4 logging incompatibility (Issue #311).
  882. - Redis: Now properly handles unknown pub/sub messages.
  883. Fix contributed by Sam Stavinoha.
  884. - amqplib: Fixed bug where more bytes were requested from the socket
  885. than necessary.
  886. Fix contributed by Ionel Cristian Mărieș.
  887. .. _version-3.0.11:
  888. 3.0.11
  889. ======
  890. :release-date: 2014-02-03 05:00 P.M UTC
  891. :release-by: Ask Solem
  892. - Now depends on :mod:`amqp` 1.4.2.
  893. - Now always trusts messages of type `application/data` and `application/text`
  894. or which have an unspecified content type (Issue #306).
  895. - Compression errors are now handled as decode errors and will trigger
  896. the ``Consumer.on_decode_error`` callback if specified.
  897. - New ``kombu.Connection.get_heartbeat_interval()`` method that can be
  898. used to access the negotiated heartbeat value.
  899. - `kombu.common.oid_for` no longer uses the MAC address of the host, but
  900. instead uses a process-wide UUID4 as a node id.
  901. This avoids a call to `uuid.getnode()` at module scope.
  902. - Hub.add: Now normalizes registered fileno.
  903. Contributed by Ionel Cristian Mărieș.
  904. - SQS: Fixed bug where the prefetch count limit was not respected.
  905. .. _version-3.0.10:
  906. 3.0.10
  907. ======
  908. :release-date: 2014-01-17 05:40 P.M UTC
  909. :release-by: Ask Solem
  910. - Now depends on :mod:`amqp` 1.4.1.
  911. - ``maybe_declare`` now raises a "recoverable connection error" if
  912. the channel is disconnected instead of a :exc:`ChannelError` so that
  913. the operation can be retried.
  914. - Redis: ``Consumer.cancel()`` is now thread safe.
  915. This fixes an issue when using gevent/eventlet and a
  916. message is handled after the consumer is canceled resulting
  917. in a "message for queue without consumers" error.
  918. - Retry operations would not always respect the interval_start
  919. value when calculating the time to sleep for (Issue #303).
  920. Fix contributed by Antoine Legrand.
  921. - Timer: Fixed "unhashable type" error on Python 3.
  922. - Hub: Do not attempt to unregister operations on an already closed
  923. poller instance.
  924. .. _version-3.0.9:
  925. 3.0.9
  926. =====
  927. :release-date: 2014-01-13 05:30 P.M UTC
  928. :release-by: Ask Solem
  929. - Now depends on :mod:`amqp` 1.4.0.
  930. - Redis: Basic cancel for fanout based queues now sends a corresponding
  931. ``UNSUBSCRIBE`` command to the server.
  932. This fixes an issue with pidbox where reply messages could be received
  933. after the consumer was canceled, giving the ``"message to queue without
  934. consumers"`` error.
  935. - MongoDB: Improved connection string and options handling
  936. (Issue #266 + Issue #120).
  937. Contributed by Alex Koshelev.
  938. - SQS: Limit the number of messages when receiving in batch to 10.
  939. This is a hard limit enforced by Amazon so the sqs transport
  940. must not exceeed this value.
  941. Fix contributed by Eric Reynolds.
  942. - ConsumerMixin: ``consume`` now checks heartbeat every time the
  943. socket times out.
  944. Contributed by Dustin J. Mitchell.
  945. - Retry Policy: A max retries of 0 did not retry forever.
  946. Fix contributed by Antoine Legrand.
  947. - Simple: If passing a Queue object the simple utils will now take
  948. default routing key from that queue.
  949. Contributed by Fernando Jorge Mota.
  950. - ``repr(producer)`` no longer evaluates the underlying channnel.
  951. - Redis: The map of Redis error classes are now exposed at the module level
  952. using the :func:`kombu.transport.redis.get_redis_error_classes` function.
  953. - Async: ``Hub.close`` now sets ``.poller`` to None.
  954. .. _version-3.0.8:
  955. 3.0.8
  956. =====
  957. :release-date: 2013-12-16 05:00 P.M UTC
  958. :release-by: Ask Solem
  959. - Serializer: loads and dumps now wraps exceptions raised into
  960. :exc:`~kombu.exceptions.DecodeError` and
  961. :exc:`kombu.exceptions.EncodeError` respectively.
  962. Contributed by Ionel Cristian Maries
  963. - Redis: Would attempt to read from the wrong connection if a select/epoll/kqueue
  964. exception event happened.
  965. Fix contributed by Michael Nelson.
  966. - Redis: Disabling ack emulation now works properly.
  967. Fix contributed by Michael Nelson.
  968. - Redis: :exc:`IOError` and :exc:`OSError` are now treated as recoverable
  969. connection errors.
  970. - SQS: Improved performance by reading messages in bulk.
  971. Contributed by Matt Wise.
  972. - Connection Pool: Attempting to acquire from a closed pool will now
  973. raise :class:`RuntimeError`.
  974. .. _version-3.0.7:
  975. 3.0.7
  976. =====
  977. :release-date: 2013-12-02 04:00 P.M UTC
  978. :release-by: Ask Solem
  979. - Fixes Python 2.6 compatibility.
  980. - Redis: Fixes 'bad file descriptor' issue.
  981. .. _version-3.0.6:
  982. 3.0.6
  983. =====
  984. :release-date: 2013-11-21 04:50 P.M UTC
  985. :release-by: Ask Solem
  986. - Timer: No longer attempts to hash keyword arguments (Issue #275).
  987. - Async: Did not account for the long type for file descriptors.
  988. Fix contributed by Fabrice Rabaute.
  989. - PyPy: kqueue support was broken.
  990. - Redis: Bad pub/sub payloads no longer crashes the consumer.
  991. - Redis: Unix socket URLs can now specify a virtual host by including
  992. it as a query parameter.
  993. Example URL specifying a virtual host using database number 3:
  994. .. code-block:: text
  995. redis+socket:///tmp/redis.sock?virtual_host=3
  996. - ``kombu.VERSION`` is now a named tuple.
  997. .. _version-3.0.5:
  998. 3.0.5
  999. =====
  1000. :release-date: 2013-11-15 11:00 P.M UTC
  1001. :release-by: Ask Solem
  1002. - Now depends on :mod:`amqp` 1.3.3.
  1003. - Redis: Fixed Python 3 compatibility problem (Issue #270).
  1004. - MongoDB: Fixed problem with URL parsing when authentication used.
  1005. Fix contributed by dongweiming.
  1006. - pyamqp: Fixed small issue when publishing the message and
  1007. the property dictionary was set to None.
  1008. Fix contributed by Victor Garcia.
  1009. - Fixed problem in ``repr(LaxBoundedSemaphore)``.
  1010. Fix contributed by Antoine Legrand.
  1011. - Tests now passing on Python 3.3.
  1012. .. _version-3.0.4:
  1013. 3.0.4
  1014. =====
  1015. :release-date: 2013-11-08 01:00 P.M UTC
  1016. :release-by: Ask Solem
  1017. - common.QoS: ``decrement_eventually`` now makes sure the value
  1018. does not go below 1 if a prefetch count is enabled.
  1019. .. _version-3.0.3:
  1020. 3.0.3
  1021. =====
  1022. :release-date: 2013-11-04 03:00 P.M UTC
  1023. :release-by: Ask Solem
  1024. - SQS: Properly reverted patch that caused delays between messages.
  1025. Contributed by James Saryerwinnie
  1026. - select: Clear all registerd fds on poller.cloe
  1027. - Eventloop: unregister if EBADF raised.
  1028. .. _version-3.0.2:
  1029. 3.0.2
  1030. =====
  1031. :release-date: 2013-10-29 02:00 P.M UTC
  1032. :release-by: Ask Solem
  1033. - Now depends on :mod:`amqp` version 1.3.2.
  1034. - select: Fixed problem where unregister did not properly remove
  1035. the fd.
  1036. .. _version-3.0.1:
  1037. 3.0.1
  1038. =====
  1039. :release-date: 2013-10-24 04:00 P.M UTC
  1040. :release-by: Ask Solem
  1041. - Now depends on :mod:`amqp` version 1.3.1.
  1042. - Redis: New option ``fanout_keyprefix``
  1043. This transport option is recommended for all users as it ensures
  1044. that broadcast (fanout) messages sent is only seen by the current
  1045. virtual host:
  1046. .. code-block:: python
  1047. Connection('redis://', transport_options={'fanout_keyprefix': True})
  1048. However, enabling this means that you cannot send or receive messages
  1049. from older Kombu versions so make sure all of your participants
  1050. are upgraded and have the transport option enabled.
  1051. This will be the default behavior in Kombu 4.0.
  1052. - Distribution: Removed file ``requirements/py25.txt``.
  1053. - MongoDB: Now disables ``auto_start_request``.
  1054. - MongoDB: Enables ``use_greenlets`` if eventlet/gevent used.
  1055. - Pidbox: Fixes problem where expires header was None,
  1056. which is a value not supported by the amq protocol.
  1057. - ConsumerMixin: New ``consumer_context`` method for starting
  1058. the consumer without draining events.
  1059. .. _version-3.0.0:
  1060. 3.0.0
  1061. =====
  1062. :release-date: 2013-10-14 04:00 P.M BST
  1063. :release-by: Ask Solem
  1064. - Now depends on :mod:`amqp` version 1.3.
  1065. - No longer supports Python 2.5
  1066. The minimum Python version supported is now Python 2.6.0 for Python 2,
  1067. and Python 3.3 for Python 3.
  1068. - Dual codebase supporting both Python 2 and 3.
  1069. No longer using ``2to3``, making it easier to maintain support for
  1070. both versions.
  1071. - pickle, yaml and msgpack deserialization is now disabled by default.
  1072. This means that Kombu will by default refuse to handle any content type other
  1073. than json.
  1074. Pickle is known to be a security concern as it will happily
  1075. load any object that is embedded in a pickle payload, and payloads
  1076. can be crafted to do almost anything you want. The default
  1077. serializer in Kombu is json but it also supports a number
  1078. of other serialization formats that it will evaluate if received:
  1079. including pickle.
  1080. It was always assumed that users were educated about the security
  1081. implications of pickle, but in hindsight we don't think users
  1082. should be expected to secure their services if we have the ability to
  1083. be secure by default.
  1084. By disabling any content type that the user did not explicitly
  1085. want enabled we ensure that the user must be conscious when they
  1086. add pickle as a serialization format to support.
  1087. The other built-in serializers (yaml and msgpack) are also disabled
  1088. even though they aren't considered insecure [#f1]_ at this point.
  1089. Instead they're disabled so that if a security flaw is found in one of these
  1090. libraries in the future, you will only be affected if you have
  1091. explicitly enabled them.
  1092. To have your consumer accept formats other than json you have to
  1093. explicitly add the wanted formats to a white-list of accepted
  1094. content types:
  1095. .. code-block:: pycon
  1096. >>> c = Consumer(conn, accept=['json', 'pickle', 'msgpack'])
  1097. or when using synchronous access:
  1098. .. code-block:: pycon
  1099. >>> msg = queue.get(accept=['json', 'pickle', 'msgpack'])
  1100. The ``accept`` argument was first supported for consumers in version
  1101. 2.5.10, and first supported by ``Queue.get`` in version 2.5.15
  1102. so to stay compatible with previous versions you can enable
  1103. the previous behavior:
  1104. >>> from kombu import enable_insecure_serializers
  1105. >>> enable_insecure_serializers()
  1106. But note that this has global effect, so be very careful should you use it.
  1107. .. rubric:: Footnotes
  1108. .. [#f1] The PyYAML library has a :func:`yaml.load` function with some of the
  1109. same security implications as pickle, but Kombu uses the
  1110. :func:`yaml.safe_load` function which is not known to be affected.
  1111. - kombu.async: Experimental event loop implementation.
  1112. This code was previously in Celery but was moved here
  1113. to make it easier for async transport implementations.
  1114. The API is meant to match the Tulip API which will be included
  1115. in Python 3.4 as the ``asyncio`` module. It's not a complete
  1116. implementation obviously, but the goal is that it will be easy
  1117. to change to it once that is possible.
  1118. - Utility function ``kombu.common.ipublish`` has been removed.
  1119. Use ``Producer(..., retry=True)`` instead.
  1120. - Utility function ``kombu.common.isend_reply`` has been removed
  1121. Use ``send_reply(..., retry=True)`` instead.
  1122. - ``kombu.common.entry_to_queue`` and ``kombu.messaging.entry_to_queue``
  1123. has been removed.
  1124. Use ``Queue.from_dict(name, **options)`` instead.
  1125. - Redis: Messages are now restored at the end of the list.
  1126. Contributed by Mark Lavin.
  1127. - ``StdConnectionError`` and ``StdChannelError`` is removed
  1128. and :exc:`amqp.ConnectionError` and :exc:`amqp.ChannelError` is used
  1129. instead.
  1130. - Message object implementation has moved to :class:`kombu.message.Message`.
  1131. - Serailization: Renamed functions encode/decode to
  1132. :func:`~kombu.serialization.dumps` and :func:`~kombu.serialization.loads`.
  1133. For backward compatibility the old names are still available as aliases.
  1134. - The ``kombu.log.anon_logger`` function has been removed.
  1135. Use :func:`~kombu.log.get_logger` instead.
  1136. - ``queue_declare`` now returns namedtuple with ``queue``, ``message_count``,
  1137. and ``consumer_count`` fields.
  1138. - LamportClock: Can now set lock class
  1139. - :mod:`kombu.utils.clock`: Utilities for ordering events added.
  1140. - :class:`~kombu.simple.SimpleQueue` now allows you to override
  1141. the exchange type used.
  1142. Contributed by Vince Gonzales.
  1143. - Zookeeper transport updated to support new changes in the :mod:`kazoo`
  1144. library.
  1145. Contributed by Mahendra M.
  1146. - pyamqp/librabbitmq: Transport options are now forwarded as keyword arguments
  1147. to the underlying connection (Issue #214).
  1148. - Transports may now distinguish between recoverable and irrecoverable
  1149. connection and channel errors.
  1150. - ``kombu.utils.Finalize`` has been removed: Use
  1151. :mod:`multiprocessing.util.Finalize` instead.
  1152. - Memory transport now supports the fanout exchange type.
  1153. Contributed by Davanum Srinivas.
  1154. - Experimental new `Pyro`_ transport (:mod:`kombu.transport.pyro`).
  1155. Contributed by Tommie McAfee.
  1156. .. _`Pyro`: http://pythonhosted.org/Pyro
  1157. - Experimental new `SoftLayer MQ`_ transport (:mod:`kombu.transport.SLMQ`).
  1158. Contributed by Kevin McDonald
  1159. .. _`SoftLayer MQ`: http://www.softlayer.com/services/additional/message-queue
  1160. - Eventio: Kqueue breaks in subtle ways so select is now used instead.
  1161. - SQLAlchemy transport: Can now specify table names using the
  1162. ``queue_tablename`` and ``message_tablename`` transport options.
  1163. Contributed by Ryan Petrello.
  1164. Redis transport: Now supports using local UNIX sockets to communicate with the
  1165. Redis server (Issue #1283)
  1166. To connect using a UNIX socket you have to use the ``redis+socket``
  1167. URL-prefix: ``redis+socket:///tmp/redis.sock``.
  1168. This functionality was merged from the `celery-redis-unixsocket`_ project.
  1169. Contributed by Maxime Rouyrre.
  1170. ZeroMQ transport: drain_events now supports timeout.
  1171. Contributed by Jesper Thomschütz.
  1172. .. _`celery-redis-unixsocket`:
  1173. https://github.com/piquadrat/celery-redis-unixsocket
  1174. .. _version-2.5.16:
  1175. 2.5.16
  1176. ======
  1177. :release-date: 2013-10-04 03:30 P.M BST
  1178. :release-by: Ask Solem
  1179. - Python 3: Fixed problem with dependencies not being installed.
  1180. .. _version-2.5.15:
  1181. 2.5.15
  1182. ======
  1183. :release-date: 2013-10-04 03:30 P.M BST
  1184. :release-by: Ask Solem
  1185. - Declaration cache: Now only keeps hash of declaration
  1186. so that it does not keep a reference to the channel.
  1187. - Declaration cache: Now respects ``entity.can_cache_declaration``
  1188. attribute.
  1189. - Fixes Python 2.5 compatibility.
  1190. - Fixes tests after python-msgpack changes.
  1191. - ``Queue.get``: Now supports ``accept`` argument.
  1192. .. _version-2.5.14:
  1193. 2.5.14
  1194. ======
  1195. :release-date: 2013-08-23 05:00 P.M BST
  1196. :release-by: Ask Solem
  1197. - safe_str did not work properly resulting in
  1198. :exc:`UnicodeDecodeError` (Issue #248).
  1199. .. _version-2.5.13:
  1200. 2.5.13
  1201. ======
  1202. :release-date: 2013-08-16 04:00 P.M BST
  1203. :release-by: Ask Solem
  1204. - Now depends on :mod:`amqp` 1.0.13
  1205. - Fixed typo in Django functional tests.
  1206. - safe_str now returns Unicode in Python 2.x
  1207. Fix contributed by Germán M. Bravo.
  1208. - amqp: Transport options are now merged with arguments
  1209. supplied to the connection.
  1210. - Tests no longer depends on distribute, which was deprecated
  1211. and merged back into setuptools.
  1212. Fix contributed by Sascha Peilicke.
  1213. - ConsumerMixin now also restarts on channel related errors.
  1214. Fix contributed by Corentin Ardeois.
  1215. .. _version-2.5.12:
  1216. 2.5.12
  1217. ======
  1218. :release-date: 2013-06-28 03:30 P.M BST
  1219. :release-by: Ask Solem
  1220. - Redis: Ignore errors about keys missing in the round-robin cycle.
  1221. - Fixed test suite errors on Python 3.
  1222. - Fixed msgpack test failures.
  1223. .. _version-2.5.11:
  1224. 2.5.11
  1225. ======
  1226. :release-date: 2013-06-25 02:30 P.M BST
  1227. :release-by: Ask Solem
  1228. - Now depends on amqp 1.0.12 (Py3 compatibility issues).
  1229. - MongoDB: Removed cause of a "database name in URI is being ignored"
  1230. warning.
  1231. Fix by Flavio Percoco Premoli
  1232. - Adds ``passive`` option to :class:`~kombu.Exchange`.
  1233. Setting this flag means that the exchange will not be declared by kombu,
  1234. but that it must exist already (or an exception will be raised).
  1235. Contributed by Rafal Malinowski
  1236. - Connection.info() now gives the current hostname and not the list of
  1237. available hostnames.
  1238. Fix contributed by John Shuping.
  1239. - pyamqp: Transport options are now forwarded as kwargs to ``amqp.Connection``.
  1240. - librabbitmq: Transport options are now forwarded as kwargs to
  1241. ``librabbitmq.Connection``.
  1242. - librabbitmq: Now raises :exc:`NotImplementedError` if SSL is enabled.
  1243. The librabbitmq library does not support ssl,
  1244. but you can use stunnel or change to the ``pyamqp://`` transport
  1245. instead.
  1246. Fix contributed by Dan LaMotte.
  1247. - librabbitmq: Fixed a cyclic reference at connection close.
  1248. - eventio: select implementation now removes bad file descriptors.
  1249. - eventio: Fixed Py3 compatibility problems.
  1250. - Functional tests added for py-amqp and librabbitmq transports.
  1251. - Resource.force_close_all no longer uses a mutex.
  1252. - Pidbox: Now ignores `IconsistencyError` when sending replies,
  1253. as this error simply means that the client may no longer be alive.
  1254. - Adds new :meth:`Connection.collect <~kombu.Connection.collect>` method,
  1255. that can be used to clean up after connections without I/O.
  1256. - ``queue_bind`` is no longer called for queues bound to
  1257. the "default exchange" (Issue #209).
  1258. Contributed by Jonathan Halcrow.
  1259. - The max_retries setting for retries was not respected correctly (off by one).
  1260. .. _version-2.5.10:
  1261. 2.5.10
  1262. ======
  1263. :release-date: 2013-04-11 06:10 P.M BST
  1264. :release-by: Ask Solem
  1265. Note about upcoming changes for Kombu 3.0
  1266. -----------------------------------------
  1267. Kombu 3 consumers will no longer accept pickle/yaml or msgpack
  1268. by default, and you will have to explicitly enable untrusted deserializers
  1269. either globally using :func:`kombu.enable_insecure_serializers`, or
  1270. using the ``accept`` argument to :class:`~kombu.Consumer`.
  1271. Changes
  1272. -------
  1273. - New utility function to disable/enable untrusted serializers.
  1274. - :func:`kombu.disable_insecure_serializers`
  1275. - :func:`kombu.enable_insecure_serializers`.
  1276. - Consumer: ``accept`` can now be used to specify a whitelist
  1277. of content types to accept.
  1278. If the accept whitelist is set and a message is received
  1279. with a content type that is not in the whitelist then a
  1280. :exc:`~kombu.exceptions.ContentDisallowed` exception
  1281. is raised. Note that this error can be handled by the already
  1282. existing `on_decode_error` callback
  1283. Examples:
  1284. .. code-block:: python
  1285. Consumer(accept=['application/json'])
  1286. Consumer(accept=['pickle', 'json'])
  1287. - Now depends on amqp 1.0.11
  1288. - pidbox: Mailbox now supports the ``accept`` argument.
  1289. - Redis: More friendly error for when keys are missing.
  1290. - Connection URLs: The parser did not work well when there were
  1291. multiple '+' tokens.
  1292. .. _version-2.5.9:
  1293. 2.5.9
  1294. =====
  1295. :release-date: 2013-04-08 05:07 P.M BST
  1296. :release-by: Ask Solem
  1297. - Pidbox: Now warns if there are multiple nodes consuming from
  1298. the same pidbox.
  1299. - Adds :attr:`Queue.on_declared <kombu.Queue.on_declared>`
  1300. A callback to be called when the queue is declared,
  1301. with signature ``(name, messages, consumers)``.
  1302. - Now uses fuzzy matching to suggest alternatives to typos in transport
  1303. names.
  1304. - SQS: Adds new transport option ``queue_prefix``.
  1305. Contributed by j0hnsmith.
  1306. - pyamqp: No longer overrides verify_connection.
  1307. - SQS: Now specifies the ``driver_type`` and ``driver_name``
  1308. attributes.
  1309. Fix contributed by Mher Movsisyan.
  1310. - Fixed bug with ``kombu.utils.retry_over_time`` when no errback
  1311. specified.
  1312. .. _version-2.5.8:
  1313. 2.5.8
  1314. =====
  1315. :release-date: 2013-03-21 04:00 P.M UTC
  1316. :release-by: Ask Solem
  1317. - Now depends on :mod:`amqp` 1.0.10 which fixes a Python 3 compatibility error.
  1318. - Redis: Fixed a possible race condition (Issue #171).
  1319. - Redis: Ack emulation/visibility_timeout can now be disabled
  1320. using a transport option.
  1321. Ack emulation adds quite a lot of overhead to ensure data is safe
  1322. even in the event of an unclean shutdown. If data loss do not worry
  1323. you there is now an `ack_emulation` transport option you can use
  1324. to disable it:
  1325. .. code-block:: python
  1326. Connection('redis://', transport_options={'ack_emulation': False})
  1327. - SQS: Fixed :mod:`boto` v2.7 compatibility (Issue #207).
  1328. - Exchange: Should not try to re-declare default exchange (``""``)
  1329. (Issue #209).
  1330. - SQS: Long polling is now disabled by default as it was not
  1331. implemented correctly, resulting in long delays between receiving
  1332. messages (Issue #202).
  1333. - Fixed Python 2.6 incompatibility depending on ``exc.errno``
  1334. being available.
  1335. Fix contributed by Ephemera.
  1336. .. _version-2.5.7:
  1337. 2.5.7
  1338. =====
  1339. :release-date: 2013-03-08 01:00 P.M UTC
  1340. :release-by: Ask Solem
  1341. - Now depends on amqp 1.0.9
  1342. - Redis: A regression in 2.5.6 caused the redis transport to
  1343. ignore options set in ``transport_options``.
  1344. - Redis: New ``socket_timeout`` transport option.
  1345. - Redis: ``InconsistencyError`` is now regarded as a recoverable error.
  1346. - Resource pools: Will no longer attempt to release resource
  1347. that was never acquired.
  1348. - MongoDB: Now supports the ``ssl`` option.
  1349. Contributed by Sebastian Pawlus.
  1350. .. _version-2.5.6:
  1351. 2.5.6
  1352. =====
  1353. :release-date: 2013-02-08 01:00 P.M UTC
  1354. :release-by: Ask Solem
  1355. - Now depends on amqp 1.0.8 which works around a bug found on some
  1356. Python 2.5 installations where 2**32 overflows to 0.
  1357. .. _version-2.5.5:
  1358. 2.5.5
  1359. =====
  1360. :release-date: 2013-02-07 05:00 P.M UTC
  1361. :release-by: Ask Solem
  1362. SQS: Now supports long polling (Issue #176).
  1363. The polling interval default has been changed to 0 and a new
  1364. transport option (``wait_time_seconds``) has been added.
  1365. This parameter specifies how long to wait for a message from
  1366. SQS, and defaults to 20 seconds, which is the maximum
  1367. value currently allowed by Amazon SQS.
  1368. Contributed by James Saryerwinnie.
  1369. - SQS: Now removes unpickleable fields before restoring messages.
  1370. - Consumer.__exit__ now ignores exceptions occurring while
  1371. canceling the consumer.
  1372. - Virtual: Routing keys can now consist of characters also used
  1373. in regular expressions (e.g. parens) (Issue #194).
  1374. - Virtual: Fixed compression header when restoring messages.
  1375. Fix contributed by Alex Koshelev.
  1376. - Virtual: ack/reject/requeue now works while using ``basic_get``.
  1377. - Virtual: Message.reject is now supported by virtual transports
  1378. (requeue depends on individual transport support).
  1379. - Fixed typo in hack used for static analyzers.
  1380. Fix contributed by Basil Mironenko.
  1381. .. _version-2.5.4:
  1382. 2.5.4
  1383. =====
  1384. :release-date: 2012-12-10 12:35 P.M UTC
  1385. :release-by: Ask Solem
  1386. - Fixed problem with connection clone and multiple URLs (Issue #182).
  1387. Fix contributed by Dane Guempel.
  1388. - zeromq: Now compatible with libzmq 3.2.x.
  1389. Fix contributed by Andrey Antukh.
  1390. - Fixed Python 3 installation problem (Issue #187).
  1391. .. _version-2.5.3:
  1392. 2.5.3
  1393. =====
  1394. :release-date: 2012-11-29 12:35 P.M UTC
  1395. :release-by: Ask Solem
  1396. - Pidbox: Fixed compatibility with Python 2.6
  1397. 2.5.2
  1398. =====
  1399. :release-date: 2012-11-29 12:35 P.M UTC
  1400. :release-by: Ask Solem
  1401. .. _version-2.5.2:
  1402. 2.5.2
  1403. =====
  1404. :release-date: 2012-11-29 12:35 P.M UTC
  1405. :release-by: Ask Solem
  1406. - [Redis] Fixed connection leak and added a new 'max_connections' transport
  1407. option.
  1408. .. _version-2.5.1:
  1409. 2.5.1
  1410. =====
  1411. :release-date: 2012-11-28 12:45 P.M UTC
  1412. :release-by: Ask Solem
  1413. - Fixed bug where return value of Queue.as_dict could not be serialized with
  1414. JSON (Issue #177).
  1415. .. _version-2.5.0:
  1416. 2.5.0
  1417. =====
  1418. :release-date: 2012-11-27 04:00 P.M UTC
  1419. :release-by: Ask Solem
  1420. - `py-amqp`_ is now the new default transport, replacing ``amqplib``.
  1421. The new `py-amqp`_ library is a fork of amqplib started with the
  1422. following goals:
  1423. - Uses AMQP 0.9.1 instead of 0.8
  1424. - Support for heartbeats (Issue #79 + Issue #131)
  1425. - Automatically revives channels on channel errors.
  1426. - Support for all RabbitMQ extensions
  1427. - Consumer Cancel Notifications (Issue #131)
  1428. - Publisher Confirms (Issue #131).
  1429. - Exchange-to-exchange bindings: ``exchange_bind`` / ``exchange_unbind``.
  1430. - API compatible with :mod:`librabbitmq` so that it can be used
  1431. as a pure-python replacement in environments where rabbitmq-c cannot
  1432. be compiled. librabbitmq will be updated to support all the same
  1433. features as py-amqp.
  1434. - Support for using multiple connection URL's for failover.
  1435. The first argument to :class:`~kombu.Connection` can now be a list of
  1436. connection URLs:
  1437. .. code-block:: python
  1438. Connection(['amqp://foo', 'amqp://bar'])
  1439. or it can be a single string argument with several URLs separated by
  1440. semicolon:
  1441. .. code-block:: python
  1442. Connection('amqp://foo;amqp://bar')
  1443. There is also a new keyword argument ``failover_strategy`` that defines
  1444. how :meth:`~kombu.Connection.ensure_connection`/
  1445. :meth:`~kombu.Connection.ensure`/:meth:`kombu.Connection.autoretry` will
  1446. reconnect in the event of connection failures.
  1447. The default reconnection strategy is ``round-robin``, which will simply
  1448. cycle through the list forever, and there's also a ``shuffle`` strategy
  1449. that will select random hosts from the list. Custom strategies can also
  1450. be used, in that case the argument must be a generator yielding the URL
  1451. to connect to.
  1452. Example:
  1453. .. code-block:: python
  1454. Connection('amqp://foo;amqp://bar')
  1455. - Now supports PyDev, PyCharm, pylint and other static code analysis tools.
  1456. - :class:`~kombu.Queue` now supports multiple bindings.
  1457. You can now have multiple bindings in the same queue by having
  1458. the second argument be a list:
  1459. .. code-block:: python
  1460. from kombu import binding, Queue
  1461. Queue('name', [
  1462. binding(Exchange('E1'), routing_key='foo'),
  1463. binding(Exchange('E1'), routing_key='bar'),
  1464. binding(Exchange('E2'), routing_key='baz'),
  1465. ])
  1466. To enable this, helper methods have been added:
  1467. - :meth:`~kombu.Queue.bind_to`
  1468. - :meth:`~kombu.Queue.unbind_from`
  1469. Contributed by Rumyana Neykova.
  1470. - Custom serializers can now be registered using Setuptools entry-points.
  1471. See :ref:`serialization-entrypoints`.
  1472. - New :class:`kombu.common.QoS` class used as a thread-safe way to manage
  1473. changes to a consumer or channels prefetch_count.
  1474. This was previously an internal class used in Celery now moved to
  1475. the :mod:`kombu.common` module.
  1476. - Consumer now supports a ``on_message`` callback that can be used to process
  1477. raw messages (not decoded).
  1478. Other callbacks specified using the ``callbacks`` argument, and
  1479. the ``receive`` method will be not be called when a on message callback
  1480. is present.
  1481. - New utility :func:`kombu.common.ignore_errors` ignores connection and
  1482. channel errors.
  1483. Must only be used for cleanup actions at shutdown or on connection loss.
  1484. - Support for exchange-to-exchange bindings.
  1485. The :class:`~kombu.Exchange` entity gained ``bind_to``
  1486. and ``unbind_from`` methods:
  1487. .. code-block:: python
  1488. e1 = Exchange('A')(connection)
  1489. e2 = Exchange('B')(connection)
  1490. e2.bind_to(e1, routing_key='rkey', arguments=None)
  1491. e2.unbind_from(e1, routing_key='rkey', arguments=None)
  1492. This is currently only supported by the ``pyamqp`` transport.
  1493. Contributed by Rumyana Neykova.
  1494. .. _version-2.4.10:
  1495. 2.4.10
  1496. ======
  1497. :release-date: 2012-11-22 06:00 P.M UTC
  1498. :release-by: Ask Solem
  1499. - The previous versions connection pool changes broke Redis support so that
  1500. it would always connect to localhost (default setting) no matter what
  1501. connection parameters were provided (Issue #176).
  1502. .. _version-2.4.9:
  1503. 2.4.9
  1504. =====
  1505. :release-date: 2012-11-21 03:00 P.M UTC
  1506. :release-by: Ask Solem
  1507. - Redis: Fixed race condition that could occur while trying to restore
  1508. messages (Issue #171).
  1509. Fix contributed by Ollie Walsh.
  1510. - Redis: Each channel is now using a specific connection pool instance,
  1511. which is disconnected on connection failure.
  1512. - ProducerPool: Fixed possible dead-lock in the acquire method.
  1513. - ProducerPool: ``force_close_all`` no longer tries to call the non-existent
  1514. ``Producer._close``.
  1515. - librabbitmq: Now implements ``transport.verify_connection`` so that
  1516. connection pools will not give back connections that are no longer working.
  1517. - New and better ``repr()`` for Queue and Exchange objects.
  1518. - Python 3: Fixed problem with running the unit test suite.
  1519. - Python 3: Fixed problem with JSON codec.
  1520. .. _version-2.4.8:
  1521. 2.4.8
  1522. =====
  1523. :release-date: 2012-11-02 05:00 P.M UTC
  1524. :release-by: Ask Solem
  1525. - Redis: Improved fair queue cycle implementation (Issue #166).
  1526. Contributed by Kevin McCarthy.
  1527. - Redis: Unacked message restore limit is now unlimited by default.
  1528. Also, the limit can now be configured using the ``unacked_restore_limit``
  1529. transport option:
  1530. .. code-block:: python
  1531. Connection('redis://', transport_options={
  1532. 'unacked_restore_limit': 100,
  1533. })
  1534. A limit of 100 means that the consumer will restore at most 100
  1535. messages at each pass.
  1536. - Redis: Now uses a mutex to ensure only one consumer restores messages at a
  1537. time.
  1538. The mutex expires after 5 minutes by default, but can be configured
  1539. using the ``unacked_mutex_expire`` transport option.
  1540. - LamportClock.adjust now returns the new clock value.
  1541. - Heartbeats can now be specified in URLs.
  1542. Fix contributed by Mher Movsisyan.
  1543. - Kombu can now be used with PyDev, PyCharm and other static analysis tools.
  1544. - Fixes problem with msgpack on Python 3 (Issue #162).
  1545. Fix contributed by Jasper Bryant-Greene
  1546. - amqplib: Fixed bug with timeouts when SSL is used in non-blocking mode.
  1547. Fix contributed by Mher Movsisyan
  1548. .. _version-2.4.7:
  1549. 2.4.7
  1550. =====
  1551. :release-date: 2012-09-18 03:00 P.M BST
  1552. :release-by: Ask Solem
  1553. - Virtual: Unknown exchanges now default to 'direct' when sending a message.
  1554. - MongoDB: Fixed memory leak when merging keys stored in the db (Issue #159)
  1555. Fix contributed by Michael Korbakov.
  1556. - MongoDB: Better index for MongoDB transport (Issue #158).
  1557. This improvement will create a new compund index for queue and _id in order
  1558. to be able to use both indexed fields for getting a new message (using
  1559. queue field) and sorting by _id. It'll be necessary to manually delete
  1560. the old index from the collection.
  1561. Improvement contributed by rmihael
  1562. .. _version-2.4.6:
  1563. 2.4.6
  1564. =====
  1565. :release-date: 2012-09-12 03:00 P.M BST
  1566. :release-by: Ask Solem
  1567. - Adds additional compatibility dependencies:
  1568. - Python <= 2.6:
  1569. - importlib
  1570. - ordereddict
  1571. - Python <= 2.5
  1572. - simplejson
  1573. .. _version-2.4.5:
  1574. 2.4.5
  1575. =====
  1576. :release-date: 2012-08-30 03:36 P.M BST
  1577. :release-by: Ask Solem
  1578. - Last version broke installtion on PyPy and Jython due
  1579. to test requirements clean-up.
  1580. .. _version-2.4.4:
  1581. 2.4.4
  1582. =====
  1583. :release-date: 2012-08-29 04:00 P.M BST
  1584. :release-by: Ask Solem
  1585. - amqplib: Fixed a bug with asynchronously reading large messages.
  1586. - pyamqp: Now requires amqp 0.9.3
  1587. - Cleaned up test requirements.
  1588. .. _version-2.4.3:
  1589. 2.4.3
  1590. =====
  1591. :release-date: 2012-08-25 10:30 P.M BST
  1592. :release-by: Ask Solem
  1593. - Fixed problem with amqp transport alias (Issue #154).
  1594. .. _version-2.4.2:
  1595. 2.4.2
  1596. =====
  1597. :release-date: 2012-08-24 05:00 P.M BST
  1598. :release-by: Ask Solem
  1599. - Having an empty transport name broke in 2.4.1.
  1600. .. _version-2.4.1:
  1601. 2.4.1
  1602. =====
  1603. :release-date: 2012-08-24 04:00 P.M BST
  1604. :release-by: Ask Solem
  1605. - Redis: Fixed race condition that could cause the consumer to crash (Issue #151)
  1606. Often leading to the error message ``"could not convert string to float"``
  1607. - Connection retry could cause an inifite loop (Issue #145).
  1608. - The ``amqp`` alias is now resolved at runtime, so that eventlet detection
  1609. works even if patching was done later.
  1610. .. _version-2.4.0:
  1611. 2.4.0
  1612. =====
  1613. :release-date: 2012-08-17 08:00 P.M BST
  1614. :release-by: Ask Solem
  1615. - New experimental :mod:`ZeroMQ <kombu.transport.zmq` transport.
  1616. Contributed by John Watson.
  1617. - Redis: Ack timed-out messages were not restored when using the eventloop.
  1618. - Now uses pickle protocol 2 by default to be cross-compatible with Python 3.
  1619. The protocol can also now be changed using the :envvar:`PICKLE_PROTOCOL`
  1620. environment variable.
  1621. - Adds ``Transport.supports_ev`` attribute.
  1622. - Pika: Queue purge was not working properly.
  1623. Fix contributed by Steeve Morin.
  1624. - Pika backend was no longer working since Kombu 2.3
  1625. Fix contributed by Steeve Morin.
  1626. .. _version-2.3.2:
  1627. 2.3.2
  1628. =====
  1629. :release-date: 2012-08-01 06:00 P.M BST
  1630. :release-by: Ask Solem
  1631. - Fixes problem with deserialization in Python 3.
  1632. .. _version-2.3.1:
  1633. 2.3.1
  1634. =====
  1635. :release-date: 2012-08-01 04:00 P.M BST
  1636. :release-by: Ask Solem
  1637. - librabbitmq: Can now handle messages that does not have a
  1638. content_encoding/content_type set (Issue #149).
  1639. Fix contributed by C Anthony Risinger.
  1640. - Beanstalk: Now uses localhost by default if the URL does not contain a host.
  1641. .. _version-2.3.0:
  1642. 2.3.0
  1643. =====
  1644. :release-date: 2012-07-24 03:50 P.M BST
  1645. :release-by: Ask Solem
  1646. - New ``pyamqp://`` transport!
  1647. The new `py-amqp`_ library is a fork of amqplib started with the
  1648. following goals:
  1649. - Uses AMQP 0.9.1 instead of 0.8
  1650. - Should support all RabbitMQ extensions
  1651. - API compatible with :mod:`librabbitmq` so that it can be used
  1652. as a pure-python replacement in environments where rabbitmq-c cannot
  1653. be compiled.
  1654. .. _`py-amqp`: https://amqp.readthedocs.io/
  1655. If you start using use py-amqp instead of amqplib you can enjoy many
  1656. advantages including:
  1657. - Heartbeat support (Issue #79 + Issue #131)
  1658. - Consumer Cancel Notifications (Issue #131)
  1659. - Publisher Confirms
  1660. amqplib has not been updated in a long while, so maintaining our own fork
  1661. ensures that we can quickly roll out new features and fixes without
  1662. resorting to monkey patching.
  1663. To use the py-amqp transport you must install the :mod:`amqp` library:
  1664. .. code-block:: console
  1665. $ pip install amqp
  1666. and change the connection URL to use the correct transport:
  1667. .. code-block:: pycon
  1668. >>> conn = Connection('pyamqp://guest:guest@localhost//')
  1669. The ``pyamqp://`` transport will be the default fallback transport
  1670. in Kombu version 3.0, when :mod:`librabbitmq` is not installed,
  1671. and librabbitmq will also be updated to support the same features.
  1672. - Connection now supports heartbeat argument.
  1673. If enabled you must make sure to manually maintain heartbeats
  1674. by calling the ``Connection.heartbeat_check`` at twice the rate
  1675. of the specified heartbeat interval.
  1676. E.g. if you have ``Connection(heartbeat=10)``,
  1677. then you must call ``Connection.heartbeat_check()`` every 5 seconds.
  1678. if the server has not sent heartbeats at a suitable rate then
  1679. the heartbeat check method must raise an error that is listed
  1680. in ``Connection.connection_errors``.
  1681. The attribute ``Connection.supports_heartbeats`` has been added
  1682. for the ability to inspect if a transport supports heartbeats
  1683. or not.
  1684. Calling ``heartbeat_check`` on a transport that does
  1685. not support heartbeats results in a noop operation.
  1686. - SQS: Fixed bug with invalid characters in queue names.
  1687. Fix contributed by Zach Smith.
  1688. - utils.reprcall: Fixed typo where kwargs argument was an empty tuple by
  1689. default, and not an empty dict.
  1690. .. _version-2.2.6:
  1691. 2.2.6
  1692. =====
  1693. :release-date: 2012-07-10 05:00 P.M BST
  1694. :release-by: Ask Solem
  1695. - Adds ``kombu.messaging.entry_to_queue`` for compat with previous versions.
  1696. .. _version-2.2.5:
  1697. 2.2.5
  1698. =====
  1699. :release-date: 2012-07-10 05:00 P.M BST
  1700. :release-by: Ask Solem
  1701. - Pidbox: Now sets queue expire at 10 seconds for reply queues.
  1702. - EventIO: Now ignores ``ValueError`` raised by epoll unregister.
  1703. - MongoDB: Fixes Issue #142
  1704. Fix by Flavio Percoco Premoli
  1705. .. _version-2.2.4:
  1706. 2.2.4
  1707. =====
  1708. :release-date: 2012-07-05 04:00 P.M BST
  1709. :release-by: Ask Solem
  1710. - Support for msgpack-python 0.2.0 (Issue #143)
  1711. The latest msgpack version no longer supports Python 2.5, so if you're
  1712. still using that you need to depend on an earlier msgpack-python version.
  1713. Fix contributed by Sebastian Insua
  1714. - :func:`~kombu.common.maybe_declare` no longer caches entities with the
  1715. ``auto_delete`` flag set.
  1716. - New experimental filesystem transport.
  1717. Contributed by Bobby Beever.
  1718. - Virtual Transports: Now support anonymous queues and exchanges.
  1719. .. _version-2.2.3:
  1720. 2.2.3
  1721. =====
  1722. :release-date: 2012-06-24 05:00 P.M BST
  1723. :release-by: Ask Solem
  1724. - ``BrokerConnection`` now renamed to ``Connection``.
  1725. The name ``Connection`` has been an alias for a very long time,
  1726. but now the rename is official in the documentation as well.
  1727. The Connection alias has been available since version 1.1.3,
  1728. and ``BrokerConnection`` will still work and is not deprecated.
  1729. - ``Connection.clone()`` now works for the sqlalchemy transport.
  1730. - :func:`kombu.common.eventloop`, :func:`kombu.utils.uuid`,
  1731. and :func:`kombu.utils.url.parse_url` can now be
  1732. imported from the :mod:`kombu` module directly.
  1733. - Pidbox transport callback ``after_reply_message_received`` now happens
  1734. in a finally block.
  1735. - Trying to use the ``librabbitmq://`` transport will now show the right
  1736. name in the :exc:`ImportError` if :mod:`librabbitmq` is not installed.
  1737. The librabbitmq falls back to the older ``pylibrabbitmq`` name for
  1738. compatibility reasons and would therefore show ``No module named
  1739. pylibrabbitmq`` instead of librabbitmq.
  1740. .. _version-2.2.2:
  1741. 2.2.2
  1742. =====
  1743. :release-date: 2012-06-22 02:30 P.M BST
  1744. :release-by: Ask Solem
  1745. - Now depends on :mod:`anyjson` 0.3.3
  1746. - Json serializer: Now passes :class:`buffer` objects directly,
  1747. since this is supported in the latest :mod:`anyjson` version.
  1748. - Fixes blocking epoll call if timeout was set to 0.
  1749. Fix contributed by John Watson.
  1750. - setup.py now takes requirements from the :file:`requirements/` directory.
  1751. - The distribution directory :file:`contrib/` is now renamed to :file:`extra/`
  1752. .. _version-2.2.1:
  1753. 2.2.1
  1754. =====
  1755. :release-date: 2012-06-21 01:00 P.M BST
  1756. :release-by: Ask Solem
  1757. - SQS: Default visibility timeout is now 30 minutes.
  1758. Since we have ack emulation the visibility timeout is
  1759. only in effect if the consumer is abrubtly terminated.
  1760. - retry argument to ``Producer.publish`` now works properly,
  1761. when the declare argument is specified.
  1762. - Json serializer: didn't handle buffer objects (Issue #135).
  1763. Fix contributed by Jens Hoffrichter.
  1764. - Virtual: Now supports passive argument to ``exchange_declare``.
  1765. - Exchange & Queue can now be bound to connections (which will use the default
  1766. channel):
  1767. .. code-block:: pycon
  1768. >>> exchange = Exchange('name')
  1769. >>> bound_exchange = exchange(connection)
  1770. >>> bound_exchange.declare()
  1771. - ``SimpleQueue`` & ``SimpleBuffer`` can now be bound to connections (which
  1772. will use the default channel).
  1773. - ``Connection.manager.get_bindings`` now works for librabbitmq and pika.
  1774. - Adds new transport info attributes:
  1775. - ``Transport.driver_type``
  1776. Type of underlying driver, e.g. "amqp", "redis", "sql".
  1777. - ``Transport.driver_name``
  1778. Name of library used e.g. "amqplib", "redis", "pymongo".
  1779. - ``Transport.driver_version()``
  1780. Version of underlying library.
  1781. .. _version-2.2.0:
  1782. 2.2.0
  1783. =====
  1784. :release-date: 2012-06-07 03:10 P.M BST
  1785. :release-by: Ask Solem
  1786. .. _v220-important:
  1787. Important Notes
  1788. ---------------
  1789. - The canonical source code repository has been moved to
  1790. http://github.com/celery/kombu
  1791. - Pidbox: Exchanges used by pidbox are no longer auto_delete.
  1792. Auto delete has been described as a misfeature,
  1793. and therefore we have disabled it.
  1794. For RabbitMQ users old exchanges used by pidbox must be removed,
  1795. these are named ``mailbox_name.pidbox``,
  1796. and ``reply.mailbox_name.pidbox``.
  1797. The following command can be used to clean up these exchanges:
  1798. .. code-block:: text
  1799. $ VHOST=/ URL=amqp:// python -c'import sys,kombu;[kombu.Connection(
  1800. sys.argv[-1]).channel().exchange_delete(x)
  1801. for x in sys.argv[1:-1]]' \
  1802. $(sudo rabbitmqctl -q list_exchanges -p "$VHOST" \
  1803. | grep \.pidbox | awk '{print $1}') "$URL"
  1804. The :envvar:`VHOST` variable must be set to the target RabbitMQ virtual host,
  1805. and the :envvar:`URL` must be the AMQP URL to the server.
  1806. - The ``amqp`` transport alias will now use :mod:`librabbitmq`
  1807. if installed.
  1808. `py-librabbitmq`_ is a fast AMQP client for Python
  1809. using the librabbitmq C library.
  1810. It can be installed by:
  1811. .. code-block:: console
  1812. $ pip install librabbitmq
  1813. It will not be used if the process is monkey patched by eventlet/gevent.
  1814. .. _`py-librabbitmq`: https://github.com/celery/librabbitmq
  1815. .. _v220-news:
  1816. News
  1817. ----
  1818. - Redis: Ack emulation improvements.
  1819. Reducing the possibility of data loss.
  1820. Acks are now implemented by storing a copy of the message when the message
  1821. is consumed. The copy is not removed until the consumer acknowledges
  1822. or rejects it.
  1823. This means that unacknowledged messages will be redelivered either
  1824. when the connection is closed, or when the visibility timeout is exceeded.
  1825. - Visibility timeout
  1826. This is a timeout for acks, so that if the consumer
  1827. does not ack the message within this time limit, the message
  1828. is redelivered to another consumer.
  1829. The timeout is set to one hour by default, but
  1830. can be changed by configuring a transport option:
  1831. >>> Connection('redis://', transport_options={
  1832. ... 'visibility_timeout': 1800, # 30 minutes
  1833. ... })
  1834. **NOTE**: Messages that have not been acked will be redelivered
  1835. if the visibility timeout is exceeded, for Celery users
  1836. this means that ETA/countdown tasks that are scheduled to execute
  1837. with a time that exceeds the visibility timeout will be executed
  1838. twice (or more). If you plan on using long ETA/countdowns you
  1839. should tweak the visibility timeout accordingly:
  1840. .. code-block:: python
  1841. BROKER_TRANSPORT_OPTIONS = {'visibility_timeout': 18000} # 5 hours
  1842. Setting a long timeout means that it will take a long time
  1843. for messages to be redelivered in the event of a power failure,
  1844. but if so happens you could temporarily set the visibility timeout lower
  1845. to flush out messages when you start up the systems again.
  1846. - Experimental `Apache ZooKeeper`_ transport
  1847. More information is in the module reference:
  1848. :mod:`kombu.transport.zookeeper`.
  1849. Contributed by Mahendra M.
  1850. .. _`Apache ZooKeeper`: http://zookeeper.apache.org/
  1851. - Redis: Priority support.
  1852. The message's ``priority`` field is now respected by the Redis
  1853. transport by having multiple lists for each named queue.
  1854. The queues are then consumed by in order of priority.
  1855. The priority field is a number in the range of 0 - 9, where
  1856. 0 is the default and highest priority.
  1857. The priority range is collapsed into four steps by default, since it is
  1858. unlikely that nine steps will yield more benefit than using four steps.
  1859. The number of steps can be configured by setting the ``priority_steps``
  1860. transport option, which must be a list of numbers in **sorted order**:
  1861. .. code-block:: pycon
  1862. >>> x = Connection('redis://', transport_options={
  1863. ... 'priority_steps': [0, 2, 4, 6, 8, 9],
  1864. ... })
  1865. Priorities implemented in this way is not as reliable as
  1866. priorities on the server side, which is why
  1867. nickname the feature "quasi-priorities";
  1868. **Using routing is still the suggested way of ensuring
  1869. quality of service**, as client implemented priorities
  1870. fall short in a number of ways, e.g. if the worker
  1871. is busy with long running tasks, has prefetched many messages,
  1872. or the queues are congested.
  1873. Still, it is possible that using priorities in combination
  1874. with routing can be more beneficial than using routing
  1875. or priorities alone. Experimentation and monitoring
  1876. should be used to prove this.
  1877. Contributed by Germán M. Bravo.
  1878. - Redis: Now cycles queues so that consuming is fair.
  1879. This ensures that a very busy queue won't block messages
  1880. from other queues, and ensures that all queues have
  1881. an equal chance of being consumed from.
  1882. This used to be the case before, but the behavior was
  1883. accidentally changed while switching to using blocking pop.
  1884. - Redis: Auto delete queues that are bound to fanout exchanges
  1885. is now deleted at channel.close.
  1886. - amqplib: Refactored the drain_events implementation.
  1887. - Pidbox: Now uses ``connection.default_channel``.
  1888. - Pickle serialization: Can now decode buffer objects.
  1889. - Exchange/Queue declarations can now be cached even if
  1890. the entity is non-durable.
  1891. This is possible because the list of cached declarations
  1892. are now kept with the connection, so that the entities
  1893. will be redeclared if the connection is lost.
  1894. - Kombu source code now only uses one-level of explicit relative imports.
  1895. .. _v220-fixes:
  1896. Fixes
  1897. -----
  1898. - eventio: Now ignores ENOENT raised by ``epoll.register``, and
  1899. EEXIST from ``epoll.unregister``.
  1900. - eventio: kqueue now ignores :exc:`KeyError` on unregister.
  1901. - Redis: ``Message.reject`` now supports the ``requeue`` argument.
  1902. - Redis: Remove superfluous pipeline call.
  1903. Fix contributed by Thomas Johansson.
  1904. - Redis: Now sets redelivered header for redelivered messages.
  1905. - Now always makes sure references to :func:`sys.exc_info` is removed.
  1906. - Virtual: The compression header is now removed before restoring messages.
  1907. - More tests for the SQLAlchemy backend.
  1908. Contributed by Franck Cuny.
  1909. - Url parsing did not handle MongoDB URLs properly.
  1910. Fix contributed by Flavio Percoco Premoli.
  1911. - Beanstalk: Ignore default tube when reserving.
  1912. Fix contributed by Zhao Xiaohong.
  1913. Nonblocking consume support
  1914. ---------------------------
  1915. librabbitmq, amqplib and redis transports can now be used
  1916. non-blocking.
  1917. The interface is very manual, and only consuming messages
  1918. is non-blocking so far.
  1919. The API should not be regarded as stable or final
  1920. in any way. It is used by Celery which has very limited
  1921. needs at this point. Hopefully we can introduce a proper
  1922. callback-based API later.
  1923. - ``Transport.eventmap``
  1924. Is a map of ``fd -> callback(fileno, event)``
  1925. to register in an eventloop.
  1926. - ``Transport.on_poll_start()``
  1927. Is called before every call to poll.
  1928. The poller must support ``register(fd, callback)``
  1929. and ``unregister(fd)`` methods.
  1930. - ``Transport.on_poll_start(poller)``
  1931. Called when the hub is initialized.
  1932. The poller argument must support the same
  1933. interface as :class:`kombu.utils.eventio.poll`.
  1934. - ``Connection.ensure_connection`` now takes a callback
  1935. argument which is called for every loop while
  1936. the connection is down.
  1937. - Adds ``connection.drain_nowait``
  1938. This is a non-blocking alternative to drain_events,
  1939. but only supported by amqplib/librabbitmq.
  1940. - drain_events now sets ``connection.more_to_read`` if
  1941. there is more data to read.
  1942. This is to support eventloops where other things
  1943. must be handled between draining events.
  1944. .. _version-2.1.8:
  1945. 2.1.8
  1946. =====
  1947. :release-date: 2012-05-06 03:06 P.M BST
  1948. :release-by: Ask Solem
  1949. * Bound Exchange/Queue's are now pickleable.
  1950. * Consumer/Producer can now be instantiated without a channel,
  1951. and only later bound using ``.revive(channel)``.
  1952. * ProducerPool now takes ``Producer`` argument.
  1953. * :func:`~kombu.utils.fxrange` now counts forever if the
  1954. stop argument is set to None.
  1955. (fxrange is like xrange but for decimals).
  1956. * Auto delete support for virtual transports were incomplete
  1957. and could lead to problems so it was removed.
  1958. * Cached declarations (:func:`~kombu.common.maybe_declare`)
  1959. are now bound to the underlying connection, so that
  1960. entities are redeclared if the connection is lost.
  1961. This also means that previously uncacheable entities
  1962. (e.g. non-durable) can now be cached.
  1963. * compat ConsumerSet: can now specify channel.
  1964. .. _version-2.1.7:
  1965. 2.1.7
  1966. =====
  1967. :release-date: 2012-04-27 06:00 P.M BST
  1968. :release-by: Ask Solem
  1969. * compat consumerset now accepts optional channel argument.
  1970. .. _version-2.1.6:
  1971. 2.1.6
  1972. =====
  1973. :release-date: 2012-04-23 01:30 P.M BST
  1974. :release-by: Ask Solem
  1975. * SQLAlchemy transport was not working correctly after URL parser change.
  1976. * maybe_declare now stores cached declarations per underlying connection
  1977. instead of globally, in the rare case that data disappears from the
  1978. broker after connection loss.
  1979. * Django: Added South migrations.
  1980. Contributed by Joseph Crosland.
  1981. .. _version-2.1.5:
  1982. 2.1.5
  1983. =====
  1984. :release-date: 2012-04-13 03:30 P.M BST
  1985. :release-by: Ask Solem
  1986. * The url parser removed more than the first leading slash (Issue #121).
  1987. * SQLAlchemy: Can now specify url using + separator
  1988. Example:
  1989. .. code-block:: python
  1990. Connection('sqla+mysql://localhost/db')
  1991. * Better support for anonymous queues (Issue #116).
  1992. Contributed by Michael Barrett.
  1993. * ``Connection.as_uri`` now quotes url parts (Issue #117).
  1994. * Beanstalk: Can now set message TTR as a message property.
  1995. Contributed by Andrii Kostenko
  1996. .. _version-2.1.4:
  1997. 2.1.4
  1998. =====
  1999. :release-date: 2012-04-03 04:00 P.M GMT
  2000. :release-by: Ask Solem
  2001. * MongoDB: URL parsing are now delegated to the pymongo library
  2002. (Fixes Issue #103 and Issue #87).
  2003. Fix contributed by Flavio Percoco Premoli and James Sullivan
  2004. * SQS: A bug caused SimpleDB to be used even if sdb persistence
  2005. was not enabled (Issue #108).
  2006. Fix contributed by Anand Kumria.
  2007. * Django: Transaction was committed in the wrong place, causing
  2008. data cleanup to fail (Issue #115).
  2009. Fix contributed by Daisuke Fujiwara.
  2010. * MongoDB: Now supports replica set URLs.
  2011. Contributed by Flavio Percoco Premoli.
  2012. * Redis: Now raises a channel error if a queue key that is currently
  2013. being consumed from disappears.
  2014. Fix contributed by Stephan Jaekel.
  2015. * All transport 'channel_errors' lists now includes
  2016. ``kombu.exception.StdChannelError``.
  2017. * All kombu exceptions now inherit from a common
  2018. :exc:`~kombu.exceptions.KombuError`.
  2019. .. _version-2.1.3:
  2020. 2.1.3
  2021. =====
  2022. :release-date: 2012-03-20 03:00 P.M GMT
  2023. :release-by: Ask Solem
  2024. * Fixes Jython compatibility issues.
  2025. * Fixes Python 2.5 compatibility issues.
  2026. .. _version-2.1.2:
  2027. 2.1.2
  2028. =====
  2029. :release-date: 2012-03-01 01:00 P.M GMT
  2030. :release-by: Ask Solem
  2031. * amqplib: Last version broke SSL support.
  2032. .. _version-2.1.1:
  2033. 2.1.1
  2034. =====
  2035. :release-date: 2012-02-24 02:00 P.M GMT
  2036. :release-by: Ask Solem
  2037. * Connection URLs now supports encoded characters.
  2038. * Fixed a case where connection pool could not recover from connection loss.
  2039. Fix contributed by Florian Munz.
  2040. * We now patch amqplib's ``__del__`` method to skip trying to close the socket
  2041. if it is not connected, as this resulted in an annoying warning.
  2042. * Compression can now be used with binary message payloads.
  2043. Fix contributed by Steeve Morin.
  2044. .. _version-2.1.0:
  2045. 2.1.0
  2046. =====
  2047. :release-date: 2012-02-04 10:38 P.M GMT
  2048. :release-by: Ask Solem
  2049. * MongoDB: Now supports fanout (broadcast) (Issue #98).
  2050. Contributed by Scott Lyons.
  2051. * amqplib: Now detects broken connections by using ``MSG_PEEK``.
  2052. * pylibrabbitmq: Now supports ``basic_get`` (Issue #97).
  2053. * gevent: Now always uses the ``select`` polling backend.
  2054. * pika transport: Now works with pika 0.9.5 and 0.9.6dev.
  2055. The old pika transport (supporting 0.5.x) is now available
  2056. as alias ``oldpika``.
  2057. (Note terribly latency has been experienced with the new pika
  2058. versions, so this is still an experimental transport).
  2059. * Virtual transports: can now set polling interval via the
  2060. transport options (Issue #96).
  2061. Example:
  2062. .. code-block:: pycon
  2063. >>> Connection('sqs://', transport_options={
  2064. ... 'polling_interval': 5.0})
  2065. The default interval is transport specific, but usually
  2066. 1.0s (or 5.0s for the Django database transport, which
  2067. can also be set using the ``KOMBU_POLLING_INTERVAL`` setting).
  2068. * Adds convenience function: :func:`kombu.common.eventloop`.
  2069. .. _version-2.0.0:
  2070. 2.0.0
  2071. =====
  2072. :release-date: 2012-01-15 06:34 P.M GMT
  2073. :release-by: Ask Solem
  2074. .. _v200-important:
  2075. Important Notes
  2076. ---------------
  2077. .. _v200-python-compatibility:
  2078. Python Compatibility
  2079. ~~~~~~~~~~~~~~~~~~~~
  2080. * No longer supports Python 2.4.
  2081. Users of Python 2.4 can still use the 1.x series.
  2082. The 1.x series has entered bugfix-only maintenance mode, and will
  2083. stay that way as long as there is demand, and a willingness to
  2084. maintain it.
  2085. .. _v200-new-transports:
  2086. New Transports
  2087. ~~~~~~~~~~~~~~
  2088. * ``django-kombu`` is now part of Kombu core.
  2089. The Django message transport uses the Django ORM to store messages.
  2090. It uses polling, with a default polling interval of 5 seconds.
  2091. The polling interval can be increased or decreased by configuring the
  2092. ``KOMBU_POLLING_INTERVAL`` Django setting, which is the polling
  2093. interval in seconds as an int or a float. Note that shorter polling
  2094. intervals can cause extreme strain on the database: if responsiveness
  2095. is needed you shall consider switching to a non-polling transport.
  2096. To use it you must use transport alias ``"django"``,
  2097. or as a URL:
  2098. .. code-block:: text
  2099. django://
  2100. and then add ``kombu.transport.django`` to ``INSTALLED_APPS``, and
  2101. run ``manage.py syncdb`` to create the necessary database tables.
  2102. **Upgrading**
  2103. If you have previously used ``django-kombu``, then the entry
  2104. in ``INSTALLED_APPS`` must be changed from ``djkombu``
  2105. to ``kombu.transport.django``:
  2106. .. code-block:: python
  2107. INSTALLED_APPS = (
  2108. # …,
  2109. 'kombu.transport.django',
  2110. )
  2111. If you have previously used django-kombu, then there is no need
  2112. to recreate the tables, as the old tables will be fully compatible
  2113. with the new version.
  2114. * ``kombu-sqlalchemy`` is now part of Kombu core.
  2115. This change requires no code changes given that the
  2116. ``sqlalchemy`` transport alias is used.
  2117. .. _v200-news:
  2118. News
  2119. ----
  2120. * :class:`kombu.mixins.ConsumerMixin` is a mixin class that lets you
  2121. easily write consumer programs and threads.
  2122. See :ref:`examples` and :ref:`guide-consumers`.
  2123. * SQS Transport: Added support for SQS queue prefixes (Issue #84).
  2124. The queue prefix can be set using the transport option
  2125. ``queue_name_prefix``:
  2126. .. code-block:: python
  2127. BrokerTransport('SQS://', transport_options={
  2128. 'queue_name_prefix': 'myapp'})
  2129. Contributed by Nitzan Miron.
  2130. * ``Producer.publish`` now supports automatic retry.
  2131. Retry is enabled by the ``reply`` argument, and retry options
  2132. set by the ``retry_policy`` argument:
  2133. .. code-block:: python
  2134. exchange = Exchange('foo')
  2135. producer.publish(message, exchange=exchange, retry=True,
  2136. declare=[exchange], retry_policy={
  2137. 'interval_start': 1.0})
  2138. See :meth:`~kombu.Connection.ensure`
  2139. for a list of supported retry policy options.
  2140. * ``Producer.publish`` now supports a ``declare`` keyword argument.
  2141. This is a list of entities (:class:`Exchange`, or :class:`Queue`)
  2142. that should be declared before the message is published.
  2143. .. _v200-fixes:
  2144. Fixes
  2145. -----
  2146. * Redis transport: Timeout was multiplied by 1000 seconds when using
  2147. ``select`` for event I/O (Issue #86).
  2148. .. _version-1.5.1:
  2149. 1.5.1
  2150. =====
  2151. :release-date: 2011-11-30 01:00 P.M GMT
  2152. :release-by: Ask Solem
  2153. * Fixes issue with ``kombu.compat`` introduced in 1.5.0 (Issue #83).
  2154. * Adds the ability to disable content_types in the serializer registry.
  2155. Any message with a content type that is disabled will be refused.
  2156. One example would be to disable the Pickle serializer:
  2157. >>> from kombu.serialization import registry
  2158. # by name
  2159. >>> registry.disable('pickle')
  2160. # or by mime-type.
  2161. >>> registry.disable('application/x-python-serialize')
  2162. .. _version-1.5.0:
  2163. 1.5.0
  2164. =====
  2165. :release-date: 2011-11-27 06:00 P.M GMT
  2166. :release-by: Ask Solem
  2167. * kombu.pools: Fixed a bug resulting in resources not being properly released.
  2168. This was caused by the use of ``__hash__`` to distinguish them.
  2169. * Virtual transports: Dead-letter queue is now disabled by default.
  2170. The dead-letter queue was enabled by default to help application
  2171. authors, but now that Kombu is stable it should be removed.
  2172. There are after all many cases where messages should just be dropped
  2173. when there are no queues to buffer them, and keeping them without
  2174. supporting automatic cleanup is rather considered a resource leak
  2175. than a feature.
  2176. If wanted the dead-letter queue can still be enabled, by using
  2177. the ``deadletter_queue`` transport option:
  2178. .. code-block:: pycon
  2179. >>> x = Connection('redis://',
  2180. ... transport_options={'deadletter_queue': 'ae.undeliver'})
  2181. In addition, an :class:`UndeliverableWarning` is now emitted when
  2182. the dead-letter queue is enabled and a message ends up there.
  2183. Contributed by Ionel Maries Cristian.
  2184. * MongoDB transport now supports Replicasets (Issue #81).
  2185. Contributed by Ivan Metzlar.
  2186. * The ``Connection.ensure`` methods now accepts a ``max_retries`` value
  2187. of 0.
  2188. A value of 0 now means *do not retry*, which is distinct from :const:`None`
  2189. which means *retry indefinitely*.
  2190. Contributed by Dan McGee.
  2191. * SQS Transport: Now has a lowercase ``sqs`` alias, so that it can be
  2192. used with broker URLs (Issue #82).
  2193. Fix contributed by Hong Minhee
  2194. * SQS Transport: Fixes KeyError on message acknowledgments (Issue #73).
  2195. The SQS transport now uses UUID's for delivery tags, rather than
  2196. a counter.
  2197. Fix contributed by Brian Bernstein.
  2198. * SQS Transport: Unicode related fixes (Issue #82).
  2199. Fix contributed by Hong Minhee.
  2200. * Redis version check could crash because of improper handling of types
  2201. (Issue #63).
  2202. * Fixed error with `Resource.force_close_all` when resources
  2203. were not yet properly initialized (Issue #78).
  2204. .. _version-1.4.3:
  2205. 1.4.3
  2206. =====
  2207. :release-date: 2011-10-27 10:00 P.M BST
  2208. :release-by: Ask Solem
  2209. * Fixes bug in ProducerPool where too many resources would be acquired.
  2210. .. _version-1.4.2:
  2211. 1.4.2
  2212. =====
  2213. :release-date: 2011-10-26 05:00 P.M BST
  2214. :release-by: Ask Solem
  2215. * Eventio: Polling should ignore `errno.EINTR`
  2216. * SQS: str.encode did only start accepting kwargs after Py2.7.
  2217. * simple_task_queue example didn't run correctly (Issue #72).
  2218. Fix contributed by Stefan Eletzhofer.
  2219. * Empty messages would not raise an exception not able to be handled
  2220. by `on_decode_error` (Issue #72)
  2221. Fix contributed by Christophe Chauvet.
  2222. * CouchDB: Properly authenticate if user/password set (Issue #70)
  2223. Fix contributed by Rafael Duran Castaneda
  2224. * Connection.Consumer had the wrong signature.
  2225. Fix contributed by Pavel Skvazh
  2226. .. _version-1.4.1:
  2227. 1.4.1
  2228. =====
  2229. :release-date: 2011-09-26 04:00 P.M BST
  2230. :release-by: Ask Solem
  2231. * 1.4.0 broke the producer pool, resulting in new connections being
  2232. established for every acquire.
  2233. .. _version-1.4.0:
  2234. 1.4.0
  2235. =====
  2236. :release-date: 2011-09-22 05:00 P.M BST
  2237. :release-by: Ask Solem
  2238. * Adds module :mod:`kombu.mixins`.
  2239. This module contains a :class:`~kombu.mixins.ConsumerMixin` class
  2240. that can be used to easily implement a message consumer
  2241. thread that consumes messages from one or more
  2242. :class:`kombu.Consumer` instances.
  2243. * New example: :ref:`task-queue-example`
  2244. Using the ``ConsumerMixin``, default channels and
  2245. the global connection pool to demonstrate new Kombu features.
  2246. * MongoDB transport did not work with MongoDB >= 2.0 (Issue #66)
  2247. Fix contributed by James Turk.
  2248. * Redis-py version check did not account for beta identifiers
  2249. in version string.
  2250. Fix contributed by David Ziegler.
  2251. * Producer and Consumer now accepts a connection instance as the
  2252. first argument.
  2253. The connections default channel will then be used.
  2254. In addition shortcut methods has been added to Connection:
  2255. .. code-block:: pycon
  2256. >>> connection.Producer(exchange)
  2257. >>> connection.Consumer(queues=..., callbacks=...)
  2258. * Connection has aquired a ``connected`` attribute that
  2259. can be used to check if the connection instance has established
  2260. a connection.
  2261. * ``ConnectionPool.acquire_channel`` now returns the connections
  2262. default channel rather than establising a new channel that
  2263. must be manually handled.
  2264. * Added ``kombu.common.maybe_declare``
  2265. ``maybe_declare(entity)`` declares an entity if it has
  2266. not previously been declared in the same process.
  2267. * :func:`kombu.compat.entry_to_queue` has been moved to :mod:`kombu.common`
  2268. * New module :mod:`kombu.clocks` now contains an implementation
  2269. of Lamports logical clock.
  2270. .. _version-1.3.5:
  2271. 1.3.5
  2272. =====
  2273. :release-date: 2011-09-16 06:00 P.M BST
  2274. :release-by: Ask Solem
  2275. * Python 3: AMQP_PROTOCOL_HEADER must be bytes, not str.
  2276. .. _version-1.3.4:
  2277. 1.3.4
  2278. =====
  2279. :release-date: 2011-09-16 06:00 P.M BST
  2280. :release-by: Ask Solem
  2281. * Fixes syntax error in pools.reset
  2282. .. _version-1.3.3:
  2283. 1.3.3
  2284. =====
  2285. :release-date: 2011-09-15 02:00 P.M BST
  2286. :release-by: Ask Solem
  2287. * pools.reset did not support after forker arguments.
  2288. .. _version-1.3.2:
  2289. 1.3.2
  2290. =====
  2291. :release-date: 2011-09-10 01:00 P.M BST
  2292. :release-by: Mher Movsisyan
  2293. * Broke Python 2.5 compatibility by importing ``parse_qsl`` from ``urlparse``
  2294. * Connection.default_channel is now closed when connection is revived
  2295. after connection failures.
  2296. * Pika: Channel now supports the ``connection.client`` attribute
  2297. as required by the simple interface.
  2298. * pools.set_limit now raises an exception if the limit is lower
  2299. than the previous limit.
  2300. * pools.set_limit no longer resets the pools.
  2301. .. _version-1.3.1:
  2302. 1.3.1
  2303. =====
  2304. :release-date: 2011-10-07 03:00 P.M BST
  2305. :release-by: Ask Solem
  2306. * Last release broke after fork for pool reinitialization.
  2307. * Producer/Consumer now has a ``connection`` attribute,
  2308. giving access to the :class:`Connection` of the
  2309. instance.
  2310. * Pika: Channels now have access to the underlying
  2311. :class:`Connection` instance using ``channel.connection.client``.
  2312. This was previously required by the ``Simple`` classes and is now
  2313. also required by :class:`Consumer` and :class:`Producer`.
  2314. * Connection.default_channel is now closed at object revival.
  2315. * Adds kombu.clocks.LamportClock.
  2316. * compat.entry_to_queue has been moved to new module :mod:`kombu.common`.
  2317. .. _version-1.3.0:
  2318. 1.3.0
  2319. =====
  2320. :release-date: 2011-10-05 01:00 P.M BST
  2321. :release-by: Ask Solem
  2322. * Broker connection info can be now be specified using URLs
  2323. The broker hostname can now be given as a URL instead, of the format:
  2324. .. code-block:: text
  2325. transport://user:password@hostname:port/virtual_host
  2326. for example the default broker is expressed as:
  2327. .. code-block:: pycon
  2328. >>> Connection('amqp://guest:guest@localhost:5672//')
  2329. Transport defaults to amqp, and is not required.
  2330. user, password, port and virtual_host is also not mandatory and
  2331. will default to the corresponding transports default.
  2332. .. note::
  2333. Note that the path component (virtual_host) always starts with a
  2334. forward-slash. This is necessary to distinguish between the virtual
  2335. host '' (empty) and '/', which are both acceptable virtual host names.
  2336. A virtual host of '/' becomes::
  2337. .. code-block:: text
  2338. amqp://guest:guest@localhost:5672//
  2339. and a virtual host of '' (empty) becomes:
  2340. .. code-block:: text
  2341. amqp://guest:guest@localhost:5672/
  2342. So the leading slash in the path component is **always required**.
  2343. * Now comes with default global connection and producer pools.
  2344. The acquire a connection using the connection parameters
  2345. from a :class:`Connection`:
  2346. .. code-block:: pycon
  2347. >>> from kombu import Connection, connections
  2348. >>> connection = Connection('amqp://guest:guest@localhost//')
  2349. >>> with connections[connection].acquire(block=True):
  2350. ... # do something with connection
  2351. To acquire a producer using the connection parameters
  2352. from a :class:`Connection`:
  2353. .. code-block:: pycon
  2354. >>> from kombu import Connection, producers
  2355. >>> connection = Connection('amqp://guest:guest@localhost//')
  2356. >>> with producers[connection].acquire(block=True):
  2357. ... producer.publish({'hello': 'world'}, exchange='hello')
  2358. Acquiring a producer will in turn also acquire a connection
  2359. from the associated pool in ``connections``, so you the number
  2360. of producers is bound the same limit as number of connections.
  2361. The default limit of 100 connections per connection instance
  2362. can be changed by doing:
  2363. .. code-block:: pycon
  2364. >>> from kombu import pools
  2365. >>> pools.set_limit(10)
  2366. The pool can also be forcefully closed by doing:
  2367. .. code-block:: pycon
  2368. >>> from kombu import pools
  2369. >>> pool.reset()
  2370. * SQS Transport: Persistence using SimpleDB is now disabled by default,
  2371. after reports of unstable SimpleDB connections leading to errors.
  2372. * :class:`Producer` can now be used as a context manager.
  2373. * ``Producer.__exit__`` now properly calls ``release`` instead of close.
  2374. The previous behavior would lead to a memory leak when using
  2375. the :class:`kombu.pools.ProducerPool`
  2376. * Now silences all exceptions from `import ctypes` to match behaviour
  2377. of the standard Python uuid module, and avoid passing on MemoryError
  2378. exceptions on SELinux-enabled systems (Issue #52 + Issue #53)
  2379. * ``amqp`` is now an alias to the ``amqplib`` transport.
  2380. * ``kombu.syn.detect_environment`` now returns 'default', 'eventlet', or
  2381. 'gevent' depending on what monkey patches have been installed.
  2382. * Serialization registry has new attribute ``type_to_name`` so it is
  2383. possible to lookup serializater name by content type.
  2384. * Exchange argument to ``Producer.publish`` can now be an :class:`Exchange`
  2385. instance.
  2386. * ``compat.Publisher`` now supports the ``channel`` keyword argument.
  2387. * Acking a message on some transports could lead to :exc:`KeyError` being
  2388. raised (Issue #57).
  2389. * Connection pool: Connections are no long instantiated when the pool is
  2390. created, but instantiated as needed instead.
  2391. * Tests now pass on PyPy.
  2392. * ``Connection.as_uri`` now includes the password if the keyword argument
  2393. ``include_password`` is set.
  2394. * Virtual transports now comes with a default ``default_connection_params``
  2395. attribute.
  2396. .. _version-1.2.1:
  2397. 1.2.1
  2398. =====
  2399. :release-date: 2011-07-29 12:52 P.M BST
  2400. :release-by: Ask Solem
  2401. * Now depends on amqplib >= 1.0.0.
  2402. * Redis: Now automatically deletes auto_delete queues at ``basic_cancel``.
  2403. * ``serialization.unregister`` added so it is possible to remove unwanted
  2404. seralizers.
  2405. * Fixes MemoryError while importing ctypes on SELinux (Issue #52).
  2406. * ``Connection.autoretry`` is a version of ``ensure`` that works
  2407. with arbitrary functions (i.e. it does not need an associated object
  2408. that implements the ``revive`` method.
  2409. Example usage:
  2410. .. code-block:: python
  2411. channel = connection.channel()
  2412. try:
  2413. ret, channel = connection.autoretry(send_messages, channel=channel)
  2414. finally:
  2415. channel.close()
  2416. * ``ConnectionPool.acquire`` no longer force establishes the connection.
  2417. The connection will be established as needed.
  2418. * ``Connection.ensure`` now supports an ``on_revive`` callback
  2419. that is applied whenever the connection is re-established.
  2420. * ``Consumer.consuming_from(queue)`` returns True if the Consumer is
  2421. consuming from ``queue``.
  2422. * ``Consumer.cancel_by_queue`` did not remove the queue from ``queues``.
  2423. * ``compat.ConsumerSet.add_queue_from_dict`` now automatically declared
  2424. the queue if ``auto_declare`` set.
  2425. .. _version-1.2.0:
  2426. 1.2.0
  2427. =====
  2428. :release-date: 2011-07-15 12:00 P.M BST
  2429. :release-by: Ask Solem
  2430. * Virtual: Fixes cyclic reference in Channel.close (Issue #49).
  2431. * Producer.publish: Can now set additional properties using keyword
  2432. arguments (Issue #48).
  2433. * Adds Queue.no_ack option to control the no_ack option for individual queues.
  2434. * Recent versions broke pylibrabbitmq support.
  2435. * SimpleQueue and SimpleBuffer can now be used as contexts.
  2436. * Test requirements specifies PyYAML==3.09 as 3.10 dropped Python 2.4 support
  2437. * Now properly reports default values in Connection.info/.as_uri
  2438. .. _version-1.1.6:
  2439. 1.1.6
  2440. =====
  2441. :release-date: 2011-06-13 04:00 P.M BST
  2442. :release-by: Ask Solem
  2443. * Redis: Fixes issue introduced in 1.1.4, where a redis connection
  2444. failure could leave consumer hanging forever.
  2445. * SQS: Now supports fanout messaging by using SimpleDB to store routing
  2446. tables.
  2447. This can be disabled by setting the `supports_fanout` transport option:
  2448. >>> Connection(transport='SQS',
  2449. ... transport_options={'supports_fanout': False})
  2450. * SQS: Now properly deletes a message when a message is acked.
  2451. * SQS: Can now set the Amazon AWS region, by using the ``region``
  2452. transport option.
  2453. * amqplib: Now uses `localhost` as default hostname instead of raising an
  2454. error.
  2455. .. _version-1.1.5:
  2456. 1.1.5
  2457. =====
  2458. :release-date: 2011-06-07 06:00 P.M BST
  2459. :release-by: Ask Solem
  2460. * Fixes compatibility with redis-py 2.4.4.
  2461. .. _version-1.1.4:
  2462. 1.1.4
  2463. =====
  2464. :release-date: 2011-06-07 04:00 P.M BST
  2465. :release-by: Ask Solem
  2466. * Redis transport: Now requires redis-py version 2.4.4 or later.
  2467. * New Amazon SQS transport added.
  2468. Usage:
  2469. >>> conn = Connection(transport='SQS',
  2470. ... userid=aws_access_key_id,
  2471. ... password=aws_secret_access_key)
  2472. The environment variables :envvar:`AWS_ACCESS_KEY_ID` and
  2473. :envvar:`AWS_SECRET_ACCESS_KEY` are also supported.
  2474. * librabbitmq transport: Fixes default credentials support.
  2475. * amqplib transport: Now supports `login_method` for SSL auth.
  2476. :class:`Connection` now supports the `login_method`
  2477. keyword argument.
  2478. Default `login_method` is ``AMQPLAIN``.
  2479. .. _version-1.1.3:
  2480. 1.1.3
  2481. =====
  2482. :release-date: 2011-04-21 04:00 P.M CEST
  2483. :release-by: Ask Solem
  2484. * Redis: Consuming from multiple connections now works with Eventlet.
  2485. * Redis: Can now perform channel operations while the channel is in
  2486. BRPOP/LISTEN mode (Issue #35).
  2487. Also the async BRPOP now times out after 1 second, this means that
  2488. canceling consuming from a queue/starting consuming from additional queues
  2489. has a latency of up to one second (BRPOP does not support subsecond
  2490. timeouts).
  2491. * Virtual: Allow channel objects to be closed multiple times without error.
  2492. * amqplib: ``AttributeError`` has been added to the list of known
  2493. connection related errors (:attr:`Connection.connection_errors`).
  2494. * amqplib: Now converts :exc:`SSLError` timeout errors to
  2495. :exc:`socket.timeout` (http://bugs.python.org/issue10272)
  2496. * Ensures cyclic references are destroyed when the connection is closed.
  2497. .. _version-1.1.2:
  2498. 1.1.2
  2499. =====
  2500. :release-date: 2011-04-06 04:00 P.M CEST
  2501. :release-by: Ask Solem
  2502. * Redis: Fixes serious issue where messages could be lost.
  2503. The issue could happen if the message exceeded a certain number
  2504. of kilobytes in size.
  2505. It is recommended that all users of the Redis transport should
  2506. upgrade to this version, even if not currently experiencing any
  2507. issues.
  2508. .. _version-1.1.1:
  2509. 1.1.1
  2510. =====
  2511. :release-date: 2011-04-05 03:51 P.M CEST
  2512. :release-by: Ask Solem
  2513. * 1.1.0 started using ``Queue.LifoQueue`` which is only available
  2514. in Python 2.6+ (Issue #33). We now ship with our own LifoQueue.
  2515. .. _version-1.1.0:
  2516. 1.1.0
  2517. =====
  2518. :release-date: 2011-04-05 01:05 P.M CEST
  2519. :release-by: Ask Solem
  2520. .. _v110-important:
  2521. Important Notes
  2522. ---------------
  2523. * Virtual transports: Message body is now base64 encoded by default
  2524. (Issue #27).
  2525. This should solve problems sending binary data with virtual
  2526. transports.
  2527. Message compatibility is handled by adding a ``body_encoding``
  2528. property, so messages sent by older versions is compatible
  2529. with this release. However -- If you are accessing the messages
  2530. directly not using Kombu, then you have to respect
  2531. the ``body_encoding`` property.
  2532. If you need to disable base64 encoding then you can do so
  2533. via the transport options:
  2534. .. code-block:: python
  2535. Connection(transport='...',
  2536. transport_options={'body_encoding': None})
  2537. **For transport authors**:
  2538. You don't have to change anything in your custom transports,
  2539. as this is handled automatically by the base class.
  2540. If you want to use a different encoder you can do so by adding
  2541. a key to ``Channel.codecs``. Default encoding is specified
  2542. by the ``Channel.body_encoding`` attribute.
  2543. A new codec must provide two methods: ``encode(data)`` and
  2544. ``decode(data)``.
  2545. * ConnectionPool/ChannelPool/Resource: Setting ``limit=None`` (or 0)
  2546. now disables pool semantics, and will establish and close
  2547. the resource whenever acquired or released.
  2548. * ConnectionPool/ChannelPool/Resource: Is now using a LIFO queue
  2549. instead of the previous FIFO behavior.
  2550. This means that the last resource released will be the one
  2551. acquired next. I.e. if only a single thread is using the pool
  2552. this means only a single connection will ever be used.
  2553. * Connection: Cloned connections did not inherit transport_options
  2554. (``__copy__``).
  2555. * contrib/requirements is now located in the top directory
  2556. of the distribution.
  2557. * MongoDB: Now supports authentication using the ``userid`` and ``password``
  2558. arguments to :class:`Connection` (Issue #30).
  2559. * Connection: Default autentication credentials are now delegated to
  2560. the individual transports.
  2561. This means that the ``userid`` and ``password`` arguments to
  2562. Connection is no longer *guest/guest* by default.
  2563. The amqplib and pika transports will still have the default
  2564. credentials.
  2565. * :meth:`Consumer.__exit__` did not have the correct signature (Issue #32).
  2566. * Channel objects now have a ``channel_id`` attribute.
  2567. * MongoDB: Version sniffing broke with development versions of
  2568. mongod (Issue #29).
  2569. * New environment variable :envvar:`KOMBU_LOG_CONNECTION` will now emit debug
  2570. log messages for connection related actions.
  2571. :envvar:`KOMBU_LOG_DEBUG` will also enable :envvar:`KOMBU_LOG_CONNECTION`.
  2572. .. _version-1.0.7:
  2573. 1.0.7
  2574. =====
  2575. :release-date: 2011-03-28 05:45 P.M CEST
  2576. :release-by: Ask Solem
  2577. * Now depends on anyjson 0.3.1
  2578. cjson is no longer a recommended json implementation, and anyjson
  2579. will now emit a deprecation warning if used.
  2580. * Please note that the Pika backend only works with version 0.5.2.
  2581. The latest version (0.9.x) drastically changed API, and it is not
  2582. compatible yet.
  2583. * on_decode_error is now called for exceptions in message_to_python
  2584. (Issue #24).
  2585. * Redis: did not respect QoS settings.
  2586. * Redis: Creating a connection now ensures the connection is established.
  2587. This means ``Connection.ensure_connection`` works properly with
  2588. Redis.
  2589. * consumer_tag argument to ``Queue.consume`` can't be :const:`None`
  2590. (Issue #21).
  2591. A None value is now automatically converted to empty string.
  2592. An empty string will make the server generate a unique tag.
  2593. * Connection now supports a ``transport_options`` argument.
  2594. This can be used to pass additional arguments to transports.
  2595. * Pika: ``drain_events`` raised :exc:`socket.timeout` even if no timeout
  2596. set (Issue #8).
  2597. .. version-1.0.6:
  2598. 1.0.6
  2599. =====
  2600. :release-date: 2011-03-22 04:00 P.M CET
  2601. :release-by: Ask Solem
  2602. * The ``delivery_mode`` aliases (persistent/transient) were not automatically
  2603. converted to integer, and would cause a crash if using the amqplib
  2604. transport.
  2605. * Redis: The redis-py :exc:`InvalidData` exception suddenly changed name to
  2606. :exc:`DataError`.
  2607. * The :envvar:`KOMBU_LOG_DEBUG` environment variable can now be set to log all
  2608. channel method calls.
  2609. Support for the following environment variables have been added:
  2610. * :envvar:`KOMBU_LOG_CHANNEL` will wrap channels in an object that
  2611. logs every method call.
  2612. * :envvar:`KOMBU_LOG_DEBUG` both enables channel logging and configures the
  2613. root logger to emit messages to standard error.
  2614. **Example Usage**:
  2615. .. code-block:: console
  2616. $ KOMBU_LOG_DEBUG=1 python
  2617. >>> from kombu import Connection
  2618. >>> conn = Connection()
  2619. >>> channel = conn.channel()
  2620. Start from server, version: 8.0, properties:
  2621. {u'product': 'RabbitMQ',.............. }
  2622. Open OK! known_hosts []
  2623. using channel_id: 1
  2624. Channel open
  2625. >>> channel.queue_declare('myq', passive=True)
  2626. [Kombu channel:1] queue_declare('myq', passive=True)
  2627. (u'myq', 0, 1)
  2628. .. _version-1.0.5:
  2629. 1.0.5
  2630. =====
  2631. :release-date: 2011-03-17 04:00 P.M CET
  2632. :release-by: Ask Solem
  2633. * Fixed memory leak when creating virtual channels. All virtual transports
  2634. affected (redis, mongodb, memory, django, sqlalchemy, couchdb, beanstalk).
  2635. * Virtual Transports: Fixed potential race condition when acking messages.
  2636. If you have been affected by this, the error would show itself as an
  2637. exception raised by the OrderedDict implementation. (``object no longer
  2638. exists``).
  2639. * MongoDB transport requires the ``findandmodify`` command only available in
  2640. MongoDB 1.3+, so now raises an exception if connected to an incompatible
  2641. server version.
  2642. * Virtual Transports: ``basic.cancel`` should not try to remove unknown
  2643. consumer tag.
  2644. .. _version-1.0.4:
  2645. 1.0.4
  2646. =====
  2647. :release-date: 2011-02-28 04:00 P.M CET
  2648. :release-by: Ask Solem
  2649. * Added Transport.polling_interval
  2650. Used by django-kombu to increase the time to sleep between SELECTs when
  2651. there are no messages in the queue.
  2652. Users of django-kombu should upgrade to django-kombu v0.9.2.
  2653. .. _version-1.0.3:
  2654. 1.0.3
  2655. =====
  2656. :release-date: 2011-02-12 04:00 P.M CET
  2657. :release-by: Ask Solem
  2658. * ConnectionPool: Re-connect if amqplib connection closed
  2659. * Adds ``Queue.as_dict`` + ``Exchange.as_dict``.
  2660. * Copyright headers updated to include 2011.
  2661. .. _version-1.0.2:
  2662. 1.0.2
  2663. =====
  2664. :release-date: 2011-01-31 10:45 P.M CET
  2665. :release-by: Ask Solem
  2666. * amqplib: Message properties were not set properly.
  2667. * Ghettoq backend names are now automatically translated to the new names.
  2668. .. _version-1.0.1:
  2669. 1.0.1
  2670. =====
  2671. :release-date: 2011-01-28 12:00 P.M CET
  2672. :release-by: Ask Solem
  2673. * Redis: Now works with Linux (epoll)
  2674. .. _version-1.0.0:
  2675. 1.0.0
  2676. =====
  2677. :release-date: 2011-01-27 12:00 P.M CET
  2678. :release-by: Ask Solem
  2679. * Initial release
  2680. .. _version-0.1.0:
  2681. 0.1.0
  2682. =====
  2683. :release-date: 2010-07-22 04:20 P.M CET
  2684. :release-by: Ask Solem
  2685. * Initial fork of carrot