├── .coveragerc ├── .gitignore ├── .gitmodules ├── .idea ├── codeStyleSettings.xml ├── django-tornado-websockets.iml ├── misc.xml └── modules.xml ├── .travis.yml ├── LICENSE ├── MANIFEST.in ├── README.rst ├── clean.sh ├── docs ├── Makefile ├── make.bat └── source │ ├── api.rst │ ├── assets │ └── img │ │ └── django-tornado-websockets_functionning.svg │ ├── conf.py │ ├── django_integration_configuration.rst │ ├── index.rst │ ├── installation.rst │ ├── modules.rst │ └── usage.rst ├── manage.py ├── requirements.txt ├── setup.py ├── testapp ├── __init__.py ├── admin.py ├── apps.py ├── migrations │ └── __init__.py ├── models.py ├── templates │ └── testapp │ │ ├── index.html │ │ └── progress_bar.html ├── tests.py ├── urls.py ├── views.py └── websocket │ ├── __init__.py │ ├── chat.py │ ├── echo.py │ └── module_progressbar.py ├── testsettings.py ├── tornado_websockets ├── __init__.py ├── exceptions.py ├── management │ ├── __init__.py │ └── commands │ │ ├── __init__.py │ │ └── runtornado.py ├── modules │ ├── __init__.py │ ├── module.py │ └── progressbar.py ├── static │ ├── __init__.py │ └── tornado_websockets │ │ ├── modules │ │ ├── tornadowebsocket-es6.js │ │ └── tornadowebsocket.js ├── tests │ ├── __init__.py │ ├── app │ │ ├── __init__.py │ │ └── ws.py │ ├── helpers │ │ ├── __init__.py │ │ ├── helpers.py │ │ ├── websocketbasetest.py │ │ └── websockethandler.py │ ├── modules │ │ ├── __init__.py │ │ └── modules.py │ ├── test_command_runtornado.py │ ├── test_module.py │ ├── test_module_progressbar.py │ ├── test_tornadowrapper.py │ ├── test_websocket.py │ └── test_websockethandler.py ├── tornadowrapper.py ├── websocket.py └── websockethandler.py └── tox.ini /.coveragerc: -------------------------------------------------------------------------------- 1 | [run] 2 | source = 3 | tornado_websockets 4 | 5 | omit = 6 | tornado_websockets/__init__.py 7 | tornado_websockets/exceptions.py 8 | tornado_websockets/**/__init__.py 9 | tornado_websockets/tests/test_*.py 10 | tornado_websockets/tests/app/*.py 11 | tornado_websockets/tests/helpers/*.py 12 | tornado_websockets/tests/modules/*.py -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by .ignore support plugin (hsz.mobi) 2 | ### Python template 3 | /testapp/sample.py 4 | # Byte-compiled / optimized / DLL files 5 | __pycache__/ 6 | *.py[cod] 7 | *$py.class 8 | 9 | # C extensions 10 | *.so 11 | 12 | # Distribution / packaging 13 | .Python 14 | /db.sqlite3 15 | env/ 16 | /drawings 17 | /static 18 | build/ 19 | develop-eggs/ 20 | dist/ 21 | downloads/ 22 | eggs/ 23 | .eggs/ 24 | lib/ 25 | lib64/ 26 | parts/ 27 | sdist/ 28 | var/ 29 | *.egg-info/ 30 | .installed.cfg 31 | *.egg 32 | 33 | # PyInstaller 34 | # Usually these files are written by a python script from a template 35 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 36 | *.manifest 37 | *.spec 38 | 39 | # Installer logs 40 | pip-log.txt 41 | pip-delete-this-directory.txt 42 | 43 | # Unit test / coverage reports 44 | htmlcov/ 45 | .tox/ 46 | .coverage 47 | .coverage.* 48 | .cache 49 | nosetests.xml 50 | coverage.xml 51 | *,cover 52 | .hypothesis/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | 62 | # Flask instance folder 63 | instance/ 64 | 65 | # Scrapy stuff: 66 | .scrapy 67 | 68 | # Sphinx documentation 69 | docs/_build/ 70 | 71 | # PyBuilder 72 | target/ 73 | 74 | # IPython Notebook 75 | .ipynb_checkpoints 76 | 77 | # pyenv 78 | .python-version 79 | 80 | # celery beat schedule file 81 | celerybeat-schedule 82 | 83 | # dotenv 84 | .env 85 | 86 | # virtualenv 87 | venv/ 88 | ENV/ 89 | 90 | # Spyder project settings 91 | .spyderproject 92 | 93 | # Rope project settings 94 | .ropeproject 95 | ### JetBrains template 96 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm 97 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 98 | 99 | # User-specific stuff: 100 | .idea/workspace.xml 101 | .idea/tasks.xml 102 | .idea/dictionaries 103 | .idea/vcs.xml 104 | .idea/jsLibraryMappings.xml 105 | 106 | # Sensitive or high-churn files: 107 | .idea/dataSources.ids 108 | .idea/dataSources.xml 109 | .idea/dataSources.local.xml 110 | .idea/sqlDataSources.xml 111 | .idea/dynamic.xml 112 | .idea/uiDesigner.xml 113 | 114 | # Gradle: 115 | .idea/gradle.xml 116 | .idea/libraries 117 | 118 | # Mongo Explorer plugin: 119 | .idea/mongoSettings.xml 120 | 121 | ## File-based project format: 122 | *.iws 123 | 124 | ## Plugin-specific files: 125 | 126 | # IntelliJ 127 | /out/ 128 | 129 | # mpeltonen/sbt-idea plugin 130 | .idea_modules/ 131 | 132 | # JIRA plugin 133 | atlassian-ide-plugin.xml 134 | 135 | # Crashlytics plugin (for Android Studio and IntelliJ) 136 | com_crashlytics_export_strings.xml 137 | crashlytics.properties 138 | crashlytics-build.properties 139 | fabric.properties 140 | 141 | /.idea/dataSources/ 142 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "tornado_websockets/static/tornado_websockets/dtws-client"] 2 | path = tornado_websockets/static/tornado_websockets/dtws-client 3 | url = https://github.com/Kocal/dtws-client.git 4 | -------------------------------------------------------------------------------- /.idea/codeStyleSettings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 7 | 9 | -------------------------------------------------------------------------------- /.idea/django-tornado-websockets.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 22 | 23 | 25 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 20 | -------------------------------------------------------------------------------- /.idea/modules.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | # We do not use sudo 2 | sudo: false 3 | 4 | # Python versions for matrix 5 | language: python 6 | python: 7 | - "2.7" 8 | - "3.3" 9 | - "3.4" 10 | - "3.5" 11 | - "3.6-dev" 12 | - "nightly" 13 | 14 | # Django versions for matrix 15 | env: 16 | - DJANGO_VERSION='>=1.8,<1.9' 17 | - DJANGO_VERSION='>=1.9a1,<1.10' 18 | - DJANGO_VERSION='>=1.10a1,<1.11' 19 | 20 | # Command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors 21 | install: 22 | - pip install python-coveralls 23 | - pip install Django$DJANGO_VERSION 24 | - pip install -r requirements.txt 25 | - pip install mock --upgrade 26 | # virtualenv>=14.0.0 has dropped Python 3.2 support 27 | - travis_retry pip install "virtualenv<14.0.0" "tox>=1.9" 28 | - travis_retry python setup.py install 29 | 30 | # Command to run tests, e.g. python setup.py test 31 | script: 32 | - export ASYNC_TEST_TIMEOUT=15 33 | - coverage run manage.py test -v 2 --failfast 34 | 35 | # Report to coveralls 36 | after_success: 37 | - coveralls 38 | - pylint tornado_websockets 39 | 40 | matrix: 41 | exclude: 42 | - python: "3.3" 43 | env: DJANGO_VERSION='>=1.9a1,<1.10' 44 | - python: "3.3" 45 | env: DJANGO_VERSION='>=1.10a1,<1.11' 46 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include LICENSE 2 | include README.rst 3 | recursive-include docs * 4 | recursive-include tornado_websockets * 5 | 6 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | 2 | DEPRECATED SINCE DJANGO-CHANNELS, SEE https://github.com/django/channels 3 | ======================================================================== 4 | 5 | django-tornado-websockets 6 | ========================= 7 | 8 | .. image:: https://travis-ci.org/Kocal/django-tornado-websockets.svg?branch=master 9 | :target: https://travis-ci.org/Kocal/django-tornado-websockets 10 | 11 | .. image:: https://coveralls.io/repos/github/Kocal/django-tornado-websockets/badge.svg?branch=master 12 | :target: https://coveralls.io/github/Kocal/django-tornado-websockets?branch=master 13 | 14 | .. image:: https://badge.fury.io/py/django-tornado-websockets.svg 15 | :target: https://badge.fury.io/py/django-tornado-websockets 16 | 17 | Django-tornado-websockets is a useful solution to provide an easy way to use Tornado WebSockets with a Django 18 | application. 19 | 20 | Supported versions 21 | ------------------ 22 | 23 | =================== =================================================================== 24 | Symbol Meaning 25 | =================== =================================================================== 26 | \:white_check_mark: Works like a charm 27 | \:warning: Works even if Python X.Y is not officially supported by Django X.Y 28 | **.** Waiting for Django X.Y release 29 | Django X.Y is not compatible with Python X.Y 30 | =================== =================================================================== 31 | 32 | ====== =================== =================== =================== =================== ========== ========== 33 | Django Python 2.7 Python 3.3 Python 3.4 Python 3.5 Python 3.6 Python 3.7 34 | ====== =================== =================== =================== =================== ========== ========== 35 | 1.8 \:white_check_mark: \:white_check_mark: \:white_check_mark: \:white_check_mark: \:warning: \:warning: 36 | 1.9 \:white_check_mark: \:white_check_mark: \:white_check_mark: \:warning: \:warning: 37 | 1.10 \:white_check_mark: \:white_check_mark: \:white_check_mark: \:warning: \:warning: 38 | 1.11 **.** **.** **.** **.** **.** 39 | 2.0 **.** **.** **.** 40 | ====== =================== =================== =================== =================== ========== ========== 41 | 42 | Documentation 43 | ------------- 44 | 45 | Documentation is available on Read the Docs: 46 | 47 | - Stable: http://django-tornado-websockets.readthedocs.io/en/stable/ 48 | - Latest: http://django-tornado-websockets.readthedocs.io/en/latest/ 49 | - Develop: http://django-tornado-websockets.readthedocs.io/en/develop/ 50 | 51 | But also on my own server: http://docs.kocal.fr/django-tornado-websockets/ 52 | -------------------------------------------------------------------------------- /clean.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | find . -name '*.pyc' -delete 4 | find . -name '__pycache__' -exec rm -r {} + 5 | -------------------------------------------------------------------------------- /docs/Makefile: -------------------------------------------------------------------------------- 1 | # Makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line. 5 | SPHINXOPTS = 6 | SPHINXBUILD = sphinx-build 7 | PAPER = 8 | BUILDDIR = build 9 | 10 | # User-friendly check for sphinx-build 11 | ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) 12 | $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don\'t have Sphinx installed, grab it from http://sphinx-doc.org/) 13 | endif 14 | 15 | # Internal variables. 16 | PAPEROPT_a4 = -D latex_paper_size=a4 17 | PAPEROPT_letter = -D latex_paper_size=letter 18 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source 19 | # the i18n builder cannot share the environment and doctrees with the others 20 | I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source 21 | 22 | .PHONY: help 23 | help: 24 | @echo "Please use \`make ' where is one of" 25 | @echo " html to make standalone HTML files" 26 | @echo " dirhtml to make HTML files named index.html in directories" 27 | @echo " singlehtml to make a single large HTML file" 28 | @echo " pickle to make pickle files" 29 | @echo " json to make JSON files" 30 | @echo " htmlhelp to make HTML files and a HTML help project" 31 | @echo " qthelp to make HTML files and a qthelp project" 32 | @echo " applehelp to make an Apple Help Book" 33 | @echo " devhelp to make HTML files and a Devhelp project" 34 | @echo " epub to make an epub" 35 | @echo " epub3 to make an epub3" 36 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 37 | @echo " latexpdf to make LaTeX files and run them through pdflatex" 38 | @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" 39 | @echo " text to make text files" 40 | @echo " man to make manual pages" 41 | @echo " texinfo to make Texinfo files" 42 | @echo " info to make Texinfo files and run them through makeinfo" 43 | @echo " gettext to make PO message catalogs" 44 | @echo " changes to make an overview of all changed/added/deprecated items" 45 | @echo " xml to make Docutils-native XML files" 46 | @echo " pseudoxml to make pseudoxml-XML files for display purposes" 47 | @echo " linkcheck to check all external links for integrity" 48 | @echo " doctest to run all doctests embedded in the documentation (if enabled)" 49 | @echo " coverage to run coverage check of the documentation (if enabled)" 50 | @echo " dummy to check syntax errors of document sources" 51 | 52 | .PHONY: clean 53 | clean: 54 | rm -rf $(BUILDDIR)/* 55 | 56 | .PHONY: html 57 | html: 58 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 59 | @echo 60 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 61 | 62 | .PHONY: dirhtml 63 | dirhtml: 64 | $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 65 | @echo 66 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 67 | 68 | .PHONY: singlehtml 69 | singlehtml: 70 | $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 71 | @echo 72 | @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 73 | 74 | .PHONY: pickle 75 | pickle: 76 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 77 | @echo 78 | @echo "Build finished; now you can process the pickle files." 79 | 80 | .PHONY: json 81 | json: 82 | $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 83 | @echo 84 | @echo "Build finished; now you can process the JSON files." 85 | 86 | .PHONY: htmlhelp 87 | htmlhelp: 88 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 89 | @echo 90 | @echo "Build finished; now you can run HTML Help Workshop with the" \ 91 | ".hhp project file in $(BUILDDIR)/htmlhelp." 92 | 93 | .PHONY: qthelp 94 | qthelp: 95 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 96 | @echo 97 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 98 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 99 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Django-tornado-websockets.qhcp" 100 | @echo "To view the help file:" 101 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Django-tornado-websockets.qhc" 102 | 103 | .PHONY: applehelp 104 | applehelp: 105 | $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp 106 | @echo 107 | @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." 108 | @echo "N.B. You won't be able to view it unless you put it in" \ 109 | "~/Library/Documentation/Help or install it in your application" \ 110 | "bundle." 111 | 112 | .PHONY: devhelp 113 | devhelp: 114 | $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 115 | @echo 116 | @echo "Build finished." 117 | @echo "To view the help file:" 118 | @echo "# mkdir -p $$HOME/.local/share/devhelp/Django-tornado-websockets" 119 | @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Django-tornado-websockets" 120 | @echo "# devhelp" 121 | 122 | .PHONY: epub 123 | epub: 124 | $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 125 | @echo 126 | @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 127 | 128 | .PHONY: epub3 129 | epub3: 130 | $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 131 | @echo 132 | @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." 133 | 134 | .PHONY: latex 135 | latex: 136 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 137 | @echo 138 | @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 139 | @echo "Run \`make' in that directory to run these through (pdf)latex" \ 140 | "(use \`make latexpdf' here to do that automatically)." 141 | 142 | .PHONY: latexpdf 143 | latexpdf: 144 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 145 | @echo "Running LaTeX files through pdflatex..." 146 | $(MAKE) -C $(BUILDDIR)/latex all-pdf 147 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 148 | 149 | .PHONY: latexpdfja 150 | latexpdfja: 151 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 152 | @echo "Running LaTeX files through platex and dvipdfmx..." 153 | $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja 154 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 155 | 156 | .PHONY: text 157 | text: 158 | $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 159 | @echo 160 | @echo "Build finished. The text files are in $(BUILDDIR)/text." 161 | 162 | .PHONY: man 163 | man: 164 | $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 165 | @echo 166 | @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 167 | 168 | .PHONY: texinfo 169 | texinfo: 170 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 171 | @echo 172 | @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." 173 | @echo "Run \`make' in that directory to run these through makeinfo" \ 174 | "(use \`make info' here to do that automatically)." 175 | 176 | .PHONY: info 177 | info: 178 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 179 | @echo "Running Texinfo files through makeinfo..." 180 | make -C $(BUILDDIR)/texinfo info 181 | @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." 182 | 183 | .PHONY: gettext 184 | gettext: 185 | $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale 186 | @echo 187 | @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." 188 | 189 | .PHONY: changes 190 | changes: 191 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 192 | @echo 193 | @echo "The overview file is in $(BUILDDIR)/changes." 194 | 195 | .PHONY: linkcheck 196 | linkcheck: 197 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 198 | @echo 199 | @echo "Link check complete; look for any errors in the above output " \ 200 | "or in $(BUILDDIR)/linkcheck/output.txt." 201 | 202 | .PHONY: doctest 203 | doctest: 204 | $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 205 | @echo "Testing of doctests in the sources finished, look at the " \ 206 | "results in $(BUILDDIR)/doctest/output.txt." 207 | 208 | .PHONY: coverage 209 | coverage: 210 | $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage 211 | @echo "Testing of coverage in the sources finished, look at the " \ 212 | "results in $(BUILDDIR)/coverage/python.txt." 213 | 214 | .PHONY: xml 215 | xml: 216 | $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml 217 | @echo 218 | @echo "Build finished. The XML files are in $(BUILDDIR)/xml." 219 | 220 | .PHONY: pseudoxml 221 | pseudoxml: 222 | $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml 223 | @echo 224 | @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." 225 | 226 | .PHONY: dummy 227 | dummy: 228 | $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy 229 | @echo 230 | @echo "Build finished. Dummy builder generates no files." 231 | -------------------------------------------------------------------------------- /docs/make.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | 3 | REM Command file for Sphinx documentation 4 | 5 | if "%SPHINXBUILD%" == "" ( 6 | set SPHINXBUILD=sphinx-build 7 | ) 8 | set BUILDDIR=build 9 | set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source 10 | set I18NSPHINXOPTS=%SPHINXOPTS% source 11 | if NOT "%PAPER%" == "" ( 12 | set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% 13 | set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% 14 | ) 15 | 16 | if "%1" == "" goto help 17 | 18 | if "%1" == "help" ( 19 | :help 20 | echo.Please use `make ^` where ^ is one of 21 | echo. html to make standalone HTML files 22 | echo. dirhtml to make HTML files named index.html in directories 23 | echo. singlehtml to make a single large HTML file 24 | echo. pickle to make pickle files 25 | echo. json to make JSON files 26 | echo. htmlhelp to make HTML files and a HTML help project 27 | echo. qthelp to make HTML files and a qthelp project 28 | echo. devhelp to make HTML files and a Devhelp project 29 | echo. epub to make an epub 30 | echo. epub3 to make an epub3 31 | echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter 32 | echo. text to make text files 33 | echo. man to make manual pages 34 | echo. texinfo to make Texinfo files 35 | echo. gettext to make PO message catalogs 36 | echo. changes to make an overview over all changed/added/deprecated items 37 | echo. xml to make Docutils-native XML files 38 | echo. pseudoxml to make pseudoxml-XML files for display purposes 39 | echo. linkcheck to check all external links for integrity 40 | echo. doctest to run all doctests embedded in the documentation if enabled 41 | echo. coverage to run coverage check of the documentation if enabled 42 | echo. dummy to check syntax errors of document sources 43 | goto end 44 | ) 45 | 46 | if "%1" == "clean" ( 47 | for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i 48 | del /q /s %BUILDDIR%\* 49 | goto end 50 | ) 51 | 52 | 53 | REM Check if sphinx-build is available and fallback to Python version if any 54 | %SPHINXBUILD% 1>NUL 2>NUL 55 | if errorlevel 9009 goto sphinx_python 56 | goto sphinx_ok 57 | 58 | :sphinx_python 59 | 60 | set SPHINXBUILD=python -m sphinx.__init__ 61 | %SPHINXBUILD% 2> nul 62 | if errorlevel 9009 ( 63 | echo. 64 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 65 | echo.installed, then set the SPHINXBUILD environment variable to point 66 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 67 | echo.may add the Sphinx directory to PATH. 68 | echo. 69 | echo.If you don't have Sphinx installed, grab it from 70 | echo.http://sphinx-doc.org/ 71 | exit /b 1 72 | ) 73 | 74 | :sphinx_ok 75 | 76 | 77 | if "%1" == "html" ( 78 | %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html 79 | if errorlevel 1 exit /b 1 80 | echo. 81 | echo.Build finished. The HTML pages are in %BUILDDIR%/html. 82 | goto end 83 | ) 84 | 85 | if "%1" == "dirhtml" ( 86 | %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml 87 | if errorlevel 1 exit /b 1 88 | echo. 89 | echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. 90 | goto end 91 | ) 92 | 93 | if "%1" == "singlehtml" ( 94 | %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml 95 | if errorlevel 1 exit /b 1 96 | echo. 97 | echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. 98 | goto end 99 | ) 100 | 101 | if "%1" == "pickle" ( 102 | %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle 103 | if errorlevel 1 exit /b 1 104 | echo. 105 | echo.Build finished; now you can process the pickle files. 106 | goto end 107 | ) 108 | 109 | if "%1" == "json" ( 110 | %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json 111 | if errorlevel 1 exit /b 1 112 | echo. 113 | echo.Build finished; now you can process the JSON files. 114 | goto end 115 | ) 116 | 117 | if "%1" == "htmlhelp" ( 118 | %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp 119 | if errorlevel 1 exit /b 1 120 | echo. 121 | echo.Build finished; now you can run HTML Help Workshop with the ^ 122 | .hhp project file in %BUILDDIR%/htmlhelp. 123 | goto end 124 | ) 125 | 126 | if "%1" == "qthelp" ( 127 | %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp 128 | if errorlevel 1 exit /b 1 129 | echo. 130 | echo.Build finished; now you can run "qcollectiongenerator" with the ^ 131 | .qhcp project file in %BUILDDIR%/qthelp, like this: 132 | echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Django-tornado-websockets.qhcp 133 | echo.To view the help file: 134 | echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Django-tornado-websockets.ghc 135 | goto end 136 | ) 137 | 138 | if "%1" == "devhelp" ( 139 | %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp 140 | if errorlevel 1 exit /b 1 141 | echo. 142 | echo.Build finished. 143 | goto end 144 | ) 145 | 146 | if "%1" == "epub" ( 147 | %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub 148 | if errorlevel 1 exit /b 1 149 | echo. 150 | echo.Build finished. The epub file is in %BUILDDIR%/epub. 151 | goto end 152 | ) 153 | 154 | if "%1" == "epub3" ( 155 | %SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3 156 | if errorlevel 1 exit /b 1 157 | echo. 158 | echo.Build finished. The epub3 file is in %BUILDDIR%/epub3. 159 | goto end 160 | ) 161 | 162 | if "%1" == "latex" ( 163 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex 164 | if errorlevel 1 exit /b 1 165 | echo. 166 | echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. 167 | goto end 168 | ) 169 | 170 | if "%1" == "latexpdf" ( 171 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex 172 | cd %BUILDDIR%/latex 173 | make all-pdf 174 | cd %~dp0 175 | echo. 176 | echo.Build finished; the PDF files are in %BUILDDIR%/latex. 177 | goto end 178 | ) 179 | 180 | if "%1" == "latexpdfja" ( 181 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex 182 | cd %BUILDDIR%/latex 183 | make all-pdf-ja 184 | cd %~dp0 185 | echo. 186 | echo.Build finished; the PDF files are in %BUILDDIR%/latex. 187 | goto end 188 | ) 189 | 190 | if "%1" == "text" ( 191 | %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text 192 | if errorlevel 1 exit /b 1 193 | echo. 194 | echo.Build finished. The text files are in %BUILDDIR%/text. 195 | goto end 196 | ) 197 | 198 | if "%1" == "man" ( 199 | %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man 200 | if errorlevel 1 exit /b 1 201 | echo. 202 | echo.Build finished. The manual pages are in %BUILDDIR%/man. 203 | goto end 204 | ) 205 | 206 | if "%1" == "texinfo" ( 207 | %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo 208 | if errorlevel 1 exit /b 1 209 | echo. 210 | echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. 211 | goto end 212 | ) 213 | 214 | if "%1" == "gettext" ( 215 | %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale 216 | if errorlevel 1 exit /b 1 217 | echo. 218 | echo.Build finished. The message catalogs are in %BUILDDIR%/locale. 219 | goto end 220 | ) 221 | 222 | if "%1" == "changes" ( 223 | %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes 224 | if errorlevel 1 exit /b 1 225 | echo. 226 | echo.The overview file is in %BUILDDIR%/changes. 227 | goto end 228 | ) 229 | 230 | if "%1" == "linkcheck" ( 231 | %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck 232 | if errorlevel 1 exit /b 1 233 | echo. 234 | echo.Link check complete; look for any errors in the above output ^ 235 | or in %BUILDDIR%/linkcheck/output.txt. 236 | goto end 237 | ) 238 | 239 | if "%1" == "doctest" ( 240 | %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest 241 | if errorlevel 1 exit /b 1 242 | echo. 243 | echo.Testing of doctests in the sources finished, look at the ^ 244 | results in %BUILDDIR%/doctest/output.txt. 245 | goto end 246 | ) 247 | 248 | if "%1" == "coverage" ( 249 | %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage 250 | if errorlevel 1 exit /b 1 251 | echo. 252 | echo.Testing of coverage in the sources finished, look at the ^ 253 | results in %BUILDDIR%/coverage/python.txt. 254 | goto end 255 | ) 256 | 257 | if "%1" == "xml" ( 258 | %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml 259 | if errorlevel 1 exit /b 1 260 | echo. 261 | echo.Build finished. The XML files are in %BUILDDIR%/xml. 262 | goto end 263 | ) 264 | 265 | if "%1" == "pseudoxml" ( 266 | %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml 267 | if errorlevel 1 exit /b 1 268 | echo. 269 | echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. 270 | goto end 271 | ) 272 | 273 | if "%1" == "dummy" ( 274 | %SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy 275 | if errorlevel 1 exit /b 1 276 | echo. 277 | echo.Build finished. Dummy builder generates no files. 278 | goto end 279 | ) 280 | 281 | :end 282 | -------------------------------------------------------------------------------- /docs/source/api.rst: -------------------------------------------------------------------------------- 1 | API 2 | === 3 | 4 | WebSocket 5 | --------- 6 | 7 | .. automodule:: tornado_websockets.websocket 8 | 9 | .. autoclass:: WebSocket 10 | .. automethod:: WebSocket.on 11 | .. automethod:: WebSocket.emit 12 | 13 | WebSocketHandler 14 | ---------------- 15 | 16 | .. automodule:: tornado_websockets.websockethandler 17 | 18 | .. autoclass:: WebSocketHandler 19 | .. automethod:: WebSocketHandler.initialize 20 | .. automethod:: WebSocketHandler.on_message 21 | .. automethod:: WebSocketHandler.on_close 22 | .. automethod:: WebSocketHandler.emit 23 | 24 | TornadoWrapper 25 | -------------- 26 | 27 | .. automodule:: tornado_websockets.tornadowrapper 28 | 29 | .. autoclass:: TornadoWrapper 30 | .. automethod:: TornadoWrapper.add_handler 31 | .. automethod:: TornadoWrapper.start_app 32 | .. automethod:: TornadoWrapper.loop 33 | .. automethod:: TornadoWrapper.listen 34 | -------------------------------------------------------------------------------- /docs/source/conf.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | # 4 | # Django-tornado-websockets documentation build configuration file, created by 5 | # sphinx-quickstart on Wed May 4 14:40:21 2016. 6 | # 7 | # This file is execfile()d with the current directory set to its 8 | # containing dir. 9 | # 10 | # Note that not all possible configuration values are present in this 11 | # autogenerated file. 12 | # 13 | # All configuration values have a default; values that are commented out 14 | # serve to show the default. 15 | 16 | import sys 17 | import os 18 | 19 | # If extensions (or modules to document with autodoc) are in another directory, 20 | # add these directories to sys.path here. If the directory is relative to the 21 | # documentation root, use os.path.abspath to make it absolute, like shown here. 22 | sys.path.insert(0, os.path.abspath('../..')) 23 | import django 24 | import tornado_websockets 25 | os.environ['DJANGO_SETTINGS_MODULE'] = 'testsettings' 26 | django.setup() 27 | 28 | # -- General configuration ------------------------------------------------ 29 | 30 | # If your documentation needs a minimal Sphinx version, state it here. 31 | #needs_sphinx = '1.0' 32 | 33 | # Add any Sphinx extension module names here, as strings. They can be 34 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 35 | # ones. 36 | extensions = [ 37 | 'sphinx.ext.autodoc', 38 | 'sphinx.ext.intersphinx', 39 | 'sphinx.ext.todo', 40 | 'sphinx.ext.viewcode' 41 | ] 42 | 43 | # Add any paths that contain templates here, relative to this directory. 44 | templates_path = ['_templates'] 45 | 46 | # The suffix(es) of source filenames. 47 | # You can specify multiple suffix as a list of string: 48 | # source_suffix = ['.rst', '.md'] 49 | source_suffix = '.rst' 50 | 51 | # The encoding of source files. 52 | #source_encoding = 'utf-8-sig' 53 | 54 | # The master toctree document. 55 | master_doc = 'index' 56 | 57 | # General information about the project. 58 | project = 'Django-tornado-websockets' 59 | copyright = '2016, Hugo ALLIAUME' 60 | author = 'Hugo ALLIAUME' 61 | 62 | # The version info for the project you're documenting, acts as replacement for 63 | # |version| and |release|, also used in various other places throughout the 64 | # built documents. 65 | # 66 | # The short X.Y version. 67 | version = '.'.join(tornado_websockets.__version_info__[0:2]) 68 | # The full version, including alpha/beta/rc tags. 69 | release = tornado_websockets.__version__ 70 | 71 | # The language for content autogenerated by Sphinx. Refer to documentation 72 | # for a list of supported languages. 73 | # 74 | # This is also used if you do content translation via gettext catalogs. 75 | # Usually you set "language" from the command line for these cases. 76 | language = None 77 | 78 | # There are two options for replacing |today|: either, you set today to some 79 | # non-false value, then it is used: 80 | #today = '' 81 | # Else, today_fmt is used as the format for a strftime call. 82 | #today_fmt = '%B %d, %Y' 83 | 84 | # List of patterns, relative to source directory, that match files and 85 | # directories to ignore when looking for source files. 86 | # This patterns also effect to html_static_path and html_extra_path 87 | exclude_patterns = [] 88 | 89 | # The reST default role (used for this markup: `text`) to use for all 90 | # documents. 91 | #default_role = None 92 | 93 | # If true, '()' will be appended to :func: etc. cross-reference text. 94 | #add_function_parentheses = True 95 | 96 | # If true, the current module name will be prepended to all description 97 | # unit titles (such as .. function::). 98 | #add_module_names = True 99 | 100 | # If true, sectionauthor and moduleauthor directives will be shown in the 101 | # output. They are ignored by default. 102 | #show_authors = False 103 | 104 | # The name of the Pygments (syntax highlighting) style to use. 105 | pygments_style = 'sphinx' 106 | 107 | # A list of ignored prefixes for module index sorting. 108 | #modindex_common_prefix = [] 109 | 110 | # If true, keep warnings as "system message" paragraphs in the built documents. 111 | #keep_warnings = False 112 | 113 | # If true, `todo` and `todoList` produce output, else they produce nothing. 114 | todo_include_todos = True 115 | 116 | 117 | # -- Options for HTML output ---------------------------------------------- 118 | 119 | # The theme to use for HTML and HTML Help pages. See the documentation for 120 | # a list of builtin themes. 121 | html_theme = 'sphinx_rtd_theme' 122 | 123 | # Theme options are theme-specific and customize the look and feel of a theme 124 | # further. For a list of options available for each theme, see the 125 | # documentation. 126 | #html_theme_options = {} 127 | 128 | # Add any paths that contain custom themes here, relative to this directory. 129 | #html_theme_path = [] 130 | 131 | # The name for this set of Sphinx documents. 132 | # " v documentation" by default. 133 | #html_title = 'Django-tornado-websockets v0.0.2' 134 | 135 | # A shorter title for the navigation bar. Default is the same as html_title. 136 | #html_short_title = None 137 | 138 | # The name of an image file (relative to this directory) to place at the top 139 | # of the sidebar. 140 | #html_logo = None 141 | 142 | # The name of an image file (relative to this directory) to use as a favicon of 143 | # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 144 | # pixels large. 145 | #html_favicon = None 146 | 147 | # Add any paths that contain custom static files (such as style sheets) here, 148 | # relative to this directory. They are copied after the builtin static files, 149 | # so a file named "default.css" will overwrite the builtin "default.css". 150 | html_static_path = ['_static'] 151 | 152 | # Add any extra paths that contain custom files (such as robots.txt or 153 | # .htaccess) here, relative to this directory. These files are copied 154 | # directly to the root of the documentation. 155 | #html_extra_path = [] 156 | 157 | # If not None, a 'Last updated on:' timestamp is inserted at every page 158 | # bottom, using the given strftime format. 159 | # The empty string is equivalent to '%b %d, %Y'. 160 | #html_last_updated_fmt = None 161 | 162 | # If true, SmartyPants will be used to convert quotes and dashes to 163 | # typographically correct entities. 164 | #html_use_smartypants = True 165 | 166 | # Custom sidebar templates, maps document names to template names. 167 | #html_sidebars = {} 168 | 169 | # Additional templates that should be rendered to pages, maps page names to 170 | # template names. 171 | #html_additional_pages = {} 172 | 173 | # If false, no module index is generated. 174 | #html_domain_indices = True 175 | 176 | # If false, no index is generated. 177 | #html_use_index = True 178 | 179 | # If true, the index is split into individual pages for each letter. 180 | #html_split_index = False 181 | 182 | # If true, links to the reST sources are added to the pages. 183 | #html_show_sourcelink = True 184 | 185 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 186 | #html_show_sphinx = True 187 | 188 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 189 | #html_show_copyright = True 190 | 191 | # If true, an OpenSearch description file will be output, and all pages will 192 | # contain a tag referring to it. The value of this option must be the 193 | # base URL from which the finished HTML is served. 194 | #html_use_opensearch = '' 195 | 196 | # This is the file name suffix for HTML files (e.g. ".xhtml"). 197 | #html_file_suffix = None 198 | 199 | # Language to be used for generating the HTML full-text search index. 200 | # Sphinx supports the following languages: 201 | # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' 202 | # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' 203 | #html_search_language = 'en' 204 | 205 | # A dictionary with options for the search language support, empty by default. 206 | # 'ja' uses this config value. 207 | # 'zh' user can custom change `jieba` dictionary path. 208 | #html_search_options = {'type': 'default'} 209 | 210 | # The name of a javascript file (relative to the configuration directory) that 211 | # implements a search results scorer. If empty, the default will be used. 212 | #html_search_scorer = 'scorer.js' 213 | 214 | # Output file base name for HTML help builder. 215 | htmlhelp_basename = 'Django-tornado-websocketsdoc' 216 | 217 | # -- Options for LaTeX output --------------------------------------------- 218 | 219 | latex_elements = { 220 | # The paper size ('letterpaper' or 'a4paper'). 221 | #'papersize': 'letterpaper', 222 | 223 | # The font size ('10pt', '11pt' or '12pt'). 224 | #'pointsize': '10pt', 225 | 226 | # Additional stuff for the LaTeX preamble. 227 | #'preamble': '', 228 | 229 | # Latex figure (float) alignment 230 | #'figure_align': 'htbp', 231 | } 232 | 233 | # Grouping the document tree into LaTeX files. List of tuples 234 | # (source start file, target name, title, 235 | # author, documentclass [howto, manual, or own class]). 236 | latex_documents = [ 237 | (master_doc, 'Django-tornado-websockets.tex', 'Django-tornado-websockets Documentation', 238 | 'Hugo ALLIAUME', 'manual'), 239 | ] 240 | 241 | # The name of an image file (relative to this directory) to place at the top of 242 | # the title page. 243 | #latex_logo = None 244 | 245 | # For "manual" documents, if this is true, then toplevel headings are parts, 246 | # not chapters. 247 | #latex_use_parts = False 248 | 249 | # If true, show page references after internal links. 250 | #latex_show_pagerefs = False 251 | 252 | # If true, show URL addresses after external links. 253 | #latex_show_urls = False 254 | 255 | # Documents to append as an appendix to all manuals. 256 | #latex_appendices = [] 257 | 258 | # If false, no module index is generated. 259 | #latex_domain_indices = True 260 | 261 | 262 | # -- Options for manual page output --------------------------------------- 263 | 264 | # One entry per manual page. List of tuples 265 | # (source start file, name, description, authors, manual section). 266 | man_pages = [ 267 | (master_doc, 'django-tornado-websockets', 'Django-tornado-websockets Documentation', 268 | [author], 1) 269 | ] 270 | 271 | # If true, show URL addresses after external links. 272 | #man_show_urls = False 273 | 274 | 275 | # -- Options for Texinfo output ------------------------------------------- 276 | 277 | # Grouping the document tree into Texinfo files. List of tuples 278 | # (source start file, target name, title, author, 279 | # dir menu entry, description, category) 280 | texinfo_documents = [ 281 | (master_doc, 'Django-tornado-websockets', 'Django-tornado-websockets Documentation', 282 | author, 'Django-tornado-websockets', 'One line description of project.', 283 | 'Miscellaneous'), 284 | ] 285 | 286 | # Documents to append as an appendix to all manuals. 287 | #texinfo_appendices = [] 288 | 289 | # If false, no module index is generated. 290 | #texinfo_domain_indices = True 291 | 292 | # How to display URL addresses: 'footnote', 'no', or 'inline'. 293 | #texinfo_show_urls = 'footnote' 294 | 295 | # If true, do not generate a @detailmenu in the "Top" node's menu. 296 | #texinfo_no_detailmenu = False 297 | -------------------------------------------------------------------------------- /docs/source/django_integration_configuration.rst: -------------------------------------------------------------------------------- 1 | Django integration and configuration 2 | ==================================== 3 | 4 | .. contents:: 5 | :local: 6 | :backlinks: none 7 | 8 | Integration 9 | ----------- 10 | 11 | In your ``settings.py`` file, you need to add ``tornado_websockets`` to your Django ``INSTALLED_APPS`` : 12 | 13 | .. code-block:: python 14 | 15 | INSTALLED_APPS = [ 16 | # ... 17 | 'tornado_websockets', 18 | ] 19 | 20 | Configuration 21 | ------------- 22 | 23 | Since we use Tornado as a replacement of a WSGI server (Gunicorn, uWSGI, ...), you need to configure it a bit before 24 | using ``django-tornado-websockets``. 25 | 26 | Basic configuration 27 | ^^^^^^^^^^^^^^^^^^^ 28 | 29 | You can provide a Tornado configuration in your ``settings.py`` file like this: 30 | 31 | .. code-block:: python 32 | 33 | # At the end of settings.py file 34 | 35 | TORNADO = { 36 | 'port': 1337, # 8000 by default 37 | 'handlers': [], # [] by default 38 | 'settings': {}, # {} by default 39 | } 40 | 41 | 1. ``port`` is the port which Tornado main loop will listen for its ``HTTPServer``, 42 | 2. ``handlers`` is a list of tuples where you can make a link between a route and an handler, 43 | 3. ``settings`` is a dictionary used to customize various aspects of Tornado (autoreload, debug, ...). 44 | 45 | Read more about Tornado ``handlers`` and ``settings`` in the Tornado documentation: `Application configuration `_ 46 | 47 | Django support 48 | ^^^^^^^^^^^^^^ 49 | 50 | To makes Django work with Tornado, you need to add a new handler to Tornado configuration. 51 | Tornado can `runs WSGI apps `_ 52 | (like Django) by using ``tornado.wsgi.WSGIContainer``, and we provide an already defined Django WSGI app that you can 53 | easily use. 54 | 55 | You can also make your own Django WSGI app using the `tornado_websockets/__init__.py `_ 56 | file. 57 | 58 | .. code-block:: python 59 | 60 | import tornado_websockets 61 | 62 | # ... 63 | 64 | TORNADO = { 65 | # ... 66 | 'handlers': [ 67 | # ... 68 | tornado_websockets.django_app(), # django_app is using a "wildcard" route, so it should be the last element 69 | ], 70 | } 71 | 72 | Static files support 73 | ^^^^^^^^^^^^^^^^^^^^ 74 | 75 | If you need static files support during your development (so you are not running a configured nginx/Apache for static 76 | files), you can add another handler to your configuration: 77 | 78 | .. code-block:: python 79 | 80 | import tornado.web 81 | 82 | # ... 83 | 84 | # Django specific configuration about static files 85 | STATIC_URL = '/static/' 86 | STATIC_ROOT = os.path.join(BASE_DIR, 'static') 87 | 88 | TORNADO = { 89 | # ... 90 | 'handlers': [ 91 | (r'%s(.*)' % STATIC_URL, tornado.web.StaticFileHandler, {'path': STATIC_ROOT}), 92 | # ... 93 | ] 94 | } 95 | 96 | Additional settings 97 | ^^^^^^^^^^^^^^^^^^^ 98 | 99 | You can pass additional settings to Tornado with ``TORNADO['settings']`` dictionary. 100 | For example, it can be useful to set ``'debug': True`` row if you are still in a development phase: 101 | 102 | .. code-block:: python 103 | 104 | TORNADO = { 105 | # ... 106 | 'settings': { 107 | 'debug': True, 108 | } 109 | } 110 | -------------------------------------------------------------------------------- /docs/source/index.rst: -------------------------------------------------------------------------------- 1 | .. Django-tornado-websockets documentation master file, created by 2 | sphinx-quickstart on Wed May 4 14:40:21 2016. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | Django-tornado-websockets's documentation 7 | ========================================= 8 | 9 | Django-tornado-websockets is a useful solution to provide an easy way to use 10 | `Tornado WebSockets `_ with a 11 | `Django `_ application. 12 | 13 | .. Important:: 14 | Django-tornado-websockets is actually in **alpha version**! 15 | 16 | ------------------------------------------------------------------------------- 17 | 18 | Architecture 19 | ------------ 20 | 21 | .. figure:: assets/img/django-tornado-websockets_functionning.svg 22 | :align: center 23 | :width: 100% 24 | :alt: Example of an architecture using Tornado as WSGI server, Django and django-tornado-websockets 25 | 26 | Example of an architecture using Tornado as WSGI server, Django and django-tornado-websockets 27 | 28 | To use django-tornado-websockets's WebSockets, you should use **Tornado as a WSGI server** where you will define 29 | handlers to *handle* an incoming request. Since we already have a WSGI server, it's probably useless to try running 30 | `Gunicorn `_ or `uWSGI `_ as WSGI server. 31 | You can try to wrap Tornado **WSGI server** into Gunicorn/uWSGI **WSGI server** but... It's a bit retarded I think 32 | ``(・_・ヾ``... 33 | 34 | Let's explain this diagram: 35 | 36 | 1. The client make a request to our web server with his web browser, 37 | 2. Our web server (`nginx `_, `Apache `_, ...) pass this WSGI or WebSocket 38 | request to Tornado [#f1]_, 39 | 3. If it is a *WebSocket request*, we pass it to ``tornado.websocket``, otherwise it's Django that will handle this 40 | request, 41 | 4. We wait for a *WebSocket response* or a Django response, 42 | 5. and 6. Then we return this response to the client. 43 | 44 | .. [#f1] I forgot it on the diagram, but nginx or Apache has the job to deliver static files, it's not Tornado's work 45 | 46 | ----------------------------------------------------------------------------------------- 47 | 48 | Documentation 49 | ------------- 50 | 51 | .. toctree:: 52 | :maxdepth: 3 53 | :numbered: 54 | 55 | installation 56 | django_integration_configuration 57 | usage 58 | modules 59 | api 60 | -------------------------------------------------------------------------------- /docs/source/installation.rst: -------------------------------------------------------------------------------- 1 | Installation 2 | ============ 3 | 4 | Automatic installation 5 | ---------------------- 6 | 7 | .. code-block:: bash 8 | 9 | $ pip install django-tornado-websockets 10 | 11 | # In your Django project 12 | $ python manage.py collectstatic 13 | 14 | Manual installation 15 | ------------------- 16 | 17 | .. code-block:: bash 18 | 19 | $ git clone --recursive https://github.com/Kocal/django-tornado-websockets.git 20 | $ cd django-tornado-websockets 21 | $ python setup.py install 22 | 23 | # In your Django project 24 | $ python manage.py collectstatic -------------------------------------------------------------------------------- /docs/source/modules.rst: -------------------------------------------------------------------------------- 1 | Modules 2 | ======= 3 | 4 | .. automodule:: tornado_websockets.modules 5 | 6 | Module 7 | ------ 8 | 9 | .. autoclass:: Module 10 | 11 | 12 | Progress bar 13 | ------------ 14 | 15 | The module « ProgressBar » facilitate the communication between the server-side and client-side of a progression bar. 16 | 17 | **Server-side**: 18 | 19 | - An easier communication with client-side ProgressBar module 20 | - Handle *init*, *update* and *done* events, 21 | - Update current progression value with :py:meth:`~.tick()` or :py:meth:`~.reset()` 22 | 23 | **Client-side**: 24 | 25 | - An easier communication with server-side ProgressBar module, 26 | - Handle *init*, *update* and *done* events, 27 | - Rendering a progression bar by using `HTML5` or `Bootstrap` rendering. 28 | 29 | Server-side 30 | ^^^^^^^^^^^ 31 | 32 | Construction 33 | ............ 34 | 35 | .. autoclass:: ProgressBar 36 | 37 | Methods 38 | ....... 39 | 40 | .. automethod:: ProgressBar.reset 41 | .. automethod:: ProgressBar.tick 42 | .. automethod:: ProgressBar.is_done 43 | 44 | Events 45 | ...... 46 | 47 | .. automethod:: ProgressBar.on 48 | .. automethod:: ProgressBar.emit_init 49 | .. automethod:: ProgressBar.emit_update 50 | .. automethod:: ProgressBar.emit_done 51 | 52 | Example 53 | ....... 54 | 55 | .. code-block:: python 56 | 57 | from tornado import gen 58 | 59 | from tornado_websockets.modules import ProgressBar 60 | from tornado_websockets.websocket import WebSocket 61 | 62 | ws = WebSocket('module_progressbar') 63 | progressbar = ProgressBar('foo', min=0, max=100) 64 | 65 | ws.bind(progressbar) 66 | 67 | 68 | @progressbar.on 69 | def reset(): 70 | progressbar.reset() 71 | 72 | 73 | @progressbar.on 74 | @gen.engine # Make this function asynchronous for Tornado's IOLoop 75 | def start(): 76 | for value in range(0, progressbar.max): 77 | yield gen.sleep(.1) # like time.sleep(), but asynchronous with @gen.engine 78 | progressbar.tick(label="[%d/%d] Tâche %d terminée" % (progressbar.current + 1, progressbar.max, value)) 79 | 80 | 81 | Client-side 82 | ^^^^^^^^^^^ 83 | 84 | Read documentation about ProgressBar client-side module `here `_. 85 | -------------------------------------------------------------------------------- /docs/source/usage.rst: -------------------------------------------------------------------------------- 1 | Usage 2 | ===== 3 | 4 | .. contents:: 5 | :local: 6 | :backlinks: none 7 | 8 | Run Tornado server 9 | ------------------ 10 | 11 | Django-tornado-websockets provides an easy solution to run your Tornado server. When you add ``tornado_websockets`` 12 | to your ``INSTALLED_APPS``, you obtain a new management command called ``runtornado``: 13 | 14 | .. code-block:: bash 15 | 16 | $ python manage.py runtornado 17 | 18 | Using WebSockets (server side) 19 | ------------------------------ 20 | 21 | It's preferable to write your WebSocket applications in your ``views.py`` file, or import these in ``views.py``. 22 | 23 | Create a WebSocket application 24 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 25 | 26 | You should use the :class:`~tornado_websockets.websocket.WebSocket` class to use... WebSockets 🤔. 27 | It takes only one parameter and it's the ``path``. This path should be unique because it's automatically adding a new 28 | handler to Tornado handlers (``your_path <=> your_websocket``): 29 | 30 | .. code-block:: python 31 | 32 | from tornado_websockets.websocket import WebSocket 33 | 34 | # Make a new instance of WebSocket and automatically add handler '/ws/my_ws' to Tornado handlers 35 | my_ws = WebSocket('/my_ws') 36 | 37 | 38 | .. note:: 39 | If you are using this decorator on a class method (a wild ``self`` parameter appears!), you need to define a 40 | context for the WebSocket instance because ``@my_ws.on`` decorator can not know by itself what value ``self`` 41 | should take (or maybe I am doing it wrong?): 42 | 43 | .. code-block:: python 44 | 45 | class MyClass(object): 46 | 47 | def __init__(self): 48 | my_ws.context = self 49 | 50 | Receive an event from a client 51 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 52 | 53 | To listen an incoming event, you should use the ``@my_ws.on`` decorator (where ``my_ws`` is an instance of 54 | :class:`~tornado_websockets.websocket.WebSocket`) on a function or a class method. 55 | 56 | Functions and class methods **should take two named parameters**: 57 | 58 | - ``socket``: client who sent the event (instance of :class:`~tornado_websockets.websockethandler.WebSocketHandler`), 59 | - ``data``: data sent by the client (dictionary). 60 | 61 | **Usage example:** 62 | 63 | .. code-block:: python 64 | 65 | # On a function 66 | @my_ws.on 67 | def my_event(socket, data): 68 | print('Catch "my_event" event from a client') 69 | print('But I know this client, it is the one using this websocket connection: %s' % socket) 70 | 71 | 72 | # On a class method 73 | class MyClass(object): 74 | 75 | def __init__(self): 76 | # Do not forget the context, otherwise the `self` value for all class methods decorated by `@my_ws.on` 77 | # decorator will be `None` 78 | my_ws.context = self 79 | 80 | @wy_ws.on 81 | def my_other_event(self, socket, data): 82 | # `self` value is a MyClass instance due to `my_ws.context = self` in `__init__()` method 83 | print('Catch "my_other_event" from a client') 84 | print('And same as before, I know that this client is using this websocket connection: %s' % socket) 85 | 86 | .. _emit-an-event: 87 | 88 | Send an event to a client 89 | ^^^^^^^^^^^^^^^^^^^^^^^^^ 90 | 91 | .. warning:: 92 | You can only emit an event in a function or method decorated by ``@my_ws.on`` decorator. 93 | 94 | There is three ways to emit an event: 95 | 96 | 1. For **all clients connected to your WebSocket application**, you should use ``my_ws.emit`` method, 97 | 2. For **the client who just sent an event**, you should use ``socket.emit`` method, 98 | 3. For **a specific client**, it's not officially implemented but you can take a look at ``my_ws.handlers``. 99 | It's a :class:`~tornado_websockets.websockethandler.WebSocketHandler` list and represents all clients connected to 100 | your application, so you can use ``my_ws.handlers[0].emit`` method. 101 | 102 | **Usage example (echo server):** 103 | 104 | .. code-block:: python 105 | 106 | from tornado_websockets.websocket import WebSocket 107 | 108 | ws_echo = WebSocket('/echo') 109 | 110 | @ws_echo.on 111 | def open(socket): 112 | # Notify all clients about a new connection 113 | ws_echo.emit('new_connection') 114 | 115 | @ws_echo.on 116 | def message(socket, data): 117 | # Reply to the client 118 | socket.emit('message', data) 119 | 120 | # Wow we got a spammer, let's inform the first client :^) 121 | if 'spam' in data.message: 122 | # wow 123 | ws_echo[0].emit('got_spam', { 124 | 'message': data.get('message'), 125 | 'socket': socket 126 | }) 127 | 128 | For more examples, you can read `testapp/views.py `_ file. 130 | 131 | Using WebSockets (client side) 132 | ------------------------------ 133 | 134 | Django-tornado-websockets uses its own wrapper for using JavaScript WebSocket in client-side: `django-tornado-websockets-client 135 | `_. By using this wrapper, you will be able to write: 136 | 137 | .. code-block:: javascript 138 | 139 | var ws = new TornadoWebSocket(...); 140 | 141 | ws.on('open', () => { 142 | ws.emit('my_event', { foo: 'bar' }); 143 | }); 144 | 145 | // instead of 146 | var ws = new WebSocket(...); 147 | 148 | ws.onopen = () => { 149 | ws.send({ event: 'my_event', data: { foo: 'bar' }}); 150 | }; 151 | 152 | But you can simply ignore this wrapper and use `raw WebSocket `_ 153 | if you want. Just remember that data passed by Django-tornado-websockets are in JSON: ``{event: 'evt', data: {}}``. 154 | 155 | ---------------------------------------------------------------------------------------------------------------------- 156 | 157 | Linking JS wrapper into your Django template 158 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 159 | 160 | Link ``django-tornado-websockets-client.js`` (symbolic link to `main.min.js `_) file in your Django template: 162 | 163 | .. code-block:: html+django 164 | 165 | {% load static %} 166 | 167 | 168 | Create a WebSocket connection 169 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 170 | 171 | There is three ways to create a WebSocket connection: 172 | 173 | .. code-block:: javascript 174 | 175 | var ws = new TornadoWebSocket(path, options); 176 | var ws = TornadoWebSocket(path, options); // shortcut to new TornadoWebSocket(path, options) 177 | var ws = tws(path, options); // shortcut to new TornadoWebSocket(path, options) 178 | 179 | .. js:class:: TornadoWebSocket(String path, Object options) 180 | 181 | Initialize a new WebSocket object with given options. 182 | 183 | **Parameters:** 184 | 185 | - ``path``: same value than ``path`` parameter from :class:`~tornado_websockets.websocket.WebSocket`, see 186 | `create websocket application `_, 188 | - ``options.host``: host used for connection (default: ``'localhost'``, but soon ``window.location``) 189 | - ``options.port``: port used for connection (default: ``8000``) 190 | - ``options.secure``: ``true`` for using a secure connection (default: ``false``) 191 | 192 | Receive an event from the server 193 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 194 | 195 | You can listen to WebSocket's events ``onopen``, ``onclose`` and ``onerror`` (``onmessage`` too but you will rewrite 196 | a core part). 197 | You can also listen to your own events like ``my_event``, ``user_joined``, etc... 198 | 199 | .. js:function:: TornadoWebSocket.on(String event, Function callback) 200 | 201 | Bind a function to an event. 202 | 203 | **Parameters:** 204 | 205 | - ``event``: Event name 206 | - ``callback``: Function to execute when event ``event`` is received 207 | 208 | .. code-block:: javascript 209 | 210 | // Bind to WebSocket.onopen 211 | ws.on('open', event => { 212 | console.log('Connection: OPEN', event); 213 | 214 | // Add an event/callback combination into TornadoWebSocket.events private object. 215 | // Will be called when we receive a JSON like that: {event: 'my_event', data: {...}} 216 | ws.on('my_event', data => { 217 | console.log('Got data from « my_event »', data); 218 | }); 219 | }); 220 | 221 | // Bind to WebSocket.onclose 222 | ws.on('close', event => { 223 | console.log('Connection: ERROR', event); 224 | }); 225 | 226 | // Bind to WebSocket.onerror 227 | ws.on('error', event => { 228 | console.log('Connection: CLOSED', event); 229 | }); 230 | 231 | Send an event to the server 232 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^ 233 | 234 | .. js:function:: TornadoWebSocket.emit(String event, Object|* data) 235 | 236 | Send a pair event/data to the server. 237 | 238 | **Parameters:** 239 | 240 | - ``event``: Event name 241 | - ``data``: Data to send, can be an ``Object``, not an ``Object`` (will be replaced by 242 | ``{ data: { message: data }}``, or ``undefined`` (will be replaced by ``{}``) 243 | 244 | .. code-block:: javascript 245 | 246 | ws.on('open', event => { 247 | ws.emit('my_event'); // will send {} 248 | 249 | ws.emit('my_event', 'My message'); // will send {message: 'My message'} 250 | 251 | ws.emit('my_event', {my: 'data'}); // will send {my: 'data} 252 | }); 253 | -------------------------------------------------------------------------------- /manage.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import os 3 | import sys 4 | 5 | if __name__ == "__main__": 6 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "testsettings") 7 | 8 | from django.core.management import execute_from_command_line 9 | 10 | execute_from_command_line(sys.argv) 11 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | Django>=1.8 2 | tornado>=4.3 3 | six>=1.10 4 | flake8 5 | mock 6 | tox 7 | Sphinx 8 | sphinx_rtd_theme -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import os 2 | from setuptools import find_packages, setup 3 | from tornado_websockets import __version__ 4 | 5 | with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme: 6 | README = readme.read() 7 | 8 | os.chdir(os.path.normpath(os.path.join(os.path.abspath(__file__), os.pardir))) 9 | 10 | setup( 11 | name='django-tornado-websockets', 12 | version=__version__, 13 | description="Simple way to use WebSockets for Django with Tornado", 14 | long_description=README, 15 | author='Hugo ALLIAUME', 16 | author_email='kocal@live.fr', 17 | install_requires=[ 18 | 'Django>=1.8', 19 | 'tornado>=4.3', 20 | 'six>=1.10', 21 | ], 22 | packages=find_packages(exclude=['node_modules', 'bower_components', '.idea']), 23 | include_package_data=True, 24 | license='GPLv3 License', 25 | classifiers=[ 26 | 'Development Status :: 5 - Production/Stable', 27 | 'Environment :: Web Environment', 28 | 'Framework :: Django :: 1.8', 29 | 'Framework :: Django :: 1.9', 30 | 'Framework :: Django :: 1.10', 31 | 'Intended Audience :: Developers', 32 | 'License :: OSI Approved :: GNU General Public License v3 (GPLv3)', 33 | 'Programming Language :: Python :: 2', 34 | 'Programming Language :: Python :: 2.7', 35 | 'Programming Language :: Python :: 3', 36 | 'Programming Language :: Python :: 3.3', 37 | 'Programming Language :: Python :: 3.4', 38 | 'Programming Language :: Python :: 3.5', 39 | 'Programming Language :: Python :: 3.6', 40 | 'Topic :: Internet :: WWW/HTTP' 41 | ] 42 | ) 43 | -------------------------------------------------------------------------------- /testapp/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Kocal/django-tornado-websockets/93b87d28e41a7450eac08d264cf1e43720f3a126/testapp/__init__.py -------------------------------------------------------------------------------- /testapp/admin.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | 3 | # Register your models here. 4 | -------------------------------------------------------------------------------- /testapp/apps.py: -------------------------------------------------------------------------------- 1 | from django.apps import AppConfig 2 | 3 | 4 | class TestappConfig(AppConfig): 5 | name = 'testapp' 6 | -------------------------------------------------------------------------------- /testapp/migrations/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Kocal/django-tornado-websockets/93b87d28e41a7450eac08d264cf1e43720f3a126/testapp/migrations/__init__.py -------------------------------------------------------------------------------- /testapp/models.py: -------------------------------------------------------------------------------- 1 | from django.db import models 2 | 3 | # Create your models here. 4 | -------------------------------------------------------------------------------- /testapp/templates/testapp/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 9 | 10 | 11 |

WebSocket chat

12 | 13 | 14 | 15 |
16 | 19 | 20 |
21 | 22 | 23 | 24 |
25 |
26 | 30 |
31 | 32 |

Messages:

33 |
    34 |
    35 | 36 | {% load static %} 37 | 38 | 39 | 58 | 106 | 107 | 108 | 109 | -------------------------------------------------------------------------------- /testapp/templates/testapp/progress_bar.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Title 6 | 7 | 9 | 18 | 19 | 20 | 21 |
    22 |
    23 | 24 | 25 |
    26 | 27 | {% load static %} 28 | 29 | 30 | 67 | 68 | 69 | -------------------------------------------------------------------------------- /testapp/tests.py: -------------------------------------------------------------------------------- 1 | from django.test import TestCase 2 | 3 | # Create your tests here. 4 | -------------------------------------------------------------------------------- /testapp/urls.py: -------------------------------------------------------------------------------- 1 | from django.conf.urls import url 2 | from django.contrib import admin 3 | 4 | from . import views 5 | 6 | urlpatterns = [ 7 | url(r'^my_chat/$', views.MyChat.as_view(), name='index'), 8 | url(r'^my_progress_bar/$', views.MyProgressBar.as_view(), name='progress_bar'), 9 | url(r'^admin/', admin.site.urls) 10 | ] 11 | -------------------------------------------------------------------------------- /testapp/views.py: -------------------------------------------------------------------------------- 1 | from testapp.websocket import echo 2 | from testapp.websocket.chat import MyChat 3 | from testapp.websocket.module_progressbar import MyProgressBar -------------------------------------------------------------------------------- /testapp/websocket/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Kocal/django-tornado-websockets/93b87d28e41a7450eac08d264cf1e43720f3a126/testapp/websocket/__init__.py -------------------------------------------------------------------------------- /testapp/websocket/chat.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Example of a « chat application » by using `tornado_websocket.WebSocket` to handle communications, 5 | and Django's TemplateView for rendering. 6 | """ 7 | 8 | from django.views.generic import TemplateView 9 | 10 | from tornado_websockets.websocket import WebSocket 11 | 12 | tws = WebSocket('/my_chat') 13 | 14 | 15 | class MyChat(TemplateView): 16 | """ 17 | Proof of concept about a really simple web chat using websockets and supporting messages history 18 | """ 19 | 20 | template_name = 'testapp/index.html' 21 | messages = [] 22 | 23 | def __init__(self, **kwargs): 24 | super(MyChat, self).__init__(**kwargs) 25 | 26 | # Otherwise, 'self' parameter for method decorated by @ws_chat.on will not be defined 27 | tws.context = self 28 | 29 | @tws.on 30 | def connection(self, socket, data): 31 | # Send an history of the chat 32 | [socket.emit('new_message', __) for __ in self.messages] 33 | tws.emit('new_connection', '%s just joined the webchat.' % data.get('username', '')) 34 | 35 | @tws.on 36 | def message(self, socket, data): 37 | message = { 38 | 'username': data.get('username', ''), 39 | 'message': data.get('message', 'Empty message') 40 | } 41 | 42 | tws.emit('new_message', message) 43 | self.messages.append(message) 44 | 45 | @tws.on 46 | def clear_history(self, socket, data): 47 | """ 48 | Called when a client wants to clear messages history. 49 | Used only for client-side JavaScript unit tests 50 | """ 51 | 52 | self.messages = [] 53 | -------------------------------------------------------------------------------- /testapp/websocket/echo.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Example of a « echo » websocket server by using `tornado_websocket.WebSocket`. 5 | """ 6 | 7 | from tornado_websockets.websocket import WebSocket 8 | 9 | tws = WebSocket('/echo') 10 | 11 | 12 | # Listen the « message » event 13 | @tws.on 14 | def message(socket, data): 15 | socket.emit('new_message', { 16 | 'message': data.get('message') 17 | }) 18 | 19 | # Shorter version 20 | # socket.emit('new_message', data) 21 | -------------------------------------------------------------------------------- /testapp/websocket/module_progressbar.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | """ 4 | Example of module « Progress Bar » by using `tornado_websocket.modules.ProgressBar` to handle communications, 5 | and Django's TemplateView for rendering. 6 | """ 7 | 8 | from django.views.generic import TemplateView 9 | from tornado import gen 10 | 11 | from tornado_websockets.modules import ProgressBar 12 | from tornado_websockets.websocket import WebSocket 13 | 14 | ws = WebSocket('module_progressbar') 15 | progressbar = ProgressBar('foo', min=0, max=100) 16 | 17 | ws.bind(progressbar) 18 | 19 | 20 | @progressbar.on 21 | def reset(): 22 | progressbar.reset() 23 | 24 | 25 | @progressbar.on 26 | @gen.engine # Make this function asynchronous for Tornado's IOLoop 27 | def start(): 28 | for value in range(0, progressbar.max): 29 | yield gen.sleep(.1) # like time.sleep(), but asynchronous 30 | progressbar.tick(label="[%d/%d] Tâche %d terminée" % (progress_bar.current + 1, progress_bar.max, value)) 31 | 32 | 33 | class MyProgressBar(TemplateView): 34 | template_name = 'testapp/progress_bar.html' 35 | -------------------------------------------------------------------------------- /testsettings.py: -------------------------------------------------------------------------------- 1 | """ 2 | Django settings for django_websockets project. 3 | 4 | Generated by 'django-admin startproject' using Django 1.9.5. 5 | 6 | For more information on this file, see 7 | https://docs.djangoproject.com/en/1.9/topics/settings/ 8 | 9 | For the full list of settings and their values, see 10 | https://docs.djangoproject.com/en/1.9/ref/settings/ 11 | """ 12 | 13 | import os 14 | 15 | import tornado.web 16 | 17 | import tornado_websockets 18 | 19 | # Build paths inside the project like this: os.path.join(BASE_DIR, ...) 20 | 21 | BASE_DIR = os.path.dirname(os.path.abspath(__file__)) 22 | 23 | # Quick-start development settings - unsuitable for production 24 | # See https://docs.djangoproject.com/en/1.9/howto/deployment/checklist/ 25 | 26 | # SECURITY WARNING: keep the secret key used in production secret! 27 | SECRET_KEY = 'Change_this_secret_key_please' 28 | 29 | # SECURITY WARNING: don't run with debug turned on in production! 30 | DEBUG = True 31 | 32 | ALLOWED_HOSTS = [] 33 | 34 | # Application definition 35 | 36 | INSTALLED_APPS = [ 37 | 'django.contrib.admin', 38 | 'django.contrib.auth', 39 | 'django.contrib.contenttypes', 40 | 'django.contrib.sessions', 41 | 'django.contrib.messages', 42 | 'django.contrib.staticfiles', 43 | 44 | 'testapp', 45 | 'tornado_websockets', 46 | ] 47 | 48 | MIDDLEWARE_CLASSES = [ 49 | 'django.middleware.security.SecurityMiddleware', 50 | 'django.contrib.sessions.middleware.SessionMiddleware', 51 | 'django.middleware.common.CommonMiddleware', 52 | 'django.middleware.csrf.CsrfViewMiddleware', 53 | 'django.contrib.auth.middleware.AuthenticationMiddleware', 54 | 'django.contrib.auth.middleware.SessionAuthenticationMiddleware', 55 | 'django.contrib.messages.middleware.MessageMiddleware', 56 | 'django.middleware.clickjacking.XFrameOptionsMiddleware', 57 | ] 58 | 59 | ROOT_URLCONF = 'testapp.urls' 60 | 61 | TEMPLATES = [ 62 | { 63 | 'BACKEND': 'django.template.backends.django.DjangoTemplates', 64 | 'DIRS': [os.path.join(BASE_DIR, 'templates')], 65 | 'APP_DIRS': True, 66 | 'OPTIONS': { 67 | 'context_processors': [ 68 | 'django.template.context_processors.debug', 69 | 'django.template.context_processors.request', 70 | 'django.contrib.auth.context_processors.auth', 71 | 'django.contrib.messages.context_processors.messages', 72 | ], 73 | }, 74 | }, 75 | ] 76 | 77 | WSGI_APPLICATION = 'tornado_websockets.wsgi.application' 78 | 79 | # Database 80 | # https://docs.djangoproject.com/en/1.9/ref/settings/#databases 81 | 82 | DATABASES = { 83 | 'default': { 84 | 'ENGINE': 'django.db.backends.sqlite3', 85 | 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), 86 | } 87 | } 88 | 89 | # Password validation 90 | # https://docs.djangoproject.com/en/1.9/ref/settings/#auth-password-validators 91 | 92 | AUTH_PASSWORD_VALIDATORS = [ 93 | { 94 | 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', 95 | }, 96 | { 97 | 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', 98 | }, 99 | { 100 | 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', 101 | }, 102 | { 103 | 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', 104 | }, 105 | ] 106 | 107 | # Internationalization 108 | # https://docs.djangoproject.com/en/1.9/topics/i18n/ 109 | 110 | LANGUAGE_CODE = 'en-us' 111 | 112 | TIME_ZONE = 'UTC' 113 | 114 | USE_I18N = True 115 | 116 | USE_L10N = True 117 | 118 | USE_TZ = True 119 | 120 | # Static files (CSS, JavaScript, Images) 121 | # https://docs.djangoproject.com/en/1.9/howto/static-files/ 122 | 123 | STATIC_URL = '/static/' 124 | STATIC_ROOT = os.path.join(BASE_DIR, 'static') 125 | 126 | # Tornado configuration 127 | 128 | TORNADO = { 129 | 'port': 8000, 130 | 'handlers': [ 131 | (r'%s(.*)' % STATIC_URL, tornado.web.StaticFileHandler, {'path': STATIC_ROOT}), 132 | tornado_websockets.django_app() 133 | ], 134 | 'settings': { 135 | 'autoreload': True, 136 | 'debug': True 137 | } 138 | } 139 | -------------------------------------------------------------------------------- /tornado_websockets/__init__.py: -------------------------------------------------------------------------------- 1 | __version_info__ = ('0', '2', '2') 2 | __version__ = '.'.join(__version_info__) 3 | 4 | 5 | def django_app(): 6 | import django.core.handlers.wsgi 7 | import tornado.wsgi 8 | 9 | django.setup() 10 | 11 | app = tornado.wsgi.WSGIContainer(django.core.handlers.wsgi.WSGIHandler()) 12 | app = ('.*', tornado.web.FallbackHandler, dict(fallback=app)) 13 | 14 | return app 15 | -------------------------------------------------------------------------------- /tornado_websockets/exceptions.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | 4 | class TornadoWebSocketsError(Exception): 5 | """ 6 | Base exception of all django-tornado-websockets exceptions. 7 | """ 8 | pass 9 | 10 | 11 | class WebSocketEventAlreadyBinded(TornadoWebSocketsError, NameError): 12 | """ 13 | Exception thrown when an user try to bind an already existing event for a given path. 14 | 15 | * ``event`` - name of the event under investigation. 16 | * ``path`` - path where the offence have taken place. 17 | """ 18 | 19 | def __init__(self, event, path): 20 | self.event = event 21 | self.path = path 22 | super(WebSocketEventAlreadyBinded, self).__init__(event, path) 23 | 24 | def __str__(self): 25 | return 'The event "%s" is already binded for "%s" path.' % (self.event, self.path) 26 | 27 | 28 | class InvalidInstanceError(TornadoWebSocketsError, TypeError): 29 | """ 30 | Exception thrown when an instance is not the expected one. 31 | 32 | * ``actual_instance`` - actual instance which is trying to appear as ``expected_instance_name``. 33 | * ``expected_instance_name`` - name of expected instance. 34 | """ 35 | 36 | def __init__(self, actual_instance, expected_instance_name): 37 | self.actual_instance = actual_instance 38 | self.expected_instance_name = expected_instance_name 39 | super(InvalidInstanceError, self).__init__(actual_instance, expected_instance_name) 40 | 41 | def __str__(self): 42 | return 'Expected instance of "%s", got "%s" instead.' % ( 43 | self.expected_instance_name, repr(self.actual_instance) 44 | ) 45 | 46 | 47 | class EmitHandlerError(TornadoWebSocketsError): 48 | """ 49 | Exception thrown when an user try to emit an event without being in a function or class method decorated 50 | by :meth:`@WebSocket.on() ` decorator. 51 | 52 | * ``event`` - name of the event under investigation. 53 | * ``path`` - path where the offence have taken place. 54 | """ 55 | 56 | def __init__(self, event, path): 57 | self.event = event 58 | self.path = path 59 | super(EmitHandlerError, self).__init__(event, path) 60 | 61 | def __str__(self): 62 | return 'Can not emit "%s" event in "%s" path, emit() should be used in a function or class method' \ 63 | ' decorated by @WebSocket.on decorator.' % (self.event, self.path) 64 | 65 | 66 | class NotCallableError(TornadoWebSocketsError): 67 | """ 68 | Exception thrown when an user try to use a decorator on a non-callable thing. 69 | 70 | * ``thing`` - « The Thing ». 71 | """ 72 | 73 | def __init__(self, thing): 74 | self.thing = thing 75 | super(NotCallableError, self).__init__(thing) 76 | 77 | def __str__(self): 78 | return 'Used @WebSocket.on decorator on a thing that is not callable, got: "%s".' % self.thing 79 | -------------------------------------------------------------------------------- /tornado_websockets/management/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Kocal/django-tornado-websockets/93b87d28e41a7450eac08d264cf1e43720f3a126/tornado_websockets/management/__init__.py -------------------------------------------------------------------------------- /tornado_websockets/management/commands/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Kocal/django-tornado-websockets/93b87d28e41a7450eac08d264cf1e43720f3a126/tornado_websockets/management/commands/__init__.py -------------------------------------------------------------------------------- /tornado_websockets/management/commands/runtornado.py: -------------------------------------------------------------------------------- 1 | # Thanks to Ben Darnell for his file which show us 2 | # how to make Tornado runs fine with Django and other WSGI Handler. 3 | # => https://github.com/bdarnell/django-tornado-demo/blob/master/testsite/tornado_main.py 4 | 5 | import json 6 | 7 | import django.core.handlers.wsgi 8 | from django.apps import AppConfig 9 | from django.conf import settings 10 | from django.core.management import BaseCommand 11 | 12 | from tornado_websockets.tornadowrapper import TornadoWrapper 13 | 14 | if django.VERSION[1] > 5: 15 | django.setup() 16 | 17 | DEFAULT_PORT = 8000 18 | 19 | 20 | def get_port(options, configuration): 21 | port = options.get('port') 22 | port = port or configuration.get('port') 23 | port = port or DEFAULT_PORT 24 | 25 | return port 26 | 27 | 28 | def run(tornado_handlers, tornado_settings, port): 29 | TornadoWrapper.start_app(tornado_handlers, tornado_settings) 30 | TornadoWrapper.listen(port) 31 | TornadoWrapper.loop() 32 | 33 | 34 | class Command(BaseCommand, AppConfig): 35 | help = 'Run Tornado web server with Django and WebSockets support' 36 | 37 | def __init__(self, *args, **kwargs): 38 | super(Command, self).__init__(*args, **kwargs) 39 | 40 | def add_arguments(self, parser): 41 | parser.add_argument('port', nargs='?', help='Optional port number', type=int) 42 | 43 | def handle(self, *args, **options): 44 | try: 45 | configuration = settings.TORNADO 46 | except AttributeError as e: 47 | self.stderr.write('runtornado: Configuration => Not found: %s.' % e) 48 | return 49 | 50 | port = get_port(options, configuration) 51 | tornado_handlers = configuration.get('handlers', []) 52 | tornado_settings = configuration.get('settings', {}) 53 | 54 | self.stdout.write('runtornado: Configuration => Found.') 55 | self.stdout.write('runtornado: Port => %d.' % port) 56 | self.stdout.write('runtornado: Handlers => Found %d initial handlers.' % len(tornado_handlers)) 57 | self.stdout.write('runtornado: Settings => ' + json.dumps(tornado_settings)) 58 | 59 | run(tornado_handlers, tornado_settings, port) 60 | -------------------------------------------------------------------------------- /tornado_websockets/modules/__init__.py: -------------------------------------------------------------------------------- 1 | from .module import Module 2 | from .progressbar import ProgressBar 3 | -------------------------------------------------------------------------------- /tornado_websockets/modules/module.py: -------------------------------------------------------------------------------- 1 | import abc 2 | 3 | import six 4 | 5 | 6 | @six.add_metaclass(abc.ABCMeta) 7 | class Module(object): 8 | @abc.abstractmethod 9 | def __init__(self, name=''): 10 | self.name = 'module_' + name 11 | self._websocket = None # will be initialized with WebSocket.bind(Module) 12 | 13 | @abc.abstractmethod 14 | def initialize(self): 15 | pass 16 | 17 | @property 18 | def context(self): 19 | return self._websocket.context 20 | 21 | @context.setter 22 | def context(self, value): 23 | self._websocket.context = value 24 | 25 | def on(self, callback): 26 | """ 27 | Shortcut for :meth:`tornado_websockets.websocket.WebSocket.on` decorator, 28 | but with a specific prefix for each module. 29 | 30 | :param callback: function or a class method. 31 | :type callback: Callable 32 | :return: ``callback`` parameter. 33 | """ 34 | 35 | callback.__name__ = self.name + '_' + callback.__name__ 36 | 37 | return self._websocket.on(callback) 38 | 39 | def emit(self, event, data=None): 40 | """ 41 | Shortcut for :meth:`tornado_websockets.websocket.WebSocket.emit` method, 42 | but with a specific prefix for each module. 43 | """ 44 | 45 | return self._websocket.emit(self.name + '_' + event, data) 46 | -------------------------------------------------------------------------------- /tornado_websockets/modules/progressbar.py: -------------------------------------------------------------------------------- 1 | # coding=utf-8 2 | from tornado_websockets.modules.module import Module 3 | 4 | 5 | class ProgressBar(Module): 6 | """ 7 | Initialize a new ProgressBar module instance. 8 | 9 | If ``min`` and ``max`` values are equal, this progress bar has its indeterminate state 10 | set to ``True``. 11 | 12 | :param min: Minimum value 13 | :param max: Maximum value 14 | :type min: int 15 | :type max: int 16 | """ 17 | 18 | def __init__(self, name='', min=0, max=100, indeterminate=False): 19 | if name: 20 | name = '_' + name 21 | super(ProgressBar, self).__init__('progressbar' + name) 22 | 23 | if max < min: 24 | raise ValueError('Param « min » can not be greater or equal than param « max ».') 25 | 26 | self.min = self.current = min 27 | self.max = max 28 | self.indeterminate = indeterminate 29 | 30 | def initialize(self): 31 | @self.on 32 | def open(): 33 | self.emit_init() 34 | 35 | def tick(self, label=None): 36 | """ 37 | Increments progress bar's _current by ``1`` and emit ``update`` event. Can also emit ``done`` event if 38 | progression is done. 39 | 40 | Call :meth:`~tornado_websockets.modules.progress_bar.ProgressBar.emit_update` method each time this 41 | method is called. 42 | Call :meth:`~tornado_websockets.modules.progress_bar.ProgressBar.emit_done` method if progression is 43 | done. 44 | 45 | :param label: A label which can be displayed on the client screen 46 | :type label: str 47 | """ 48 | 49 | if not self.indeterminate and self.current < self.max: 50 | self.current += 1 51 | 52 | self.emit_update(label) 53 | 54 | if self.is_done(): 55 | self.emit_done() 56 | 57 | def reset(self): 58 | """ 59 | Reset progress bar's progression to its minimum value. 60 | """ 61 | self.current = self.min 62 | 63 | def is_done(self): 64 | """ 65 | Return ``True`` if progress bar's progression is done, otherwise ``False``. 66 | 67 | Returns ``False`` if progress bar is indeterminate, returns ``True`` if progress bar is 68 | determinate and current value is equals to ``max`` value. 69 | Returns ``False`` by default. 70 | 71 | :rtype: bool 72 | """ 73 | 74 | if self.indeterminate: 75 | return False 76 | 77 | if self.current is self.max: 78 | return True 79 | 80 | return False 81 | 82 | def emit_init(self): 83 | """ 84 | Emit ``before_init``, ``init`` and ``after_init`` events to initialize a client-side progress bar. 85 | 86 | If progress bar is not indeterminate, ``min``, ``max`` and ``value`` values are sent with ``init`` event. 87 | """ 88 | 89 | data = {'indeterminate': self.indeterminate} 90 | 91 | if not self.indeterminate: 92 | data.update({ 93 | 'min': int(self.min), 94 | 'max': int(self.max), 95 | 'current': int(self.current), 96 | }) 97 | 98 | self.emit('before_init') 99 | self.emit('init', data) 100 | self.emit('after_init') 101 | 102 | def emit_update(self, label=None): 103 | """ 104 | Emit ``before_update``, ``update`` and ``after_update`` events to update a client-side progress bar. 105 | 106 | :param label: A label which can be displayed on the client screen 107 | :type label: str 108 | """ 109 | 110 | data = {} 111 | 112 | if not self.indeterminate: 113 | data.update({'current': self.current}) 114 | 115 | if label: 116 | data.update({'label': label}) 117 | 118 | self.emit('before_update') 119 | self.emit('update', data) 120 | self.emit('after_update') 121 | 122 | def emit_done(self): 123 | """ 124 | Emit ``done`` event when progress bar's progression 125 | :meth:`~tornado_websockets.modules.progress_bar.ProgressBar.is_done`. 126 | """ 127 | 128 | self.emit('done') 129 | -------------------------------------------------------------------------------- /tornado_websockets/static/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Kocal/django-tornado-websockets/93b87d28e41a7450eac08d264cf1e43720f3a126/tornado_websockets/static/__init__.py -------------------------------------------------------------------------------- /tornado_websockets/static/tornado_websockets/modules: -------------------------------------------------------------------------------- 1 | dtws-client/dist/modules -------------------------------------------------------------------------------- /tornado_websockets/static/tornado_websockets/tornadowebsocket-es6.js: -------------------------------------------------------------------------------- 1 | dtws-client/dist/tornadowebsocket-es6.js -------------------------------------------------------------------------------- /tornado_websockets/static/tornado_websockets/tornadowebsocket.js: -------------------------------------------------------------------------------- 1 | dtws-client/dist/tornadowebsocket.js -------------------------------------------------------------------------------- /tornado_websockets/tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Kocal/django-tornado-websockets/93b87d28e41a7450eac08d264cf1e43720f3a126/tornado_websockets/tests/__init__.py -------------------------------------------------------------------------------- /tornado_websockets/tests/app/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Kocal/django-tornado-websockets/93b87d28e41a7450eac08d264cf1e43720f3a126/tornado_websockets/tests/app/__init__.py -------------------------------------------------------------------------------- /tornado_websockets/tests/app/ws.py: -------------------------------------------------------------------------------- 1 | from tornado_websockets.websocket import WebSocket 2 | 3 | ''' 4 | Test application for WebSocket tests. 5 | ''' 6 | 7 | 8 | def get_ws(): 9 | ws = WebSocket('/test') 10 | 11 | @ws.on 12 | def hello(socket, data): 13 | ws.emit('hello', { 14 | 'socket': str(socket), 15 | 'data_sent': data, 16 | 'message': 'Hello from hello callback!' 17 | }) 18 | 19 | return ws 20 | -------------------------------------------------------------------------------- /tornado_websockets/tests/helpers/__init__.py: -------------------------------------------------------------------------------- 1 | from .websocketbasetest import WebSocketBaseTestCase 2 | from .websockethandler import WebSocketHandlerForTests 3 | -------------------------------------------------------------------------------- /tornado_websockets/tests/helpers/helpers.py: -------------------------------------------------------------------------------- 1 | try: 2 | from tornado import speedups 3 | except ImportError: 4 | speedups = None 5 | -------------------------------------------------------------------------------- /tornado_websockets/tests/helpers/websocketbasetest.py: -------------------------------------------------------------------------------- 1 | from tornado import gen 2 | from tornado.testing import AsyncHTTPTestCase 3 | from tornado.websocket import websocket_connect 4 | 5 | 6 | class WebSocketBaseTestCase(AsyncHTTPTestCase): 7 | @gen.coroutine 8 | def ws_connect(self, path, compression_options=None): 9 | ws = yield websocket_connect( 10 | 'ws://127.0.0.1:%d%s' % (self.get_http_port(), path), 11 | compression_options=compression_options 12 | ) 13 | 14 | raise gen.Return(ws) 15 | 16 | @gen.coroutine 17 | def close(self, ws): 18 | """Close a websocket connection and wait for the server side. 19 | If we don't wait here, there are sometimes leak warnings in the 20 | tests. 21 | """ 22 | ws.close() 23 | yield self.close_future 24 | -------------------------------------------------------------------------------- /tornado_websockets/tests/helpers/websockethandler.py: -------------------------------------------------------------------------------- 1 | from tornado_websockets.websockethandler import WebSocketHandler 2 | 3 | 4 | class WebSocketHandlerForTests(WebSocketHandler): 5 | """Base class for testing handlers that exposes the on_close event. 6 | This allows for deterministic cleanup of the associated socket. 7 | """ 8 | 9 | def initialize(self, websocket, close_future, compression_options=None): 10 | super(WebSocketHandlerForTests, self).initialize(websocket) 11 | self.close_future = close_future 12 | self.compression_options = compression_options 13 | 14 | def get_compression_options(self): 15 | return self.compression_options 16 | 17 | def on_close(self): 18 | super(WebSocketHandlerForTests, self).on_close() 19 | self.close_future.set_result((self.close_code, self.close_reason)) 20 | -------------------------------------------------------------------------------- /tornado_websockets/tests/modules/__init__.py: -------------------------------------------------------------------------------- 1 | from .modules import Module1, Module2, Module3, MyModule 2 | -------------------------------------------------------------------------------- /tornado_websockets/tests/modules/modules.py: -------------------------------------------------------------------------------- 1 | from tornado_websockets.modules import Module 2 | 3 | 4 | class Module1(Module): 5 | pass 6 | 7 | 8 | class Module2(Module): 9 | def __init__(self, name=''): 10 | pass 11 | 12 | 13 | class Module3(Module): 14 | def __init__(self, name=''): 15 | pass 16 | 17 | def initialize(self): 18 | pass 19 | 20 | 21 | class MyModule(Module): 22 | def __init__(self, name=''): 23 | if name: 24 | name = '_' + name 25 | super(MyModule, self).__init__('mymodule' + name) 26 | 27 | def initialize(self): 28 | print('initialized') 29 | -------------------------------------------------------------------------------- /tornado_websockets/tests/test_command_runtornado.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | import django 4 | from django.conf import settings 5 | from django.core.management import call_command 6 | from django.test import TestCase 7 | from django.utils.six import StringIO 8 | from mock import patch, ANY 9 | 10 | from tornado_websockets.management.commands import runtornado 11 | 12 | django.setup() 13 | 14 | 15 | class TestCommandRuntornado(TestCase): 16 | """ 17 | Tests for the management command « runtornado ». 18 | """ 19 | 20 | def setUp(self): 21 | self.TORNADO = settings.TORNADO 22 | 23 | def tearDown(self): 24 | settings.TORNADO = self.TORNADO 25 | 26 | ''' 27 | Tests for settings behavior. 28 | ''' 29 | 30 | @patch('tornado_websockets.management.commands.runtornado.run') 31 | def test_without_tornado_settings(self, stub): 32 | del settings.TORNADO 33 | 34 | err = StringIO() 35 | 36 | call_command('runtornado', stdout=StringIO(), stderr=err) 37 | 38 | self.assertIn("Configuration => Not found: 'Settings' object has no attribute 'TORNADO'", err.getvalue()) 39 | stub.assert_not_called() 40 | 41 | @patch('tornado_websockets.management.commands.runtornado.run') 42 | def test_with_tornado_settings(self, stub): 43 | err = StringIO() 44 | 45 | call_command('runtornado', stdout=StringIO(), stderr=err) 46 | 47 | self.assertNotIn("Configuration => Not found: 'Settings' object has no attribute 'TORNADO'", err.getvalue()) 48 | stub.assert_called() 49 | 50 | ''' 51 | Tests for handlers behavior. 52 | ''' 53 | 54 | @patch('tornado_websockets.management.commands.runtornado.run') 55 | def test_without_handlers(self, stub): 56 | del settings.TORNADO['handlers'] 57 | 58 | call_command('runtornado', stdout=StringIO()) 59 | 60 | stub.assert_called_with([], ANY, ANY) 61 | 62 | @patch('tornado_websockets.management.commands.runtornado.run') 63 | def test_with_handlers(self, stub): 64 | call_command('runtornado', stdout=StringIO()) 65 | 66 | stub.assert_called_with(ANY, ANY, ANY) 67 | 68 | ''' 69 | Tests for settings behavior. 70 | ''' 71 | 72 | @patch('tornado_websockets.management.commands.runtornado.run') 73 | def test_without_settings(self, stub): 74 | del settings.TORNADO['settings'] 75 | 76 | call_command('runtornado', stdout=StringIO()) 77 | 78 | stub.assert_called_with(ANY, {}, ANY) 79 | 80 | @patch('tornado_websockets.management.commands.runtornado.run') 81 | def test_with_settings(self, stub): 82 | call_command('runtornado', stdout=StringIO()) 83 | 84 | stub.assert_called_with(ANY, {'autoreload': True, 'debug': True}, ANY) 85 | 86 | ''' 87 | Tests for port behavior. 88 | ''' 89 | 90 | @patch('tornado_websockets.management.commands.runtornado.run') 91 | def test_get_port_from_options(self, stub): 92 | settings.TORNADO['port'] = 1234 93 | 94 | call_command('runtornado', '8080', stdout=StringIO()) 95 | 96 | stub.assert_called_with(ANY, ANY, 8080) 97 | 98 | @patch('tornado_websockets.management.commands.runtornado.run') 99 | def test_get_port_from_settings(self, stub): 100 | settings.TORNADO['port'] = 1234 101 | 102 | call_command('runtornado', stdout=StringIO()) 103 | 104 | stub.assert_called_with(ANY, ANY, 1234) 105 | 106 | @patch('tornado_websockets.management.commands.runtornado.run') 107 | def test_get_port_with_default_port(self, stub): 108 | del settings.TORNADO['port'] 109 | 110 | call_command('runtornado', stdout=StringIO()) 111 | 112 | stub.assert_called_with(ANY, ANY, 8000) 113 | 114 | ''' 115 | Test for run() 116 | ''' 117 | 118 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.loop') 119 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.listen') 120 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.start_app') 121 | def test_run(self, start_app, listen, loop): 122 | handlers = [] 123 | settings = {} 124 | port = 1234 125 | 126 | runtornado.run(handlers, settings, port) 127 | 128 | start_app.assert_called_with(handlers, settings) 129 | listen.assert_called_with(port) 130 | loop.assert_called() 131 | -------------------------------------------------------------------------------- /tornado_websockets/tests/test_module.py: -------------------------------------------------------------------------------- 1 | from unittest import TestCase 2 | 3 | import six 4 | 5 | from tornado_websockets.tests.modules import Module1, Module2, Module3 6 | from tornado_websockets.tests.modules import MyModule 7 | from tornado_websockets.websocket import WebSocket 8 | 9 | if six.PY2: 10 | from mock import patch, Mock 11 | else: 12 | from unittest.mock import patch, Mock 13 | 14 | 15 | class TestModule(TestCase): 16 | def test_abstraction(self): 17 | # Module1.__init__() and Module1.initialize() are abstract 18 | with self.assertRaisesRegexp(TypeError, "Can't instantiate abstract class Module1"): 19 | Module1() 20 | 21 | # Module2.initialize() is abstract 22 | with self.assertRaisesRegexp(TypeError, "Can't instantiate abstract class Module2.* initialize"): 23 | Module2() 24 | 25 | # Module3 is ok! 26 | Module3() 27 | 28 | def test_construct(self): 29 | moduleFoo = MyModule() 30 | moduleBar = MyModule('bar') 31 | 32 | self.assertEqual(moduleFoo.name, 'module_mymodule') 33 | self.assertEqual(moduleBar.name, 'module_mymodule_bar') 34 | 35 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.add_handler') 36 | def test_context(self, add_handler): 37 | module = MyModule() 38 | ws = WebSocket('pb') 39 | 40 | self.assertIsNone(module._websocket) 41 | with self.assertRaisesRegexp(AttributeError, "'NoneType' object has no attribute 'context'"): 42 | print(module.context) 43 | 44 | ws.bind(module) 45 | 46 | module.context = 'foo' 47 | self.assertEqual(module._websocket.context, 'foo') 48 | self.assertEqual(module.context, 'foo') 49 | 50 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.add_handler') 51 | def test_on(self, add_handler): 52 | ws = WebSocket('foo') 53 | moduleBar = MyModule('bar') 54 | moduleBar.initialize = Mock() 55 | 56 | # Module is not binded to WebSocket instance 57 | self.assertEqual(ws.modules, []) 58 | self.assertEqual(ws.events, {}) 59 | self.assertIsNone(moduleBar._websocket) 60 | with self.assertRaisesRegexp(AttributeError, "'NoneType' object has no attribute 'on'"): 61 | @moduleBar.on 62 | def func_a(): 63 | pass 64 | 65 | # Module is now binded to WebSocket instance 66 | ws.bind(moduleBar) 67 | moduleBar.initialize.assert_called_with() 68 | 69 | self.assertEqual(ws.modules, [moduleBar]) 70 | self.assertEqual(ws.events, {}) 71 | self.assertEqual(moduleBar._websocket, ws) 72 | 73 | @moduleBar.on 74 | def func_b(): 75 | pass 76 | 77 | self.assertDictEqual(ws.events, {'module_mymodule_bar_func_b': func_b}) 78 | 79 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.add_handler') 80 | def test_emit(self, add_handler): 81 | ws = WebSocket('foo') 82 | ws.emit = Mock() 83 | moduleBar = MyModule('bar') 84 | moduleBar.initialize = Mock() 85 | 86 | # Module is not binded to WebSocket instance 87 | self.assertEqual(ws.modules, []) 88 | self.assertEqual(ws.events, {}) 89 | self.assertIsNone(moduleBar._websocket) 90 | with self.assertRaisesRegexp(AttributeError, "'NoneType' object has no attribute 'emit'"): 91 | moduleBar.emit('my_event', {'my': 'data'}) 92 | ws.emit.assert_not_called() 93 | 94 | # Module is now binded to WebSocket instance 95 | ws.bind(moduleBar) 96 | 97 | moduleBar.initialize.assert_called_with() 98 | 99 | self.assertEqual(ws.modules, [moduleBar]) 100 | self.assertEqual(ws.events, {}) 101 | self.assertEqual(moduleBar._websocket, ws) 102 | 103 | moduleBar.emit('my_event', {'my': 'data'}) 104 | 105 | ws.emit.assert_called_with('module_mymodule_bar_my_event', {'my': 'data'}) 106 | -------------------------------------------------------------------------------- /tornado_websockets/tests/test_module_progressbar.py: -------------------------------------------------------------------------------- 1 | # coding=utf-8 2 | from unittest import TestCase 3 | 4 | import six 5 | import tornado.web 6 | from tornado.concurrent import Future 7 | from tornado.escape import json_decode 8 | from tornado.testing import gen_test 9 | 10 | from tornado_websockets.modules import ProgressBar 11 | from tornado_websockets.tests.helpers import WebSocketBaseTestCase 12 | from tornado_websockets.tests.helpers import WebSocketHandlerForTests 13 | from tornado_websockets.websocket import WebSocket 14 | 15 | if six.PY2: 16 | from mock import patch, Mock, call 17 | else: 18 | from unittest.mock import patch, Mock, call 19 | 20 | 21 | class TestModuleProgressBar(TestCase): 22 | def test_construct_default_values(self): 23 | module_pb = ProgressBar() 24 | 25 | self.assertEqual(module_pb.name, 'module_progressbar') 26 | self.assertEqual(module_pb.min, 0) 27 | self.assertEqual(module_pb.max, 100) 28 | self.assertEqual(module_pb.current, module_pb.min) 29 | self.assertFalse(module_pb.indeterminate) 30 | 31 | def test_construct_min_gt_max(self): 32 | with self.assertRaisesRegexp(ValueError, '« min » .* not be greater or equal .* « max »'): 33 | ProgressBar(min=1, max=0) 34 | 35 | def test_construct_should_be_indeterminate(self): 36 | module_pb = ProgressBar(indeterminate=True) 37 | 38 | self.assertTrue(module_pb.indeterminate) 39 | 40 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.add_handler') 41 | def test_initialize(self, add_handler): 42 | ws = WebSocket('pb') 43 | module_pb = ProgressBar() 44 | module_pb.initialize = Mock() 45 | 46 | self.assertEqual(ws.modules, []) 47 | 48 | ws.bind(module_pb) 49 | 50 | self.assertEqual(ws.modules, [module_pb]) 51 | module_pb.initialize.assert_called_with() 52 | 53 | def test_tick_and_is_done(self): 54 | module_pb = ProgressBar(min=0, max=3) 55 | module_pb.emit_update = Mock() 56 | module_pb.emit_done = Mock() 57 | 58 | self.assertEqual(module_pb.current, 0) 59 | self.assertFalse(module_pb.is_done()) 60 | 61 | # 1st tick 62 | module_pb.tick() 63 | 64 | self.assertEqual(module_pb.current, 1) 65 | module_pb.emit_update.assert_called_with(None) 66 | self.assertFalse(module_pb.is_done()) 67 | module_pb.emit_done.assert_not_called() 68 | 69 | # 2nd tick 70 | module_pb.tick('My label') 71 | 72 | self.assertEqual(module_pb.current, 2) 73 | module_pb.emit_update.assert_called_with('My label') 74 | self.assertFalse(module_pb.is_done()) 75 | module_pb.emit_done.assert_not_called() 76 | 77 | # 3rd tick 78 | module_pb.tick('My other label') 79 | 80 | self.assertEqual(module_pb.current, 3) 81 | module_pb.emit_update.assert_called_with('My other label') 82 | self.assertTrue(module_pb.is_done()) 83 | module_pb.emit_done.assert_called_with() 84 | 85 | def test_reset(self): 86 | module_pb = ProgressBar() 87 | module_pb.emit_update = Mock() 88 | module_pb.emit_done = Mock() 89 | 90 | self.assertEqual(module_pb.min, 0) 91 | self.assertEqual(module_pb.current, module_pb.min) 92 | 93 | module_pb.tick() 94 | self.assertEqual(module_pb.current, 1) 95 | 96 | module_pb.tick() 97 | self.assertEqual(module_pb.current, 2) 98 | 99 | module_pb.reset() 100 | self.assertEqual(module_pb.current, module_pb.min) 101 | 102 | def test_is_done(self): 103 | module_pb = ProgressBar(min=0, max=100) 104 | self.assertFalse(module_pb.is_done()) 105 | 106 | module_pb = ProgressBar(indeterminate=False) 107 | self.assertFalse(module_pb.is_done()) 108 | 109 | module_pb = ProgressBar(min=0, max=1) 110 | module_pb.emit_update = Mock() 111 | module_pb.emit_done = Mock() 112 | module_pb.tick() 113 | self.assertEqual(module_pb.current, 1) 114 | self.assertTrue(module_pb.is_done()) 115 | 116 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.add_handler') 117 | def test_emit_init_determinate(self, add_handler): 118 | ws = WebSocket('pb') 119 | module_pb = ProgressBar() 120 | 121 | ws.bind(module_pb) 122 | ws.emit = Mock() 123 | 124 | module_pb.emit_init() 125 | 126 | call1 = call('module_progressbar_before_init', None) 127 | call2 = call('module_progressbar_init', { 128 | 'indeterminate': False, 129 | 'min': 0, 130 | 'max': 100, 131 | 'current': 0 132 | }) 133 | call3 = call('module_progressbar_after_init', None) 134 | 135 | ws.emit.assert_has_calls([call1, call2, call3]) 136 | 137 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.add_handler') 138 | def test_emit_init_indeterminate(self, add_handler): 139 | ws = WebSocket('pb') 140 | module_pb = ProgressBar(indeterminate=True) 141 | 142 | ws.bind(module_pb) 143 | ws.emit = Mock() 144 | 145 | module_pb.emit_init() 146 | 147 | call1 = call('module_progressbar_before_init', None) 148 | call2 = call('module_progressbar_init', { 149 | 'indeterminate': True 150 | }) 151 | call3 = call('module_progressbar_after_init', None) 152 | 153 | ws.emit.assert_has_calls([call1, call2, call3]) 154 | 155 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.add_handler') 156 | def test_emit_update_determinate(self, add_handler): 157 | ws = WebSocket('pb') 158 | module_pb = ProgressBar() 159 | 160 | ws.bind(module_pb) 161 | ws.emit = Mock() 162 | 163 | # 1st try, without label 164 | module_pb.tick() 165 | 166 | call1 = call('module_progressbar_before_update', None) 167 | call2 = call('module_progressbar_update', { 168 | 'current': 1 169 | }) 170 | call3 = call('module_progressbar_after_update', None) 171 | 172 | ws.emit.assert_has_calls([call1, call2, call3]) 173 | ws.emit.reset_mock() 174 | 175 | # 2nd and last try, with label 176 | module_pb.tick('My label') 177 | 178 | call1 = call('module_progressbar_before_update', None) 179 | call2 = call('module_progressbar_update', { 180 | 'current': 2, 181 | 'label': 'My label' 182 | }) 183 | call3 = call('module_progressbar_after_update', None) 184 | 185 | ws.emit.assert_has_calls([call1, call2, call3]) 186 | 187 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.add_handler') 188 | def test_emit_update_indeterminate(self, add_handler): 189 | ws = WebSocket('pb') 190 | module_pb = ProgressBar(indeterminate=True) 191 | 192 | ws.bind(module_pb) 193 | ws.emit = Mock() 194 | 195 | # 1st try, without label 196 | module_pb.tick() 197 | 198 | call1 = call('module_progressbar_before_update', None) 199 | call2 = call('module_progressbar_update', {}) 200 | call3 = call('module_progressbar_after_update', None) 201 | 202 | ws.emit.assert_has_calls([call1, call2, call3]) 203 | ws.emit.reset_mock() 204 | 205 | # 2nd and last try, with label 206 | module_pb.tick('My label') 207 | 208 | call1 = call('module_progressbar_before_update', None) 209 | call2 = call('module_progressbar_update', { 210 | 'label': 'My label' 211 | }) 212 | call3 = call('module_progressbar_after_update', None) 213 | 214 | ws.emit.assert_has_calls([call1, call2, call3]) 215 | 216 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.add_handler') 217 | def test_emit_done(self, add_handler): 218 | ws = WebSocket('pb') 219 | module_pb = ProgressBar(min=0, max=2) 220 | 221 | ws.bind(module_pb) 222 | ws.emit = Mock() 223 | module_pb.emit_init = Mock() 224 | module_pb.emit_update = Mock() 225 | 226 | # 1st try 227 | module_pb.tick() 228 | self.assertEqual(module_pb.current, 1) 229 | ws.emit.assert_not_called() 230 | 231 | # 2nd and last try 232 | module_pb.tick() 233 | self.assertEqual(module_pb.current, 2) 234 | self.assertEqual(module_pb.current, module_pb.max) 235 | ws.emit.assert_called_with('module_progressbar_done', None) 236 | 237 | 238 | class TestModuleProgressBarCommunication(WebSocketBaseTestCase): 239 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.add_handler') 240 | def get_app(self, add_handler): 241 | self.ws = WebSocket('pb') 242 | self.close_future = Future() 243 | 244 | return tornado.web.Application([ 245 | ('/ws/module/pb', WebSocketHandlerForTests, {'websocket': self.ws, 'close_future': self.close_future}), 246 | ]) 247 | 248 | @gen_test 249 | def test_open_event(self): 250 | @self.ws.on 251 | def open(): 252 | self.ws.emit('opened') 253 | 254 | module_pb = ProgressBar() 255 | module_pb.emit_init = Mock() 256 | self.ws.bind(module_pb) 257 | 258 | ws_connection = yield self.ws_connect('/ws/module/pb') 259 | 260 | # 1st: clasical websocket on open event 261 | response = yield ws_connection.read_message() 262 | response = json_decode(response) 263 | 264 | self.assertDictEqual(response, { 265 | 'event': 'opened', 266 | 'data': {} 267 | }) 268 | 269 | # 2nd: ProgressBar module on open event 270 | module_pb.emit_init.assert_called_with() 271 | 272 | self.close(ws_connection) 273 | -------------------------------------------------------------------------------- /tornado_websockets/tests/test_tornadowrapper.py: -------------------------------------------------------------------------------- 1 | from _socket import gaierror 2 | from unittest import TestCase 3 | 4 | import tornado 5 | import tornado.httpserver 6 | import tornado.web 7 | from mock import patch 8 | from tornado.websocket import WebSocketHandler 9 | 10 | from tornado_websockets.tornadowrapper import TornadoWrapper 11 | 12 | 13 | class TestTornadoWrapper(TestCase): 14 | """ 15 | Tests for TornadoWrapper class. 16 | """ 17 | 18 | def tearDown(self): 19 | TornadoWrapper.app = None 20 | TornadoWrapper.handlers = [] 21 | 22 | ''' 23 | Tests for TornadoWrapper.start_app() 24 | ''' 25 | 26 | @patch('tornado.web.Application') 27 | def test_start_app_without_handlers_without_settings(self, stub): 28 | TornadoWrapper.start_app() 29 | 30 | stub.assert_called_with([]) 31 | 32 | @patch('tornado.web.Application') 33 | def test_start_app_with_handlers_with_settings(self, stub): 34 | TornadoWrapper.start_app([], {'foo': 'bar', 'foo2': 'bar2'}) 35 | 36 | stub.assert_called_with([], foo='bar', foo2='bar2') 37 | 38 | ''' 39 | Tests for TornadoWrapper.listen() 40 | ''' 41 | 42 | def test_listen_with_bad_port_type(self): 43 | TornadoWrapper.start_app() 44 | 45 | with self.assertRaisesRegexp(gaierror, 'Servname not supported'): 46 | TornadoWrapper.listen('not a integer') 47 | 48 | def test_listen_without_app_instance(self): 49 | with self.assertRaisesRegexp(TypeError, 'Tornado application was not instantiated'): 50 | TornadoWrapper.listen(8000) 51 | 52 | @patch('tornado.httpserver.HTTPServer', autospec=True) 53 | def test_listen_with_app_instance(self, stub): 54 | self.assertIsNone(TornadoWrapper.app) 55 | self.assertIsNone(TornadoWrapper.server) 56 | 57 | TornadoWrapper.start_app() 58 | TornadoWrapper.listen(12345) 59 | 60 | self.assertIsInstance(TornadoWrapper.app, tornado.web.Application) 61 | self.assertIs(stub, tornado.httpserver.HTTPServer) 62 | stub.assert_called_with(TornadoWrapper.app) 63 | 64 | ''' 65 | Test for TornadoWrapper.loop() 66 | ''' 67 | 68 | @patch('tornado.ioloop.IOLoop.instance') 69 | def test_loop(self, stub): 70 | TornadoWrapper.loop() 71 | 72 | stub.assert_called() 73 | 74 | ''' 75 | Tests for TornadoWrapper.add_handler() 76 | ''' 77 | 78 | def test_add_handler_without_tornado_app_instance(self): 79 | self.assertIsNone(TornadoWrapper.app) 80 | self.assertListEqual(TornadoWrapper.handlers, []) 81 | 82 | with self.assertRaises(TypeError): 83 | TornadoWrapper.add_handler('a string') 84 | 85 | self.assertListEqual(TornadoWrapper.handlers, []) 86 | 87 | TornadoWrapper.add_handler([('my', 'tuple', 'in', 'a', 'list')]) 88 | self.assertListEqual(TornadoWrapper.handlers, [('my', 'tuple', 'in', 'a', 'list')]) 89 | 90 | TornadoWrapper.add_handler(('my', 'tuple')) 91 | self.assertListEqual(TornadoWrapper.handlers, [('my', 'tuple'), ('my', 'tuple', 'in', 'a', 'list')]) 92 | 93 | def test_add_handler_with_tornado_app_instance(self): 94 | self.assertIsNone(TornadoWrapper.app) 95 | self.assertListEqual(TornadoWrapper.handlers, []) 96 | 97 | TornadoWrapper.start_app() 98 | self.assertIsNotNone(TornadoWrapper.app) 99 | 100 | with self.assertRaisesRegexp(AttributeError, "'str' object has no attribute 'name'"): 101 | TornadoWrapper.add_handler('a string') 102 | 103 | TornadoWrapper.add_handler([('path', WebSocketHandler, {})]) 104 | TornadoWrapper.add_handler(('path2', WebSocketHandler, {})) 105 | -------------------------------------------------------------------------------- /tornado_websockets/tests/test_websocket.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | from unittest import TestCase 4 | 5 | import six 6 | 7 | from tornado_websockets.exceptions import NotCallableError 8 | from tornado_websockets.modules import ProgressBar 9 | from tornado_websockets.websocket import WebSocket 10 | from tornado_websockets.websockethandler import WebSocketHandler 11 | 12 | if six.PY2: 13 | from mock import patch, Mock 14 | else: 15 | from unittest.mock import patch, Mock 16 | 17 | 18 | class TestWebSocket(TestCase): 19 | """ 20 | Tests for the class « WebSocket ». 21 | """ 22 | 23 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.add_handler') 24 | def test_construct(self, add_handler): 25 | add_handler.assert_called_with(('/ws/path1', WebSocketHandler, {'websocket': WebSocket('path1')})) 26 | add_handler.assert_called_with(('/ws/path2', WebSocketHandler, {'websocket': WebSocket('/path2')})) 27 | add_handler.assert_called_with(('/ws/path3', WebSocketHandler, {'websocket': WebSocket(' path3 ')})) 28 | add_handler.assert_called_with(('/ws/path4', WebSocketHandler, {'websocket': WebSocket(' /path4 ')})) 29 | 30 | with self.assertRaisesRegexp(TypeError, '« Path » parameter should be a string.'): 31 | WebSocket(path=1234) 32 | 33 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.add_handler') 34 | def test_bind_module(self, add_handler): 35 | ws = WebSocket('path') 36 | module = ProgressBar('progress') 37 | 38 | module.initialize = Mock() 39 | 40 | self.assertListEqual(ws.modules, []) 41 | self.assertIsNone(module._websocket) 42 | module.initialize.assert_not_called() 43 | 44 | ws.bind(module) 45 | 46 | self.assertListEqual(ws.modules, [module]) 47 | self.assertEqual(module._websocket, ws) 48 | module.initialize.assert_called_with() 49 | 50 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.add_handler') 51 | def test_on(self, add_handler): 52 | ws = WebSocket('path') 53 | 54 | self.assertDictEqual(ws.events, {}) 55 | 56 | with self.assertRaises(NotCallableError): 57 | ws.on('string') 58 | 59 | @ws.on 60 | def func(): 61 | pass 62 | 63 | self.assertDictEqual(ws.events, {'func': func}) 64 | 65 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.add_handler') 66 | def test_emit(self, add_handler): 67 | ws = WebSocket('path') 68 | handler = Mock() 69 | 70 | # Emulate WebSocketHandler class with Mock, because only Tornado can instantiate it properly 71 | def side_effect(websocket): 72 | ws.handlers.append(handler) 73 | handler.websocket = websocket 74 | 75 | handler.return_value = None 76 | handler.websocket = None 77 | handler.initialize.side_effect = side_effect 78 | handler.emit = Mock() 79 | 80 | self.assertListEqual(ws.handlers, []) 81 | self.assertIsNone(handler.websocket) 82 | 83 | handler.initialize(ws) 84 | 85 | self.assertListEqual(ws.handlers, [handler]) 86 | self.assertEqual(handler.websocket, ws) 87 | 88 | with self.assertRaisesRegexp(TypeError, 'Param « event » should be a string.'): 89 | ws.emit(123) 90 | handler.emit.assert_not_called() 91 | 92 | ws.emit('event') 93 | handler.emit.assert_called_with('event', {}) 94 | handler.emit.reset_mock() 95 | 96 | ws.emit('event', {}) 97 | handler.emit.assert_called_with('event', {}) 98 | handler.emit.reset_mock() 99 | 100 | ws.emit('event', 'my message') 101 | handler.emit.assert_called_with('event', {'message': 'my message'}) 102 | handler.emit.reset_mock() 103 | 104 | with self.assertRaisesRegexp(TypeError, 'Param « data » should be a string or a dictionary.'): 105 | ws.emit('event', 123) 106 | handler.emit.assert_not_called() 107 | -------------------------------------------------------------------------------- /tornado_websockets/tests/test_websockethandler.py: -------------------------------------------------------------------------------- 1 | import unittest 2 | 3 | import tornado.httpclient 4 | import tornado.web 5 | from mock import patch, ANY 6 | from tornado.concurrent import Future 7 | from tornado.escape import json_decode, json_encode 8 | from tornado.testing import gen_test 9 | 10 | from tornado_websockets.tests.app import ws as appTest 11 | from tornado_websockets.tests.helpers import WebSocketBaseTestCase, WebSocketHandlerForTests 12 | from tornado_websockets.websockethandler import WebSocketHandler 13 | 14 | 15 | class WebSocketHandlerTest(WebSocketBaseTestCase): 16 | @patch('tornado_websockets.tornadowrapper.TornadoWrapper.add_handler') 17 | def get_app(self, add_handler): 18 | self.ws = appTest.get_ws() 19 | self.close_future = Future() 20 | 21 | return tornado.web.Application([ 22 | ('/ws/test', WebSocketHandlerForTests, {'websocket': self.ws, 'close_future': self.close_future}), 23 | ]) 24 | 25 | @gen_test 26 | def test_connection_on_existing_websocket(self): 27 | ws_connection = yield self.ws_connect('/ws/test') 28 | 29 | self.assertEqual(None, ws_connection.close_code) 30 | self.assertEqual(None, ws_connection.close_reason) 31 | 32 | self.close(ws_connection) 33 | 34 | @gen_test 35 | def test_connection_on_non_existing_websocket(self): 36 | with self.assertRaisesRegexp(tornado.httpclient.HTTPError, 'HTTP 404: Not Found'): 37 | yield self.ws_connect('/ws/foo/bar') 38 | 39 | @gen_test 40 | def test_initialize(self): 41 | self.assertListEqual(self.ws.handlers, []) 42 | 43 | ws_connection = yield self.ws_connect('/ws/test') 44 | 45 | self.assertIsInstance(self.ws.handlers[0], WebSocketHandlerForTests) 46 | self.assertIsInstance(self.ws.handlers[0], WebSocketHandler) 47 | self.assertEqual(self.ws.handlers[0].websocket, self.ws) 48 | 49 | self.close(ws_connection) 50 | 51 | @unittest.expectedFailure 52 | @gen_test 53 | def test_open_without_open_event(self): 54 | @self.ws.on 55 | def open(): 56 | self.ws.emit('opened') 57 | 58 | self.assertDictEqual(self.ws.events, { 59 | 'hello': ANY 60 | }) 61 | 62 | ws_connection = yield self.ws_connect('/ws/test') 63 | 64 | # Waiting for nonexistent open event 65 | yield ws_connection.read_message() 66 | 67 | @gen_test 68 | def test_open_event_with_open(self): 69 | @self.ws.on 70 | def open(): 71 | self.ws.emit('opened') 72 | 73 | self.assertDictEqual(self.ws.events, { 74 | 'hello': ANY, 75 | 'open': open 76 | }) 77 | 78 | ws_connection = yield self.ws_connect('/ws/test') 79 | 80 | response = yield ws_connection.read_message() 81 | response = json_decode(response) 82 | 83 | self.assertDictEqual(response, { 84 | 'event': 'opened', 85 | 'data': {} 86 | }) 87 | 88 | self.close(ws_connection) 89 | 90 | @gen_test 91 | def test_on_message(self): 92 | ws_connection = yield self.ws_connect('/ws/test') 93 | 94 | # Test for invalid JSON 95 | ws_connection.write_message('Not a JSON') 96 | 97 | response = yield ws_connection.read_message() 98 | response = json_decode(response) 99 | 100 | self.assertDictEqual(response, { 101 | 'event': 'warning', 102 | 'data': { 103 | 'message': 'Invalid JSON was sent.' 104 | } 105 | }) 106 | 107 | # Test when there is no event 108 | ws_connection.write_message(json_encode({ 109 | 'data': {'message': 'my message'} 110 | })) 111 | 112 | response = yield ws_connection.read_message() 113 | response = json_decode(response) 114 | 115 | self.assertDictEqual(response, { 116 | 'event': 'warning', 117 | 'data': { 118 | 'message': 'There is no event in this JSON.' 119 | } 120 | }) 121 | 122 | # Test when the data is not a dict 123 | self.assertDictEqual(self.ws.events, {'hello': ANY}) 124 | 125 | ws_connection.write_message(json_encode({ 126 | 'event': 'hello', 127 | 'data': 'not a dict' 128 | })) 129 | 130 | response = yield ws_connection.read_message() 131 | response = json_decode(response) 132 | 133 | self.assertDictEqual(response, { 134 | 'event': 'warning', 135 | 'data': { 136 | 'message': 'The data should be a dictionary.' 137 | } 138 | }) 139 | 140 | # Test for socket and data params 141 | self.assertDictEqual(self.ws.events, {'hello': ANY}) 142 | 143 | ws_connection.write_message(json_encode({ 144 | 'event': 'hello', 145 | 'data': { 146 | 'foo': 'FOO', 147 | 'bar': 'BAR' 148 | } 149 | })) 150 | 151 | response = yield ws_connection.read_message() 152 | response = json_decode(response) 153 | 154 | self.assertDictEqual(response, { 155 | 'event': 'hello', 156 | 'data': { 157 | 'socket': str(self.ws.handlers[0]), 158 | 'message': 'Hello from hello callback!', 159 | 'data_sent': { 160 | 'foo': 'FOO', 161 | 'bar': 'BAR' 162 | } 163 | } 164 | }) 165 | 166 | @gen_test 167 | def test_on_message_without_context(self): 168 | ws = self.ws 169 | ws_connection = yield self.ws_connect('/ws/test') 170 | 171 | class WithoutContext(object): 172 | @ws.on 173 | def without_context(self, socket, data): 174 | assert self is None 175 | ws.emit('without_context', 'fail') 176 | 177 | WithoutContext() 178 | 179 | self.assertDictEqual(ws.events, { 180 | 'hello': ANY, 181 | 'without_context': ANY 182 | }) 183 | 184 | ws_connection.write_message(json_encode({'event': 'without_context'})) 185 | response = yield ws_connection.read_message() 186 | response = json_decode(response) 187 | 188 | self.assertDictEqual(response, { 189 | 'event': 'without_context', 190 | 'data': { 191 | 'message': 'fail' 192 | } 193 | }) 194 | 195 | self.close(ws_connection) 196 | 197 | @gen_test 198 | def test_on_message_with_context(self): 199 | ws = self.ws 200 | ws_connection = yield self.ws_connect('/ws/test') 201 | 202 | class WithContext(object): 203 | def __init__(self): 204 | ws.context = self 205 | 206 | @ws.on 207 | def with_context(self, socket, data): 208 | assert self is not None 209 | ws.emit('with_context', 'ok') 210 | 211 | WithContext() 212 | 213 | self.assertDictEqual(self.ws.events, { 214 | 'hello': ANY, 215 | 'with_context': ANY 216 | }) 217 | 218 | ws_connection.write_message(json_encode({'event': 'with_context'})) 219 | 220 | response = yield ws_connection.read_message() 221 | response = json_decode(response) 222 | 223 | self.assertDictEqual(response, { 224 | 'event': 'with_context', 225 | 'data': { 226 | 'message': 'ok' 227 | } 228 | }) 229 | 230 | self.close(ws_connection) 231 | 232 | @unittest.expectedFailure 233 | @gen_test(timeout=1) 234 | def test_on_message_when_nonexistent_event(self): 235 | ws_connection = yield self.ws_connect('/ws/test') 236 | 237 | # Test when the event is not binded 238 | self.assertDictEqual(self.ws.events, {'hello': ANY}) 239 | 240 | ws_connection.write_message(json_encode({ 241 | 'event': 'bye', 242 | 'data': {'message': 'Bye !'} 243 | })) 244 | 245 | # Throw TimeoutError and/or StopIteration, because WebSocketHandler.on_message() does not send 246 | # any message when the client send a nonexistent event ('bye' in our case). 247 | # Also, I don't know how catch them, because self.assertRaises() and try/catch don't work. 248 | # So I use @unittest.expectedFailure here, but it's a bit dirty imo. 249 | yield ws_connection.read_message() 250 | 251 | @gen_test 252 | def test_emit(self): 253 | ws_connection = yield self.ws_connect('/ws/test') 254 | 255 | self.assertEqual(self.ws.events, {'hello': ANY}) 256 | self.assertNotEqual(self.ws.handlers, []) 257 | self.ws.handlers[0].emit('my_event', {'my': 'data'}) 258 | 259 | response = yield ws_connection.read_message() 260 | response = json_decode(response) 261 | 262 | self.assertDictEqual(response, { 263 | 'event': 'my_event', 264 | 'data': { 265 | 'my': 'data' 266 | } 267 | }) 268 | 269 | self.close(ws_connection) 270 | 271 | @gen_test 272 | def test_emit_warning(self): 273 | ws_connection = yield self.ws_connect('/ws/test') 274 | 275 | self.assertEqual(self.ws.events, {'hello': ANY}) 276 | self.assertNotEqual(self.ws.handlers, []) 277 | self.ws.handlers[0].emit_warning('WARNING!') 278 | 279 | response = yield ws_connection.read_message() 280 | response = json_decode(response) 281 | 282 | self.assertDictEqual(response, { 283 | 'event': 'warning', 284 | 'data': { 285 | 'message': 'WARNING!' 286 | } 287 | }) 288 | 289 | self.close(ws_connection) 290 | 291 | @gen_test 292 | def test_on_close(self): 293 | self.assertEqual(self.ws.handlers, []) 294 | 295 | ws_connection = yield self.ws_connect('/ws/test') 296 | self.assertNotEqual(self.ws.handlers, []) 297 | 298 | self.close(ws_connection) 299 | yield self.close_future 300 | 301 | self.assertEqual(self.ws.handlers, []) 302 | -------------------------------------------------------------------------------- /tornado_websockets/tornadowrapper.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | import tornado 3 | import tornado.httpserver 4 | import tornado.ioloop 5 | import tornado.web 6 | import tornado.websocket 7 | 8 | 9 | class TornadoWrapper(object): 10 | """ 11 | Wrapper for Tornado application and server handling. 12 | 13 | It let you access to Tornado app, handlers and settings everywhere in your code (it's really 14 | useful when you run ``runtornado`` management command and WebSockets management). 15 | """ 16 | 17 | app = None 18 | server = None 19 | handlers = [] 20 | 21 | @classmethod 22 | def start_app(cls, handlers=None, settings=None): 23 | """ 24 | Initialize the Tornado web application with given handlers and settings. 25 | 26 | :param handlers: Handlers (routes) for Tornado 27 | :param settings: Settings for Tornado 28 | :type handlers: list 29 | :type settings: dict 30 | :return: None 31 | """ 32 | 33 | if not handlers: 34 | handlers = [] 35 | 36 | if not settings: 37 | settings = {} 38 | 39 | # Not `handlers += cls.handlers` because the wildcard handler should be the last value in handlers 40 | # list. See http://www.tornadoweb.org/en/stable/_modules/tornado/web.html#Application.add_handlers 41 | handlers = cls.handlers + handlers 42 | 43 | cls.app = tornado.web.Application(handlers, **settings) 44 | 45 | @classmethod 46 | def listen(cls, tornado_port): 47 | """ 48 | Start the Tornado HTTP server on given port. 49 | 50 | :param tornado_port: Port to listen 51 | :type tornado_port: int 52 | :return: None 53 | 54 | .. todo:: Add support for HTTPS server. 55 | """ 56 | 57 | if not cls.app: 58 | raise TypeError('Tornado application was not instantiated, call TornadoWrapper.start_app method.') 59 | 60 | cls.server = tornado.httpserver.HTTPServer(cls.app) 61 | cls.server.listen(tornado_port) 62 | 63 | @classmethod 64 | def loop(cls): 65 | """ 66 | Run Tornado main loop and display configuration about Tornado handlers and settings. 67 | 68 | :return: None 69 | """ 70 | tornado.ioloop.IOLoop.instance().start() 71 | 72 | @classmethod 73 | def add_handler(cls, handler): 74 | """ 75 | Add an handler to Tornado app if it's defined, otherwise it add this handler to the 76 | TornadoWrapper.tornado_handlers list. 77 | 78 | :param handler: An handler which conforms 79 | :type handler: list|tuple 80 | """ 81 | 82 | if isinstance(handler, tuple): 83 | handler = [handler] 84 | 85 | if cls.app: 86 | cls.app.add_handlers('.*', handler) 87 | else: 88 | # ``cls.handler = handler + cls.handler`` and not ``cls.handler += handler``, 89 | # see `TornadoWrapper.start_app` source to know why. 90 | cls.handlers = handler + cls.handlers 91 | -------------------------------------------------------------------------------- /tornado_websockets/websocket.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | from six import string_types 4 | 5 | from .exceptions import NotCallableError 6 | from .tornadowrapper import TornadoWrapper 7 | from .websockethandler import WebSocketHandler 8 | 9 | 10 | class WebSocket(object): 11 | """ 12 | Class that you should to make WebSocket applications 👍. 13 | """ 14 | 15 | def __init__(self, path): 16 | """ 17 | Initialize a new WebSocket object. 18 | 19 | :param path: path of your application, used to rely with dtws's client side. 20 | :type path: str 21 | """ 22 | 23 | self.events = {} 24 | self.handlers = [] 25 | self.context = None 26 | self.modules = [] 27 | 28 | if not isinstance(path, string_types): 29 | raise TypeError('« Path » parameter should be a string.') 30 | 31 | self.path = path.strip() 32 | self.path = self.path if self.path.startswith('/') else '/' + self.path 33 | 34 | TornadoWrapper.add_handler(('/ws' + self.path, WebSocketHandler, {'websocket': self})) 35 | 36 | def bind(self, module): 37 | """ 38 | Bind a Module instance to a WebSocket one. 39 | 40 | :param module: Module instance to bind 41 | :type module: tornado_websockets.modules.Module 42 | """ 43 | 44 | self.modules.append(module) 45 | module._websocket = self 46 | module.initialize() 47 | 48 | def on(self, callback): 49 | """ 50 | Should be used as a decorator. 51 | 52 | It will execute the decorated function when :class:`~tornado_websockets.websockethandler.WebSocketHandler` 53 | will receive an event where its name correspond to the function (by using ``__name__`` magic attribute). 54 | 55 | :param callback: Function to decorate. 56 | :type callback: callable 57 | :raise tornado_websockets.exceptions.NotCallableError: 58 | 59 | :Example: 60 | >>> ws = WebSocket('/example') 61 | >>> @ws.on 62 | ... def hello(socket, data): 63 | ... print('Received event « hello » from a client.') 64 | """ 65 | 66 | if not callable(callback): 67 | raise NotCallableError(callback) 68 | 69 | self.events[callback.__name__] = callback 70 | return callback 71 | 72 | def emit(self, event, data=None): 73 | """ 74 | Send an event/data dictionnary to all clients connected to your WebSocket instance. 75 | To see all ways to emit an event, please read « :ref:`emit-an-event` » section. 76 | 77 | :param event: event name 78 | :param data: a dictionary or a string which will be converted to ``{'message': data}`` 79 | :type event: str 80 | :type data: dict or str 81 | :raise: :class:`~tornado_websockets.exceptions.EmitHandlerError` if not used inside 82 | :meth:`@WebSocket.on() ` decorator. 83 | :raise: :class:`tornado.websocket.WebSocketClosedError` if connection is closed. 84 | 85 | .. warning:: 86 | :meth:`WebSocket.emit() ` method should be used inside 87 | a function or a class method decorated by :meth:`@WebSocket.on() 88 | ` decorator, otherwise it will raise a 89 | :class:`~tornado_websockets.exceptions.EmitHandlerError` exception. 90 | """ 91 | 92 | if not isinstance(event, string_types): 93 | raise TypeError('Param « event » should be a string.') 94 | 95 | if not data: 96 | data = {} 97 | 98 | if isinstance(data, string_types): 99 | data = {'message': data} 100 | 101 | if not isinstance(data, dict): 102 | raise TypeError('Param « data » should be a string or a dictionary.') 103 | 104 | if self.handlers: 105 | for handler in self.handlers: 106 | handler.emit(event, data) 107 | -------------------------------------------------------------------------------- /tornado_websockets/websockethandler.py: -------------------------------------------------------------------------------- 1 | # coding: utf-8 2 | 3 | import inspect 4 | 5 | import tornado 6 | import tornado.escape 7 | import tornado.httpserver 8 | import tornado.ioloop 9 | import tornado.web 10 | import tornado.websocket 11 | 12 | 13 | class WebSocketHandler(tornado.websocket.WebSocketHandler): 14 | """ 15 | Represents a WebSocket connection, wrapper of 16 | `tornado.websocket.WebSocketHandler `_ 17 | class. 18 | 19 | This class should not be instantiated directly; use the :class:`~tornado_websockets.websocket.WebSocket` class 20 | instead. 21 | """ 22 | 23 | def initialize(self, websocket): 24 | """ 25 | Called when class initialization, makes a link between a :class:`~tornado_websockets.websocket.WebSocket` 26 | instance and this object. 27 | 28 | :param websocket: instance of WebSocket. 29 | :type websocket: WebSocket 30 | """ 31 | 32 | # Make a link between a WebSocket instance and this object 33 | self.websocket = websocket 34 | websocket.handlers.append(self) 35 | 36 | def open(self): 37 | """ 38 | Called when the WebSocket is opened 39 | """ 40 | 41 | for event in self.websocket.events: 42 | if event.endswith('open'): 43 | self.on_message('{"event": "%s", "data": {}}' % event) 44 | 45 | def check_origin(self, origin): 46 | return True 47 | 48 | def on_message(self, message): 49 | """ 50 | Handle incoming messages on the WebSocket. 51 | 52 | :param message: JSON string 53 | :type message: str 54 | """ 55 | 56 | try: 57 | message = tornado.escape.json_decode(message) 58 | event = message.get('event') 59 | data = message.get('data') 60 | except ValueError: 61 | self.emit_warning('Invalid JSON was sent.') 62 | return 63 | 64 | if not event: 65 | self.emit_warning('There is no event in this JSON.') 66 | return 67 | 68 | if not self.websocket.events.get(event): 69 | return 70 | 71 | if not data: 72 | data = {} 73 | elif not isinstance(data, dict): 74 | self.emit_warning('The data should be a dictionary.') 75 | return 76 | 77 | callback = self.websocket.events.get(event) 78 | spec = inspect.getargspec(callback) 79 | kwargs = {} 80 | 81 | if 'self' in spec.args: 82 | kwargs['self'] = self.websocket.context 83 | if 'socket' in spec.args: 84 | kwargs['socket'] = self 85 | if 'data' in spec.args: 86 | kwargs['data'] = data 87 | 88 | return callback(**kwargs) 89 | 90 | def emit(self, event, data): 91 | """ 92 | Sends a given event/data combinaison to the client of this WebSocket. 93 | 94 | Wrapper for `tornado.websocket.WebSocketHandler.write_message `_ method. 96 | 97 | :param event: event name to emit 98 | :param data: associated data 99 | :type event: str 100 | :type data: dict 101 | """ 102 | 103 | self.write_message({ 104 | 'event': event, 105 | 'data': data 106 | }) 107 | 108 | def emit_warning(self, message): 109 | """ 110 | Shortuct to emit a warning. 111 | 112 | :param message: error message 113 | :type message: str 114 | """ 115 | 116 | return self.emit('warning', {'message': message}) 117 | 118 | def on_close(self): 119 | """ 120 | Called when the WebSocket is closed, delete the link between this object and its WebSocket. 121 | """ 122 | 123 | self.websocket.handlers.remove(self) 124 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | # Tox (http://codespeak.net/~hpk/tox/) is a tool for running tests 2 | # in multiple virtualenvs. This configuration file will run the 3 | # test suite on all supported python versions. To use it, "pip install tox" 4 | # and then run "tox" from this directory. 5 | 6 | [flake8] 7 | max-line-length = 119 8 | max-complexity = 10 9 | ignore = F401 10 | 11 | [tox] 12 | minversion = 1.8.0 13 | envlist = 14 | py{27,33,34,35}-django18 15 | py{27,34,35}-django19 16 | py{27,34,35}-django110 17 | 18 | [testenv] 19 | setenv = 20 | DJANGO_SETTINGS_MODULE=testsettings 21 | PYTHONPATH = {toxinidir} 22 | PYTHONDONTWRITEBYTECODE = 1 23 | 24 | whitelist_externals = 25 | bash 26 | 27 | commands = 28 | bash {toxinidir}/clean.sh 29 | 30 | python --version 31 | 32 | python setup.py install 33 | flake8 tornado_websockets 34 | python manage.py migrate 35 | python manage.py collectstatic --noinput 36 | 37 | coverage erase 38 | coverage run manage.py test -v 2 --failfast 39 | coverage report -m 40 | coverage html 41 | 42 | deps = 43 | django18: django >=1.8,<1.9 44 | django19: django >=1.9a1,<1.10 45 | django110: django >=1.10a1,<1.11 46 | tornado 47 | six 48 | flake8 49 | mock 50 | coverage 51 | coveralls 52 | --------------------------------------------------------------------------------