[PATCH] gnu: Add python-pysox.

Done

Details

2 participants

Arun Isaac
jgart

Owner: unassigned

Submitted by: jgart

Severity: normal

jgart wrote on 8 Jul 2021 20:45

Recipients:(address . guix-patches@gnu.org)

Message-ID:0e7aba9bd4b403707a06597219700743@dismail.de

Hi Guix!

Here is python-pysox.

Tests for this package depend on https://issues.guix.gnu.org/47181

all best,

jgart

jgart wrote on 8 Jul 2021 21:35

Recipients:(address . 49469@debbugs.gnu.org)(name . jgart)(address . jgart@dismail.de)

Message-ID:20210708193555.4907-1-jgart@dismail.de

* gnu/packages/audio.scm (python-pysox): New variable.

---

gnu/packages/audio.scm | 30 ++++++++++++++++++++++++++++++

1 file changed, 30 insertions(+)

Toggle diff (43 lines)diff --git a/gnu/packages/audio.scm b/gnu/packages/audio.scm
index 3939d4bc7e..5222fb0343 100644
--- a/gnu/packages/audio.scm
+++ b/gnu/packages/audio.scm
@@ -2385,6 +2385,36 @@ compensation, (de)interleaving, and byte-swapping
     ;; original developer.
     (license license:expat)))
 
