winloop 0.0.1__tar.gz

winloop-0.0.1/LICENSE-APACHE

@@ -0,0 +1,203 @@
+Copyright (C) 2023-present Vizonex, the winloop authors and winloop contributors.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (C) 2023-present Vizonex, the winloop authors and winloop contributors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

winloop-0.0.1/LICENSE-MIT

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (C) 2023-present Vizonex , winloop authors and the winloop contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

winloop-0.0.1/PKG-INFO

@@ -0,0 +1,265 @@
+Metadata-Version: 2.1
+Name: winloop
+Version: 0.0.1
+Summary: An Alternative library for uvloop compatability with windows
+Author: Vizonex
+License: MIT
+Keywords: winloop,libuv,windows,cython,fast-asyncio,uvloop-alternative
+Platform: Microsoft Windows
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Intended Audience :: Developers
+Classifier: Framework :: AsyncIO
+Description-Content-Type: text/markdown
+License-File: LICENSE-APACHE
+License-File: LICENSE-MIT
+
+![Alt text](https://raw.githubusercontent.com/Vizonex/Winloop/main/winloop.png)
+
+# Winloop
+An Alternative library for uvloop compatability with windows Because let's face it. Window's python asyncio can be garabage at times. 
+I never really liked the fact that I couldn't make anything run faster escpecially when you have fiber internet connections in place. 
+It always felt dissapointing when libuv is avalible on windows but doesn't have uvloop compatability. 
+So I went ahead and downloaded the uvloop source code and modified the library to be windows compatable. 
+
+"This library was inpired by the MagicStack Team and I take no credit for the original code that I had to modify." - Vizonex 
+
+link to the original library by MagicStack https://github.com/MagicStack/uvloop
+
+The differences with uvloop is that OS forking has been fully disabled and some smaller api calls had to be changed. Subprocesses instead release the gil instead of forking out although I might change that in the future. If handling asynchronous subprocesses becomes a problem to handle...
+
+
+However there is a perfromance increase of about 5 times vs using the `WindowsSelectorEventLoopPolicy` and `WindowsProactorEventLoopPolicy` which has ssl problems in python 3.9. Winloop is a very good replacement for that as well.
+
+
+
+
+## How to install Winloop on your windows OS 
+
+```
+pip install winloop
+```
+
+you can also clone the reposity and build the extension yourself by running if you wish to use/build the extension locally 
+
+```
+python setup.py build_ext --inplace 
+```
+
+This project is still in it's beta phase and may have some sneaky bugs that we didn't catch yet, so if you find find any bugs you can report them to our github repository.
+
+
+
+```python
+try:
+    import aiohttp
+    import aiohttp.web
+except ImportError:
+    skip_tests = True
+else:
+    skip_tests = False
+
+import asyncio
+import unittest
+import weakref
+import winloop
+import sys
+
+class TestAioHTTP(unittest.TestCase):
+    def __init__(self, methodName: str = "test_aiohttp_basic_1") -> None:
+        super().__init__(methodName)
+       
+
+    def setUp(self):
+        self.loop = asyncio.get_event_loop()
+
+    def test_aiohttp_basic_1(self):
+        PAYLOAD = '<h1>It Works!</h1>' * 10000
+
+        async def on_request(request):
+            return aiohttp.web.Response(text=PAYLOAD)
+
+        asyncio.set_event_loop(self.loop)
+        app = aiohttp.web.Application()
+        app.router.add_get('/', on_request)
+
+        runner = aiohttp.web.AppRunner(app)
+        self.loop.run_until_complete(runner.setup())
+        site = aiohttp.web.TCPSite(runner, '0.0.0.0', '10000')
+        self.loop.run_until_complete(site.start())
+        port = site._server.sockets[0].getsockname()[1]
+
+        async def test():
+            # Make sure we're using the correct event loop.
+            self.assertIs(asyncio.get_event_loop(), self.loop)
+
+            for addr in (('localhost', port),
+                         ('127.0.0.1', port)):
+                async with aiohttp.ClientSession() as client:
+                    async with client.get('http://{}:{}'.format(*addr)) as r:
+                        self.assertEqual(r.status, 200)
+                        result = await r.text()
+                        self.assertEqual(result, PAYLOAD)
+
+        self.loop.run_until_complete(test())
+        self.loop.run_until_complete(runner.cleanup())
+
+    def test_aiohttp_graceful_shutdown(self):
+        async def websocket_handler(request):
+            ws = aiohttp.web.WebSocketResponse()
+            await ws.prepare(request)
+            request.app['websockets'].add(ws)
+            try:
+                async for msg in ws:
+                    await ws.send_str(msg.data)
+            finally:
+                request.app['websockets'].discard(ws)
+            return ws
+
+        async def on_shutdown(app):
+            for ws in set(app['websockets']):
+                await ws.close(
+                    code=aiohttp.WSCloseCode.GOING_AWAY,
+                    message='Server shutdown')
+
+        asyncio.set_event_loop(self.loop)
+        app = aiohttp.web.Application()
+        app.router.add_get('/', websocket_handler)
+        app.on_shutdown.append(on_shutdown)
+        app['websockets'] = weakref.WeakSet()
+
+        runner = aiohttp.web.AppRunner(app)
+        self.loop.run_until_complete(runner.setup())
+        site = aiohttp.web.TCPSite(runner, '0.0.0.0', '10000')
+        self.loop.run_until_complete(site.start())
+        port = site._server.sockets[0].getsockname()[1]
+
+        async def client():
+            async with aiohttp.ClientSession() as client:
+                async with client.ws_connect(
+                        'http://127.0.0.1:{}'.format(port)) as ws:
+                    await ws.send_str("hello")
+                    async for msg in ws:
+                        assert msg.data == "hello"
+
+        client_task = asyncio.ensure_future(client())
+
+        async def stop():
+            await asyncio.sleep(0.1)
+            try:
+                await asyncio.wait_for(runner.cleanup(), timeout=0.1)
+            except Exception as e:
+                print(e)
+            finally:
+                try:
+                    client_task.cancel()
+                    await client_task
+                except asyncio.CancelledError:
+                    pass
+
+        self.loop.run_until_complete(stop())
+
+
+
+if __name__ == "__main__":
+    # print("tesing without winloop")
+    # asyncio.DefaultEventLoopPolicy = asyncio.WindowsSelectorEventLoopPolicy
+    # asyncio.DefaultEventLoopPolicy = asyncio.WindowsProactorEventLoopPolicy
+    unittest.main()
+    # Looks like winloop might be 3x faster than the Proctor Event Loop , THAT's A HUGE IMPROVEMENT! 
+    print("testing again but with winloop enabled")
+    winloop.install()
+    unittest.main()
+```
+
+The benchmarks for the code above are as follows 
+
+## Benchmarks
+
+### TCP Connections 
+-------------------
+
+| Asyncio Event Loop Policy         | Time (in Seconds)     |          
+|-----------------------------------|-----------------------|
+| WinLoopPolicy                     | 0.493s                |
+| WindowsProactorEventLoopPolicy    | 2.510s                |
+| WindowsSelectorEventLoopPolicy    | 2.723s                |
+
+
+That's a massive increase and jump from just TCP alone I'll be posting more benchmarks soon as 
+I modify more of the current test suites made by uvloop...
+
+
+## How to Use Winloop with Fastapi 
+
+This was a cool little script I put together Just to make fastapi that much faster to handle
+
+```python
+
+from fastapi import FastAPI
+from fastapi.responses import HTMLResponse
+import winloop 
+import uvicorn
+import asyncio 
+import datetime 
+
+app = FastAPI()
+
+@app.on_event("startup")
+def make_assertion():
+    # Check to make sure that we bypassed the original eventloop Policy....
+    assert isinstance(asyncio.get_event_loop_policy(), winloop.WinLoopPolicy)
+
+
+@app.get("/test")
+async def test_get_request():
+    return HTMLResponse("<html><body><h1>FAST API WORKS WITH WINLOOP!</h1></body></html>")
+
+
+# starllete will use asyncio.to_thread() so that this can remain asynchronous 
+@app.get("/date")
+def test_dynamic_response():
+    return str(datetime.datetime.now())
+
+
+# Although tricky to pass and is not normal, it does in fact work...
+if __name__ == "__main__":
+    winloop.install()
+    # Winloop's eventlooppolicy will be passed to uvicorn after this point...
+    loop = asyncio.get_event_loop()
+    config = uvicorn.Config(app=app,port=10000,loop=loop)
+    server = uvicorn.Server(config)
+    asyncio.run(server.serve())
+```
+
+
+## How To Use Winloop When Uvloop is not avalible
+
+```python
+
+# Here's A small Example of using winloop when uvloop is not avalible to us
+import sys
+import aiohttp
+import asyncio 
+
+async def main():
+    async with aiohttp.ClientSession("https://httpbin.org") as client:
+        async with client.get("/ip") as resp:
+            print(await resp.json())
+
+if __name__ == "__main__":
+    if sys.platform in ('win32', 'cygwin', 'cli'):
+        from winloop import install
+    else:
+        # if we're on apple or linux do this instead
+        from uvloop import install 
+    install()
+    asyncio.run(main())
+  ```
+
+
+
+
+
+

winloop-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

winloop-0.0.1/setup.py

@@ -0,0 +1,90 @@
+from setuptools import Extension, setup
+import pathlib 
+import sys 
+try:
+    from Cython.Build import cythonize
+except:
+    print("please install cython first")
+    sys.exit(1)
+
+
+
+HERE = pathlib.Path("winloop")
+long_description = open('readme.md').read()
+
+__version__ = "0.0.1"
+
+
+
+# This is a temporary test Solution and is not the official file yet but this is to display/show what 
+# I'm currently using to compile the winloop library...
+def do_installation():
+
+
+    # "Thank goodness we don't have to dig out the libpath ourselves I almost vomited" - Vizonex            
+    Windows_Libraries = [
+        "Shell32.lib",
+        "Ws2_32.lib",
+        "Advapi32.lib",
+        "iphlpapi.lib",
+        "WSock32.lib",
+        "Userenv.lib",
+        "User32.lib"
+    ]
+
+    ext = [
+        Extension("winloop",["winloop\\loop.pyx"], 
+            # NOTE uv_a.lib will be user-compiled when 
+            # I've fixed the install there's still been some probelms with compiling fs-poll.c on it's own...
+            extra_link_args=Windows_Libraries + ["winloop\\vendor\\uv_a.lib"],
+            # I have some macros setup for now to help me with debugging - Vizonex
+            library_dirs=["winloop"],
+            define_macros=[
+                ('_GNU_SOURCE', 1),
+                ('WIN32', 1),
+                ("_WIN32_WINNT","0x0602")
+            ],
+            # Just incase, Try Optimzing a bit further....
+            extra_compile_args=["/O2"]
+        )
+    ]
+
+
+    setup(
+        name="winloop",
+        author="Vizonex",
+        version=__version__,
+        description="""An Alternative library for uvloop compatability with windows""",
+        ext_modules=cythonize(ext),
+        license="MIT",
+        platforms=['Microsoft Windows'],
+        keywords=[
+            "winloop", 
+            "libuv", 
+            "windows", 
+            "cython",
+            "fast-asyncio",
+            "uvloop-alternative"
+        ],
+        long_description_content_type='text/markdown',
+        long_description=long_description,
+        classifiers=[
+            'Programming Language :: Python :: 3.9',
+            'Programming Language :: Python :: 3.10',
+            'Programming Language :: Python :: 3.11',
+            'Intended Audience :: Developers',
+            'Framework :: AsyncIO'
+        ],
+        install_requires=["cython"]
+    )
+
+if __name__ == "__main__":
+
+    if sys.platform not in ('win32', 'cygwin', 'cli'):
+        # TODO (Vizonex) Ask uvloop Owners/contributors if it would be ok or acceptable to recommend 
+        # this library as an alternative resource for any users on windows 
+        raise RuntimeError("Winloop is Only Avalible for Windows Users Please try installing uvloop instead, you won't be dissapointed with it...")
+
+    do_installation()
+    
+