TiMemory Release 1.1.1

- Added 'report_at_exit' field to auto_timer
- Updated docs
- Updated README
- Incremented version to 1.1.1

CHANGES.rst

@@ -1,6 +1,19 @@
 TiMemory
 ========
 
+Release: TiMemory 1.1.0
+~~~~~~~~~~~~~~~~~~~~~~~
+
+- Author: Jonathan R. Madsen
+- Date:   Mon Jan 29 15:00:12 2018 -0800
+
+    - Added 'report_at_exit' parameter to auto_timer decorator
+    - Added added_args flag for auto_timer decorator
+    - Fixed I/O output bug
+    - Added setup.cfg
+    - Fixed auto_timer decorator issue with self.key, self.is_class, and self.add_args
+
+
 Release: TiMemory 1.1b0
 ~~~~~~~~~~~~~~~~~~~~~~~
 

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required(VERSION 3.1.3 FATAL_ERROR)
 
-project(TiMemory LANGUAGES C CXX VERSION 1.1.0)
+project(TiMemory LANGUAGES C CXX VERSION 1.1.1)
 
 set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/cmake/Modules
     ${CMAKE_MODULE_PATH})

README.md

@@ -56,22 +56,23 @@ python setup.py config --disable-mpi build install
   - key : this is a custom key to append after function name. The default will add file and line number.
   - add_args : add the arguments to the auto-timer key. Will be over-ridden by key argument
   - is_class : will add `'[{}]'.format(type(self).__name__)`` to the function name
+  - report_at_exit (auto_timer only) : at the end of the timing, report to stdout
 
 ```python
-@timemory.util.auto_timer(key="", add_args=False, is_class=False)
+@timemory.util.auto_timer(key="", add_args=False, is_class=False, report_at_exit=False)
 def function(...):
     time.sleep(1)
 ```
 
 #### Auto-timer example
 
 ```python
-@timemory.util.auto_timer(key="", add_args=False, is_class=False)
+@timemory.util.auto_timer(key="", add_args=False, is_class=False, report_at_exit=False)
 def function(...):
     time.sleep(1)
 ```
 
-  - output (from `timemory.report()`):
+  - sample of an output (from `timemory.report()`):
 
 ```
 > [pyc] test_func_glob@'timemory_test.py':218   :  5.003 wall,  0.000 user +  0.000 system =  0.000 CPU [sec] (  0.0%) : RSS {tot,self}_{curr,peak} : (52.6|52.6) | ( 0.0| 0.0) [MB]
@@ -88,7 +89,7 @@ def function(...):
     time.sleep(1)
 ```
 
-  - output:
+  - sample of an output:
 
 ```
 # free function
@@ -105,7 +106,7 @@ def function(...):
     time.sleep(1)
 ```
 
-  - output:
+  - sample of an output:
 
 ```
 test_func_rss@'timemory_test.py':244 : RSS {total,self}_{current,peak} : (52.536|193.164) | (0.0|140.568) [MB]

README.rst

@@ -70,10 +70,12 @@ Basic Python usage
       over-ridden by key argument
    -  is\_class : will add \`'[{}]'.format(type(self).\ **name**)\`\` to
       the function name
+   -  report\_at\_exit (auto\_timer only) : at the end of the timing,
+      report to stdout
 
 .. code:: python
 
-  @timemory.util.auto_timer(key="", add_args=False, is_class=False)
+  @timemory.util.auto_timer(key="", add_args=False, is_class=False, report_at_exit=False)
   def function(...):
       time.sleep(1)
 
@@ -82,13 +84,13 @@ Auto-timer example
 
 .. code:: python
 
-  @timemory.util.auto_timer(key="", add_args=False, is_class=False)
+  @timemory.util.auto_timer(key="", add_args=False, is_class=False, report_at_exit=False)
   def function(...):
       time.sleep(1)
 
 ::
 
-  - output (from `timemory.report()`):
+  - sample of an output (from `timemory.report()`):
 
 ::
 
@@ -108,7 +110,7 @@ Timer example (will report to stdout at the end of the function)
 
 ::
 
-  - output:
+  - sample of an output:
 
 ::
 
@@ -128,7 +130,7 @@ RSS usage example:
 
 ::
 
-  - output:
+  - sample of an output:
 
 ::
 

docs/annotated.html

@@ -29,7 +29,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">TiMemory
-   &#160;<span id="projectnumber">1.1.0</span>
+   &#160;<span id="projectnumber">1.1.1</span>
    </div>
    <div id="projectbrief">C++ and Python Timing and Memory Tracking</div>
   </td>
@@ -140,7 +140,7 @@
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Mon Jan 29 2018 13:33:36 for TiMemory by
+    <li class="footer">Generated on Mon Jan 29 2018 15:00:39 for TiMemory by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
   </ul>

docs/classes.html

@@ -29,7 +29,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">TiMemory
-   &#160;<span id="projectnumber">1.1.0</span>
+   &#160;<span id="projectnumber">1.1.1</span>
    </div>
    <div id="projectbrief">C++ and Python Timing and Memory Tracking</div>
   </td>
@@ -108,7 +108,7 @@
 <!-- start footer part -->
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
-    <li class="footer">Generated on Mon Jan 29 2018 13:33:36 for TiMemory by
+    <li class="footer">Generated on Mon Jan 29 2018 15:00:39 for TiMemory by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
   </ul>

docs/d0/d54/class_n_a_m_e___t_i_m_1_1base__clock.html

@@ -29,7 +29,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">TiMemory
-   &#160;<span id="projectnumber">1.1.0</span>
+   &#160;<span id="projectnumber">1.1.1</span>
    </div>
    <div id="projectbrief">C++ and Python Timing and Memory Tracking</div>
   </td>
@@ -97,8 +97,7 @@
 <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
 </div>
 <div id="dynsection-0-content" class="dyncontent" style="display:none;">
-<div class="center"><iframe scrolling="no" frameborder="0" src="../../d5/dd6/class_n_a_m_e___t_i_m_1_1base__clock__coll__graph.svg" width="162" height="264"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
-</div>
+<div class="center"><iframe scrolling="no" frameborder="0" src="../../d5/dd6/class_n_a_m_e___t_i_m_1_1base__clock__coll__graph.svg" width="162" height="264"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
 </div>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
@@ -256,7 +255,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a57d23717dceec5c89ed930b9
 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
   <ul>
     <li class="navelem"><a class="el" href="../../de/de2/namespace_n_a_m_e___t_i_m.html">NAME_TIM</a></li><li class="navelem"><a class="el" href="../../d0/d54/class_n_a_m_e___t_i_m_1_1base__clock.html">base_clock</a></li>
-    <li class="footer">Generated on Mon Jan 29 2018 13:33:36 for TiMemory by
+    <li class="footer">Generated on Mon Jan 29 2018 15:00:38 for TiMemory by
     <a href="http://www.doxygen.org/index.html">
     <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
   </ul>