Skip to content

Conversation

@Exirel
Copy link
Contributor

@Exirel Exirel commented Jun 27, 2020

Description

It partially implements the changes required by #1738 but contains only the very bare minimum changes.
I wanted to make sure that it is backward compatible. As a proof, I'll use the current test-suite.

The next steps will include updating Sopel's tests to use sopel.plugin, and to change Sopel's built-in plugins to use sopel.plugin aswell.

Note: I had to add label to the __all__ magic constants to make it work properly. I guess I forgot that part back when I added this decorator.

Edit: Updated the doc and docstrings, because it wouldn't work otherwise. I didn't try to keep old link to the doc of sopel.module. I'm still working on a rewrite of the documentation related to plugins, so this will be probably discussed/taken care of at that point.

Checklist

  • I have read CONTRIBUTING.md
  • I can and do license this contribution under the EFLv2
  • No issues are reported by make qa (runs make quality and make test)
  • I have tested the functionality of the things this change touches

@Exirel Exirel added the Feature label Jun 27, 2020
@Exirel Exirel added this to the 7.1.0 milestone Jun 27, 2020
@Exirel Exirel requested a review from dgw June 27, 2020 12:20
Copy link
Member

@dgw dgw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In addition to minimal feedback on the current PR contents, I looked for other files mentioning "module" that should probably be updated at the same time lest they get forgotten:

  • contrib
    • sopel.cfg (link to module-configuration page)
  • docs
    • source
      • plugin.rst
  • sopel
    • __init__.py
    • coretasks.py
    • irc
      • backends.py
    • modules
      • check/update all
        also look for "Module" instead of "Plugin" in the top-level docstring
    • plugin.py (docstrings & examples that still refer to its old name)
    • tools
      • __init__.py
      • _events.py
      • jobs.py (I think)
    • web.py (or skip it, since it's just a comment and the module is deprecated)
  • test
    • you already knew about these, of course

PRs like this remind me not to pay that much attention to GitHub's contributor stats, because depending on who does them, big renames like this or the one I did with web skew the numbers quite a bit. 😛

@Exirel Exirel requested a review from dgw June 27, 2020 21:45
@Exirel
Copy link
Contributor Author

Exirel commented Jun 27, 2020

Great review, I updated docstrings & strings here and there. It's ready for review!

@lgtm-com
Copy link

lgtm-com bot commented Jun 27, 2020

This pull request introduces 1 alert when merging e961948 into 82ad1b3 - view on LGTM.com

new alerts:

  • 1 for Unused import

Copy link
Member

@dgw dgw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple little details, mostly about the legacy imports left in sopel.module.

@Exirel
Copy link
Contributor Author

Exirel commented Jul 6, 2020

@dgw should be good now.

@Exirel Exirel requested a review from dgw July 6, 2020 13:14
@lgtm-com
Copy link

lgtm-com bot commented Jul 6, 2020

This pull request introduces 1 alert when merging b379c70 into 73e7230 - view on LGTM.com

new alerts:

  • 1 for Unused import

Copy link
Member

@dgw dgw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've gone through the changes since my last review, and decided they're Good Enough™. We already know there will be a follow-up PR to switch things over "for real" to the new plugin name and tweak some other stuff. Squash what you feel like, if anything, and let's :shipit:.

@Exirel Exirel force-pushed the plugins-rename-sopel-module branch from b379c70 to adb4a31 Compare July 11, 2020 20:25
@Exirel
Copy link
Contributor Author

Exirel commented Jul 11, 2020

Thanks. I'm happy with the rebase. Let's move forward (when Travis & LGTM are OK).

@lgtm-com
Copy link

lgtm-com bot commented Jul 11, 2020

This pull request introduces 1 alert when merging adb4a31 into a5a6e2d - view on LGTM.com

new alerts:

  • 1 for Unused import

@dgw
Copy link
Member

dgw commented Jul 11, 2020

1 suppressed* alert, you silly static-analysis tool.

@dgw dgw merged commit a4c2fdd into sopel-irc:master Jul 11, 2020
Exirel added a commit to Exirel/sopel that referenced this pull request Jul 15, 2020
This is a hotfix, this code should have been modified by sopel-irc#1898 and not
merged with this error. My bad.
@Exirel Exirel deleted the plugins-rename-sopel-module branch May 1, 2021 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants