| | |
- builtins.OSError(builtins.Exception)
-
- SmbError
-
- ConnectionRefusedError
- ExistsError
- NoEntryError
- NoSpaceError
- NotDirectoryError
- NotEmptyError
- PermissionError
- TimedOutError
- builtins.object
-
- Context
- Dir
- Dirent
- File
class ConnectionRefusedError(SmbError) |
| | |
- Method resolution order:
- ConnectionRefusedError
- SmbError
- builtins.OSError
- builtins.Exception
- builtins.BaseException
- builtins.object
Data descriptors inherited from SmbError:
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from builtins.OSError:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __reduce__(...)
- Helper for pickle.
- __str__(self, /)
- Return str(self).
Static methods inherited from builtins.OSError:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data descriptors inherited from builtins.OSError:
- characters_written
- errno
- POSIX exception code
- filename
- exception filename
- filename2
- second exception filename
- strerror
- exception strerror
Methods inherited from builtins.BaseException:
- __delattr__(self, name, /)
- Implement delattr(self, name).
- __getattribute__(self, name, /)
- Return getattr(self, name).
- __repr__(self, /)
- Return repr(self).
- __setattr__(self, name, value, /)
- Implement setattr(self, name, value).
- __setstate__(...)
- with_traceback(...)
- Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.
Data descriptors inherited from builtins.BaseException:
- __cause__
- exception cause
- __context__
- exception context
- __dict__
- __suppress_context__
- __traceback__
- args
|
class Context(builtins.object) |
| |
SMBC context
============
A context for libsmbclient calls.
Optional parameters are:
auth_fn: a function for collecting authentication details from
the user. This is called whenever authentication details are needed.
The parameters it will be given are all strings: server, share,
workgroup, username, and password (these last two can be ignored).
The function should return a tuple of strings: workgroup, username,
and password.
debug: an integer representing the debug level to use.
|
| |
Methods defined here:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- chmod(...)
- chmod(uri, mode) -> int
@type uri: string
@param uri: URI to chmod
@type mode: int
@param mode: permissions to set
@return: 0 on success, < 0 on error
- creat(...)
- creat(uri) -> File
@type uri: string
@param uri: URI to creat
@return: a L{smbc.File} object for the URI
- getxattr(...)
- getxattr(uri, the_acl) -> int
@type uri: string
@param uri: URI to scan
@type name: string
@param name: the acl to get with the following syntax
system.nt_sec_desc.<attribute name>
system.nt_sec_desc.*
system.nt_sec_desc.*+
where <attribute name> is one of:
revision
owner
owner+
group
group+
acl:<name or sid>
acl+:<name or sid>
In the forms "system.nt_sec_desc.*" and
"system.nt_sec_desc.*+", the asterisk and plus signs are
literal, i.e. the string is provided exactly as shown, and
the value parameter will return a complete security
descriptor with name:value pairs separated by tabs,
commas, or newlines (not spaces!).
The plus sign ('+') indicates that SIDs should be mapped
to names. Without the plus sign, SIDs are not mapped;
rather they are simply converted to a string format.
@return: a string representing the actual extended attributes of the uri
- mkdir(...)
- mkdir(uri, mode) -> int
@type uri: string
@param uri: URI to mkdir
@param mode: Specifies the permissions to use.
@return: 0 on success, < 0 on error
- open(...)
- open(uri) -> File
@type uri: string
@param uri: URI to open
@return: a L{smbc.File} object for the URI
- opendir(...)
- opendir(uri) -> Dir
@type uri: string
@param uri: URI to opendir
@return: a L{smbc.Dir} object for the URI
- rename(...)
- rename(ouri, nuri) -> int
@type ouri: string
@param ouri: The original smb uri
@type nuri: string
@param nuri: The new smb uri
@return: 0 on success, < 0 on error
- rmdir(...)
- rmdir(uri) -> int
@type uri: string
@param uri: URI to rmdir
@return: 0 on success, < 0 on error
- set_credentials_with_fallback(...)
- set_credentials_with_fallback(workgroup, user, password)
@type workgroup: string
@param workgroup: Workgroup of user
@type user: string
@param user: Username of user
@type password: string
@param password: Password of user
- setxattr(...)
- setxattr(uri, the_acl) -> int
@type uri: string
@param uri: URI to modify
@type name: string
@param name: the acl to set with the following syntax
system.nt_sec_desc.<attribute name>
system.nt_sec_desc.*
system.nt_sec_desc.*+
where <attribute name> is one of:
revision
owner
owner+
group
group+
acl:<name or sid>
acl+:<name or sid>
In the forms "system.nt_sec_desc.*" and
"system.nt_sec_desc.*+", the asterisk and plus signs are
literal, i.e. the string is provided exactly as shown, and
the value parameter will return a complete security
descriptor with name:value pairs separated by tabs,
commas, or newlines (not spaces!).
The plus sign ('+') indicates that SIDs should be mapped
to names. Without the plus sign, SIDs are not mapped;
rather they are simply converted to a string format.
@type string
@param value - a string representing the acl
@type int
@param flags - XATTR_FLAG_CREATE or XATTR_FLAG_REPLACE
@return: 0 on success
- stat(...)
- stat(uri) -> tuple
@type uri: string
@param uri: URI to get stat information
@return: stat information
- unlink(...)
- unlink(uri) -> int
@type uri: string
@param uri: URI to unlink
@return: 0 on success, < 0 on error
Static methods defined here:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data descriptors defined here:
- debug
- Debug level.
- functionAuthData
- Function for obtaining authentication data.
- netbiosName
- Netbios name used for making connections.
- optionDebugToStderr
- Whether to log to standard error instead of standard output.
- optionFallbackAfterKerberos
- Whether to fallback after Kerberos.
- optionFullTimeNames
- Use full time names (Create Time)
- optionNoAutoAnonymousLogin
- Whether to automatically select anonymous login.
- optionUseKerberos
- Whether to enable use of Kerberos.
- port
- Set the TCP port used to connect (0 means default).
- timeout
- Get the timeout used for waiting on connections and response data(in milliseconds)
- workgroup
- Workgroup used for making connections.
|
class Dirent(builtins.object) |
| |
SMBC Dirent
===========
A directory entry object.
|
| |
Methods defined here:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __repr__(self, /)
- Return repr(self).
Static methods defined here:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data descriptors defined here:
- comment
- comment
- name
- name
- smbc_type
- smbc_type
|
class ExistsError(SmbError) |
| | |
- Method resolution order:
- ExistsError
- SmbError
- builtins.OSError
- builtins.Exception
- builtins.BaseException
- builtins.object
Data descriptors inherited from SmbError:
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from builtins.OSError:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __reduce__(...)
- Helper for pickle.
- __str__(self, /)
- Return str(self).
Static methods inherited from builtins.OSError:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data descriptors inherited from builtins.OSError:
- characters_written
- errno
- POSIX exception code
- filename
- exception filename
- filename2
- second exception filename
- strerror
- exception strerror
Methods inherited from builtins.BaseException:
- __delattr__(self, name, /)
- Implement delattr(self, name).
- __getattribute__(self, name, /)
- Return getattr(self, name).
- __repr__(self, /)
- Return repr(self).
- __setattr__(self, name, value, /)
- Implement setattr(self, name, value).
- __setstate__(...)
- with_traceback(...)
- Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.
Data descriptors inherited from builtins.BaseException:
- __cause__
- exception cause
- __context__
- exception context
- __dict__
- __suppress_context__
- __traceback__
- args
|
class File(builtins.object) |
| |
SMBC File
=========
A file object.
|
| |
Methods defined here:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __iter__(self, /)
- Implement iter(self).
- __next__(self, /)
- Implement next(self).
- close(...)
- close() -> int
@return: on success, < 0 on error
- flush(...)
- flush()
@return: NOP function
- fstat(...)
- fstat() -> tuple
@return: fstat information
- lseek(...)
- lseek(offset, whence=0)
@return: on success, current offset location, othwerwise -1
- read(...)
- read(size) -> string
@type size: int
@param size: size of reading
@return: read data
- readinto(...)
- readinto(b) -> int
@type b: writable bytes-like object
@param b: buffer to fill
@return: number of bytes read
- seek(...)
- seek(offset, whence=0)
@return: on success, current offset location, othwerwise -1
- seekable(...)
- seekable() -> bool
@return: determine if seekable
- tell(...)
- tell() -> int
@return: on success, current location, othwerwise -1
- write(...)
- write(buf) -> int
@type buf: string
@param buf: write data
@return: size of written
Static methods defined here:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
|
class NoEntryError(SmbError) |
| | |
- Method resolution order:
- NoEntryError
- SmbError
- builtins.OSError
- builtins.Exception
- builtins.BaseException
- builtins.object
Data descriptors inherited from SmbError:
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from builtins.OSError:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __reduce__(...)
- Helper for pickle.
- __str__(self, /)
- Return str(self).
Static methods inherited from builtins.OSError:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data descriptors inherited from builtins.OSError:
- characters_written
- errno
- POSIX exception code
- filename
- exception filename
- filename2
- second exception filename
- strerror
- exception strerror
Methods inherited from builtins.BaseException:
- __delattr__(self, name, /)
- Implement delattr(self, name).
- __getattribute__(self, name, /)
- Return getattr(self, name).
- __repr__(self, /)
- Return repr(self).
- __setattr__(self, name, value, /)
- Implement setattr(self, name, value).
- __setstate__(...)
- with_traceback(...)
- Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.
Data descriptors inherited from builtins.BaseException:
- __cause__
- exception cause
- __context__
- exception context
- __dict__
- __suppress_context__
- __traceback__
- args
|
class NoSpaceError(SmbError) |
| | |
- Method resolution order:
- NoSpaceError
- SmbError
- builtins.OSError
- builtins.Exception
- builtins.BaseException
- builtins.object
Data descriptors inherited from SmbError:
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from builtins.OSError:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __reduce__(...)
- Helper for pickle.
- __str__(self, /)
- Return str(self).
Static methods inherited from builtins.OSError:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data descriptors inherited from builtins.OSError:
- characters_written
- errno
- POSIX exception code
- filename
- exception filename
- filename2
- second exception filename
- strerror
- exception strerror
Methods inherited from builtins.BaseException:
- __delattr__(self, name, /)
- Implement delattr(self, name).
- __getattribute__(self, name, /)
- Return getattr(self, name).
- __repr__(self, /)
- Return repr(self).
- __setattr__(self, name, value, /)
- Implement setattr(self, name, value).
- __setstate__(...)
- with_traceback(...)
- Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.
Data descriptors inherited from builtins.BaseException:
- __cause__
- exception cause
- __context__
- exception context
- __dict__
- __suppress_context__
- __traceback__
- args
|
class NotDirectoryError(SmbError) |
| | |
- Method resolution order:
- NotDirectoryError
- SmbError
- builtins.OSError
- builtins.Exception
- builtins.BaseException
- builtins.object
Data descriptors inherited from SmbError:
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from builtins.OSError:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __reduce__(...)
- Helper for pickle.
- __str__(self, /)
- Return str(self).
Static methods inherited from builtins.OSError:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data descriptors inherited from builtins.OSError:
- characters_written
- errno
- POSIX exception code
- filename
- exception filename
- filename2
- second exception filename
- strerror
- exception strerror
Methods inherited from builtins.BaseException:
- __delattr__(self, name, /)
- Implement delattr(self, name).
- __getattribute__(self, name, /)
- Return getattr(self, name).
- __repr__(self, /)
- Return repr(self).
- __setattr__(self, name, value, /)
- Implement setattr(self, name, value).
- __setstate__(...)
- with_traceback(...)
- Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.
Data descriptors inherited from builtins.BaseException:
- __cause__
- exception cause
- __context__
- exception context
- __dict__
- __suppress_context__
- __traceback__
- args
|
class NotEmptyError(SmbError) |
| | |
- Method resolution order:
- NotEmptyError
- SmbError
- builtins.OSError
- builtins.Exception
- builtins.BaseException
- builtins.object
Data descriptors inherited from SmbError:
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from builtins.OSError:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __reduce__(...)
- Helper for pickle.
- __str__(self, /)
- Return str(self).
Static methods inherited from builtins.OSError:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data descriptors inherited from builtins.OSError:
- characters_written
- errno
- POSIX exception code
- filename
- exception filename
- filename2
- second exception filename
- strerror
- exception strerror
Methods inherited from builtins.BaseException:
- __delattr__(self, name, /)
- Implement delattr(self, name).
- __getattribute__(self, name, /)
- Return getattr(self, name).
- __repr__(self, /)
- Return repr(self).
- __setattr__(self, name, value, /)
- Implement setattr(self, name, value).
- __setstate__(...)
- with_traceback(...)
- Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.
Data descriptors inherited from builtins.BaseException:
- __cause__
- exception cause
- __context__
- exception context
- __dict__
- __suppress_context__
- __traceback__
- args
|
class PermissionError(SmbError) |
| | |
- Method resolution order:
- PermissionError
- SmbError
- builtins.OSError
- builtins.Exception
- builtins.BaseException
- builtins.object
Data descriptors inherited from SmbError:
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from builtins.OSError:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __reduce__(...)
- Helper for pickle.
- __str__(self, /)
- Return str(self).
Static methods inherited from builtins.OSError:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data descriptors inherited from builtins.OSError:
- characters_written
- errno
- POSIX exception code
- filename
- exception filename
- filename2
- second exception filename
- strerror
- exception strerror
Methods inherited from builtins.BaseException:
- __delattr__(self, name, /)
- Implement delattr(self, name).
- __getattribute__(self, name, /)
- Return getattr(self, name).
- __repr__(self, /)
- Return repr(self).
- __setattr__(self, name, value, /)
- Implement setattr(self, name, value).
- __setstate__(...)
- with_traceback(...)
- Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.
Data descriptors inherited from builtins.BaseException:
- __cause__
- exception cause
- __context__
- exception context
- __dict__
- __suppress_context__
- __traceback__
- args
|
class SmbError(builtins.OSError) |
| | |
- Method resolution order:
- SmbError
- builtins.OSError
- builtins.Exception
- builtins.BaseException
- builtins.object
Data descriptors defined here:
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from builtins.OSError:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __reduce__(...)
- Helper for pickle.
- __str__(self, /)
- Return str(self).
Static methods inherited from builtins.OSError:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data descriptors inherited from builtins.OSError:
- characters_written
- errno
- POSIX exception code
- filename
- exception filename
- filename2
- second exception filename
- strerror
- exception strerror
Methods inherited from builtins.BaseException:
- __delattr__(self, name, /)
- Implement delattr(self, name).
- __getattribute__(self, name, /)
- Return getattr(self, name).
- __repr__(self, /)
- Return repr(self).
- __setattr__(self, name, value, /)
- Implement setattr(self, name, value).
- __setstate__(...)
- with_traceback(...)
- Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.
Data descriptors inherited from builtins.BaseException:
- __cause__
- exception cause
- __context__
- exception context
- __dict__
- __suppress_context__
- __traceback__
- args
|
class TimedOutError(SmbError) |
| | |
- Method resolution order:
- TimedOutError
- SmbError
- builtins.OSError
- builtins.Exception
- builtins.BaseException
- builtins.object
Data descriptors inherited from SmbError:
- __weakref__
- list of weak references to the object (if defined)
Methods inherited from builtins.OSError:
- __init__(self, /, *args, **kwargs)
- Initialize self. See help(type(self)) for accurate signature.
- __reduce__(...)
- Helper for pickle.
- __str__(self, /)
- Return str(self).
Static methods inherited from builtins.OSError:
- __new__(*args, **kwargs) from builtins.type
- Create and return a new object. See help(type) for accurate signature.
Data descriptors inherited from builtins.OSError:
- characters_written
- errno
- POSIX exception code
- filename
- exception filename
- filename2
- second exception filename
- strerror
- exception strerror
Methods inherited from builtins.BaseException:
- __delattr__(self, name, /)
- Implement delattr(self, name).
- __getattribute__(self, name, /)
- Return getattr(self, name).
- __repr__(self, /)
- Return repr(self).
- __setattr__(self, name, value, /)
- Implement setattr(self, name, value).
- __setstate__(...)
- with_traceback(...)
- Exception.with_traceback(tb) --
set self.__traceback__ to tb and return self.
Data descriptors inherited from builtins.BaseException:
- __cause__
- exception cause
- __context__
- exception context
- __dict__
- __suppress_context__
- __traceback__
- args
| |