Merge pull request #38 from MTG/yapf-formatting

Added yapf code style checking

Author: ffont

.github/workflows/yapf.yml

@@ -0,0 +1,12 @@
+name: YAPF Formatting Check
+on: [push, pull_request]
+jobs:
+  formatting-check:
+    name: Formatting Check
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: run YAPF to test if python code is correctly formatted
+      uses: AlexanderMelde/yapf-action@master
+      with:
+        args: --verbose

download_bookmarks_example.py

@@ -33,11 +33,7 @@
     print("\tCategory:", bookmark.name)
     print("\tNum sounds:", bookmark.num_sounds)
 
-    sounds_results_pager = user.get_bookmark_category_sounds(
-        bookmark.id,
-        fields="id,name,type",
-        page_size=1
-    )
+    sounds_results_pager = user.get_bookmark_category_sounds(bookmark.id, fields="id,name,type", page_size=1)
 
     while True:
         for sound in sounds_results_pager:

essentia_example.py

@@ -1,4 +1,4 @@
-import pyaudio, numpy, scipy,freesound, essentia, wave, wavio
+import pyaudio, numpy, scipy, freesound, essentia, wave, wavio
 from essentia.standard import *
 from scipy.io.wavfile import *
 
@@ -9,59 +9,59 @@
 RECORD_SECONDS = 3
 SIZE = 4
 
+
 def record_audio():
     p = pyaudio.PyAudio()
-    stream = p.open(format=FORMAT,
-                channels=CHANNELS,
-                rate=RATE,
-                input=True,
-                frames_per_buffer=CHUNK)
-    
+    stream = p.open(format=FORMAT, channels=CHANNELS, rate=RATE, input=True, frames_per_buffer=CHUNK)
+
     print("* recording (3 seconds)")
     frames = []
     audio = numpy.array([])
     for i in range(0, int(RATE / CHUNK * RECORD_SECONDS)):
         data = stream.read(CHUNK)
         floats = numpy.fromstring(data, 'Float32')
         frames.append(data)
-        audio = numpy.hstack((audio,floats))
+        audio = numpy.hstack((audio, floats))
     print("* done")
     stream.stop_stream()
     stream.close()
     p.terminate()
-    write_file(frames,'recording.wav')
+    write_file(frames, 'recording.wav')
     return audio
 
-def write_file(frames,fname):
+
+def write_file(frames, fname):
     wf = wave.open(fname, 'wb')
     wf.setnchannels(CHANNELS)
     wf.setsampwidth(SIZE)
     wf.setframerate(RATE)
     wf.writeframes(b''.join(frames))
     wf.close()
 
+
 def extract_mfcc(audio):
-    w = Windowing(type = 'blackmanharris62')
+    w = Windowing(type='blackmanharris62')
     spectrum = Spectrum()
     mfcc = essentia.standard.MFCC()
-    mfccs =[]
+    mfccs = []
     audio = essentia.array(audio)
-    for frame in FrameGenerator(audio, frameSize = 2048 , hopSize = 1024):
+    for frame in FrameGenerator(audio, frameSize=2048, hopSize=1024):
         mfcc_bands, mfcc_coeffs = mfcc(spectrum(w(frame)))
         mfccs.append(mfcc_coeffs)
     mfccs = essentia.array(mfccs).T
     return mfccs
 
+
 def query_by_voice():
     c = freesound.FreesoundClient()
-    c.set_token("<YOUR_API_KEY_HERE>","token")
+    c.set_token("<YOUR_API_KEY_HERE>", "token")
     d = record_audio()
     mfcc_frames = extract_mfcc(d)
-    mfcc_mean=numpy.mean(mfcc_frames,1)    
-    mfcc_var=numpy.var(mfcc_frames,1)   
-    m =",".join(["%.3f"%x for x in mfcc_mean])
-    v =",".join(["%.3f"%x for x in mfcc_var])
-    
+    mfcc_mean = numpy.mean(mfcc_frames, 1)
+    mfcc_var = numpy.var(mfcc_frames, 1)
+    m = ",".join(["%.3f" % x for x in mfcc_mean])
+    v = ",".join(["%.3f" % x for x in mfcc_var])
+
     results = c.content_based_search(target="lowlevel.mfcc.mean:"+m+" lowlevel.mfcc.var:"+v,\
             fields="id,name,url,analysis", descriptors="lowlevel.mfcc.mean,lowlevel.mfcc.var", \
             filter="duration:0 TO 3")
@@ -70,6 +70,5 @@ def query_by_voice():
         print(sound.name)
         print(sound.url)
         print("--")
-        
-    
+
     return results

examples.py

@@ -26,10 +26,7 @@
 print("Sound info specifying some request parameters:")
 print("-----------")
 sound = freesound_client.get_sound(
-    96541,
-    fields="id,name,username,duration,analysis",
-    descriptors="lowlevel.spectral_centroid",
-    normalized=1
+    96541, fields="id,name,username,duration,analysis", descriptors="lowlevel.spectral_centroid", normalized=1
 )
 print("Getting sound:", sound.name)
 print("Username:", sound.username)
@@ -52,10 +49,7 @@
 # Get sound analysis example specifying some request parameters
 print("Get analysis with specific normalized descriptor:")
 print("-------------")
-analysis = sound.get_analysis(
-    descriptors="lowlevel.spectral_centroid.mean",
-    normalized=1
-)
+analysis = sound.get_analysis(descriptors="lowlevel.spectral_centroid.mean", normalized=1)
 spectral_centroid_mean = analysis.lowlevel.spectral_centroid.mean
 print("Normalized mean of spectral centroid:", spectral_centroid_mean)
 print()
@@ -72,9 +66,7 @@
 print("Similar sounds specifying some request parameters:")
 print("---------------")
 results_pager = sound.get_similar(
-    page_size=10,
-    fields="name,username",
-    descriptors_filter="lowlevel.pitch.mean:[110 TO 180]"
+    page_size=10, fields="name,username", descriptors_filter="lowlevel.pitch.mean:[110 TO 180]"
 )
 for similar_sound in results_pager:
     print("\t-", similar_sound.name, "by", similar_sound.username)
@@ -128,29 +120,44 @@
     print("\t-", sound.name, "by", sound.username)
 print()
 
-
 # Getting sounds from a user example specifying some request parameters
 print("User sounds specifying some request parameters:")
 print("-----------")
 user = freesound_client.get_user("Headphaze")
 print("User name:", user.username)
 results_pager = user.get_sounds(
-    page_size=10,
-    fields="name,username,samplerate,duration,analysis",
-    descriptors="rhythm.bpm"
+    page_size=10, fields="name,username,samplerate,duration,analysis", descriptors="rhythm.bpm"
 )
 
 print("Num results:", results_pager.count)
 print("\t----- PAGE 1 -----")
 for sound in results_pager:
-    print("\t-", sound.name, "by", sound.username,)
-    print(", with sample rate of", sound.samplerate, "Hz and duration of",)
+    print(
+        "\t-",
+        sound.name,
+        "by",
+        sound.username,
+    )
+    print(
+        ", with sample rate of",
+        sound.samplerate,
+        "Hz and duration of",
+    )
     print(sound.duration, "s")
 print("\t----- PAGE 2 -----")
 results_pager = results_pager.next_page()
 for sound in results_pager:
-    print("\t-", sound.name, "by", sound.username,)
-    print(", with sample rate of", sound.samplerate, "Hz and duration of",)
+    print(
+        "\t-",
+        sound.name,
+        "by",
+        sound.username,
+    )
+    print(
+        ", with sample rate of",
+        sound.samplerate,
+        "Hz and duration of",
+    )
     print(sound.duration, "s")
 print()
 
@@ -160,21 +167,37 @@
 pack = freesound_client.get_pack(3524)
 print("Pack name:", pack.name)
 results_pager = pack.get_sounds(
-    page_size=5,
-    fields="id,name,username,duration,analysis",
-    descriptors="lowlevel.spectral_flatness_db"
+    page_size=5, fields="id,name,username,duration,analysis", descriptors="lowlevel.spectral_flatness_db"
 )
 print("Num results:", results_pager.count)
 print("\t----- PAGE 1 -----")
 for sound in results_pager:
-    print("\t-", sound.name, "by", sound.username, ", with duration of",)
-    print(sound.duration, "s and a mean spectral flatness of",)
+    print(
+        "\t-",
+        sound.name,
+        "by",
+        sound.username,
+        ", with duration of",
+    )
+    print(
+        sound.duration,
+        "s and a mean spectral flatness of",
+    )
     print(sound.analysis.lowlevel.spectral_flatness_db.mean)
 print("\t----- PAGE 2 -----")
 results_pager = results_pager.next_page()
 for sound in results_pager:
-    print("\t-", sound.name, "by", sound.username, ", with duration of",)
-    print(sound.duration, "s and a mean spectral flatness of",)
+    print(
+        "\t-",
+        sound.name,
+        "by",
+        sound.username,
+        ", with duration of",
+    )
+    print(
+        sound.duration,
+        "s and a mean spectral flatness of",
+    )
     print(sound.analysis.lowlevel.spectral_flatness_db.mean)
 print()
 
@@ -187,6 +210,11 @@
 print("Num results:", results_pager.count)
 print("\t----- PAGE 1 -----")
 for bookmark_category in results_pager:
-    print("\t-", bookmark_category.name, "with", bookmark_category.num_sounds,)
+    print(
+        "\t-",
+        bookmark_category.name,
+        "with",
+        bookmark_category.num_sounds,
+    )
     print("sounds at", bookmark_category.url)
 print()

freesound.py

@@ -48,7 +48,7 @@ class URIS:
     USER_SOUNDS = '/users/<username>/sounds/'
     USER_PACKS = '/users/<username>/packs/'
     USER_BOOKMARK_CATEGORIES = '/users/<username>/bookmark_categories/'
-    USER_BOOKMARK_CATEGORY_SOUNDS = '/users/<username>/bookmark_categories/<category_id>/sounds/'  # noqa
+    USER_BOOKMARK_CATEGORY_SOUNDS = '/users/<username>/bookmark_categories/<category_id>/sounds/'    # noqa
     PACK = '/packs/<pack_id>/'
     PACK_SOUNDS = '/packs/<pack_id>/sounds/'
     PACK_DOWNLOAD = '/packs/<pack_id>/download/'
@@ -83,7 +83,7 @@ class FreesoundClient:
     """
 
     def __init__(self):
-        self.auth = None  # should be set later
+        self.auth = None    # should be set later
         self.session = Session()
 
     def get_sound(self, sound_id, **params):
@@ -235,11 +235,11 @@ class FSRequest:
 
     @staticmethod
     def request(
-            uri,
-            params,
-            client,
-            wrapper=FreesoundObject,
-            method='GET',
+        uri,
+        params,
+        client,
+        wrapper=FreesoundObject,
+        method='GET',
     ):
         req = Request(method, uri, params=params, auth=client.auth)
         prepared = client.session.prepare_request(req)
@@ -326,9 +326,7 @@ def more(self):
         """
         Get more results
         """
-        return FSRequest.request(
-            self.more, {}, self.client, CombinedSearchPager
-        )
+        return FSRequest.request(self.more, {}, self.client, CombinedSearchPager)
 
 
 class Sound(FreesoundObject):
@@ -388,13 +386,9 @@ def retrieve_preview(self, directory, name=None, quality='lq', file_format='mp3'
                 '-',
                 'Preview uris are not present in your sound object. Please add'
                 ' them using the fields parameter in your request. See '
-                ' https://www.freesound.org/docs/api/resources_apiv2.html#response-sound-list.'  # noqa
+                ' https://www.freesound.org/docs/api/resources_apiv2.html#response-sound-list.'    # noqa
             ) from exc
-        return FSRequest.retrieve(
-            preview_attr,
-            self.client,
-            path
-        )
+        return FSRequest.retrieve(preview_attr, self.client, path)
 
     def get_analysis(self, descriptors=None, normalized=0):
         """
@@ -504,9 +498,7 @@ def get_bookmark_category_sounds(self, category_id, **params):
 
         >>> p = u.get_bookmark_category_sounds(0)
         """
-        uri = URIS.uri(
-            URIS.USER_BOOKMARK_CATEGORY_SOUNDS, self.username, category_id
-        )
+        uri = URIS.uri(URIS.USER_BOOKMARK_CATEGORY_SOUNDS, self.username, category_id)
         return FSRequest.request(uri, params, self.client, Pager)
 
     def __repr__(self):

pyproject.toml

@@ -0,0 +1,10 @@
+[tool.yapf]
+based_on_style = "google"
+spaces_before_comment = 4
+split_before_logical_operator = true
+split_before_expression_after_opening_paren = true
+split_before_first_argument = true
+dedent_closing_brackets = true
+coalesce_brackets = true
+column_limit = 120
+align_closing_bracket_with_visual_indent = true