mirror
/
miguelgrinberg.python-socketio
mirror of https://github.com/miguelgrinberg/python-socketio
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Updated documentation options (Fixes #597)

pull/599/head
Miguel Grinberg 4 years ago
parent
314971c8a0
commit
251fee1763
No known key found for this signature in database GPG Key ID: 36848B262DF5F06C
4 changed files with 71 additions and 26 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      socketio/asyncio_client.py
  2. 67
      socketio/asyncio_server.py
  3. 4
      socketio/client.py
  4. 22
      socketio/server.py

4
socketio/asyncio_client.py
View File

@ -45,6 +45,10 @@ class AsyncClient(client.Client):
:param request_timeout: A timeout in seconds for requests. The default is :param request_timeout: A timeout in seconds for requests. The default is
5 seconds. 5 seconds.
:param http_session: an initialized ``requests.Session`` object to be used
when sending requests to the server. Use it if you
need to add special client options such as proxy
servers, SSL certificates, etc.
:param ssl_verify: ``True`` to verify SSL certificates, or ``False`` to :param ssl_verify: ``True`` to verify SSL certificates, or ``False`` to
skip SSL certificate verification, allowing skip SSL certificate verification, allowing
connections to servers with self signed certificates. connections to servers with self signed certificates.

67
socketio/asyncio_server.py
View File

@ -13,7 +13,7 @@ class AsyncServer(server.Server):
This class implements a fully compliant Socket.IO web server with support This class implements a fully compliant Socket.IO web server with support
for websocket and long-polling transports, compatible with the asyncio for websocket and long-polling transports, compatible with the asyncio
framework on Python 3.5 or newer. framework.
:param client_manager: The client manager instance that will manage the :param client_manager: The client manager instance that will manage the
client list. When this is omitted, the client list client list. When this is omitted, the client list
@ -26,46 +26,75 @@ class AsyncServer(server.Server):
packets. Custom json modules must have ``dumps`` and ``loads`` packets. Custom json modules must have ``dumps`` and ``loads``
functions that are compatible with the standard library functions that are compatible with the standard library
versions. versions.
:param async_handlers: If set to ``True``, event handlers are executed in :param async_handlers: If set to ``True``, event handlers for a client are
separate threads. To run handlers synchronously, executed in separate threads. To run handlers for a
set to ``False``. The default is ``True``. client synchronously, set to ``False``. The default
is ``True``.
:param always_connect: When set to ``False``, new connections are
provisory until the connect handler returns
something other than ``False``, at which point they
are accepted. When set to ``True``, connections are
immediately accepted, and then if the connect
handler returns ``False`` a disconnect is issued.
Set to ``True`` if you need to emit events from the
connect handler and your client is confused when it
receives events before the connection acceptance.
In any other case use the default of ``False``.
:param kwargs: Connection parameters for the underlying Engine.IO server. :param kwargs: Connection parameters for the underlying Engine.IO server.
The Engine.IO configuration supports the following settings: The Engine.IO configuration supports the following settings:
:param async_mode: The asynchronous model to use. See the Deployment :param async_mode: The asynchronous model to use. See the Deployment
section in the documentation for a description of the section in the documentation for a description of the
available options. Valid async modes are "aiohttp". If available options. Valid async modes are "threading",
this argument is not given, an async mode is chosen "eventlet", "gevent" and "gevent_uwsgi". If this
based on the installed packages. argument is not given, "eventlet" is tried first, then
"gevent_uwsgi", then "gevent", and finally "threading".
The first async mode that has all its dependencies
installed is then one that is chosen.
:param ping_interval: The interval in seconds at which the server pings
the client. The default is 25 seconds. For advanced
control, a two element tuple can be given, where
the first number is the ping interval and the second
is a grace period added by the server.
:param ping_timeout: The time in seconds that the client waits for the :param ping_timeout: The time in seconds that the client waits for the
server to respond before disconnecting. server to respond before disconnecting. The default
:param ping_interval: The interval in seconds at which the client pings is 5 seconds.
the server.
:param max_http_buffer_size: The maximum size of a message when using the :param max_http_buffer_size: The maximum size of a message when using the
polling transport. polling transport. The default is 1,000,000
:param allow_upgrades: Whether to allow transport upgrades or not. bytes.
:param allow_upgrades: Whether to allow transport upgrades or not. The
default is ``True``.
:param http_compression: Whether to compress packages when using the :param http_compression: Whether to compress packages when using the
polling transport. polling transport. The default is ``True``.
:param compression_threshold: Only compress messages when their byte size :param compression_threshold: Only compress messages when their byte size
is greater than this value. is greater than this value. The default is
:param cookie: Name of the HTTP cookie that contains the client session 1024 bytes.
id. If set to ``None``, a cookie is not sent to the client. :param cookie: If set to a string, it is the name of the HTTP cookie the
server sends back tot he client containing the client
session id. If set to a dictionary, the ``'name'`` key
contains the cookie name and other keys define cookie
attributes, where the value of each attribute can be a
string, a callable with no arguments, or a boolean. If set
to ``None`` (the default), a cookie is not sent to the
client.
:param cors_allowed_origins: Origin or list of origins that are allowed to :param cors_allowed_origins: Origin or list of origins that are allowed to
connect to this server. Only the same origin connect to this server. Only the same origin
is allowed by default. Set this argument to is allowed by default. Set this argument to
``'*'`` to allow all origins, or to ``[]`` to ``'*'`` to allow all origins, or to ``[]`` to
disable CORS handling. disable CORS handling.
:param cors_credentials: Whether credentials (cookies, authentication) are :param cors_credentials: Whether credentials (cookies, authentication) are
allowed in requests to this server. allowed in requests to this server. The default is
``True``.
:param monitor_clients: If set to ``True``, a background task will ensure :param monitor_clients: If set to ``True``, a background task will ensure
inactive clients are closed. Set to ``False`` to inactive clients are closed. Set to ``False`` to
disable the monitoring task (not recommended). The disable the monitoring task (not recommended). The
default is ``True``. default is ``True``.
:param engineio_logger: To enable Engine.IO logging set to ``True`` or pass :param engineio_logger: To enable Engine.IO logging set to ``True`` or pass
a logger object to use. To disable logging set to a logger object to use. To disable logging set to
``False``. Note that fatal errors are logged even ``False``. The default is ``False``. Note that
when ``engineio_logger`` is ``False``. fatal errors are logged even when
``engineio_logger`` is ``False``.
""" """
def __init__(self, client_manager=None, logger=False, json=None, def __init__(self, client_manager=None, logger=False, json=None,
async_handlers=True, **kwargs): async_handlers=True, **kwargs):

4
socketio/client.py
View File

@ -66,6 +66,10 @@ class Client(object):
:param request_timeout: A timeout in seconds for requests. The default is :param request_timeout: A timeout in seconds for requests. The default is
5 seconds. 5 seconds.
:param http_session: an initialized ``requests.Session`` object to be used
when sending requests to the server. Use it if you
need to add special client options such as proxy
servers, SSL certificates, etc.
:param ssl_verify: ``True`` to verify SSL certificates, or ``False`` to :param ssl_verify: ``True`` to verify SSL certificates, or ``False`` to
skip SSL certificate verification, allowing skip SSL certificate verification, allowing
connections to servers with self signed certificates. connections to servers with self signed certificates.

22
socketio/server.py
View File

@ -54,13 +54,16 @@ class Server(object):
"gevent_uwsgi", then "gevent", and finally "threading". "gevent_uwsgi", then "gevent", and finally "threading".
The first async mode that has all its dependencies The first async mode that has all its dependencies
installed is then one that is chosen. installed is then one that is chosen.
:param ping_interval: The interval in seconds at which the server pings
the client. The default is 25 seconds. For advanced
control, a two element tuple can be given, where
the first number is the ping interval and the second
is a grace period added by the server.
:param ping_timeout: The time in seconds that the client waits for the :param ping_timeout: The time in seconds that the client waits for the
server to respond before disconnecting. The default server to respond before disconnecting. The default
is 60 seconds. is 5 seconds.
:param ping_interval: The interval in seconds at which the client pings
the server. The default is 25 seconds.
:param max_http_buffer_size: The maximum size of a message when using the :param max_http_buffer_size: The maximum size of a message when using the
polling transport. The default is 100,000,000 polling transport. The default is 1,000,000
bytes. bytes.
:param allow_upgrades: Whether to allow transport upgrades or not. The :param allow_upgrades: Whether to allow transport upgrades or not. The
default is ``True``. default is ``True``.
@ -69,9 +72,14 @@ class Server(object):
:param compression_threshold: Only compress messages when their byte size :param compression_threshold: Only compress messages when their byte size
is greater than this value. The default is is greater than this value. The default is
1024 bytes. 1024 bytes.
:param cookie: Name of the HTTP cookie that contains the client session :param cookie: If set to a string, it is the name of the HTTP cookie the
id. If set to ``None``, a cookie is not sent to the client. server sends back tot he client containing the client
The default is ``'io'``. session id. If set to a dictionary, the ``'name'`` key
contains the cookie name and other keys define cookie
attributes, where the value of each attribute can be a
string, a callable with no arguments, or a boolean. If set
to ``None`` (the default), a cookie is not sent to the
client.
:param cors_allowed_origins: Origin or list of origins that are allowed to :param cors_allowed_origins: Origin or list of origins that are allowed to
connect to this server. Only the same origin connect to this server. Only the same origin
is allowed by default. Set this argument to is allowed by default. Set this argument to

Write Preview
Loading…
Cancel
Save