b2blaze.utilities.RangeStream.__enter__() - Code Metrics - sibblegp/b2blaze - Measure and Improve Code Quality continuously with Scrutinizer

b2blaze.utilities.RangeStream.enter() A
last analyzed 2018-10-30 20:38 UTC

↳ Parent: b2blaze.utilities

Complexity

Conditions

Size

Total Lines	3
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1.2963

Importance

Changes

Metric	Value
cc	1
eloc	3
nop	1
dl	0
loc	3
ccs	1
cts	3
cp	0.3333
crap	1.2963
rs	10
c	0
b	0
f	0

"""
Code used under MIT License from https://www.backblaze.com/b2/docs/string_encoding.html

Copyright (c) 2015 Backblaze
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:


The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


Additional code copyright George Sibble 2018
"""
import os
from hashlib import sha1

try:
    from urllib import quote, unquote_plus
except ImportError:
    from urllib.parse import quote, unquote_plus


def b2_url_encode(s):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    return quote(s.encode('utf-8'))


def b2_url_decode(s):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    return unquote_plus(str(s)).decode('utf-8')

def get_content_length(file):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    if hasattr(file, 'name') and os.path.isfile(file.name):
        return os.path.getsize(file.name)
    else:
        raise Exception('Content-Length could not be automatically determined.')

def decode_error(response):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    try:
        response_json = response.json()
        return str(response.status_code) + ' - ' + str(response_json)
    except ValueError:
        raise ValueError(str(response.status_code) + ' - Invalid JSON Response')

def get_part_ranges(content_length, part_size):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    parts = []
    next_offest = 0
    while content_length > 0:
        if content_length < part_size:
            part_size = content_length
        parts.append((next_offest, part_size))
        next_offest += part_size
        content_length -= part_size
    return parts

class RangeStream:

    """
    Wraps a file-like object (read only) and reads the selected
    range of the file.
    """

    def __init__(self, stream, offset, length):
        """

        :param stream:
        :param offset:
        :param length:
        :return: None
        """
        self.stream = stream
        self.offset = offset
        self.remaining = length

    def __enter__(self):
        self.stream.__enter__()
        return self

    def __exit__(self, exc_type, exc_val, exc_tb):
        return self.stream.__exit__(exc_type, exc_val, exc_tb)

    def seek(self, pos):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.stream.seek(self.offset + pos)

    def read(self, size=None):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        if size is None:
            to_read = self.remaining
        else:
            to_read = min(size, self.remaining)
        data = self.stream.read(to_read)
        self.remaining -= len(data)
        return data

