skyplane.api.tracker#

Classes

`EmptyTransferHook`()	Empty transfer hook that does nothing
`TransferHook`()	Hook that shows transfer related stats
`TransferProgressTracker`(dataplane, jobs, ...)	Tracks transfer progress in one tranfer session

class skyplane.api.tracker.EmptyTransferHook[source]#

Bases: TransferHook

Empty transfer hook that does nothing

on_chunk_completed(chunks, region_tag=None)[source]#: Chunks are all transferred

on_chunk_dispatched(chunks)[source]#: Dispatching data chunks to transfer

on_dispatch_end()[source]#: Ending the dispatch job

on_dispatch_start()[source]#: Starting the dispatch job

on_transfer_end(transfer_stats)[source]#: Ending the transfer job

on_transfer_error(error)[source]#: Showing the tranfer error if it fails

class skyplane.api.tracker.TransferHook[source]#

Bases: ABC

Hook that shows transfer related stats

on_chunk_completed(chunks, region_tag=None)[source]#: Chunks are all transferred

on_chunk_dispatched(chunks)[source]#: Dispatching data chunks to transfer

on_dispatch_end()[source]#: Ending the dispatch job

on_dispatch_start()[source]#: Starting the dispatch job

on_transfer_end(transfer_stats)[source]#: Ending the transfer job

on_transfer_error(error)[source]#: Showing the tranfer error if it fails

class skyplane.api.tracker.TransferProgressTracker(dataplane, jobs, transfer_config, hooks)[source]#

Bases: Thread

Tracks transfer progress in one tranfer session

Parameters:

dataplane (Dataplane) – dataplane that starts the transfer
jobs (List) – list of transfer jobs launched in parallel
transfer_config (TransferConfig) – the configuration during the transfer
hooks (TransferHook) – the hook that shows transfer related stats

property daemon#

A boolean value indicating whether this thread is a daemon thread.

This must be set before start() is called, otherwise RuntimeError is raised. Its initial value is inherited from the creating thread; the main thread is not a daemon thread and therefore all threads created in the main thread default to daemon = False.

The entire Python program exits when only daemon threads are left.

property ident#

Thread identifier of this thread or None if it has not been started.

This is a nonzero integer. See the get_ident() function. Thread identifiers may be recycled when a thread exits and another thread is created. The identifier is available even after the thread has exited.

is_alive()#

Return whether the thread is alive.

This method returns True just before the run() method starts until just after the run() method terminates. See also the module function enumerate().

property is_complete#: Return if the transfer is complete

join(timeout=None)#

Wait until the thread terminates.

This blocks the calling thread until the thread whose join() method is called terminates – either normally or through an unhandled exception or until the optional timeout occurs.

When the timeout argument is present and not None, it should be a floating point number specifying a timeout for the operation in seconds (or fractions thereof). As join() always returns None, you must call is_alive() after join() to decide whether a timeout happened – if the thread is still alive, the join() call timed out.

When the timeout argument is not present or None, the operation will block until the thread terminates.

A thread can be join()ed many times.

join() raises a RuntimeError if an attempt is made to join the current thread as that would cause a deadlock. It is also an error to join() a thread before it has been started and attempts to do so raises the same exception.

monitor_transfer(self, region_tag)[source]#: Monitor the tranfer by copying remote gateway logs and show transfer stats by hooks

property name#

A string used for identification purposes only.

It has no semantics. Multiple threads may be given the same name. The initial name is set by the constructor.

property native_id#

Native integral thread ID of this thread, or None if it has not been started.

This is a non-negative integer. See the get_native_id() function. This represents the Thread ID as reported by the kernel.

query_bytes_dispatched()[source]#: Query the total number of bytes dispatched to chunks ready for transfer

query_bytes_remaining(region_tag=None)[source]#: Query the total number of bytes remaining in all the transfer jobs

run()[source]#: Dispatch and start the transfer jobs

start()#

Start the thread’s activity.

It must be called at most once per thread object. It arranges for the object’s run() method to be invoked in a separate thread of control.

This method will raise a RuntimeError if called more than once on the same thread object.