#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
**io.py**
**Platform:**
Windows, Linux, Mac Os X.
**Description:**
This module provides file input / output objects and resources manipulation objects.
**Others:**
"""
#**********************************************************************************************************************
#*** Future imports.
#**********************************************************************************************************************
from __future__ import unicode_literals
#**********************************************************************************************************************
#*** External imports.
#**********************************************************************************************************************
import codecs
import os
import shutil
import urllib2
#**********************************************************************************************************************
#*** Internal imports.
#**********************************************************************************************************************
import foundations.common
import foundations.verbose
import foundations.exceptions
import foundations.strings
from foundations.globals.constants import Constants
#**********************************************************************************************************************
#*** Module attributes.
#**********************************************************************************************************************
__author__ = "Thomas Mansencal"
__copyright__ = "Copyright (C) 2008 - 2013 - Thomas Mansencal"
__license__ = "GPL V3.0 - http://www.gnu.org/licenses/"
__maintainer__ = "Thomas Mansencal"
__email__ = "thomas.mansencal@gmail.com"
__status__ = "Production"
__all__ = ["LOGGER", "File", "setDirectory", "copy", "remove"]
LOGGER = foundations.verbose.installLogger()
#**********************************************************************************************************************
#*** Module classes and definitions.
#**********************************************************************************************************************
[docs]class File(object):
"""
This class provides methods to read / write and append to files or retrieve online file content.
"""
def __init__(self, path=None, content=None):
"""
.. Sphinx: Statements updated for auto-documentation purpose.
Usage::
>>> file = File(u"file.txt")
>>> file.content = [u"Some file content ...\\n", u"... ready to be saved!\\n"]
>>> file.write()
True
>>> file.read()
u'Some file content ...\\n... ready to be saved!\\n'
:param path: File path. ( String )
:param content: Content. ( List )
"""
LOGGER.debug("> Initializing '{0}()' class.".format(self.__class__.__name__))
# --- Setting class attributes. ---
self.__path = None
self.path = path
self.__content = None
self.content = content or []
#******************************************************************************************************************
#*** Attributes properties.
#******************************************************************************************************************
@property
def path(self):
"""
This method is the property for **self.__path** attribute.
:return: self.__path. ( String )
"""
return self.__path
@path.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(AssertionError)
def path(self, value):
"""
This method is the setter method for **self.__path** attribute.
:param value: Attribute value. ( String )
"""
if value is not None:
assert type(value) is unicode, "'{0}' attribute: '{1}' type is not 'unicode'!".format("path", value)
self.__path = value
@path.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def path(self):
"""
This method is the deleter method for **self.__path** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "path"))
@property
def content(self):
"""
This method is the property for **self.__content** attribute.
:return: self.__content. ( List )
"""
return self.__content
@content.setter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(AssertionError)
def content(self, value):
"""
This method is the setter method for **self.__content** attribute.
:param value: Attribute value. ( List )
"""
if value is not None:
assert type(value) is list, "'{0}' attribute: '{1}' type is not 'list'!".format("content", value)
self.__content = value
@content.deleter
#*** Sphinx: Decorator commented for auto-documentation purpose. @foundations.exceptions.handleExceptions(foundations.exceptions.ProgrammingError)
[docs] def content(self):
"""
This method is the deleter method for **self.__content** attribute.
"""
raise foundations.exceptions.ProgrammingError(
"{0} | '{1}' attribute is not deletable!".format(self.__class__.__name__, "content"))
#******************************************************************************************************************
#*** Class methods.
#******************************************************************************************************************
[docs] def cache(self, mode="r", encoding=Constants.encodingCodec, errors=Constants.encodingError):
"""
This method reads given file content and stores it in the content cache.
:param mode: File read mode. ( String )
:param encoding: File encoding codec. ( String )
:param errors: File encoding errors handling. ( String )
:return: Method success. ( Boolean )
"""
self.uncache()
if foundations.strings.isWebsite(self.__path):
try:
LOGGER.debug("> Caching '{0}' online file content.".format(self.__path))
self.__content = urllib2.urlopen(self.__path).readlines()
return True
except urllib2.URLError as error:
LOGGER.warning(
"!> {0} | Cannot read '{1}' online file: '{2}'.".format(self.__class__.__name__, self.__path, error))
elif foundations.common.pathExists(self.__path):
with codecs.open(self.__path, mode, encoding, errors) as file:
LOGGER.debug("> Caching '{0}' file content.".format(self.__path))
self.__content = file.readlines()
return True
return False
[docs] def uncache(self):
"""
This method uncaches the cached content.
:return: Method success. ( Boolean )
"""
LOGGER.debug("> Uncaching '{0}' file content.".format(self.__path))
self.__content = []
return True
[docs] def read(self):
"""
This method returns defined file content.
:return: File content. ( String )
"""
return "".join(self.__content) if self.cache() else ""
[docs] def write(self, mode="w", encoding=Constants.encodingCodec, errors=Constants.encodingError):
"""
This method writes content to defined file.
:param mode: File write mode. ( String )
:param encoding: File encoding codec. ( String )
:param errors: File encoding errors handling. ( String )
:return: Method success. ( Boolean )
"""
if foundations.strings.isWebsite(self.__path):
LOGGER.warning("!> {0} | Cannot write to '{1}' online file!".format(self.__class__.__name__, self.__path))
return False
with codecs.open(self.__path, mode, encoding, errors) as file:
LOGGER.debug("> Writting '{0}' file content.".format(self.__path))
for line in self.__content:
file.write(line)
return True
return False
[docs] def append(self, mode="a", encoding=Constants.encodingCodec, errors=Constants.encodingError):
"""
This method appends content to defined file.
:param mode: File write mode. ( String )
:param encoding: File encoding codec. ( String )
:param errors: File encoding errors handling. ( String )
:return: Method success. ( Boolean )
"""
if foundations.strings.isWebsite(self.__path):
LOGGER.warning("!> {0} | Cannot append to '{1}' online file!".format(self.__class__.__name__, self.__path))
return False
with codecs.open(self.__path, mode, encoding, errors) as file:
LOGGER.debug("> Appending to '{0}' file content.".format(self.__path))
for line in self.__content:
file.write(line)
return True
return False
[docs] def clear(self, encoding=Constants.encodingCodec):
"""
This method clears the defined file content.
:param encoding: File encoding codec. ( String )
:return: Method success. ( Boolean )
"""
if foundations.strings.isWebsite(self.__path):
LOGGER.warning("!> {0} | Cannot clear '{1}' online file!".format(self.__class__.__name__, self.__path))
return False
if self.uncache():
LOGGER.debug("> Clearing '{0}' file content.".format(self.__path))
return self.write(encoding=encoding)
else:
return False
[docs]def setDirectory(path):
"""
| This definition creates a directory with given path.
| The directory creation is delegated to
Python :func:`os.makedirs` definition so that directories hierarchy is recursively created.
:param path: Directory path. ( String )
:return: Definition success. ( Boolean )
"""
if not foundations.common.pathExists(path):
LOGGER.debug("> Creating directory: '{0}'.".format(path))
os.makedirs(path)
return True
else:
LOGGER.debug("> '{0}' directory already exist, skipping creation!".format(path))
return True
[docs]def copy(source, destination):
"""
This definition copies the given file or directory to destination.
:param source: Source to copy from. ( String )
:param destination: Destination to copy to. ( String )
:return: Method success. ( Boolean )
"""
if os.path.isfile(source):
LOGGER.debug("> Copying '{0}' file to '{1}'.".format(source, destination))
shutil.copyfile(source, destination)
else:
LOGGER.debug("> Copying '{0}' directory to '{1}'.".format(source, destination))
shutil.copytree(source, destination)
return True
[docs]def remove(path):
"""
This definiton removes the given file or directory.
:param path: Resource to remove. ( String )
:return: Method success. ( Boolean )
"""
if os.path.isfile(path):
LOGGER.debug("> Removing '{0}' file.".format(path))
os.remove(path)
elif os.path.isdir(path):
LOGGER.debug("> Removing '{0}' directory.".format(path))
shutil.rmtree(path)
return True