class StreamWithHashProgress:

    """
    Wraps a file-like object (read-only), hashes on-the-fly, and
    updates a progress_listener as data is read.
    """

    def __init__(self, stream, progress_listener=None):
        """

        :param stream:
        :param progress_listener:
        :return: None
        """
        self.stream = stream
        self.progress_listener = progress_listener
        self.bytes_completed = 0
        self.digest = sha1()
        self.hash = None
        self.hash_read = 0

    def __enter__(self):
        return self

    def __exit__(self, exc_type, exc_val, exc_tb):
        return self.stream.__exit__(exc_type, exc_val, exc_tb)

    def read(self, size=None):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        data = b''
        if self.hash is None:
            # Read some bytes from stream
            if size is None:
                data = self.stream.read()
            else:
                data = self.stream.read(size)

            # Update hash
            self.digest.update(data)

            # Check for end of stream
            if size is None or len(data) < size:
                self.hash = self.digest.hexdigest()
                if size is not None:
                    size -= len(data)

            # Update progress listener
            self._update(len(data))

        else:
            # The end of stream was reached, return hash now
            size = size or len(self.hash)
            data += str.encode(self.hash[self.hash_read:self.hash_read + size])
            self.hash_read += size

        return data

    def _update(self, delta):
        self.bytes_completed += delta
        if self.progress_listener is not None:
            self.progress_listener(self.bytes_completed)

    def get_hash(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        return self.hash

    def hash_size(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        return self.digest.digest_size * 2


1		"""
2		Code used under MIT License from https://www.backblaze.com/b2/docs/string_encoding.html
3
4		Copyright (c) 2015 Backblaze
5		Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
		0 ignored issues – show Coding Style introduced 2018-06-27 20:20 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (432/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
6
7		The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
		0 ignored issues – show Coding Style introduced 2018-06-27 20:20 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (126/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
8		THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
		0 ignored issues – show Coding Style introduced 2018-06-27 20:20 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (460/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
9
10		Additional code copyright George Sibble 2018
11		"""
12	1	import os
13	1	from hashlib import sha1
14
15	1	try:
16	1	from urllib import quote, unquote_plus
17		except ImportError:
18		from urllib.parse import quote, unquote_plus
19
20
21	1	def b2_url_encode(s):
		0 ignored issues – show Coding Style introduced 2018-06-28 21:45 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history... Coding Style Naming introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report The name `s` does not conform to the argument naming conventions (`(([a-z][a-z0-9_]{2,30})\|(_[a-z0-9_]*))$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
22	1	return quote(s.encode('utf-8'))
23
24
25	1	def b2_url_decode(s):
		0 ignored issues – show Coding Style introduced 2018-06-28 21:45 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history... Coding Style Naming introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report The name `s` does not conform to the argument naming conventions (`(([a-z][a-z0-9_]{2,30})\|(_[a-z0-9_]*))$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
26		return unquote_plus(str(s)).decode('utf-8')
27
28	1	def get_content_length(file):
		0 ignored issues – show Bug Best Practice introduced 2018-07-23 06:58 UTC by Report Bug Copy Issue Report This seems to re-define the built-in `file`. It is generally discouraged to redefine built-ins as this makes code very hard to read. Loading history... Coding Style introduced 2018-07-23 06:58 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
29	1	if hasattr(file, 'name') and os.path.isfile(file.name):
30	1	return os.path.getsize(file.name)
31		else:
32		raise Exception('Content-Length could not be automatically determined.')
33
34	1	def decode_error(response):
		0 ignored issues – show Coding Style introduced 2018-07-23 06:58 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
35		try:
36		response_json = response.json()
37		return str(response.status_code) + ' - ' + str(response_json)
38		except ValueError:
39		raise ValueError(str(response.status_code) + ' - Invalid JSON Response')
40
41	1	def get_part_ranges(content_length, part_size):
		0 ignored issues – show Coding Style introduced 2018-07-23 06:58 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
42		parts = []
43		next_offest = 0
44		while content_length > 0:
45		if content_length < part_size:
46		part_size = content_length
47		parts.append((next_offest, part_size))
48		next_offest += part_size
49		content_length -= part_size
50		return parts
51
52	1	class RangeStream:
		0 ignored issues – show introduced 2018-07-23 06:58 UTC by Report Bug Copy Issue Report Old-style class defined. Loading history...
53		"""
54		Wraps a file-like object (read only) and reads the selected
55		range of the file.
56		"""
57
58	1	def __init__(self, stream, offset, length):
59		"""
60
61		:param stream:
62		:param offset:
63		:param length:
64		:return: None
65		"""
66		self.stream = stream
67		self.offset = offset
68		self.remaining = length
69
70	1	def __enter__(self):
71		self.stream.__enter__()
72		return self
73
74	1	def __exit__(self, exc_type, exc_val, exc_tb):
75		return self.stream.__exit__(exc_type, exc_val, exc_tb)
76
77	1	def seek(self, pos):
		0 ignored issues – show Coding Style introduced 2018-07-23 06:58 UTC by Report Bug Copy Issue Report This method should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
78		self.stream.seek(self.offset + pos)
79
80	1	def read(self, size=None):
		0 ignored issues – show Coding Style introduced 2018-07-23 06:58 UTC by Report Bug Copy Issue Report This method should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
81		if size is None:
82		to_read = self.remaining
83		else:
84		to_read = min(size, self.remaining)
85		data = self.stream.read(to_read)
86		self.remaining -= len(data)
87		return data
88
89	1	class StreamWithHashProgress:
		0 ignored issues – show introduced 2018-07-23 06:58 UTC by Report Bug Copy Issue Report Old-style class defined. Loading history...
90		"""
91		Wraps a file-like object (read-only), hashes on-the-fly, and
92		updates a progress_listener as data is read.
93		"""
94
95	1	def __init__(self, stream, progress_listener=None):
96		"""
97
98		:param stream:
99		:param progress_listener:
100		:return: None
101		"""
102	1	self.stream = stream
103	1	self.progress_listener = progress_listener
104	1	self.bytes_completed = 0
105	1	self.digest = sha1()
106	1	self.hash = None
107	1	self.hash_read = 0
108
109	1	def __enter__(self):
110		return self
111
112	1	def __exit__(self, exc_type, exc_val, exc_tb):
113		return self.stream.__exit__(exc_type, exc_val, exc_tb)
114
115	1	def read(self, size=None):
		0 ignored issues – show Coding Style introduced 2018-07-23 06:58 UTC by Report Bug Copy Issue Report This method should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
116	1	data = b''
117	1	if self.hash is None:
118		# Read some bytes from stream
119	1	if size is None:
120		data = self.stream.read()
121		else:
122	1	data = self.stream.read(size)
123
124		# Update hash
125	1	self.digest.update(data)
126
127		# Check for end of stream
128	1	if size is None or len(data) < size:
129	1	self.hash = self.digest.hexdigest()
130	1	if size is not None:
131	1	size -= len(data)
132
133		# Update progress listener
134	1	self._update(len(data))
135
136		else:
137		# The end of stream was reached, return hash now
138	1	size = size or len(self.hash)
139	1	data += str.encode(self.hash[self.hash_read:self.hash_read + size])
140	1	self.hash_read += size
141
142	1	return data
143
144	1	def _update(self, delta):
145	1	self.bytes_completed += delta
146	1	if self.progress_listener is not None:
147		self.progress_listener(self.bytes_completed)
148
149	1	def get_hash(self):
		0 ignored issues – show Coding Style introduced 2018-07-23 06:58 UTC by Report Bug Copy Issue Report This method should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
150		return self.hash
151
152	1	def hash_size(self):
		0 ignored issues – show Coding Style introduced 2018-07-23 06:58 UTC by Report Bug Copy Issue Report This method should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
153		return self.digest.digest_size * 2
154

sibblegp / b2blaze

GitHub Access Token became invalid

b2blaze.utilities.RangeStream.__enter__() A last analyzed 2018-10-30 20:38 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

b2blaze.utilities.RangeStream.enter() A
last analyzed 2018-10-30 20:38 UTC