Skip to content

Commit 1dfa840

Browse files
author
Bartek Kwiecien
committed
Internal changes
1 parent 1059739 commit 1dfa840

File tree

4 files changed

+55
-57
lines changed

4 files changed

+55
-57
lines changed

‎filestack/mixins/common.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ def url(self):
1515
>>> filelink.url
1616
'https://cdn.filestackcontent.com/FILE_HANDLE'
1717
>>> transformation.url
18-
'https://cdn.filestackcontent.com/resize=width:800/file_handle'
18+
'https://cdn.filestackcontent.com/resize=width:800/FILE_HANDLE'
1919
2020
Returns:
2121
str: object's URL
@@ -29,7 +29,7 @@ def signed_url(self, security=None):
2929
>>> filelink.url
3030
'https://cdn.filestackcontent.com/security=p:<encoded_policy>,s:<signature>/FILE_HANDLE'
3131
>>> transformation.url
32-
'https://cdn.filestackcontent.com/resize=width:800/security=p:<encoded_policy>,s:<signature>/file_handle'
32+
'https://cdn.filestackcontent.com/resize=width:800/security=p:<encoded_policy>,s:<signature>/FILE_HANDLE'
3333
3434
Args:
3535
security (:class:`filestack.Security`): Security object that will be used
@@ -64,7 +64,7 @@ def store(self, filename=None, location=None, path=None, container=None,
6464
Returns:
6565
:class:`filestack.Filelink`: new Filelink object
6666
"""
67-
instance = self.add_transform_task('store', locals())
67+
instance = self._add_transform_task('store', locals())
6868
response = requests.post(instance.url)
6969
return filestack.models.Filelink(handle=response.json()['handle'])
7070

@@ -105,7 +105,7 @@ def tags(self, security=None):
105105
Returns:
106106
`dict`: dictionary containing image tags
107107
"""
108-
obj = self.add_transform_task('tags', params={'self': None})
108+
obj = self._add_transform_task('tags', params={'self': None})
109109
response = requests.get(obj.signed_url(security=security))
110110
return response.json()
111111

@@ -120,6 +120,6 @@ def sfw(self, security=None):
120120
Returns:
121121
`dict`: dictionary containing SFW result
122122
"""
123-
obj = self.add_transform_task('sfw', params={'self': None})
123+
obj = self._add_transform_task('sfw', params={'self': None})
124124
response = requests.get(obj.signed_url(security=security))
125125
return response.json()

‎filestack/mixins/imagetransformation.py

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -8,123 +8,123 @@ class ImageTransformationMixin:
88
be directly called by Transformation or Filelink objects.
99
"""
1010
def resize(self, width=None, height=None, fit=None, align=None):
11-
return self.add_transform_task('resize', locals())
11+
return self._add_transform_task('resize', locals())
1212

1313
def crop(self, dim=None):
14-
return self.add_transform_task('crop', locals())
14+
return self._add_transform_task('crop', locals())
1515

1616
def rotate(self, deg=None, exif=None, background=None):
17-
return self.add_transform_task('rotate', locals())
17+
return self._add_transform_task('rotate', locals())
1818

1919
def flip(self):
20-
return self.add_transform_task('flip', locals())
20+
return self._add_transform_task('flip', locals())
2121

2222
def flop(self):
23-
return self.add_transform_task('flop', locals())
23+
return self._add_transform_task('flop', locals())
2424

2525
def watermark(self, file=None, size=None, position=None):
26-
return self.add_transform_task('watermark', locals())
26+
return self._add_transform_task('watermark', locals())
2727

2828
def detect_faces(self, minsize=None, maxsize=None, color=None, export=None):
29-
return self.add_transform_task('detect_faces', locals())
29+
return self._add_transform_task('detect_faces', locals())
3030

3131
def crop_faces(self, mode=None, width=None, height=None, faces=None, buffer=None):
32-
return self.add_transform_task('crop_faces', locals())
32+
return self._add_transform_task('crop_faces', locals())
3333

3434
def pixelate_faces(self, faces=None, minsize=None, maxsize=None, buffer=None, amount=None, blur=None, type=None):
35-
return self.add_transform_task('pixelate_faces', locals())
35+
return self._add_transform_task('pixelate_faces', locals())
3636

3737
def round_corners(self, radius=None, blur=None, background=None):
38-
return self.add_transform_task('round_corners', locals())
38+
return self._add_transform_task('round_corners', locals())
3939

4040
def vignette(self, amount=None, blurmode=None, background=None):
41-
return self.add_transform_task('vignette', locals())
41+
return self._add_transform_task('vignette', locals())
4242

4343
def polaroid(self, color=None, rotate=None, background=None):
44-
return self.add_transform_task('polaroid', locals())
44+
return self._add_transform_task('polaroid', locals())
4545

4646
def torn_edges(self, spread=None, background=None):
47-
return self.add_transform_task('torn_edges', locals())
47+
return self._add_transform_task('torn_edges', locals())
4848

4949
def shadow(self, blur=None, opacity=None, vector=None, color=None, background=None):
50-
return self.add_transform_task('shadow', locals())
50+
return self._add_transform_task('shadow', locals())
5151

5252
def circle(self, background=None):
53-
return self.add_transform_task('circle', locals())
53+
return self._add_transform_task('circle', locals())
5454

5555
def border(self, width=None, color=None, background=None):
56-
return self.add_transform_task('border', locals())
56+
return self._add_transform_task('border', locals())
5757

5858
def sharpen(self, amount=None):
59-
return self.add_transform_task('sharpen', locals())
59+
return self._add_transform_task('sharpen', locals())
6060

6161
def blur(self, amount=None):
62-
return self.add_transform_task('blur', locals())
62+
return self._add_transform_task('blur', locals())
6363

6464
def monochrome(self):
65-
return self.add_transform_task('monochrome', locals())
65+
return self._add_transform_task('monochrome', locals())
6666

6767
def blackwhite(self, threshold=None):
68-
return self.add_transform_task('blackwhite', locals())
68+
return self._add_transform_task('blackwhite', locals())
6969

7070
def sepia(self, tone=None):
71-
return self.add_transform_task('sepia', locals())
71+
return self._add_transform_task('sepia', locals())
7272

7373
def pixelate(self, amount=None):
74-
return self.add_transform_task('pixelate', locals())
74+
return self._add_transform_task('pixelate', locals())
7575

7676
def oil_paint(self, amount=None):
77-
return self.add_transform_task('oil_paint', locals())
77+
return self._add_transform_task('oil_paint', locals())
7878

7979
def negative(self):
80-
return self.add_transform_task('negative', locals())
80+
return self._add_transform_task('negative', locals())
8181

8282
def modulate(self, brightness=None, hue=None, saturation=None):
83-
return self.add_transform_task('modulate', locals())
83+
return self._add_transform_task('modulate', locals())
8484

8585
def partial_pixelate(self, amount=None, blur=None, type=None, objects=None):
86-
return self.add_transform_task('partial_pixelate', locals())
86+
return self._add_transform_task('partial_pixelate', locals())
8787

8888
def partial_blur(self, amount=None, blur=None, type=None, objects=None):
89-
return self.add_transform_task('partial_blur', locals())
89+
return self._add_transform_task('partial_blur', locals())
9090

9191
def collage(self, files=None, margin=None, width=None, height=None, color=None, fit=None, autorotate=None):
92-
return self.add_transform_task('collage', locals())
92+
return self._add_transform_task('collage', locals())
9393

9494
def upscale(self, upscale=None, noise=None, style=None):
95-
return self.add_transform_task('upscale', locals())
95+
return self._add_transform_task('upscale', locals())
9696

9797
def enhance(self):
98-
return self.add_transform_task('enhance', locals())
98+
return self._add_transform_task('enhance', locals())
9999

100100
def redeye(self):
101-
return self.add_transform_task('redeye', locals())
101+
return self._add_transform_task('redeye', locals())
102102

103103
def ascii(self, background=None, foreground=None, colored=None, size=None, reverse=None):
104-
return self.add_transform_task('ascii', locals())
104+
return self._add_transform_task('ascii', locals())
105105

106106
def filetype_conversion(self, format=None, background=None, page=None, density=None, compress=None,
107107
quality=None, strip=None, colorspace=None, secure=None,
108108
docinfo=None, pageformat=None, pageorientation=None):
109-
return self.add_transform_task('output', locals())
109+
return self._add_transform_task('output', locals())
110110

111111
def no_metadata(self):
112-
return self.add_transform_task('no_metadata', locals())
112+
return self._add_transform_task('no_metadata', locals())
113113

114114
def quality(self, value=None):
115-
return self.add_transform_task('quality', locals())
115+
return self._add_transform_task('quality', locals())
116116

117117
def zip(self):
118-
return self.add_transform_task('zip', locals())
118+
return self._add_transform_task('zip', locals())
119119

120120
def fallback(self, handle=None, cache=None):
121-
return self.add_transform_task('fallback', locals())
121+
return self._add_transform_task('fallback', locals())
122122

123123
def pdf_info(self, colorinfo=None):
124-
return self.add_transform_task('pdfinfo', locals())
124+
return self._add_transform_task('pdfinfo', locals())
125125

126126
def pdf_convert(self, pageorientation=None, pageformat=None, pages=None):
127-
return self.add_transform_task('pdfconvert', locals())
127+
return self._add_transform_task('pdfconvert', locals())
128128

129129
def av_convert(self, *, preset=None, force=None, title=None, extname=None, filename=None,
130130
width=None, height=None, upscale=None, aspect_mode=None, two_pass=None,
@@ -134,7 +134,7 @@ def av_convert(self, *, preset=None, force=None, title=None, extname=None, filen
134134
path=None, access=None, container=None, audio_bitrate=None, audio_sample_rate=None,
135135
audio_channels=None, clip_length=None, clip_offset=None):
136136

137-
new_transform = self.add_transform_task('video_convert', locals())
137+
new_transform = self._add_transform_task('video_convert', locals())
138138
response = utils.requests.get(new_transform.url).json()
139139
uuid = response['uuid']
140140
timestamp = response['timestamp']
@@ -143,7 +143,7 @@ def av_convert(self, *, preset=None, force=None, title=None, extname=None, filen
143143
new_transform.url, uuid, timestamp, apikey=new_transform.apikey, security=new_transform.security
144144
)
145145

146-
def add_transform_task(self, transformation, params):
146+
def _add_transform_task(self, transformation, params):
147147
if isinstance(self, filestack.models.Transformation):
148148
instance = self
149149
else:

‎filestack/models/client.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,21 +79,21 @@ def urlscreenshot(self, url, agent=None, mode=None, width=None, height=None, del
7979

8080
return new_transform
8181

82-
def zip(self, destination_path, file_handles, security=None):
82+
def zip(self, destination_path, files, security=None):
8383
"""
8484
Takes array of handles and downloads a compressed ZIP archive
8585
to provided path
8686
8787
Args:
8888
destination_path (str): path where the ZIP file should be stored
89-
file_handles (list): list of filelink handles and/or URLs
89+
file (list): list of filelink handles and/or URLs
9090
security (:class:`filestack.Security`): Security object that will be used
9191
for this API call
9292
9393
Returns:
9494
int: ZIP archive size in bytes
9595
"""
96-
url_parts = [config.CDN_URL, self.apikey, 'zip', '[{}]'.format(','.join(file_handles))]
96+
url_parts = [config.CDN_URL, self.apikey, 'zip', '[{}]'.format(','.join(files))]
9797
sec = security or self.security
9898
if sec is not None:
9999
url_parts.insert(3, sec.as_url_string())
@@ -122,7 +122,7 @@ def upload_url(self, url, store_params=None, security=None):
122122
handle = upload_external_url(url, self.apikey, store_params, security=security or self.security)
123123
return filestack.models.Filelink(handle=handle)
124124

125-
def upload(self, filepath=None, file_obj=None, store_params=None, intelligent=False, security=None):
125+
def upload(self, *, filepath=None, file_obj=None, store_params=None, intelligent=False, security=None):
126126
"""
127127
Uploads local file or file-like object.
128128
@@ -136,6 +136,10 @@ def upload(self, filepath=None, file_obj=None, store_params=None, intelligent=Fa
136136
137137
Returns:
138138
:class:`filestack.Filelink`: new Filelink object
139+
140+
Note:
141+
This method accepts keyword arguments only.
142+
Out of filepath and file_obj only one should be provided.
139143
"""
140144
if store_params: # Check the structure of parameters
141145
STORE_SCHEMA.check(store_params)

‎filestack/models/filelink.py

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,6 @@ def metadata(self, attributes_list=None, security=None):
5151
5252
Returns:
5353
`dict`: A buffered writable file descriptor
54-
55-
Raises:
56-
Exception: if API call fails, Exception will be raised
5754
"""
5855
attributes_list = attributes_list or []
5956
params = {}
@@ -75,9 +72,6 @@ def delete(self, apikey=None, security=None):
7572
7673
Returns:
7774
None
78-
79-
Raises:
80-
Exception: if API call fails, Exception will be raised
8175
"""
8276
sec = security or self.security
8377
apikey = apikey or self.apikey
@@ -109,7 +103,7 @@ def overwrite(self, *, filepath=None, url=None, file_obj=None, base64decode=Fals
109103
to overwrite filelink
110104
111105
Note:
112-
This method only accepts keyword arguments.
106+
This method accepts keyword arguments only.
113107
Out of filepath, url and file_obj only one should be provided.
114108
"""
115109
sec = security or self.security

0 commit comments

Comments
 (0)