def close(self):
"""
python.org: Flush and close this stream.
:since: v1.0.0
"""
raise NotImplementedException()
def free(self):
"""
Frees all watcher callbacks for garbage collection.
:since: v1.0.0
"""
raise NotImplementedException()
def disable():
"""
Disables this watcher and frees all callbacks for garbage collection.
:since: v1.0.0
"""
raise NotImplementedException()
def implementing_scheme(self):
"""
Returns the implementing scheme name.
:return: (str) Implementing scheme name
:since: v1.0.0
"""
raise NotImplementedException()
def url(self):
"""
Returns the URL of this VFS object.
:return: (str) VFS URL
:since: v1.0.0
"""
raise NotImplementedException()
def type(self):
"""
Returns the type of this object.
:return: (int) Object type
:since: v1.0.0
"""
raise NotImplementedException()
def size(self):
"""
Returns the size in bytes.
:return: (int) Size in bytes
:since: v1.0.0
"""
raise NotImplementedException()
def is_valid(self):
"""
Returns true if the object is available.
:return: (bool) True on success
:since: v1.0.0
"""
raise NotImplementedException()
def check(self, url):
"""
Checks a given URL for changes if "is_synchronous()" is true.
:param url: Resource URL
:since: v1.0.0
"""
raise NotImplementedException()
def warning(self, data, *args, **kwargs):
"""
Warning message method
:param data: Warning data
:param context: Logging context
:since: v1.0.0
"""
raise NotImplementedException()
def info(self, data, *args, **kwargs):
"""
Info message method
:param data: Info data
:param context: Logging context
:since: v1.0.0
"""
raise NotImplementedException()
def is_file_cached(self, file_path_name):
"""
Return true if the given file path and name is cached.
:param file_path_name: Cached file path and name
:return: (bool) True if currently cached
:since: v1.0.0
"""
raise NotImplementedException()
def is_vfs_url_cached(self, vfs_url):
"""
Return true if the given VFS URL is cached.
:param vfs_url: VFS URL
:return: (bool) True if currently cached
:since: v1.0.0
"""
raise NotImplementedException()
def get_from_vfs_url(self, vfs_url):
"""
Get the content for the given VFS URL cached.
:param vfs_url: VFS URL
:return: (mixed) VFS URL content cached
:since: v1.0.0
"""
raise NotImplementedException()
def open(self, vfs_url, readonly=False):
"""
Opens a VFS object. The handle is set at the beginning of the object.
:param vfs_url: VFS URL
:param readonly: Open object in readonly mode
:since: v1.0.0
"""
raise NotImplementedException()
def error(self, data, *args, **kwargs):
"""
Error message method
:param data: Error data
:param context: Logging context
:since: v1.0.0
"""
raise NotImplementedException()
def get_from_file(self, file_path_name):
"""
Get the content for the given file path and name cached.
:param file_path_name: File path and name
:return: (mixed) File content cached
:since: v1.0.0
"""
raise NotImplementedException()
def get_module(package_module, autoload=True):
"""
Get the module for the specified package and module name.
:param package_module: Package and module name
:param autoload: True to load the module automatically if not done already.
:return: (object) Python module; None on error
:since: v1.0.6
"""
raise NotImplementedException()
def reload(package_module, clear_caches=True):
"""
Reloads the the specified package module.
:param package_module: Package and module name
:param clear_caches: True to clear import caches before reloading
:return: (object) Reloaded module on success
:since: v1.0.6
"""
raise NotImplementedException()
def set_file(self, file_path_name, content, content_size = None):
"""
Fill the cache for the given file path and name with the given cached content.
:param file_path_name: File path and name
:param content: Cached entry content
:param content_size: Size of the cached entry content
:since: v1.0.0
"""
raise NotImplementedException()
def unregister(self, url, callback):
"""
Handles deregistration of resource URL watches.
:param url: Resource URL watched
:param callback: Callback for the path
:return: (bool) True on success
:since: v1.0.0
"""
raise NotImplementedException()
def is_defined(package_module, autoload=True):
"""
Checks if the specified package, module and class name is defined or can be
resolved after auto loading it.
:param package_module: Package and module name
:param autoload: True to load the class module automatically if not done
already.
:return: (bool) True if defined or resolvable
:since: v1.0.6
"""
raise NotImplementedException()
def is_watched(self, url, callback = None):
"""
Returns true if the resource URL is already watched. It will return false
if a callback is given but not defined for the watched URL.
:param url: Resource URL
:param callback: Callback to be checked for the watched resource URL
:return: (bool) True if watched with the defined callback or any if not
defined.
:since: v1.0.0
"""
raise NotImplementedException()
def set_vfs_url(self,
vfs_url,
content,
content_size=None,
is_compatibility_checked=False):
"""
Fill the cache for the given VFS URL with the given cached content.
:param vfs_url: VFS URL
:param content: Cached entry content
:param content_size: Size of the cached entry content
:since: v1.0.0
"""
raise NotImplementedException()