this post was submitted on 06 Sep 2024
61 points (74.0% liked)

Programming

17666 readers
215 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Rules

  • Follow the programming.dev instance rules
  • Keep content related to programming in some way
  • If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities [email protected]



founded 2 years ago
MODERATORS
61
Why YAML sucks? (programming.dev)
submitted 3 months ago* (last edited 3 months ago) by [email protected] to c/[email protected]
 

I feel that Yaml sucks. I understand the need for such markup language but I think it sucks. Somehow it's clunky to use. Can you explain why?

(page 3) 49 comments
sorted by: hot top controversial new old
[–] [email protected] 12 points 3 months ago (1 children)

it does what it needs to do: i don't think it's necessarily bad.

it's for data not programming and it handles complex structures cleaner than json

load more comments (1 replies)
[–] [email protected] 0 points 3 months ago

If YAML and JSON were gripping my hands for dear life, dangling off of a cliff...

I would let both drop into the abyss so I could spend more time with INI.

[–] [email protected] 3 points 3 months ago

I think much of the issue with YAML is that it's often paired with bad editors. You need a way to manage the whitespace, collapse sections, etc. Notepad doesn't cut it.

[–] [email protected] 42 points 3 months ago (3 children)
[–] [email protected] 16 points 3 months ago

That is amazing.

I don't know what I just read.

If my website ever gets married, I'm going to invite this website to stand next to it as a bridesmaid - because it makes my website look pretty by comparison.

load more comments (2 replies)
[–] [email protected] 3 points 3 months ago (1 children)

I wish s-expression was a popular alternative. It's readable without the yaml issues.

load more comments (1 replies)
[–] [email protected] 13 points 3 months ago

But.. Yaml ain't markup language..

[–] [email protected] 26 points 3 months ago (3 children)

I don’t like YAML because it’s overly complicated. The specification is like 80 pages long. How the hell did they think that was a good idea?

JSON on the other hand is super simple. It doesn’t do more than it needs to.

Just compare this: https://yaml.org/spec/1.2.2/

With this: https://www.json.org/json-en.html

The entire JSON specification is shorter than just the table of contents of the YAML specification!

Another thing I like about JSON is that you can format it however you want with the whitespace. Want everything on one line? Just write everything on one line!

If data can be represented as a JSON, then there’s generally only one way to represent it in JSON (apart from whitespace). In YAML the same data can be represented in 1000s of different ways. You pick one.

[–] [email protected] 12 points 3 months ago

This is the major reason for me. I really liked yaml, because it is way more readable to me than JSON. But then I kept finding new and more confusing yaml features and have realized how over-engineered it is.

Yaml would be great language if it had its features prunned heavy.

load more comments (2 replies)
[–] [email protected] 26 points 3 months ago* (last edited 3 months ago)

One pattern I've noticed is people seeking a language that's better than {JSON,XML,INI,etc} at wrangling their slightly complex configuration files, noticing the additional features and type support offered by YAML, and assuming it will be a good solution.

Then, as their configs grow ever larger and more complex, they discover that expressing them in YAML requires large sections of deep nesting, long item sequences, and line wrapping. The syntax style that they saw working well in other places (e.g. certain programming languages) breaks down quickly at that level of complexity, making it difficult for humans to correctly write and follow, and leading to frequent errors.

YAML doesn't suck for small stuff, IMHO. (But it is more complex than necessary for small stuff.)

For things likely to grow to medium-large size or complexity, I would recommend either breaking up the data into separate files, or looking for a different config/serialization language.

[–] [email protected] 13 points 3 months ago (2 children)

I like yml. Clean to read, easy to use, supports comments.

[–] [email protected] 5 points 3 months ago

Way easier to type than json!

load more comments (1 replies)
[–] [email protected] 18 points 3 months ago (1 children)

I think TOML should replace YAML for config files, it is much clearer, easier to parse for a human.

load more comments (1 replies)
[–] [email protected] 7 points 3 months ago

"Why does YAML suck?" is a question. "Why YAML sucks" is an explanation.

[–] [email protected] 6 points 3 months ago

I don't like it either, but I'm not entirely sure why. Maybe the biggest flaw to me is it uses Python style indentation for structuring as part of data logic. It doesn't feel like a configuration language to me and it does not feel simple too. It's also unlike most programming language structures (maybe besides Python), so it looks weird to read and write. Other than that, I don't know exactly why I don't like this format much. Admittedly, I did not do much in YAML, so because lack of experience take my opinion with a thick grain of salt.

