Commit for release 2.1.1.

- Fix of [ydataai#206] - Improve code maintainability of the view (HTML templates, notebook) - Fix bug in dendrogram sizing
chanedwin · Jul 11, 2019 · 03db596 · 03db596
1 parent cf4eafa
commit 03db596
Show file tree

Hide file tree

Showing 7 changed files with 483 additions and 0 deletions.
diff --git a/docs/utils/notebook.html b/docs/utils/notebook.html
@@ -0,0 +1,87 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
+<meta name="generator" content="pdoc 0.6.2" />
+<title>pandas_profiling.utils.notebook API documentation</title>
+<meta name="description" content="Utility functions that come in handy when working with Jupyter notebooks" />
+<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
+<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
+<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
+<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase;cursor:pointer}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>pandas_profiling.utils.notebook</code></h1>
+</header>
+<section id="section-intro">
+<p>Utility functions that come in handy when working with Jupyter notebooks</p>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">&#34;&#34;&#34;Utility functions that come in handy when working with Jupyter notebooks&#34;&#34;&#34;
+
+
+def full_width():
+    &#34;&#34;&#34;Resize the notebook to use it&#39;s full width&#34;&#34;&#34;
+    from IPython.core.display import display, HTML
+
+    display(HTML(&#34;&lt;style&gt;.container { width:100% !important; }&lt;/style&gt;&#34;))</code></pre>
+</details>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-functions">Functions</h2>
+<dl>
+<dt id="pandas_profiling.utils.notebook.full_width"><code class="name flex">
+<span>def <span class="ident">full_width</span></span>(<span>)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Resize the notebook to use it's full width</p></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">def full_width():
+    &#34;&#34;&#34;Resize the notebook to use it&#39;s full width&#34;&#34;&#34;
+    from IPython.core.display import display, HTML
+
+    display(HTML(&#34;&lt;style&gt;.container { width:100% !important; }&lt;/style&gt;&#34;))</code></pre>
+</details>
+</dd>
+</dl>
+</section>
+<section>
+</section>
+</article>
+<nav id="sidebar">
+<h1>Index</h1>
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="pandas_profiling.utils" href="index.html">pandas_profiling.utils</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-functions">Functions</a></h3>
+<ul class="">
+<li><code><a title="pandas_profiling.utils.notebook.full_width" href="#pandas_profiling.utils.notebook.full_width">full_width</a></code></li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.6.2</a>.</p>
+</footer>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
+<script>hljs.initHighlightingOnLoad()</script>
+</body>
+</html>
diff --git a/docs/view/notebook.html b/docs/view/notebook.html
@@ -0,0 +1,264 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
+<meta name="generator" content="pdoc 0.6.2" />
+<title>pandas_profiling.view.notebook API documentation</title>
+<meta name="description" content="Functionality related to displaying the profile report in Jupyter notebooks." />
+<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
+<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
+<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
+<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase;cursor:pointer}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>pandas_profiling.view.notebook</code></h1>
+</header>
+<section id="section-intro">
+<p>Functionality related to displaying the profile report in Jupyter notebooks.</p>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">&#34;&#34;&#34;Functionality related to displaying the profile report in Jupyter notebooks.&#34;&#34;&#34;
+import html
+from pathlib import Path
+
+
+from pandas_profiling.config import config
+
+
+def get_notebook_iframe_srcdoc(profile):
+    &#34;&#34;&#34;Get the IPython HTML object with ifram with the srcdoc attribute
+
+    Args:
+        profile: The profile report object
+
+    Returns:
+        IPython HTML object.
+    &#34;&#34;&#34;
+    from IPython.core.display import HTML
+
+    iframe = &#34;&#34;&#34;
+                &lt;iframe
+                    width=&#34;{width}&#34;
+                    height=&#34;{height}&#34;
+                    srcdoc=&#34;{src}&#34;
+                    frameborder=&#34;0&#34;
+                    allowfullscreen
+                &gt;&lt;/iframe&gt;
+                &#34;&#34;&#34;
+    iframe = iframe.format(
+        width=config[&#34;notebook&#34;][&#34;iframe&#34;][&#34;width&#34;].get(str),
+        height=config[&#34;notebook&#34;][&#34;iframe&#34;][&#34;height&#34;].get(str),
+        src=html.escape(profile.to_html()),
+    )
+    return HTML(iframe)
+
+
+def get_notebook_iframe_src(profile):
+    &#34;&#34;&#34;Get the IPython IFrame object
+
+    Args:
+        profile: The profile report object
+
+    Returns:
+        IPython IFrame object.
+    &#34;&#34;&#34;
+    tmp_file = Path(&#34;./ipynb_tmp&#34;) / profile.get_unique_file_name()
+    tmp_file.parent.mkdir(exist_ok=True)
+    profile.to_file(tmp_file)
+    from IPython.lib.display import IFrame
+
+    return IFrame(
+        str(tmp_file),
+        width=config[&#34;notebook&#34;][&#34;iframe&#34;][&#34;width&#34;].get(str),
+        height=config[&#34;notebook&#34;][&#34;iframe&#34;][&#34;height&#34;].get(str),
+    )
+
+
+def display_notebook_iframe(profile):
+    &#34;&#34;&#34;Display the profile report in an iframe in the Jupyter notebook
+
+    Args:
+        profile: The profile report object
+
+    Returns:
+        Displays the Iframe
+    &#34;&#34;&#34;
+    from IPython.core.display import display
+
+    attribute = config[&#34;notebook&#34;][&#34;iframe&#34;][&#34;attribute&#34;].get(str)
+    if attribute == &#34;src&#34;:
+        output = get_notebook_iframe_src(profile)
+    elif attribute == &#34;srcdoc&#34;:
+        output = get_notebook_iframe_srcdoc(profile)
+    else:
+        raise ValueError(
+            &#39;Iframe Attribute can be &#34;src&#34; or &#34;srcdoc&#34; (current: {}).&#39;.format(attribute)
+        )
+
+    display(output)</code></pre>
+</details>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-functions">Functions</h2>
+<dl>
+<dt id="pandas_profiling.view.notebook.display_notebook_iframe"><code class="name flex">
+<span>def <span class="ident">display_notebook_iframe</span></span>(<span>profile)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Display the profile report in an iframe in the Jupyter notebook</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>profile</code></strong></dt>
+<dd>The profile report object</dd>
+</dl>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>Displays</code> <code>the</code> <code>Iframe</code></dt>
+<dd>&nbsp;</dd>
+</dl></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">def display_notebook_iframe(profile):
+    &#34;&#34;&#34;Display the profile report in an iframe in the Jupyter notebook
+
+    Args:
+        profile: The profile report object
+
+    Returns:
+        Displays the Iframe
+    &#34;&#34;&#34;
+    from IPython.core.display import display
+
+    attribute = config[&#34;notebook&#34;][&#34;iframe&#34;][&#34;attribute&#34;].get(str)
+    if attribute == &#34;src&#34;:
+        output = get_notebook_iframe_src(profile)
+    elif attribute == &#34;srcdoc&#34;:
+        output = get_notebook_iframe_srcdoc(profile)
+    else:
+        raise ValueError(
+            &#39;Iframe Attribute can be &#34;src&#34; or &#34;srcdoc&#34; (current: {}).&#39;.format(attribute)
+        )
+
+    display(output)</code></pre>
+</details>
+</dd>
+<dt id="pandas_profiling.view.notebook.get_notebook_iframe_src"><code class="name flex">
+<span>def <span class="ident">get_notebook_iframe_src</span></span>(<span>profile)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Get the IPython IFrame object</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>profile</code></strong></dt>
+<dd>The profile report object</dd>
+</dl>
+<h2 id="returns">Returns</h2>
+<p>IPython IFrame object.</p></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">def get_notebook_iframe_src(profile):
+    &#34;&#34;&#34;Get the IPython IFrame object
+
+    Args:
+        profile: The profile report object
+
+    Returns:
+        IPython IFrame object.
+    &#34;&#34;&#34;
+    tmp_file = Path(&#34;./ipynb_tmp&#34;) / profile.get_unique_file_name()
+    tmp_file.parent.mkdir(exist_ok=True)
+    profile.to_file(tmp_file)
+    from IPython.lib.display import IFrame
+
+    return IFrame(
+        str(tmp_file),
+        width=config[&#34;notebook&#34;][&#34;iframe&#34;][&#34;width&#34;].get(str),
+        height=config[&#34;notebook&#34;][&#34;iframe&#34;][&#34;height&#34;].get(str),
+    )</code></pre>
+</details>
+</dd>
+<dt id="pandas_profiling.view.notebook.get_notebook_iframe_srcdoc"><code class="name flex">
+<span>def <span class="ident">get_notebook_iframe_srcdoc</span></span>(<span>profile)</span>
+</code></dt>
+<dd>
+<section class="desc"><p>Get the IPython HTML object with ifram with the srcdoc attribute</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>profile</code></strong></dt>
+<dd>The profile report object</dd>
+</dl>
+<h2 id="returns">Returns</h2>
+<p>IPython HTML object.</p></section>
+<details class="source">
+<summary>Source code</summary>
+<pre><code class="python">def get_notebook_iframe_srcdoc(profile):
+    &#34;&#34;&#34;Get the IPython HTML object with ifram with the srcdoc attribute
+
+    Args:
+        profile: The profile report object
+
+    Returns:
+        IPython HTML object.
+    &#34;&#34;&#34;
+    from IPython.core.display import HTML
+
+    iframe = &#34;&#34;&#34;
+                &lt;iframe
+                    width=&#34;{width}&#34;
+                    height=&#34;{height}&#34;
+                    srcdoc=&#34;{src}&#34;
+                    frameborder=&#34;0&#34;
+                    allowfullscreen
+                &gt;&lt;/iframe&gt;
+                &#34;&#34;&#34;
+    iframe = iframe.format(
+        width=config[&#34;notebook&#34;][&#34;iframe&#34;][&#34;width&#34;].get(str),
+        height=config[&#34;notebook&#34;][&#34;iframe&#34;][&#34;height&#34;].get(str),
+        src=html.escape(profile.to_html()),
+    )
+    return HTML(iframe)</code></pre>
+</details>
+</dd>
+</dl>
+</section>
+<section>
+</section>
+</article>
+<nav id="sidebar">
+<h1>Index</h1>
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="pandas_profiling.view" href="index.html">pandas_profiling.view</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-functions">Functions</a></h3>
+<ul class="">
+<li><code><a title="pandas_profiling.view.notebook.display_notebook_iframe" href="#pandas_profiling.view.notebook.display_notebook_iframe">display_notebook_iframe</a></code></li>
+<li><code><a title="pandas_profiling.view.notebook.get_notebook_iframe_src" href="#pandas_profiling.view.notebook.get_notebook_iframe_src">get_notebook_iframe_src</a></code></li>
+<li><code><a title="pandas_profiling.view.notebook.get_notebook_iframe_srcdoc" href="#pandas_profiling.view.notebook.get_notebook_iframe_srcdoc">get_notebook_iframe_srcdoc</a></code></li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.6.2</a>.</p>
+</footer>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
+<script>hljs.initHighlightingOnLoad()</script>
+</body>
+</html>
diff --git a/pandas_profiling/utils/notebook.py b/pandas_profiling/utils/notebook.py
@@ -0,0 +1,8 @@
+"""Utility functions that come in handy when working with Jupyter notebooks"""
+
+
+def full_width():
+    """Resize the notebook to use it's full width"""
+    from IPython.core.display import display, HTML
+
+    display(HTML("<style>.container { width:100% !important; }</style>"))