• Scripts
• Unofficial scripts
• Python 3

Why a transition to Python 3?

Python 2.x is legacy; it has an end-of-life set for 2020.
Python 3.x is the present and future of the language. Version 3.0 was released on Dec 3, 2008 (16 years ago).

Python 3 has many new exciting features, for example:

• unicode by default
• asyncio
• f-strings
• function annotations
• "breakpoint" function
• …

Support of Python 3 in WeeChat

WeeChat supports Python 3 since version 0.3.7, which was released on Feb 26, 2012 (12 years, 10 months ago).

The support of Python 3 is optional: the WeeChat python plugin can be compiled with Python 2.7 or Python 3.x, but not both at same time.
As of Jun 3, 2018, it is recommended to compile with Python 2.7 because many scripts won't work at all with Python 3.x, while all scripts should run fine with Python 2.7.

To compile with Python 3.x support and enable quick switch between Python 2.7 and 3.x, see: Compile and test with Python 2.7 and 3.x

Transition roadmap

Here is the roadmap for the transition to Python 3 in WeeChat:

Jun 3, 2018

Transition to Python 3 starts.
All scripts that are not yet compatible with both Python 2.7 and Python 3.x can be updated to support both versions (see the status below).
You can help by converting existing scripts (see how to help below).

Jun 16, 2018

An e-mail is sent to the authors of Python scripts which are not compatible with Python 3 (at least they are not marked as compatible in database).
All authors are encouraged to make their scripts compatible with Python 3.x as soon as possible. Help from other people is welcome as well.

Jul 1, 2018

All new scripts must be compatible with both Python 2.7 and Python 3.x.
Script updates are still allowed to be compatible with Python 2.7 only.

Sep 1, 2018

All new scripts as well as script updates must be compatible with both Python 2.7 and Python 3.x.
Scripts must be properly tested with Python 2.7 and a Python 3.x version (if possible the latest stable).

Jul 1, 2019

New versions of WeeChat are compiled with Python 3 by default, which becomes the recommended Python version to use in WeeChat.
All new scripts as well as script updates must still be compatible with Python 2.7 and Python 3.x, time for the users to upgrade to the latest version of WeeChat which is Python 3 only.
Unfortunately, at this date, only 42% of Python scripts (96 out of 226) are compatible with Python 3. Compiling by default with Python 3 should speed up the update of scripts.

Jan 1, 2020

It is the initial end date for the transition.
Unfortunately, at this date, only 46% of Python scripts (103 out of 228) are compatible with Python 3. The end of transition is postponed (see below).

May 1, 2020

All new scripts as well as script updates must be compatible with Python 3.x. Extra support of Python 2.x is optional.

Oct 15, 2022

Starting with WeeChat 3.8, support of Python 2.x has been removed.
Important: at this date, all scripts that are not compatible with Python 3 are disabled: still visible on the scripts list page, but marked as "disabled" and these scripts can not be installed in WeeChat any more.

Transition status

The scripts which are compatible with Python 3 have tag "py3".
Transition status at various dates:

How to help

If possible, the author of script should make the necessary changes to make the script compatible with both Python 2.7 and 3.x.

Here's a list of some resources that can help to port scripts to Python 3:

• https://docs.python.org/3/howto/pyporting.html
• https://python-future.org/compatible_idioms.html

Compile and test with Python 2.7 and 3.x

You can not use Python 2.7 and 3.x at same time in WeeChat, but you could compile both versions of the Python plugin and switch the Python plugin with aliases.

First check that you have both Python 2.7 and 3.x libraries installed to compile WeeChat with both versions.

Compile WeeChat with Python 3.x and install it in home directory. From the cloned git repository:

$ mkdir build
$ cd build
$ cmake .. -DCMAKE_INSTALL_PREFIX=$HOME/dev/weechat -DENABLE_PYTHON3=ON
$ make install
$ mv ~/dev/weechat/lib/weechat/plugins/python.so ~/dev/weechat/python3.so
$ rm -f CMakeCache.txt
$ cmake .. -DCMAKE_INSTALL_PREFIX=$HOME/dev/weechat -DENABLE_PYTHON3=OFF
$ make install

Run WeeChat:

$ ~/dev/weechat/bin/weechat

Check that Python version is 2.7:

/debug libs

Libs:
(…)
  python: 2.7.16rc1

Add aliases to quickly switch between Python 2.7 and 3.x:

/alias add py2 /plugin unload python; /plugin load python
/alias add py3 /plugin unload python; /plugin load ~/dev/weechat/python3.so

Now you can type /py2 or /py3 to switch the Python version.
Note: this unloads all scripts because the Python plugin is reloaded.

To switch to Python 3.x:

/py3

Check that Python version is 3.x:

/debug libs

Libs:
(…)
  python: 3.7.2+