ini2toml

ini2toml copied to clipboard

First -- thank you for all your work around pyproject.toml and setuptools, and for this conversion helper -- very much appreciated!!

I'm using ini2toml 0.10 and Python 3.9.11. The following piece of my setup.cfg

[options.package_data]
* = ['extension/jupyter_tempvars.*']

is being converted to

[tool.setuptools.package-data]
"*" = [ "['extension/jupyter_tempvars.*']",]

I'm pretty sure it should just be

"*" = ['extension/jupyter_tempvars.*',]

This was the only array value in the entire setup.cfg, so I don't have any other array values to compare to. Is this parse case just not implemented yet?

Hi @bskinn thank you very much for reporting this. What I think is happening is the following:

• The syntax of the setup.cfg files is not really aware about arrays/lists of value. There is no way of representing this type of values in .cfg or .ini files
• The way setuptools works for options.package_data is by accepting either a string that contains a , separator between values or a multiline string where each line is a different value.

There is an example on the setuptools website about this: https://setuptools.pypa.io/en/latest/userguide/declarative_config.html

So I don't think ini2toml is doing the wrong thing in this particular case (there might be other bugs elsewhere...).

Does this make sense to you?

Oh, interesting -- I didn't realize that was a limitation of the INI format. Yes, it makes total sense!

Would it make sense to add a warning, displayed to the user, if ini2toml detects values that "look like arrays", so that they would know to find and revise them?

I didn't realize that was a limitation of the INI format. Yes, it makes total sense!

That is one of the reasons why people want to move towards TOML. It is easier to work with.

Would it make sense to add a warning, displayed to the user, if ini2toml detects values that "look like arrays"

That is a bit tricky... Do you know if there is a validator for setup.cfg somewhere? Maybe that would help?

Do you know if there is a validator for setup.cfg somewhere? Maybe that would help?

I don't offhand, unfortunately. Perhaps there's something in the guts of setuptools that could be exploited?

That said -- perhaps a "sloppy" warning would be good enough? E.g., emitting a warning that 'an array may be present', any time a string value contains both [ and ]?

(It seems like the multiline strings are interpreted well by ini2toml, and would be of less concern... e.g., my classifiers were correctly transformed into an array.)

E.g., emitting a warning that 'an array may be present', any time a string value contains both [ and ]?

I guess declaring dependencies would be one time that [ and ] will be present and not represent an array... for package extras. Hm.

I don't offhand, unfortunately. Perhaps there's something in the guts of setuptools that could be exploited?

I checked... setuptools does not seem to have any kind of checks for this problem.

This can be done directly in ini2toml, although it will increase the complexity of the already complex code...

Would you like to give it a try and propose a PR?

Sure, I'll take a look and see if I can come up with something. Can't make any promises on a timeline, though.

Thank you very much @bskinn, there is absolutely no pressure and no rush.

This is a "nice to have", but if too complicated or if none of us has the bandwidth, we can still use the package like it is nowadays.