Beautiful Language and Beautiful Code

language

The post Beautiful Language and Beautiful Code first appeared on Qvault.

“Dead Poet’s Society” is a classic film, and has become a recent favorite of mine. There’s a scene in particular that I enjoy, where Robin William’s character explains that it’s bad practice to use terms like “very tired” or “very sad”, instead we should use descriptive words like “exhausted” or “morose”!

I wholeheartedly agree with what’s being taught to the students in this scene. It’s tiresome to read a novel where the author drones on within the bounds of a lackluster vocabulary. This brings me to the point I wanted to emphasize in this short article:

Beautiful language and beautiful code are far from the same.

Beautiful language doesn’t simply communicate instructions from one human to another. Language well-used arouses emotions, illustrates scenery, exposes nuance, and can sing through rhyme and meter. Its purpose isn’t purely functional, it’s a rich medium of creative expression.

Beautiful code, at least by my standards, is purely functional. Its goal is to communicate exactly what it does. Emotion, motif, and narrative be damned. Beautiful code should be written so that machines carry out the instructions as efficiently as possible, and humans grok the instructions as easily as possible. The ideal piece of code is perfectly efficient and can be understood by any human that reads it.

Why shouldn’t code be more like its more expressive counterpart?

If you’re a part of /r/shittyprogramming on Reddit, you may have noticed several weeks back when the community became interested in writing the most ridiculous and inefficient way to calculate whether or not a given number is even. Here are some highlights.



const isEven = n => 'x'.repeat(n).replace(/xx/g, '') === '';


Code language: JavaScript (javascript)


source




function isEven(number) { if (0 == number) { return true; } else if (number < 0) { //I actually don't remember if JS has an absolute value function, return !isEven(number+1); // so this is how we handle negative numbers } else { return !isEven(number-1); } }


Code language: JavaScript (javascript)


source




#include <stdio.h> #include <unistd.h> #include <stdlib.h> char isEvenFile() { while (access("/tmp/isEven", F_OK)) ; //We have to wait until the other process created the file FILE *comms = fopen("/tmp/isEven", "r"); int c = EOF; while (c == EOF) c = fgetc(comms); //In case we were so fast that the other process didn't write to the file for (;;) { int newC = fgetc(comms); if (newC != ' ') //the number has been sent c = newC; else { FILE *out = fopen("/tmp/out", "w+"); switch (c) { case '0': case '2': case '4': case '6': case '8': fprintf(out, "b"); break; default: fprintf(out, "a"); //printing a null char would be the end of the string. break; } fflush(out); break; } } fclose(comms); exit(0); } char isEven(int n) { char input[10]; sprintf(input, "%d", n); int pid = fork(); if (pid == -1) return 2; //error if (pid == 0) { isEvenFile(); } else { FILE *comms = fopen("/tmp/isEven", "w+"); fprintf(comms, "%d ", n); fflush(comms); //send the number to stdin of the child while (access("/tmp/out", F_OK | R_OK)) ; FILE *out = fopen("/tmp/out", "r"); int result = EOF; while (result == EOF) result = fgetc(out); //Again, we have to wait until the other process is done result = result == 'b'; fclose(comms); fclose(out); remove("/tmp/isEven"); remove("/tmp/out"); return (char) result; } }


Code language: C++ (cpp)


Source


One Redditor went so far as to apply machine learning to the problem and annotate an “isEven” training set.


My point with all this “isEven” nonsense is that code can be fun, interesting, and entertaining – I’m not trying to say it can’t be. I’m doing some mental gymnastics, however, in that I define all these “jokes through code” as normal language. It’s a medium through which humans express themselves creatively to one another, just like film, poetry, novels, or blogging.


None of the examples above are actually intended to run in production. If they were, they would be examples of ugly code indeed.










Ready to get coding?


Try our coding courses free


Join our Discord community







Have questions or feedback?


Follow and hit me up on Twitter @q_vault if you have any questions or comments. If I’ve made a mistake in the article be sure to let me know so I can get it corrected!









source https://qvault.io/clean-code/beautiful-language-and-beautiful-code/






































Comments











Post a Comment























Popular posts from this blog









Why is Exclusive Or (XOR) Important in Cryptography?




















Image







    If you are getting into cryptography, or just trying to understand the fundamentals, you may have noticed that the exclusive-or operation is used quite often, especially in ciphers.  What is XOR ( ⊕ )?  XOR, or “exclusive or” operates on binary data. It returns true if both of its inputs are opposites (one false and one true), otherwise, it returns false.     An example in go code would be something like:  func exclusiveOr(a bool, b bool) bool {         return a != b }  XOR Cipher – The Perfect Cipher  The XOR operation can be used as a simple cipher for encrypting and decrypting messages with a single key. This is known as symmetric encryption.  It is interesting to note that if:   The key is the same size as the message  The key is kept secret and generated truly randomly   Then the cipher is impossible  to crack. This is known as a one time pad . However, a simple XOR shouldn’t be used in production due to the key length needing to be too long to be practical.  Cipher Example  A...








Read more










Base64 vs Base58 Encoding




















Image







 By Lane Wagner –  @wagslane  on Twitter   Base64 is one of the most popular encoding formats for representing data. Have some binary data? Base64 encode it for convenient readability and parsing. Base58 is just another encoding format (with 58 characters instead of 64, and has gained popularity largely due to Bitcoin and other cryptocurrencies.  When it comes to data encoding, there is typically a trade-off made between:   Human Readability: Do humans have a good idea of what is being represented at a glance?  Efficient data compression: How many bytes are used to represent the same data?   Let’s rank Base58, Base64, and ASCII encoding against each other using these metrics!  First: A Note on Binary  All data is stored in a raw binary format on computers. These encoding formats (Base64, Base58, and ASCII) are just different ways of reading and writing binary data. For example, in Base64 the binary code 000000  represents the letter A , but in ASCII the binary 00000000  repres...








Read more










(Very) Basic Intro to Hash Functions (SHA-256, MD-5, etc)




















Image







 This is going to be a basic introduction to hash functions. I will assume most of my audience is here to gain an understanding of why hash functions are used and the basic idea of why they work. My goal is to explain it in a general sense, I will be omitting proofs and implementation details and instead focusing on the high-level principles.     Why Use A Hash Function?  Hash functions are used all over the internet in order to securely store passwords, find duplicate records, quickly store and retrieve data, and more. For example,  Qvault  uses hashes to extend master passwords into private encryption keys.  A longer list of uses here:  https://en.wikipedia.org/wiki/Hash_function#Uses  I want to focus on several important features of hash functions, arguably the most important features.   Hash functions scramble data deterministically  No matter the input, the output of a hash function always has the same size  The original data can not be retrieved from the scrambled d...








Read more