forked from sopel-irc/sopel
-
Notifications
You must be signed in to change notification settings - Fork 0
/
NEWS
2051 lines (1664 loc) · 83.9 KB
/
NEWS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
This file is used to auto-generate the "Changelog" section of Sopel's website.
When adding new entries, follow the style guide in NEWS.spec.md to avoid
causing problems with the site build.
Changes between 7.0.6 and 7.0.7
===============================
Core changes
------------
* Make sure Sopel continues to install smoothly on all of its supported Python
versions after November 2020 changes in `urllib3` 1.26
* Updated a few spots in tests and documentation to keep our 7.0.x maintenance
branch in tip-top shape
Changes between 7.0.5 and 7.0.6
===============================
Core changes
------------
* Tweak `reddit` plugin's requirements to mitigate install problems on older
versions of Python [[#1919][]]
[#1919]: https://github.com/sopel-irc/sopel/pull/1919
Changes between 7.0.4 and 7.0.5
===============================
Core changes
------------
* Update `ip` plugin's requirements to prevent install problems on older
versions of Python [[#1909][]]
* Also includes a tweak to one of DuckDuckGo's tests in the `search` plugin,
and a backported update to the `ip` plugin's tests.
[#1909]: https://github.com/sopel-irc/sopel/pull/1909
Changes between 7.0.3 and 7.0.4
===============================
Plugin changes
--------------
* Relax DuckDuckGo test in `search` plugin that was causing CI issues
Core changes
------------
* Fix plugin name in bot's internal command-group tracking [[#1863][]]
[#1863]: https://github.com/sopel-irc/sopel/pull/1863
Changes between 7.0.2 and 7.0.3
===============================
Plugin changes
--------------
* Tweak Bing result matching in `search` plugin again [[#1854][]]
Core changes
------------
* Fix URL callbacks missing required attributes [[#1855][]]
[#1854]: https://github.com/sopel-irc/sopel/pull/1854
[#1855]: https://github.com/sopel-irc/sopel/pull/1855
Changes between 7.0.1 and 7.0.2
===============================
Plugin changes
--------------
* Fix version comparison in `find_updates` plugin [[#1832][]]
* Suppress link when `xkcd` plugin is triggered by a URL [[#1848][]]
* Fix `reddit` grammar when post/comment only has 1 point [[#1849][]]
* Handle missing data when `safety` plugin uses VirusTotal [[#1851][]]
* Update `search` plugin for changed Bing SERPs [[#1852][]]
* Also fixes `xkcd` plugin's find-comic-by-keywords functionality
Core changes
------------
* Fixed that per-channel configuration didn't work as documented for some
plugin types [[#1840][]]
* Show how to use channel key (password) in configuration examples [[#1844][]]
* Fixed URL callbacks bypassing user/channel restrictions [[#1845][]]
* Capped `urllib3` (transitive dependency from `requests`) version on Python
3.3 to avoid a recent release breaking things
* Meta: Fixed incorrect links in changelog entry for 7.0.1
API changes
-----------
* Handle 0 seconds properly in `tools.time.seconds_to_human()` [[#1843][]]
[#1832]: https://github.com/sopel-irc/sopel/pull/1832
[#1840]: https://github.com/sopel-irc/sopel/pull/1840
[#1843]: https://github.com/sopel-irc/sopel/pull/1843
[#1844]: https://github.com/sopel-irc/sopel/pull/1844
[#1845]: https://github.com/sopel-irc/sopel/pull/1845
[#1848]: https://github.com/sopel-irc/sopel/pull/1848
[#1849]: https://github.com/sopel-irc/sopel/pull/1849
[#1851]: https://github.com/sopel-irc/sopel/pull/1851
[#1852]: https://github.com/sopel-irc/sopel/pull/1852
Changes between 7.0.0 and 7.0.1
===============================
Sopel 7.0.1 contains small fixes and tweaks for core code, core plugins, and
documentation. As this is a maintenance release, there are no new API features
or deprecations to report—but stay tuned for a few new things in version 7.1.0.
Plugin changes
--------------
* The `reddit` plugin now displays when a redditor is an admin [[#1764][]]
* When triggered by a native media link, `reddit` plugin output will include a
link to the submission page (comments view) [[#1814][]]
* Fixed `reddit` plugin not matching links with encoded characters [[#1827][]]
* `clock` plugin's `.setchanneltz` command now emits an error message if an
unprivileged user attempts to use it [[#1828][]]
* Fixed the `units` plugin's handling of 16 ounces / 1 pound [[#1829][]]
* Fixed loading `remind` database with reminder(s) containing certain IRC
formatting characters [[#1831][]]
Core changes
------------
* Hotfixed a crash that could occur if the connection was lost [[#1820][]]
* Sopel now prints the used config file path at startup [[#1822][]]
[#1764]: https://github.com/sopel-irc/sopel/pull/1764
[#1814]: https://github.com/sopel-irc/sopel/pull/1814
[#1820]: https://github.com/sopel-irc/sopel/pull/1820
[#1822]: https://github.com/sopel-irc/sopel/pull/1822
[#1827]: https://github.com/sopel-irc/sopel/pull/1827
[#1828]: https://github.com/sopel-irc/sopel/pull/1828
[#1829]: https://github.com/sopel-irc/sopel/pull/1829
[#1831]: https://github.com/sopel-irc/sopel/pull/1831
Changes between 6.6.9 and 7.0.0
===============================
Sopel 7.0 contains numerous fixes, tweaks, new features, and internal
improvements. While we maintain no official statistics on such things, it's
probably the biggest release the project has ever seen.
The full, detailed list of changes is below, but you can just read the
[migration guide][sopel-7-migration] if all you care about is the really
important stuff. All breaking changes (including those planned for the *next*
release) are explained there.
Plugin changes
--------------
* The `spellcheck` plugin has been removed to simplify dependencies [[#1675][]]
* An updated version with added features and tweaks, based on `aspell`, is
installable separately [from PyPI][spellcheck-pypi] [[#1164][], [#1545][]]
* See [#1142][] & [#1642][] for background on why we decided to separate
`spellcheck` into a separate package (tl;dr: dependency hell)
* Similarly, the `ipython` plugin is now an external package, eliminating from
Sopel itself a dependency which most users will never need [[#1684][]]
* Find the new `sopel-ipython` package [on PyPI][ipython-pypi]
* The `.choose`/`.choice` command has been moved from `dice` into a standalone
plugin, aptly named `choose` [[#1679][]]
* Moved `.py` into its own plugin, named `py` [[#1710][], [#1711][], [#1712][]]
* In case of issues with our "official" instance, there's now a setting to
configure the address of your own [Oblique][oblique] service
* The `currency` plugin changed data sources to support more currencies, and
can optionally use Fixer.io for even *more* [[#1430][], [#1627][], [#1629][]]
* Fixer.io requires a free API key, which gives plenty of calls per month
(the plugin caches exchange rates for 24 hours)
* Choose any of five pastebin services for `help` output [[#1451][], [#1651][]]
* This is intended mostly for resilience (so one pastebin service going
down, as ptpb did during the 6.6.x life-cycle, won't force a new Sopel
release), but it's also just good to have choices
* Optionally hide IRC server name/address in `help` command listing [[#1459][]]
* New `help` plugin setting, `reply_method` [[#1700][]]
* `wiktionary` now supports many more parts of speech [[#1443][]]
* Definitions can be retrieved for things like proper nouns, prepositional
phrases, and punctuation marks—things that were unsupported in Sopel 6.x
* This means that the `wiktionary` plugin is now somewhat case-sensitive, to
account for common and proper nouns that differ only in capitalization
* `url` will now ignore "private" addresses by default [[#1439][], [#1624][]]
* New config settings for the `url` plugin allow overriding the checks, in
cases where loading previews of e.g. LAN servers is safe
* The default is off, so users don't unwittingly open themselves to attackers
fishing for running HTTP services on the local machine or network
* `url` now correctly ignores invalid URLs (e.g. `http://*\.com`) [[#1788][]]
* Various improvements to the `clock` functions [[#1592][]]
* Improved guessing in `.t`/`.time` command, which no longer falls back all
the way to the bot's default timezone if given an unrecognized argument
* New `.tz` command, to explicitly get time for a timezone name (in case of
conflict between a known nick and a timezone name)
* The `tell` & `remind` plugins' ".db" files have changed names [[#1699][]]
* Both will attempt automatic migration of existing files, if they exist,
and output debugging information if the migration fails
* The `.at` command (in `remind`) understands dates now [[#1590][], [#1736][]]
* Finally, it's possible to set a reminder more than 24 hours ahead without
first converting the future date/time to a duration for use with `.in`!
* A new `tell` plugin setting allows delivering messages privately [[#1694][]]
* The `reddit` plugin now also handles short `redd.it` links, direct links to
comments, inline `u/` and `r/` references, & reddit-hosted image/video links
[[#1503][], [#1720][], [#1722][], [#1734][], [#1760][], [#1773][]]
* Spoilers & NSFW are now separate concepts in the `reddit` plugin [[#1620][]]
* Reddit implemented spoilers as a distinct post flag some time ago. Sopel's
plugin supports independently setting channels as "SFW" or "spoiler-free".
* Rolling `.dice` now officially supports trailing `# comments` [[#1577][]]
* Python version is now included in `.version` command output [[#1462][]]
* The `.version` command's output format is improved [[#1633][]]
* Using the `.reload` command shows the specific file reloaded [[#1762][]]
* The `.seen` command's output now uses relative time [[#1661][]]
* Readability of `.choose` command output is significantly improved [[#1425][]]
* Added `.invite` command [[#1497][]]
* Both Sopel and the inviting user must have privileges in the target channel
* A `.restart` command is added [[#1333][]]
* Usable by admins only, just like `.quit`
* The `.msg` command is now known as `.say` [[#1606][]]
* `.msg` will continue to work for now, likely until being removed in Sopel 8
* The `admin` plugin auto-saves channels when using `.join`/`.part`, and added
`.tmpjoin`/`.tmppart` commands to bypass this behavior [[#1492][]]
* Added command to `.unset` config values in the `admin` plugin [[#1556][]]
* Restored commands in `adminchannel` plugin for managing op/voice [[#1498][]]
* These were removed some time ago, seemingly without reason, by the
project's previous maintainers
* Since there was some desire from users to have them back, we restored them
* Fixed/tweaked hostmask handling in `adminchannel` ban functions [[#1791][]]
* `find` also collects Sopel's own messages now, so users can "correct" the bot
if they wish to be extra cheeky [[#1470][]]
* Fixed that the `url` plugin had to be enabled or some link-handling functions
wouldn't work [[#1510][]]
* Tweaked `.ddg` command output so it's less likely to mangle URLs [[#1713][]]
* `remind` commands now "reply" with error messages [[#1715][]]
* Fixed `etymology` plugin error with empty argument [[#1677][]]
* Fixed an uncaught exception in `instagram` plugin [[#1702][]]
* Handle JSON fetch/parse errors in `find_updates` plugin [[#1779][]]
* Removed nonsensical uses of the `core.verify_ssl` setting [[#1706][]]
* Unused `clock` plugin settings have been removed [[#1696][]]
* Updated MaxMind database handling in `ip` plugin [[#1797][]]
* Reworked `safety` plugin's cache management [[#1753][], [#1802][]]
* General code cleanup and tweaks all around [[#1402][], [#1486][], [#1505][],
[#1569][], [#1573][], [#1578][], [#1579][], [#1581][], [#1592][], [#1606][],
[#1607][], [#1609][], [#1678][], [#1681][], [#1696][], [#1717][], [#1721][],
[#1725][], [#1735][], [#1741][], [#1754][]]
Core changes
------------
* Brought back support for non-SQLite databases by switching to SQLAlchemy
[[#1446][], [#1652][], [#1729][], [#1755][], [#1774][], [#1777][], [#1783][]]
* For details on using non-SQLite databases, see the [README][readme-db] or
[configuration instructions][db-config-docs]
* You will probably need to install additional dependencies if you wish to
use something other than SQLite
* Migrating an existing database from SQLite to your chosen option is
probably easy, but we do not offer instructions for doing so
* Be aware that plugins written for older versions of Sopel might not work
properly with non-SQLite databases
* The `db_filename` config setting (for SQLite) is now interpreted as relative
to the config's `homedir` setting [[#1574][]]
* `homedir` itself has a default value that will be used if not set
* Added separate server & nickname authentication options [[#1513][]]
* See [authentication configuration docs][auth-config-docs]
* Added `commands_on_connect` setting to send a list of commands automatically
when Sopel's IRC connection is successfully established [[#1528][]]
* Log files have become *much* more configurable [[#1678][], [#1714][]]
* Logs are named based on the config name
* Many, many new settings added to customize logging
* The default log format includes timestamp, source package, & level (which
will make logs *much* more useful when reporting bugs)
* Logs now have information about which plugin file was reloaded [[#1762][]]
* This is helpful for owners of Sopel instances with multiple versions of a
plugin available for testing or development purposes
* Sopel's own rate-limiting & flood protection parameters are now configurable,
and can even be turned off entirely if Sopel is behind a bouncer or other IRC
proxy that handles flood protection itself [[#1518][], [#1638][]]
* Added more control over JOIN throttling [[#1751][]]
* Includes a new `throttle_wait` setting instead of a hard-coded time value
* Log timestamp and log line formats are now configurable [[#1512][]]
* See details in [the logging configuration docs][logging-config-docs]
* Log filenames now include the config name, to help keep track of logs from
multiple Sopel instances [[#1547][]]
* Home directory is no longer assumed to be `~/.sopel` on first run [[#1404][]]
* Restarting Sopel via CLI is added [[#1333][]]
* Sopel's CLI is restructured [[#1493][], [#1509][], [#1718][]]
* New subcommands (`start`, `stop`, `restart`, and `configure`) replace many
of the old `--option`s, cleaning up the syntax
* The legacy `--option`s will continue to work for the life of Sopel 7.x, and
will be removed in Sopel 8
* New `--config-dir` common option [[#1598][]]
* Added a new `sopel-config` command for working with config files [[#1507][]]
* Currently supports `list` (existing files), `init` (new config file), and
`get` (config value) actions
* The old `--list` argument to `sopel` is considered deprecated, and will be
removed in Sopel 8
* See detailed usage in your terminal with `sopel-config --help`, or review
[the online CLI docs][docs-cli-config] at our website
* Added a new `sopel-plugins` command for managing plugins [[#1588][]]
* Currently supports `list` (available plugins), `show` (plugin details &
status), `enable` & `disable` (edits config on the user's behalf)
* See detailed usage in your terminal with `sopel-plugins --help`, or review
[the online CLI docs][docs-cli-plugins] at our website
* Sopel now also looks for plugins in `$HOMEDIR/plugins` [[#1747][]]
* This is part of a longer-term plan to reduce confusion over the term
"module", which Sopel has been using in conflicting ways; see [[#1738][]]
* The config file Sopel should use can be specified via the `SOPEL_CONFIG`
environment variable [[#1473][]]
* List values in config can be separated by newlines [[#1628][], [#1690][]]
* Newline-separated values support commas within each value
* Comma-separated value support will end someday, but likely not till Sopel 9
* Find more details in [the `ListAttribute` documentation][docs-listattr]
* Config options can be set/overridden via environment variables [[#1096][]]
* Variable naming format: `SOPEL_SECTION_OPTION`
* Underscores in `SECTION` and `OPTION` names are preserved, e.g.
`SOPEL_CORE_AUTH_PASSWORD`
* Example multi-instance systemd template is now available [[#1059][]]
* Example systemd unit files wait until networking is connected before starting
Sopel [[#1511][]]
* Running Sopel on an unknown OS platform will output a warning encouraging the
user to report any issues (because test coverage on an unrecognized platform
name is likely to be nil) [[#1487][]]
* Cleaned up or refactored a bunch of places [[#1424][], [#1429][], [#1456][],
[#1458][], [#1472][], [#1479][], [#1510][], [#1522][], [#1527][], [#1542][],
[#1557][], [#1561][], [#1567][], [#1579][], [#1580][], [#1583][], [#1597][],
[#1610][], [#1635][], [#1685][], [#1697][], [#1708][], [#1716][], [#1723][],
[#1724][], [#1728][], [#1730][], [#1731][], [#1732][], [#1735][], [#1739][],
[#1740][], [#1741][], [#1742][], [#1743][], [#1754][], [#1759][], [#1787][]]
* Sopel 7 will emit warnings when run under Python 2, as Python 2.7 support
officially ended on January 1, 2020 [[#1488][], [#1795][], [#1800][]]
* Sopel's warnings are set to become more dire around the time when Python's
maintainers plan to release the final version of 2.7
* While Sopel 7 is intended to remain compatible with Python 2, future
compatibility is not guaranteed, and users should plan for Sopel 8 to
officially drop Python 2 support (see [upgrade notes][sopel-7-migration])
* Added support for IRCv3 `echo-message` capability, which Sopel will now
request upon connecting to an IRC server [[#1470][], [#1672][], [#1674][]]
* Added support for disabling commands (or entire plugins) on a per-channel
basis [[#1235][]]
* See how it works: [Per-channel configuration][per-channel-conf]
* Fixed tracking user `away` state [[#1663][], [#1664][], [#1666][], [#1703][]]
* User information is now periodically updated [[#1664][]]
* Fixed a case in which MODE tracking could break [[#1737][]]
* Handle non-standard `+y`/`+Y` OPER modes [[#1671][]]
* A new `OPER` constant in `sopel.module` now exists for these channel modes,
which (at least on InspIRCd) use the privilege prefix `!`
* This is a stopgap for one specific case; we are working on further changes
to support dynamic parsing of privilege modes/prefixes at connect time
* Stopped sending TOPIC command on JOIN [[#1749][]]
* IRC servers should send the topic on join without being asked, per spec
* Greatly improved the warning printed when a deprecated function is used,
adding detail and removing unnecessary traceback lines [[#1568][], [#1613][]]
* Typical length of output for each deprecated function call reduced from
roughly 15 lines to 3 (warning, file/line, and offending code snippet)
* Added optional `@deprecated` decorator arguments:
* `reason`: why this item was deprecated
* `version`: the version in which the deprecation happened
* `removed_in`: the version in which the deprecated item will be removed
* The end-of-life warning for users on Python 2.x is now date-aware [[#1756][]]
* Made sure ignored users cannot trigger URL handlers [[#1806][]]
* Tightened up some more dependency version specifiers [[#1807][]]
API changes
-----------
* [API documentation][api-docs] has been almost entirely overhauled [[#1563][],
[#1566][], [#1646][], [#1668][], [#1669][], [#1680][], [#1719][], [#1727][],
[#1735][], [#1750][], [#1766][], [#1770][], [#1771][], [#1772][], [#1775][],
[#1776][], [#1778][], [#1782][], [#1813][]]
* Nearly every file, both for the public API and Sopel's internals, was
reviewed in its entirety to make these improvements globally:
* More consistent style
* Better use of Sphinx features (e.g. parameter definitions, return value
notes, & version annotations)
* General cleanup and copy-editing
* Add more detail and examples to help new bot users and plugin authors
* Remove or correct outdated information left over from previous versions
* Most of Sopel's submodules now define `__all__`, limiting namespace pollution
from using `*` in imports [[#1582][], [#1727][]]
* Plugins can register themselves via `setuptools` entry points [[#1585][]]
* This feature is an evolution of the previous mechanism to install plugins
via PyPI packages, which required a specific directory structure and
package name format (`sopel_modules.plugin_name`)
* See [the entry point plugin documentation][entry-point-plugin] for more
* Logging has been reworked [[#1678][]]
* The `sopel.logger.get_logger()` function is deprecated in favor of a new
`sopel.tools.get_logger()` utility with plugin-specific behavior
* `sopel.logger.get_logger()` will begin emitting deprecation warnings in
version 8.0, and will be removed in 9.0
* Testing tools have been overhauled [[#1731][], [#1732][], [#1781][]]
* The old "Mock" classes in `sopel.test_tools` are now deprecated:
* `MockConfig`
* `MockSopel`
* `MockSopelWrapper`
* New pytest fixtures make the real objects usable in tests directly
* The bot keeps track of running triggered threads, so tests can be sure that
processing has finished before evaluating results
* Sopel also now exports a `pytest` plugin, for convenience
* `module.event()` decorator no longer requires a rule [[#1693][], [#1709][]]
* Since 99% (unscientific guesstimate) of event decorators were paired with
`@module.rule('.*')`, that's now implied if no rule decorator is present
* Added `sopel.tools.web` (replaces `sopel.web`) [[#1616][], [#1670][]]
* Both old and new import locations will work until Sopel 7 end-of-life
* The `sopel.web` package will be removed completely in Sopel 8
* Functions marked as deprecated in the old location (e.g. `web.get()`) do
*not* carry forward to the new package namespace; they remain deprecated
* Added `tools.web.unquote()`, the reverse of `tools.web.quote()` [[#1681][]]
* Note: This is not available in the `sopel.web` compatibility layer
* Added a set of methods in the `bot` object to manipulate URL callbacks:
`bot.register_url_callback`, `bot.unregister_url_callback`, and
`bot.search_url_callbacks` [[#1508][], [#1808][]]
* Modules should switch to using these new API methods instead of directly
accessing `bot.memory['url_callbacks']`
* There are no definite plans to remove `bot.memory['url_callbacks']`, but it
should be considered deprecated
* Added `kick()` method to `bot` object [[#1539][]]
* `bot.kick(nick, channel, optional_message)` is shorthand for the pattern
`bot.write(['KICK', channel, nick], optional_message)`, used by a number
of both core and third-party plugins
* Added `bot.myinfo`, containing the server's RPL_MYINFO (004) data [[#1769][]]
* More information in [the MYINFO documentation][docs-myinfo]
* Added `bot.isupport`, exposing network-specific settings and properties from
the server's RPL_ISUPPORT (005) data [[#1758][]]
* This includes useful things like the network's maximum nickname length
(`NICKLEN`), maximum topic length (`TOPICLEN`), number of targets allowed
per command (`TARGMAX`), and channel-privilege mappings (`PREFIX`)
* More information in [the ISUPPORT documentation][docs-isupport]
* Added `session()` method to `bot.db` [[#1811][]]
* `db.connect()` now logs a message when used with a non-SQLite database
connected, as raw connection behavior for different DB types varies
* Added `delete_{nick,channel}_value` methods in `bot.db` [[#1526][]]
* Added "plugin value" API to `bot.db` [[#1621][]]
* Functionally identical to "nick" and "channel" values, but in a separate
namespace intended for plugins' use to store key-value data that isn't
associated with a nick or channel and doesn't belong in the config file
* Added optional `default` kwarg to `db.get_*_value()` functions [[#1673][]]
* This allows streamlining some uses of values fetched from the database
* New `sopel.module.output_prefix` decorator [[#1701][]]
* Defines a prefix for all output sent from the decorated callable via
`bot.say` or `bot.notice` (`bot.action` & `bot.reply` don't fit the use
cases this feature is intended to address)
* New `sopel.module.require_account` decorator [[#1733][]]
* This is useful to require services login on networks where Sopel can track
users' authentication status, but will block *all* use of the decorated
callable on networks without the necessary features
* `sopel.module` decorators work much more consistently [[#1632][]]
* All relevant decorators accept multiple arguments at once, and will work
properly if used multiple times on the same function
* Added `reply` option to `module.require_*` decorators [[#1456][], [#1500][]]
* Passing `reply=True` will send the error message as if via `bot.reply()`,
prefixing it with the name of the calling user to get their attention
* Passing `reply=False` (or omitting the argument) will behave exactly as
before, with the error message sent as if via `bot.say()`
* Fixed the `@module.url` decorator to work always, regardless of whether any
core plugins are enabled [[#1510][], [#1576][]]
* Added `bot.hostmask` property (read-only) [[#1537][]]
* This property is a shortcut for `bot.users.get(bot.nick).hostmask`, so it
will throw an error if the bot is not connected to a network **and** joined
to at least one channel. Basically, don't try to use it in plugin `setup()`
or `shutdown()` methods.
* Added `bot.get_plugin_meta()` method to fetch plugin information [[#1762][]]
* Added `module.echo` decorator [[#1470][]]
* Decorated callables will receive messages that Sopel itself sends,
regardless of whether the IRC server actually supports `echo-message`
* Don't send output from `@echo`-decorated callables; this will cause loops
* Added `module.action_commands` decorator [[#1660][]]
* This presently conflicts with other command/trigger decorators because of
internal implementation details, but fixing that is on our to-do list
* If you want both `action_commands` and another command type (`commands`,
`nickname_commands`, etc.), use `@action_commands('foo')` to decorate a
wrapper function that simply calls the main one
* Officially deprecated the methods `SopelMemory.contains()` and
`SopelMemoryWithDefault.contains()`, to be removed in Sopel 8 [[#1563][]]
* Use the `in` operator instead
* Officially deprecated the `bot.msg()` method [[#1606][]]
* Adds a warning to Sopel's output for any third-party code that is still
using `bot.msg()` (which was declared deprecated and removed from the API
docs in 6.0) instead of `bot.say()`
* Added a new `user_help` kwarg to `@module.example` decorator [[#1403][]]
* This allows multiple help examples per command, as requested in [#1200][]
* See the [Sopel 7 migration guide][sopel-7-migration] for details on using
this new parameter, and about backwards compatibility
* Added a new `online` kwarg to `@module.example` decorator [[#1555][]]
* Example tests that require an Internet connection may be marked with
`online=True` to indicate this fact (the default is `False`)
* This facilitates running only offline-safe plugin tests, by passing
`--offline` to pytest, if an Internet connection is unavailable
* Outside of the test suite, this parameter has no effect
* Corrected case-mapping in `tools.Identifier` class [[#1744][]]
* See [the Sopel 7 migration guide][sopel-7-migration] for details,
particularly if your plugin interacts with the database and/or user/channel
identifiers in their lowercase form
* Added more utilities to `tools.time`:
* `tools.time.seconds_to_human()`, for generating human-readable fuzzy
relative timestamps from `timedelta` or raw number of seconds [[#1560][]]
* `tools.time.get_nick_timezone()` and `tools.time.get_channel_timezone()`,
for cases where the fallback behavior(s) of `tools.time.get_timezone()`
would be undesired [[#1592][]]
* Made `tools.time.validate_timezone()` more robust [[#1707][]]
* Added alias for 462 numeric in `tools.events` [[#1665][]]
* [RFC 2812][] defined an incorrect spelling, `ERR_ALREADYREGISTRED`, and
Sopel copied it verbatim
* The spelling `ERR_ALREADYREGISTERED` can be used now, too
* Fixed invalid raw lines in generated `@example` tests [[#1499][]]
* Fixed `PreTrigger` objects missing the `text` attribute sometimes [[#1782][]]
[#1059]: https://github.com/sopel-irc/sopel/pull/1059
[#1096]: https://github.com/sopel-irc/sopel/pull/1096
[#1142]: https://github.com/sopel-irc/sopel/issues/1142
[#1164]: https://github.com/sopel-irc/sopel/pull/1164
[#1200]: https://github.com/sopel-irc/sopel/issues/1200
[#1235]: https://github.com/sopel-irc/sopel/pull/1235
[#1333]: https://github.com/sopel-irc/sopel/pull/1333
[#1402]: https://github.com/sopel-irc/sopel/pull/1402
[#1403]: https://github.com/sopel-irc/sopel/pull/1403
[#1404]: https://github.com/sopel-irc/sopel/pull/1404
[#1424]: https://github.com/sopel-irc/sopel/pull/1424
[#1425]: https://github.com/sopel-irc/sopel/pull/1425
[#1429]: https://github.com/sopel-irc/sopel/pull/1429
[#1430]: https://github.com/sopel-irc/sopel/pull/1430
[#1439]: https://github.com/sopel-irc/sopel/pull/1439
[#1443]: https://github.com/sopel-irc/sopel/pull/1443
[#1446]: https://github.com/sopel-irc/sopel/pull/1446
[#1451]: https://github.com/sopel-irc/sopel/pull/1451
[#1456]: https://github.com/sopel-irc/sopel/pull/1456
[#1458]: https://github.com/sopel-irc/sopel/pull/1458
[#1459]: https://github.com/sopel-irc/sopel/pull/1459
[#1462]: https://github.com/sopel-irc/sopel/pull/1462
[#1470]: https://github.com/sopel-irc/sopel/pull/1470
[#1472]: https://github.com/sopel-irc/sopel/pull/1472
[#1473]: https://github.com/sopel-irc/sopel/pull/1473
[#1479]: https://github.com/sopel-irc/sopel/pull/1479
[#1486]: https://github.com/sopel-irc/sopel/pull/1486
[#1487]: https://github.com/sopel-irc/sopel/pull/1487
[#1488]: https://github.com/sopel-irc/sopel/pull/1488
[#1492]: https://github.com/sopel-irc/sopel/pull/1492
[#1493]: https://github.com/sopel-irc/sopel/pull/1493
[#1497]: https://github.com/sopel-irc/sopel/pull/1497
[#1498]: https://github.com/sopel-irc/sopel/pull/1498
[#1499]: https://github.com/sopel-irc/sopel/pull/1499
[#1500]: https://github.com/sopel-irc/sopel/pull/1500
[#1503]: https://github.com/sopel-irc/sopel/pull/1503
[#1505]: https://github.com/sopel-irc/sopel/pull/1505
[#1507]: https://github.com/sopel-irc/sopel/pull/1507
[#1508]: https://github.com/sopel-irc/sopel/pull/1508
[#1509]: https://github.com/sopel-irc/sopel/pull/1509
[#1510]: https://github.com/sopel-irc/sopel/pull/1510
[#1511]: https://github.com/sopel-irc/sopel/pull/1511
[#1512]: https://github.com/sopel-irc/sopel/pull/1512
[#1513]: https://github.com/sopel-irc/sopel/pull/1513
[#1518]: https://github.com/sopel-irc/sopel/pull/1518
[#1522]: https://github.com/sopel-irc/sopel/pull/1522
[#1526]: https://github.com/sopel-irc/sopel/pull/1526
[#1527]: https://github.com/sopel-irc/sopel/pull/1527
[#1528]: https://github.com/sopel-irc/sopel/pull/1528
[#1537]: https://github.com/sopel-irc/sopel/pull/1537
[#1539]: https://github.com/sopel-irc/sopel/pull/1539
[#1542]: https://github.com/sopel-irc/sopel/pull/1542
[#1545]: https://github.com/sopel-irc/sopel/pull/1545
[#1547]: https://github.com/sopel-irc/sopel/pull/1547
[#1555]: https://github.com/sopel-irc/sopel/pull/1555
[#1556]: https://github.com/sopel-irc/sopel/pull/1556
[#1557]: https://github.com/sopel-irc/sopel/pull/1557
[#1560]: https://github.com/sopel-irc/sopel/pull/1560
[#1561]: https://github.com/sopel-irc/sopel/pull/1561
[#1563]: https://github.com/sopel-irc/sopel/pull/1563
[#1566]: https://github.com/sopel-irc/sopel/pull/1566
[#1567]: https://github.com/sopel-irc/sopel/pull/1567
[#1568]: https://github.com/sopel-irc/sopel/pull/1568
[#1569]: https://github.com/sopel-irc/sopel/pull/1569
[#1573]: https://github.com/sopel-irc/sopel/pull/1573
[#1574]: https://github.com/sopel-irc/sopel/pull/1574
[#1576]: https://github.com/sopel-irc/sopel/pull/1576
[#1577]: https://github.com/sopel-irc/sopel/pull/1577
[#1578]: https://github.com/sopel-irc/sopel/pull/1578
[#1579]: https://github.com/sopel-irc/sopel/pull/1579
[#1580]: https://github.com/sopel-irc/sopel/pull/1580
[#1581]: https://github.com/sopel-irc/sopel/pull/1581
[#1582]: https://github.com/sopel-irc/sopel/pull/1582
[#1583]: https://github.com/sopel-irc/sopel/pull/1583
[#1585]: https://github.com/sopel-irc/sopel/pull/1585
[#1588]: https://github.com/sopel-irc/sopel/pull/1588
[#1590]: https://github.com/sopel-irc/sopel/pull/1590
[#1592]: https://github.com/sopel-irc/sopel/pull/1592
[#1597]: https://github.com/sopel-irc/sopel/pull/1597
[#1598]: https://github.com/sopel-irc/sopel/pull/1598
[#1606]: https://github.com/sopel-irc/sopel/pull/1606
[#1607]: https://github.com/sopel-irc/sopel/pull/1607
[#1609]: https://github.com/sopel-irc/sopel/pull/1609
[#1610]: https://github.com/sopel-irc/sopel/pull/1610
[#1613]: https://github.com/sopel-irc/sopel/pull/1613
[#1616]: https://github.com/sopel-irc/sopel/pull/1616
[#1620]: https://github.com/sopel-irc/sopel/pull/1620
[#1621]: https://github.com/sopel-irc/sopel/pull/1621
[#1624]: https://github.com/sopel-irc/sopel/pull/1624
[#1627]: https://github.com/sopel-irc/sopel/pull/1627
[#1628]: https://github.com/sopel-irc/sopel/pull/1628
[#1629]: https://github.com/sopel-irc/sopel/pull/1629
[#1632]: https://github.com/sopel-irc/sopel/pull/1632
[#1633]: https://github.com/sopel-irc/sopel/pull/1633
[#1635]: https://github.com/sopel-irc/sopel/pull/1635
[#1638]: https://github.com/sopel-irc/sopel/pull/1638
[#1642]: https://github.com/sopel-irc/sopel/issues/1642
[#1646]: https://github.com/sopel-irc/sopel/pull/1646
[#1651]: https://github.com/sopel-irc/sopel/pull/1651
[#1652]: https://github.com/sopel-irc/sopel/pull/1652
[#1660]: https://github.com/sopel-irc/sopel/pull/1660
[#1661]: https://github.com/sopel-irc/sopel/pull/1661
[#1663]: https://github.com/sopel-irc/sopel/pull/1663
[#1664]: https://github.com/sopel-irc/sopel/pull/1664
[#1665]: https://github.com/sopel-irc/sopel/pull/1665
[#1666]: https://github.com/sopel-irc/sopel/pull/1666
[#1668]: https://github.com/sopel-irc/sopel/pull/1668
[#1669]: https://github.com/sopel-irc/sopel/pull/1669
[#1670]: https://github.com/sopel-irc/sopel/pull/1670
[#1671]: https://github.com/sopel-irc/sopel/pull/1671
[#1672]: https://github.com/sopel-irc/sopel/pull/1672
[#1673]: https://github.com/sopel-irc/sopel/pull/1673
[#1674]: https://github.com/sopel-irc/sopel/pull/1674
[#1675]: https://github.com/sopel-irc/sopel/pull/1675
[#1677]: https://github.com/sopel-irc/sopel/pull/1677
[#1678]: https://github.com/sopel-irc/sopel/pull/1678
[#1679]: https://github.com/sopel-irc/sopel/pull/1679
[#1680]: https://github.com/sopel-irc/sopel/pull/1680
[#1681]: https://github.com/sopel-irc/sopel/pull/1681
[#1684]: https://github.com/sopel-irc/sopel/pull/1684
[#1685]: https://github.com/sopel-irc/sopel/pull/1685
[#1690]: https://github.com/sopel-irc/sopel/pull/1690
[#1693]: https://github.com/sopel-irc/sopel/pull/1693
[#1694]: https://github.com/sopel-irc/sopel/pull/1694
[#1696]: https://github.com/sopel-irc/sopel/pull/1696
[#1697]: https://github.com/sopel-irc/sopel/pull/1697
[#1699]: https://github.com/sopel-irc/sopel/pull/1699
[#1700]: https://github.com/sopel-irc/sopel/pull/1700
[#1701]: https://github.com/sopel-irc/sopel/pull/1701
[#1702]: https://github.com/sopel-irc/sopel/pull/1702
[#1703]: https://github.com/sopel-irc/sopel/pull/1703
[#1706]: https://github.com/sopel-irc/sopel/pull/1706
[#1707]: https://github.com/sopel-irc/sopel/pull/1707
[#1708]: https://github.com/sopel-irc/sopel/pull/1708
[#1709]: https://github.com/sopel-irc/sopel/pull/1709
[#1710]: https://github.com/sopel-irc/sopel/pull/1710
[#1711]: https://github.com/sopel-irc/sopel/pull/1711
[#1712]: https://github.com/sopel-irc/sopel/pull/1712
[#1713]: https://github.com/sopel-irc/sopel/pull/1713
[#1714]: https://github.com/sopel-irc/sopel/pull/1714
[#1715]: https://github.com/sopel-irc/sopel/pull/1715
[#1716]: https://github.com/sopel-irc/sopel/pull/1716
[#1717]: https://github.com/sopel-irc/sopel/pull/1717
[#1718]: https://github.com/sopel-irc/sopel/pull/1718
[#1719]: https://github.com/sopel-irc/sopel/pull/1719
[#1720]: https://github.com/sopel-irc/sopel/pull/1720
[#1721]: https://github.com/sopel-irc/sopel/pull/1721
[#1722]: https://github.com/sopel-irc/sopel/pull/1722
[#1723]: https://github.com/sopel-irc/sopel/pull/1723
[#1724]: https://github.com/sopel-irc/sopel/pull/1724
[#1725]: https://github.com/sopel-irc/sopel/pull/1725
[#1727]: https://github.com/sopel-irc/sopel/pull/1727
[#1728]: https://github.com/sopel-irc/sopel/pull/1728
[#1729]: https://github.com/sopel-irc/sopel/pull/1729
[#1730]: https://github.com/sopel-irc/sopel/pull/1730
[#1731]: https://github.com/sopel-irc/sopel/pull/1731
[#1732]: https://github.com/sopel-irc/sopel/pull/1732
[#1733]: https://github.com/sopel-irc/sopel/pull/1733
[#1734]: https://github.com/sopel-irc/sopel/pull/1734
[#1735]: https://github.com/sopel-irc/sopel/pull/1735
[#1736]: https://github.com/sopel-irc/sopel/pull/1736
[#1737]: https://github.com/sopel-irc/sopel/pull/1737
[#1738]: https://github.com/sopel-irc/sopel/issues/1738
[#1739]: https://github.com/sopel-irc/sopel/pull/1739
[#1740]: https://github.com/sopel-irc/sopel/pull/1740
[#1741]: https://github.com/sopel-irc/sopel/pull/1741
[#1742]: https://github.com/sopel-irc/sopel/pull/1742
[#1743]: https://github.com/sopel-irc/sopel/pull/1743
[#1744]: https://github.com/sopel-irc/sopel/pull/1744
[#1747]: https://github.com/sopel-irc/sopel/pull/1747
[#1749]: https://github.com/sopel-irc/sopel/pull/1749
[#1750]: https://github.com/sopel-irc/sopel/pull/1750
[#1751]: https://github.com/sopel-irc/sopel/pull/1751
[#1753]: https://github.com/sopel-irc/sopel/pull/1753
[#1754]: https://github.com/sopel-irc/sopel/pull/1754
[#1755]: https://github.com/sopel-irc/sopel/pull/1755
[#1756]: https://github.com/sopel-irc/sopel/pull/1756
[#1758]: https://github.com/sopel-irc/sopel/pull/1758
[#1759]: https://github.com/sopel-irc/sopel/pull/1759
[#1760]: https://github.com/sopel-irc/sopel/pull/1760
[#1762]: https://github.com/sopel-irc/sopel/pull/1762
[#1766]: https://github.com/sopel-irc/sopel/pull/1766
[#1769]: https://github.com/sopel-irc/sopel/pull/1769
[#1770]: https://github.com/sopel-irc/sopel/pull/1770
[#1771]: https://github.com/sopel-irc/sopel/pull/1771
[#1772]: https://github.com/sopel-irc/sopel/pull/1772
[#1773]: https://github.com/sopel-irc/sopel/pull/1773
[#1774]: https://github.com/sopel-irc/sopel/pull/1774
[#1775]: https://github.com/sopel-irc/sopel/pull/1775
[#1776]: https://github.com/sopel-irc/sopel/pull/1776
[#1777]: https://github.com/sopel-irc/sopel/pull/1777
[#1778]: https://github.com/sopel-irc/sopel/pull/1778
[#1779]: https://github.com/sopel-irc/sopel/pull/1779
[#1781]: https://github.com/sopel-irc/sopel/pull/1781
[#1782]: https://github.com/sopel-irc/sopel/pull/1782
[#1783]: https://github.com/sopel-irc/sopel/pull/1783
[#1787]: https://github.com/sopel-irc/sopel/pull/1787
[#1788]: https://github.com/sopel-irc/sopel/pull/1788
[#1791]: https://github.com/sopel-irc/sopel/pull/1791
[#1795]: https://github.com/sopel-irc/sopel/pull/1795
[#1797]: https://github.com/sopel-irc/sopel/pull/1797
[#1800]: https://github.com/sopel-irc/sopel/pull/1800
[#1802]: https://github.com/sopel-irc/sopel/pull/1802
[#1806]: https://github.com/sopel-irc/sopel/pull/1806
[#1807]: https://github.com/sopel-irc/sopel/pull/1807
[#1808]: https://github.com/sopel-irc/sopel/pull/1808
[#1811]: https://github.com/sopel-irc/sopel/pull/1811
[#1813]: https://github.com/sopel-irc/sopel/pull/1813
[api-docs]: https://sopel.chat/docs/
[auth-config-docs]: https://sopel.chat/docs/configure.html#authentication
[db-config-docs]: https://sopel.chat/docs/configuration.html#database
[docs-cli-config]: https://sopel.chat/docs/cli.html#the-sopel-config-command
[docs-cli-plugins]: https://sopel.chat/docs/cli.html#the-sopel-plugins-command
[docs-isupport]: https://sopel.chat/docs/irc.html#module-sopel.irc.isupport
[docs-listattr]: https://sopel.chat/docs/config.html#sopel.config.types.ListAttribute
[docs-myinfo]: https://sopel.chat/docs/irc.html#sopel.irc.utils.MyInfo
[entry-point-plugin]: https://sopel.chat/docs/plugin.html#sopel.plugins.handlers.EntryPointPlugin
[logging-config-docs]: https://sopel.chat/docs/configure.html#logging
[per-channel-conf]: https://sopel.chat/usage/per-channel-configuration/
[readme-db]: https://github.com/sopel-irc/sopel/blob/v7.0.0/README.rst#database-support
[sopel-7-migration]: https://sopel.chat/usage/installing/upgrading-to-sopel-7/
[oblique]: https://github.com/sopel-irc/oblique
[ipython-pypi]: https://pypi.org/project/sopel-ipython/
[spellcheck-pypi]: https://pypi.org/project/sopel-spellcheck/
[RFC 2812]: https://tools.ietf.org/html/rfc2812
Changes between 6.6.8 and 6.6.9
===============================
Module changes
--------------
* Also block changing `core.owner_account` setting in `admin` plugin [[#1599][]]
* Fixed `instagram` parsing after changes to the website [[#1608][]]
* `tld` plugin decodes HTML entities before output [[#1612][]]
* Handle an error condition when querying `ip` module using nickname [[#1631][]]
Core changes
------------
* Fixed populating `user` & `host` in the bot's user database when `NAMES` reply
arrives first [[#1630][]]
[#1599]: https://github.com/sopel-irc/sopel/pull/1599
[#1608]: https://github.com/sopel-irc/sopel/pull/1608
[#1612]: https://github.com/sopel-irc/sopel/pull/1612
[#1630]: https://github.com/sopel-irc/sopel/pull/1630
[#1631]: https://github.com/sopel-irc/sopel/pull/1631
Changes between 6.6.7 and 6.6.8
===============================
Module changes
--------------
* `admin` module no longer allows setting `core.owner` value [[#1587][]]
* Allowing any bot admin to change the owner opened Sopel to a
privilege-escalation attack
* Even with this patch, you still should add only users you really trust to
the `admins` list, for obvious reasons
API changes
-----------
* Fixed some content & formatting errors in documentation [[#1589][]]
[#1587]: https://github.com/sopel-irc/sopel/pull/1587
[#1589]: https://github.com/sopel-irc/sopel/pull/1589
Changes between 6.6.6 and 6.6.7
===============================
Fixing this bug, which was discovered after the previous release, serves to
exorcise the curse brought upon us by version 6.6.6.
Core changes
------------
* Fixed incorrect `MODE` message parsing that could lead to Sopel thinking
some users had higher channel privileges than they did [[#1575][]]
[#1575]: https://github.com/sopel-irc/sopel/pull/1575
Changes between 6.6.5 and 6.6.6
===============================
This slightly cursed version of Sopel is brought to you by the following happy
coincidences. When this release cycle began:
* 6.6.6 was the next patch version number
* Tax Day (in the U.S.) was just a few weeks off — the perfect release date
As it happens, the [v6.6.6 GitHub milestone][ms-666] ended up with 13 closed
issues/PRs in total. We *definitely* didn't try to *plan* any of this. Promise.
[ms-666]: https://github.com/sopel-irc/sopel/milestone/21?closed=1
Module changes
--------------
* Potential denial-of-service via repeated long output in the `.py` and `.calc`
commands was mitigated [[#1552][]]
* `admin` module's `.set` command no longer throws an exception if missing
arguments [[#1520][]]
* Fixed `admin` module's `.mode` command sending invalid raw line [[#1549][]]
* Tweaked output-formatting code in the `meetbot` & `reddit` modules [[#1516][]]
* The most visible effect of this is that moderators' names will now appear
green in `reddit`'s output, like on the site, instead of the old brown/purple
* Updated example/test output for `.ip` command [[#1523][]]
Core changes
------------
* Flood protection delay is now capped at 2 seconds [[#1552][]]
* The flood delay penalty is calculated using the message length before
truncation. Very long command output could thus "hang" the bot for many
minutes at a time, meaning some modules could be used to DoS the bot.
* Sopel 7 will add configuration for flood protection and perhaps reorganize
the logic to reduce silly bugs like this. (See: [#1518][], [#1559][])
* Fixed a few cases where keyboard interrupt (Control + C) wasn't handled
correctly [[#1534][], [#1558][]]
* Fixed invalid `MODE` command sent during connection phase [[#1544][]]
API changes
-----------
* Fixed a regression in testing modules by running them directly [[#1529][]]
* Fixed that `bot` output methods (`say`, `reply`, etc.) would cause errors
during tests if passed certain keyword arguments [[#1538][]]
[#1516]: https://github.com/sopel-irc/sopel/pull/1516
[#1518]: https://github.com/sopel-irc/sopel/pull/1518
[#1520]: https://github.com/sopel-irc/sopel/pull/1520
[#1523]: https://github.com/sopel-irc/sopel/pull/1523
[#1529]: https://github.com/sopel-irc/sopel/pull/1529
[#1534]: https://github.com/sopel-irc/sopel/pull/1534
[#1538]: https://github.com/sopel-irc/sopel/pull/1538
[#1544]: https://github.com/sopel-irc/sopel/pull/1544
[#1549]: https://github.com/sopel-irc/sopel/pull/1549
[#1552]: https://github.com/sopel-irc/sopel/pull/1552
[#1558]: https://github.com/sopel-irc/sopel/pull/1558
[#1559]: https://github.com/sopel-irc/sopel/issues/1559
Changes between 6.6.4 and 6.6.5
===============================
Module changes
--------------
* Fixed url module not cleaning punctuation when auto-titling [[#1515][]]
* Fixed url module's punctuation-cleaning on Python 2 [[#1517][]]
* Fixed `.redditor` command with newer `praw` versions (4.0+) [[#1506][]]
* Reloading modules now runs their `shutdown()` routines [[#1412][]]
[#1412]: https://github.com/sopel-irc/sopel/pull/1412
[#1506]: https://github.com/sopel-irc/sopel/pull/1506
[#1515]: https://github.com/sopel-irc/sopel/pull/1515
[#1517]: https://github.com/sopel-irc/sopel/pull/1517
Changes between 6.6.3 and 6.6.4
===============================
Module changes
--------------
* Replaced `help` pastebin with `clbin.com`
* `ptpb.pw` shut down due to abuse — see [ptpb/pb#246](
https://github.com/ptpb/pb/issues/246) for more
* More news on this front (reducing Sopel's dependence on specific pastebins)
in a future release. Several ideas are under consideration.
* Cleaned up code in `instagram` and `unicode` modules
* Core modules now use `bot.channels` instead of deprecated `bot.privileges`
Core changes
------------
* Privilege tracking now always updates both `bot.channels` & `bot.privileges`,
where before some handlers only updated one or the other
* This *should* have zero effect on behavior, but do report any observed.
Changes between 6.6.2 and 6.6.3
===============================
Module changes
--------------
* Fixed loading etymology module on Python 3.3
* Added Unicode support to calc module's `.py` output
* Correctly quote URL parameters in etymology and search modules
Core changes
------------
* Added docstrings to the privilege level constants in `sopel.module`
Changes between 6.6.1 and 6.6.2
===============================
Module changes
--------------
* wiktionary tries harder to get a valid result before erroring out
Core changes
------------
* Fixed an inconsistency between interpretations of the `--config` option in
normal operation vs. wizard mode
* Requirement specifiers tightened up to reduce/prevent `pip` trying to install
incompatible dependency versions (`IPython`, `dnspython`)
* SASL token is now split when required according to spec
* Multi-byte Unicode characters are now handled correctly when splitting lines
Changes between 6.6.0 and 6.6.1
===============================
Module changes
--------------
* spellcheck's `pyenchant` dependency is no longer required for py3.7+
* This should alleviate a lot of installation problems due to `pyenchant`
being unmaintained. If use of the spellcheck module is desired, the
necessary libraries may be installed manually.
Changes between 6.5.3 and 6.6.0
===============================
Sopel 6.6.0 has been a long time coming, but it contains a metric ton of fixes
and enhancements. The big stuff is yet to come in Sopel 7, though; stay tuned!
(You can get some hints by browsing the [GitHub milestones][].)
View and contribute toward Sopel's budgetary needs by visiting the project's
new [Open Collective page](https://opencollective.com/sopel).
Now that Sopel 6.6.0 is released, the focus will shift from preparing the new
release to migrating the website and documentation off of Embolalia's personal
infrastructure. Once this migration is complete, Sopel's [documentation][docs]
will be updated to reflect the changes/additions listed below. Questions about
the new (and old) API methods are welcome in [#sopel][] on Freenode, of course,
as always. Thank you for bearing with this transitional period!
Importantly, a couple of broken modules have been removed in this release. For
easy reference, they and their PyPI-installable replacements are listed near
the top of the "[Module changes](#module-changes)" section.
Because this is the last release planned before Sopel 7, it's important to note
some upcoming changes. They're mostly for module developers, or for bot owners
who run unmaintained third-party modules (which might need manual updating).
But first, a user-facing change. Sopel is drifting toward a more streamlined
release model, which will see most of the core module library split out into
separate packages. Moving modules to their own packages will enable faster
fixes when APIs change, and easier module adoption by members of the community.
Further process details will appear in future changelogs as modules are moved
out of core, but the plan is to have Sopel "require" modules it used to include
for a release or two after their removal. Existing installations should thereby
have a smooth transition, as long as they get updated reasonably often. To
discuss this plan, visit issue [#1291][].
And now, for the developer stuff.
There will be some attention given to how `Identifier` objects work in Sopel 7.
In particular, the way lowercase works appears to have been wrong for some
time. Subscribe to issue [#1389][] for updates, or to join the discussion on
the best plan for addressing this.
Also in Sopel 7, the following deprecated functions in `sopel.web` will be
removed: `get()`, `head()`, `post()`, `get_urllib_object()`. Module authors