{"author":null,"author_email":"Pablo Galindo Salgado ","bugtrack_url":null,"classifiers":["Intended Audience :: Developers","License :: OSI Approved :: Apache Software License","Operating System :: POSIX :: Linux","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: CPython","Topic :: Software Development :: Debuggers"],"description":" $\"logo\"/$ \n\n# pytest-memray\n\n[![PyPI](https://img.shields.io/pypi/v/pytest-memray?style=flat-square)](https://pypi.org/project/pytest-memray)\n[![PyPI - Implementation](https://img.shields.io/pypi/implementation/pytest-memray?style=flat-square)](https://pypi.org/project/pytest-memray)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pytest-memray?style=flat-square)](https://pypi.org/project/pytest-memray)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/pytest-memray?style=flat-square)](https://pypistats.org/packages/pytest-memray)\n[![PyPI - License](https://img.shields.io/pypi/l/pytest-memray?style=flat-square)](https://opensource.org/licenses/MIT)\n[![Tests](https://github.com/bloomberg/pytest-memray/actions/workflows/build.yml/badge.svg)](https://github.com/bloomberg/pytest-memray/actions/workflows/build.yml)\n![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)\n\npytest-memray is a pytest plugin for easy integration of\n[memray](https://github.com/bloomberg/memray).\n\n## Installation\n\npytest-memray requires Python 3.8 or higher and can be easily installed using most\ncommon Python packaging tools. We recommend installing the latest stable release from\n[PyPI](https://pypi.org/project/pytest-memray/) with pip:\n\n```shell\npip install pytest-memray\n```\n\n## Documentation\n\nYou can find the latest documentation available\n[here](https://pytest-memray.readthedocs.io/en/latest/).\n\n## Quick introduction\n\nTo use the plugin in a pytest run, simply add `--memray` to the command line invocation:\n\n```shell\npytest --memray tests\n```\n\nAfter the test suite runs you'll see a memory report printed:\n\n```bash\n=================================== test session starts ====================================\nplatform linux -- Python 3.10.4, pytest-7.1.2, pluggy-1.0.0\ncachedir: /v/.pytest_cache\nrootdir: /w\nplugins: memray-1.1.0\ncollected 2 items\n\ndemo/test_ok.py .M [100%]\n\n========================================= FAILURES =========================================\n____________________________________ test_memory_exceed ____________________________________\nTest was limited to 100.0KiB but allocated 117.2KiB\n------------------------------------ memray-max-memory -------------------------------------\nTest is using 117.2KiB out of limit of 100.0KiB\nList of allocations:\n\t- :/w/demo/test_ok.py:17 -> 117.2KiB\n\n====================================== MEMRAY REPORT =======================================\nAllocations results for demo/test_ok.py::test_memory_exceed\n\n\t 📦 Total memory allocated: 117.2KiB\n\t 📏 Total allocations: 30\n\t 📊 Histogram of allocation sizes: |█|\n\t 🥇 Biggest allocating functions:\n\t\t- :/w/demo/test_ok.py:17 -> 117.2KiB\n\n\nAllocations results for demo/test_ok.py::test_track\n\n\t 📦 Total memory allocated: 54.9KiB\n\t 📏 Total allocations: 71\n\t 📊 Histogram of allocation sizes: |█ ▅ |\n\t 🥇 Biggest allocating functions:\n\t\t- test_track:/w/demo/test_ok.py:12 -> 39.1KiB\n\t\t- _compile_bytecode::672 -> 7.2KiB\n\t\t- _call_with_frames_removed::241 -> 4.7KiB\n\t\t- _call_with_frames_removed::241 -> 1.8KiB\n\t\t- _is_marked_for_rewrite:/v/lib/python3.10/site-packages/_pytest/assertion/rewrite.py:240 -> 1.1KiB\n\n\n================================= short test summary info ==================================\nMEMORY PROBLEMS demo/test_ok.py::test_memory_exceed\n=============================== 1 failed, 1 passed in 0.01s ================================\n```\n\n## Configuration - CLI flags\n\n- `--memray` - activate memray tracking\n- `--most-allocations=MOST_ALLOCATIONS` - show the N tests that allocate most memory\n (N=0 for all)\n- `--hide-memray-summary` - hide the memray summary at the end of the execution\n- `--memray-bin-path` - path where to write the memray binary dumps (by default a\n temporary folder)\n- `--memray-bin-prefix` - prefix to use for the binary dump (by default a random UUID4\n hex)\n- `--stacks=STACKS` - Show the N stack entries when showing tracebacks of memory allocations\n- `--native` - Show native frames when showing tracebacks of memory allocations (will be slower)\n- `--trace-python-allocators` - Record allocations made by the Pymalloc allocator (will be slower)\n- `--fail-on-increase` - Fail a test with the `limit_memory`` marker if it uses\n more memory than its last successful run\n\n## Configuration - INI\n\n- `memray(bool)` - activate memray tracking\n- `most-allocations(string)` - show the N tests that allocate most memory (N=0 for all)\n- `hide_memray_summary(bool)` - hide the memray summary at the end of the execution\n- `stacks(int)` - Show the N stack entries when showing tracebacks of memory allocations\n- `native(bool)`- Show native frames when showing tracebacks of memory allocations (will be slower)\n- `trace_python_allocators(bool)` - Record allocations made by the Pymalloc allocator (will be slower)\n- `fail-on-increase(bool)` - Fail a test with the `limit_memory` marker if it\n uses more memory than its last successful run\n\n## License\n\npytest-memray is Apache-2.0 licensed, as found in the [LICENSE](LICENSE) file.\n\n## Code of Conduct\n\n- [Code of Conduct](https://github.com/bloomberg/.github/blob/main/CODE_OF_CONDUCT.md)\n\nThis project has adopted a Code of Conduct. If you have any concerns about the Code, or\nbehavior which you have experienced in the project, please contact us at\nopensource@bloomberg.net.\n\n## Security Policy\n\n- [Security Policy](https://github.com/bloomberg/pytest-memray/security/policy)\n\nIf you believe you have identified a security vulnerability in this project, please send\nemail to the project team at opensource@bloomberg.net, detailing the suspected issue and\nany methods you've found to reproduce it.\n\nPlease do NOT open an issue in the GitHub repository, as we'd prefer to keep\nvulnerability reports private until we've had an opportunity to review and address them.\n\n## Contributing\n\nWe welcome your contributions to help us improve and extend this project!\n\nBelow you will find some basic steps required to be able to contribute to the project.\nIf you have any questions about this process or any other aspect of contributing to a\nBloomberg open source project, feel free to email opensource@bloomberg.net, and we'll\nget your questions answered as quickly as we can.\n\n### Contribution Licensing\n\nSince this project is distributed under the terms of an [open source license](LICENSE),\ncontributions that you make are licensed under the same terms. In order for us to be\nable to accept your contributions, we will need explicit confirmation from you that you\nare able and willing to provide them under these terms, and the mechanism we use to do\nthis is called a Developer's Certificate of Origin\n[(DCO)](https://github.com/bloomberg/.github/blob/main/DCO.md). This is very similar to\nthe process used by the Linux(R) kernel, Samba, and many other major open source\nprojects.\n\nTo participate under these terms, all that you must do is include a line like the\nfollowing as the last line of the commit message for each commit in your contribution:\n\n```git\nSigned-Off-By: Random J. Developer \n```\n\nThe simplest way to accomplish this is to add `-s` or `--signoff` to your `git commit`\ncommand.\n\nYou must use your real name (sorry, no pseudonyms, and no anonymous contributions).\n\n### Steps\n\n- Create an Issue, selecting 'Feature Request', and explain the proposed change.\n- Follow the guidelines in the issue template presented to you.\n- Submit the Issue.\n- Submit a Pull Request and link it to the Issue by including \"#\" in the\n Pull Request summary.\n\n### Development\n\nThe project requires a Linux OS to work. To set up a DEV environment use tox (or\ndirectly the make targets). You can use Docker to run the test suite on non Linux as in\n(you can parametrize tox by passing additional arguments at the end):\n\n```shell\ndocker-compose run --rm test tox\n```\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":null,"license":null,"license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":"Pablo Galindo Salgado ","name":"pytest-memray","package_url":"https://pypi.org/project/pytest-memray/","platform":null,"project_url":"https://pypi.org/project/pytest-memray/","project_urls":{"Bug Tracker":"https://github.com/bloomberg/pytest-memray/issues","Documentation":"https://pytest-memray.readthedocs.io","Source Code":"https://github.com/bloomberg/pytest-memray"},"provides_extra":["docs","lint","test"],"release_url":"https://pypi.org/project/pytest-memray/1.7.0/","requires_dist":["memray>=1.12","pytest>=7.2","furo>=2022.12.7; extra == \"docs\"","sphinx-argparse>=0.4; extra == \"docs\"","sphinx-inline-tabs>=2022.1.2b11; extra == \"docs\"","sphinx>=6.1.3; extra == \"docs\"","sphinxcontrib-programoutput>=0.17; extra == \"docs\"","towncrier>=22.12; extra == \"docs\"","black==22.12; extra == \"lint\"","isort==5.11.4; extra == \"lint\"","mypy==0.991; extra == \"lint\"","ruff==0.0.272; extra == \"lint\"","anyio>=4.4.0; extra == \"test\"","covdefaults>=2.2.2; extra == \"test\"","coverage>=7.0.5; extra == \"test\"","flaky>=3.7; extra == \"test\"","pytest-xdist>=3.1; extra == \"test\"","pytest>=7.2; extra == \"test\""],"requires_python":">=3.8","summary":"A simple plugin to use with pytest","version":"1.7.0","yanked":false,"yanked_reason":null}

Dependency	Optional
memray	false
pytest	false
anyio	true
black	true
covdefaults	true
coverage	true
flaky	true
furo	true
isort	true
mypy	true
pytest-xdist	true
ruff	true
sphinx	true
sphinx-argparse	true
sphinx-inline-tabs	true
sphinxcontrib-programoutput	true
towncrier	true

Package search

pytest-memray

project_urls

Dependencies

All package metadata

Releases