move package to src dir

Author: rmorshea

.github/workflows/test.yml

@@ -11,42 +11,39 @@ on:
     - cron: "0 0 * * *"
 
 jobs:
-  test-linux:
+  coverage:
     runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        python-version: [3.7, 3.8, 3.9]
     steps:
       - uses: actions/checkout@v2
       - uses: nanasess/setup-chromedriver@master
       - uses: actions/setup-node@v2-beta
         with:
           node-version: "12"
-      - name: Use Python ${{ matrix.python-version }}
+      - name: Use Latest Python
         uses: actions/setup-python@v2
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: 3.9
       - name: Install Python Dependencies
         run: pip install -r requirements/test-run.txt
       - name: Run Tests
         run: |
           nox -s test -- pytest[--headless]
-  test-other-systems:
+  matrix:
     runs-on: ${{ matrix.os }}
     strategy:
-      fail-fast: false
       matrix:
-        os: [ macos-latest, windows-latest ]
+        python-version: [3.7, 3.8, 3.9]
+        os: [ubuntu-latest, macos-latest, windows-latest]
     steps:
       - uses: actions/checkout@v2
       - uses: nanasess/setup-chromedriver@master
       - uses: actions/setup-node@v2-beta
         with:
           node-version: "12"
-      - name: Use Python 3.9
+      - name: Use Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
-          python-version: 3.9
+          python-version: ${{ matrix.python-version }}
       - name: Install Python Dependencies
         run: pip install -r requirements/test-run.txt
       - name: Run Tests

MANIFEST.in

@@ -1,10 +1,6 @@
-recursive-include idom/client/app *
-recursive-exclude idom/client/app/node_modules *
-recursive-exclude idom/client/app/web_modules *
-recursive-exclude idom/client/build *
-include idom/py.typed
-include LICENSE
+recursive-include src/idom *
+recursive-exclude src/idom/client/app/node_modules *
+recursive-exclude src/idom/client/app/web_modules *
+recursive-exclude src/idom/client/build *
 include requirements/prod.txt
 include requirements/extras.txt
-include README.md
-include scripts/build.sh

noxfile.py

@@ -87,9 +87,14 @@ def test_python(session: Session) -> None:
     """Run the Python-based test suite"""
     session.env["IDOM_DEBUG_MODE"] = "1"
     session.install("-r", "requirements/test-env.txt")
-    session.install(".[all]")
-    args = ["pytest", "tests"] + get_posargs("pytest", session)
-    session.run(*args)
+
+    pytest_args = get_posargs("pytest", session)
+    if "--no-cov" in pytest_args:
+        session.install(".[all]")
+    else:
+        session.install("-e", ".[all]")
+
+    session.run("pytest", "tests", *pytest_args)
 
 
 @nox.session
@@ -98,14 +103,14 @@ def test_types(session: Session) -> None:
     session.install("-r", "requirements/check-types.txt")
     session.install("-r", "requirements/pkg-deps.txt")
     session.install("-r", "requirements/pkg-extras.txt")
-    session.run("mypy", "--strict", "idom")
+    session.run("mypy", "--strict", "src/idom")
 
 
 @nox.session
 def test_style(session: Session) -> None:
     """Check that style guidelines are being followed"""
     session.install("-r", "requirements/check-style.txt")