+(define-public python-pysox
+  (package
+    (name "python-pysox")
+    (version "1.4.1")
+    (source
+      (origin
+        (method url-fetch)
+        (uri (pypi-uri "sox" version))
+        (sha256
+          (base32
+            "0m8hszh51lfzacbb4nxc5bn446c0dzljfqgnsff8h2s5j8vd3wmh"))))
+    (build-system python-build-system)
+    (arguments
+     ;; Tests require python-soundfile.
+     ;; TODO: enable tests once http://issues.guix.gnu.org/47181 is completed.
+     `(#:tests? #f))
+    (propagated-inputs
+      `(("python-numpy" ,python-numpy)))
+    (native-inputs
+      `(("python-pytest" ,python-pytest)
+        ("python-pytest-cov" ,python-pytest-cov)))
+    (home-page "https://github.com/rabitt/pysox")
+    (synopsis "Python wrapper around sox")
+    (description "@code{pysox} is a wrapper around the @command{sox} command line tool.
+ pysox's API offers @code{Transformer} and @code{Combiner} classes that allow the user to
+incrementally build up effects and audio manipulations.  @code{pysox} also
+provides methods for querying audio information such as sample rate,
+determining whether an audio file is silent and much more.")
+    (license license:bsd-3)))
+
 (define-public python-pyaudio
   (package
     (name "python-pyaudio")
-- 
2.31.1

Arun Isaac wrote on 9 Oct 2021 17:20

Recipients:(name . jgart)(address . jgart@dismail.de)(address . 49469@debbugs.gnu.org)

Message-ID:874k9qjkck.fsf@systemreboot.net

Hi jgart,

Toggle quote (4 lines)

> + ;; Tests require python-soundfile.

> + ;; TODO: enable tests once http://issues.guix.gnu.org/47181 is completed.

> + `(#:tests? #f))

python-soundfile is now in Guix. Could you try getting the tests

working?

Thank you!

Arun

jgart wrote on 10 Oct 2021 08:15

Recipients:(address . 49469@debbugs.gnu.org)

Message-ID:20211010061525.11302-1-jgart@dismail.de

Here is an updated patch. I got the tests to pass. I also realized that I had

to wrap some binaries.

all best,

jgart

jgart wrote on 10 Oct 2021 08:15

Recipients:(address . 49469@debbugs.gnu.org)(name . jgart)(address . jgart@dismail.de)

Message-ID:20211010061525.11302-2-jgart@dismail.de

* gnu/packages/audio.scm (python-pysox): New variable.

---

gnu/packages/audio.scm | 57 ++++++++++++++++++++++++++++++++++++++++++

1 file changed, 57 insertions(+)

Toggle diff (70 lines)diff --git a/gnu/packages/audio.scm b/gnu/packages/audio.scm
index cc51ac51f3..8b412a63d1 100644
--- a/gnu/packages/audio.scm
+++ b/gnu/packages/audio.scm
@@ -2429,6 +2429,63 @@ compensation, (de)interleaving, and byte-swapping
     ;; original developer.
     (license license:expat)))
 
+(define-public python-pysox
+  (let ((commit "3d0053381c24ae3490f759d4de87194b85789d36")
+        (revision "0"))
+    (package
+      (name "python-pysox")
+      (version (git-version "1.4.2" revision commit))
+      (source
+        (origin
+          (method git-fetch)
+          (uri (git-reference
+                 (url "https://github.com/rabitt/pysox")
+                 (commit commit)))
+          (file-name (git-file-name name version))
+          (sha256
+            (base32
+              "0i62jx92vfpcr2z7lp69yzqdi9idfs3pifl3rzm2akc2c4cr1mac"))))
+      (build-system python-build-system)
+      (arguments
+        `(#:phases
+          (modify-phases %standard-phases
+            (add-after 'unpack 'patch-sox
+              (lambda* (#:key inputs #:allow-other-keys)
+                (let* ((sox-store-path (assoc-ref inputs "sox"))
+                       (sox-bin (string-append sox-store-path "/bin/sox")))
+                  (substitute* "sox/__init__.py"
+                    (("sox -h")
+                     (string-append sox-bin " -h")))
+                  (substitute* "sox/core.py"
+                    (("\\['sox")
+                     (string-append "['" sox-bin)))
+                  (substitute* "sox/log.py"
+                    (("Logger\\('sox")
+                     (string-append "Logger\('" sox-bin))))))
+            (replace 'check
+              (lambda* (#:key inputs outputs tests? #:allow-other-keys)
+                (when tests?
+                  (add-installed-pythonpath inputs outputs)
+                  (setenv "PYTHONPATH" (string-append ".:" (getenv "PYTHONPATH")))
+                  (invoke "pytest")))))))
+      (propagated-inputs
+        `(("python-numpy" ,python-numpy)
+          ("python-typing-extensions" ,python-typing-extensions)))
+      (native-inputs
+        `(("sox" ,sox)
+          ("python-pytest" ,python-pytest)
+          ("python-pytest-cov" ,python-pytest-cov)
+          ("python-soundfile" ,python-soundfile)))
+      (home-page "https://github.com/rabitt/pysox")
+      (synopsis "Python wrapper around sox")
+      (description
+"@code{pysox} is a wrapper around the @command{sox} command line tool.
+ pysox's API offers @code{Transformer} and @code{Combiner} classes that allow the user to
+incrementally build up effects and audio manipulations.  @code{pysox} also
+provides methods for querying audio information such as sample rate,
+determining whether an audio file is silent and much more.")
+      (license license:bsd-3))))
+
 (define-public python-pyaudio
   (package
     (name "python-pyaudio")
-- 
2.33.0

Arun Isaac wrote on 16 Oct 2021 12:02

Recipients:(name . jgart)(address . jgart@dismail.de)(address . 49469@debbugs.gnu.org)

Message-ID:87sfx1s2xh.fsf@systemreboot.net

Hi jgart,

Thanks for the updated patch! Some feedback follows.

Toggle quote (7 lines)

> +(define-public python-pysox

> + (let ((commit "3d0053381c24ae3490f759d4de87194b85789d36")

> + (revision "0"))

> + (package

> + (name "python-pysox")

> + (version (git-version "1.4.2" revision commit))

According to PyPI, it seems that the latest version is 1.4.1.

And, I see that upstream is not tagging releases correctly in their git

repo. Could you raise this issue with upstream?

Toggle quote (6 lines)

> + (source

> + (origin

> + (method git-fetch)

> + (uri (git-reference

> + (url "https://github.com/rabitt/pysox")

We should prefer the PyPI source tarball. If there is something missing

in the PyPI source tarball, and that's why you are using the GitHub

source, could you add a comment explaining the reason?

Toggle quote (4 lines)

> + (substitute* "sox/log.py"

> + (("Logger\\('sox")

> + (string-append "Logger\('" sox-bin))))))

I think the above substitution is not required, because in this instance

'sox' is the name of the logger, rather than the full path to the sox

executable.

Toggle quote (3 lines)

> + (setenv "PYTHONPATH" (string-append ".:" (getenv

> "PYTHONPATH")))

This setting of PYTHONPATH does not seem to be required. The tests

succeed without it.

Toggle quote (7 lines)

> + (description

> +"@code{pysox} is a wrapper around the @command{sox} command line tool.

> + pysox's API offers @code{Transformer} and @code{Combiner} classes that allow the user to

> +incrementally build up effects and audio manipulations. @code{pysox} also

> +provides methods for querying audio information such as sample rate,

> +determining whether an audio file is silent and much more.")

I think @code{pysox} should be @code{python-pysox} since we are

referring to the python-pysox scheme variable.

Could you send an updated patch? Also, please do use `git format-patch

-v2', `git format-patch -v3', etc. when sending updated patches.

Thanks!

Arun

Arun Isaac wrote on 16 Oct 2021 12:05

Recipients:(name . jgart)(address . jgart@dismail.de)(address . 49469@debbugs.gnu.org)

Message-ID:87o87ps2rx.fsf@systemreboot.net

Also, in the next patch, please add a copyright header for yourself.

Thanks!

Arun Isaac wrote on 24 Nov 2021 17:25

Recipients:(name . jgart)(address . jgart@dismail.de)(address . 49469@debbugs.gnu.org)

Message-ID:87k0gx8qsh.fsf@systemreboot.net

Hi jgart,

Just a gentle reminder. I was wondering if you missed my last mail on

this patch.

Thanks,

Arun

jgart wrote on 25 Nov 2021 05:33

Recipients:(name . Arun Isaac)(address . arunisaac@systemreboot.net)(address . 49469@debbugs.gnu.org)

Message-ID:20211124233328.GB22950@gac.attlocal.net

On Wed, 24 Nov 2021 21:55:02 +0530 Arun Isaac <arunisaac@systemreboot.net> wrote:

Toggle quote (9 lines)

> Hi jgart,

> Just a gentle reminder. I was wondering if you missed my last mail on

> this patch.

> Thanks,

> Arun

Hi Arun,

Thank you for taking the time to review these patches.

Oddly enough, PyPi does not include the data folder that contains the audio files required for testing:

https://github.com/rabitt/pysox/tree/master/tests/data

Here is a snippet of the log showing test failures from not finding the data folder with the audio files:

/gnu/store/grnpyl2q67cyymcx7p27h5l64i23i4bn-python-pysox-1.4.1/lib/python3.8/site-packages/sox/file_info.py:248: OSError

________________ TestTransformerVol.test_limiter_gain_vol_up_db ________________

self = <test_transform.TestTransformerVol testMethod=test_limiter_gain_vol_up_db>

def test_limiter_gain_vol_up_db(self):

tfm = new_transformer()

tfm.vol(2.0, gain_type='db', limiter_gain=0.05)

actual_args = tfm.effects

expected_args = ['vol', '2.000000', 'dB', '0.050000']

self.assertEqual(expected_args, actual_args)

actual_log = tfm.effects_log

expected_log = ['vol']

self.assertEqual(expected_log, actual_log)

Toggle quote (2 lines)

> actual_res = tfm.build(INPUT_FILE, OUTPUT_FILE)

tests/test_transform.py:5322:

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

/gnu/store/grnpyl2q67cyymcx7p27h5l64i23i4bn-python-pysox-1.4.1/lib/python3.8/site-packages/sox/transform.py:593: in build

input_format, input_filepath = self._parse_inputs(

/gnu/store/grnpyl2q67cyymcx7p27h5l64i23i4bn-python-pysox-1.4.1/lib/python3.8/site-packages/sox/transform.py:493: in _parse_inputs

file_info.validate_input_file(input_filepath)

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

input_filepath = '/tmp/guix-build-python-pysox-1.4.1.drv-0/sox-1.4.1/tests/data/input.wav'

def validate_input_file(input_filepath):

'''Input file validation function. Checks that file exists and can be

processed by SoX.

Parameters

----------

input_filepath : str

The input filepath.

'''

if not os.path.exists(input_filepath):

Toggle quote (1 lines)

> raise IOError(

"input_filepath {} does not exist.".format(input_filepath)

)

E OSError: input_filepath /tmp/guix-build-python-pysox-1.4.1.drv-0/sox-1.4.1/tests/data/input.wav does not exist.

/gnu/store/grnpyl2q67cyymcx7p27h5l64i23i4bn-python-pysox-1.4.1/lib/python3.8/site-packages/sox/file_info.py:248: OSError

================= 282 failed, 373 passed, 10 skipped in 51.02s =================

Next email will contain the new patch set with your suggestions. I've included a copyright statement also.

Thank you!

all best,

jgart

jgart wrote on 25 Nov 2021 05:42

[PATCH v3] gnu: Add python-pysox.

Recipients:(address . 49469@debbugs.gnu.org)(name . jgart)(address . jgart@dismail.de)

Message-ID:20211125044245.25678-1-jgart@dismail.de

* gnu/packages/audio.scm (python-pysox): New variable.

---

gnu/packages/audio.scm | 56 ++++++++++++++++++++++++++++++++++++++++++

1 file changed, 56 insertions(+)

Toggle diff (76 lines)diff --git a/gnu/packages/audio.scm b/gnu/packages/audio.scm
index 4b1a602804..694ea1a21b 100644
--- a/gnu/packages/audio.scm
+++ b/gnu/packages/audio.scm
@@ -34,6 +34,7 @@
 ;;; Copyright © 2020 Giacomo Leidi <goodoldpaul@autistici.org>
 ;;; Copyright © 2020, 2021 Vinicius Monego <monego@posteo.net>
 ;;; Copyright © 2020 Michael Rohleder <mike@rohleder.de>
+;;; Copyright © 2021 jgart <jgart@dismail.de>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -5532,6 +5533,61 @@ (define-public siggen
 device.  There is support for mono and/or stereo and 8 or 16 bit samples.")
     (license license:gpl2)))
 
+(define-public python-pysox
+  ;; PyPi does not include the data folder containing audio files for testing.
+  (let ((commit "3d0053381c24ae3490f759d4de87194b85789d36")
+        (revision "0"))
+    (package
+      (name "python-pysox")
+      (version (git-version "1.4.2" revision commit))
+      (source
+        (origin
+          (method git-fetch)
+          (uri (git-reference
+                 (url "https://github.com/rabitt/pysox")
+                 (commit commit)))
+          (file-name (git-file-name name version))
+          (sha256
+            (base32
+              "0i62jx92vfpcr2z7lp69yzqdi9idfs3pifl3rzm2akc2c4cr1mac"))))
+      (build-system python-build-system)
+      (arguments
+        `(#:phases
+          (modify-phases %standard-phases
+            (add-after 'unpack 'patch-sox
+              (lambda* (#:key inputs #:allow-other-keys)
+                (let* ((sox-store-path (assoc-ref inputs "sox"))
+                       (sox-bin (string-append sox-store-path "/bin/sox")))
+                  (substitute* "sox/__init__.py"
+                    (("sox -h")
+                     (string-append sox-bin " -h")))
+                  (substitute* "sox/core.py"
+                    (("\\['sox")
+                     (string-append "['" sox-bin))))))
+            (replace 'check
+              (lambda* (#:key inputs outputs tests? #:allow-other-keys)
+                (when tests?
+                  (add-installed-pythonpath inputs outputs)
+                  (invoke "pytest")))))))
+      (propagated-inputs
+        `(("python-numpy" ,python-numpy)
+          ("python-typing-extensions" ,python-typing-extensions)))
+      (native-inputs
+        `(("sox" ,sox)
+          ("python-pytest" ,python-pytest)
+          ("python-pytest-cov" ,python-pytest-cov)
+          ("python-soundfile" ,python-soundfile)))
+      (home-page "https://github.com/rabitt/pysox")
+      (synopsis "Python wrapper around SoX")
+      (description
+"@code{python-pysox} is a wrapper around the @command{sox} command
+line tool.  The API offers @code{Transformer} and @code{Combiner}
+classes that allow the user to incrementally build up effects and audio
+manipulations.  @code{python-pysox} also provides methods for querying
+audio information such as sample rate, determining whether an audio file
+is silent, and much more.")
+      (license license:bsd-3))))
+
 (define-public mda-lv2
   (package
     (name "mda-lv2")
-- 
2.34.0

jgart wrote on 25 Nov 2021 05:46

Re: bug#49469: [PATCH] gnu: Add python-pysox.

Recipients:(name . Arun Isaac)(address . arunisaac@systemreboot.net)(address . 49469@debbugs.gnu.org)

Message-ID:20211124234634.GB25725@gac.attlocal.net

On Wed, 24 Nov 2021 23:33:28 -0500 jgart <jgart@dismail.de> wrote:

I sent the latest patch set (v3) but forgot to Cc you ;)

all best,

jgart

Arun Isaac wrote on 29 Nov 2021 17:12

Recipients:(name . jgart)(address . jgart@dismail.de)(address . 49469-done@debbugs.gnu.org)

Message-ID:87a6hnrldj.fsf@systemreboot.net

Hi jgart,

Thank you for your revised patch! I have pushed it to master.

Toggle quote (3 lines)

> Oddly enough, PyPi does not include the data folder that contains the

> audio files required for testing:

Personally, I believe this is bad practice, but sadly it is quite

common.

Regards,

Arun

Closed

Your comment

This issue is archived.

To comment on this conversation send an email to 49469@debbugs.gnu.org

is:open	open issues
is:done	closed issues
submitter:<who>	search issue submitter
author:<who>	search by message author
date:yesterday..now	search by issue date
mdate:3m..2d	search by message date