We have JSON and TOML. I quiet like TOML. We have "better" alternatives, that are probably easier to parse. And therefore there is not much need for YAML. Maybe if YAML was the default config format for Python it would get off the ground and be accepted more often.

[–] [email protected] 16 points 3 months ago (1 children)

It sucks the same way Python sucks. Some people just really don't like indentation-based syntax. I'm one of them, so I dislike both formats. However, if you groove on that sort of thing, I don't think YAML is any worse than any other markup.

Oddly, I get along with Haskell, which also used indentation for scoping/delimiting; I can't explain that, except that, somehow, indentation-based syntax seems to fit better with functional languages. But I have no clear argument about why; it's just an oddity in my aesthetics.

[–] [email protected] 11 points 3 months ago* (last edited 3 months ago) (3 children)

You can't say python's whitespace usage is as bad as yaml's. YAML mixes 2 and 4 spaces all the time. Python scripts don't run if you write this kind of crap.

And whitespaces is really just the tip of the iceberg of YAML problems...

[–] [email protected] 3 points 3 months ago (6 children)

YAML mixes 2 and 4 spaces

I think that's a user thing and it doesn't happen if you have a linter enforce 2 or 4.

load more comments (6 replies)
load more comments (2 replies)
[–] [email protected] 11 points 3 months ago (1 children)

I don't hate YAML, but it has the same issues languages like PHP and JS introduce...there are unexpected corner cases that only exist because the designer wanted the language to be "friendly"

https://www.bram.us/2022/01/11/yaml-the-norway-problem/

[–] [email protected] 3 points 3 months ago

Sorry, what's confusing the fact that "Hi my name is {$this->name}" works and "Hi my name is {self::name}" is unintelligible gibberish! /s

[–] [email protected] 2 points 3 months ago (2 children)

Yes, they could've just used JSON. Totally pointless waste of time.

[–] [email protected] 13 points 3 months ago (5 children)

JSON does lack comments. And numbers that are not 64 floats.

[–] [email protected] 5 points 3 months ago

Readability in general sucks

[–] [email protected] 7 points 3 months ago (2 children)

TFB, the numbers are not defined as 64 bits floats.

They are just not defined. At all.

load more comments (2 replies)
load more comments (3 replies)
[–] [email protected] 5 points 3 months ago (1 children)

So Poe's Law and all that... I really hope you're being sarcastic because having non-technical people hand edit JSON is a nightmare. It's also quite annoying to read without a lot of extra whitespace which most editors that'd help less technical folks omit... and comments to help highlight what different things mean are hacky, hard to read, and actually read as data.

load more comments (1 replies)
[–] [email protected] 35 points 3 months ago (2 children)

Because people over use it. YAML is pretty good for short config files that need to be human readable but it falls apart with complex multi line strings and escaping.

I think there are much better clearly delimited for machine reading purposes formats out there that you should prefer if you're writing a really heavy config file and, tbh, I think for everything else .ini is probably "good enough".

[–] [email protected] 27 points 3 months ago (1 children)

At least use TOML if you like ini, there is no ini spec but TOML can look quite similar.

[–] [email protected] 10 points 3 months ago

Strong agree. It's also the absolute best at expressing really long documents of configuration/data.

[–] [email protected] 13 points 3 months ago* (last edited 3 months ago) (2 children)

I agree - YAML is not suitable for complex cases that people use it in, like ~~Terraform~~ and Home Assistant. My pet peeve is a YAML config in a situation that really calls for more abstraction, like functions and variables. I'd like to see more use of the class of configuration languages that support that stuff, like Dhall, Cue, and Nickel.

There is another gotcha which is that YAML has more room for ambiguity than, say, JSON. YAML has a lot of ways to say true and false, and it's implicit quoting is a bit complex. So some values that you expect to be strings might be interpreted as something els.

[–] [email protected] 4 points 3 months ago (1 children)

What YAML does Terraform use? HCL is similar but different enough to YAML.

[–] [email protected] 4 points 3 months ago (3 children)

Oh, thanks for calling that out. I think I may have mixed up some of the frustrations I experienced at an old job.

load more comments (3 replies)
[–] [email protected] 5 points 3 months ago* (last edited 3 months ago) (1 children)

