❗🛠 Testers, documentors needed

[demberto]

✨An upcoming version of PyFLP is coming soon #15.

🛠 I need testers to test their own FLPs against the latest version, which can be installed via cloning the repo and performing an editable install.

📘 I have uploaded the latest docs to https://pyflp.rtfd.io.

[ttaschke]

Hi, I would like to help with this.
Please let me know, what kind of tests / feedback you are looking for.

For now I just tried to import a random FLP, but got the following parse error:

Python 3.10.7 (main, Sep  7 2022, 22:40:42) [GCC 11.2.1 20220219] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import pyflp
>>> project = pyflp.parse("../test_data/melody.flp")
/python_project/pyflp/pyflp/__init__.py:151: RuntimeWarning: Event 212 not parsed entirely; parsed 18, found 52 bytes
  events.append(event_type(id, value))
/python_project/pyflp/pyflp/__init__.py:151: RuntimeWarning: Event 215 not parsed entirely; parsed 158, found 168 bytes
  events.append(event_type(id, value))

(Note: Above was executed after applying the fix for Python 3.10 from #21)

I also tried an older Python version, but got an error on importing pyflp:

Python 3.7.14 (default, Sep  8 2022, 00:44:25)
[GCC 11.2.1 20220219] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import pyflp
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/python_project/pyflp/pyflp/__init__.py", line 37, in <module>
    from ._base import (
  File "/python_project/pyflp/pyflp/_base.py", line 93, in <module>
    class EventBase(abc.ABC, Generic[T], Hashable, Sized, SupportsBytes):
TypeError: metaclass conflict: the metaclass of a derived class must be a (non-strict) subclass of the metaclasses of all its bases

---

Btw, I would also be happy to help with development tasks, if you could suggest some appropriate development tasks for starting to contribute to this project in general.

[ttaschke]

Thanks for the explanation.
I will take a look at the things you mentioned and the TODOs in code and see what makes sense for first steps.

Its a warning, which just tells that an event size has increased compared to what I parse into pyflp._base.StructBase._props.

Oh, right.. Totally overlooked that it is a warning and not an error.

Also, if you do not have this on your radar yet, I will create an issue for the error with Python 3.7 and look into it.
TypeError: metaclass conflict: the metaclass of a derived class must be a (non-strict) subclass of the metaclasses of all its bases

[demberto]

Also, if you do not have this on your radar yet, I will create an issue for the error with Python 3.7 and look into it.
TypeError: metaclass conflict: the metaclass of a derived class must be a (non-strict) subclass of the metaclasses of all its bases

I found out that inheriting typing.SupportsBytes for EventBase did that, fixed it.

[demberto]

@ttaschke Hey there, I have opened some issues. Please check them out

[ttaschke]

Hi @demberto,
While looking through the issues, I got interested in seeing how inspecting FLPs with your GUI application works.
I could not get it to run immediately, because it depends on an old version of the PyFLP API, but I got it working with the newest PyFLP version in the end.
I also created a PR for this:
https://github.com/demberto/FLPInspect/pull/1
(In case it is too early to sync FLPInspect to PyFLP, this can maybe just be the base for an upgrade after the full 2.x release.)

Btw, originally I was looking for how to do inspecting and finding events. Could you please explain what your workflow for this is?
For example, when trying to map a plugin's params to events (#30).

[demberto]

Nah FLPInspect was just a side hustle, I will be working on a rewrite of it after I finish with PyFLP and the ZIP export utility. There was a utility called FLPEdit by @RoadCrewWorker. I dunno why it got taken down. It's a nice utlity to inspect event data. If you are on WIndows you are in luck, I have attached it.

Go to FLPEdit/bin/release, and check the DBG: Allow unknown IDs. A good amount of it's code was used for PyFLP's event parsing logic. It might run just fine if you are on Mac or Linux via Wine.

FLPEdit.zip

[demberto]

@ttaschke I have added new docs for users and contributors, can you check them out please? 👀

[ttaschke]

Sorry, only noticed this now.
Just had a quick look at the contributor guide and this seems really comprehensive. 👍 🙏
A lot of information there so it will take a bit time to work through it all.

[demberto]

It just occured to me that instead of using the same FLP for all the tests, separate presets (saved via FL Studio) can be used for separate tests. Modifying them is as easy as loading the preset in FL and saving it back.

Presets saved in one of FL Studio's formats use the same layout as a full FLP, but only the required events.

This will also improve test isolation.