/usr/share/makehuman-doc/html/_modules/managed_file.html is in makehuman-doc 1.1.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://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/html; charset=utf-8" />
<title>managed_file — MakeHuman 1.0 documentation</title>
<link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for managed_file</h1><div class="highlight"><pre>
<span></span><span class="ch">#!/usr/bin/python2.7</span>
<span class="c1"># -*- coding: utf-8 -*-</span>
<span class="sd">"""</span>
<span class="sd">File class definition</span>
<span class="sd">=====================</span>
<span class="sd">**Project Name:** MakeHuman</span>
<span class="sd">**Product Home Page:** http://www.makehuman.org/</span>
<span class="sd">**Code Home Page:** https://bitbucket.org/MakeHuman/makehuman/</span>
<span class="sd">**Authors:** Thanasis Papoutsidakis</span>
<span class="sd">**Copyright(c):** MakeHuman Team 2001-2017</span>
<span class="sd">**Licensing:** AGPL3</span>
<span class="sd"> This file is part of MakeHuman (www.makehuman.org).</span>
<span class="sd"> This program is free software: you can redistribute it and/or modify</span>
<span class="sd"> it under the terms of the GNU Affero General Public License as</span>
<span class="sd"> published by the Free Software Foundation, either version 3 of the</span>
<span class="sd"> License, or (at your option) any later version.</span>
<span class="sd"> This program is distributed in the hope that it will be useful,</span>
<span class="sd"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="sd"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<span class="sd"> GNU Affero General Public License for more details.</span>
<span class="sd"> You should have received a copy of the GNU Affero General Public License</span>
<span class="sd"> along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
<span class="sd">Abstract</span>
<span class="sd">--------</span>
<span class="sd">This module defines the File class, an object that represents a file that</span>
<span class="sd">is being edited inside MakeHuman.</span>
<span class="sd">"""</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">events3d</span>
<span class="kn">from</span> <span class="nn">getpath</span> <span class="k">import</span> <span class="n">pathToUnicode</span>
<div class="viewcode-block" id="FileModifiedEvent"><a class="viewcode-back" href="../module_managed_file.html#managed_file.FileModifiedEvent">[docs]</a><span class="k">class</span> <span class="nc">FileModifiedEvent</span><span class="p">(</span><span class="n">events3d</span><span class="o">.</span><span class="n">Event</span><span class="p">):</span>
<span class="sd">"""Event class to be emitted upon modification of a managed File object.</span>
<span class="sd"> It contains information about the state of the modified flag and</span>
<span class="sd"> possibly about the reason that the event was triggered.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">oldvalue</span><span class="p">,</span> <span class="n">reason</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""FileModifiedEvent constructor.</span>
<span class="sd"> The FileModifiedEvent object has .value and .oldvalue members for</span>
<span class="sd"> the new and the previous state of the associated File object's</span>
<span class="sd"> modified flag.</span>
<span class="sd"> The reason argument might be a string or a container of strings to be</span>
<span class="sd"> inserted as the emitted event's .reasons set. It may describe</span>
<span class="sd"> aditional information about the cause of the event, with a usage</span>
<span class="sd"> similar to using flags - i.e. like: if "save" in event.reasons: (...).</span>
<span class="sd"> The data member is an optional extra object for the event to carry.</span>
<span class="sd"> A good practice for this could be to be a dictionary of attributes</span>
<span class="sd"> that can provide information about the event.</span>
<span class="sd"> """</span>
<span class="n">events3d</span><span class="o">.</span><span class="n">Event</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">file</span> <span class="o">=</span> <span class="n">file</span>
<span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="o">=</span> <span class="n">value</span>
<span class="bp">self</span><span class="o">.</span><span class="n">oldvalue</span> <span class="o">=</span> <span class="n">oldvalue</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reasons</span> <span class="o">=</span> <span class="nb">set</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">addReason</span><span class="p">(</span><span class="n">reason</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">data</span>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Print out information about the FileModifiedEvent."""</span>
<span class="k">return</span> <span class="s2">"FileModifiedEvent: file: </span><span class="si">%s</span><span class="s2">, flag state: </span><span class="si">%s</span><span class="s2">, previous flag state: </span><span class="si">%s</span><span class="s2">, reasons: </span><span class="si">%s</span><span class="s2">"</span> <span class="o">%</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">file</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">value</span><span class="p">),</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">oldvalue</span><span class="p">),</span> <span class="nb">repr</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">reasons</span><span class="p">))</span>
<span class="k">def</span> <span class="nf">__nonzero__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Boolean representation of the event. Returns its .value member."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span>
<div class="viewcode-block" id="FileModifiedEvent.addReason"><a class="viewcode-back" href="../module_managed_file.html#managed_file.FileModifiedEvent.addReason">[docs]</a> <span class="k">def</span> <span class="nf">addReason</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">reason</span><span class="p">):</span>
<span class="sd">"""Add the given reason to the event's reason list."""</span>
<span class="k">if</span> <span class="n">reason</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="n">reason</span><span class="p">,</span> <span class="s1">'__iter__'</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reasons</span> <span class="o">|=</span> <span class="nb">set</span><span class="p">(</span><span class="n">reason</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reasons</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">reason</span><span class="p">)</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">objectWasChanged</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Return whether the cause that triggered the event has altered</span>
<span class="sd"> the associated object's data.</span>
<span class="sd"> This method can be used by external classes for invoking</span>
<span class="sd"> update routines.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">value</span> <span class="ow">or</span> <span class="s2">"load"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">reasons</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">pathWasChanged</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Return whether the cause that triggered the event has changed</span>
<span class="sd"> the location of the associated file.</span>
<span class="sd"> This method can be used by external classes for updating path</span>
<span class="sd"> inspectors like path explorers / tree views.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="s2">"newpath"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">reasons</span>
<span class="nd">@classmethod</span>
<div class="viewcode-block" id="FileModifiedEvent.fromObjectAssignment"><a class="viewcode-back" href="../module_managed_file.html#managed_file.FileModifiedEvent.fromObjectAssignment">[docs]</a> <span class="k">def</span> <span class="nf">fromObjectAssignment</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">newfileobj</span><span class="p">,</span> <span class="n">oldfileobj</span><span class="p">):</span>
<span class="sd">"""Class method that returns a new FileModifiedEvent object</span>
<span class="sd"> properly modified to inform about a modification event,</span>
<span class="sd"> in the case that the change was done with the use of</span>
<span class="sd"> assignment (instead of the standard object's methods</span>
<span class="sd"> e.g. load() etc.).</span>
<span class="sd"> """</span>
<span class="n">newvalue</span> <span class="o">=</span> <span class="n">newfileobj</span><span class="o">.</span><span class="n">modified</span> <span class="k">if</span> <span class="n">newfileobj</span> <span class="k">else</span> <span class="kc">False</span>
<span class="n">oldvalue</span> <span class="o">=</span> <span class="n">oldfileobj</span><span class="o">.</span><span class="n">modified</span> <span class="k">if</span> <span class="n">oldfileobj</span> <span class="k">else</span> <span class="kc">False</span>
<span class="n">event</span> <span class="o">=</span> <span class="bp">cls</span><span class="p">(</span><span class="n">newfileobj</span><span class="p">,</span> <span class="n">newvalue</span><span class="p">,</span> <span class="n">oldvalue</span><span class="p">,</span> <span class="s2">"assignment"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">newfileobj</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">event</span><span class="o">.</span><span class="n">addReason</span><span class="p">(</span><span class="s2">"delete"</span><span class="p">)</span>
<span class="k">return</span> <span class="n">event</span>
<span class="n">event</span><span class="o">.</span><span class="n">addReason</span><span class="p">(</span><span class="s2">"load"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">oldfileobj</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">newfileobj</span><span class="o">.</span><span class="n">path</span> <span class="o">!=</span> <span class="n">oldfileobj</span><span class="o">.</span><span class="n">path</span><span class="p">:</span>
<span class="n">event</span><span class="o">.</span><span class="n">addReason</span><span class="p">(</span><span class="s2">"newpath"</span><span class="p">)</span>
<span class="k">return</span> <span class="n">event</span></div></div>
<div class="viewcode-block" id="File"><a class="viewcode-back" href="../module_managed_file.html#managed_file.File">[docs]</a><span class="k">class</span> <span class="nc">File</span><span class="p">(</span><span class="n">events3d</span><span class="o">.</span><span class="n">EventHandler</span><span class="p">):</span>
<span class="sd">"""Object class representing a file that is being opened and edited</span>
<span class="sd"> from inside the application.</span>
<span class="sd"> It can be used for managing project files, and handling the currently</span>
<span class="sd"> opened files in a Graphical User Interface using an organized structure.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""File object constructor.</span>
<span class="sd"> The managed File class has a path member,</span>
<span class="sd"> necessary for knowing to which file on disk</span>
<span class="sd"> this File object corresponds.</span>
<span class="sd"> A File object also contains a modified flag, to indicate whether</span>
<span class="sd"> a change occured since the last save or load action. This flag is</span>
<span class="sd"> a property that emits events upon assignment, which can be used</span>
<span class="sd"> for signaling external classes to update their data.</span>
<span class="sd"> """</span>
<span class="n">events3d</span><span class="o">.</span><span class="n">EventHandler</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_modified</span> <span class="o">=</span> <span class="kc">False</span>
<div class="viewcode-block" id="File.getModified"><a class="viewcode-back" href="../module_managed_file.html#managed_file.File.getModified">[docs]</a> <span class="k">def</span> <span class="nf">getModified</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Get the state of the modified flag."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_modified</span></div>
<div class="viewcode-block" id="File.setModified"><a class="viewcode-back" href="../module_managed_file.html#managed_file.File.setModified">[docs]</a> <span class="k">def</span> <span class="nf">setModified</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
<span class="sd">"""Set the value of the modified flag and emit an event."""</span>
<span class="n">event</span> <span class="o">=</span> <span class="n">FileModifiedEvent</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_modified</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_modified</span> <span class="o">=</span> <span class="n">value</span>
<span class="bp">self</span><span class="o">.</span><span class="n">callEvent</span><span class="p">(</span><span class="s1">'onModified'</span><span class="p">,</span> <span class="n">event</span><span class="p">)</span></div>
<span class="n">modified</span> <span class="o">=</span> <span class="nb">property</span><span class="p">(</span><span class="n">getModified</span><span class="p">,</span> <span class="n">setModified</span><span class="p">)</span>
<div class="viewcode-block" id="File.changed"><a class="viewcode-back" href="../module_managed_file.html#managed_file.File.changed">[docs]</a> <span class="k">def</span> <span class="nf">changed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">reason</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Method to be called when the File's associated data is modified.</span>
<span class="sd"> Without arguments, it is equivalent to File.modified = True.</span>
<span class="sd"> Extra arguments are passed to the FileModifiedEvent constructor.</span>
<span class="sd"> """</span>
<span class="n">event</span> <span class="o">=</span> <span class="n">FileModifiedEvent</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="kc">True</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_modified</span><span class="p">,</span> <span class="n">reason</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_modified</span> <span class="o">=</span> <span class="kc">True</span>
<span class="bp">self</span><span class="o">.</span><span class="n">callEvent</span><span class="p">(</span><span class="s1">'onModified'</span><span class="p">,</span> <span class="n">event</span><span class="p">)</span></div>
<span class="k">def</span> <span class="nf">_associate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">reason</span><span class="p">,</span> <span class="n">extrareason</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Internal method that associates the File object with a path."""</span>
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="n">basestring</span><span class="p">):</span>
<span class="n">path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">normpath</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="n">event</span> <span class="o">=</span> <span class="n">FileModifiedEvent</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_modified</span><span class="p">,</span> <span class="n">reason</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_modified</span> <span class="o">=</span> <span class="kc">False</span>
<span class="n">event</span><span class="o">.</span><span class="n">addReason</span><span class="p">(</span><span class="n">extrareason</span><span class="p">)</span>
<span class="k">if</span> <span class="n">pathToUnicode</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> <span class="o">!=</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">:</span>
<span class="n">event</span><span class="o">.</span><span class="n">addReason</span><span class="p">(</span><span class="s2">"newpath"</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_path</span> <span class="o">=</span> <span class="n">pathToUnicode</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">callEvent</span><span class="p">(</span><span class="s1">'onModified'</span><span class="p">,</span> <span class="n">event</span><span class="p">)</span>
<div class="viewcode-block" id="File.saved"><a class="viewcode-back" href="../module_managed_file.html#managed_file.File.saved">[docs]</a> <span class="k">def</span> <span class="nf">saved</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">reason</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Method to be called after saving the file to a path."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_associate</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s2">"save"</span><span class="p">,</span> <span class="n">reason</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span></div>
<div class="viewcode-block" id="File.loaded"><a class="viewcode-back" href="../module_managed_file.html#managed_file.File.loaded">[docs]</a> <span class="k">def</span> <span class="nf">loaded</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">,</span> <span class="n">reason</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Method to be called after loading the file from a path."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_associate</span><span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="s2">"load"</span><span class="p">,</span> <span class="n">reason</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span></div>
<div class="viewcode-block" id="File.closed"><a class="viewcode-back" href="../module_managed_file.html#managed_file.File.closed">[docs]</a> <span class="k">def</span> <span class="nf">closed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">reason</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">"""Method to be called after closing the file."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_associate</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="p">(</span><span class="s2">"load"</span><span class="p">,</span> <span class="s2">"close"</span><span class="p">),</span> <span class="n">reason</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span></div>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">path</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Get the full path of the associated file."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_path</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Get the filename of the associated file."""</span>
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="k">else</span> <span class="kc">None</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">extension</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Get the extension of the associated file."""</span>
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)[</span><span class="mi">1</span><span class="p">]</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="k">else</span> <span class="kc">None</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">title</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Get the title of the associated file,</span>
<span class="sd"> which is the filename without the extension."""</span>
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="k">else</span> <span class="kc">None</span>
<span class="nd">@property</span>
<span class="k">def</span> <span class="nf">dir</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Get the directory of the associated file."""</span>
<span class="k">return</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">)</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">path</span> <span class="k">else</span> <span class="kc">None</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../index.html">Documentation overview</a><ul>
<li><a href="index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2017, MHteam.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
</div>
</body>
</html>
|