fuel.utils.open_() - Code Metrics - Inspection of "UTF-8 and Gzip for text files" - mila-udem/fuel - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#305)

by Bart

created 2016-02-02 15:09 UTC

fuel.utils.open_() A

↳ Parent: Project

Complexity

Conditions

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Metric	Value
cc	2
dl	0
loc	23
rs	9.0856

"""Low-level utilities for reading a variety of source formats."""
import codecs
import gzip
import tarfile
import six


def open_(filename, mode='r', encoding='utf-8'):
    """Open a text file with UTF-8 and optional gzip compression.

    This function is useful when dealing with text files.

    Parameters
    ----------
    filename : str
        The filename to read.
    mode : str, optional
        The mode with which to open the file. Defaults to `r`.
    encoding : str, optional
        The encoding to use (see the codecs documentation_ for supported
        values). Defaults to `utf-8`.

    .. _documentation:
    https://docs.python.org/3/library/codecs.html#standard-encodings

    """
    if filename.endswith('.gz.'):
        zf = gzip.open(filename, mode)
        return codecs.getreader(encoding)(zf)
    return codecs.open(filename, mode, encoding=encoding)


def tar_open(f):
    """Open either a filename or a file-like object as a TarFile.

    Parameters
    ----------
    f : str or file-like object
        The filename or file-like object from which to read.

    Returns
    -------
    TarFile
        A `TarFile` instance.

    """
    if isinstance(f, six.string_types):
        return tarfile.open(name=f)
    else:
        return tarfile.open(fileobj=f)


1			"""Low-level utilities for reading a variety of source formats."""
2			import codecs
3			import gzip
4			import tarfile
5			import six
6
7
8			def open_(filename, mode='r', encoding='utf-8'):
9			"""Open a text file with UTF-8 and optional gzip compression.
10
11			This function is useful when dealing with text files.
12
13			Parameters
14			----------
15			filename : str
16			The filename to read.
17			mode : str, optional
18			The mode with which to open the file. Defaults to `r`.
19			encoding : str, optional
20			The encoding to use (see the codecs documentation_ for supported
21			values). Defaults to `utf-8`.
22
23			.. _documentation:
24			https://docs.python.org/3/library/codecs.html#standard-encodings
25
26			"""
27			if filename.endswith('.gz.'):
28			zf = gzip.open(filename, mode)
29			return codecs.getreader(encoding)(zf)
30			return codecs.open(filename, mode, encoding=encoding)
31
32
33			def tar_open(f):
34			"""Open either a filename or a file-like object as a TarFile.
35
36			Parameters
37			----------
38			f : str or file-like object
39			The filename or file-like object from which to read.
40
41			Returns
42			-------
43			TarFile
44			A `TarFile` instance.
45
46			"""
47			if isinstance(f, six.string_types):
48			return tarfile.open(name=f)
49			else:
50			return tarfile.open(fileobj=f)
51

mila-udem / fuel

Pull Request — master (#305)

fuel.utils.open_() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like