botserver: Allow importing custom bot modules. #523
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aero31aero
added a commit
to aero31aero/zulip
that referenced
this pull request
Aug 28, 2019
This documents the feature added in zulip/python-zulip-api#523.
|
Looks reasonable; is it easy to add a test for it? |
timabbott
reviewed
Aug 28, 2019
| # Wrapper around importutil; see https://stackoverflow.com/a/67692/3909240. | ||
| spec = importlib.util.spec_from_file_location("custom_bot_module", file_path) | ||
| lib_module = importlib.util.module_from_spec(spec) | ||
| spec.loader.exec_module(lib_module) # type: ignore # mypy thinks the `spec` is None in Optional[Loader]. |
There was a problem hiding this comment.
I think you can use assert spec is not None for this. Though what happens if the file path is invalid? We might need code for that.
There was a problem hiding this comment.
This function is called from inside a try-except block, and we print:
except ImportError:
error_message = ("Error: Bot \"{}\" doesn't exist. Please make sure "
"you have set up the botserverrc file correctly.\n".format(bot))There was a problem hiding this comment.
(A slightly related issue in mypy: python/mypy#2420)
I'm working on tests for this, that should add additional checking for our purposes.
timabbott
pushed a commit
to aero31aero/zulip
that referenced
this pull request
Aug 28, 2019
This documents the feature added in zulip/python-zulip-api#523.
aero31aero
added a commit
to aero31aero/zulip
that referenced
this pull request
Aug 29, 2019
This documents the feature added in zulip/python-zulip-api#523.
We can now specify path to a bot's python file as the ini section header in the botserver's config file. For example: [~/Documents/helloworld.py] email=a@b.com key=XXXX site=https://b.com token=XXXX
aero31aero
force-pushed
the
0-botserver-custom-module
branch
from
ee3089c to
602c442
Compare
aero31aero
force-pushed
the
0-botserver-custom-module
branch
from
602c442 to
ba9d901
Compare
|
Added tests, this is ready for review along with zulip/zulip#13090. |
aero31aero
force-pushed
the
0-botserver-custom-module
branch
from
ba9d901 to
9a0bb61
Compare
|
Squashed and merged, thanks @aero31aero! |
timabbott
pushed a commit
to zulip/zulip
that referenced
this pull request
Sep 3, 2019
This documents the feature added in zulip/python-zulip-api#523.
matheuscmelo
pushed a commit
to matheuscmelo/zulip
that referenced
this pull request
Sep 28, 2019
This documents the feature added in zulip/python-zulip-api#523.
YashRE42
pushed a commit
to YashRE42/zulip
that referenced
this pull request
Dec 12, 2019
This documents the feature added in zulip/python-zulip-api#523.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We can now specify path to a bot's python file as the ini section
header in the botserver's config file. For example: