Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V2.1.1 #209

Merged
merged 2 commits into from
Jul 11, 2019
Merged

V2.1.1 #209

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7ff4ab
Commit for release 2.1.1.
sbrugman Jul 10, 2019
1a02991
Commit for release 2.1.1.
sbrugman Jul 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/controller/console.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h1 class="title">Module <code>pandas_profiling.controller.console</code></h1>
if not args.silent:
import webbrowser

webbrowser.open_new_tab(p.file.name)</code></pre>
webbrowser.open_new_tab(args.output_file)</code></pre>
</details>
</section>
<section>
Expand Down Expand Up @@ -144,7 +144,7 @@ <h2 id="args">Args</h2>
if not args.silent:
import webbrowser

webbrowser.open_new_tab(p.file.name)</code></pre>
webbrowser.open_new_tab(args.output_file)</code></pre>
</details>
</dd>
<dt id="pandas_profiling.controller.console.parse_args"><code class="name flex">
Expand Down
84 changes: 5 additions & 79 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,6 @@ <h2 id="dependencies">Dependencies</h2>

.. include:: ../README.md
&#34;&#34;&#34;
import html
import sys
import warnings

Expand All @@ -174,6 +173,7 @@ <h2 id="dependencies">Dependencies</h2>
from pandas_profiling.controller import pandas_decorator
import pandas_profiling.view.templates as templates
from pandas_profiling.model.describe import describe as describe_df
from pandas_profiling.view.notebook import display_notebook_iframe
from pandas_profiling.view.report import to_html


Expand Down Expand Up @@ -319,50 +319,13 @@ <h2 id="dependencies">Dependencies</h2>
&#34;&#34;&#34;Used to output the HTML representation to a Jupyter notebook.
When config.notebook.iframe.attribute is &#34;src&#34;, this function creates a temporary HTML file
in `./tmp/profile_[hash].html` and returns an Iframe pointing to that contents.
When config.notebook.iframe.attribute is &#34;srco&#34;, the same HTML is injected in the &#34;srcdoc&#34; attribute of
When config.notebook.iframe.attribute is &#34;srcdoc&#34;, the same HTML is injected in the &#34;srcdoc&#34; attribute of
the Iframe.

Notes:
This constructions solves problems with conflicting stylesheets and navigation links.
&#34;&#34;&#34;
attribute = config[&#34;notebook&#34;][&#34;iframe&#34;][&#34;attribute&#34;].get(str)
if attribute == &#34;src&#34;:
tmp_file = Path(&#34;./ipynb_tmp&#34;) / self.get_unique_file_name()
tmp_file.parent.mkdir(exist_ok=True)
self.to_file(tmp_file)
from IPython.lib.display import IFrame, display

display(
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),
)
)
elif attribute:
from IPython.core.display import HTML, display

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(self.to_html()),
)
display(HTML(iframe))
else:
raise ValueError(
&#39;Iframe Attribute can be &#34;src&#34; or &#34;srcdoc&#34; (current: {}).&#39;.format(
attribute
)
)
display_notebook_iframe(self)

def __repr__(self):
&#34;&#34;&#34;Override so that Jupyter Notebook does not print the object.&#34;&#34;&#34;
Expand Down Expand Up @@ -556,50 +519,13 @@ <h2 class="section-title" id="header-classes">Classes</h2>
&#34;&#34;&#34;Used to output the HTML representation to a Jupyter notebook.
When config.notebook.iframe.attribute is &#34;src&#34;, this function creates a temporary HTML file
in `./tmp/profile_[hash].html` and returns an Iframe pointing to that contents.
When config.notebook.iframe.attribute is &#34;srco&#34;, the same HTML is injected in the &#34;srcdoc&#34; attribute of
When config.notebook.iframe.attribute is &#34;srcdoc&#34;, the same HTML is injected in the &#34;srcdoc&#34; attribute of
the Iframe.

