DRY en "Do One Thing"

Functies schrijven in Python

Shayne Miel

Software Architect @ Duo Security

Don't repeat yourself (DRY)

train = pd.read_csv('train.csv')
train_y = train['labels'].values
train_X = train[col for col in train.columns if col != 'labels'].values
train_pca = PCA(n_components=2).fit_transform(train_X)
plt.scatter(train_pca[:,0], train_pca[:,1])

val = pd.read_csv('validation.csv')
val_y = val['labels'].values
val_X = val[col for col in val.columns if col != 'labels'].values
val_pca = PCA(n_components=2).fit_transform(val_X)
plt.scatter(val_pca[:,0], val_pca[:,1])

test = pd.read_csv('test.csv')
test_y = test['labels'].values
test_X = test[col for col in test.columns if col != 'labels'].values
test_pca = PCA(n_components=2).fit_transform(train_X)
plt.scatter(test_pca[:,0], test_pca[:,1])

Het probleem met herhalen

train = pd.read_csv('train.csv')
train_y = train['labels'].values
train_X = train[col for col in train.columns if col != 'labels'].values
train_pca = PCA(n_components=2).fit_transform(train_X)
plt.scatter(train_pca[:,0], train_pca[:,1])

val = pd.read_csv('validation.csv')
val_y = val['labels'].values
val_X = val[col for col in val.columns if col != 'labels'].values
val_pca = PCA(n_components=2).fit_transform(val_X)
plt.scatter(val_pca[:,0], val_pca[:,1])

test = pd.read_csv('test.csv')
test_y = test['labels'].values
test_X = test[col for col in test.columns if col != 'labels'].values
test_pca = PCA(n_components=2).fit_transform(train_X)  ### yikes! ###
plt.scatter(test_pca[:,0], test_pca[:,1])

Nog een probleem met herhalen

train = pd.read_csv('train.csv')
train_y = train['labels'].values  ### <- daar en daar --v ### 
train_X = train[col for col in train.columns if col != 'labels'].values
train_pca = PCA(n_components=2).fit_transform(train_X)
plt.scatter(train_pca[:,0], train_pca[:,1])

val = pd.read_csv('validation.csv')
val_y = val['labels'].values  ### <- daar en daar --v ### 
val_X = val[col for col in val.columns if col != 'labels'].values
val_pca = PCA(n_components=2).fit_transform(val_X)
plt.scatter(val_pca[:,0], val_pca[:,1])

test = pd.read_csv('test.csv')
test_y = test['labels'].values  ### <- daar en daar --v ### 
test_X = test[col for col in test.columns if col != 'labels'].values
test_pca = PCA(n_components=2).fit_transform(test_X)
plt.scatter(test_pca[:,0], test_pca[:,1])

Gebruik functies om herhaling te vermijden

def load_and_plot(path):
  """Laad een dataset en plot de eerste twee hoofdcomponenten.

  Args:
    path (str): De locatie van een CSV-bestand.

  Returns:
    tuple of ndarray: (features, labels)
  """
  data = pd.read_csv(path)
  y = data['label'].values
  X = data[col for col in data.columns if col != 'label'].values
  pca = PCA(n_components=2).fit_transform(X)
  plt.scatter(pca[:,0], pca[:,1])
  return X, y

train_X, train_y = load_and_plot('train.csv')

val_X, val_y = load_and_plot('validation.csv')

test_X, test_y = load_and_plot('test.csv')

def load_and_plot(path):
  """Laad een dataset en plot de eerste twee hoofdcomponenten.

  Args:
    path (str): De locatie van een CSV-bestand.

  Returns:
    tuple of ndarray: (features, labels)
  """
  data = pd.read_csv(path)
  y = data['label'].values
  X = data[col for col in data.columns if col != 'label'].values

  pca = PCA(n_components=2).fit_transform(X)
  plt.scatter(pca[:,0], pca[:,1])

  return X, y

def load_and_plot(path):
  """Laad een dataset en plot de eerste twee hoofdcomponenten.

  Args:
    path (str): De locatie van een CSV-bestand.

  Returns:
    tuple of ndarray: (features, labels)
  """
  # laad de data
  data = pd.read_csv(path)
  y = data['label'].values
  X = data[col for col in data.columns if col != 'label'].values

  pca = PCA(n_components=2).fit_transform(X)
  plt.scatter(pca[:,0], pca[:,1])

  return X, y

def load_and_plot(path):
  """Laad een dataset en plot de eerste twee hoofdcomponenten.

  Args:
    path (str): De locatie van een CSV-bestand.

  Returns:
    tuple of ndarray: (features, labels)
  """
  # laad de data
  data = pd.read_csv(path)
  y = data['label'].values
  X = data[col for col in data.columns if col != 'label'].values

  # plot de eerste twee hoofdcomponenten
  pca = PCA(n_components=2).fit_transform(X)
  plt.scatter(pca[:,0], pca[:,1])

  return X, y

def load_and_plot(path):
  """Laad een dataset en plot de eerste twee hoofdcomponenten.

  Args:
    path (str): De locatie van een CSV-bestand.

  Returns:
    tuple of ndarray: (features, labels)
  """
  # laad de data
  data = pd.read_csv(path)
  y = data['label'].values
  X = data[col for col in data.columns if col != 'label'].values

  # plot de eerste twee hoofdcomponenten
  pca = PCA(n_components=2).fit_transform(X)
  plt.scatter(pca[:,0], pca[:,1])

  # geef de geladen data terug
  return X, y

Do One Thing

def load_data(path):
  """Laad een dataset.

  Args:
    path (str): De locatie van een CSV-bestand.

  Returns:
    tuple of ndarray: (features, labels)
  """
  data = pd.read_csv(path)
  y = data['labels'].values
  X = data[col for col in data.columns 
           if col != 'labels'].values
  return X, y

def plot_data(X):
  """Plot de eerste twee hoofdcomponenten van een matrix.

  Args:
    X (numpy.ndarray): De data om te plotten.
  """
  pca = PCA(n_components=2).fit_transform(X)
  plt.scatter(pca[:,0], pca[:,1])

Voordelen van één ding doen

De code wordt:

Flexibeler
Makkelijker te begrijpen
Simpeler te testen
Simpeler te debuggen
Eenvoudiger aan te passen

Code smells en refactoring

"Elke dwaas kan code schrijven die een computer begrijpt. Goede programmeurs schrijven code die mensen begrijpen." - Martin Fowler (1999)

"Refactoring" van Martin Fowler

Laten we oefenen!

Functies schrijven in Python