dsbench


Namedsbench JSON
Version 0.1.1 PyPI version JSON
download
home_page
Summary
upload_time2024-01-18 03:42:39
maintainer
docs_urlNone
authorDemonicSavage
requires_python>=3.9,<4.0
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # DSBench

This small library provides a decorator function that benchmarks functions.

### dsbench.benchmark(\*, name: str, cumulative: bool = False, range_start: int = 0, range_end: int = None) -> Callable

Decorator function for benchmarking other functions.

* **Parameters:**
  * **name** (*str*) – The name of the benchmark.
  * **cumulative** (*bool* *,* *optionals*) – Whether to benchmark a function a number of times with different inputs. If the decorated function returns a result, the sum of the total results is displayed. Defaults to False.
  * **range_start** (*int* *,* *optional*) – The start value of the range for cumulative benchmarking. Defaults to 0.
  * **range_end** (*int* *,* *optional*) – The end value of the range for cumulative benchmarking. Defaults to the decorated function’s first argument.
* **Returns:**
  The decorated function.
* **Return type:**
  function

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "dsbench",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<4.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "DemonicSavage",
    "author_email": "gabrielhuwe@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/53/ad/0fc2a3b50e523aefe5824b25a6b0b42ac7e1a12e76142acb418becb21e5e/dsbench-0.1.1.tar.gz",
    "platform": null,
    "description": "# DSBench\n\nThis small library provides a decorator function that benchmarks functions.\n\n### dsbench.benchmark(\\*, name: str, cumulative: bool = False, range_start: int = 0, range_end: int = None) -> Callable\n\nDecorator function for benchmarking other functions.\n\n* **Parameters:**\n  * **name** (*str*) \u2013 The name of the benchmark.\n  * **cumulative** (*bool* *,* *optionals*) \u2013 Whether to benchmark a function a number of times with different inputs. If the decorated function returns a result, the sum of the total results is displayed. Defaults to False.\n  * **range_start** (*int* *,* *optional*) \u2013 The start value of the range for cumulative benchmarking. Defaults to 0.\n  * **range_end** (*int* *,* *optional*) \u2013 The end value of the range for cumulative benchmarking. Defaults to the decorated function\u2019s first argument.\n* **Returns:**\n  The decorated function.\n* **Return type:**\n  function\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "",
    "version": "0.1.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cf7016fd0acac1da1f89f2cf414d3a380e5de8cfd557c224c042fe1c54b16d5e",
                "md5": "3f68bb77d7e127facde3a801d7b53466",
                "sha256": "0e49717b3558d9a8686422ff238e90d64c69d66faa9b7a970aefffab1b7655a5"
            },
            "downloads": -1,
            "filename": "dsbench-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3f68bb77d7e127facde3a801d7b53466",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<4.0",
            "size": 6240,
            "upload_time": "2024-01-18T03:42:37",
            "upload_time_iso_8601": "2024-01-18T03:42:37.911919Z",
            "url": "https://files.pythonhosted.org/packages/cf/70/16fd0acac1da1f89f2cf414d3a380e5de8cfd557c224c042fe1c54b16d5e/dsbench-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "53ad0fc2a3b50e523aefe5824b25a6b0b42ac7e1a12e76142acb418becb21e5e",
                "md5": "8aa70d5e26d973d55c910085732357dc",
                "sha256": "8fc3f7611c2a013b05c0fcdaa19e87af45e161167113ed5bacb0ecf3649e68b5"
            },
            "downloads": -1,
            "filename": "dsbench-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "8aa70d5e26d973d55c910085732357dc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<4.0",
            "size": 5617,
            "upload_time": "2024-01-18T03:42:39",
            "upload_time_iso_8601": "2024-01-18T03:42:39.018445Z",
            "url": "https://files.pythonhosted.org/packages/53/ad/0fc2a3b50e523aefe5824b25a6b0b42ac7e1a12e76142acb418becb21e5e/dsbench-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-18 03:42:39",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "dsbench"
}
        
Elapsed time: 0.47110s