Being generic and foreseeing the future is good (again).

TL;DR: Don't over-generalize

Problems

• Speculative Design

• Complexity

• Over-Engineering

Solutions

1. Remove the abstract class until you get more examples

Context

In the past, programmers told us to design for change.

Nowadays, We keep following the scientific method.

Whenever we find a duplication we remove it.

Not before.

Not with interfaces, not with classes.

Sample Code

Wrong

class Boss(object):
    def __init__(self, name):
        self.name = name 

class GoodBoss(Boss):
    def __init__(self, name):
        super().__init__(name)

# This is actually a very classification example
# Bosses should be immutable but can change their mood
# with constructive feedback

Right

class Boss(object):
    def __init__(self, name):
        self.name = name  

# Bosses are concrete and can change mood

Detection

[X] Automatic

This is very easy for our linters since they can trace this error at compile time.

Exceptions

Some frameworks create an abstract class as a placeholder to build our models over them.

Subclassifing should be never our first option.

A more elegant solution would be to declare an interface since it is less coupled.

Tags

• Over Design

Relations

Code Smell 114 - Empty Class

Maxi Contieri ・ Feb 12 '22

#oop #tutorial #cleancode #webdev

Code Smell 11 - Subclassification for Code Reuse

Maxi Contieri ・ Oct 30 '20

#oop #codenewbie #tutorial

Code Smell 43 - Concrete Classes Subclassified

Maxi Contieri ・ Dec 5 '20

#oop #codenewbie #tutorial #webdev

Code Smell 92 - Isolated Subclasses Names

Maxi Contieri ・ Oct 11 '21

#poo #webdev #python #javascript

Code Smell 135 - Interfaces With just One Realization

Maxi Contieri ・ May 26 '22

#java #programming #webdev #tutorial

Conclusion

We need to wait for abstractions and not be creative and speculative.

Credits

Photo by Benjamin Davies on Unsplash

Writing a class without its contract would be similar to producing an engineering component (electrical circuit, VLSI (Very Large Scale Integration) chip, bridge, engine...) without a spec. No professional engineer would even consider the idea.

Bertrand Meyer

Software Engineering Great Quotes

Maxi Contieri ・ Dec 28 '20

#codenewbie #programming #quotes #software

This article is part of the CodeSmell Series.

How to Find the Stinky parts of your Code

Maxi Contieri ・ May 21 '21

#codenewbie #tutorial #codequality #beginners