add uvloop optional dependency (#145)

.github/workflows/release.yaml

@@ -16,7 +16,7 @@ jobs:
         with:
           python-version: 3.7
       - name: "Install dependencies"
-        run: "pip install -r dev-requirements.txt"
+        run: "pip install -r requirements/dev-requirements.txt"
       - name: "Publish to PyPI"
         run: "./scripts/release.sh"
         env:

.github/workflows/tests.yaml

@@ -22,9 +22,9 @@ jobs:
             - name: Install dependencies
               run: |
                   python -m pip install --upgrade pip
-                  pip install -r requirements.txt
-                  pip install -r dev-requirements.txt
-                  pip install -r tests/test-requirements.txt
+                  pip install -r requirements/requirements.txt
+                  pip install -r requirements/dev-requirements.txt
+                  pip install -r requirements/test-requirements.txt
             - name: Lint
               run: ./scripts/lint.sh
 
@@ -62,8 +62,8 @@ jobs:
             - name: Install dependencies
               run: |
                   python -m pip install --upgrade pip
-                  pip install -r requirements.txt
-                  pip install -r tests/test-requirements.txt
+                  pip install -r requirements/requirements.txt
+                  pip install -r requirements/test-requirements.txt
             - name: Setup postgres
               run: |
                   export PGPASSWORD=postgres
@@ -97,8 +97,8 @@ jobs:
             - name: Install dependencies
               run: |
                   python -m pip install --upgrade pip
-                  pip install -r requirements.txt
-                  pip install -r tests/test-requirements.txt
+                  pip install -r requirements/requirements.txt
+                  pip install -r requirements/test-requirements.txt
             - name: Test with pytest, SQLite
               run: ./scripts/test-sqlite.sh
             - name: Upload coverage

.gitignore

@@ -15,3 +15,5 @@ _build/
 *.sqlite
 htmlcov/
 prof/
+.env/
+.venv/

docs/src/piccolo/getting_started/installing_piccolo.rst

@@ -21,6 +21,10 @@ Now install piccolo, ideally inside a `virtualenv <https://docs.python-guide.org
     # The important bit:
     pip install piccolo
 
-    # For optional orjson support, which improves JSON serialisation
-    # performance:
+    # Optional: orjson for improved JSON serialisation performance
     pip install piccolo[orjson]
+
+    # Optional: uvloop as default event loop instead of asyncio
+    # If using Piccolo with Uvicorn, Uvicorn will set uvloop as
+    # default event loop if installed
+    pip install piccolo[uvloop]

piccolo/main.py

@@ -3,6 +3,13 @@
 
 from targ import CLI  # type: ignore
 
+try:
+    import uvloop  # type: ignore
+
+    uvloop.install()
+except ImportError:
+    pass
+
 from piccolo.apps.app.piccolo_app import APP_CONFIG as app_config
 from piccolo.apps.asgi.piccolo_app import APP_CONFIG as asgi_config
 from piccolo.apps.meta.piccolo_app import APP_CONFIG as meta_config

requirements/README.md

@@ -0,0 +1,6 @@
+# Requirement files
+
+* `extras` - Optional dependencies of `Piccolo`.
+* `dev-requirements.txt` - Requirements needed to develop `Piccolo`.
+* `requirements.txt` - Default requirements of `Piccolo`.
+* `test-requirements.txt` - Requirements needed to run `Piccolo` tests.

requirements/extras/orjson.txt

@@ -0,0 +1 @@
+orjson==3.4.1

requirements/extras/playground.txt

@@ -0,0 +1 @@
+ipython

requirements/extras/uvloop.txt

@@ -0,0 +1 @@
+uvloop>=0.12.0

tests/test-requirements.txt → requirements/test-requirements.txt

@@ -1,6 +1,5 @@
 coveralls==2.2.0
 flake8==3.8.4
-mypy==0.790
 pytest-cov==2.10.1
 pytest==6.2.1
 python-dateutil==2.8.1

setup.py

@@ -2,23 +2,48 @@
 # -*- coding: utf-8 -*-
 
 import os
+from typing import List
 from setuptools import find_packages, setup
 
 from piccolo import __VERSION__ as VERSION
 
 
 directory = os.path.abspath(os.path.dirname(__file__))
 
-
-with open(os.path.join(directory, "requirements.txt")) as f:
-    contents = f.read()
-    REQUIREMENTS = [i.strip() for i in contents.strip().split("\n")]
+extras = ["orjson", "playground", "uvloop"]
 
 
 with open(os.path.join(directory, "README.md")) as f:
     LONG_DESCRIPTION = f.read()
 
 
+def parse_requirement(req_path: str) -> List[str]:
+    """
+    Parse requirement file.
+    Example:
+        parse_requirement('requirements.txt')       # requirements/requirements.txt
+        parse_requirement('extras/playground.txt')  # requirements/extras/playground.txt
+    Returns:
+        List[str]: list of requirements specified in the file.
+    """
+    with open(os.path.join(directory, "requirements", req_path)) as f:
+        contents = f.read()
+        return [i.strip() for i in contents.strip().split("\n")]
+
+
+def extras_require():
+    """
+    Parse requirements in requirements/extras directory
+    """
+    extra_requirements = {}
+    for extra in extras:
+        extra_requirements[extra] = parse_requirement(
+            os.path.join("extras", extra + ".txt")
+        )
+
+    return extra_requirements
+
+
 setup(
     name="piccolo",
     version=VERSION,
@@ -41,8 +66,8 @@
         ],
         "piccolo": ["py.typed"],
     },
-    install_requires=REQUIREMENTS,
-    extras_require={"orjson": ["orjson==3.4.1"], "playground": ["ipython"]},
+    install_requires=parse_requirement("requirements.txt"),
+    extras_require=extras_require(),
     license="MIT",
     classifiers=[
         "License :: OSI Approved :: MIT License",