Source.Python/docs/developing/modules/core.update.html at Data-Update · srpg/Source.Python · GitHub

Repository navigation

History

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

<!DOCTYPE html>

<head>

<title>core.update module — Source.Python v743 documentation</title>

</head><body>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v743 documentation</a> »</li>

<li class="nav-item nav-item-this"><a href="">core.update module</a></li>

</ul>

</div>

<h1>core.update module<a class="headerlink" href="#module-core.update" title="Link to this heading">¶</a></h1>

Provides functions to update Source.Python and its data files.

core.update.download_file(url_path, file_path, timeout=3)<a class="reference internal" href="../../_modules/core/update.html#download_file">[source]</a><a class="headerlink" href="#core.update.download_file" title="Link to this definition">¶</a></dt>

<dd>Download a file from an URL to a specific file.

<dt class="field-odd">Parameters:</dt>

<li>url_path (<a class="reference external" href="https://docs.python.org/3.13/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – The URL that should be opened.</li>

<li>file_path (<a class="reference external" href="https://docs.python.org/3.13/library/stdtypes.html#str" title="(in Python v3.13)">str</a>) – The file where the content of the URL should be stored.</li>

<li>timeout (<a class="reference external" href="https://docs.python.org/3.13/library/functions.html#float" title="(in Python v3.13)">float</a>) – Number of seconds that need to pass until a timeout occurs.</li>

</ul>

</dd>

</dl>

</dd></dl>

core.update.get_build_artifacts(timeout=3)<a class="reference internal" href="../../_modules/core/update.html#get_build_artifacts">[source]</a><a class="headerlink" href="#core.update.get_build_artifacts" title="Link to this definition">¶</a></dt>

<dd>Return the artifacts of the latest Source.Python build.

<dt class="field-odd">Parameters:</dt>

<dd class="field-odd">timeout (<a class="reference external" href="https://docs.python.org/3.13/library/functions.html#float" title="(in Python v3.13)">float</a>) – Number of seconds that need to pass until a timeout occurs.

</dd>

</dl>

</dd></dl>

core.update.get_download_url(game='css', timeout=3)<a class="reference internal" href="../../_modules/core/update.html#get_download_url">[source]</a><a class="headerlink" href="#core.update.get_download_url" title="Link to this definition">¶</a></dt>

<dd>Get the latest Source.Python download URL for a specific game.

<dt class="field-odd">Parameters:</dt>

</ul>

</dd>

<dt class="field-even">Return type:</dt>

</dd>

<dt class="field-odd">Raises:</dt>

<dd class="field-odd"><a class="reference external" href="https://docs.python.org/3.13/library/exceptions.html#ValueError" title="(in Python v3.13)">ValueError</a> – Raised if the game wasn’t found.

</dd>

</dl>

</dd></dl>

core.update.get_latest_data_checksum(timeout=3)<a class="reference internal" href="../../_modules/core/update.html#get_latest_data_checksum">[source]</a><a class="headerlink" href="#core.update.get_latest_data_checksum" title="Link to this definition">¶</a></dt>

<dd>Return the MD5 checksum of the latest data from the build server.

<dt class="field-odd">Parameters:</dt>

</dd>

<dt class="field-even">Return type:</dt>

</dd>

</dl>

</dd></dl>

core.update.is_new_data_available(timeout=3)<a class="reference internal" href="../../_modules/core/update.html#is_new_data_available">[source]</a><a class="headerlink" href="#core.update.is_new_data_available" title="Link to this definition">¶</a></dt>

<dd>Return <code class="docutils literal notranslate">True</code> if new data is available.

<dt class="field-odd">Parameters:</dt>

</dd>

<dt class="field-even">Return type:</dt>

</dd>

</dl>

</dd></dl>

core.update.update_data(timeout=3)<a class="reference internal" href="../../_modules/core/update.html#update_data">[source]</a><a class="headerlink" href="#core.update.update_data" title="Link to this definition">¶</a></dt>

<dd>Download and unpack the latest data from the build server.

Old data gets deleted before unpacking.

<dt class="field-odd">Parameters:</dt>

</dd>

</dl>

</dd></dl>

core.update.update_in_progress = False<a class="headerlink" href="#core.update.update_in_progress" title="Link to this definition">¶</a></dt>

<dd>Indicates, whether an update is in progress (stage 1 has been applied).

</dd></dl>

</section>

</div>

</a>

<div>

<h3><a href="../../index.html">Table of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">core.update module</a><ul>

<li><a class="reference internal" href="#core.update.download_file"><code class="docutils literal notranslate">download_file()</code></a></li>

<li><a class="reference internal" href="#core.update.get_build_artifacts"><code class="docutils literal notranslate">get_build_artifacts()</code></a></li>

<li><a class="reference internal" href="#core.update.get_download_url"><code class="docutils literal notranslate">get_download_url()</code></a></li>

<li><a class="reference internal" href="#core.update.get_latest_data_checksum"><code class="docutils literal notranslate">get_latest_data_checksum()</code></a></li>

<li><a class="reference internal" href="#core.update.is_new_data_available"><code class="docutils literal notranslate">is_new_data_available()</code></a></li>

<li><a class="reference internal" href="#core.update.update_data"><code class="docutils literal notranslate">update_data()</code></a></li>

<li><a class="reference internal" href="#core.update.update_in_progress"><code class="docutils literal notranslate">update_in_progress</code></a></li>

</ul>

</li>

</ul>

</div>

<li><a href="../../_sources/developing/modules/core.update.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<h3 id="searchlabel">Quick search</h3>

</form>

</div>

</search>

</div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

>index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v743 documentation</a> »</li>

<li class="nav-item nav-item-this"><a href="">core.update module</a></li>

</ul>

</div>

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.

</div>

</body>

</html>

Source.Python/docs/developing/modules/core.update.html at Data-Update · srpg/Source.Python · GitHub

Repository navigation

Expand file tree

Breadcrumbs

core.update.html

Latest commit

History

Breadcrumbs

core.update.html

File metadata and controls