Home Explore Help
Sign In
cnheider
/
draugr
mirror of https://github.com/cnheider/draugr
Watch 1
Star 1
Fork 0
Files Issues 0 Wiki
Tree: 94a402cab4
Branches Tags
draugr
/
docs
/
github
/
html
/
_modules
/
draugr.html

draugr.html 16 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229 
  1. 

  2. <!DOCTYPE html>
    3. 

  3. 

  4. <html lang="en">
    5. 

  5.   <head>
    6. 

  6.     <meta charset="utf-8" />
    7. 

  7.     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    8. 

  8.     <title>draugr &#8212; Draugr 1.0.1 documentation</title>
    9. 

  9.     <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
    10. 

  10.     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
    11. 

  11.     <link rel="stylesheet" type="text/css" href="../_static/graphviz.css" />
    12. 

  12.     <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
    13. 

  13.     <script src="../_static/jquery.js"></script>
    14. 

  14.     <script src="../_static/underscore.js"></script>
    15. 

  15.     <script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
    16. 

  16.     <script src="../_static/doctools.js"></script>
    17. 

  17.     <link rel="canonical" href="pything.github.io/draugr/_modules/draugr.html" />
    18. 

  18.     <link rel="index" title="Index" href="../genindex.html" />
    19. 

  19.     <link rel="search" title="Search" href="../search.html" />
    20. 

  20.    
    21. 

  21.   <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
    22. 

  22.   
    23. 

  23.   
    24. 

  24.   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
    25. 

  25. 

  26.   </head><body>
    27. 

  27.   
    28. 

  28. 

  29.     <div class="document">
    30. 

  30.       <div class="documentwrapper">
    31. 

  31.         <div class="bodywrapper">
    32. 

  32.           
    33. 

  33. 

  34.           <div class="body" role="main">
    35. 

  35.             
    36. 

  36.   <h1>Source code for draugr</h1><div class="highlight"><pre>
    37. 

  37. <span></span><span class="ch">#!/usr/bin/env python3</span>
    38. 

  38. <span class="c1"># -*- coding: utf-8 -*-</span>
    39. 

  39. 

  40. 

  41. <span class="n">__project__</span> <span class="o">=</span> <span class="s2">&quot;Draugr&quot;</span>
    42. 

  42. <span class="n">__author__</span> <span class="o">=</span> <span class="s2">&quot;Christian Heider Nielsen&quot;</span>
    43. 

  43. <span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;1.0.1&quot;</span>
    44. 

  44. <span class="vm">__doc__</span> <span class="o">=</span> <span class="sa">r</span><span class="s2">&quot;&quot;&quot;</span>
    45. 

  45. <span class="s2">Created on 27/04/2019</span>
    46. 

  46. 

  47. <span class="s2">@author: cnheider</span>
    48. 

  48. 

  49. <span class="s2">&quot;&quot;&quot;</span>
    50. 

  50. 

  51. <span class="kn">import</span> <span class="nn">datetime</span>
    52. 

  52. <span class="kn">import</span> <span class="nn">os</span>
    53. 

  53. <span class="kn">from</span> <span class="nn">logging</span> <span class="kn">import</span> <span class="n">warning</span>
    54. 

  54. <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span>
    55. 

  55. 

  56. <span class="kn">import</span> <span class="nn">pkg_resources</span>
    57. 

  57. 

  58. <span class="kn">from</span> <span class="nn">apppath</span> <span class="kn">import</span> <span class="n">AppPath</span>
    59. 

  59. <span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span>
    60. 

  60. 

  61. <span class="c1"># from .drawers import *</span>
    62. 

  62. <span class="c1"># from .writers import *</span>
    63. 

  63. <span class="c1"># from .opencv_utilities import *</span>
    64. 

  64. <span class="c1"># from .torch_utilities import *</span>
    65. 

  65. <span class="c1"># from .stopping import *</span>
    66. 

  66. <span class="c1"># from .numpy_utilities import *</span>
    67. 

  67. <span class="c1"># from .visualisation import *</span>
    68. 

  68. <span class="kn">from</span> <span class="nn">.metrics</span> <span class="kn">import</span> <span class="o">*</span>
    69. 

  69. <span class="kn">from</span> <span class="nn">.python_utilities</span> <span class="kn">import</span> <span class="o">*</span>
    70. 

  70. 

  71. <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">Path</span><span class="p">(</span><span class="vm">__file__</span><span class="p">)</span><span class="o">.</span><span class="n">parent</span> <span class="o">/</span> <span class="s2">&quot;README.md&quot;</span><span class="p">,</span> <span class="s2">&quot;r&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">this_init_file</span><span class="p">:</span>
    72. 

  72.     <span class="vm">__doc__</span> <span class="o">+=</span> <span class="n">this_init_file</span><span class="o">.</span><span class="n">read</span><span class="p">()</span>
    73. 

  73. 

  74. 

  75. <span class="c1"># with open(Path(__file__).parent.parent / &quot;README.md&quot;, &quot;r&quot;) as this_init_file:</span>
    76. 

  76. <span class="c1">#    __doc__ += this_init_file.read()</span>
    77. 

  77. 

  78. <span class="c1"># __all__ = [&quot;PROJECT_APP_PATH&quot;, &quot;PROJECT_NAME&quot;, &quot;PROJECT_VERSION&quot;, &quot;get_version&quot;]</span>
    79. 

  79. 

  80. 

  81. <div class="viewcode-block" id="dist_is_editable"><a class="viewcode-back" href="../generated/draugr.dist_is_editable.html#draugr.dist_is_editable">[docs]</a><span class="k">def</span> <span class="nf">dist_is_editable</span><span class="p">(</span><span class="n">dist</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
    82. 

  82.     <span class="sd">&quot;&quot;&quot;</span>
    83. 

  83. <span class="sd">    Return True if given Distribution is an editable installation.&quot;&quot;&quot;</span>
    84. 

  84.     <span class="kn">import</span> <span class="nn">sys</span>
    85. 

  85. 

  86.     <span class="k">for</span> <span class="n">path_item</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="p">:</span>
    87. 

  87.         <span class="n">egg_link</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">path_item</span><span class="p">)</span> <span class="o">/</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">dist</span><span class="o">.</span><span class="n">project_name</span><span class="si">}</span><span class="s2">.egg-link&quot;</span>
    88. 

  88.         <span class="k">if</span> <span class="n">egg_link</span><span class="o">.</span><span class="n">is_file</span><span class="p">():</span>
    89. 

  89.             <span class="k">return</span> <span class="kc">True</span>
    90. 

  90.     <span class="k">return</span> <span class="kc">False</span></div>
    91. 

  91. 

  92. 

  93. <span class="n">PROJECT_ORGANISATION</span> <span class="o">=</span> <span class="s2">&quot;pything&quot;</span>
    94. 

  94. <span class="n">PROJECT_NAME</span> <span class="o">=</span> <span class="n">__project__</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot; &quot;</span><span class="p">,</span> <span class="s2">&quot;_&quot;</span><span class="p">)</span>
    95. 

  95. <span class="n">PROJECT_VERSION</span> <span class="o">=</span> <span class="n">__version__</span>
    96. 

  96. <span class="n">PROJECT_YEAR</span> <span class="o">=</span> <span class="mi">2018</span>
    97. 

  97. <span class="n">PROJECT_AUTHOR</span> <span class="o">=</span> <span class="n">__author__</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">&quot; &quot;</span><span class="p">,</span> <span class="s2">&quot;_&quot;</span><span class="p">)</span>
    98. 

  98. <span class="n">PROJECT_APP_PATH</span> <span class="o">=</span> <span class="n">AppPath</span><span class="p">(</span><span class="n">app_name</span><span class="o">=</span><span class="n">PROJECT_NAME</span><span class="p">,</span> <span class="n">app_author</span><span class="o">=</span><span class="n">PROJECT_AUTHOR</span><span class="p">)</span>
    99. 

  99. <span class="n">PACKAGE_DATA_PATH</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">pkg_resources</span><span class="o">.</span><span class="n">resource_filename</span><span class="p">(</span><span class="n">PROJECT_NAME</span><span class="p">,</span> <span class="s2">&quot;data&quot;</span><span class="p">))</span>
    100. 

  100. <span class="n">INCLUDE_PROJECT_READMES</span> <span class="o">=</span> <span class="kc">False</span>
    101. 

  101. 

  102. <span class="n">distributions</span> <span class="o">=</span> <span class="p">{</span><span class="n">v</span><span class="o">.</span><span class="n">key</span><span class="p">:</span> <span class="n">v</span> <span class="k">for</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">pkg_resources</span><span class="o">.</span><span class="n">working_set</span><span class="p">}</span>
    103. 

  103. <span class="k">if</span> <span class="n">PROJECT_NAME</span> <span class="ow">in</span> <span class="n">distributions</span><span class="p">:</span>
    104. 

  104.     <span class="n">distribution</span> <span class="o">=</span> <span class="n">distributions</span><span class="p">[</span><span class="n">PROJECT_NAME</span><span class="p">]</span>
    105. 

  105.     <span class="n">DEVELOP</span> <span class="o">=</span> <span class="n">dist_is_editable</span><span class="p">(</span><span class="n">distribution</span><span class="p">)</span>
    106. 

  106. <span class="k">else</span><span class="p">:</span>
    107. 

  107.     <span class="n">DEVELOP</span> <span class="o">=</span> <span class="kc">True</span>
    108. 

  108. 

  109. 

  110. <div class="viewcode-block" id="get_version"><a class="viewcode-back" href="../generated/draugr.get_version.html#draugr.get_version">[docs]</a><span class="k">def</span> <span class="nf">get_version</span><span class="p">(</span><span class="n">append_time</span><span class="p">:</span> <span class="n">Any</span> <span class="o">=</span> <span class="n">DEVELOP</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
    111. 

  111.     <span class="sd">&quot;&quot;&quot;description&quot;&quot;&quot;</span>
    112. 

  112.     <span class="n">version</span> <span class="o">=</span> <span class="n">__version__</span>
    113. 

  113.     <span class="k">if</span> <span class="ow">not</span> <span class="n">version</span><span class="p">:</span>
    114. 

  114.         <span class="n">version</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">&quot;VERSION&quot;</span><span class="p">,</span> <span class="s2">&quot;0.0.0&quot;</span><span class="p">)</span>
    115. 

  115. 

  116.     <span class="k">if</span> <span class="n">append_time</span><span class="p">:</span>
    117. 

  117.         <span class="n">now</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span>
    118. 

  118.         <span class="n">date_version</span> <span class="o">=</span> <span class="n">now</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s2">&quot;%Y%m</span><span class="si">%d</span><span class="s2">%H%M%S&quot;</span><span class="p">)</span>
    119. 

  119.         <span class="c1"># date_version = time.time()</span>
    120. 

  120. 

  121.         <span class="k">if</span> <span class="n">version</span><span class="p">:</span>
    122. 

  122.             <span class="c1"># Most git tags are prefixed with &#39;v&#39; (example: v1.2.3) this is</span>
    123. 

  123.             <span class="c1"># never desirable for artifact repositories, so we strip the</span>
    124. 

  124.             <span class="c1"># leading &#39;v&#39; if it&#39;s present.</span>
    125. 

  125.             <span class="n">version</span> <span class="o">=</span> <span class="p">(</span>
    126. 

  126.                 <span class="n">version</span><span class="p">[</span><span class="mi">1</span><span class="p">:]</span>
    127. 

  127.                 <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">version</span><span class="p">,</span> <span class="nb">str</span><span class="p">)</span> <span class="ow">and</span> <span class="n">version</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">&quot;v&quot;</span><span class="p">)</span>
    128. 

  128.                 <span class="k">else</span> <span class="n">version</span>
    129. 

  129.             <span class="p">)</span>
    130. 

  130.         <span class="k">else</span><span class="p">:</span>
    131. 

  131.             <span class="c1"># Default version is an ISO8601 compliant datetime. PyPI doesn&#39;t allow</span>
    132. 

  132.             <span class="c1"># the colon &#39;:&#39; character in its versions, and time is required to allow</span>
    133. 

  133.             <span class="c1"># for multiple publications to master in one day. This datetime string</span>
    134. 

  134.             <span class="c1"># uses the &#39;basic&#39; ISO8601 format for both its date and time components</span>
    135. 

  135.             <span class="c1"># to avoid issues with the colon character (ISO requires that date and</span>
    136. 

  136.             <span class="c1"># time components of a date-time string must be uniformly basic or</span>
    137. 

  137.             <span class="c1"># extended, which is why the date component does not have dashes.</span>
    138. 

  138.             <span class="c1">#</span>
    139. 

  139.             <span class="c1"># Publications using datetime versions should only be made from master</span>
    140. 

  140.             <span class="c1"># to represent the HEAD moving forward.</span>
    141. 

  141.             <span class="n">warning</span><span class="p">(</span>
    142. 

  142.                 <span class="sa">f</span><span class="s2">&quot;Environment variable VERSION is not set, only using datetime: </span><span class="si">{</span><span class="n">date_version</span><span class="si">}</span><span class="s2">&quot;</span>
    143. 

  143.             <span class="p">)</span>
    144. 

  144. 

  145.             <span class="c1"># warn(f&#39;Environment variable VERSION is not set, only using timestamp: {version}&#39;)</span>
    146. 

  146. 

  147.         <span class="n">version</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">version</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="n">date_version</span><span class="si">}</span><span class="s2">&quot;</span>
    148. 

  148. 

  149.     <span class="k">return</span> <span class="n">version</span></div>
    150. 

  150. 

  151. 

  152. <span class="k">if</span> <span class="n">__version__</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
    153. 

  153.     <span class="n">__version__</span> <span class="o">=</span> <span class="n">get_version</span><span class="p">(</span><span class="n">append_time</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
    154. 

  154. 

  155. <span class="n">__version_info__</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="nb">int</span><span class="p">(</span><span class="n">segment</span><span class="p">)</span> <span class="k">for</span> <span class="n">segment</span> <span class="ow">in</span> <span class="n">__version__</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">&quot;.&quot;</span><span class="p">))</span>
    156. 

  156. </pre></div>
    157. 

  157. 

  158.           </div>
    159. 

  159.           
    160. 

  160.         </div>
    161. 

  161.       </div>
    162. 

  162.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    163. 

  163.         <div class="sphinxsidebarwrapper">
    164. 

  164.             <p class="logo"><a href="../index.html">
    165. 

  165.               <img class="logo" src="../_static/valknut.svg" alt="Logo"/>
    166. 

  166.             </a></p>
    167. 

  167. <h1 class="logo"><a href="../index.html">Draugr</a></h1>
    168. 

  168. 

  169. 

  170. 

  171. 

  172. 

  173. 

  174. 

  175. 

  176. <h3>Navigation</h3>
    177. 

  177. <ul>
    178. 

  178. <li class="toctree-l1"><a class="reference internal" href="../generated/draugr.html">draugr</a></li>
    179. 

  179. </ul>
    180. 

  180. <p class="caption" role="heading"><span class="caption-text">Notes</span></p>
    181. 

  181. <ul>
    182. 

  182. <li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
    183. 

  183. </ul>
    184. 

  184. 

  185. <div class="relations">
    186. 

  186. <h3>Related Topics</h3>
    187. 

  187. <ul>
    188. 

  188.   <li><a href="../index.html">Documentation overview</a><ul>
    189. 

  189.   <li><a href="index.html">Module code</a><ul>
    190. 

  190.   </ul></li>
    191. 

  191.   </ul></li>
    192. 

  192. </ul>
    193. 

  193. </div>
    194. 

  194. <div id="searchbox" style="display: none" role="search">
    195. 

  195.   <h3 id="searchlabel">Quick search</h3>
    196. 

  196.     <div class="searchformwrapper">
    197. 

  197.     <form class="search" action="../search.html" method="get">
    198. 

  198.       <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
    199. 

  199.       <input type="submit" value="Go" />
    200. 

  200.     </form>
    201. 

  201.     </div>
    202. 

  202. </div>
    203. 

  203. <script>document.getElementById('searchbox').style.display = "block"</script>
    204. 

  204. 

  205. 

  206. 

  207. 

  208. 

  209. 

  210. 

  211. 

  212.         </div>
    213. 

  213.       </div>
    214. 

  214.       <div class="clearer"></div>
    215. 

  215.     </div>
    216. 

  216.     <div class="footer">
    217. 

  217.       &copy;.
    218. 

  218.       
    219. 

  219.       |
    220. 

  220.       Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a>
    221. 

  221.       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
    222. 

  222.       
    223. 

  223.     </div>
    224. 

  224. 

  225.     
    226. 

  226. 

  227.     
    228. 

  228.   </body>
    229. 

  229. </html>
    230.