Explicit is better than implicit

I’m convinced that implicitness leads to a higher WTF per Minute (WTFPM) in the long run.

Implicitness requires the coder to remember hidden details instead of having them clearly defined in the code. For example, can you tell me why we’re adding “10” here?

1
// Implicit (bad)
2
function calculateSalary(a, b) {
3
  return a + b + 10;  // a?? b?? WTF is 10?
4
}

Exactly, that was the point. No one can tell what “10” represents except the person who wrote it, and that’s awful in my opinion. If you have a team of engineers working on a project, how can anyone possibly navigate the codebase with such ambiguity?

Instead of implicitly adding “10”, we can prevent future headaches by simply creating a clear variable for the bonus. In my view, relying too heavily on implicit behavior can cause confusion and make managing the codebase more difficult.

1
// Explicit (good)
2
function calculateSalary(cash, equity) {
3
  const bonus = 10; // Explicit bonus variable
4
  return cash + equity + bonus;
5
}

Tim Peters’ second point in The Zen of Python states, “Explicit is better than implicit,” and I couldn’t agree more.

Imagine a function that grants access to different parts of a system based on a user’s role. In this example, implicit behavior leads to confusion about which roles have which permissions, making the code difficult to maintain.

1
// Implicit (bad)
2
function grantAccess(user) {
3
  if (user.role === 'admin') {
4
    return ['read', 'write', 'delete'];  // Full access
5
  }
6

7
  if (user.role === 'editor') {
8
    return ['read', 'write'];  // Editors can't delete
9
  }
10

11
  if (user.role === 'viewer') {
12
    return ['read'];  // View-only access
13
  }
14

15
  // Implicit fallback
16
  return ['none'];  // WTF is 'none'?
17
}
18

19
function showAccessControls(user) {
20
  const permissions = grantAccess(user);
21

22
  if (permissions.includes('read')) {
23
    console.log("User has read access.");
24
  }
25
  if (permissions.includes('write')) {
26
    console.log("User has write access.");
27
  }
28
  if (permissions.includes('delete')) {
29
    console.log("User has delete access.");
30
  }
31
}
32

33
// Example usage
34
const user1 = { name: "Alice", role: "admin" };
35
const user2 = { name: "Bob", role: "viewer" };
36
const user3 = { name: "Charlie", role: "guest" };  // Implicit 'none' fallback
37

38
showAccessControls(user1);  // Has all access
39
showAccessControls(user2);  // Read-only access
40
showAccessControls(user3);  // No access, but why?

The access control is handled with hard-coded roles and magic strings like ‘none’, making it unclear and unmanageable as more roles are added. Permissions are scattered throughout the code, leading to confusion and maintenance issues for future developers.

1
// Explicit (good)
2
const ROLE_PERMISSIONS = {
3
  admin: ['read', 'write', 'delete'],
4
  editor: ['read', 'write'],
5
  viewer: ['read'],
6
  guest: []  // Explicitly defining guest permissions
7
};
8

9
function grantAccess(user) {
10
  const permissions = ROLE_PERMISSIONS[user.role] || ROLE_PERMISSIONS['guest'];
11
  return permissions;
12
}
13

14
function showAccessControls(user) {
15
  const permissions = grantAccess(user);
16

17
  if (permissions.includes('read')) {
18
    console.log(`${user.name} has read access.`);
19
  }
20
  if (permissions.includes('write')) {
21
    console.log(`${user.name} has write access.`);
22
  }
23
  if (permissions.includes('delete')) {
24
    console.log(`${user.name} has delete access.`);
25
  }
26
  if (permissions.length === 0) {
27
    console.log(`${user.name} has no access.`);
28
  }
29
}
30

31
// Example usage
32
const user1 = { name: 'Alice', role: 'admin' };
33
const user2 = { name: 'Bob', role: 'viewer' };
34
const user3 = { name: 'Charlie', role: 'guest' };
35

36
showAccessControls(user1);  // Alice has read, write, and delete access.
37
showAccessControls(user2);  // Bob has read access.
38
showAccessControls(user3);  // Charlie has no access.

Why Explicit is Better

Explicit Mapping: The ROLE_PERMISSIONS object clearly defines each role and its corresponding permissions.
Clarity: By making permissions explicit, there’s no need for magic strings or conditionals scattered across the codebase.
Maintainability: Future roles or changes to permissions can be easily updated in one place.

In my opinion, “Explicit is better than implicit” is about choosing clear, direct code over concise but potentially ambiguous alternatives. This principle puts readability and maintainability first, even if it means writing slightly more verbose code.

By being explicit, the intentions behind the code are obvious, making it easier for any developer to understand and work with the codebase.

Explicit is better than implicit

Clarity is key: being explicit makes your code more readable and maintainable.

Why Explicit is Better

Related Articles

Programming Trends to Watch in 2020 and Beyond

Objective-C Is a Total Abomination (opinion)

The Credit Vacuum

Recommended Engineering Resources

CodeCrafters

Scrimba

Boot.dev