You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
294 lines
14 KiB
294 lines
14 KiB
<!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.7.0" />
|
|
<title>miplearn.log API documentation</title>
|
|
<meta name="description" content="" />
|
|
<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,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.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;margin-bottom:1em}.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>miplearn.log</code></h1>
|
|
</header>
|
|
<section id="section-intro">
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python"># MIPLearn: Extensible Framework for Learning-Enhanced Mixed-Integer Optimization
|
|
# Copyright (C) 2020, UChicago Argonne, LLC. All rights reserved.
|
|
# Released under the modified BSD license. See COPYING.md for more details.
|
|
|
|
import logging
|
|
import sys
|
|
import time
|
|
|
|
|
|
class TimeFormatter(logging.Formatter):
|
|
def __init__(self, start_time, log_colors):
|
|
super().__init__()
|
|
self.start_time = start_time
|
|
self.log_colors = log_colors
|
|
|
|
def format(self, record):
|
|
if record.levelno >= logging.ERROR:
|
|
color = self.log_colors["red"]
|
|
elif record.levelno >= logging.WARNING:
|
|
color = self.log_colors["yellow"]
|
|
else:
|
|
color = self.log_colors["green"]
|
|
return "%s[%12.3f]%s %s" % (
|
|
color,
|
|
record.created - self.start_time,
|
|
self.log_colors["reset"],
|
|
record.getMessage(),
|
|
)
|
|
|
|
|
|
def setup_logger(start_time=None, force_color=False):
|
|
if start_time is None:
|
|
start_time = time.time()
|
|
if sys.stdout.isatty() or force_color:
|
|
log_colors = {
|
|
"green": "\033[92m",
|
|
"yellow": "\033[93m",
|
|
"red": "\033[91m",
|
|
"reset": "\033[0m",
|
|
}
|
|
else:
|
|
log_colors = {
|
|
"green": "",
|
|
"yellow": "",
|
|
"red": "",
|
|
"reset": "",
|
|
}
|
|
handler = logging.StreamHandler()
|
|
handler.setFormatter(TimeFormatter(start_time, log_colors))
|
|
logging.getLogger().addHandler(handler)
|
|
logging.getLogger("miplearn").setLevel(logging.INFO)</code></pre>
|
|
</details>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
</section>
|
|
<section>
|
|
<h2 class="section-title" id="header-functions">Functions</h2>
|
|
<dl>
|
|
<dt id="miplearn.log.setup_logger"><code class="name flex">
|
|
<span>def <span class="ident">setup_logger</span></span>(<span>start_time=None, force_color=False)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"></section>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def setup_logger(start_time=None, force_color=False):
|
|
if start_time is None:
|
|
start_time = time.time()
|
|
if sys.stdout.isatty() or force_color:
|
|
log_colors = {
|
|
"green": "\033[92m",
|
|
"yellow": "\033[93m",
|
|
"red": "\033[91m",
|
|
"reset": "\033[0m",
|
|
}
|
|
else:
|
|
log_colors = {
|
|
"green": "",
|
|
"yellow": "",
|
|
"red": "",
|
|
"reset": "",
|
|
}
|
|
handler = logging.StreamHandler()
|
|
handler.setFormatter(TimeFormatter(start_time, log_colors))
|
|
logging.getLogger().addHandler(handler)
|
|
logging.getLogger("miplearn").setLevel(logging.INFO)</code></pre>
|
|
</details>
|
|
</dd>
|
|
</dl>
|
|
</section>
|
|
<section>
|
|
<h2 class="section-title" id="header-classes">Classes</h2>
|
|
<dl>
|
|
<dt id="miplearn.log.TimeFormatter"><code class="flex name class">
|
|
<span>class <span class="ident">TimeFormatter</span></span>
|
|
<span>(</span><span>start_time, log_colors)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Formatter instances are used to convert a LogRecord to text.</p>
|
|
<p>Formatters need to know how a LogRecord is constructed. They are
|
|
responsible for converting a LogRecord to (usually) a string which can
|
|
be interpreted by either a human or an external system. The base Formatter
|
|
allows a formatting string to be specified. If none is supplied, the
|
|
the style-dependent default value, "%(message)s", "{message}", or
|
|
"${message}", is used.</p>
|
|
<p>The Formatter can be initialized with a format string which makes use of
|
|
knowledge of the LogRecord attributes - e.g. the default value mentioned
|
|
above makes use of the fact that the user's message and arguments are pre-
|
|
formatted into a LogRecord's message attribute. Currently, the useful
|
|
attributes in a LogRecord are described by:</p>
|
|
<p>%(name)s
|
|
Name of the logger (logging channel)
|
|
%(levelno)s
|
|
Numeric logging level for the message (DEBUG, INFO,
|
|
WARNING, ERROR, CRITICAL)
|
|
%(levelname)s
|
|
Text logging level for the message ("DEBUG", "INFO",
|
|
"WARNING", "ERROR", "CRITICAL")
|
|
%(pathname)s
|
|
Full pathname of the source file where the logging
|
|
call was issued (if available)
|
|
%(filename)s
|
|
Filename portion of pathname
|
|
%(module)s
|
|
Module (name portion of filename)
|
|
%(lineno)d
|
|
Source line number where the logging call was issued
|
|
(if available)
|
|
%(funcName)s
|
|
Function name
|
|
%(created)f
|
|
Time when the LogRecord was created (time.time()
|
|
return value)
|
|
%(asctime)s
|
|
Textual time when the LogRecord was created
|
|
%(msecs)d
|
|
Millisecond portion of the creation time
|
|
%(relativeCreated)d Time in milliseconds when the LogRecord was created,
|
|
relative to the time the logging module was loaded
|
|
(typically at application startup time)
|
|
%(thread)d
|
|
Thread ID (if available)
|
|
%(threadName)s
|
|
Thread name (if available)
|
|
%(process)d
|
|
Process ID (if available)
|
|
%(message)s
|
|
The result of record.getMessage(), computed just as
|
|
the record is emitted</p>
|
|
<p>Initialize the formatter with specified format strings.</p>
|
|
<p>Initialize the formatter either with the specified format string, or a
|
|
default as described above. Allow for specialized date formatting with
|
|
the optional datefmt argument. If datefmt is omitted, you get an
|
|
ISO8601-like (or RFC 3339-like) format.</p>
|
|
<p>Use a style parameter of '%', '{' or '$' to specify that you want to
|
|
use one of %-formatting, :meth:<code>str.format</code> (<code>{}</code>) formatting or
|
|
:class:<code>string.Template</code> formatting in your format string.</p>
|
|
<div class="admonition versionchanged">
|
|
<p class="admonition-title">Changed in version: 3.2</p>
|
|
<p>Added the <code>style</code> parameter.</p>
|
|
</div></section>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">class TimeFormatter(logging.Formatter):
|
|
def __init__(self, start_time, log_colors):
|
|
super().__init__()
|
|
self.start_time = start_time
|
|
self.log_colors = log_colors
|
|
|
|
def format(self, record):
|
|
if record.levelno >= logging.ERROR:
|
|
color = self.log_colors["red"]
|
|
elif record.levelno >= logging.WARNING:
|
|
color = self.log_colors["yellow"]
|
|
else:
|
|
color = self.log_colors["green"]
|
|
return "%s[%12.3f]%s %s" % (
|
|
color,
|
|
record.created - self.start_time,
|
|
self.log_colors["reset"],
|
|
record.getMessage(),
|
|
)</code></pre>
|
|
</details>
|
|
<h3>Ancestors</h3>
|
|
<ul class="hlist">
|
|
<li>logging.Formatter</li>
|
|
</ul>
|
|
<h3>Methods</h3>
|
|
<dl>
|
|
<dt id="miplearn.log.TimeFormatter.format"><code class="name flex">
|
|
<span>def <span class="ident">format</span></span>(<span>self, record)</span>
|
|
</code></dt>
|
|
<dd>
|
|
<section class="desc"><p>Format the specified record as text.</p>
|
|
<p>The record's attribute dictionary is used as the operand to a
|
|
string formatting operation which yields the returned string.
|
|
Before formatting the dictionary, a couple of preparatory steps
|
|
are carried out. The message attribute of the record is computed
|
|
using LogRecord.getMessage(). If the formatting string uses the
|
|
time (as determined by a call to usesTime(), formatTime() is
|
|
called to format the event time. If there is exception information,
|
|
it is formatted using formatException() and appended to the message.</p></section>
|
|
<details class="source">
|
|
<summary>
|
|
<span>Expand source code</span>
|
|
</summary>
|
|
<pre><code class="python">def format(self, record):
|
|
if record.levelno >= logging.ERROR:
|
|
color = self.log_colors["red"]
|
|
elif record.levelno >= logging.WARNING:
|
|
color = self.log_colors["yellow"]
|
|
else:
|
|
color = self.log_colors["green"]
|
|
return "%s[%12.3f]%s %s" % (
|
|
color,
|
|
record.created - self.start_time,
|
|
self.log_colors["reset"],
|
|
record.getMessage(),
|
|
)</code></pre>
|
|
</details>
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
</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="miplearn" href="index.html">miplearn</a></code></li>
|
|
</ul>
|
|
</li>
|
|
<li><h3><a href="#header-functions">Functions</a></h3>
|
|
<ul class="">
|
|
<li><code><a title="miplearn.log.setup_logger" href="#miplearn.log.setup_logger">setup_logger</a></code></li>
|
|
</ul>
|
|
</li>
|
|
<li><h3><a href="#header-classes">Classes</a></h3>
|
|
<ul>
|
|
<li>
|
|
<h4><code><a title="miplearn.log.TimeFormatter" href="#miplearn.log.TimeFormatter">TimeFormatter</a></code></h4>
|
|
<ul class="">
|
|
<li><code><a title="miplearn.log.TimeFormatter.format" href="#miplearn.log.TimeFormatter.format">format</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</main>
|
|
<footer id="footer">
|
|
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.7.0</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> |