Skip to content

Commit c783635

Browse files
committed
plugins: don't search in ~/.sopel/modules by default any more
Also reindented the touched docstring to follow our current conventions re: block roles (e.g. `.. seealso::`). Removed unnecessary `list(ListAttribute)` typecast.
1 parent 0ee5974 commit c783635

File tree

2 files changed

+13
-17
lines changed

2 files changed

+13
-17
lines changed

sopel/plugins/__init__.py

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
1414
* extra directories defined in the settings
1515
* homedir's ``plugins`` directory
16-
* homedir's ``modules`` directory
1716
* ``sopel.plugins`` setuptools entry points
1817
* ``sopel_modules``'s subpackages
1918
* ``sopel.modules``'s core plugins
@@ -137,33 +136,30 @@ def enumerate_plugins(settings):
137136
138137
.. seealso::
139138
140-
The find functions used are:
139+
The find functions used are:
141140
142-
* :func:`find_internal_plugins` for internal plugins
143-
* :func:`find_sopel_modules_plugins` for ``sopel_modules.*`` plugins
144-
* :func:`find_entry_point_plugins` for plugins exposed by setuptools
145-
entry points
146-
* :func:`find_directory_plugins` for plugins in ``$homedir/modules``,
147-
``$homedir/plugins``, and in extra directories, as defined by
148-
``settings.core.extra``
141+
* :func:`find_internal_plugins` for internal plugins
142+
* :func:`find_sopel_modules_plugins` for ``sopel_modules.*`` plugins
143+
* :func:`find_entry_point_plugins` for plugins exposed by setuptools
144+
entry points
145+
* :func:`find_directory_plugins` for plugins in ``$homedir/plugins``,
146+
and in extra directories as defined by ``settings.core.extra``
149147
150-
.. versionchanged:: 7.0
148+
.. versionchanged:: 8.0
151149
152-
Previously, plugins were called "modules", so this would load plugins
153-
from the ``$homedir/modules`` directory. Now it also loads plugins
154-
from the ``$homedir/plugins`` directory.
150+
Looks in ``$homedir/plugins`` instead of the ``$homedir/modules``
151+
directory, reflecting Sopel's shift away from calling them "modules".
155152
156153
"""
157154
from_internals = find_internal_plugins()
158155
from_sopel_modules = find_sopel_modules_plugins()
159156
from_entry_points = find_entry_point_plugins()
160157
# load from directories
161158
source_dirs = [
162-
os.path.join(settings.homedir, 'modules'),
163159
os.path.join(settings.homedir, 'plugins'),
164160
]
165161
if settings.core.extra:
166-
source_dirs = source_dirs + list(settings.core.extra)
162+
source_dirs = source_dirs + settings.core.extra
167163

168164
from_directories = [
169165
find_directory_plugins(source_dir)
@@ -205,7 +201,7 @@ def get_usable_plugins(settings):
205201
contains one and only one plugin per unique name, using a specific order:
206202
207203
* extra directories defined in the settings
208-
* homedir's ``modules`` directory
204+
* homedir's ``plugins`` directory
209205
* ``sopel.plugins`` setuptools entry points
210206
* ``sopel_modules``'s subpackages
211207
* ``sopel.modules``'s core plugins

sopel/plugins/handlers.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -374,7 +374,7 @@ class PyFilePlugin(PyModulePlugin):
374374
``__init__.py`` file, and behaves like a :class:`PyModulePlugin`::
375375
376376
>>> from sopel.plugins.handlers import PyFilePlugin
377-
>>> plugin = PyFilePlugin('/home/sopel/.sopel/modules/custom.py')
377+
>>> plugin = PyFilePlugin('/home/sopel/.sopel/plugins/custom.py')
378378
>>> plugin.load()
379379
>>> plugin.name
380380
'custom'

0 commit comments

Comments
 (0)