weechat-matrix: no module named Logbook

[mjlbach]

Describe the bug

weechat-matrix is not finding Logbook even though it is part of the derivation

A clear and concise description of what the bug is.
         │10:45:58     |   ___       __         ______________        _____
         │10:45:58     |   __ |     / /___________  ____/__  /_______ __  /_
         │10:45:58     |   __ | /| / /_  _ \  _ \  /    __  __ \  __ `/  __/
         │10:45:58     |   __ |/ |/ / /  __/  __/ /___  _  / / / /_/ // /_
         │10:45:58     |   ____/|__/  \___/\___/\____/  /_/ /_/\__,_/ \__/
         │10:45:58     | WeeChat 2.7 [compiled on Feb  4 2020 16:50:43]
         │10:45:58     | - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
         │10:45:58     | Plugins loaded: alias, buflist, charset, exec, fifo, fset, guile, irc, logger, lua, perl, python, relay, ruby, script, spell, tcl, trigger, xfer
         │10:45:58     | python: loading script "/nix/store/hfnvly47a42nww7wl53r2v93yci5fg8z-wee-slack-2.4.0/share/wee_slack.py"
         │10:45:59     | python: registered script "slack", version 2.4.0 (Extends weechat for typing notification/search/etc on slack.com)
         │10:45:59     | Connecting to 1 slack team.
         │10:45:59     | python: loading script "/nix/store/z3mcx3aqcxixc0jp25kclhn9ljp1fl2s-python3.7-weechat-matrix-unstable-2019-11-10/share/matrix.py"
         │10:45:59     | python: stdout/stderr (?): Traceback (most recent call last):
         │10:45:59     | python: stdout/stderr (?):   File "/nix/store/z3mcx3aqcxixc0jp25kclhn9ljp1fl2s-python3.7-weechat-matrix-unstable-2019-11-10/share/matrix.py", line 41, in
         │             | <module>
         │10:45:59     | python: stdout/stderr (?):     import logbook
         │10:45:59     | python: stdout/stderr (?): ModuleNotFoundError: No module named 'logbook'
         │10:45:59 =!= | python: unable to parse file "/nix/store/z3mcx3aqcxixc0jp25kclhn9ljp1fl2s-python3.7-weechat-matrix-unstable-2019-11-10/share/matrix.py"

To Reproduce
Steps to reproduce the behavior:

1. Install weechat/weechat-matrix
2. Run weechat

See the following home-manager config:

{ pkgs, config, ... }:
let 
weechat = pkgs.weechat.override {
  configure = {availablePlugins, ...}: 
  {
    scripts = with pkgs.weechatScripts; [ wee-slack weechat-matrix];
  };
};
in
{
    # home.file.".weechat/python/autoload/notify_send.py".source = 
    #   "${(import ../../nix/sources.nix).weechat-notify-send}/notify_send.py";

    home.file.".weechat/plugins.conf".text = ''
      [var]
      python.slack.auto_open_threads = "true"
      python.slack.background_load_all_history = "true"
      python.slack.channel_name_typing_indicator = "true"
      python.slack.color_buflist_muted_channels = "darkgray"
      python.slack.color_edited_suffix = "095"
      python.slack.color_reaction_suffix = "darkgray"
      python.slack.color_thread_suffix = "lightcyan"
      python.slack.colorize_private_chats = "false"
      python.slack.debug_level = "3"
      python.slack.debug_mode = "false"
      python.slack.distracting_channels = ""
      python.slack.external_user_suffix = "*"
      python.slack.group_name_prefix = "&"
      python.slack.map_underline_to = "_"
      python.slack.migrated = "true"
      python.slack.muted_channels_activity = "personal_highlights"
      python.slack.never_away = "false"
      python.slack.notify_usergroup_handle_updated = "false"
      python.slack.record_events = "false"
      python.slack.render_bold_as = "bold"
      python.slack.render_italic_as = "italic"
      python.slack.send_typing_notice = "true"
      python.slack.server_aliases = ""
      python.slack.shared_name_prefix = "%"
      python.slack.short_buffer_names = "false"
      python.slack.show_buflist_presence = "true"
      python.slack.show_reaction_nicks = "true"
      python.slack.slack_timeout = "20000"
      python.slack.switch_buffer_on_join = "true"
      python.slack.thread_messages_in_channel = "false"
      python.slack.unfurl_auto_link_display = "both"
      python.slack.unfurl_ignore_alt_text = "false"
      python.slack.unhide_buffers_with_activity = "false"
    '';
    #python.slack.slack_api_token = "${config.secrets.slack-term}"
    
    home.packages = [weechat];
  }

Expected behavior
weechat-matrix runs

Metadata

 - system: `"x86_64-darwin"`
 - host os: `Darwin 19.3.0, macOS 10.15.3`
 - multi-user?: `no`
 - sandbox: `no`
 - version: `nix-env (Nix) 2.3.2`
 - channels(michael): `"home-manager, nixpkgs-20.03pre211998.57ed5db343f"`
 - nixpkgs: `/Users/michael/.nix-defexpr/channels/nixpkgs`

Maintainer information:

# a list of nixpkgs attributes affected by the problem
attribute:
# a list of nixos modules affected by the problem
module:

[emilazy]

I think this is not a bug so much as an inadequacy of the current nixpkgs WeeChat infrastructure, per this comment of mine (which also contains instructions on how to (hopefully) get it working).

[Valodim]

Thanks for the hint, @emilazy. I tried with the expression you gave, and got this:

 python: stdout/stderr (?): Traceback (most recent call last):
 python: stdout/stderr (?):   File "/nix/store/b7ijkimgsqwgc9x6n0ccvxna1g5yrvj0-python3.7-weechat-matrix-unstable-2020-01-21/share/matrix.py", line
 55, in <module>
 python: stdout/stderr (?):     from matrix import globals as G
 python: stdout/stderr (?): ModuleNotFoundError: No module named 'matrix'
 python: unable to parse file "/nix/store/b7ijkimgsqwgc9x6n0ccvxna1g5yrvj0-python3.7-weechat-matrix-unstable-2020-01-21/share/matrix.py"

Looks like it can't find the module that's in the weechat-matrix site-packages itself. It does work with this monstrosity:

(availablePlugins.python.withPackages (_: weechat-matrix.propagatedBuildInputs ++ [ weechat-matrix ]))

But boy, that's a pretty rough packaging story :|

[mjlbach]

For future reference, this is what I had to do to get things running. Not sure if there's a cleaner way, or if we should address this from the packaging side, but I'll close for now.

{ pkgs, config, ... }:
let 
  weechat = pkgs.weechat.override {
  configure = {availablePlugins, ...}: with pkgs.weechatScripts;
  {
     plugins = with availablePlugins; [
         (python.withPackages (_: [ weechat-matrix ]))
        ];
    scripts = [ weechat-matrix];
  };
};
in
{
    home.packages = [weechat];
}

[Texou-]

Hi,

Sorry but I am still experiencing this bug. I dont understand the code to fix it: where should I insert it? Can I paste it directly?

Thanks for your help.

Regards

[mjlbach]

I edited to make it more obvious exactly what is necessary

[Texou-]

Many thanks. Sorry again, my programming skills are... nearly 0. Can I paste it in matrix.py anywhere?

Best regards

[mjlbach]

I have no idea how you are configuring your nix system. You need to use the nix expression language to create an override, this is nix, not python. I recommend you read the nixos manual to understand how derivations work, and then once you understand how overriding a package works you will understand what I pasted above.

[Texou-]

oh ok many thanks. Just realized I really did not undertand something. I go on investigating this issue for my own case (simple Debian Linux system).