Notes:
This constructions solves problems with conflicting stylesheets and navigation links.
&#34;&#34;&#34;
attribute = config[&#34;notebook&#34;][&#34;iframe&#34;][&#34;attribute&#34;].get(str)
if attribute == &#34;src&#34;:
tmp_file = Path(&#34;./ipynb_tmp&#34;) / self.get_unique_file_name()
tmp_file.parent.mkdir(exist_ok=True)
self.to_file(tmp_file)
from IPython.lib.display import IFrame, display

display(
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),
)
)
elif attribute:
from IPython.core.display import HTML, display

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(self.to_html()),
)
display(HTML(iframe))
else:
raise ValueError(
&#39;Iframe Attribute can be &#34;src&#34; or &#34;srcdoc&#34; (current: {}).&#39;.format(
attribute
)
)
display_notebook_iframe(self)

def __repr__(self):
&#34;&#34;&#34;Override so that Jupyter Notebook does not print the object.&#34;&#34;&#34;
Expand Down
34 changes: 24 additions & 10 deletions docs/model/describe.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,10 +414,14 @@ <h1 class="title">Module <code>pandas_profiling.model.describe</code></h1>
A dictionary containing the base64 encoded plots for each diagram that is active in the config (matrix, bar, heatmap, dendrogram).
&#34;&#34;&#34;
missing_map = {
&#34;matrix&#34;: {&#34;func&#34;: plot.missing_matrix, &#34;min_missing&#34;: 0},
&#34;bar&#34;: {&#34;func&#34;: plot.missing_bar, &#34;min_missing&#34;: 0},
&#34;heatmap&#34;: {&#34;func&#34;: plot.missing_heatmap, &#34;min_missing&#34;: 2},
&#34;dendrogram&#34;: {&#34;func&#34;: plot.missing_dendrogram, &#34;min_missing&#34;: 1},
&#34;bar&#34;: {&#34;func&#34;: plot.missing_bar, &#34;min_missing&#34;: 0, &#34;name&#34;: &#34;Count&#34;},
&#34;matrix&#34;: {&#34;func&#34;: plot.missing_matrix, &#34;min_missing&#34;: 0, &#34;name&#34;: &#34;Matrix&#34;},
&#34;heatmap&#34;: {&#34;func&#34;: plot.missing_heatmap, &#34;min_missing&#34;: 2, &#34;name&#34;: &#34;Heatmap&#34;},
&#34;dendrogram&#34;: {
&#34;func&#34;: plot.missing_dendrogram,
&#34;min_missing&#34;: 1,
&#34;name&#34;: &#34;Dendrogram&#34;,
},
}

