b.t.r.RemoteSSHTransport(RemoteTransport) : class documentation

Part of bzrlib.transport.remote View In Hierarchy

Connection to smart server over SSH.

This is essentially just a factory to get 'RemoteTransport(url,
SmartSSHClientMedium).
Method _build_medium Create the medium if _from_transport does not provide one.

Inherited from RemoteTransport:

Method __init__ Constructor.
Method is_readonly Smart server transport can do read/write file operations.
Method get_smart_client Undocumented
Method get_smart_medium Return a smart client medium for this transport if possible.
Method has Indicate whether a remote file of the given name exists or not.
Method get Return file-like object reading the contents of a remote file.
Method get_bytes Get a raw string of the bytes for a file at the given location.
Method mkdir Create a directory at the given path.
Method open_write_stream See Transport.open_write_stream.
Method put_bytes Atomically put the supplied bytes into the given location.
Method put_bytes_non_atomic See Transport.put_bytes_non_atomic.
Method put_file Copy the file-like object into the location.
Method put_file_non_atomic Copy the file-like object into the target location.
Method append_file Append bytes from a file-like object to a file at relpath.
Method append_bytes Append bytes to a file at relpath.
Method delete Delete the item at relpath
Method external_url See bzrlib.transport.Transport.external_url.
Method recommended_page_size Return the recommended page size for this transport.
Method rename Rename a file or directory.
Method move Move the item at rel_from to the location at rel_to.
Method rmdir Remove a directory at the given path.
Method disconnect Disconnect the transport.
Method stat Return the stat information for a file.
Method listable Return True if this store supports listing.
Method list_dir Return a list of all files at the given location.
Method iter_files_recursive Iter the relative paths of files in the transports sub-tree.
Method _report_activity See Transport._report_activity.
Method _remote_path Returns the Unicode version of the absolute path for relpath.
Method _call Undocumented
Method _call2 Call a method on the remote server.
Method _call_with_body_bytes Call a method on the remote server with body bytes.
Method _serialise_optional_mode Undocumented
Method _readv Get parts of the file at the given relative path.
Method _handle_response Undocumented
Method _ensure_ok Undocumented
Method _translate_error Translate an IOError or OSError into an appropriate bzr error.

Inherited from ConnectedTransport (via RemoteTransport):

Method clone Return a new transport with root at self.base + offset
Method relpath Return the local path portion from a given absolute path
Method abspath Return the full url to the given relative path.
Method _user Undocumented
Method _password Undocumented
Method _host Undocumented
Method _port Undocumented
Method _path Undocumented
Method _scheme Undocumented
Static Method _split_url Undocumented
Static Method _unsplit_url Build the full URL for the given already URL encoded path.
Method _get_shared_connection Get the object shared amongst cloned transports.
Method _set_connection Record a newly created connection with its associated credentials.
Method _get_connection Returns the transport specific connection object.
Method _get_credentials Returns the credentials used to establish the connection.
Method _update_credentials Update the credentials of the current connection.
Method _reuse_for Returns a transport sharing the same connection if possible.

Inherited from Transport (via RemoteTransport, ConnectedTransport):

Method create_prefix Create all the directories leading down to self.base.
Method ensure_base Ensure that the directory this transport references exists.
Method get_segment_parameters Return the segment parameters for the top segment of the URL.
Method local_abspath Return the absolute path on the local filesystem.
Method has_multi Return True/False for each entry in relpaths
Method has_any Return True if any of the paths exist.
Method readv Get parts of the file at the given relative path.
Method get_multi Get a list of file-like objects, one for each entry in relpaths.
Method mkdir_multi Create a group of directories
Method append_multi Append the text in each file-like or string object to
Method copy Copy the item at rel_from to the location at rel_to.
Method copy_multi Copy a bunch of entries.
Method copy_to Copy a set of entries from self into another Transport.
Method copy_tree Copy a subtree from one relpath to another.
Method copy_tree_to_transport Copy a subtree from one transport to another.
Method move_multi Move a bunch of entries.
Method move_multi_to Move a bunch of entries to a single location.
Method delete_multi Queue up a bunch of deletes to be done.
Method delete_tree Delete an entire tree. This may require a listable transport.
Method __repr__ Undocumented
Method stat_multi Stat multiple files and return the information.
Method readlink Return a string representing the path to which the symbolic link points.
Method hardlink Create a hardlink pointing to source named link_name.
Method symlink Create a symlink pointing to source named link_name.
Method lock_read Lock the given file for shared (read) access.
Method lock_write Lock the given file for exclusive (write) access.
Method _pump Most children will need to copy from one file-like
Method _get_total Try to figure out how many entries are in multi,
Method _update_pb Update the progress bar based on the current count
Method _iterate_over Iterate over all entries in multi, passing them to func,
Method _seek_and_read An implementation of readv that uses fp.seek and fp.read.
Method _sort_expand_and_combine Helper for readv.
Static Method _coalesce_offsets Yield coalesced offsets.
Method _can_roundtrip_unix_modebits Return true if this transport can store and retrieve unix modebits.
Method _redirected_to Returns a transport suitable to re-issue a redirected request.
def _build_medium(self):
Create the medium if _from_transport does not provide one.

The medium is analogous to the connection for ConnectedTransport: it allows connection sharing.

API Documentation for Bazaar, generated by pydoctor at 2022-06-16 00:25:16.