inboard depends on gunicorn, which in turn depends on setuptools for pkg_resources. Unfortunately this sub-dependency is not mentioned in the poetry.lock file. That means when building a docker file as described in the docs, RUN poetry install will actually uninstall setuptools.

   - Removing setuptools (65.4.1)

That in turn breaks guincorn.

Traceback (most recent call last):
ModuleNotFoundError: No module named 'pkg_resources'
    import pkg_resources
  File "/app/.venv/lib/python3.10/site-packages/gunicorn/util.py", line 25, in <module>
    from gunicorn import util
  File "/app/.venv/lib/python3.10/site-packages/gunicorn/app/base.py", line 11, in <module>
    from gunicorn.app.base import Application
  File "/app/.venv/lib/python3.10/site-packages/gunicorn/app/wsgiapp.py", line 9, in <module>
    from gunicorn.app.wsgiapp import run
  File "/app/.venv/bin/gunicorn", line 5, in <module>

All I did for this PR is run poetry lock in the repository. It added setuptools in line 199 of poetry.lock as well as in the [metadata.files] section.

Description

This PR will add Python 3.10 support to inboard.

Changes

GitHub Actions

• [x] Add Python 3.10 to GitHub Actions workflows
• [x] Update to stable Python 3.10 when it is released
  • What's new in Python 3.10
  • actions/python-versions 3.10.0
  • actions/setup-python#249
• [x] Update Python version syntax to enclose version numbers in quotes
  • Python versions must now be quoted in YAML. 3.10 (without quotes) is interpreted as a float and becomes 3.1, so "3.10" must be used instead.
  • https://github.com/actions/setup-python/issues/249#issuecomment-934299359
  • https://dev.to/hugovk/the-python-3-1-problem-85g

Poetry

