Mock
Classes¶
Default ¶
Default(protocol_attr, rse_settings, logger=None)
Implementing access to RSEs using the local filesystem.
Initializes the object with information about the referred RSE.
| PARAMETER | DESCRIPTION |
|---|---|
props
|
Properties derived from the RSE Repository
|
Functions¶
path2pfn ¶
path2pfn(path)
Returns a fully qualified PFN for the file referred by path.
| PARAMETER | DESCRIPTION |
|---|---|
path
|
The path to the file.
|
| RETURNS | DESCRIPTION |
|---|---|
|
Fully qualified PFN. |
exists ¶
exists(pfn)
Checks if the requested file is known by the referred RSE.
| PARAMETER | DESCRIPTION |
|---|---|
pfn
|
Physical file name
|
| RETURNS | DESCRIPTION |
|---|---|
|
True if the file exists, False if it doesn't |
connect ¶
connect()
Establishes the actual connection to the referred RSE.
| PARAMETER | DESCRIPTION |
|---|---|
credentials
|
Provide all necessary information to establish a connection to the referred storage system. Some is loaded from the repository inside the RSE class and some must be provided specific for the SFTP protocol like username, password, private_key, private_key_pass, port. For details about possible additional parameters and details about their usage see the pysftp.Connection() documentation. NOTE: the host parametrer is overwritten with the value provided by the repository
|
get ¶
get(pfn, dest, transfer_timeout=None)
Provides access to files stored inside connected the RSE.
| PARAMETER | DESCRIPTION |
|---|---|
pfn
|
Physical file name of requested file
|
dest
|
Name and path of the files when stored at the client
|
put ¶
put(source, target, source_dir=None, transfer_timeout=None)
Allows to store files inside the referred RSE.
| PARAMETER | DESCRIPTION |
|---|---|
source
|
Physical file name
|
target
|
Name of the file on the storage system e.g. with prefixed scope
|
delete ¶
delete(pfn)
Deletes a file from the connected RSE.
| PARAMETER | DESCRIPTION |
|---|---|
pfn
|
Physical file name
|
bulk_delete ¶
bulk_delete(pfns)
Submits an async task to bulk delete files.
| PARAMETER | DESCRIPTION |
|---|---|
pfns
|
list of pfns to delete
|
| RAISES | DESCRIPTION |
|---|---|
TransferAPIError
|
if unexpected response from the service. |
rename ¶
rename(pfn, new_pfn)
Allows to rename a file stored inside the connected RSE.
| PARAMETER | DESCRIPTION |
|---|---|
pfn
|
Current physical file name
|