html-report-line-profiler


Namehtml-report-line-profiler JSON
Version 0.1.1 PyPI version JSON
download
home_pagehttps://1sixunhuit.frama.io/html_report_line_profiler
SummaryGenerate an HTML report for line_parser
upload_time2023-06-10 21:45:15
maintainer
docs_urlNone
authorPierre
requires_python>=3.9, <4
licenseAGPL 3
keywords ['profiling' 'profiler' 'line_profiler' 'html' 'report']
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![Latest Release](https://framagit.org/1sixunhuit/html_report_line_profiler/badges/main/release.svg)](https://framagit.org/1sixunhuit/html_report_line_profiler/-/releases)
[![pipeline status](https://framagit.org/1sixunhuit/html_report_line_profiler/badges/main/pipeline.svg)](https://framagit.org/1sixunhuit/html_report_line_profiler/-/commits/main)
[![coverage report](https://framagit.org/1sixunhuit/html_report_line_profiler/badges/main/coverage.svg)](https://1sixunhuit.frama.io/html_report_line_profiler/coveragepy_report/)
[![PEP8-Critical](https://img.shields.io/endpoint?url=https://1sixunhuit.frama.io/html_report_line_profiler/badges/pep8-critical.json)](https://1sixunhuit.frama.io/html_report_line_profiler/flake8_report/)
[![PEP8-NonCritical](https://img.shields.io/endpoint?url=https://1sixunhuit.frama.io/html_report_line_profiler/badges/pep8-noncritical.json)](https://1sixunhuit.frama.io/html_report_line_profiler/flake8_report/)
[![PEP8-Rate](https://img.shields.io/endpoint?url=https://1sixunhuit.frama.io/html_report_line_profiler/badges/pep8-rate.json)](https://1sixunhuit.frama.io/html_report_line_profiler/flake8_report/)

---

[![Downloads](https://pepy.tech/badge/html_report_line_profiler/month)](https://pepy.tech/project/html_report_line_profiler)
[![Supported Versions](https://img.shields.io/pypi/pyversions/html_report_line_profiler.svg)](https://pypi.org/project/html_report_line_profiler)

---


# Intro

Crée un rapport HTML (avec une arborescence), en se basant sur line_profiler : https://github.com/pyutils/line_profiler, fork de https://github.com/rkern/line_profiler


# TODO
- [ ] Several classes in one file : bug...

# Utilisation dans les tests unitaires :

A ajouter a un test unittaire unittest, et à lancer avec $ coverage run -m unittest test_str.py 

Dans :
```
[...]

import html_report_line_profiler as hr


class Test_CeciEstUnTest(unittest.TestCase):
    def setUp(self):
        # Code execute avant chaque test
        [...] # ce que l'on veut

        # Profiler :
        self.profiler, self.delete_profiling_env = hr.setUp_profiler(castList)

    #endDef

    # ...

    def tearDown(self):
        # Code executé après chaque test
        # Terminer le profiler en premier

        # Create basename
        hr.proffile_basename = classname2basename(
            file_name = __file__,
            class_name = self.__class__.__name__,
            method_name = self._testMethodName
        )

        # Launch the profiler out
        hr.tearDown_profiler(
            profiler=self.profiler,
            proffile_basename=proffile_basename,
            output_folder=output_folder,
            delete_profiling_env=self.delete_profiling_env
        )
        #
	# [...] # Les autres commandes
    #endDef
#endClass
```


# Rapport HTML
Pour lancer ensuite le post-traitement (rapport html) :
```
$ profiler_html_report.py
```

Remarques

* `-d = --input-dir` (default : './profile')
* `-o = --output-dir` (default : './profile_html')

            

Raw data

            {
    "_id": null,
    "home_page": "https://1sixunhuit.frama.io/html_report_line_profiler",
    "name": "html-report-line-profiler",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9, <4",
    "maintainer_email": "",
    "keywords": "['profiling','profiler','line_profiler','html','report']",
    "author": "Pierre",
    "author_email": "pierre@exemple.com",
    "download_url": "https://files.pythonhosted.org/packages/ad/74/3e1e4189fe2ee332fba4d38d4e9979d4639154fa62f92cf608e7464d2865/html_report_line_profiler-0.1.1.tar.gz",
    "platform": null,
    "description": "[![Latest Release](https://framagit.org/1sixunhuit/html_report_line_profiler/badges/main/release.svg)](https://framagit.org/1sixunhuit/html_report_line_profiler/-/releases)\n[![pipeline status](https://framagit.org/1sixunhuit/html_report_line_profiler/badges/main/pipeline.svg)](https://framagit.org/1sixunhuit/html_report_line_profiler/-/commits/main)\n[![coverage report](https://framagit.org/1sixunhuit/html_report_line_profiler/badges/main/coverage.svg)](https://1sixunhuit.frama.io/html_report_line_profiler/coveragepy_report/)\n[![PEP8-Critical](https://img.shields.io/endpoint?url=https://1sixunhuit.frama.io/html_report_line_profiler/badges/pep8-critical.json)](https://1sixunhuit.frama.io/html_report_line_profiler/flake8_report/)\n[![PEP8-NonCritical](https://img.shields.io/endpoint?url=https://1sixunhuit.frama.io/html_report_line_profiler/badges/pep8-noncritical.json)](https://1sixunhuit.frama.io/html_report_line_profiler/flake8_report/)\n[![PEP8-Rate](https://img.shields.io/endpoint?url=https://1sixunhuit.frama.io/html_report_line_profiler/badges/pep8-rate.json)](https://1sixunhuit.frama.io/html_report_line_profiler/flake8_report/)\n\n---\n\n[![Downloads](https://pepy.tech/badge/html_report_line_profiler/month)](https://pepy.tech/project/html_report_line_profiler)\n[![Supported Versions](https://img.shields.io/pypi/pyversions/html_report_line_profiler.svg)](https://pypi.org/project/html_report_line_profiler)\n\n---\n\n\n# Intro\n\nCr\u00e9e un rapport HTML (avec une arborescence), en se basant sur line_profiler : https://github.com/pyutils/line_profiler, fork de https://github.com/rkern/line_profiler\n\n\n# TODO\n- [ ] Several classes in one file : bug...\n\n# Utilisation dans les tests unitaires :\n\nA ajouter a un test unittaire unittest, et \u00e0 lancer avec $ coverage run -m unittest test_str.py \n\nDans :\n```\n[...]\n\nimport html_report_line_profiler as hr\n\n\nclass Test_CeciEstUnTest(unittest.TestCase):\n    def setUp(self):\n        # Code execute avant chaque test\n        [...] # ce que l'on veut\n\n        # Profiler :\n        self.profiler, self.delete_profiling_env = hr.setUp_profiler(castList)\n\n    #endDef\n\n    # ...\n\n    def tearDown(self):\n        # Code execut\u00e9 apr\u00e8s chaque test\n        # Terminer le profiler en premier\n\n        # Create basename\n        hr.proffile_basename = classname2basename(\n            file_name = __file__,\n            class_name = self.__class__.__name__,\n            method_name = self._testMethodName\n        )\n\n        # Launch the profiler out\n        hr.tearDown_profiler(\n            profiler=self.profiler,\n            proffile_basename=proffile_basename,\n            output_folder=output_folder,\n            delete_profiling_env=self.delete_profiling_env\n        )\n        #\n\t# [...] # Les autres commandes\n    #endDef\n#endClass\n```\n\n\n# Rapport HTML\nPour lancer ensuite le post-traitement (rapport html) :\n```\n$ profiler_html_report.py\n```\n\nRemarques\n\n* `-d = --input-dir` (default : './profile')\n* `-o = --output-dir` (default : './profile_html')\n",
    "bugtrack_url": null,
    "license": "AGPL 3",
    "summary": "Generate an HTML report for line_parser",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://1sixunhuit.frama.io/html_report_line_profiler"
    },
    "split_keywords": [
        "['profiling'",
        "'profiler'",
        "'line_profiler'",
        "'html'",
        "'report']"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fadb57478307a50613bf3eec038843f990861630ecd2aabc280e5d862e2b62b8",
                "md5": "db2e80020316be6421abb90a9bd9654a",
                "sha256": "3766420bb52577200d9fd69c0cfba50fe4337ba90fda0eb8ead7b820c1d70e0d"
            },
            "downloads": -1,
            "filename": "html_report_line_profiler-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "db2e80020316be6421abb90a9bd9654a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9, <4",
            "size": 18350,
            "upload_time": "2023-06-10T21:45:13",
            "upload_time_iso_8601": "2023-06-10T21:45:13.455075Z",
            "url": "https://files.pythonhosted.org/packages/fa/db/57478307a50613bf3eec038843f990861630ecd2aabc280e5d862e2b62b8/html_report_line_profiler-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ad743e1e4189fe2ee332fba4d38d4e9979d4639154fa62f92cf608e7464d2865",
                "md5": "6903d5e8475ab448d838f6184f4a0f92",
                "sha256": "797f7e4b4283dd5b4da46e23d8473dfecbea46d9526f3905c72fd91f80b95a13"
            },
            "downloads": -1,
            "filename": "html_report_line_profiler-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "6903d5e8475ab448d838f6184f4a0f92",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9, <4",
            "size": 15024,
            "upload_time": "2023-06-10T21:45:15",
            "upload_time_iso_8601": "2023-06-10T21:45:15.962335Z",
            "url": "https://files.pythonhosted.org/packages/ad/74/3e1e4189fe2ee332fba4d38d4e9979d4639154fa62f92cf608e7464d2865/html_report_line_profiler-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-10 21:45:15",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "html-report-line-profiler"
}
        
Elapsed time: 0.09311s