particle-os/debian-koji
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

kojikamid: docstring for getFile method

Browse source 
Document the getFile method.
This commit is contained in:
Ken Dreyer 2022-11-09 10:40:51 -05:00 • committed by Tomas Kopecek
parent 57e8a726da
commit bb1d61569e
1 changed files with 16 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

17
vm/kojikamid.py
View file

@ -320,7 +320,22 @@ class WindowsBuild(object):
self.server.expireBuildroot(self.buildroot_id)
def fetchFile(self, basedir, buildinfo, fileinfo, brtype):
"""Download the file from buildreq, at filepath, into the basedir"""
"""Download a buildrequires file into the basedir.
Example:
/tmp/build/buildreqs/wnbd/win/vstudio/x64/Release/libwnbd.dll
"/tmp/build/buildreqs/wnbd/win" is basedir...
("wnbd" is the package name, "win" is the brtype.)
"vstudio/x64/Release/libwnbd.dll" is the fileinfo['localpath'].
:param str basedir: absolute path directory for this package's files.
Example: "/tmp/build/buildreqs/wnbd/win"
:param dict buildinfo: dict from getLatestBuild RPC.
:param dict fileinfo: Comes from getFileList() RPC's list elements.
Dict should have "localpath" (str) and
"checksum_type" (int) items.
:param str brtype: The type of a buildrequires. For example: "win".
"""
destpath = os.path.join(basedir, fileinfo['localpath'])
ensuredir(os.path.dirname(destpath)) # noqa: F821
if 'checksum_type' in fileinfo: