icecube.dataio.I3FileStagerFile module

class icecube.dataio.I3FileStagerFile.AbstractFileStager

Bases: I3FileStager

GenerateLocalFileName(url, readable)

WillReadLater((I3FileStager)arg1, (str)arg2) → None :

C++ signature :

void WillReadLater(I3FileStager {lvalue},std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>)

classmethod get_local_scratch_dir()

classmethod get_subclasses() → list[Type[AbstractFileStager]]

Assemble a list of all subclasses defined in the current module

classmethod set_local_scratch_dir(staging_directory)

Set the directory to use for staging temporary files, overriding the default guesses.

static try_to_make_scratch_dir(basename, fullname)

class icecube.dataio.I3FileStagerFile.DCacheStager

Bases: AbstractFileStager

Handles dcap:// URLs

CopyFileIn(url, local_path)

CopyFileOut(local_path, url)

ReadSchemes((I3FileStager)arg1) → vector_string :

C++ signature :

std::__1::vector<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>, std::__1::allocator<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>>> ReadSchemes(I3FileStager {lvalue})

ReadSchemes( (I3FileStager)arg1) -> None :

C++ signature :

void ReadSchemes(boost::shared_ptr<I3FileStagerWrapper> {lvalue})

WillReadLater(url, fname)

Tell the DCache gateway to move the file into disk cache

WriteSchemes((I3FileStager)arg1) → vector_string :

C++ signature :

std::__1::vector<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>, std::__1::allocator<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>>> WriteSchemes(I3FileStager {lvalue})

WriteSchemes( (I3FileStager)arg1) -> None :

C++ signature :

void WriteSchemes(boost::shared_ptr<I3FileStagerWrapper> {lvalue})

dccp(*args)

class icecube.dataio.I3FileStagerFile.GridFTPStager(globus_url_copy='globus-url-copy', options=['-nodcau', '-rst', '-cd'])

Bases: AbstractFileStager

Handles ftp:// and gsiftp:// URLs

Note

GridFTP requires that you have a proxy certificate either in the standard location or in the location specified by the environment variable X509_USER_PROXY. See the Globus Toolkit documentation for more information. You will also need to obtain a user certificate :wiki:`Using_GridFTP.

CopyFileIn(url, local_path)

CopyFileOut(local_path, url)

ReadSchemes((I3FileStager)arg1) → vector_string :

C++ signature :

std::__1::vector<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>, std::__1::allocator<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>>> ReadSchemes(I3FileStager {lvalue})

ReadSchemes( (I3FileStager)arg1) -> None :

C++ signature :

void ReadSchemes(boost::shared_ptr<I3FileStagerWrapper> {lvalue})

WriteSchemes((I3FileStager)arg1) → vector_string :

C++ signature :

std::__1::vector<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>, std::__1::allocator<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>>> WriteSchemes(I3FileStager {lvalue})

WriteSchemes( (I3FileStager)arg1) -> None :

C++ signature :

void WriteSchemes(boost::shared_ptr<I3FileStagerWrapper> {lvalue})

class icecube.dataio.I3FileStagerFile.I3FileStagerFile(blocksize=65536, ssl=None, retry=5)

Bases: AbstractFileStager

Handles http://, https://, ftp://, and file:// URLs

Note

A username/password combination may be embedded in http URLs in the format specified in RFC 3986. This should only be used for “dummy” shared passwords like the standard IceCube password.

A ssl parameter is available for ssl configuration.

CopyFileIn(url, output_path)

CopyFileOut(local_path, url)

ReadSchemes((I3FileStager)arg1) → vector_string :

C++ signature :

std::__1::vector<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>, std::__1::allocator<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>>> ReadSchemes(I3FileStager {lvalue})

ReadSchemes( (I3FileStager)arg1) -> None :

C++ signature :

void ReadSchemes(boost::shared_ptr<I3FileStagerWrapper> {lvalue})

WriteSchemes((I3FileStager)arg1) → vector_string :

C++ signature :

std::__1::vector<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>, std::__1::allocator<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>>> WriteSchemes(I3FileStager {lvalue})

WriteSchemes( (I3FileStager)arg1) -> None :

C++ signature :

void WriteSchemes(boost::shared_ptr<I3FileStagerWrapper> {lvalue})

strip_auth(url)

urlopen() doesn’t support inline auth. Strip it out and construct the appropriate header by hand.

class icecube.dataio.I3FileStagerFile.SCPStager

Bases: AbstractFileStager

Handles scp:// URLs

Note

Since there is no way to enter your password, you must have public key authentication set up to use the scp stager. If you try to embed the password in the URL, an error will be raised.

CopyFileIn(url, local_path)

CopyFileOut(local_path, url)

ReadSchemes((I3FileStager)arg1) → vector_string :

C++ signature :

std::__1::vector<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>, std::__1::allocator<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>>> ReadSchemes(I3FileStager {lvalue})

ReadSchemes( (I3FileStager)arg1) -> None :

C++ signature :

void ReadSchemes(boost::shared_ptr<I3FileStagerWrapper> {lvalue})

WriteSchemes((I3FileStager)arg1) → vector_string :

C++ signature :

std::__1::vector<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>, std::__1::allocator<std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char>>>> WriteSchemes(I3FileStager {lvalue})

WriteSchemes( (I3FileStager)arg1) -> None :

C++ signature :

void WriteSchemes(boost::shared_ptr<I3FileStagerWrapper> {lvalue})