Cookiecutter template for FastAPI projects using: Machine Learning, Poetry, Azure Pipelines and Pytests

Overview

cookiecutter-fastapi

In order to create a template to FastAPI projects. 🚀

Important

To use this project you don't need fork it. Just run cookiecutter CLI and voilà!

Cookiecutter

Cookiecutter is a CLI tool (Command Line Interface) to create an application boilerplate from a template. It uses a templating system — Jinja2 — to replace or customize folder and file names, as well as file content.

How can I install?

pip install cookiecutter

How can I generate a FastAPI project?

cookiecutter gh:arthurhenrique/cookiecutter-fastapi

Hands On

Example

Comments
  • license?

    license?

    Hello, thanks for putting this together :)

    Sorry if there's a license somewhere, but I wasn't able to find one.

    Would you be up for adding a LICENSE file? For purely selfish reasons, I'd appreciate if it were permissive (e.g. Apache, MIT), but GPL would be better than nothing :)

    Thanks again

    documentation 
    opened by zdog234 2
  • chore(deps): update python docker tag to v3.11.1

    chore(deps): update python docker tag to v3.11.1

    Mend Renovate

    This PR contains the following updates:

    | Package | Type | Update | Change | |---|---|---|---| | python | final | patch | 3.11.0 -> 3.11.1 |


    Configuration

    📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    🔕 Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box

    This PR has been generated by Mend Renovate. View repository job log here.

    opened by renovate[bot] 1
  • Creating project with default values throw an error on .github\workflows\ci.yaml file

    Creating project with default values throw an error on .github\workflows\ci.yaml file

    Error message:

    Unable to create file '.github/workflows/ci.yaml'
    Error message: 'matrix' is undefined
    Context: {
        "cookiecutter": {
            "_extensions": [
                "jinja2_time.TimeExtension"
            ],
            "_template": "gh:arthurhenrique/cookiecutter-fastapi",
            "email": "Your address email ([email protected])",
            "full_name": "Your name",
            "machine_learn_model_name": "model.pkl",
            "machine_learn_model_path": "./ml/model/",
            "project_name": "Name of the project",
            "project_short_description": "A short description of the project",
            "project_slug": "name-of-the-project",
            "release_date": "2022-06-17",
            "version": "0.1.0"
        }
    }
    

    Steps to reproduce:

    cookiecutter gh:arthurhenrique/cookiecutter-fastapi
    You've downloaded /home/maciej/snap/cookiecutter/1/.cookiecutters/cookiecutter-fastapi before. Is it okay to delete and re-download it? [yes]: yes
    project_name [Name of the project]: 
    project_slug [name-of-the-project]: 
    project_short_description [A short description of the project]: 
    machine_learn_model_path [./ml/model/]: 
    machine_learn_model_name [model.pkl]: 
    full_name [Your name]: 
    email [Your address email (yo[email protected])]: 
    release_date [2022-06-17]: 
    version [0.1.0]: 
    

    Enviroment:

    Ubuntu 20.04.4 LTS
    Python 3.10.4 (via pyenv 2.3.0-14-g0930533)
    Cookiecutter 1.6.0 from /snap/cookiecutter/1/lib/python3.6/site-packages (Python 3.6)
    Creation of project inside venv
    
    good first issue 
    opened by BudzynskiMaciej 1
  • Bump certifi from 2022.9.24 to 2022.12.7 in /{{cookiecutter.project_slug}}

    Bump certifi from 2022.9.24 to 2022.12.7 in /{{cookiecutter.project_slug}}

    Bumps certifi from 2022.9.24 to 2022.12.7.

    Commits

    Dependabot compatibility score

    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.


    Dependabot commands and options

    You can trigger Dependabot actions by commenting on this PR:

    • @dependabot rebase will rebase this PR
    • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
    • @dependabot merge will merge this PR after your CI passes on it
    • @dependabot squash and merge will squash and merge this PR after your CI passes on it
    • @dependabot cancel merge will cancel a previously requested merge and block automerging
    • @dependabot reopen will reopen this PR if it is closed
    • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
    • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
    • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
    • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
    • @dependabot use these labels will set the current labels as the default for future PRs for this repo and language
    • @dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language
    • @dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language
    • @dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

    You can disable automated security fix PRs for this repo from the Security Alerts page.

    dependencies 
    opened by dependabot[bot] 0
  • fix(deps): update dependency fastapi to ^0.88.0

    fix(deps): update dependency fastapi to ^0.88.0

    Mend Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | fastapi | ^0.87.0 -> ^0.88.0 | age | adoption | passing | confidence |


    Release Notes

    tiangolo/fastapi

    v0.88.0

    Compare Source

    Upgrades
    • ⬆ Bump Starlette to version 0.22.0 to fix bad encoding for query parameters in new TestClient. PR #​5659 by @​azogue.
    Docs
    Translations
    • 🌐 Add Portuguese translation for docs/pt/docs/deployment/docker.md. PR #​5663 by @​ayr-ton.
    Internal

    Configuration

    📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    🔕 Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box

    This PR has been generated by Mend Renovate. View repository job log here.

    opened by renovate[bot] 0
  • fix(deps): update dependency uvicorn to v0.20.0

    fix(deps): update dependency uvicorn to v0.20.0

    Mend Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | uvicorn (changelog) | 0.19.0 -> 0.20.0 | age | adoption | passing | confidence |


    Release Notes

    encode/uvicorn

    v0.20.0

    Compare Source

    Added
    • Check if handshake is completed before sending frame on wsproto shutdown (#​1737)
    • Add default headers to WebSockets implementations (#​1606 & #​1747) 28/10/22
    • Warn user when reload and workers flag are used together (#​1731) 31/10/22
    Fixed
    • Use correct WebSocket error codes on close (#​1753) 20/11/22
    • Send disconnect event on connection lost for wsproto (#​996) 29/10/22
    • Add SIGQUIT handler to UvicornWorker (#​1710) 01/11/22
    • Fix crash on exist with "--uds" if socket doesn't exist (#​1725) 27/10/22
    • Annotate CONFIG_KWARGS in UvicornWorker class (#​1746) 31/10/22
    Removed
    • Remove conditional on RemoteProtocolError.event_hint on wsproto (#​1486) 31/10/22
    • Remove unused handle_no_connect on wsproto implementation (#​1759) 17/11/22

    Configuration

    📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    🔕 Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box

    This PR has been generated by Mend Renovate. View repository job log here.

    opened by renovate[bot] 0
  • fix(deps): update dependency fastapi to ^0.87.0

    fix(deps): update dependency fastapi to ^0.87.0

    Mend Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | fastapi | ^0.86.0 -> ^0.87.0 | age | adoption | passing | confidence |


    Release Notes

    tiangolo/fastapi

    v0.87.0

    Compare Source

    Highlights of this release:

    • Upgraded Starlette
      • Now the TestClient is based on HTTPX instead of Requests. 🚀
      • There are some possible breaking changes in the TestClient usage, but @​Kludex built bump-testclient to help you automatize migrating your tests. Make sure you are using Git and that you can undo any unnecessary changes (false positive changes, etc) before using bump-testclient.
    • New WebSocketException (and docs), re-exported from Starlette.
    • Upgraded and relaxed dependencies for package extras all (including new Uvicorn version), when you install "fastapi[all]".
    • New docs about how to Help Maintain FastAPI.
    Features
    Docs
    Translations
    • 🌐 Fix highlight lines for Japanese translation for docs/tutorial/query-params.md. PR #​2969 by @​ftnext.
    • 🌐 Add French translation for docs/fr/docs/advanced/additional-status-code.md. PR #​5477 by @​axel584.
    • 🌐 Add Portuguese translation for docs/pt/docs/tutorial/request-forms-and-files.md. PR #​5579 by @​batlopes.
    • 🌐 Add Japanese translation for docs/ja/docs/advanced/websockets.md. PR #​4983 by @​xryuseix.
    Internal

    Configuration

    📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    🔕 Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box

    This PR has been generated by Mend Renovate. View repository job log here.

    opened by renovate[bot] 0
  • chore(deps): update dependency pytest to v7

    chore(deps): update dependency pytest to v7

    Mend Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | pytest (source, changelog) | ^5.2 -> ^7.2 | age | adoption | passing | confidence |


    Release Notes

    pytest-dev/pytest

    v7.2.0

    Compare Source

    pytest 7.2.0 (2022-10-23)

    Deprecations

    • #​10012: Update pytest.PytestUnhandledCoroutineWarning{.interpreted-text role="class"} to a deprecation; it will raise an error in pytest 8.

    • #​10396: pytest no longer depends on the py library. pytest provides a vendored copy of py.error and py.path modules but will use the py library if it is installed. If you need other py.* modules, continue to install the deprecated py library separately, otherwise it can usually be removed as a dependency.

    • #​4562: Deprecate configuring hook specs/impls using attributes/marks.

      Instead use :pypytest.hookimpl{.interpreted-text role="func"} and :pypytest.hookspec{.interpreted-text role="func"}. For more details, see the docs <legacy-path-hooks-deprecated>{.interpreted-text role="ref"}.

    • #​9886: The functionality for running tests written for nose has been officially deprecated.

      This includes:

      • Plain setup and teardown functions and methods: this might catch users by surprise, as setup() and teardown() are not pytest idioms, but part of the nose support.
      • Setup/teardown using the @​with_setup decorator.

      For more details, consult the deprecation docs <nose-deprecation>{.interpreted-text role="ref"}.

    Features

    • #​9897: Added shell-style wildcard support to testpaths.

    Improvements

    • #​10218: @pytest.mark.parametrize() (and similar functions) now accepts any Sequence[str] for the argument names, instead of just list[str] and tuple[str, ...].

      (Note that str, which is itself a Sequence[str], is still treated as a comma-delimited name list, as before).

    • #​10381: The --no-showlocals flag has been added. This can be passed directly to tests to override --showlocals declared through addopts.

    • #​3426: Assertion failures with strings in NFC and NFD forms that normalize to the same string now have a dedicated error message detailing the issue, and their utf-8 representation is expresed instead.

    • #​7337: A warning is now emitted if a test function returns something other than [None]{.title-ref}. This prevents a common mistake among beginners that expect that returning a [bool]{.title-ref} (for example [return foo(a, b) == result]{.title-ref}) would cause a test to pass or fail, instead of using [assert]{.title-ref}.

    • #​8508: Introduce multiline display for warning matching via :pypytest.warns{.interpreted-text role="func"} and enhance match comparison for :py_pytest._code.ExceptionInfo.match{.interpreted-text role="func"} as returned by :pypytest.raises{.interpreted-text role="func"}.

    • #​8646: Improve :pypytest.raises{.interpreted-text role="func"}. Previously passing an empty tuple would give a confusing error. We now raise immediately with a more helpful message.

    • #​9741: On Python 3.11, use the standard library's tomllib{.interpreted-text role="mod"} to parse TOML.

      tomli{.interpreted-text role="mod"}` is no longer a dependency on Python 3.11.

    • #​9742: Display assertion message without escaped newline characters with -vv.

    • #​9823: Improved error message that is shown when no collector is found for a given file.

    • #​9873: Some coloring has been added to the short test summary.

    • #​9883: Normalize the help description of all command-line options.

    • #​9920: Display full crash messages in short test summary info, when runng in a CI environment.

    • #​9987: Added support for hidden configuration file by allowing .pytest.ini as an alternative to pytest.ini.

    Bug Fixes

    • #​10150: sys.stdin{.interpreted-text role="data"} now contains all expected methods of a file-like object when capture is enabled.

    • #​10382: Do not break into pdb when raise unittest.SkipTest() appears top-level in a file.

    • #​7792: Marks are now inherited according to the full MRO in test classes. Previously, if a test class inherited from two or more classes, only marks from the first super-class would apply.

      When inheriting marks from super-classes, marks from the sub-classes are now ordered before marks from the super-classes, in MRO order. Previously it was the reverse.

      When inheriting marks from super-classes, the [pytestmark]{.title-ref} attribute of the sub-class now only contains the marks directly applied to it. Previously, it also contained marks from its super-classes. Please note that this attribute should not normally be accessed directly; use pytest.Node.iter_markers{.interpreted-text role="func"} instead.

    • #​9159: Showing inner exceptions by forcing native display in ExceptionGroups even when using display options other than --tb=native. A temporary step before full implementation of pytest-native display for inner exceptions in ExceptionGroups.

    • #​9877: Ensure caplog.get_records(when) returns current/correct data after invoking caplog.clear().

    Improved Documentation

    • #​10344: Update information on writing plugins to use pyproject.toml instead of setup.py.
    • #​9248: The documentation is now built using Sphinx 5.x (up from 3.x previously).
    • #​9291: Update documentation on how pytest.warns{.interpreted-text role="func"} affects DeprecationWarning{.interpreted-text role="class"}.

    Trivial/Internal Changes

    • #​10196: ~pytest.PytestReturnNotNoneWarning{.interpreted-text role="class"} is now a subclass of ~pytest.PytestRemovedIn8Warning{.interpreted-text role="class"}: the plan is to make returning non-None from tests an error in the future.
    • #​10313: Made _pytest.doctest.DoctestItem export pytest.DoctestItem for type check and runtime purposes. Made [_pytest.doctest]{.title-ref} use internal APIs to avoid circular imports.
    • #​9906: Made _pytest.compat re-export importlib_metadata in the eyes of type checkers.
    • #​9910: Fix default encoding warning (EncodingWarning) in cacheprovider
    • #​9984: Improve the error message when we attempt to access a fixture that has been torn down. Add an additional sentence to the docstring explaining when it's not a good idea to call getfixturevalue.

    v7.1.3

    Compare Source

    pytest 7.1.3 (2022-08-31)

    Bug Fixes

    • #​10060: When running with --pdb, TestCase.tearDown is no longer called for tests when the class has been skipped via unittest.skip or pytest.mark.skip.
    • #​10190: Invalid XML characters in setup or teardown error messages are now properly escaped for JUnit XML reports.
    • #​10230: Ignore .py files created by pyproject.toml-based editable builds introduced in pip 21.3.
    • #​3396: Doctests now respect the --import-mode flag.
    • #​9514: Type-annotate FixtureRequest.param as Any as a stop gap measure until 8073{.interpreted-text role="issue"} is fixed.
    • #​9791: Fixed a path handling code in rewrite.py that seems to work fine, but was incorrect and fails in some systems.
    • #​9917: Fixed string representation for pytest.approx{.interpreted-text role="func"} when used to compare tuples.

    Improved Documentation

    • #​9937: Explicit note that tmpdir{.interpreted-text role="fixture"} fixture is discouraged in favour of tmp_path{.interpreted-text role="fixture"}.

    Trivial/Internal Changes

    v7.1.2

    Compare Source

    pytest 7.1.2 (2022-04-23)

    Bug Fixes

    • #​9726: An unnecessary numpy import inside pytest.approx{.interpreted-text role="func"} was removed.
    • #​9820: Fix comparison of dataclasses with InitVar.
    • #​9869: Increase stacklevel for the NODE_CTOR_FSPATH_ARG deprecation to point to the user's code, not pytest.
    • #​9871: Fix a bizarre (and fortunately rare) bug where the [temp_path]{.title-ref} fixture could raise an internal error while attempting to get the current user's username.

    v7.1.1

    Compare Source

    pytest 7.1.1 (2022-03-17)

    Bug Fixes

    • #​9767: Fixed a regression in pytest 7.1.0 where some conftest.py files outside of the source tree (e.g. in the [site-packages]{.title-ref} directory) were not picked up.

    v7.1.0: 7.1.0

    Compare Source

    pytest 7.1.0 (2022-03-13)

    Breaking Changes

    • #​8838: As per our policy, the following features have been deprecated in the 6.X series and are now removed:

      • pytest._fillfuncargs function.
      • pytest_warning_captured hook - use pytest_warning_recorded instead.
      • -k -foobar syntax - use -k 'not foobar' instead.
      • -k foobar: syntax.
      • pytest.collect module - import from pytest directly.

      For more information consult Deprecations and Removals in the docs.

    • #​9437: Dropped support for Python 3.6, which reached end-of-life at 2021-12-23.

    Improvements

    • #​5192: Fixed test output for some data types where -v would show less information.

      Also, when showing diffs for sequences, -q would produce full diffs instead of the expected diff.

    • #​9362: pytest now avoids specialized assert formatting when it is detected that the default __eq__ is overridden in attrs or dataclasses.

    • #​9536: When -vv is given on command line, show skipping and xfail reasons in full instead of truncating them to fit the terminal width.

    • #​9644: More information about the location of resources that led Python to raise ResourceWarning{.interpreted-text role="class"} can now be obtained by enabling tracemalloc{.interpreted-text role="mod"}.

      See resource-warnings{.interpreted-text role="ref"} for more information.

    • #​9678: More types are now accepted in the ids argument to @pytest.mark.parametrize. Previously only [str]{.title-ref}, [float]{.title-ref}, [int]{.title-ref} and [bool]{.title-ref} were accepted; now [bytes]{.title-ref}, [complex]{.title-ref}, [re.Pattern]{.title-ref}, [Enum]{.title-ref} and anything with a [__name__]{.title-ref} are also accepted.

    • #​9692: pytest.approx{.interpreted-text role="func"} now raises a TypeError{.interpreted-text role="class"} when given an unordered sequence (such as set{.interpreted-text role="class"}).

      Note that this implies that custom classes which only implement __iter__ and __len__ are no longer supported as they don't guarantee order.

    Bug Fixes

    • #​8242: The deprecation of raising unittest.SkipTest{.interpreted-text role="class"} to skip collection of tests during the pytest collection phase is reverted - this is now a supported feature again.

    • #​9493: Symbolic link components are no longer resolved in conftest paths. This means that if a conftest appears twice in collection tree, using symlinks, it will be executed twice. For example, given

      tests/real/conftest.py tests/real/test_it.py tests/link -> tests/real

      running pytest tests now imports the conftest twice, once as tests/real/conftest.py and once as tests/link/conftest.py. This is a fix to match a similar change made to test collection itself in pytest 6.0 (see 6523{.interpreted-text role="pull"} for details).

    • #​9626: Fixed count of selected tests on terminal collection summary when there were errors or skipped modules.

      If there were errors or skipped modules on collection, pytest would mistakenly subtract those from the selected count.

    • #​9645: Fixed regression where --import-mode=importlib used together with PYTHONPATH{.interpreted-text role="envvar"} or pythonpath{.interpreted-text role="confval"} would cause import errors in test suites.

    • #​9708: pytester{.interpreted-text role="fixture"} now requests a monkeypatch{.interpreted-text role="fixture"} fixture instead of creating one internally. This solves some issues with tests that involve pytest environment variables.

    • #​9730: Malformed pyproject.toml files now produce a clearer error message.

    v7.0.1

    Compare Source

    pytest 7.0.1 (2022-02-11)

    Bug Fixes

    • #​9608: Fix invalid importing of importlib.readers in Python 3.9.
    • #​9610: Restore [UnitTestFunction.obj]{.title-ref} to return unbound rather than bound method. Fixes a crash during a failed teardown in unittest TestCases with non-default [__init__]{.title-ref}. Regressed in pytest 7.0.0.
    • #​9636: The pythonpath plugin was renamed to python_path. This avoids a conflict with the pytest-pythonpath plugin.
    • #​9642: Fix running tests by id with :: in the parametrize portion.
    • #​9643: Delay issuing a ~pytest.PytestWarning{.interpreted-text role="class"} about diamond inheritance involving ~pytest.Item{.interpreted-text role="class"} and ~pytest.Collector{.interpreted-text role="class"} so it can be filtered using standard warning filters <warnings>{.interpreted-text role="ref"}.

    v7.0.0

    Compare Source

    pytest 7.0.0 (2022-02-03)

    (Please see the full set of changes for this release also in the 7.0.0rc1 notes below)

    Deprecations

    • #​9488: If custom subclasses of nodes like pytest.Item{.interpreted-text role="class"} override the __init__ method, they should take **kwargs. See uncooperative-constructors-deprecated{.interpreted-text role="ref"} for details.

      Note that a deprection warning is only emitted when there is a conflict in the arguments pytest expected to pass. This deprecation was already part of pytest 7.0.0rc1 but wasn't documented.

    Bug Fixes

    • #​9355: Fixed error message prints function decorators when using assert in Python 3.8 and above.
    • #​9396: Ensure pytest.Config.inifile{.interpreted-text role="attr"} is available during the pytest_cmdline_main <_pytest.hookspec.pytest_cmdline_main>{.interpreted-text role="func"} hook (regression during 7.0.0rc1).

    Improved Documentation

    • #​9404: Added extra documentation on alternatives to common misuses of [pytest.warns(None)]{.title-ref} ahead of its deprecation.
    • #​9505: Clarify where the configuration files are located. To avoid confusions documentation mentions that configuration file is located in the root of the repository.

    Trivial/Internal Changes

    • #​9521: Add test coverage to assertion rewrite path.

    pytest 7.0.0rc1 (2021-12-06)

    Breaking Changes

    • #​7259: The Node.reportinfo() <non-python tests>{.interpreted-text role="ref"} function first return value type has been expanded from [py.path.local | str]{.title-ref} to [os.PathLike[str] | str]{.title-ref}.

      Most plugins which refer to [reportinfo()]{.title-ref} only define it as part of a custom pytest.Item{.interpreted-text role="class"} implementation. Since [py.path.local]{.title-ref} is a [os.PathLike[str]]{.title-ref}, these plugins are unaffacted.

      Plugins and users which call [reportinfo()]{.title-ref}, use the first return value and interact with it as a [py.path.local]{.title-ref}, would need to adjust by calling [py.path.local(fspath)]{.title-ref}. Although preferably, avoid the legacy [py.path.local]{.title-ref} and use [pathlib.Path]{.title-ref}, or use [item.location]{.title-ref} or [item.path]{.title-ref}, instead.

      Note: pytest was not able to provide a deprecation period for this change.

    • #​8246: --version now writes version information to stdout rather than stderr.

    • #​8733: Drop a workaround for pyreadline that made it work with --pdb.

      The workaround was introduced in #​1281 in 2015, however since then pyreadline seems to have gone unmaintained, is generating warnings, and will stop working on Python 3.10.

    • #​9061: Using pytest.approx{.interpreted-text role="func"} in a boolean context now raises an error hinting at the proper usage.

      It is apparently common for users to mistakenly use pytest.approx like this:

      assert pytest.approx(actual, expected)
      

      While the correct usage is:

      assert actual == pytest.approx(expected)
      

      The new error message helps catch those mistakes.

    • #​9277: The pytest.Instance collector type has been removed. Importing pytest.Instance or _pytest.python.Instance returns a dummy type and emits a deprecation warning. See instance-collector-deprecation{.interpreted-text role="ref"} for details.

    • #​9308: PytestRemovedIn7Warning deprecation warnings are now errors by default.

      Following our plan to remove deprecated features with as little disruption as possible, all warnings of type PytestRemovedIn7Warning now generate errors instead of warning messages by default.

      The affected features will be effectively removed in pytest 7.1, so please consult the deprecations{.interpreted-text role="ref"} section in the docs for directions on how to update existing code.

      In the pytest 7.0.X series, it is possible to change the errors back into warnings as a stopgap measure by adding this to your pytest.ini file:

      [pytest]
      filterwarnings =
          ignore::pytest.PytestRemovedIn7Warning
      

      But this will stop working when pytest 7.1 is released.

      If you have concerns about the removal of a specific feature, please add a comment to 9308{.interpreted-text role="issue"}.

    Deprecations

    • #​7259: py.path.local arguments for hooks have been deprecated. See the deprecation note <legacy-path-hooks-deprecated>{.interpreted-text role="ref"} for full details.

      py.path.local arguments to Node constructors have been deprecated. See the deprecation note <node-ctor-fspath-deprecation>{.interpreted-text role="ref"} for full details.

      ::: {.note} ::: {.admonition-title} Note :::

      The name of the ~_pytest.nodes.Node{.interpreted-text role="class"} arguments and attributes (the new attribute being path) is the opposite of the situation for hooks (the old argument being path).

      This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the py{.interpreted-text role="pypi"} dependency (see 9283{.interpreted-text role="issue"} for a longer discussion). :::

    • #​7469: Directly constructing the following classes is now deprecated:

      • _pytest.mark.structures.Mark
      • _pytest.mark.structures.MarkDecorator
      • _pytest.mark.structures.MarkGenerator
      • _pytest.python.Metafunc
      • _pytest.runner.CallInfo
      • _pytest._code.ExceptionInfo
      • _pytest.config.argparsing.Parser
      • _pytest.config.argparsing.OptionGroup
      • _pytest.pytester.HookRecorder

      These constructors have always been considered private, but now issue a deprecation warning, which may become a hard error in pytest 8.

    • #​8242: Raising unittest.SkipTest{.interpreted-text role="class"} to skip collection of tests during the pytest collection phase is deprecated. Use pytest.skip{.interpreted-text role="func"} instead.

      Note: This deprecation only relates to using unittest.SkipTest{.interpreted-text role="class"} during test collection. You are probably not doing that. Ordinary usage of unittest.SkipTest{.interpreted-text role="class"} / unittest.TestCase.skipTest{.interpreted-text role="meth"} / unittest.skip{.interpreted-text role="func"} in unittest test cases is fully supported.

    • #​8315: Several behaviors of Parser.addoption <pytest.Parser.addoption>{.interpreted-text role="meth"} are now scheduled for removal in pytest 8 (deprecated since pytest 2.4.0):

      • parser.addoption(..., help=".. %default ..") - use %(default)s instead.
      • parser.addoption(..., type="int/string/float/complex") - use type=int etc. instead.
    • #​8447: Defining a custom pytest node type which is both an pytest.Item <Item>{.interpreted-text role="class"} and a pytest.Collector <Collector>{.interpreted-text role="class"} (e.g. pytest.File <File>{.interpreted-text role="class"}) now issues a warning. It was never sanely supported and triggers hard to debug errors.

      See the deprecation note <diamond-inheritance-deprecated>{.interpreted-text role="ref"} for full details.

    • #​8592: pytest_cmdline_preparse{.interpreted-text role="hook"} has been officially deprecated. It will be removed in a future release. Use pytest_load_initial_conftests{.interpreted-text role="hook"} instead.

      See the deprecation note <cmdline-preparse-deprecated>{.interpreted-text role="ref"} for full details.

    • #​8645: pytest.warns(None) <pytest.warns>{.interpreted-text role="func"} is now deprecated because many people used it to mean "this code does not emit warnings", but it actually had the effect of checking that the code emits at least one warning of any type - like pytest.warns() or pytest.warns(Warning).

    • #​8948: pytest.skip(msg=...) <pytest.skip>{.interpreted-text role="func"}, pytest.fail(msg=...) <pytest.fail>{.interpreted-text role="func"} and pytest.exit(msg=...) <pytest.exit>{.interpreted-text role="func"} signatures now accept a reason argument instead of msg. Using msg still works, but is deprecated and will be removed in a future release.

      This was changed for consistency with pytest.mark.skip <pytest.mark.skip>{.interpreted-text role="func"} and pytest.mark.xfail <pytest.mark.xfail>{.interpreted-text role="func"} which both accept reason as an argument.

    • #​8174: The following changes have been made to types reachable through pytest.ExceptionInfo.traceback{.interpreted-text role="attr"}:

      • The path property of _pytest.code.Code returns Path instead of py.path.local.
      • The path property of _pytest.code.TracebackEntry returns Path instead of py.path.local.

      There was no deprecation period for this change (sorry!).

    Features

    • #​5196: Tests are now ordered by definition order in more cases.

      In a class hierarchy, tests from base classes are now consistently ordered before tests defined on their subclasses (reverse MRO order).

    • #​7132: Added two environment variables PYTEST_THEME{.interpreted-text role="envvar"} and PYTEST_THEME_MODE{.interpreted-text role="envvar"} to let the users customize the pygments theme used.

    • #​7259: Added cache.mkdir() <pytest.Cache.mkdir>{.interpreted-text role="meth"}, which is similar to the existing cache.makedir() <pytest.Cache.makedir>{.interpreted-text role="meth"}, but returns a pathlib.Path{.interpreted-text role="class"} instead of a legacy py.path.local.

      Added a paths type to parser.addini() <pytest.Parser.addini>{.interpreted-text role="meth"}, as in parser.addini("mypaths", "my paths", type="paths"), which is similar to the existing pathlist, but returns a list of pathlib.Path{.interpreted-text role="class"} instead of legacy py.path.local.

    • #​7469: The types of objects used in pytest's API are now exported so they may be used in type annotations.

      The newly-exported types are:

      • pytest.Config for Config <pytest.Config>{.interpreted-text role="class"}.
      • pytest.Mark for marks <pytest.Mark>{.interpreted-text role="class"}.
      • pytest.MarkDecorator for mark decorators <pytest.MarkDecorator>{.interpreted-text role="class"}.
      • pytest.MarkGenerator for the pytest.mark <pytest.MarkGenerator>{.interpreted-text role="class"} singleton.
      • pytest.Metafunc for the metafunc <pytest.MarkGenerator>{.interpreted-text role="class"} argument to the pytest_generate_tests{.interpreted-text role="hook"} hook.
      • pytest.CallInfo for the CallInfo <pytest.CallInfo>{.interpreted-text role="class"} type passed to various hooks.
      • pytest.PytestPluginManager for PytestPluginManager <pytest.PytestPluginManager>{.interpreted-text role="class"}.
      • pytest.ExceptionInfo for the ExceptionInfo <pytest.ExceptionInfo>{.interpreted-text role="class"} type returned from pytest.raises{.interpreted-text role="func"} and passed to various hooks.
      • pytest.Parser for the Parser <pytest.Parser>{.interpreted-text role="class"} type passed to the pytest_addoption{.interpreted-text role="hook"} hook.
      • pytest.OptionGroup for the OptionGroup <pytest.OptionGroup>{.interpreted-text role="class"} type returned from the parser.addgroup <pytest.Parser.getgroup>{.interpreted-text role="func"} method.
      • pytest.HookRecorder for the HookRecorder <pytest.HookRecorder>{.interpreted-text role="class"} type returned from ~pytest.Pytester{.interpreted-text role="class"}.
      • pytest.RecordedHookCall for the RecordedHookCall <pytest.HookRecorder>{.interpreted-text role="class"} type returned from ~pytest.HookRecorder{.interpreted-text role="class"}.
      • pytest.RunResult for the RunResult <pytest.RunResult>{.interpreted-text role="class"} type returned from ~pytest.Pytester{.interpreted-text role="class"}.
      • pytest.LineMatcher for the LineMatcher <pytest.RunResult>{.interpreted-text role="class"} type used in ~pytest.RunResult{.interpreted-text role="class"} and others.
      • pytest.TestReport for the TestReport <pytest.TestReport>{.interpreted-text role="class"} type used in various hooks.
      • pytest.CollectReport for the CollectReport <pytest.CollectReport>{.interpreted-text role="class"} type used in various hooks.

      Constructing most of them directly is not supported; they are only meant for use in type annotations. Doing so will emit a deprecation warning, and may become a hard-error in pytest 8.0.

      Subclassing them is also not supported. This is not currently enforced at runtime, but is detected by type-checkers such as mypy.

    • #​7856: --import-mode=importlib <import-modes>{.interpreted-text role="ref"} now works with features that depend on modules being on :pysys.modules{.interpreted-text role="data"}, such as pickle{.interpreted-text role="mod"} and dataclasses{.interpreted-text role="mod"}.

    • #​8144: The following hooks now receive an additional pathlib.Path argument, equivalent to an existing py.path.local argument:

      • pytest_ignore_collect{.interpreted-text role="hook"} - The collection_path parameter (equivalent to existing path parameter).
      • pytest_collect_file{.interpreted-text role="hook"} - The file_path parameter (equivalent to existing path parameter).
      • pytest_pycollect_makemodule{.interpreted-text role="hook"} - The module_path parameter (equivalent to existing path parameter).
      • pytest_report_header{.interpreted-text role="hook"} - The start_path parameter (equivalent to existing startdir parameter).
      • pytest_report_collectionfinish{.interpreted-text role="hook"} - The start_path parameter (equivalent to existing startdir parameter).

      ::: {.note} ::: {.admonition-title} Note :::

      The name of the ~_pytest.nodes.Node{.interpreted-text role="class"} arguments and attributes (the new attribute being path) is the opposite of the situation for hooks (the old argument being path).

      This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the py{.interpreted-text role="pypi"} dependency (see 9283{.interpreted-text role="issue"} for a longer discussion). :::

    • #​8251: Implement Node.path as a pathlib.Path. Both the old fspath and this new attribute gets set no matter whether path or fspath (deprecated) is passed to the constructor. It is a replacement for the fspath attribute (which represents the same path as py.path.local). While fspath is not deprecated yet due to the ongoing migration of methods like ~_pytest.Item.reportinfo{.interpreted-text role="meth"}, we expect to deprecate it in a future release.

      ::: {.note} ::: {.admonition-title} Note :::

      The name of the ~_pytest.nodes.Node{.interpreted-text role="class"} arguments and attributes (the new attribute being path) is the opposite of the situation for hooks (the old argument being path).

      This is an unfortunate artifact due to historical reasons, which should be resolved in future versions as we slowly get rid of the py{.interpreted-text role="pypi"} dependency (see 9283{.interpreted-text role="issue"} for a longer discussion). :::

    • #​8421: pytest.approx{.interpreted-text role="func"} now works on ~decimal.Decimal{.interpreted-text role="class"} within mappings/dicts and sequences/lists.

    • #​8606: pytest invocations with --fixtures-per-test and --fixtures have been enriched with:

      • Fixture location path printed with the fixture name.
      • First section of the fixture's docstring printed under the fixture name.
      • Whole of fixture's docstring printed under the fixture name using --verbose option.
    • #​8761: New version-tuple{.interpreted-text role="ref"} attribute, which makes it simpler for users to do something depending on the pytest version (such as declaring hooks which are introduced in later versions).

    • #​8789: Switch TOML parser from toml to tomli for TOML v1.0.0 support in pyproject.toml.

    • #​8920: Added pytest.Stash{.interpreted-text role="class"}, a facility for plugins to store their data on ~pytest.Config{.interpreted-text role="class"} and ~_pytest.nodes.Node{.interpreted-text role="class"}s in a type-safe and conflict-free manner. See plugin-stash{.interpreted-text role="ref"} for details.

    • #​8953: RunResult <_pytest.pytester.RunResult>{.interpreted-text role="class"} method assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>{.interpreted-text role="meth"} now accepts a warnings argument to assert the total number of warnings captured.

    • #​8954: --debug flag now accepts a str{.interpreted-text role="class"} file to route debug logs into, remains defaulted to [pytestdebug.log]{.title-ref}.

    • #​9023: Full diffs are now always shown for equality assertions of iterables when [CI]{.title-ref} or BUILD_NUMBER is found in the environment, even when -v isn't used.

    • #​9113: RunResult <_pytest.pytester.RunResult>{.interpreted-text role="class"} method assert_outcomes <_pytest.pytester.RunResult.assert_outcomes>{.interpreted-text role="meth"} now accepts a deselected argument to assert the total number of deselected tests.

    • #​9114: Added pythonpath{.interpreted-text role="confval"} setting that adds listed paths to sys.path{.interpreted-text role="data"} for the duration of the test session. If you currently use the pytest-pythonpath or pytest-srcpaths plugins, you should be able to replace them with built-in [pythonpath]{.title-ref} setting.

    Improvements

    • #​7480: A deprecation scheduled to be removed in a major version X (e.g. pytest 7, 8, 9, ...) now uses warning category [PytestRemovedInXWarning]{.title-ref}, a subclass of ~pytest.PytestDeprecationWarning{.interpreted-text role="class"}, instead of PytestDeprecationWarning{.interpreted-text role="class"} directly.

      See backwards-compatibility{.interpreted-text role="ref"} for more details.

    • #​7864: Improved error messages when parsing warning filters.

      Previously pytest would show an internal traceback, which besides being ugly sometimes would hide the cause of the problem (for example an ImportError while importing a specific warning type).

    • #​8335: Improved pytest.approx{.interpreted-text role="func"} assertion messages for sequences of numbers.

      The assertion messages now dumps a table with the index and the error of each diff. Example:

      >       assert [1, 2, 3, 4] == pytest.approx([1, 3, 3, 5])
      E       assert comparison failed for 2 values:
      E         Index | Obtained | Expected
      E         1     | 2        | 3 +- 3.0e-06
      E         3     | 4        | 5 +- 5.0e-06
      
    • #​8403: By default, pytest will truncate long strings in assert errors so they don't clutter the output too much, currently at 240 characters by default.

      However, in some cases the longer output helps, or is even crucial, to diagnose a failure. Using -v will now increase the truncation threshold to 2400 characters, and -vv or higher will disable truncation entirely.

    • #​8509: Fixed issue where unittest.TestCase.setUpClass{.interpreted-text role="meth"} is not called when a test has [/]{.title-ref} in its name since pytest 6.2.0.

      This refers to the path part in pytest node IDs, e.g. TestClass::test_it in the node ID tests/test_file.py::TestClass::test_it.

      Now, instead of assuming that the test name does not contain /, it is assumed that test path does not contain ::. We plan to hopefully make both of these work in the future.

    • #​8803: It is now possible to add colors to custom log levels on cli log.

      By using add_color_level <_pytest.logging.add_color_level>{.interpreted-text role="func"} from a pytest_configure hook, colors can be added:

      logging_plugin = config.pluginmanager.get_plugin('logging-plugin')
      logging_plugin.log_cli_handler.formatter.add_color_level(logging.INFO, 'cyan')
      logging_plugin.log_cli_handler.formatter.add_color_level(logging.SPAM, 'blue')
      

      See log_colors{.interpreted-text role="ref"} for more information.

    • #​8822: When showing fixture paths in [--fixtures]{.title-ref} or [--fixtures-by-test]{.title-ref}, fixtures coming from pytest itself now display an elided path, rather than the full path to the file in the [site-packages]{.title-ref} directory.

    • #​8898: Complex numbers are now treated like floats and integers when generating parameterization IDs.

    • #​9062: --stepwise-skip now implicitly enables --stepwise and can be used on its own.

    • #​9205: pytest.Cache.set{.interpreted-text role="meth"} now preserves key order when saving dicts.

    Bug Fixes

    • #​7124: Fixed an issue where __main__.py would raise an ImportError when --doctest-modules was provided.

    • #​8061: Fixed failing staticmethod test cases if they are inherited from a parent test class.

    • #​8192: testdir.makefile now silently accepts values which don't start with . to maintain backward compatibility with older pytest versions.

      pytester.makefile now issues a clearer error if the . is missing in the ext argument.

    • #​8258: Fixed issue where pytest's faulthandler support would not dump traceback on crashes if the faulthandler{.interpreted-text role="mod"} module was already enabled during pytest startup (using python -X dev -m pytest for example).

    • #​8317: Fixed an issue where illegal directory characters derived from getpass.getuser() raised an OSError.

    • #​8367: Fix Class.from_parent so it forwards extra keyword arguments to the constructor.

    • #​8377: The test selection options pytest -k and pytest -m now support matching names containing forward slash (/) characters.

    • #​8384: The @pytest.mark.skip decorator now correctly handles its arguments. When the reason argument is accidentally given both positional and as a keyword (e.g. because it was confused with skipif), a TypeError now occurs. Before, such tests were silently skipped, and the positional argument ignored. Additionally, reason is now documented correctly as positional or keyword (rather than keyword-only).

    • #​8394: Use private names for internal fixtures that handle classic setup/teardown so that they don't show up with the default --fixtures invocation (but they still show up with --fixtures -v).

    • #​8456: The required_plugins{.interpreted-text role="confval"} config option now works correctly when pre-releases of plugins are installed, rather than falsely claiming that those plugins aren't installed at all.

    • #​8464: -c <config file> now also properly defines rootdir as the directory that contains <config file>.

    • #​8503: pytest.MonkeyPatch.syspath_prepend{.interpreted-text role="meth"} no longer fails when setuptools is not installed. It now only calls pkg_resources.fixup_namespace_packages{.interpreted-text role="func"} if pkg_resources was previously imported, because it is not needed otherwise.

    • #​8548: Introduce fix to handle precision width in log-cli-format in turn to fix output coloring for certain formats.

    • #​8796: Fixed internal error when skipping doctests.

    • #​8983: The test selection options pytest -k and pytest -m now support matching names containing backslash ([\]{.title-ref}) characters. Backslashes are treated literally, not as escape characters (the values being matched against are already escaped).

    • #​8990: Fix [pytest -vv]{.title-ref} crashing with an internal exception [AttributeError: 'str' object has no attribute 'relative_to']{.title-ref} in some cases.

    • #​9077: Fixed confusing error message when request.fspath / request.path was accessed from a session-scoped fixture.

    • #​9131: Fixed the URL used by --pastebin to use bpa.st.

    • #​9163: The end line number and end column offset are now properly set for rewritten assert statements.

    • #​9169: Support for the files API from importlib.resources within rewritten files.

    • #​9272: The nose compatibility module-level fixtures [setup()]{.title-ref} and [teardown()]{.title-ref} are now only called once per module, instead of for each test function. They are now called even if object-level [setup]{.title-ref}/[teardown]{.title-ref} is defined.

    Improved Documentation

    • #​4320: Improved docs for [pytester.copy_example]{.title-ref}.
    • #​5105: Add automatically generated plugin-list{.interpreted-text role="ref"}. The list is updated on a periodic schedule.
    • #​8337: Recommend numpy.testing module on pytest.approx{.interpreted-text role="func"} documentation.
    • #​8655: Help text for --pdbcls more accurately reflects the option's behavior.
    • #​9210: Remove incorrect docs about confcutdir being a configuration option: it can only be set through the --confcutdir command-line option.
    • #​9242: Upgrade readthedocs configuration to use a newer Ubuntu version` with better unicode support for PDF docs.
    • #​9341: Various methods commonly used for non-python tests{.interpreted-text role="ref"} are now correctly documented in the reference docs. They were undocumented previously.

    Trivial/Internal Changes

    • #​8133: Migrate to setuptools_scm 6.x to use SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYTEST for more robust release tooling.
    • #​8174: The following changes have been made to internal pytest types/functions:
      • The _pytest.code.getfslineno() function returns Path instead of py.path.local.
      • The _pytest.python.path_matches_patterns() function takes Path instead of py.path.local.
      • The _pytest._code.Traceback.cut() function accepts any os.PathLike[str], not just py.path.local.
    • #​8248: Internal Restructure: let python.PyObjMixin inherit from nodes.Node to carry over typing information.
    • #​8432: Improve error message when pytest.skip{.interpreted-text role="func"} is used at module level without passing [allow_module_level=True]{.title-ref}.
    • #​8818: Ensure regendoc opts out of TOX_ENV cachedir selection to ensure independent example test runs.
    • #​8913: The private CallSpec2._arg2scopenum attribute has been removed after an internal refactoring.
    • #​8967: pytest_assertion_pass{.interpreted-text role="hook"} is no longer considered experimental and future changes to it will be considered more carefully.
    • #​9202: Add github action to upload coverage report to codecov instead of bash uploader.
    • #​9225: Changed the command used to create sdist and wheel artifacts: using the build package instead of setup.py.
    • #​9351: Correct minor typos in doc/en/example/special.rst.

    v6.2.5

    Compare Source

    pytest 6.2.5 (2021-08-29)

    Trivial/Internal Changes

    • #​8494: Python 3.10 is now supported.
    • #​9040: Enable compatibility with pluggy 1.0 or later.

    v6.2.4

    Compare Source

    pytest 6.2.4 (2021-05-04)

    Bug Fixes

    • #​8539: Fixed assertion rewriting on Python 3.10.

    v6.2.3

    Compare Source

    pytest 6.2.3 (2021-04-03)

    Bug Fixes

    • #​8414: pytest used to create directories under /tmp with world-readable permissions. This means that any user in the system was able to read information written by tests in temporary directories (such as those created by the tmp_path/tmpdir fixture). Now the directories are created with private permissions.

      pytest used silenty use a pre-existing /tmp/pytest-of-<username> directory, even if owned by another user. This means another user could pre-create such a directory and gain control of another user's temporary directory. Now such a condition results in an error.

    v6.2.2

    Compare Source

    pytest 6.2.2 (2021-01-25)

    Bug Fixes

    • #​8152: Fixed "(<Skipped instance>)" being shown as a skip reason in the verbose test summary line when the reason is empty.
    • #​8249: Fix the faulthandler plugin for occasions when running with twisted.logger and using pytest --capture=no.

    v6.2.1

    Compare Source

    pytest 6.2.1 (2020-12-15)

    Bug Fixes

    • #​7678: Fixed bug where ImportPathMismatchError would be raised for files compiled in the host and loaded later from an UNC mounted path (Windows).

    • #​8132: Fixed regression in approx: in 6.2.0 approx no longer raises TypeError when dealing with non-numeric types, falling back to normal comparison. Before 6.2.0, array types like tf.DeviceArray fell through to the scalar case, and happened to compare correctly to a scalar if they had only one element. After 6.2.0, these types began failing, because they inherited neither from standard Python number hierarchy nor from numpy.ndarray.

      approx now converts arguments to numpy.ndarray if they expose the array protocol and are not scalars. This treats array-like objects like numpy arrays, regardless of size.

    v6.2.0

    Compare Source

    pytest 6.2.0 (2020-12-12)

    Breaking Changes

    • #​7808: pytest now supports python3.6+ only.

    Deprecations

    • #​7469: Directly constructing/calling the following classes/functions is now deprecated:

      • _pytest.cacheprovider.Cache
      • _pytest.cacheprovider.Cache.for_config()
      • _pytest.cacheprovider.Cache.clear_cache()
      • _pytest.cacheprovider.Cache.cache_dir_from_config()
      • _pytest.capture.CaptureFixture
      • _pytest.fixtures.FixtureRequest
      • _pytest.fixtures.SubRequest
      • _pytest.logging.LogCaptureFixture
      • _pytest.pytester.Pytester
      • _pytest.pytester.Testdir
      • _pytest.recwarn.WarningsRecorder
      • _pytest.recwarn.WarningsChecker
      • _pytest.tmpdir.TempPathFactory
      • _pytest.tmpdir.TempdirFactory

      These have always been considered private, but now issue a deprecation warning, which may become a hard error in pytest 7.0.0.

    • #​7530: The --strict command-line option has been deprecated, use --strict-markers instead.

      We have plans to maybe in the future to reintroduce --strict and make it an encompassing flag for all strictness related options (--strict-markers and --strict-config at the moment, more might be introduced in the future).

    • #​7988: The @pytest.yield_fixture decorator/function is now deprecated. Use pytest.fixture instead.

      yield_fixture has been an alias for fixture for a very long time, so can be search/replaced safely.

    Features

    • #​5299: pytest now warns about unraisable exceptions and unhandled thread exceptions that occur in tests on Python>=3.8. See unraisable for more information.

    • #​7425: New pytester fixture, which is identical to testdir but its methods return pathlib.Path when appropriate instead of py.path.local.

      This is part of the movement to use pathlib.Path objects internally, in order to remove the dependency to py in the future.

      Internally, the old Testdir <_pytest.pytester.Testdir> is now a thin wrapper around Pytester <_pytest.pytester.Pytester>, preserving the old interface.

    • #​7695: A new hook was added, pytest_markeval_namespace which should return a dictionary. This dictionary will be used to augment the "global" variables available to evaluate skipif/xfail/xpass markers.

      Pseudo example

      conftest.py:

      def pytest_markeval_namespace():
          return {"color": "red"}
      

      test_func.py:

      @&#8203;pytest.mark.skipif("color == 'blue'", reason="Color is not red")
      def test_func():
          assert False
      
    • #​8006: It is now possible to construct a ~pytest.MonkeyPatch object directly as pytest.MonkeyPatch(), in cases when the monkeypatch fixture cannot be used. Previously some users imported it from the private _pytest.monkeypatch.MonkeyPatch namespace.

      Additionally, MonkeyPatch.context <pytest.MonkeyPatch.context> is now a classmethod, and can be used as with MonkeyPatch.context() as mp: .... This is the recommended way to use MonkeyPatch directly, since unlike the monkeypatch fixture, an instance created directly is not undo()-ed automatically.

    Improvements

    • #​1265: Added an __str__ implementation to the ~pytest.pytester.LineMatcher class which is returned from pytester.run_pytest().stdout and similar. It returns

    Configuration

    📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    🔕 Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box

    This PR has been generated by Mend Renovate. View repository job log here.

    opened by renovate[bot] 0
  • chore(deps): update dependency autopep8 to v2

    chore(deps): update dependency autopep8 to v2

    Mend Renovate

    This PR contains the following updates:

    | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | autopep8 | ^1.4.4 -> ^2.0.0 | age | adoption | passing | confidence |


    Release Notes

    hhatto/autopep8

    v2.0.0

    Compare Source

    version 1.7.1 is yanked.

    release version 2.0.0

    v1.7.1

    Compare Source

    What's Changed

    New Contributors

    Full Changelog: https://github.com/hhatto/autopep8/compare/v1.7.0...v1.7.1


    Configuration

    📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    🔕 Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box

    This PR has been generated by Mend Renovate. View repository job log here.

    opened by renovate[bot] 0
  • chore(deps): update actions/setup-python action to v4

    chore(deps): update actions/setup-python action to v4

    Mend Renovate

    This PR contains the following updates:

    | Package | Type | Update | Change | |---|---|---|---| | actions/setup-python | action | major | v2 -> v4 |


    Release Notes

    actions/setup-python

    v4

    Compare Source

    v3

    Compare Source


    Configuration

    📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    🔕 Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box

    This PR has been generated by Mend Renovate. View repository job log here.

    opened by renovate[bot] 0
  • chore(deps): update actions/checkout action to v3

    chore(deps): update actions/checkout action to v3

    Mend Renovate

    This PR contains the following updates:

    | Package | Type | Update | Change | |---|---|---|---| | actions/checkout | action | major | v2 -> v3 |


    Release Notes

    actions/checkout

    v3

    Compare Source


    Configuration

    📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

    🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

    Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

    🔕 Ignore: Close this PR and you won't be reminded about this update again.


    • [ ] If you want to rebase/retry this PR, check this box

    This PR has been generated by Mend Renovate. View repository job log here.

    opened by renovate[bot] 0
  • Dependency Dashboard

    Dependency Dashboard

    This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

    This repository currently has no open or pending branches.

    Detected dependencies

    docker-compose
    {{cookiecutter.project_slug}}/docker-compose.yml
    dockerfile
    {{cookiecutter.project_slug}}/Dockerfile
    • python 3.11.1
    github-actions
    .github/workflows/ci.yaml
    • actions/checkout v3
    • actions/cache v3
    • actions/setup-python v4
    poetry
    {{cookiecutter.project_slug}}/pyproject.toml
    • fastapi ^0.88.0
    • uvicorn 0.20.0
    • pydantic ^1.3
    • requests ^2.22.0
    • loguru ^0.6.0
    • joblib ^1.2.0
    • scikit-learn ^1.2.0
    • pytest ^7.2
    • autopep8 ^2.0.0
    • ipdb ^0.13.0
    • pylint ^2.15.8
    • mangum ^0.17.0

    • [ ] Check this box to trigger a request for Renovate to run again on this repository
    opened by renovate[bot] 0
Releases(v1.0.0)
  • v1.0.0(Dec 18, 2022)

    What's Changed

    • fix: jinja render and ci by @arthurhenrique in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/19
    • fix(security): update packages and dependencies by @arthurhenrique in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/20
    • Bump joblib from 0.15.1 to 1.2.0 in /{{cookiecutter.project_slug}} by @dependabot in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/21
    • Configure Renovate by @renovate in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/22
    • chore(deps): update python docker tag to v3.11.0 by @renovate in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/24
    • chore(deps): update dependency ipdb to ^0.13.0 by @renovate in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/23
    • fix(deps): update dependency loguru to ^0.6.0 by @renovate in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/27
    • fix(deps): update dependency fastapi to ^0.86.0 by @renovate in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/26
    • chore(deps): update actions/cache action to v3 by @renovate in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/29
    • fix(deps): update dependency uvicorn to v0.19.0 by @renovate in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/28
    • chore(deps): update actions/checkout action to v3 by @renovate in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/30
    • chore(deps): update actions/setup-python action to v4 by @renovate in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/31
    • chore(deps): update dependency autopep8 to v2 by @renovate in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/32
    • chore(deps): update dependency pytest to v7 by @renovate in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/33
    • fix(deps): update dependency fastapi to ^0.87.0 by @renovate in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/34
    • fix(deps): update dependency uvicorn to v0.20.0 by @renovate in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/35
    • fix(deps): update dependency fastapi to ^0.88.0 by @renovate in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/36
    • chore(deps): update python docker tag to v3.11.1 by @renovate in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/37
    • Bump certifi from 2022.9.24 to 2022.12.7 in /{{cookiecutter.project_slug}} by @dependabot in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/38
    • up to date by @arthurhenrique in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/39

    New Contributors

    • @dependabot made their first contribution in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/21
    • @renovate made their first contribution in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/22

    Full Changelog: https://github.com/arthurhenrique/cookiecutter-fastapi/compare/v0.0.2...v1.0.0

    Source code(tar.gz)
    Source code(zip)
  • v0.0.2(Jun 11, 2022)

    What's Changed

    • Sourcery Starbot ⭐ refactored arthurhenrique/cookiecutter-fastapi by @sourcery-ai-bot in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/9
    • Create MIT LICENSE by @arthurhenrique in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/10
    • chore: bump versions by @arthurhenrique in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/11
    • chore: update to fix security warnings by @arthurhenrique in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/12
    • chore: bumps poetry lock by @arthurhenrique in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/13
    • fix(security): bumps uvicorn for websocket > 10 by @arthurhenrique in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/14
    • Create CODE_OF_CONDUCT.md by @arthurhenrique in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/15
    • chore: update by @arthurhenrique in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/16
    • feat: add github actions by @arthurhenrique in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/17

    New Contributors

    • @sourcery-ai-bot made their first contribution in https://github.com/arthurhenrique/cookiecutter-fastapi/pull/9

    Full Changelog: https://github.com/arthurhenrique/cookiecutter-fastapi/compare/v0.0.1...v0.0.2

    Source code(tar.gz)
    Source code(zip)
Owner
Arthur Henrique
λ
Arthur Henrique
A FastAPI Plug-In to support authentication authorization using the Microsoft Authentication Library (MSAL)

FastAPI/MSAL - MSAL (Microsoft Authentication Library) plugin for FastAPI FastAPI - https://github.com/tiangolo/fastapi FastAPI is a modern, fast (hig

Dudi Levy 15 Jul 20, 2022
Practice-python is a simple Fast api project for dealing with modern rest api technologies.

Practice Python Practice-python is a simple Fast api project for dealing with modern rest api technologies. Deployment with docker Go to the project r

0 Sep 19, 2022
🚀 Cookiecutter Template for FastAPI + React Projects. Using PostgreSQL, SQLAlchemy, and Docker

FastAPI + React · A cookiecutter template for bootstrapping a FastAPI and React project using a modern stack. Features FastAPI (Python 3.8) JWT authen

Gabriel Abud 1.4k Jan 02, 2023
Keycloak integration for Python FastAPI

FastAPI Keycloak Integration Documentation Introduction Welcome to fastapi-keycloak. This projects goal is to ease the integration of Keycloak (OpenID

Code Specialist 113 Dec 31, 2022
Cookiecutter API for creating Custom Skills for Azure Search using Python and Docker

cookiecutter-spacy-fastapi Python cookiecutter API for quick deployments of spaCy models with FastAPI Azure Search The API interface is compatible wit

Microsoft 379 Jan 03, 2023
This code generator creates FastAPI app from an openapi file.

fastapi-code-generator This code generator creates FastAPI app from an openapi file. This project is an experimental phase. fastapi-code-generator use

Koudai Aono 632 Jan 05, 2023
A request rate limiter for fastapi

fastapi-limiter Introduction FastAPI-Limiter is a rate limiting tool for fastapi routes. Requirements redis Install Just install from pypi pip insta

long2ice 200 Jan 08, 2023
Instrument your FastAPI app

Prometheus FastAPI Instrumentator A configurable and modular Prometheus Instrumentator for your FastAPI. Install prometheus-fastapi-instrumentator fro

Tim Schwenke 441 Jan 05, 2023
FastAPI with Docker and Traefik

Dockerizing FastAPI with Postgres, Uvicorn, and Traefik Want to learn how to build this? Check out the post. Want to use this project? Development Bui

51 Jan 06, 2023
Cube-CRUD is a simple example of a REST API CRUD in a context of rubik's cube review service.

Cube-CRUD is a simple example of a REST API CRUD in a context of rubik's cube review service. It uses Sqlalchemy ORM to manage the connection and database operations.

Sebastian Andrade 1 Dec 11, 2021
API using python and Fastapi framework

Welcome 👋 CFCApi is a API DEVELOPMENT PROJECT UNDER CODE FOR COMMUNITY ! Project Walkthrough 🚀 CFCApi run on Python using FASTapi Framework Docs The

Abhishek kushwaha 7 Jan 02, 2023
A FastAPI Middleware of joerick/pyinstrument to check your service performance.

fastapi_profiler A FastAPI Middleware of joerick/pyinstrument to check your service performance. 📣 Info A FastAPI Middleware of pyinstrument to check

LeoSun 107 Jan 05, 2023
Repository for the Demo of using DVC with PyCaret & MLOps (DVC Office Hours - 20th Jan, 2022)

Using DVC with PyCaret & FastAPI (Demo) This repo contains all the resources for my demo explaining how to use DVC along with other interesting tools

Tezan Sahu 6 Jul 22, 2022
Hook Slinger acts as a simple service that lets you send, retry, and manage event-triggered POST requests, aka webhooks

Hook Slinger acts as a simple service that lets you send, retry, and manage event-triggered POST requests, aka webhooks. It provides a fully self-contained docker image that is easy to orchestrate, m

Redowan Delowar 96 Jan 02, 2023
Code for my FastAPI tutorial

FastAPI tutorial Code for my video tutorial FastAPI tutorial What is FastAPI? FastAPI is a high-performant REST API framework for Python. It's built o

José Haro Peralta 9 Nov 15, 2022
API written using Fast API to manage events and implement a leaderboard / badge system.

Open Food Facts Events API written using Fast API to manage events and implement a leaderboard / badge system. Installation To run the API locally, ru

Open Food Facts 5 Jan 07, 2023
Boilerplate code for quick docker implementation of REST API with JWT Authentication using FastAPI, PostgreSQL and PgAdmin ⭐

FRDP Boilerplate code for quick docker implementation of REST API with JWT Authentication using FastAPI, PostgreSQL and PgAdmin ⛏ . Getting Started Fe

BnademOverflow 53 Dec 29, 2022
Adds simple SQLAlchemy support to FastAPI

FastAPI-SQLAlchemy FastAPI-SQLAlchemy provides a simple integration between FastAPI and SQLAlchemy in your application. It gives access to useful help

Michael Freeborn 465 Jan 07, 2023
FastAPI Server Session is a dependency-based extension for FastAPI that adds support for server-sided session management

FastAPI Server-sided Session FastAPI Server Session is a dependency-based extension for FastAPI that adds support for server-sided session management.

DevGuyAhnaf 5 Dec 23, 2022
User authentication fastapi with python

user-authentication-fastapi Authentication API Development Setup environment You should create a virtual environment and activate it: virtualenv venv

Sabir Hussain 3 Mar 03, 2022