missing = {}
Expand All @@ -430,7 +434,10 @@ <h1 class="title">Module <code>pandas_profiling.model.describe</code></h1>
table_stats[&#34;n_vars_with_missing&#34;] - table_stats[&#34;n_vars_all_missing&#34;]
&gt;= settings[&#34;min_missing&#34;]
):
missing[name] = settings[&#34;func&#34;](df)
missing[name] = {
&#34;name&#34;: settings[&#34;name&#34;],
&#34;matrix&#34;: settings[&#34;func&#34;](df),
}
return missing


Expand Down Expand Up @@ -1241,10 +1248,14 @@ <h2 id="returns">Returns</h2>
A dictionary containing the base64 encoded plots for each diagram that is active in the config (matrix, bar, heatmap, dendrogram).
&#34;&#34;&#34;
missing_map = {
&#34;matrix&#34;: {&#34;func&#34;: plot.missing_matrix, &#34;min_missing&#34;: 0},
&#34;bar&#34;: {&#34;func&#34;: plot.missing_bar, &#34;min_missing&#34;: 0},
&#34;heatmap&#34;: {&#34;func&#34;: plot.missing_heatmap, &#34;min_missing&#34;: 2},
&#34;dendrogram&#34;: {&#34;func&#34;: plot.missing_dendrogram, &#34;min_missing&#34;: 1},
&#34;bar&#34;: {&#34;func&#34;: plot.missing_bar, &#34;min_missing&#34;: 0, &#34;name&#34;: &#34;Count&#34;},
&#34;matrix&#34;: {&#34;func&#34;: plot.missing_matrix, &#34;min_missing&#34;: 0, &#34;name&#34;: &#34;Matrix&#34;},
&#34;heatmap&#34;: {&#34;func&#34;: plot.missing_heatmap, &#34;min_missing&#34;: 2, &#34;name&#34;: &#34;Heatmap&#34;},
&#34;dendrogram&#34;: {
&#34;func&#34;: plot.missing_dendrogram,
&#34;min_missing&#34;: 1,
&#34;name&#34;: &#34;Dendrogram&#34;,
},
}

missing = {}
Expand All @@ -1257,7 +1268,10 @@ <h2 id="returns">Returns</h2>
table_stats[&#34;n_vars_with_missing&#34;] - table_stats[&#34;n_vars_all_missing&#34;]
&gt;= settings[&#34;min_missing&#34;]
):
missing[name] = settings[&#34;func&#34;](df)
missing[name] = {
&#34;name&#34;: settings[&#34;name&#34;],
&#34;matrix&#34;: settings[&#34;func&#34;](df),
}
return missing</code></pre>
</details>
</dd>
Expand Down
5 changes: 5 additions & 0 deletions docs/utils/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dd>
<section class="desc"><p>Utils for pandas DataFrames.</p></section>
</dd>
<dt><code class="name"><a title="pandas_profiling.utils.notebook" href="notebook.html">pandas_profiling.utils.notebook</a></code></dt>
<dd>
<section class="desc"><p>Utility functions that come in handy when working with Jupyter notebooks</p></section>
</dd>
<dt><code class="name"><a title="pandas_profiling.utils.paths" href="paths.html">pandas_profiling.utils.paths</a></code></dt>
<dd>
<section class="desc"><p>Paths that are useful throughout the project.</p></section>
Expand Down Expand Up @@ -65,6 +69,7 @@ <h1>Index</h1>
<ul>
<li><code><a title="pandas_profiling.utils.common" href="common.html">pandas_profiling.utils.common</a></code></li>
<li><code><a title="pandas_profiling.utils.dataframe" href="dataframe.html">pandas_profiling.utils.dataframe</a></code></li>
<li><code><a title="pandas_profiling.utils.notebook" href="notebook.html">pandas_profiling.utils.notebook</a></code></li>
<li><code><a title="pandas_profiling.utils.paths" href="paths.html">pandas_profiling.utils.paths</a></code></li>
</ul>
</li>
Expand Down
87 changes: 87 additions & 0 deletions docs/utils/notebook.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
5 changes: 5 additions & 0 deletions docs/view/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dd>
<section class="desc"><p>Formatters are utilities for formatting numbers and certain strings</p></section>
</dd>
<dt><code class="name"><a title="pandas_profiling.view.notebook" href="notebook.html">pandas_profiling.view.notebook</a></code></dt>
<dd>
<section class="desc"><p>Functionality related to displaying the profile report in Jupyter notebooks.</p></section>
</dd>
<dt><code class="name"><a title="pandas_profiling.view.plot" href="plot.html">pandas_profiling.view.plot</a></code></dt>
<dd>
<section class="desc"><p>Plot functions for the profiling report.</p></section>
Expand Down Expand Up @@ -68,6 +72,7 @@ <h1>Index</h1>
<li><h3><a href="#header-submodules">Sub-modules</a></h3>
<ul>
<li><code><a title="pandas_profiling.view.formatters" href="formatters.html">pandas_profiling.view.formatters</a></code></li>
<li><code><a title="pandas_profiling.view.notebook" href="notebook.html">pandas_profiling.view.notebook</a></code></li>
<li><code><a title="pandas_profiling.view.plot" href="plot.html">pandas_profiling.view.plot</a></code></li>
<li><code><a title="pandas_profiling.view.report" href="report.html">pandas_profiling.view.report</a></code></li>
<li><code><a title="pandas_profiling.view.templates" href="templates.html">pandas_profiling.view.templates</a></code></li>
Expand Down
Loading