• [x] Install Poetry successfully with Python 3.10: Poetry has introduced some breaking changes recently. To help buffer against these breaking changes, and to promote reproducible Poetry installations, br3ndonland/inboard#47 updated Poetry installations to use pipx instead of get-poetry.py or its replacement install-poetry.py. This change eliminated all of the issues seen with get-poetry.py and install-poetry.py.
• [x] Install Poetry dependencies successfully with Python 3.10: Installing Poetry with pipx (#47) eliminated the issues seen when installing dependencies with Python 3.10.
• [x] Ensure Python 3.10 classifier is included with Poetry package builds: Fixed as of Poetry 1.1.11 (python-poetry/poetry#4581).

 Traceback (most recent call last):
  File "/opt/poetry/bin/poetry", line 17, in <module>
    from poetry.console import main
  File "/opt/poetry/lib/poetry/console/__init__.py", line 1, in <module>
    from .application import Application
  File "/opt/poetry/lib/poetry/console/application.py", line 3, in <module>
    from cleo import Application as BaseApplication
ModuleNotFoundError: No module named 'cleo'

OSError

Could not find a suitable TLS CA certificate bundle, invalid path:
/opt/poetry/venv/lib/python3.9/site-packages/certifi/cacert.pem

at /opt/poetry/venv/lib/python3.9/site-packages/requests/adapters.py:227
in cert_verify

  CalledProcessError

  Command '['/opt/poetry/venv/bin/python', '/opt/poetry/venv/lib/python3.8/site-packages/virtualenv/seed/wheels/embed/pip-21.0.1-py3-none-any.whl/pip', 'install', '--disable-pip-version-check', '--prefix', '/opt/hostedtoolcache/Python/3.8.11/x64', '--no-deps', 'file:/home/runner/.cache/pypoetry/artifacts/94/aa/c7/f2115774653c0d0bf72ce93092eb73de70854164adf9f00749a952ba9c/websockets-9.1-cp38-cp38-manylinux2010_x86_64.whl']' returned non-zero exit status 1.

  at /opt/hostedtoolcache/Python/3.8.11/x64/lib/python3.8/subprocess.py:516 in run
       512│             # We don't call process.wait() as .__exit__ does that for us.
       513│             raise
       514│         retcode = process.poll()
       515│         if check and retcode:
    →  516│             raise CalledProcessError(retcode, process.args,
       517│                                      output=stdout, stderr=stderr)
       518│     return CompletedProcess(process.args, retcode, stdout, stderr)
       519│
       520│

The following error occurred when trying to handle this error:


  EnvCommandError

  Command ['/opt/poetry/venv/bin/python', '/opt/poetry/venv/lib/python3.8/site-packages/virtualenv/seed/wheels/embed/pip-21.0.1-py3-none-any.whl/pip', 'install', '--disable-pip-version-check', '--prefix', '/opt/hostedtoolcache/Python/3.8.11/x64', '--no-deps', 'file:/home/runner/.cache/pypoetry/artifacts/94/aa/c7/f2115774653c0d0bf72ce93092eb73de70854164adf9f00749a952ba9c/websockets-9.1-cp38-cp38-manylinux2010_x86_64.whl'] errored with the following return code 1, and output:
  Traceback (most recent call last):
    File "/opt/hostedtoolcache/Python/3.8.11/x64/lib/python3.8/runpy.py", line 194, in _run_module_as_main
      return _run_code(code, main_globals, None,
    File "/opt/hostedtoolcache/Python/3.8.11/x64/lib/python3.8/runpy.py", line 87, in _run_code
      exec(code, run_globals)
    File "/opt/poetry/venv/lib/python3.8/site-packages/virtualenv/seed/wheels/embed/pip-21.0.1-py3-none-any.whl/pip/__main__.py", line 24, in <module>
    File "/opt/poetry/venv/lib/python3.8/site-packages/virtualenv/seed/wheels/embed/pip-21.0.1-py3-none-any.whl/pip/_internal/cli/main.py", line 71, in main
    File "/opt/poetry/venv/lib/python3.8/site-packages/virtualenv/seed/wheels/embed/pip-21.0.1-py3-none-any.whl/pip/_internal/commands/__init__.py", line 96, in create_command
    File "/opt/hostedtoolcache/Python/3.8.11/x64/lib/python3.8/importlib/__init__.py", line 127, in import_module
      return _bootstrap._gcd_import(name[level:], package, level)
    File "<frozen importlib._bootstrap>", line 1014, in _gcd_import
    File "<frozen importlib._bootstrap>", line 991, in _find_and_load
    File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
    File "<frozen importlib._bootstrap>", line 655, in _load_unlocked
    File "<frozen importlib._bootstrap>", line 618, in _load_backward_compatible
    File "<frozen zipimport>", line 259, in load_module
    File "/opt/poetry/venv/lib/python3.8/site-packages/virtualenv/seed/wheels/embed/pip-21.0.1-py3-none-any.whl/pip/_internal/commands/install.py", line 15, in <module>
    File "<frozen importlib._bootstrap>", line 991, in _find_and_load
    File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
    File "<frozen importlib._bootstrap>", line 655, in _load_unlocked
    File "<frozen importlib._bootstrap>", line 618, in _load_backward_compatible
    File "<frozen zipimport>", line 259, in load_module
    File "/opt/poetry/venv/lib/python3.8/site-packages/virtualenv/seed/wheels/embed/pip-21.0.1-py3-none-any.whl/pip/_internal/cli/req_command.py", line 21, in <module>
    File "<frozen importlib._bootstrap>", line 991, in _find_and_load
    File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
    File "<frozen importlib._bootstrap>", line 655, in _load_unlocked
    File "<frozen importlib._bootstrap>", line 618, in _load_backward_compatible
    File "<frozen zipimport>", line 259, in load_module
    File "/opt/poetry/venv/lib/python3.8/site-packages/virtualenv/seed/wheels/embed/pip-21.0.1-py3-none-any.whl/pip/_internal/req/__init__.py", line 8, in <module>
    File "<frozen importlib._bootstrap>", line 991, in _find_and_load
    File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
    File "<frozen importlib._bootstrap>", line 655, in _load_unlocked
    File "<frozen importlib._bootstrap>", line 618, in _load_backward_compatible
    File "<frozen zipimport>", line 259, in load_module
    File "/opt/poetry/venv/lib/python3.8/site-packages/virtualenv/seed/wheels/embed/pip-21.0.1-py3-none-any.whl/pip/_internal/req/req_install.py", line 32, in <module>
    File "<frozen importlib._bootstrap>", line 991, in _find_and_load
    File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
    File "<frozen importlib._bootstrap>", line 655, in _load_unlocked
    File "<frozen importlib._bootstrap>", line 618, in _load_backward_compatible
    File "<frozen zipimport>", line 259, in load_module
    File "/opt/poetry/venv/lib/python3.8/site-packages/virtualenv/seed/wheels/embed/pip-21.0.1-py3-none-any.whl/pip/_internal/pyproject.py", line 4, in <module>
    File "<frozen importlib._bootstrap>", line 991, in _find_and_load
    File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
    File "<frozen importlib._bootstrap>", line 655, in _load_unlocked
    File "<frozen importlib._bootstrap>", line 618, in _load_backward_compatible
    File "<frozen zipimport>", line 259, in load_module
    File "/opt/poetry/venv/lib/python3.8/site-packages/virtualenv/seed/wheels/embed/pip-21.0.1-py3-none-any.whl/pip/_vendor/toml/__init__.py", line 6, in <module>
    File "<frozen importlib._bootstrap>", line 991, in _find_and_load
    File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
    File "<frozen importlib._bootstrap>", line 655, in _load_unlocked
    File "<frozen importlib._bootstrap>", line 618, in _load_backward_compatible
    File "<frozen zipimport>", line 259, in load_module
    File "/opt/poetry/venv/lib/python3.8/site-packages/virtualenv/seed/wheels/embed/pip-21.0.1-py3-none-any.whl/pip/_vendor/toml/encoder.py", line 6, in <module>
    File "<frozen importlib._bootstrap>", line 991, in _find_and_load
    File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
    File "<frozen importlib._bootstrap>", line 655, in _load_unlocked
    File "<frozen importlib._bootstrap>", line 618, in _load_backward_compatible
    File "<frozen zipimport>", line 259, in load_module
    File "/opt/poetry/venv/lib/python3.8/site-packages/virtualenv/seed/wheels/embed/pip-21.0.1-py3-none-any.whl/pip/_vendor/toml/decoder.py", line 7, in <module>
    File "<frozen importlib._bootstrap>", line 991, in _find_and_load
    File "<frozen importlib._bootstrap>", line 971, in _find_and_load_unlocked
    File "<frozen importlib._bootstrap>", line 914, in _find_spec
    File "<frozen importlib._bootstrap_external>", line 1407, in find_spec
    File "<frozen importlib._bootstrap_external>", line 1381, in _get_spec
    File "<frozen importlib._bootstrap_external>", line 1362, in _legacy_get_spec
    File "<frozen importlib._bootstrap>", line 414, in spec_from_loader
    File "<frozen importlib._bootstrap_external>", line 709, in spec_from_file_location
    File "<frozen zipimport>", line 191, in get_filename
    File "<frozen zipimport>", line 709, in _get_module_code
    File "<frozen zipimport>", line 536, in _get_data
  FileNotFoundError: [Errno 2] No such file or directory: '/opt/poetry/venv/lib/python3.8/site-packages/virtualenv/seed/wheels/embed/pip-21.0.1-py3-none-any.whl'


  at /opt/poetry/venv/lib/python3.8/site-packages/poetry/utils/env.py:1300 in _run
      1296│                 output = subprocess.check_output(
      1297│                     cmd, stderr=subprocess.STDOUT, env=env, **kwargs
      1298│                 )
      1299│         except CalledProcessError as e:
    → 1300│             raise EnvCommandError(e, input=input_)
      1301│
      1302│         return decode(output)
      1303│
      1304│     def execute(self, bin: str, *args: str, **kwargs: Any) -> Optional[int]:

The following error occurred when trying to handle this error:


  PoetryException

  Failed to install file:/home/runner/.cache/pypoetry/artifacts/94/aa/c7/f2115774653c0d0bf72ce93092eb73de70854164adf9f00749a952ba9c/websockets-9.1-cp38-cp38-manylinux2010_x86_64.whl

  at /opt/poetry/venv/lib/python3.8/site-packages/poetry/utils/pip.py:60 in pip_install
       56│                     *env.get_pip_command(),
       57│                     *args,
       58│                     env={**os.environ, "PYTHONPATH": str(env.purelib)},
       59│                 )
    →  60│         raise PoetryException(f"Failed to install {path.as_posix()}") from e
       61│
       62│
       63│ def pip_editable_install(directory: Path, environment: Env) -> Union[int, str]:
       64│     return pip_install(

pydantic and typing

• [x] Ensure pydantic provides Python package wheels for Python 3.10: Python 3.10 support was added in pydantic 1.9.0.
• [x] Ensure pydantic models are compatible with Python 3.10 type annotations:
  • The Python 3.10 union operator (the pipe, like str | None) will not be used on pydantic models. This project still supports Python 3.8 and 3.9. If running Python 3.9 or below, pydantic is not compatible with the union operator, even if annotations are imported with from __future__ import annotations.
  • PEP 604: Allow writing union types as X | Y
  • https://github.com/samuelcolvin/pydantic/issues/2597#issuecomment-1086194186
  • https://github.com/samuelcolvin/pydantic/pull/2609#issuecomment-1084341812
  • https://github.com/samuelcolvin/pydantic/issues/3300#issuecomment-1034007897
• [x] Update type annotations for Python 3.10 (all except the union types on pydantic model fields)

Related

• [x] I have reviewed the Guidelines for Contributing and the Code of Conduct.

GitHub Actions

• actions/setup-python#249

Poetry

• br3ndonland/inboard#44
• br3ndonland/inboard#47
• python-poetry/poetry#3071
• python-poetry/poetry#3139
• python-poetry/poetry#3336
• python-poetry/poetry#3345
• python-poetry/poetry#3706
• python-poetry/poetry#3870
• python-poetry/poetry#3957
• python-poetry/poetry#4056
• python-poetry/poetry#4195
• python-poetry/poetry#4210
• https://github.com/python-poetry/poetry/discussions/4271
• python-poetry/poetry#4336
• python-poetry/poetry#4369
• python-poetry/poetry#4414
• python-poetry/poetry#4429
• python-poetry/poetry#4430
• python-poetry/poetry#4433
• python-poetry/poetry#4463
• python-poetry/poetry#4470
• python-poetry/poetry#4581

pydantic and typing

• samuelcolvin/pydantic#2597
• samuelcolvin/pydantic#2609
• samuelcolvin/pydantic#3300
• pydantic 1.9.0
• PEP 604: Allow writing union types as X | Y
• Python 3 docs: What's new in Python 3.10

Description

This PR will migrate inboard from Poetry 1.1 to Hatch. See br3ndonland/inboard#56 for more details and context around the motivations for this change.

Note that projects using inboard are not required to migrate to Hatch. The Docker images will retain Poetry 1.1 for backwards compatibility for now. Poetry 1.1 is unmaintained, and so it will eventually need to be removed, but there will be notice given at least one minor version ahead of time. If projects using inboard require poetry>1.2, they can add pipx upgrade poetry or pipx install poetry>1.2 --force to their Dockerfiles as described in the updated docs in this PR (on the Docker page, under "Docker and Poetry").

Changes

Update configuration files for Hatch

• Remove poetry.lock
• Remove poetry.toml
• Remove [tool.poetry] sections from pyproject.toml
• Update [build-system] section in pyproject.toml for Hatchling
• Move version number to inboard/__init__.py, which allows Python projects to import it with import inboard then inboard.__version__
• Add project metadata to new [project] section in pyproject.toml, bringing this project in line with Python project metadata standards
• Add optional dependencies to [project.optional-dependencies] groups
• Pin asgiref and mypy to avoid breaking changes to type checking that could be introduced by changes to mypy strict mode (2cbc99c) or by changes to asgiref TypedDict keys (d729fdf)
• Add environments to [tool.hatch.envs.*] tables, using features for optional dependency groups, and path = ".venv" for an in-project virtualenv in the same location as a Poetry in-project virtualenv
• Add Hatch environment names to .gitignore

Update Dockerfile for Hatch

• Remove poetry.lock and poetry.toml from COPY step
• Add README.md to COPY step (README.md is part of the Python package)
• Break ARG and ENV commands onto multiple lines for readability
• Add HATCH_VERSION build arg
• Set HATCH_ENV_TYPE_VIRTUAL_PATH=".venv" to ensure consistent in-project virtualenv location
• Install Hatch with pipx
• Continue installing Poetry 1.1 with pipx for backwards compatibility for now. Poetry 1.1 is unmaintained, and so it will eventually need to be removed, but there will be notice given at least one minor version ahead of time.
• Replace poetry install commands with hatch env create commands. There is no direct command to manually install or sync dependencies. The Hatch docs say, "You never need to manually create environments as spawning a shell or running commands within one will automatically trigger creation." The hatch env create command will create the virtual environment and install the appropriate dependencies. Note that commands for directly installing or syncing environments may be added in the future.
  • pypa/hatch#593
  • pypa/hatch#650

Update GitHub Actions workflows for Hatch

• Update test that ensures pipx installs correct version of Hatch
• Update test for consistent in-project virtualenv directory (.venv)
• Update caching for pip so that GitHub Actions caches dependencies
• Update poetry run commands for Hatch, ensuring correct environment is selected with the HATCH_ENV environment variable
• Update package build and PyPI publish commands for Hatch

Update docs for Hatch

• Add new user words to cspell.json
• Add Hatch description and instructions to contributing.md
• Update Poetry references in docs for Hatch
• Move instructions for code quality checks below instructions for Hatch so that contributors understand how to set up the project prior to running code quality checks

Related

• Closes br3ndonland/inboard#55
• br3ndonland/inboard#56
• Closes br3ndonland/inboard#57
• [x] I have reviewed the Guidelines for Contributing and the Code of Conduct.

Pull Request #49 refactored by Sourcery.

If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.

NOTE: As code is pushed to the original Pull Request, Sourcery will re-run and update (force-push) this Pull Request with new refactorings as necessary. If Sourcery finds no refactorings at any point, this Pull Request will be closed automatically.

See our documentation here.

git fetch origin sourcery/logging-filter
git merge --ff-only FETCH_HEAD
git reset HEAD^

Help us improve this pull request!

Description

When applications with APIs are deployed, it is common to perform "health checks" on them. Health checks are usually performed by making HTTP requests to a designated API endpoint. These checks are made at frequent intervals, and so they can fill up the access logs with large numbers of unnecessary log records.

To avoid logging health checks, it would be helpful to have a way to filter health checks out of the logs.

Changes

This PR will add a configurable logging filter to inboard.logging_conf.

• Filters can be provided as a comma-separated string with the environment variable LOG_FILTERS, like LOG_FILTERS="/health, /heartbeat".
• The environment variable value will be converted into a set of strings.
• Each log message will then be checked for each filter in the set. If any matches are present in the log message, the logger will not log that message.

There are multiple ways to match these filters. inboard simply performs a substring membership check to see if any of the filters in the set have a match in the log message. This should work for most use cases, but the match could be overly greedy. For example, if /health is in LOG_FILTERS, it would filter out calls to /health, but it would also filter out calls to /healthy.

Another approach could be to operate on the LogRecord args, but the results would vary based on how the program supplies the log record.

• As seen in the type stubs for the logging module, the args can be either tuple[object, ...] or Mapping[str, object]. The args could be converted to a set, and compared with the set of filters using isdisjoint. This set comparison approach is potentially more precise than string matching.
• Gunicorn's access logger gunicorn.access supports several custom message fields, which it calls "atoms" in its source code, and "identifiers" in the docs. Gunicorn formats these atoms and supplies them as LogRecord args. The URL path could be logged with the %(U)s atom, and inboard could check to see if there is an exact match in the set of filters.
• Uvicorn's access logger uvicorn.access automatically supplies the URL path as its own arg, which could also work nicely with this approach.
• However, LogRecord args aren't always supplied as strings directly, so there would probably need to be isinstance checks added to check each of the args. For example, when watching files with watchgod (now renamed to watchfiles), Uvicorn logs the list of files being watched as a single arg. Lists are not hashable, so the list would need to be converted to another type (like set, or str as the logger does when formatting messages) in order to perform equality comparisons.

Substring membership checks should be adequate for this feature, and they avoid the complications of working with LogRecord args directly.

Related

• benoitc/gunicorn#1781
• Python 3 docs: How-To - Logging Cookbook - Using Filters to impart contextual information
• Python 3 docs: What's new in Python 3.2 - logging
• Django 4.0 docs: How-to - Logging
• Django 4.0 docs: Reference - Logging
• Django 4.0 docs: Topics - Logging
• [x] I have reviewed the Guidelines for Contributing and the Code of Conduct.

Description

While the TOML spec is alive and well, the toml package that was used in this project is dead (uiri/toml#267).

There are several alternatives:

• rtoml is the fastest, but does not provide "round trip" guarantees (meaning that it can't load, then dump, and get an identical result). However, for simple loading and parsing it's fine. It also requires a Rust environment to compile from source, which may be a consideration on distributions like Alpine Linux.
• tomli is another alternative, but it is read-only (writing requires a separate tomli-w package), and requires files to be opened in binary mode to parse TOML.
• tomlkit is used by Poetry (and is written by the original author of Poetry), but is currently 70x slower than rtoml.

This PR will remove toml from the fastapi Poetry extras group, and make the necessary source code changes.

Rather than installing an alternative TOML package, the TOML logic will simply be removed from inboard, because the TOML parsing and settings loading was somewhat tangential to the focus of the project. A separate project, fastenv, is more focused on settings management, and may feature TOML support in the future.

Note that toml is still a sub-dependency of some dev-dependencies, including pre-commit and pytest.

Changes

• Drop toml dependency (619f63c)

Related

uiri/toml#267 https://github.com/uiri/toml/pull/279#issuecomment-633012586

• [x] I have reviewed the Guidelines for Contributing and the Code of Conduct.

Description

Gunicorn supports a GUNICORN_CMD_ARGS catch-all environment variable for configuring settings. It looks for the GUNICORN_CMD_ARGS environment variable automatically, and gives these settings precedence over other environment variables and Gunicorn config files.

It would be useful to have something similar for Uvicorn. This PR will add support for a UVICORN_CONFIG_OPTIONS environment variable. The idea here is to allow a catch-all Uvicorn config variable in the spirit of GUNICORN_CMD_ARGS, so that advanced users can specify the full range of Uvicorn options even if inboard has not directly implemented them. The inboard.start module will run the UVICORN_CONFIG_OPTIONS environment variable value through json.loads(), and then pass the resultant dictionary through to Uvicorn. If the same option is set with an individual environment variable (such as WITH_RELOAD) and with a JSON value in UVICORN_CONFIG_OPTIONS, the JSON value will take precedence.

json.loads() converts data types from JSON to Python, and returns a Python dictionary. See the guide to understanding JSON schema for many helpful examples of how JSON data types correspond to Python data types. If the Uvicorn options are already available as a Python dictionary, dump them to a JSON-formatted string with json.dumps(), and set that as an environment variable.

The UVICORN_CONFIG_OPTIONS environment variable is suggested for advanced usage, because it requires some knowledge of uvicorn.config.Config. Other than the JSON -> Python dictionary conversion, no additional type conversions or validations are performed on UVICORN_CONFIG_OPTIONS. All options should be able to be passed directly to uvicorn.config.Config.

Changes

• Use pytest fixtures for test Uvicorn configs (2964358)
• Implement UVICORN_CONFIG_OPTIONS variable (a8773b6)
• Document UVICORN_CONFIG_OPTIONS variable (509b4bf)

Related

br3ndonland/inboard#21 br3ndonland/inboard#39

• [x] I have reviewed the Guidelines for Contributing and the Code of Conduct.

Pull Request #39 refactored by Sourcery.

If you're happy with these changes, merge this Pull Request using the Squash and merge strategy.

NOTE: As code is pushed to the original Pull Request, Sourcery will re-run and update (force-push) this Pull Request with new refactorings as necessary. If Sourcery finds no refactorings at any point, this Pull Request will be closed automatically.

See our documentation here.

git fetch origin sourcery/uvicorn-0.15
git merge --ff-only FETCH_HEAD
git reset HEAD^

Help us improve this pull request!

Description

PR #21 implemented the Uvicorn reload_dirs setting, enabling file watching and hot-reloading with watchgod for development.

In encode/uvicorn#820 and Uvicorn 0.15, additional reload configuration options were added:

• reload_delay (CLI equivalent: --reload-delay)
• reload_excludes (CLI equivalent: --reload-exclude)
• reload_includes (CLI equivalent: --reload-include)

This PR will implement the new Uvicorn reload options. The options will be configured with the following environment variables:

• RELOAD_DELAY
• RELOAD_EXCLUDES
• RELOAD_INCLUDES

Changes

• Upgrade to Uvicorn 0.15 (ffb47df)
• Implement new Uvicorn 0.15 reload config options (f4428dd)
• Document new Uvicorn 0.15 reload config options (95fe201)
• Update #39 with Sourcery refactorings from #40 (75b81a4)

Related

br3ndonland/inboard#21 encode/uvicorn#820 https://github.com/encode/uvicorn/releases/tag/0.15.0

• [x] I have reviewed the Guidelines for Contributing and the Code of Conduct.

Description

Unit test coverage is at 100%, but testing doesn't stop there. It is still important to test that the Uvicorn and Gunicorn servers are being properly configured with environment variables and configuration files. This PR will provide improvements to the unit tests for the Uvicorn and Gunicorn servers, while maintaining test coverage at 100%.

Changes

Gunicorn

• Properly mock Gunicorn and Uvicorn processes (9ddbc4b)
  • Add full process calls: verify that the server functions (uvicorn.run for Uvicorn, subprocess.run for Gunicorn) are called with expected arguments.
  • Add mock for subprocess.run(): similar to Uvicorn update in 3906b3d.
  • Provide Gunicorn with correct worker_tmp_dir: The Gunicorn server was previously exiting without need for a mock. However, this was actually because it couldn't find the hard-coded worker_tmp_dir (/dev/shm), as can be seen when invoking pytest with pytest -vv --capture=sys. The solution is to override the hard-coded worker_tmp_dir with GUNICORN_CMD_ARGS="--worker-tmp-dir $DIR". Although the full Gunicorn module is not mocked here, it's a good practice to properly configure the Gunicorn server.
• Improve Gunicorn performance auto-tuning (02b249e)
  • The "auto-tuning" advertised in tiangolo/uvicorn-gunicorn-docker is basically a few lines of the gunicorn_conf.py that determine the number of Gunicorn workers to run. It would be helpful to write some unit test cases for this feature, but without being in a separate unit, it is difficult to unit test in isolation.
  • This commit will refactor the performance auto-tuning into a function, gunicorn_conf.calculate_workers, and will add unit test cases to test_start.py to verify the resulting number of worker processes.
• Clarify Gunicorn worker calculation in README (2567156)

General

• Improve pytest fixtures for temporary paths (c1a6f3a)
  • Ensure Path() is used for shutil arguments instead of string
  • Create temporary directory for Gunicorn with tmp_path_factory
  • Copy gunicorn_conf.py to temporary directory
  • Update test_start.py with new Gunicorn paths
• Set default process manager for base ASGI app (9d51de4)
  • 5e6af54 added a check for the PROCESS_MANAGER environment variable in inboard/app/base/main.py, but no default was set.
  • This commit will set Gunicorn as the default process manager, to avoid errors if PROCESS_MANAGER is not set.

Related

br3ndonland/inboard@3906b3d br3ndonland/inboard@cd7604c br3ndonland/inboard#8 https://github.com/tiangolo/uvicorn-gunicorn-docker/releases/tag/0.3.0 tiangolo/uvicorn-gunicorn-docker#5 tiangolo/uvicorn-gunicorn-starlette-docker#4 tiangolo/uvicorn-gunicorn-fastapi-docker#6

• [x] I have reviewed the Guidelines for Contributing and the Code of Conduct.

Bumps certifi from 2022.9.24 to 2022.12.7.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.