summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorengn33r <engn33r@users.noreply.github.com>2021-06-08 18:20:31 -0400
committerengn33r <engn33r@users.noreply.github.com>2021-06-08 18:20:31 -0400
commita462d459dddaa4bfc66ae34eaf4cf33eb3f79a97 (patch)
tree9bc45591fa354167ee1e6f4de8bad6984bbaf144 /docs
parentd265ede585d3559dd884e49584c195b782d6384e (diff)
downloadwebsocket-client-a462d459dddaa4bfc66ae34eaf4cf33eb3f79a97.tar.gz
Remove numpy for performance boost
Diffstat (limited to 'docs')
-rw-r--r--docs/source/faq.rst14
1 files changed, 8 insertions, 6 deletions
diff --git a/docs/source/faq.rst b/docs/source/faq.rst
index c4642a9..81ee3fa 100644
--- a/docs/source/faq.rst
+++ b/docs/source/faq.rst
@@ -14,12 +14,14 @@ Why is this library slow?
The ``send`` and ``validate_utf8`` methods are very slow in pure Python.
You can disable UTF8 validation in this library (and receive a
performance enhancement) with the ``skip_utf8_validation`` parameter.
-If you want to get better performance, please install both numpy and
-wsaccel, and import them into your project files - these external
-libraries will automatically be used when available. wsaccel
-doubles the speed of UTF8 validation while both numpy and wsaccel
-offer a minor performance boost when masking the payload data as
-part of the ``send`` process.
+If you want to get better performance, install wsaccel. While
+websocket-client does not depend on wsaccel, it will be used if
+available. wsaccel doubles the speed of UTF8 validation and
+offers a very minor 10% performance boost when masking the
+payload data as part of the ``send`` process. Numpy used to
+be a suggested alternative, but
+`issue #687 <https://github.com/websocket-client/websocket-client/issues/687>`_
+found it didn't help.
How to troubleshoot an unclear callback error?
===================================================