| Name | akarsu JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | |
| Summary | New Generation Profiler based on PEP 669 |
| upload_time | 2023-10-12 20:12:52 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.12 |
| license | The MIT License (MIT) ===================== Copyright © `2023` `Furkan Onder` Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
profiler
pep669
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
_akarsu_ is the New Generation Profiler based on
[PEP 669](https://peps.python.org/pep-0669/). The name of the project, comes from the
surname of a minstrel named `Muhlis Akarsu`, which means `stream`.
## Installation
_akarsu_ can be installed by running `pip install akarsu`. It requires Python 3.12.0+ to
run.
## Usage
```sh
cat example.py
```
Output:
```python
def foo():
x = 1
isinstance(x, int)
return x
def bar():
foo()
bar()
```
---
```sh
akarsu -f example.py
```
Output:
```
Count Event Type Filename(function)
1 PY_CALL example.py(bar)
1 PY_START example.py(bar)
1 PY_CALL example.py(foo)
1 PY_START example.py(foo)
1 C_CALL example.py(<built-in function isinstance>)
1 C_RETURN example.py(foo)
1 PY_RETURN example.py(foo)
1 PY_RETURN example.py(bar)
Total number of events: 8
PY_CALL = 2
PY_START = 2
PY_RETURN = 2
C_CALL = 1
C_RETURN = 1
```
---
If you want to show only the function calls in the output, you can use the `-c` or
`--calls` argument.
```sh
akarsu -c -f example.py
```
Output:
```
Count Event Type Filename(function)
1 PY_CALL example.py(bar)
1 PY_CALL example.py(foo)
1 C_CALL example.py(<built-in function isinstance>)
Total number of events: 3
PY_CALL = 2
C_CALL = 1
```
Raw data
{
"_id": null,
"home_page": "",
"name": "akarsu",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": "",
"keywords": "profiler,PEP669",
"author": "",
"author_email": "Furkan Onder <furkanonder@protonmail.com>",
"download_url": "https://files.pythonhosted.org/packages/17/7f/3577b49dc54ffcb554b16c6b59651adad499ecffeb580fc994be8cf84da4/akarsu-0.2.0.tar.gz",
"platform": null,
"description": "_akarsu_ is the New Generation Profiler based on\n[PEP 669](https://peps.python.org/pep-0669/). The name of the project, comes from the\nsurname of a minstrel named `Muhlis Akarsu`, which means `stream`.\n\n## Installation\n\n_akarsu_ can be installed by running `pip install akarsu`. It requires Python 3.12.0+ to\nrun.\n\n## Usage\n\n```sh\ncat example.py\n```\n\nOutput:\n\n```python\ndef foo():\n x = 1\n isinstance(x, int)\n return x\n\n\ndef bar():\n foo()\n\n\nbar()\n```\n\n---\n\n```sh\nakarsu -f example.py\n```\n\nOutput:\n\n```\n Count Event Type Filename(function)\n 1 PY_CALL example.py(bar)\n 1 PY_START example.py(bar)\n 1 PY_CALL example.py(foo)\n 1 PY_START example.py(foo)\n 1 C_CALL example.py(<built-in function isinstance>)\n 1 C_RETURN example.py(foo)\n 1 PY_RETURN example.py(foo)\n 1 PY_RETURN example.py(bar)\n\nTotal number of events: 8\n PY_CALL = 2\n PY_START = 2\n PY_RETURN = 2\n C_CALL = 1\n C_RETURN = 1\n```\n\n---\n\nIf you want to show only the function calls in the output, you can use the `-c` or\n`--calls` argument.\n\n```sh\nakarsu -c -f example.py\n```\n\nOutput:\n\n```\n Count Event Type Filename(function)\n 1 PY_CALL example.py(bar)\n 1 PY_CALL example.py(foo)\n 1 C_CALL example.py(<built-in function isinstance>)\n\nTotal number of events: 3\n PY_CALL = 2\n C_CALL = 1\n```\n",
"bugtrack_url": null,
"license": "The MIT License (MIT) ===================== Copyright \u00a9 `2023` `Furkan Onder` Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "New Generation Profiler based on PEP 669",
"version": "0.2.0",
"project_urls": {
"Bug Reports": "https://github.com/furkanonder/akarsu/issues",
"Homepage": "https://github.com/furkanonder/akarsu",
"Source": "https://github.com/furkanonder/akarsu"
},
"split_keywords": [
"profiler",
"pep669"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3183f2489e724dd764f1634b7c7163914987c2f242cfa8b0ffcba2a553f455a1",
"md5": "3848e0abcc922f3520a97aceb7e336d9",
"sha256": "d9307e1609e9e49d1bf965126ee09b7f8296ece02785465ad33add58ab434b31"
},
"downloads": -1,
"filename": "akarsu-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3848e0abcc922f3520a97aceb7e336d9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 5707,
"upload_time": "2023-10-12T20:12:51",
"upload_time_iso_8601": "2023-10-12T20:12:51.451489Z",
"url": "https://files.pythonhosted.org/packages/31/83/f2489e724dd764f1634b7c7163914987c2f242cfa8b0ffcba2a553f455a1/akarsu-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "177f3577b49dc54ffcb554b16c6b59651adad499ecffeb580fc994be8cf84da4",
"md5": "39cd22e111510f960fca335f69e40648",
"sha256": "762864b1b452d60d0235199a515a33cbc3ae0e78d92b709e004cdff18b0c43af"
},
"downloads": -1,
"filename": "akarsu-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "39cd22e111510f960fca335f69e40648",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 5374,
"upload_time": "2023-10-12T20:12:52",
"upload_time_iso_8601": "2023-10-12T20:12:52.602064Z",
"url": "https://files.pythonhosted.org/packages/17/7f/3577b49dc54ffcb554b16c6b59651adad499ecffeb580fc994be8cf84da4/akarsu-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-12 20:12:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "furkanonder",
"github_project": "akarsu",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "akarsu"
}
