b2blaze.models.b2_file.B2File.hide() - Code Metrics - sibblegp/b2blaze - Measure and Improve Code Quality continuously with Scrutinizer

b2blaze.models.b2_file.B2File.hide() A
last analyzed 2018-10-30 20:38 UTC

↳ Parent: b2blaze.models.b2_file

Complexity

Conditions

Size

Total Lines	15
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	2.0054

Importance

Changes

Metric	Value
cc	2
eloc	11
nop	1
dl	0
loc	15
ccs	8
cts	9
cp	0.8889
crap	2.0054
rs	9.85
c	0
b	0
f	0

"""
Copyright George Sibble 2018
"""
from io import BytesIO
from ..utilities import b2_url_encode, b2_url_decode, decode_error

from ..b2_exceptions import B2Exception
from ..api import API

class B2File(object):

    """

    """
    def __init__(self, connector, parent_list, fileId, fileName, contentSha1, contentLength, contentType,

                 fileInfo, action, uploadTimestamp, *args, **kwargs):
        """

        :param connector:
        :param parent_list:
        :param fileId:
        :param fileName:
        :param contentSha1:
        :param contentLength:
        :param contentType:
        :param fileInfo:
        :param action:
        :param uploadTimestamp:
        :param args:
        :param kwargs:
        """
        self.file_id = fileId
        # self.file_name_decoded = b2_url_decode(fileName)
         #TODO:  Find out if this is necessary

        self.file_name = fileName
        self.content_sha1 = contentSha1
        self.content_length = contentLength
        self.content_type = contentType
        self.file_info = fileInfo
        self.action = action
        self.uploadTimestamp = uploadTimestamp

        self.connector = connector
        self.parent_list = parent_list
        self.deleted = False

    def get_versions(self, limit=None): 

        """ Fetch list of all versions of the current file.
            Params:
                limit:              (int) Limit number of results returned (optional, default 10000)

            Returns:
                file_versions       (list) B2FileObject of all file versions
        """
        bucket_id = self.parent_list.bucket.bucket_id

        path = API.list_file_versions
        file_versions = []
        params = {
            'bucketId': bucket_id,
            'maxFileCount': limit or 10000,
            'startFileId': self.file_id,
            'startFileName': self.file_name,
        }

        response = self.connector.make_request(path=path, method='post', params=params)
        if response.status_code == 200:
            files_json = response.json()
            for file_json in files_json['files']:
                new_file = B2File(connector=self.connector, parent_list=self, **file_json)
                file_versions.append(new_file)
        else:
            raise B2Exception.parse(response)
        return file_versions
        


    def hide(self):
        """ Soft-delete a file (hide it from files list, but previous versions are saved.) """
        path = API.delete_file
        params = {
            'bucketId': self.parent_list.bucket.bucket_id,
            'fileName': b2_url_encode(self.file_name)
        }
        response = self.connector.make_request(path=path, method='post', params=params)
        if response.status_code == 200:
            self.deleted = True
            # Delete from parent list if exists
            self.parent_list._files_by_name.pop(self.file_name)
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
            self.parent_list._files_by_id.pop(self.file_id)
class MyParent:
    def __init__(self):
        self._x = 1;
        self.y = 2;

class MyChild(MyParent):
    def some_method(self):
        return self._x    # Ok, since accessed from a child class

class AnotherClass:
    def some_method(self, instance_of_my_child):
        return instance_of_my_child._x   # Would be flagged as AnotherClass is not
                                         # a child class of MyParent
        else:
            raise B2Exception.parse(response)


    def delete_all_versions(self, confirm=False):
        """ Delete completely all versions of a file. 

            ** NOTE THAT THIS CAN BE VERY EXPENSIVE IN TERMS OF YOUR API LIMITS **
            Each call to delete_all_versions will result in multiple API calls: 

                One API call per file version to be deleted, per file.
            1. Call '/b2_list_file_versions' to get file versions
            2. Call '/b2_delete_file_version' once for each version of the file

            This means: if you have 10 files with 50 versions each and call delete_all_versions, 

            you will spend (10 + 1) x 50 == 550 API calls against your BackBlaze b2 API limit.

            ** You have been warned! BE CAREFUL!!! **
        """
        print(self.delete_all_versions.__name__, self.delete_all_versions.__doc__) # Print warnings at call time.


        # Confirm deletion
        if not confirm:
            print('To call this function, use delete_all_versions(confirm=True)')

            return False

        versions = self.get_versions()

        version_count = len(versions)
        if not version_count > 0:
            print('No file versions')

        else:
            print(version_count, 'file versions')
            for count, v in enumerate(versions):

                print('deleting [{}/{}]'.format(count + 1 , version_count))

                v.delete()


    def delete(self):
        """ Delete a file version (Does not delete entire file history: only most recent version) """

        path = API.delete_file_version
        params = {
            'fileId': self.file_id,
            'fileName': b2_url_encode(self.file_name)
        }
        response = self.connector.make_request(path=path, method='post', params=params)
        if not response.status_code == 200:
            raise B2Exception.parse(response)
        self.deleted = True


    def download(self):
        """ Download latest file version """
        response = self.connector.download_file(file_id=self.file_id)
        if response.status_code == 200:
            return BytesIO(response.content)
        else:
            raise B2Exception.parse(response)

    @property
    def url(self):
        """ Return file download URL """
        return self.connector.download_url + '?fileId=' + self.file_id


