theonepath
1964ac3290
Added all files related to doxygen doc file generation for the consideration of using doxygen as the base tool for doc generation of project.
296 lines
14 KiB
HTML
296 lines
14 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.4"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>CLog: clog.utils.printfmt Namespace Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">CLog<span id="projectnumber"> 0.1.0</span>
|
|
</div>
|
|
<div id="projectbrief">logging as simple as putting on a shoe</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.4 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="namespaceclog.html">clog</a></li><li class="navelem"><a class="el" href="namespaceclog_1_1utils.html">utils</a></li><li class="navelem"><a class="el" href="namespaceclog_1_1utils_1_1printfmt.html">printfmt</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Classes</a> |
|
|
<a href="#func-members">Functions</a> |
|
|
<a href="#var-members">Variables</a> </div>
|
|
<div class="headertitle"><div class="title">clog.utils.printfmt Namespace Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
|
|
Classes</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classclog_1_1utils_1_1printfmt_1_1_colours.html">Colours</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a6699089e06d4d87587103dda64c527e9"><td class="memItemLeft" align="right" valign="top">str </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceclog_1_1utils_1_1printfmt.html#a6699089e06d4d87587103dda64c527e9">loglevel_as_str</a> (Union[<a class="el" href="classclog_1_1utils_1_1common_1_1_log_level.html">LogLevel</a>, int] level)</td></tr>
|
|
<tr class="separator:a6699089e06d4d87587103dda64c527e9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac98d91dc79e0cd16dddc26e0b3b5c5a4"><td class="memItemLeft" align="right" valign="top">str </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceclog_1_1utils_1_1printfmt.html#ac98d91dc79e0cd16dddc26e0b3b5c5a4">log_as_col</a> (Union[int, <a class="el" href="classclog_1_1utils_1_1common_1_1_log_level.html">LogLevel</a>] level)</td></tr>
|
|
<tr class="separator:ac98d91dc79e0cd16dddc26e0b3b5c5a4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac4954fb457fd37e436175b427b32b764"><td class="memItemLeft" align="right" valign="top">str </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceclog_1_1utils_1_1printfmt.html#ac4954fb457fd37e436175b427b32b764">gen_log_header</a> (Union[<a class="el" href="classclog_1_1utils_1_1common_1_1_log_level.html">LogLevel</a>, int, str] _type)</td></tr>
|
|
<tr class="separator:ac4954fb457fd37e436175b427b32b764"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7bc3c7278d0a16b7c882273df2bc35a8"><td class="memItemLeft" align="right" valign="top">str </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceclog_1_1utils_1_1printfmt.html#a7bc3c7278d0a16b7c882273df2bc35a8">wrap</a> (str value, *int width=120, int tb_size=4)</td></tr>
|
|
<tr class="separator:a7bc3c7278d0a16b7c882273df2bc35a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
|
|
Variables</h2></td></tr>
|
|
<tr class="memitem:a26d5d5c5d47accdba417db4ad90a1438"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceclog_1_1utils_1_1printfmt.html#a26d5d5c5d47accdba417db4ad90a1438">__LOG_TMPL</a> = "[{DATE}] [{0}] {TYPE} "</td></tr>
|
|
<tr class="memdesc:a26d5d5c5d47accdba417db4ad90a1438"><td class="mdescLeft"> </td><td class="mdescRight">log message constant format template <a href="namespaceclog_1_1utils_1_1printfmt.html#a26d5d5c5d47accdba417db4ad90a1438">More...</a><br /></td></tr>
|
|
<tr class="separator:a26d5d5c5d47accdba417db4ad90a1438"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab74ef239fd20c63e311f318f8010776b"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceclog_1_1utils_1_1printfmt.html#ab74ef239fd20c63e311f318f8010776b">__TIMESTAMP_FMT</a> = "%Y-%m-%dT%H:%M:%S%z"</td></tr>
|
|
<tr class="memdesc:ab74ef239fd20c63e311f318f8010776b"><td class="mdescLeft"> </td><td class="mdescRight">string time format (ISO: 8601, long-form) <a href="namespaceclog_1_1utils_1_1printfmt.html#ab74ef239fd20c63e311f318f8010776b">More...</a><br /></td></tr>
|
|
<tr class="separator:ab74ef239fd20c63e311f318f8010776b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="ac4954fb457fd37e436175b427b32b764" name="ac4954fb457fd37e436175b427b32b764"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac4954fb457fd37e436175b427b32b764">◆ </a></span>gen_log_header()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"> str clog.utils.printfmt.gen_log_header </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Union[<a class="el" href="classclog_1_1utils_1_1common_1_1_log_level.html">LogLevel</a>, int, str] </td>
|
|
<td class="paramname"><em>_type</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<pre class="fragment">Generate a header string for use of standardising log outputs.
|
|
|
|
The header is defined using the following standard header:
|
|
```plaintext
|
|
"[YYYY-MM-DDTHH:MM:SS+OFFSET] [{CALLER}] <LogLevel> {0}"
|
|
```
|
|
|
|
The first column defines the Date-Time following the ISO 8601 (long)
|
|
standard timestamp format, whereby `T` is the separator between Date
|
|
and Time. The `+OFFSET` is the number of hours ahead/behind UTC, the
|
|
currently timezone set by the PC. This is achieved using the following
|
|
string to time format:
|
|
`%Y-%m-%dT%H:%M:%S%z`.
|
|
|
|
The second column is reversed during the return value of the string.
|
|
This column is used to allow for a stacktrace to be attached to the
|
|
log message.
|
|
|
|
The third column defines the level of the log message. This will be
|
|
five blank space characters if a level is passed outside of the
|
|
defined scope of logging levels.
|
|
|
|
The fourth column is reserved during the return value of the string.
|
|
It represents the body of the message to be logged.
|
|
|
|
|
|
`@Params`: _type - `LogLevel | int | str`
|
|
`@Return`: Formattable string - `str`
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
<a id="ac98d91dc79e0cd16dddc26e0b3b5c5a4" name="ac98d91dc79e0cd16dddc26e0b3b5c5a4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac98d91dc79e0cd16dddc26e0b3b5c5a4">◆ </a></span>log_as_col()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"> str clog.utils.printfmt.log_as_col </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Union[int, <a class="el" href="classclog_1_1utils_1_1common_1_1_log_level.html">LogLevel</a>] </td>
|
|
<td class="paramname"><em>level</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<pre class="fragment">Convert an integer or enum value into an associated ANSI escape
|
|
code terminal colour sequence. Depending on log level severity, an
|
|
associated colour is returned to give STDOUT text a distinct
|
|
separation of colour from regular STDOUT text.
|
|
|
|
`@Params`: level - `LogLevel | int`
|
|
`@Return`: Enum of `Colours`
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
<a id="a6699089e06d4d87587103dda64c527e9" name="a6699089e06d4d87587103dda64c527e9"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6699089e06d4d87587103dda64c527e9">◆ </a></span>loglevel_as_str()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"> str clog.utils.printfmt.loglevel_as_str </td>
|
|
<td>(</td>
|
|
<td class="paramtype">Union[<a class="el" href="classclog_1_1utils_1_1common_1_1_log_level.html">LogLevel</a>, int] </td>
|
|
<td class="paramname"><em>level</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<pre class="fragment">Convert an integer or enum value into its appropriate enum
|
|
attribute name.
|
|
|
|
`@Params`: level - `LogLevel | int`
|
|
`Returns`: LogLevel enum literal attribute name - `str`
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
<a id="a7bc3c7278d0a16b7c882273df2bc35a8" name="a7bc3c7278d0a16b7c882273df2bc35a8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a7bc3c7278d0a16b7c882273df2bc35a8">◆ </a></span>wrap()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"> str clog.utils.printfmt.wrap </td>
|
|
<td>(</td>
|
|
<td class="paramtype">str </td>
|
|
<td class="paramname"><em>value</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">*int  </td>
|
|
<td class="paramname"><em>width</em> = <code>120</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int  </td>
|
|
<td class="paramname"><em>tb_size</em> = <code>4</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<pre class="fragment">Return a hard-wrapped string defined by a fixed width.
|
|
|
|
Wrapped text is separated by a `\\n` character and a fixed width of
|
|
120 characters. Each wrap is appended with a tab size of 4 characters
|
|
at the start of each line-wrap.
|
|
|
|
`@Params`: value - `str`, width = 120 - `int`, tb_size = 4 - `int`
|
|
`@Return`: `str`
|
|
</pre>
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Variable Documentation</h2>
|
|
<a id="a26d5d5c5d47accdba417db4ad90a1438" name="a26d5d5c5d47accdba417db4ad90a1438"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a26d5d5c5d47accdba417db4ad90a1438">◆ </a></span>__LOG_TMPL</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string clog.utils.printfmt.__LOG_TMPL = "[{DATE}] [{0}] {TYPE} "</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>log message constant format template </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab74ef239fd20c63e311f318f8010776b" name="ab74ef239fd20c63e311f318f8010776b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab74ef239fd20c63e311f318f8010776b">◆ </a></span>__TIMESTAMP_FMT</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">string clog.utils.printfmt.__TIMESTAMP_FMT = "%Y-%m-%dT%H:%M:%S%z"</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>string time format (ISO: 8601, long-form) </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
|
|
</small></address>
|
|
</body>
|
|
</html>
|