Functions | |
def | fileinfo (args) |
def | _make_file_info (lines) |
def | getAvailableDimensions (samweb) |
def | _callDimensions (samweb, url, dimensions, params=None, stream=False) |
def | listFiles (samweb, dimensions=None, defname=None, fileinfo=False, stream=False) |
def | listFilesSummary (samweb, dimensions=None, defname=None) |
def | parseDims (samweb, dimensions, mode=False) |
def | countFiles (samweb, dimensions=None, defname=None) |
def | _make_file_path (filenameorid) |
def | locateFile (samweb, filenameorid) |
def | locateFiles (samweb, filenameorids) |
def | addFileLocation (samweb, filenameorid, location) |
def | removeFileLocation (samweb, filenameorid, location) |
def | getFileAccessUrls (samweb, filenameorid, schema, locationfilter=None) |
def | getMetadata (samweb, filenameorid, locations=False) |
def | getMultipleMetadata (samweb, filenameorids, locations=False, asJSON=False) |
def | getMetadataText (samweb, filenameorid, format=None, locations=False) |
def | getFileLineage (samweb, lineagetype, filenameorid) |
def | validateFileMetadata (samweb, md=None, mdfile=None) |
def | declareFile (samweb, md=None, mdfile=None) |
def | modifyFileMetadata (samweb, filename, md=None, mdfile=None) |
def | retireFile (samweb, filename) |
Variables | |
fileinfo = namedtuple("fileinfo", ["file_name", "file_id", "file_size", "event_count"]) | |
|
private |
Call the requested method with a dimensions string, automatically switching from GET to POST as needed
Definition at line 32 of file files.py.
|
private |
Definition at line 16 of file files.py.
References samweb_client.files.fileinfo, and makeTrainCVSamples.int.
Referenced by samweb_client.files.listFiles().
|
private |
Definition at line 123 of file files.py.
References samweb_client.http_client.escape_url_component().
Referenced by samweb_client.files.addFileLocation(), samweb_client.files.getFileAccessUrls(), samweb_client.files.getFileLineage(), samweb_client.files.getMetadata(), samweb_client.files.getMetadataText(), samweb_client.files.locateFile(), samweb_client.files.modifyFileMetadata(), samweb_client.files.removeFileLocation(), and samweb_client.files.retireFile().
def samweb_client.files.addFileLocation | ( | samweb, | |
filenameorid, | |||
location | |||
) |
Add a location for a file arguments: name or id of file location
Definition at line 162 of file files.py.
References samweb_client.files._make_file_path().
def samweb_client.files.countFiles | ( | samweb, | |
dimensions = None , |
|||
defname = None |
|||
) |
return count of files matching either a dataset definition or a dimensions string arguments: dimensions: string (default None) defname: string definition name (default None)
Definition at line 112 of file files.py.
References samweb_client.http_client.escape_url_component().
def samweb_client.files.declareFile | ( | samweb, | |
md = None , |
|||
mdfile = None |
|||
) |
Declare a new file arguments: md: dictionary containing metadata (default None) mdfile: file object containing metadata (must be in json format)
Definition at line 276 of file files.py.
def samweb_client.files.fileinfo | ( | args | ) |
def samweb_client.files.getAvailableDimensions | ( | samweb | ) |
List the available dimensions
Definition at line 26 of file files.py.
References samweb_client.convert_from_unicode().
def samweb_client.files.getFileAccessUrls | ( | samweb, | |
filenameorid, | |||
schema, | |||
locationfilter = None |
|||
) |
return urls by which this file may be accessed arguments: name or id of file schema locationfilter (default None)
Definition at line 184 of file files.py.
References samweb_client.files._make_file_path(), and samweb_client.convert_from_unicode().
def samweb_client.files.getFileLineage | ( | samweb, | |
lineagetype, | |||
filenameorid | |||
) |
Return lineage information for a file arguments: lineagetype (ie "parents", "children") name or id of file
Definition at line 251 of file files.py.
References samweb_client.files._make_file_path(), samweb_client.convert_from_unicode(), and samweb_client.http_client.escape_url_component().
def samweb_client.files.getMetadata | ( | samweb, | |
filenameorid, | |||
locations = False |
|||
) |
Return metadata as a dictionary arguments: name or id of file locations: if True, also return file locations
Definition at line 198 of file files.py.
References samweb_client.files._make_file_path(), and samweb_client.convert_from_unicode().
def samweb_client.files.getMetadataText | ( | samweb, | |
filenameorid, | |||
format = None , |
|||
locations = False |
|||
) |
Return metadata as a string arguments: name or id of file
Definition at line 239 of file files.py.
References samweb_client.files._make_file_path().
def samweb_client.files.getMultipleMetadata | ( | samweb, | |
filenameorids, | |||
locations = False , |
|||
asJSON = False |
|||
) |
Return a list of metadata dictionaries (This method does not return an error if a file does not exist; instead it returns no result for that file) arguments: list of file names or ids locations: if True include location information asJSON: return the undecoded JSON string instead of python objects
Definition at line 210 of file files.py.
References samweb_client.convert_from_unicode().
def samweb_client.files.listFiles | ( | samweb, | |
dimensions = None , |
|||
defname = None , |
|||
fileinfo = False , |
|||
stream = False |
|||
) |
list files matching either a dataset definition or a dimensions string arguments: dimensions: string (default None) defname: string definition name (default None) fileinfo: boolean; if True, return file_id, file_size, event_count stream: boolean: if True the return value will be a generator and the results will be progressively returned to the client. Note that this keeps the network connection open until all the response has been read. (default False) returns: a generator producing file names (note that the network connection may not be closed until you have read the entire list). If fileinfo is true, it will produce (file_name, file_id, file_size, event_count) tuples
Definition at line 47 of file files.py.
References samweb_client.files._make_file_info(), samweb_client.http_client.escape_url_component(), and parse_dependency_file_t.list.
Referenced by ProductionTestTools.getConfigFromDef(), and ProductionTestTools.getSamDefinitionFiles().
def samweb_client.files.listFilesSummary | ( | samweb, | |
dimensions = None , |
|||
defname = None |
|||
) |
return summary of files matching either a dataset definition or a dimensions string arguments: dimensions: string (default None) defname: string definition name (default None)
Definition at line 80 of file files.py.
References samweb_client.convert_from_unicode(), and samweb_client.http_client.escape_url_component().
Referenced by FirstAnaPageMakers.makeDatasetPage(), and ProductionTestTools.samDefinitionSummary().
def samweb_client.files.locateFile | ( | samweb, | |
filenameorid | |||
) |
return locations for this file arguments: name or id of file
Definition at line 132 of file files.py.
References samweb_client.files._make_file_path(), and samweb_client.convert_from_unicode().
def samweb_client.files.locateFiles | ( | samweb, | |
filenameorids | |||
) |
return the locations of multiple files The return value is a dictionary of { file_name_or_id : location } pairs
Definition at line 142 of file files.py.
References samweb_client.convert_from_unicode().
def samweb_client.files.modifyFileMetadata | ( | samweb, | |
filename, | |||
md = None , |
|||
mdfile = None |
|||
) |
Modify file metadata arguments: filename md: dictionary containing metadata (default None) mdfile: file object containing metadata (must be in json format)
Definition at line 291 of file files.py.
References samweb_client.files._make_file_path().
def samweb_client.files.parseDims | ( | samweb, | |
dimensions, | |||
mode = False |
|||
) |
def samweb_client.files.removeFileLocation | ( | samweb, | |
filenameorid, | |||
location | |||
) |
Remove a location for a file arguments: name or id of file location
Definition at line 173 of file files.py.
References samweb_client.files._make_file_path().
def samweb_client.files.retireFile | ( | samweb, | |
filename | |||
) |
Retire a file: arguments: filename
Definition at line 306 of file files.py.
References samweb_client.files._make_file_path().
def samweb_client.files.validateFileMetadata | ( | samweb, | |
md = None , |
|||
mdfile = None |
|||
) |
Check the metadata for validity arguments: md: dictionary containing metadata (default None) mdfile: file object containing metadata (must be in json format)
Definition at line 261 of file files.py.
samweb_client.files.fileinfo = namedtuple("fileinfo", ["file_name", "file_id", "file_size", "event_count"]) |
Definition at line 14 of file files.py.
Referenced by samweb_client.files._make_file_info(), and samweb_client.files.fileinfo().