1		"""
2		Copyright George Sibble 2018
3		"""
4	1	from io import BytesIO
5	1	from ..utilities import b2_url_encode, b2_url_decode, decode_error
		0 ignored issues – show Unused Code introduced 2018-06-27 20:20 UTC by Report Bug Copy Issue Report Unused b2_url_decode imported from utilities Loading history... Unused Code introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report Unused decode_error imported from utilities Loading history...
6	1	from ..b2_exceptions import B2Exception
7	1	from ..api import API
8
9	1	class B2File(object):
		0 ignored issues – show Documentation introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report Empty class docstring Loading history... best-practice introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report Too many instance attributes (11/7) Loading history...
10		"""
11
12		"""
13	1	def __init__(self, connector, parent_list, fileId, fileName, contentSha1, contentLength, contentType,
		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 (105/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history... best-practice introduced 2018-06-27 20:20 UTC by Report Bug Copy Issue Report Too many arguments (11/5) Loading history... Unused Code introduced 2018-06-27 20:20 UTC by Report Bug Copy Issue Report The argument `args` seems to be unused. Loading history... Unused Code introduced 2018-06-27 20:20 UTC by Report Bug Copy Issue Report The argument `kwargs` seems to be unused. Loading history...
14		fileInfo, action, uploadTimestamp, args, *kwargs):
15		"""
16
17		:param connector:
18		:param parent_list:
19		:param fileId:
20		:param fileName:
21		:param contentSha1:
22		:param contentLength:
23		:param contentType:
24		:param fileInfo:
25		:param action:
26		:param uploadTimestamp:
27		:param args:
28		:param kwargs:
29		"""
30	1	self.file_id = fileId
31		# self.file_name_decoded = b2_url_decode(fileName)
32		#TODO: Find out if this is necessary
		0 ignored issues – show Coding Style introduced 2018-06-27 20:20 UTC by Report Bug Copy Issue Report `TODO` and `FIXME` comments should generally be avoided. Loading history...
33	1	self.file_name = fileName
34	1	self.content_sha1 = contentSha1
35	1	self.content_length = contentLength
36	1	self.content_type = contentType
37	1	self.file_info = fileInfo
38	1	self.action = action
39	1	self.uploadTimestamp = uploadTimestamp
		0 ignored issues – show Coding Style Naming introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report The name `uploadTimestamp` does not conform to the attribute 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...
40	1	self.connector = connector
41	1	self.parent_list = parent_list
42	1	self.deleted = False
43
44	1	def get_versions(self, limit=None):
		0 ignored issues – show Coding Style introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report Trailing whitespace Loading history...
45		""" Fetch list of all versions of the current file.
46		Params:
47		limit: (int) Limit number of results returned (optional, default 10000)
48
49		Returns:
50		file_versions (list) B2FileObject of all file versions
51		"""
52	1	bucket_id = self.parent_list.bucket.bucket_id
53
54	1	path = API.list_file_versions
55	1	file_versions = []
56	1	params = {
57		'bucketId': bucket_id,
58		'maxFileCount': limit or 10000,
59		'startFileId': self.file_id,
60		'startFileName': self.file_name,
61		}
62
63	1	response = self.connector.make_request(path=path, method='post', params=params)
64	1	if response.status_code == 200:
65	1	files_json = response.json()
66	1	for file_json in files_json['files']:
67	1	new_file = B2File(connector=self.connector, parent_list=self, **file_json)
68	1	file_versions.append(new_file)
69		else:
70		raise B2Exception.parse(response)
71	1	return file_versions
72
		0 ignored issues – show Coding Style introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report Trailing whitespace Loading history...
73
74	1	def hide(self):
75		""" Soft-delete a file (hide it from files list, but previous versions are saved.) """
76	1	path = API.delete_file
77	1	params = {
78		'bucketId': self.parent_list.bucket.bucket_id,
79		'fileName': b2_url_encode(self.file_name)
80		}
81	1	response = self.connector.make_request(path=path, method='post', params=params)
82	1	if response.status_code == 200:
83	1	self.deleted = True
84		# Delete from parent list if exists
85	1	self.parent_list._files_by_name.pop(self.file_name)
		0 ignored issues – show Coding Style Best Practice introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report It seems like `_files_by_name` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
86	1	self.parent_list._files_by_id.pop(self.file_id)
		0 ignored issues – show Coding Style Best Practice introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report It seems like `_files_by_id` was declared protected and should not be accessed from this context. Prefixing a member variable `_` is usually regarded as the equivalent of declaring it with protected visibility that exists in other languages. Consequentially, such a member should only be accessed from the same class or a child class: class MyParent: def __init__(self): self._x = 1; self.y = 2; class MyChild(MyParent): def some_method(self): return self._x # Ok, since accessed from a child class class AnotherClass: def some_method(self, instance_of_my_child): return instance_of_my_child._x # Would be flagged as AnotherClass is not # a child class of MyParent Loading history...
87		else:
88		raise B2Exception.parse(response)
89
90
91	1	def delete_all_versions(self, confirm=False):
92		""" Delete completely all versions of a file.
		0 ignored issues – show Coding Style introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report Trailing whitespace Loading history...
93		NOTE THAT THIS CAN BE VERY EXPENSIVE IN TERMS OF YOUR API LIMITS
94		Each call to delete_all_versions will result in multiple API calls:
		0 ignored issues – show Coding Style introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report Trailing whitespace Loading history...
95		One API call per file version to be deleted, per file.
96		1. Call '/b2_list_file_versions' to get file versions
97		2. Call '/b2_delete_file_version' once for each version of the file
98
99		This means: if you have 10 files with 50 versions each and call delete_all_versions,
		0 ignored issues – show Coding Style introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report Trailing whitespace Loading history...
100		you will spend (10 + 1) x 50 == 550 API calls against your BackBlaze b2 API limit.
101
102		You have been warned! BE CAREFUL!!!
103		"""
104	1	print(self.delete_all_versions.__name__, self.delete_all_versions.__doc__) # Print warnings at call time.
		0 ignored issues – show Coding Style introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (113/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
105
106		# Confirm deletion
107	1	if not confirm:
108		print('To call this function, use delete_all_versions(confirm=True)')
		0 ignored issues – show Unused Code Coding Style introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report There is an unnecessary parenthesis after `print`. Loading history...
109		return False
110
111	1	versions = self.get_versions()
112
113	1	version_count = len(versions)
114	1	if not version_count > 0:
115		print('No file versions')
		0 ignored issues – show Unused Code Coding Style introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report There is an unnecessary parenthesis after `print`. Loading history...
116		else:
117	1	print(version_count, 'file versions')
118	1	for count, v in enumerate(versions):
		0 ignored issues – show Coding Style Naming introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report The name `v` does not conform to the variable 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...
119	1	print('deleting [{}/{}]'.format(count + 1 , version_count))
		0 ignored issues – show Unused Code Coding Style introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report There is an unnecessary parenthesis after `print`. Loading history... Coding Style introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report No space allowed before comma Loading history...
120	1	v.delete()
121
122
123	1	def delete(self):
124		""" Delete a file version (Does not delete entire file history: only most recent version) """
		0 ignored issues – show Coding Style introduced 2018-10-30 20:37 UTC by Report Bug Copy Issue Report This line is too long as per the coding-style (101/100). This check looks for lines that are too long. You can specify the maximum line length. Loading history...
125	1	path = API.delete_file_version
126	1	params = {
127		'fileId': self.file_id,
128		'fileName': b2_url_encode(self.file_name)
129		}
130	1	response = self.connector.make_request(path=path, method='post', params=params)
131	1	if not response.status_code == 200:
132		raise B2Exception.parse(response)
133	1	self.deleted = True
134
135
136	1	def download(self):
137		""" Download latest file version """
138	1	response = self.connector.download_file(file_id=self.file_id)
139	1	if response.status_code == 200:
140	1	return BytesIO(response.content)
141		else:
142		raise B2Exception.parse(response)
143
144	1	@property
145		def url(self):
146		""" Return file download URL """
147		return self.connector.download_url + '?fileId=' + self.file_id
148

sibblegp / b2blaze

GitHub Access Token became invalid

b2blaze.models.b2_file.B2File.hide() A last analyzed 2018-10-30 20:38 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

b2blaze.models.b2_file.B2File.hide() A
last analyzed 2018-10-30 20:38 UTC