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

mila-udem / fuel

Pull Request — master (#305)

fuel.utils.open_() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like