For those highly complex situations is Lua still viewed as the ideal solution? Lua is sort of legendary for game configuration and seems to strike a good expressiveness/accessibility balance for modders and the casually technical.

load more comments (1 replies)
[–] [email protected] 85 points 3 months ago (6 children)

Any language in which whitespace has syntactic value is intrinsically flawed.

Can't speak to your specific issues, but that's why yaml will always suck.

[–] [email protected] 7 points 3 months ago* (last edited 3 months ago) (1 children)

Haskell supports both semantic whitespace and explicit delimiters, and somehow almost everybody that uses the language disagrees with you.

But anyway, for all the problems of YAML, this one isn't even relevant enough to point out. Even if you agree it's a problem. (And I agree that the YAML semantic whitespace is horrible.) If YAML was a much better language, it would be worth arguing whether semantic whitespace breaks it or not.

load more comments (1 replies)
[–] [email protected] 6 points 3 months ago* (last edited 3 months ago) (3 children)

YAML sucks because, among other things, indenting it is not obvious.

In contrast, the only mistake of Python when it comes to whitespaces was allowing hard tabs, which makes it too easy to mix them if your editor is not configured.

Improper indentation stands out more than missing or unbalanced braces and it's really not an issue to delimit code blocks.

load more comments (3 replies)
[–] [email protected] -1 points 3 months ago

I now use Scala 3, and very happy with syntactic whitespace (combined with an intelligent compiler)

[–] [email protected] 25 points 3 months ago (5 children)

As a serialization format, agree 100%, but would Python really be better if it switched to braces?

[–] [email protected] 16 points 3 months ago* (last edited 3 months ago)

would Python really be better if it switched to braces?

Yes. A thousand times, yes.

[–] [email protected] 5 points 3 months ago (1 children)

To be pendantic, it's level of indentation in Python that has semantic meaning, not whitespace.

[–] [email protected] 13 points 3 months ago (1 children)

The end of line also has semantic meaning. Both indentation and eol are whitespace.

load more comments (1 replies)
[–] [email protected] 63 points 3 months ago (4 children)

Yes, I think so. The downside with Python comes when refactoring the code. There’s always this double checking if the code is correctly indented after the refactor. Sometimes small mistakes creep in.

It’s really hard to tell when Python code is incorrectly indented. It’s often still valid Python code, but you can’t tell if it’s wrong unless you know the intention of the code.

In order languages it’s always obvious when code is incorrectly indented. There’s no ambiguity.

[–] [email protected] 5 points 3 months ago (4 children)

It’s only hard to tell indentation in Python when the code block gets longer than about a screen, which is usually a sign the code should be refactored into smaller methods.

load more comments (4 replies)
load more comments (3 replies)
[–] [email protected] 28 points 3 months ago (3 children)

Yes it would - look at optional braces for short if expressions in C family languages and why it's so discouraged in large projects. Terminating characters are absolutely worth the cost of an extra LoC

[–] [email protected] 7 points 3 months ago* (last edited 3 months ago) (4 children)

False dichotomy. Optional braces are bad practice because they mislead the programmer that is adding an additional clause to the block.

This misleading behavior wouldn't happen in Python, as it would either be invalid syntax, or it would be part of the block.

Indentation problems are pretty obvious to the reader. Even more than missing or unbalanced braces.

[–] [email protected] 12 points 3 months ago (1 children)

They may be obvious to the reader but they may be impossible to see if tabs and spaces are mixed together.

Closing tokens are always clearer.

[–] [email protected] 3 points 3 months ago* (last edited 3 months ago)

yes, from my other comment

the only mistake of Python when it comes to whitespaces was allowing hard tabs

but that's easily fixed with an editor setting - on the other hand, unbalancing braces (and not realizing it) is too easy all the time.

load more comments (3 replies)
[–] [email protected] 16 points 3 months ago (6 children)

I started in C before moving on to C++, Java, Ruby and Python.

I’ve had more bugs from missing braces than from misaligned whitespace because the latter is far more obvious when looking at a block of code.

load more comments (6 replies)
[–] [email protected] 5 points 3 months ago* (last edited 3 months ago)

I'm fine with python, because it's consistent. In C I get nervous every time I see it.

goto fail;

load more comments (1 replies)
[–] [email protected] 1 points 3 months ago

It's the only time that tabs Vs spaces really riles me up. So annoying when everyone has different tab lengths

load more comments (1 replies)
load more comments
view more: ‹ prev next ›