-    session.run("flake8", "idom", "tests", "docs")
+    session.run("flake8", "src/idom", "tests", "docs")
     black_default_exclude = r"\.eggs|\.git|\.hg|\.mypy_cache|\.nox|\.tox|\.venv|\.svn|_build|buck-out|build|dist"
     session.run(
         "black",

scripts/__init__.py

@@ -13,14 +13,14 @@ max-line-length = 88
 max-complexity = 18
 select = B,C,E,F,W,T4,B9,N,ROH
 exclude =
-    idom/client/app/node_modules/*
+    src/idom/client/app/node_modules/*
     .eggs/*
     .tox/*
 
 [tool:pytest]
 testpaths = tests
 xfail_strict = True
-addopts = --cov=idom --cov-report term
+addopts = --cov=src/idom --cov-report term
 markers =
     slow: marks tests as slow (deselect with '-m "not slow"')
 
@@ -30,11 +30,11 @@ show_missing = True
 skip_covered = True
 sort = Name
 exclude_lines =
-    pragma: no cover
+    coverage: skip
     \.\.\.
     raise NotImplementedError
 omit =
-    idom/__main__.py
+    src/idom/__main__.py
 
 [build_sphinx]
 all-files = true

setup.cfg

@@ -1,6 +1,5 @@
 from __future__ import print_function
 
-import os
 import pipes
 import shutil
 import subprocess
@@ -9,6 +8,7 @@
 from distutils import log
 from distutils.command.build import build  # type: ignore
 from distutils.command.sdist import sdist  # type: ignore
+from pathlib import Path
 
 from setuptools import find_packages, setup
 from setuptools.command.develop import develop
@@ -25,8 +25,9 @@ def list2cmdline(cmd_list):
 name = "idom"
 
 # basic paths used to gather files
-here = os.path.abspath(os.path.dirname(__file__))
-root = os.path.join(here, name)
+root_dir = Path(__file__).parent
+src_dir = root_dir / "src"
+package_dir = src_dir / name
 
 
 # -----------------------------------------------------------------------------
@@ -37,7 +38,8 @@ def list2cmdline(cmd_list):
 package = {
     "name": name,
     "python_requires": ">=3.7",
-    "packages": find_packages(exclude=["tests*"]),
+    "packages": find_packages(str(src_dir)),
+    "package_dir": {"": "src"},
     "description": "Control the web with Python",
     "author": "Ryan Morshead",
     "author_email": "[email protected]",
@@ -76,16 +78,16 @@ def list2cmdline(cmd_list):
 
 
 requirements = []
-with open(os.path.join(here, "requirements", "pkg-deps.txt"), "r") as f:
+with (root_dir / "requirements" / "pkg-deps.txt").open() as f:
     for line in map(str.strip, f):
         if not line.startswith("#"):
             requirements.append(line)
 package["install_requires"] = requirements
 
 _current_extras = []
 extra_requirements = {"all": []}  # type: ignore
-extra_requirements_path = os.path.join(here, "requirements", "pkg-extras.txt")
-with open(extra_requirements_path, "r") as f:
+extra_requirements_path = root_dir / "requirements" / "pkg-extras.txt"
+with extra_requirements_path.open() as f:
     for line in map(str.strip, f):
         if line.startswith("#") and line[1:].strip().startswith("extra="):
             _current_extras = [e.strip() for e in line.split("=", 1)[1].split(",")]
@@ -98,8 +100,9 @@ def list2cmdline(cmd_list):
                 extra_requirements[e].append(line)
             extra_requirements["all"].append(line)
         elif line:
-            msg = "No '# extra=<name>' header before requirements in %r"
-            raise ValueError(msg % extra_requirements_path)
+            raise ValueError(
+                f"No '# extra=<name>' header before requirements in {extra_requirements_path}"
+            )
 package["extras_require"] = extra_requirements
 
 
@@ -108,7 +111,7 @@ def list2cmdline(cmd_list):
 # -----------------------------------------------------------------------------
 
 
-with open(os.path.join(here, "README.md")) as f:
+with (root_dir / "README.md").open() as f:
     long_description = f.read()
 
 package["long_description"] = long_description
@@ -125,7 +128,7 @@ class Command(cls):
         def run(self):
             log.info("Installing Javascript...")
             try:
-                js_dir = os.path.join(root, "client", "app")
+                js_dir = str(package_dir / "client" / "app")
                 for cmd, *args in map(str.split, ["npm install", "npm run build"]):
                     which_cmd = shutil.which(cmd)
                     if which_cmd is None:

setup.py

@@ -3,7 +3,7 @@
 
 try:
     __version__: str = _get_distribution(__name__).version
-except _DistributionNotFound:  # pragma: no cover
+except _DistributionNotFound:  # coverage: skip
     # package is not installed
     __version__ = "0.0.0"
 
@@ -24,7 +24,7 @@
     import htm
     import pyalect
     import tagged
-except ImportError:  # pragma: no cover
+except ImportError:  # coverage: skip
     pass
 else:
     from . import dialect

idom/__init__.py renamed to src/idom/__init__.py

@@ -27,7 +27,7 @@ def _copy_to_build_dir(source: Path) -> None:
     shutil.copytree(source, BUILD_DIR, symlinks=True)
 
 
-if not BUILD_DIR.exists():  # pragma: no cover
+if not BUILD_DIR.exists():  # coverage: skip
     _copy_to_build_dir(BACKUP_BUILD_DIR)
 
 
@@ -129,7 +129,7 @@ def build(packages_to_install: Sequence[str], clean_build: bool = False) -> None
 
     not_discovered = package_names_to_install.difference(web_module_names())
     if not_discovered:
-        raise RuntimeError(  # pragma: no cover
+        raise RuntimeError(  # coverage: skip
             f"Successfuly installed {list(package_names_to_install)} but "
             f"failed to discover {list(not_discovered)} post-install."
         )
@@ -147,7 +147,7 @@ def _run_subprocess(args: List[str], cwd: Path) -> None:
     cmd, *args = args
     which_cmd = shutil.which(cmd)
     if which_cmd is None:
-        raise RuntimeError(  # pragma: no cover
+        raise RuntimeError(  # coverage: skip
             f"Failed to run command - {cmd!r} is not installed."
         )
     try:
@@ -158,6 +158,6 @@ def _run_subprocess(args: List[str], cwd: Path) -> None:
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE,
         )
-    except subprocess.CalledProcessError as error:  # pragma: no cover
+    except subprocess.CalledProcessError as error:  # coverage: skip
         raise subprocess.SubprocessError(error.stderr.decode()) from error
     return None

idom/__main__.py renamed to src/idom/__main__.py

@@ -3,7 +3,7 @@
 from functools import wraps
 from typing import TYPE_CHECKING, Any, Callable, Dict, Tuple, Union
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:  # coverage: skip
     from .vdom import VdomDict  # noqa
 
 

idom/_options.py renamed to src/idom/_options.py

@@ -134,7 +134,7 @@ def __iter__(self) -> Iterator[str]:
     def __getitem__(self, key: str) -> "EventHandler":
         return self._handlers[key]
 
-    def __repr__(self) -> str:  # pragma: no cover
+    def __repr__(self) -> str:  # coverage: skip
         return repr(self._handlers)
 
 
@@ -229,5 +229,5 @@ def __contains__(self, function: Any) -> bool:
         else:
             return function in self._func_handlers
 
-    def __repr__(self) -> str:  # pragma: no cover
+    def __repr__(self) -> str:  # coverage: skip
         return f"{type(self).__name__}({self.serialize()})"

idom/cli.py renamed to src/idom/cli.py

@@ -67,7 +67,7 @@ class Layout(HasAsyncResources):
 
     __slots__ = ["root", "_event_handlers"]
 
-    if not hasattr(abc.ABC, "__weakref__"):  # pragma: no cover
+    if not hasattr(abc.ABC, "__weakref__"):  # coverage: skip
         __slots__.append("__weakref__")
 
     def __init__(self, root: "AbstractComponent") -> None:

idom/client/__init__.py renamed to src/idom/client/__init__.py

@@ -14,9 +14,9 @@
     overload,
 )
 
-if sys.version_info >= (3, 7):  # pragma: no cover
+if sys.version_info >= (3, 7):  # coverage: skip
     from contextlib import AsyncExitStack, asynccontextmanager  # noqa
-else:  # pragma: no cover
+else:  # coverage: skip
     from async_exit_stack import AsyncExitStack
     from async_generator import asynccontextmanager
 

idom/client/app/.gitignore renamed to src/idom/client/app/.gitignore

@@ -44,9 +44,9 @@ def run(self, host: str, port: int, *args: Any, **kwargs: Any) -> None:
         if self._app is None:
             app = self._default_application(self._config)
             self.register(app)
-        else:  # pragma: no cover
+        else:  # coverage: skip
             app = self._app
-        if not self._daemonized:  # pragma: no cover
+        if not self._daemonized:  # coverage: skip
             return self._run_application(self._config, app, host, port, args, kwargs)
         else:
             return self._run_application_in_thread(
@@ -76,7 +76,7 @@ def register(self: _Self, app: Optional[_App]) -> _Self:
     def wait_until_server_start(self, timeout: float = 3.0) -> None:
         """Block until the underlying application has started"""
         if not self._server_did_start.wait(timeout=timeout):
-            raise RuntimeError(  # pragma: no cover
+            raise RuntimeError(  # coverage: skip
                 f"Server did not start within {timeout} seconds"
             )
 

idom/client/app/README.md renamed to src/idom/client/app/README.md

@@ -43,7 +43,7 @@ class FlaskRenderServer(AbstractRenderServer[Flask, Config]):
     def stop(self, timeout: Optional[float] = None) -> None:
         try:
             server = self._wsgi_server
-        except AttributeError:  # pragma: no cover
+        except AttributeError:  # coverage: skip
             raise RuntimeError(
                 f"Application is not running or was not started by {self}"
             )
@@ -70,7 +70,7 @@ def _setup_application(self, config: Config, app: Flask) -> None:
         self._setup_blueprint_routes(config, bp)
 
         cors_config = config["cors"]
-        if cors_config:  # pragma: no cover
+        if cors_config:  # coverage: skip
             cors_params = cors_config if isinstance(cors_config, dict) else {}
             CORS(bp, **cors_params)
 
@@ -162,7 +162,7 @@ def _generic_run_application(
         **kwargs: Any,
     ) -> None:
         if debug:
-            logging.basicConfig(level=logging.DEBUG)  # pragma: no cover
+            logging.basicConfig(level=logging.DEBUG)  # coverage: skip
         logging.debug("Starting server...")
         self._wsgi_server = _StartCallbackWSGIServer(
             self._server_did_start.set,
@@ -272,7 +272,7 @@ def update_environ(self) -> None:
         """
         super().update_environ()
         # BUG: for some reason coverage doesn't seem to think this line is covered
-        self._before_first_request_callback()  # pragma: no cover
+        self._before_first_request_callback()  # coverage: skip
 
 
 def _join_url_paths(*args: str) -> str:

idom/client/app/idom-logo-square-small.svg renamed to src/idom/client/app/idom-logo-square-small.svg

@@ -44,14 +44,14 @@ def run(
         The server instance. This isn't really useful unless the server is spawned
         as a daemon. Otherwise this function blocks until the server has stopped.
     """
-    if server_type is None:  # pragma: no cover
+    if server_type is None:  # coverage: skip
         raise ValueError("No default server available.")
-    if port is None:  # pragma: no cover
+    if port is None:  # coverage: skip
         port = find_available_port(host)
 
     server = server_type(component, server_config)
 
-    if app is not None:  # pragma: no cover
+    if app is not None:  # coverage: skip
         server.register(app)
 
     run_server = server.run if not daemon else server.daemon